Dies ist die Beschreibung der MQTT API Bindings für das Joystick Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Joystick Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die MQTT API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 | # Change XYZ to the UID of your Joystick Bricklet 2.0
setup:
# Get current position
subscribe to tinkerforge/response/joystick_v2_bricklet/XYZ/get_position
publish '' to tinkerforge/request/joystick_v2_bricklet/XYZ/get_position
|
Download (example-callback.txt)
1 2 3 4 5 6 7 8 9 | # Change XYZ to the UID of your Joystick Bricklet 2.0
setup:
# Handle incoming pressed callbacks
subscribe to tinkerforge/callback/joystick_v2_bricklet/XYZ/pressed
publish '{"register": true}' to tinkerforge/register/joystick_v2_bricklet/XYZ/pressed # Register pressed callback
# Set period for pressed callback to 0.01s (10ms)
publish '{"period": 10, "value_has_to_change": true}' to tinkerforge/request/joystick_v2_bricklet/XYZ/set_pressed_callback_configuration
|
Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.
Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....
Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Position des Joystick zurück. Die Mittelposition des Joysticks ist x=0, y=0. Die zurückgegebenen Werte sind gemittelt und kalibriert (siehe request/joystick_v2_bricklet/<UID>/calibrate).
Wenn die Position periodisch abgefragt werden sollen, wird empfohlen den register/joystick_v2_bricklet/<UID>/position Callback zu nutzen und die Periode mit request/joystick_v2_bricklet/<UID>/set_position_callback_configuration vorzugeben.
Anfrage: |
|
---|---|
Antwort: |
|
Gibt true zurück wenn die Taste gedrückt ist und sonst false.
Wenn der Tastendruck periodisch abgefragt werden sollen, wird empfohlen den register/joystick_v2_bricklet/<UID>/pressed Callback zu nutzen und die Periode mit request/joystick_v2_bricklet/<UID>/set_pressed_callback_configuration vorzugeben.
Anfrage: |
|
---|---|
Antwort: |
|
Kalibriert die Mittelposition des Joysticks. Sollte der Joystick Bricklet 2.0 nicht x=0 und y=0 in der Mittelposition zurückgeben, kann diese Funktion aufgerufen werden wenn der Joystick sich unbewegt in der Mittelposition befindet.
Die resultierende Kalibrierung wird in nicht-flüchtigem Speicher gespeichert, somit ist die Kalibrierung nur einmalig notwendig.
Anfrage: |
|
---|---|
Antwort: |
|
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.
Anfrage: |
|
---|---|
Antwort: |
|
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 Symbole sind für diese Funktion verfügbar:
Für mode:
Für status:
Anfrage: |
|
---|---|
Antwort: |
|
Gibt den aktuellen Bootloader-Modus zurück, siehe request/joystick_v2_bricklet/<UID>/set_bootloader_mode.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
Anfrage: |
|
---|---|
Antwort: |
|
Setzt den Firmware-Pointer für request/joystick_v2_bricklet/<UID>/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.
Anfrage: |
|
---|---|
Antwort: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von request/joystick_v2_bricklet/<UID>/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.
Anfrage: |
|
---|---|
Antwort: |
|
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 Symbole sind für diese Funktion verfügbar:
Für config:
Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Konfiguration zurück, wie von request/joystick_v2_bricklet/<UID>/set_status_led_config gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
Anfrage: |
|
---|---|
Antwort: |
|
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.
Anfrage: |
|
---|---|
Antwort: |
|
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.
Anfrage: |
|
---|---|
Antwort: |
|
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.
Anfrage: |
|
---|---|
Antwort: |
|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
Anfrage: |
|
---|---|
Antwort: |
|
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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.
Der Display Name enthält den Anzeigenamen des Joystick 2.0.
Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/joystick_v2_bricklet/<UID>/position 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.
Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels request/joystick_v2_bricklet/<UID>/set_position_callback_configuration gesetzt.
Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/joystick_v2_bricklet/<UID>/pressed 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.
Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels request/joystick_v2_bricklet/<UID>/set_pressed_callback_configuration gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.
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.
Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/joystick_v2_bricklet/<UID>/position[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/joystick_v2_bricklet/<UID>/position[/<SUFFIX>]-Topic veröffentlicht.
Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/joystick_v2_bricklet/<UID>/set_position_callback_configuration gesetzten Konfiguration
Die Payload-Member des Callbacks sind die gleichen wie bei request/joystick_v2_bricklet/<UID>/get_position.
Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/joystick_v2_bricklet/<UID>/pressed[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/joystick_v2_bricklet/<UID>/pressed[/<SUFFIX>]-Topic veröffentlicht.
Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/joystick_v2_bricklet/<UID>/set_pressed_callback_configuration gesetzten Konfiguration
Der Payload-Member des Callbacks ist der gleiche wie bei request/joystick_v2_bricklet/<UID>/is_pressed.