Documentation

Overview

Capacitive touch sensor for 12 electrodes.

See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/MultiTouchV2_Bricklet_Go.html.

Index

Constants

View Source
const DeviceDisplayName = "Multi Touch Bricklet 2.0"
View Source
const DeviceIdentifier = 2129

Variables

This section is empty.

Functions

This section is empty.

Types

type BootloaderMode

type BootloaderMode = uint8
const (
	BootloaderModeBootloader                    BootloaderMode = 0
	BootloaderModeFirmware                      BootloaderMode = 1
	BootloaderModeBootloaderWaitForReboot       BootloaderMode = 2
	BootloaderModeFirmwareWaitForReboot         BootloaderMode = 3
	BootloaderModeFirmwareWaitForEraseAndReboot BootloaderMode = 4
)

type BootloaderStatus

type BootloaderStatus = uint8
const (
	BootloaderStatusOK                        BootloaderStatus = 0
	BootloaderStatusInvalidMode               BootloaderStatus = 1
	BootloaderStatusNoChange                  BootloaderStatus = 2
	BootloaderStatusEntryFunctionNotPresent   BootloaderStatus = 3
	BootloaderStatusDeviceIdentifierIncorrect BootloaderStatus = 4
	BootloaderStatusCRCMismatch               BootloaderStatus = 5
)

type Function

type Function = uint8
const (
	FunctionGetTouchState                      Function = 1
	FunctionSetTouchStateCallbackConfiguration Function = 2
	FunctionGetTouchStateCallbackConfiguration Function = 3
	FunctionRecalibrate                        Function = 5
	FunctionSetElectrodeConfig                 Function = 6
	FunctionGetElectrodeConfig                 Function = 7
	FunctionSetElectrodeSensitivity            Function = 8
	FunctionGetElectrodeSensitivity            Function = 9
	FunctionSetTouchLEDConfig                  Function = 10
	FunctionGetTouchLEDConfig                  Function = 11
	FunctionGetSPITFPErrorCount                Function = 234
	FunctionSetBootloaderMode                  Function = 235
	FunctionGetBootloaderMode                  Function = 236
	FunctionSetWriteFirmwarePointer            Function = 237
	FunctionWriteFirmware                      Function = 238
	FunctionSetStatusLEDConfig                 Function = 239
	FunctionGetStatusLEDConfig                 Function = 240
	FunctionGetChipTemperature                 Function = 242
	FunctionReset                              Function = 243
	FunctionWriteUID                           Function = 248
	FunctionReadUID                            Function = 249
	FunctionGetIdentity                        Function = 255
	FunctionCallbackTouchState                 Function = 4
)

type MultiTouchV2Bricklet

type MultiTouchV2Bricklet struct {
	// contains filtered or unexported fields
}

func New

Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.

func (*MultiTouchV2Bricklet) DeregisterTouchStateCallback

func (device *MultiTouchV2Bricklet) DeregisterTouchStateCallback(registrationId uint64)

Remove a registered Touch State callback.

func (*MultiTouchV2Bricklet) GetAPIVersion

func (device *MultiTouchV2Bricklet) GetAPIVersion() [3]uint8

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

func (*MultiTouchV2Bricklet) GetBootloaderMode

func (device *MultiTouchV2Bricklet) GetBootloaderMode() (mode BootloaderMode, err error)

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot

func (*MultiTouchV2Bricklet) GetChipTemperature

func (device *MultiTouchV2Bricklet) GetChipTemperature() (temperature int16, err error)

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

func (*MultiTouchV2Bricklet) GetElectrodeConfig

func (device *MultiTouchV2Bricklet) GetElectrodeConfig() (enabledElectrodes [13]bool, err error)

Returns the electrode configuration, as set by SetElectrodeConfig.

func (*MultiTouchV2Bricklet) GetElectrodeSensitivity

func (device *MultiTouchV2Bricklet) GetElectrodeSensitivity() (sensitivity uint8, err error)

Returns the current sensitivity, as set by SetElectrodeSensitivity.

func (*MultiTouchV2Bricklet) GetIdentity

