Modbus - Multi Touch Bricklet

Dies ist die Beschreibung des Modbus Protokolls für das Multi Touch Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Multi Touch Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletMultiTouch.get_touch_state
Funktions-ID:
  • 1
Anfrage:
  • keine Nutzdaten
Antwort:
  • state – Typ: uint16, Wertebereich: [0 bis 213 - 1]

Gibt den aktuellen Tastzustand zurück. Der Zustand ist als ein Bitfeld repräsentiert.

Bits 0 bis 11 repräsentieren die 12 Elektroden und Bit 12 repräsentiert die Proximity (Nähe).

Wird eine Elektrode berührt, ist das korrespondierende Bit true. Wenn eine Hand oder vergleichbares in der Nähe der Elektroden ist wird Bit 12 auf true gesetzt.

Beispiel: Der Zustand 4103 = 0x1007 = 0b1000000000111 bedeutet dass die Elektroden 0, 1 und 2 berührt werden und das sich etwas in der nähe der Elektroden befindet.

Das Proximity Bit wird ab einer Distanz von ca. 1-2cm aktiviert. Eine Elektrode wird schon als berührt gezählt wenn ein Finger sie beinahe berührt. Dadurch ist es möglich ein Stück Papier oder Folie über die Elektrode zu kleben um damit ein Touchpanel mit einem professionellen Aussehen zu bauen.

BrickletMultiTouch.recalibrate
Funktions-ID:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Rekalibriert die Elektroden. Rufe diese Funktion auf wenn die Elektroden verändert oder bewegt wurden.

BrickletMultiTouch.set_electrode_config
Funktions-ID:
  • 3
Anfrage:
  • enabled_electrodes – Typ: uint16, Wertebereich: [0 bis 213 - 1], Standardwert: 213 - 1
Antwort:
  • keine Antwort

Aktiviert/deaktiviert Elektroden mit einem Bitfeld (siehe get_touch_state).

True aktiviert eine Elektrode, false deaktiviert eine Elektrode. Eine deaktivierte Elektrode hat immer den Zustand false. Wenn nicht alle Elektroden gebraucht werden können die ungebrauchten deaktiviert werden.

Wir empfehlen das Proximity Bit (Bit 12) zu deaktivieren wenn das Proximity-Feature nicht benötigt wird. Das verringert den Datenverkehr der durch den CALLBACK_TOUCH_STATE Callback ausgelöst wird.

Eine deaktivierte Elektrode verringert zusätzlich den Stromverbrauch.

Standardwert: 8191 = 0x1FFF = 0b1111111111111 (alle Elektroden und Proximity-Feature aktiviert)

BrickletMultiTouch.get_electrode_config
Funktions-ID:
  • 4
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled_electrodes – Typ: uint16, Wertebereich: [0 bis 213 - 1], Standardwert: 213 - 1

Gibt die Elektrodenkonfiguration zurück, wie von set_electrode_config gesetzt.

BrickletMultiTouch.set_electrode_sensitivity
Funktions-ID:
  • 6
Anfrage:
  • sensitivity – Typ: uint8, Wertebereich: [5 bis 201], Standardwert: 181
Antwort:
  • keine Antwort

Setzt die Empfindlichkeit der Elektrode. Eine Elektrode mit einer hohen Empfindlichkeit registriert eine Berührung früher als eine Elektrode mit einer niedrigen Empfindlichkeit.

Wenn eine große Elektrode verwendet wird sollte die Empfindlichkeit verringert werden, da eine größere Fläche aufgeladen werden kann. Wenn eine Elektrode aus größerem Abstand aktivierbar seien soll, muss die Empfindlichkeit vergrößert werden.

Nachdem eine neue Empfindlichkeit gesetzt wurde, macht es Sinn recalibrate aufzurufen damit die Elektroden mit der neu definierten Empfindlichkeit kalibriert werden.

BrickletMultiTouch.get_electrode_sensitivity
Funktions-ID:
  • 7
Anfrage:
  • keine Nutzdaten
Antwort:
  • sensitivity – Typ: uint8, Wertebereich: [5 bis 201], Standardwert: 181

Gibt die aktuelle Empfindlichkeit zurück, wie von set_electrode_sensitivity gesetzt.

Fortgeschrittene Funktionen

BrickletMultiTouch.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'z']
  • hardware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Callbacks

BrickletMultiTouch.CALLBACK_TOUCH_STATE
Funktions-ID:
  • 5
Antwort:
  • state – Typ: uint16, Wertebereich: [0 bis 213 - 1]

Gibt den aktuellen Tastzustand zurück, siehe get_touch_state für mehr Informationen über den Zustand.

Dieser Callback wird ausgelöst, wenn sich ein Tastzustand ändert.