Dies ist die Beschreibung der Ruby API Bindings für das Multi Touch Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Multi Touch Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Ruby API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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 | #!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-
require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_multi_touch_v2'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Multi Touch Bricklet 2.0
ipcon = IPConnection.new # Create IP connection
mt = BrickletMultiTouchV2.new UID, ipcon # Create device object
ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected
# Get current touch state
state = mt.get_touch_state
puts "Electrode 0: #{state[0]}"
puts "Electrode 1: #{state[1]}"
puts "Electrode 2: #{state[2]}"
puts "Electrode 3: #{state[3]}"
puts "Electrode 4: #{state[4]}"
puts "Electrode 5: #{state[5]}"
puts "Electrode 6: #{state[6]}"
puts "Electrode 7: #{state[7]}"
puts "Electrode 8: #{state[8]}"
puts "Electrode 9: #{state[9]}"
puts "Electrode 10: #{state[10]}"
puts "Electrode 11: #{state[11]}"
puts "Proximity: #{state[12]}"
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
Download (example_callback.rb)
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 | #!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-
require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_multi_touch_v2'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Multi Touch Bricklet 2.0
ipcon = IPConnection.new # Create IP connection
mt = BrickletMultiTouchV2.new UID, ipcon # Create device object
ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected
# Register touch state callback
mt.register_callback(BrickletMultiTouchV2::CALLBACK_TOUCH_STATE) do |state|
puts "Electrode 0: #{state[0]}"
puts "Electrode 1: #{state[1]}"
puts "Electrode 2: #{state[2]}"
puts "Electrode 3: #{state[3]}"
puts "Electrode 4: #{state[4]}"
puts "Electrode 5: #{state[5]}"
puts "Electrode 6: #{state[6]}"
puts "Electrode 7: #{state[7]}"
puts "Electrode 8: #{state[8]}"
puts "Electrode 9: #{state[9]}"
puts "Electrode 10: #{state[10]}"
puts "Electrode 11: #{state[11]}"
puts "Proximity: #{state[12]}"
puts ''
end
# Set period for touch state callback to 0.01s (10ms)
mt.set_touch_state_callback_configuration 10, true
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
BrickletMultiTouchV2
::
new
(uid, ipcon) → multi_touch_v2¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
multi_touch_v2 = BrickletMultiTouchV2.new 'YOUR_DEVICE_UID', ipcon
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletMultiTouchV2
#
get_touch_state
→ [bool, ...]¶Rückgabe: |
|
---|
Gibt den aktuellen Tastzustand zurück. Der Zustand wird als Bool-Array repräsentiert.
Element 0 bis 11 repräsentieren die 12 Elektroden und Element 12 repräsentiert die Proximity (Nähe).
Wird eine Elektrode berührt, ist das korrespondierende Element true. Wenn eine Hand oder vergleichbares in der Nähe der Elektroden ist wird Element 12 auf true gesetzt.
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.
Wenn der Wert periodisch benötigt wird, kann auch der ::CALLBACK_TOUCH_STATE
Callback
verwendet werden. Der Callback wird mit der Funktion
#set_touch_state_callback_configuration
konfiguriert.
BrickletMultiTouchV2
#
recalibrate
→ nil¶Rekalibriert die Elektroden. Rufe diese Funktion auf wenn die Elektroden verändert oder bewegt wurden.
BrickletMultiTouchV2
#
set_electrode_config
(enabled_electrodes) → nil¶Parameter: |
|
---|
Aktiviert/deaktiviert Elektroden mit einem Bool-Array (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 die Proximity-Elektrode (Element 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.
BrickletMultiTouchV2
#
get_electrode_config
→ [bool, ...]¶Rückgabe: |
|
---|
Gibt die Elektrodenkonfiguration zurück, wie von #set_electrode_config
gesetzt.
BrickletMultiTouchV2
#
set_electrode_sensitivity
(sensitivity) → nil¶Parameter: |
|
---|
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.
BrickletMultiTouchV2
#
get_electrode_sensitivity
→ int¶Rückgabe: |
|
---|
Gibt die aktuelle Empfindlichkeit zurück, wie von
#set_electrode_sensitivity
gesetzt.
BrickletMultiTouchV2
#
set_touch_led_config
(config) → nil¶Parameter: |
|
---|
Konfiguriert die Touch-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option mit der LED den Touch-Zustand anzuzeigen (Elektrode berührt = LED an).
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletMultiTouchV2
#
get_touch_led_config
→ int¶Rückgabe: |
|
---|
Gibt die LED-Konfiguration zurück, wie von #set_touch_led_config
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletMultiTouchV2
#
get_spitfp_error_count
→ [int, int, int, int]¶Rückgabe-Array: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
BrickletMultiTouchV2
#
set_status_led_config
(config) → nil¶Parameter: |
|
---|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletMultiTouchV2
#
get_status_led_config
→ int¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von #set_status_led_config
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletMultiTouchV2
#
get_chip_temperature
→ int¶Rückgabe: |
|
---|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
BrickletMultiTouchV2
#
reset
→ nil¶Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
BrickletMultiTouchV2
#
get_identity
→ [str, str, chr, [int, ...], [int, ...], int]¶Rückgabe-Array: |
|
---|
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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
BrickletMultiTouchV2
#
register_callback
(callback_id) { |param [, ...]| block } → nil¶Parameter: |
|
---|
Registriert den block
für die gegebene callback_id
.
Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.
BrickletMultiTouchV2
#
set_touch_state_callback_configuration
(period, value_has_to_change) → nil¶Parameter: |
|
---|
Die Periode ist die Periode mit der der ::CALLBACK_TOUCH_STATE
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
BrickletMultiTouchV2
#
get_touch_state_callback_configuration
→ [int, bool]¶Rückgabe-Array: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
#set_touch_state_callback_configuration
gesetzt.
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit der Funktion #register_callback
des
Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID
und der zweite Parameter der Block:
multi_touch_v2.register_callback BrickletMultiTouchV2::CALLBACK_EXAMPLE, do |param|
puts "#{param}"
end
Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.
Bemerkung
Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.
BrickletMultiTouchV2
::
CALLBACK_TOUCH_STATE
¶Callback-Parameter: |
|
---|
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 mit
der eingestellten Periode (siehe #set_touch_state_callback_configuration
)
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.
BrickletMultiTouchV2
#
get_api_version
→ [int, ...]¶Rückgabe-Array: |
|
---|
Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.
BrickletMultiTouchV2
#
get_response_expected
(function_id) → bool¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.
Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt
werden, da diese Funktionen immer eine Antwort senden. Für
Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber
entfernt werden mittels #set_response_expected
. Für Setter-Funktionen ist
es standardmäßig nicht gesetzt, kann aber gesetzt werden.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für function_id:
BrickletMultiTouchV2
#
set_response_expected
(function_id, response_expected) → nil¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für function_id:
BrickletMultiTouchV2
#
set_response_expected_all
(response_expected) → nil¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
BrickletMultiTouchV2
#
set_bootloader_mode
(mode) → int¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
Für status:
BrickletMultiTouchV2
#
get_bootloader_mode
→ int¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe #set_bootloader_mode
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletMultiTouchV2
#
set_write_firmware_pointer
(pointer) → nil¶Parameter: |
|
---|
Setzt den Firmware-Pointer für #write_firmware
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickletMultiTouchV2
#
write_firmware
(data) → int¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
#set_write_firmware_pointer
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickletMultiTouchV2
#
write_uid
(uid) → nil¶Parameter: |
|
---|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
BrickletMultiTouchV2
#
read_uid
→ int¶Rückgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
BrickletMultiTouchV2
::
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Multi Touch Bricklet 2.0 zu identifizieren.
Die #get_identity()
Funktion und der
IPConnection::CALLBACK_ENUMERATE
Callback der IP Connection haben ein device_identifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
BrickletMultiTouchV2
::
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Multi Touch Bricklet 2.0 dar.