func (device *MultiTouchV2Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an `Isolator Bricklet <isolator_bricklet>` is always at position 'z'.

The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|

func (*MultiTouchV2Bricklet) GetResponseExpected

func (device *MultiTouchV2Bricklet) GetResponseExpected(functionID Function) (bool, error)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

See SetResponseExpected for the list of function ID constants available for this function.

func (*MultiTouchV2Bricklet) GetSPITFPErrorCount

func (device *MultiTouchV2Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

* ACK checksum errors, * message checksum errors, * framing errors and * overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

func (*MultiTouchV2Bricklet) GetStatusLEDConfig

func (device *MultiTouchV2Bricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*MultiTouchV2Bricklet) GetTouchLEDConfig

func (device *MultiTouchV2Bricklet) GetTouchLEDConfig() (config TouchLEDConfig, err error)

Returns the LED configuration as set by SetTouchLEDConfig

Associated constants:

* TouchLEDConfigOff
* TouchLEDConfigOn
* TouchLEDConfigShowHeartbeat
* TouchLEDConfigShowTouch

func (*MultiTouchV2Bricklet) GetTouchState

func (device *MultiTouchV2Bricklet) GetTouchState() (state [13]bool, err error)

Returns the current touch state. The state is given as a array of bools.

Element 0 to 11 represent the 12 electrodes and element 12 represents the proximity.

If an electrode is touched, the corresponding element is *true*. If a hand or similar is in proximity to the electrodes, element 12 is *true*.

The proximity is activated with a distance of 1-2cm. An electrode is already counted as touched if a finger is nearly touching the electrode. This means that you can put a piece of paper or foil or similar on top of a electrode to build a touch panel with a professional look.

If you want to get the value periodically, it is recommended to use the RegisterTouchStateCallback callback. You can set the callback configuration with SetTouchStateCallbackConfiguration.

func (*MultiTouchV2Bricklet) GetTouchStateCallbackConfiguration

func (device *MultiTouchV2Bricklet) GetTouchStateCallbackConfiguration() (period uint32, valueHasToChange bool, err error)

Returns the callback configuration as set by SetTouchStateCallbackConfiguration.

func (*MultiTouchV2Bricklet) ReadUID

func (device *MultiTouchV2Bricklet) ReadUID() (uid uint32, err error)

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

func (*MultiTouchV2Bricklet) Recalibrate

func (device *MultiTouchV2Bricklet) Recalibrate() (err error)

Recalibrates the electrodes. Call this function whenever you changed or moved you electrodes.

func (*MultiTouchV2Bricklet) RegisterTouchStateCallback

func (device *MultiTouchV2Bricklet) RegisterTouchStateCallback(fn func([13]bool)) uint64

Returns the current touch state, see GetTouchState for information about the state.

This callback is triggered every time the touch state changes with a given period (see SetTouchStateCallbackConfiguration)

func (*MultiTouchV2Bricklet) Reset

func (device *MultiTouchV2Bricklet) Reset() (err error)

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

func (*MultiTouchV2Bricklet) SetBootloaderMode

func (device *MultiTouchV2Bricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot
* BootloaderStatusOK
* BootloaderStatusInvalidMode
* BootloaderStatusNoChange
* BootloaderStatusEntryFunctionNotPresent
* BootloaderStatusDeviceIdentifierIncorrect
* BootloaderStatusCRCMismatch

func (*MultiTouchV2Bricklet) SetElectrodeConfig

func (device *MultiTouchV2Bricklet) SetElectrodeConfig(enabledElectrodes [13]bool) (err error)

Enables/disables electrodes with a bool array (see GetTouchState).

*True* enables the electrode, *false* disables the electrode. A disabled electrode will always return *false* as its state. If you don't need all electrodes you can disable the electrodes that are not needed.

It is recommended that you disable the proximity electrode (element 12) if the proximity feature is not needed. This will reduce the amount of traffic that is produced by the RegisterTouchStateCallback callback.

Disabling electrodes will also reduce power consumption.

func (*MultiTouchV2Bricklet) SetElectrodeSensitivity

func (device *MultiTouchV2Bricklet) SetElectrodeSensitivity(sensitivity uint8) (err error)

Sets the sensitivity of the electrodes. An electrode with a high sensitivity will register a touch earlier then an electrode with a low sensitivity.

If you build a big electrode you might need to decrease the sensitivity, since the area that can be charged will get bigger. If you want to be able to activate an electrode from further away you need to increase the sensitivity.

After a new sensitivity is set, you likely want to call Recalibrate to calibrate the electrodes with the newly defined sensitivity.

func (*MultiTouchV2Bricklet) SetResponseExpected

func (device *MultiTouchV2Bricklet) SetResponseExpected(functionID Function, responseExpected bool) error

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

func (*MultiTouchV2Bricklet) SetResponseExpectedAll

func (device *MultiTouchV2Bricklet) SetResponseExpectedAll(responseExpected bool)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

func (*MultiTouchV2Bricklet) SetStatusLEDConfig

func (device *MultiTouchV2Bricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*MultiTouchV2Bricklet) SetTouchLEDConfig

func (device *MultiTouchV2Bricklet) SetTouchLEDConfig(config TouchLEDConfig) (err error)

Configures the touch LED to be either turned off, turned on, blink in heartbeat mode or show the touch state (electrode touched = LED on).

Associated constants:

* TouchLEDConfigOff
* TouchLEDConfigOn
* TouchLEDConfigShowHeartbeat
* TouchLEDConfigShowTouch

func (*MultiTouchV2Bricklet) SetTouchStateCallbackConfiguration

func (device *MultiTouchV2Bricklet) SetTouchStateCallbackConfiguration(period uint32, valueHasToChange bool) (err error)

The period is the period with which the RegisterTouchStateCallback callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

func (*MultiTouchV2Bricklet) SetWriteFirmwarePointer

func (device *MultiTouchV2Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)

Sets the firmware pointer for WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*MultiTouchV2Bricklet) WriteFirmware

func (device *MultiTouchV2Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*MultiTouchV2Bricklet) WriteUID

func (device *MultiTouchV2Bricklet) WriteUID(uid uint32) (err error)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

type StatusLEDConfig

type StatusLEDConfig = uint8
const (
	StatusLEDConfigOff           StatusLEDConfig = 0
	StatusLEDConfigOn            StatusLEDConfig = 1
	StatusLEDConfigShowHeartbeat StatusLEDConfig = 2
	StatusLEDConfigShowStatus    StatusLEDConfig = 3
)

type TouchLEDConfig

type TouchLEDConfig = uint8
const (
	TouchLEDConfigOff           TouchLEDConfig = 0
	TouchLEDConfigOn            TouchLEDConfig = 1
	TouchLEDConfigShowHeartbeat TouchLEDConfig = 2
	TouchLEDConfigShowTouch     TouchLEDConfig = 3
)