Go - Multi Touch Bricklet

This is the description of the Go API bindings for the Multi Touch Bricklet. General information and technical specifications for the Multi Touch Bricklet are summarized in its hardware description.

An installation guide for the Go API bindings is part of their general description. Additional documentation can be found on godoc.org.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (example_simple.go)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/multi_touch_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Multi Touch Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    mt, _ := multi_touch_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Get current touch state.
    state, _ := mt.GetTouchState()
    var str string

    if (state & (1 << 12)) == (1 << 12) {
        str += "In proximity, "
    }

    if (state & 0xfff) == 0 {
        str += "No electrodes touched"
    } else {
        str += "Electrodes "
        for i := uint(0); i < 12; i++ {
            if (state & (1 << i)) == (1 << i) {
                str += string(i) + " "
            }
        }
        str += "touched"
    }

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Callback

Download (example_callback.go)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/multi_touch_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Multi Touch Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    mt, _ := multi_touch_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    mt.RegisterTouchStateCallback(func(state uint16) {
        var str string

        if (state & (1 << 12)) == (1 << 12) {
            str += "In proximity, "
        }

        if (state & 0xfff) == 0 {
            str += "No electrodes touched"
        } else {
            str += "Electrodes "
            for i := uint(0); i < 12; i++ {
                if (state & (1 << i)) == (1 << i) {
                    str += string(i) + " "
                }
            }
            str += "touched"
        }
        fmt.Print(str)
    })

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

The Multi Touch Bricklet API is defined in the package github.com/Tinkerforge/go-api-bindings/multi_touch_bricklet

Nearly every function of the Go bindings can return an ipconnection.DeviceError, implementing the error interface. The error can have one of the following values:

  • ipconnection.DeviceErrorSuccess = 0
  • ipconnection.DeviceErrorInvalidParameter = 1
  • ipconnection.DeviceErrorFunctionNotSupported = 2
  • ipconnection.DeviceErrorUnknownError = 3

which correspond to the values returned from Bricks and Bricklets.

All functions listed below are thread-safe.

Basic Functions

func multi_touch_bricklet.New(uid string, ipcon *IPConnection) (device MultiTouchBricklet, err error)
Parameters:
  • uid – Type: string
  • ipcon – Type: *IPConnection
Returns:
  • device – Type: MultiTouchBricklet
  • err – Type: error

Creates a new MultiTouchBricklet object with the unique device ID uid and adds it to the IPConnection ipcon:

device, err := multi_touch_bricklet.New("YOUR_DEVICE_UID", &ipcon)

This device object can be used after the IPConnection has been connected (see examples above).

func (*MultiTouchBricklet) GetTouchState() (state uint16, err error)
Returns:
  • state – Type: uint16, Range: [0 to 8191]
  • err – Type: 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() (err error)
Returns:
  • err – Type: error

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

func (*MultiTouchBricklet) SetElectrodeConfig(enabledElectrodes uint16) (err error)
Parameters:
  • enabledElectrodes – Type: uint16, Range: [0 to 8191], Default: 8191
Returns:
  • err – Type: 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) GetElectrodeConfig() (enabledElectrodes uint16, err error)
Returns:
  • enabledElectrodes – Type: uint16, Range: [0 to 8191], Default: 8191
  • err – Type: error

Returns the electrode configuration, as set by SetElectrodeConfig().

func (*MultiTouchBricklet) SetElectrodeSensitivity(sensitivity uint8) (err error)
Parameters:
  • sensitivity – Type: uint8, Range: [5 to 201], Default: 181
Returns:
  • err – Type: 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) GetElectrodeSensitivity() (sensitivity uint8, err error)
Returns:
  • sensitivity – Type: uint8, Range: [5 to 201], Default: 181
  • err – Type: error

Returns the current sensitivity, as set by SetElectrodeSensitivity().

Advanced Functions

func (*MultiTouchBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Returns:
  • uid – Type: string, Length: up to 8
  • connectedUid – Type: string, Length: up to 8
  • position – Type: rune, Range: ['a' to 'h', 'i', 'z']
  • hardwareVersion – Type: [3]uint8
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • firmwareVersion – Type: [3]uint8
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • deviceIdentifier – Type: uint16, Range: [0 to 216 - 1]
  • err – Type: 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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding Register*Callback function, which returns a unique callback ID. This ID can be used to deregister the callback later with the corresponding Deregister*Callback function.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

func (*MultiTouchBricklet) RegisterTouchStateCallback(func(state uint16)) (registrationId uint64)
Callback Parameters:
  • state – Type: uint16, Range: [0 to 8191]
Returns:
  • registrationId – Type: uint64

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

This callback is triggered every time the touch state changes.

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

func (*MultiTouchBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)
Returns:
  • apiVersion – Type: [3]uint8
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • err – Type: error

Returns the version of the API definition 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) GetResponseExpected(functionId uint8) (responseExpected bool, err error)
Parameters:
  • functionId – Type: uint8, Range: See constants
Returns:
  • responseExpected – Type: bool
  • err – Type: 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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • multi_touch_bricklet.FunctionRecalibrate = 2
  • multi_touch_bricklet.FunctionSetElectrodeConfig = 3
  • multi_touch_bricklet.FunctionSetElectrodeSensitivity = 6
func (*MultiTouchBricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)
Parameters:
  • functionId – Type: uint8, Range: See constants
  • responseExpected – Type: bool
Returns:
  • err – Type: 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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • multi_touch_bricklet.FunctionRecalibrate = 2
  • multi_touch_bricklet.FunctionSetElectrodeConfig = 3
  • multi_touch_bricklet.FunctionSetElectrodeSensitivity = 6
func (*MultiTouchBricklet) SetResponseExpectedAll(responseExpected bool) (err error)
Parameters:
  • responseExpected – Type: bool
Returns:
  • err – Type: error

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

Constants

multi_touch_bricklet.DeviceIdentifier

This constant is used to identify a Multi Touch Bricklet.

The GetIdentity() function and the (*IPConnection) RegisterEnumerateCallback callback of the IPConnection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

multi_touch_bricklet.DeviceDisplayName

This constant represents the human readable name of a Multi Touch Bricklet.