multi_touch_bricklet

package
Version: v0.0.0-...-8a98e63 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 11, 2022 License: CC0-1.0 Imports: 5 Imported by: 0

Documentation

Overview

Capacitive touch sensor for 12 electrodes.

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

Index

Constants

View Source
const DeviceDisplayName = "Multi Touch Bricklet"
View Source
const DeviceIdentifier = 234

Variables

This section is empty.

Functions

This section is empty.

Types

type Function

type Function = uint8
const (
	FunctionGetTouchState           Function = 1
	FunctionRecalibrate             Function = 2
	FunctionSetElectrodeConfig      Function = 3
	FunctionGetElectrodeConfig      Function = 4
	FunctionSetElectrodeSensitivity Function = 6
	FunctionGetElectrodeSensitivity Function = 7
	FunctionGetIdentity             Function = 255
	FunctionCallbackTouchState      Function = 5
)

type MultiTouchBricklet

type MultiTouchBricklet 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 (*MultiTouchBricklet) DeregisterTouchStateCallback

func (device *MultiTouchBricklet) DeregisterTouchStateCallback(registrationId uint64)

Remove a registered Touch State callback.

func (*MultiTouchBricklet) GetAPIVersion

func (device *MultiTouchBricklet) 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 (*MultiTouchBricklet) GetElectrodeConfig

func (device *MultiTouchBricklet) GetElectrodeConfig() (enabledElectrodes uint16, err error)

Returns the electrode configuration, as set by SetElectrodeConfig.

func (*MultiTouchBricklet) GetElectrodeSensitivity

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

Returns the current sensitivity, as set by SetElectrodeSensitivity.

func (*MultiTouchBricklet) GetIdentity

func (device *MultiTouchBricklet) 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 (*MultiTouchBricklet) GetResponseExpected

func (device *MultiTouchBricklet) 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 (*MultiTouchBricklet) GetTouchState

func (device *MultiTouchBricklet) GetTouchState() (state uint16, err error)

Returns the current touch state. The state is given as a bitfield.

Bits 0 to 11 represent the 12 electrodes and bit 12 represents the proximity.

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

Example: The state 4103 = 0x1007 = 0b1000000000111 means that electrodes 0, 1 and 2 are touched and that something is in the proximity of the electrodes.

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.

func (*MultiTouchBricklet) Recalibrate

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

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

func (*MultiTouchBricklet) RegisterTouchStateCallback

func (device *MultiTouchBricklet) RegisterTouchStateCallback(fn func(uint16)) uint64

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

This callback is triggered every time the touch state changes.

func (*MultiTouchBricklet) SetElectrodeConfig

func (device *MultiTouchBricklet) SetElectrodeConfig(enabledElectrodes uint16) (err error)

Enables/disables electrodes with a bitfield (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 bit (bit 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.

Default: 8191 = 0x1FFF = 0b1111111111111 (all electrodes and proximity feature enabled)

func (*MultiTouchBricklet) SetElectrodeSensitivity

func (device *MultiTouchBricklet) 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 (*MultiTouchBricklet) SetResponseExpected

func (device *MultiTouchBricklet) 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 (*MultiTouchBricklet) SetResponseExpectedAll

func (device *MultiTouchBricklet) SetResponseExpectedAll(responseExpected bool)

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL