openHAB - Multi Touch Bricklet

This is the description of the openHAB 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 openHAB API bindings is part of their general description.

Thing

UID:
  • tinkerforge:brickletmultitouch:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Sensitivity – Type: integer, Default: 181, Min: 5, Max: 201
  • 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.

  • Proximity Enabled – Type: boolean, Default: true
  • True enables the proximity feature, false disables it. It is recommended that you disable the proximity feature if not needed. This will reduce the amount of traffic that is produced.

  • Electrode 0 Enabled – Type: boolean, Default: true
  • 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. Disabling electrodes will also reduce power consumption.

  • Electrode 1 Enabled – Type: boolean, Default: true
  • 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. Disabling electrodes will also reduce power consumption.

  • Electrode 2 Enabled – Type: boolean, Default: true
  • 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. Disabling electrodes will also reduce power consumption.

  • Electrode 3 Enabled – Type: boolean, Default: true
  • 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. Disabling electrodes will also reduce power consumption.

  • Electrode 4 Enabled – Type: boolean, Default: true
  • 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. Disabling electrodes will also reduce power consumption.

  • Electrode 5 Enabled – Type: boolean, Default: true
  • 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. Disabling electrodes will also reduce power consumption.

  • Electrode 6 Enabled – Type: boolean, Default: true
  • 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. Disabling electrodes will also reduce power consumption.

  • Electrode 7 Enabled – Type: boolean, Default: true
  • 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. Disabling electrodes will also reduce power consumption.

  • Electrode 8 Enabled – Type: boolean, Default: true
  • 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. Disabling electrodes will also reduce power consumption.

  • Electrode 9 Enabled – Type: boolean, Default: true
  • 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. Disabling electrodes will also reduce power consumption.

  • Electrode 10 Enabled – Type: boolean, Default: true
  • 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. Disabling electrodes will also reduce power consumption.

  • Electrode 11 Enabled – Type: boolean, Default: true
  • 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. Disabling electrodes will also reduce power consumption.

Channels

Electrode 0

The current touch state. 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.

Type:
  • Switch
UID:
  • tinkerforge:brickletmultitouch:[UID]:BrickletMultiTouchElectrode0
Read only:
  • No
Predicate:
  • This channel will only be available if Electrode 0 Enabled is enabled.
Electrode 1

The current touch state. 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.

Type:
  • Switch
UID:
  • tinkerforge:brickletmultitouch:[UID]:BrickletMultiTouchElectrode1
Read only:
  • No
Predicate:
  • This channel will only be available if Electrode 1 Enabled is enabled.
Electrode 2

The current touch state. 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.

Type:
  • Switch
UID:
  • tinkerforge:brickletmultitouch:[UID]:BrickletMultiTouchElectrode2
Read only:
  • No
Predicate:
  • This channel will only be available if Electrode 2 Enabled is enabled.
Electrode 3

The current touch state. 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.

Type:
  • Switch
UID:
  • tinkerforge:brickletmultitouch:[UID]:BrickletMultiTouchElectrode3
Read only:
  • No
Predicate:
  • This channel will only be available if Electrode 3 Enabled is enabled.
Electrode 4

The current touch state. 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.

Type:
  • Switch
UID:
  • tinkerforge:brickletmultitouch:[UID]:BrickletMultiTouchElectrode4
Read only:
  • No
Predicate:
  • This channel will only be available if Electrode 4 Enabled is enabled.
Electrode 5

The current touch state. 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.

Type:
  • Switch
UID:
  • tinkerforge:brickletmultitouch:[UID]:BrickletMultiTouchElectrode5
Read only:
  • No
Predicate:
  • This channel will only be available if Electrode 5 Enabled is enabled.
Electrode 6

The current touch state. 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.

Type:
  • Switch
UID:
  • tinkerforge:brickletmultitouch:[UID]:BrickletMultiTouchElectrode6
Read only:
  • No
Predicate:
  • This channel will only be available if Electrode 6 Enabled is enabled.
Electrode 7

The current touch state. 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.

Type:
  • Switch
UID:
  • tinkerforge:brickletmultitouch:[UID]:BrickletMultiTouchElectrode7
Read only:
  • No
Predicate:
  • This channel will only be available if Electrode 7 Enabled is enabled.
Electrode 8

The current touch state. 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.

Type:
  • Switch
UID:
  • tinkerforge:brickletmultitouch:[UID]:BrickletMultiTouchElectrode8
Read only:
  • No
Predicate:
  • This channel will only be available if Electrode 8 Enabled is enabled.
Electrode 9

The current touch state. 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.

Type:
  • Switch
UID:
  • tinkerforge:brickletmultitouch:[UID]:BrickletMultiTouchElectrode9
Read only:
  • No
Predicate:
  • This channel will only be available if Electrode 9 Enabled is enabled.
Electrode 10

The current touch state. 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.

Type:
  • Switch
UID:
  • tinkerforge:brickletmultitouch:[UID]:BrickletMultiTouchElectrode10
Read only:
  • No
Predicate:
  • This channel will only be available if Electrode 10 Enabled is enabled.
Electrode 11

The current touch state. 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.

Type:
  • Switch
UID:
  • tinkerforge:brickletmultitouch:[UID]:BrickletMultiTouchElectrode11
Read only:
  • No
Predicate:
  • This channel will only be available if Electrode 11 Enabled is enabled.
Proximity

The current touch state. If a hand or similar is in proximity to the electrodes, this channel is toggled. The proximity is activated with a distance of 1-2cm. 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.

Type:
  • Switch
UID:
  • tinkerforge:brickletmultitouch:[UID]:BrickletMultiTouchProximity
Read only:
  • No
Predicate:
  • This channel will only be available if Proximity Enabled is enabled.
Recalibrate Electrodes

Recalibrates the electrodes. Trigger this channel whenever you changed or moved you electrodes.

Type:
  • Commands (String)
UID:
  • tinkerforge:brickletmultitouch:[UID]:BrickletMultiTouchRecalibrate
Read only:
  • No
Commands:
  • Accepts any string

Actions

Actions can be used in rules by creating an action object. All actions return a Map<String, Object>. Returned values can be accessed by name, sometimes the type deduction needs some hints, as shown below:

val actions = getActions("tinkerforge", "tinkerforge:brickletmultitouch:[UID]")
val hwVersion = actions.brickletMultiTouchGetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletMultiTouchGetTouchState()
Return Map:
  • state – Type: int, Range: [0 to 213 - 1]

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.

brickletMultiTouchRecalibrate()

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

brickletMultiTouchGetElectrodeConfig()
Return Map:
  • enabledElectrodes – Type: int, Range: [0 to 213 - 1], Default: 213 - 1

Returns the electrode configuration, as set by the thing configuration.

brickletMultiTouchGetElectrodeSensitivity()
Return Map:
  • sensitivity – Type: short, Range: [5 to 201], Default: 181

Returns the current sensitivity, as set by the thing configuration.

Advanced Actions

brickletMultiTouchGetIdentity()
Return Map:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardwareVersion – Type: short[], Length: 3
    • 0: major – Type: short, Range: [0 to 255]
    • 1: minor – Type: short, Range: [0 to 255]
    • 2: revision – Type: short, Range: [0 to 255]
  • firmwareVersion – Type: short[], Length: 3
    • 0: major – Type: short, Range: [0 to 255]
    • 1: minor – Type: short, Range: [0 to 255]
    • 2: revision – Type: short, Range: [0 to 255]
  • deviceIdentifier – Type: int, Range: [0 to 216 - 1]

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 is always as position 'z'.

The device identifier numbers can be found here