MQTT - Joystick Bricklet¶

Dies ist die Beschreibung der MQTT API Bindings für das Joystick Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Joystick Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die MQTT API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (example-simple.txt)

# Change XYZ to the UID of your Joystick Bricklet

setup:
    # Get current position
    subscribe to tinkerforge/response/joystick_bricklet/XYZ/get_position
    publish '' to tinkerforge/request/joystick_bricklet/XYZ/get_position

Callback¶

Download (example-callback.txt)

# Change XYZ to the UID of your Joystick Bricklet

setup:
    # Handle incoming pressed callbacks
    subscribe to tinkerforge/callback/joystick_bricklet/XYZ/pressed
    publish '{"register": true}' to tinkerforge/register/joystick_bricklet/XYZ/pressed # Register pressed callback

    # Handle incoming released callbacks
    subscribe to tinkerforge/callback/joystick_bricklet/XYZ/released
    publish '{"register": true}' to tinkerforge/register/joystick_bricklet/XYZ/released # Register released callback

Find Borders¶

Download (example-find-borders.txt)

# Change XYZ to the UID of your Joystick Bricklet

setup:
    # Get threshold callbacks with a debounce time of 0.2 seconds (200ms)
    publish '{"debounce": 200}' to tinkerforge/request/joystick_bricklet/XYZ/set_debounce_period

    # Handle incoming position reached callbacks
    subscribe to tinkerforge/callback/joystick_bricklet/XYZ/position_reached
        if a message arrives
            # message contains x and y as int
            if y == 100
                print "Top"
            elseif y == -100
                print "Bottom"
            endif

            if x == 100
                print "Right"
            elseif x == -100
                print "Left"
            endif

            print "\n"
        endif
    endsubscribe

    publish '{"register": true}' to tinkerforge/register/joystick_bricklet/XYZ/position_reached # Register position_reached callback

    # Configure threshold for position "outside of -99, -99 to 99, 99"
    publish '{"option": "outside", "min_x": -99, "max_x": 99, "min_y": -99, "max_y": 99}' to tinkerforge/request/joystick_bricklet/XYZ/set_position_callback_threshold

API¶

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/....

Grundfunktionen¶

request/joystick_bricklet/<UID>/get_position¶

Anfrage:	keine Nutzdaten
Antwort:	x – Typ: int, Wertebereich: [-100 bis 100] y – Typ: int, Wertebereich: [-100 bis 100]

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_bricklet/<UID>/calibrate()).

Wenn die Position periodisch abgefragt werden sollen, wird empfohlen den register/joystick_bricklet/<UID>/position() Callback zu nutzen und die Periode mit request/joystick_bricklet/<UID>/set_position_callback_period() vorzugeben.

request/joystick_bricklet/<UID>/is_pressed¶

Anfrage:	keine Nutzdaten
Antwort:	pressed – Typ: bool

Gibt true zurück wenn die Taste gedrückt ist und sonst false.

Es wird empfohlen die register/joystick_bricklet/<UID>/pressed() und register/joystick_bricklet/<UID>/released() Callbacks zu nutzen, um die Taste programmatisch zu behandeln.

Fortgeschrittene Funktionen¶

request/joystick_bricklet/<UID>/get_analog_value¶

Anfrage:	keine Nutzdaten
Antwort:	x – Typ: int, Wertebereich: [0 bis 2¹² - 1] y – Typ: int, Wertebereich: [0 bis 2¹² - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von request/joystick_bricklet/<UID>/get_position() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während request/joystick_bricklet/<UID>/get_analog_value() unverarbeitete Analogwerte zurück gibt. Der einzige Grund request/joystick_bricklet/<UID>/get_analog_value() zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn die Analogwerte periodisch abgefragt werden sollen, wird empfohlen den register/joystick_bricklet/<UID>/analog_value() Callback zu nutzen und die Periode mit request/joystick_bricklet/<UID>/set_analog_value_callback_period() vorzugeben.

request/joystick_bricklet/<UID>/calibrate¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Kalibriert die Mittelposition des Joysticks. Sollte der Joystick Bricklet 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 den EEPROM des Joystick Bricklet gespeichert, somit ist die Kalibrierung nur einmalig notwendig.

request/joystick_bricklet/<UID>/get_identity¶

Anfrage:

keine Nutzdaten

Antwort:

uid – Typ: string, Länge: bis zu 8
connected_uid – Typ: string, Länge: bis zu 8
position – Typ: char, Wertebereich: ["a" bis "h", "z"]
hardware_version – Typ: [int, ...], Länge: 3

0: major – Typ: int, Wertebereich: [0 bis 255]
1: minor – Typ: int, Wertebereich: [0 bis 255]
2: revision – Typ: int, Wertebereich: [0 bis 255]

firmware_version – Typ: [int, ...], Länge: 3

0: major – Typ: int, Wertebereich: [0 bis 255]
1: minor – Typ: int, Wertebereich: [0 bis 255]
2: revision – Typ: int, Wertebereich: [0 bis 255]

device_identifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
_display_name – Typ: string

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. 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.

Konfigurationsfunktionen für Callbacks¶

request/joystick_bricklet/<UID>/set_position_callback_period¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der register/joystick_bricklet/<UID>/position() Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

The register/joystick_bricklet/<UID>/position() Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

request/joystick_bricklet/<UID>/get_position_callback_period¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/joystick_bricklet/<UID>/set_position_callback_period() gesetzt.

request/joystick_bricklet/<UID>/set_analog_value_callback_period¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der register/joystick_bricklet/<UID>/analog_value() Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/joystick_bricklet/<UID>/analog_value() Callback wird nur ausgelöst, wenn sich die Analogwerte seit der letzten Auslösung geändert hat.

request/joystick_bricklet/<UID>/get_analog_value_callback_period¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/joystick_bricklet/<UID>/set_analog_value_callback_period() gesetzt.

request/joystick_bricklet/<UID>/set_position_callback_threshold¶

Anfrage:	option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min_x – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max_x – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 min_y – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max_y – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt den Schwellwert für den register/joystick_bricklet/<UID>/position_reached() Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Position außerhalb der min und max Werte ist
'i'	Callback wird ausgelöst, wenn die Position innerhalb der min und max Werte ist
'<'	Callback wird ausgelöst, wenn die Position kleiner als die min Werte ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Position größer als die min Werte ist (max wird ignoriert)

Die folgenden Symbole sind für diese Funktion verfügbar:

Für option:

"off" = "x"
"outside" = "o"
"inside" = "i"
"smaller" = "<"
"greater" = ">"

request/joystick_bricklet/<UID>/get_position_callback_threshold¶

Anfrage:	keine Nutzdaten
Antwort:	option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min_x – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max_x – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 min_y – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max_y – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von request/joystick_bricklet/<UID>/set_position_callback_threshold() gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für option:

"off" = "x"
"outside" = "o"
"inside" = "i"
"smaller" = "<"
"greater" = ">"

request/joystick_bricklet/<UID>/set_analog_value_callback_threshold¶

Anfrage:	option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min_x – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max_x – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 min_y – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max_y – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt den Schwellwert für den register/joystick_bricklet/<UID>/analog_value_reached() Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Analogwerte außerhalb der min und max Werte ist
'i'	Callback wird ausgelöst, wenn die Analogwerte innerhalb der min und max Werte ist
'<'	Callback wird ausgelöst, wenn die Analogwerte kleiner als die min Werte ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Analogwerte größer als die min Werte ist (max wird ignoriert)

Die folgenden Symbole sind für diese Funktion verfügbar:

Für option:

"off" = "x"
"outside" = "o"
"inside" = "i"
"smaller" = "<"
"greater" = ">"

request/joystick_bricklet/<UID>/get_analog_value_callback_threshold¶

Anfrage:	keine Nutzdaten
Antwort:	option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min_x – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max_x – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 min_y – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max_y – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von request/joystick_bricklet/<UID>/set_analog_value_callback_threshold() gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für option:

"off" = "x"
"outside" = "o"
"inside" = "i"
"smaller" = "<"
"greater" = ">"

request/joystick_bricklet/<UID>/set_debounce_period¶

Anfrage:	debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100
Antwort:	keine Antwort

Setzt die Periode mit welcher die Schwellwert Callbacks

register/joystick_bricklet/<UID>/position_reached(),
register/joystick_bricklet/<UID>/analog_value_reached()

ausgelöst werden, wenn die Schwellwerte

request/joystick_bricklet/<UID>/set_position_callback_threshold(),
request/joystick_bricklet/<UID>/set_analog_value_callback_threshold()

weiterhin erreicht bleiben.

request/joystick_bricklet/<UID>/get_debounce_period¶

Anfrage:	keine Nutzdaten
Antwort:	debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von request/joystick_bricklet/<UID>/set_debounce_period() gesetzt.

Callbacks¶

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.

register/joystick_bricklet/<UID>/position¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	x – Typ: int, Wertebereich: [-100 bis 100] y – Typ: int, Wertebereich: [-100 bis 100]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/joystick_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_bricklet/<UID>/position[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/joystick_bricklet/<UID>/set_position_callback_period(), ausgelöst. Der Payload des Callbacks ist die Position des Joysticks.

Der register/joystick_bricklet/<UID>/position() Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

register/joystick_bricklet/<UID>/analog_value¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	x – Typ: int, Wertebereich: [0 bis 2¹² - 1] y – Typ: int, Wertebereich: [0 bis 2¹² - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/joystick_bricklet/<UID>/analog_value[/<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_bricklet/<UID>/analog_value[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/joystick_bricklet/<UID>/set_analog_value_callback_period(), ausgelöst. Der Payload des Callbacks sind die Analogwerte des Joysticks.

Der register/joystick_bricklet/<UID>/analog_value() Callback wird nur ausgelöst, wenn sich die Analogwerte seit der letzten Auslösung geändert hat.

register/joystick_bricklet/<UID>/position_reached¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	x – Typ: int, Wertebereich: [-100 bis 100] y – Typ: int, Wertebereich: [-100 bis 100]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/joystick_bricklet/<UID>/position_reached[/<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_bricklet/<UID>/position_reached[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/joystick_bricklet/<UID>/set_position_callback_threshold() gesetzt, erreicht wird. Der Payload des Callbacks ist die Position des Joysticks.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit request/joystick_bricklet/<UID>/set_debounce_period() gesetzt, ausgelöst.

register/joystick_bricklet/<UID>/analog_value_reached¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	x – Typ: int, Wertebereich: [0 bis 2¹² - 1] y – Typ: int, Wertebereich: [0 bis 2¹² - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/joystick_bricklet/<UID>/analog_value_reached[/<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_bricklet/<UID>/analog_value_reached[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/joystick_bricklet/<UID>/set_analog_value_callback_threshold() gesetzt, erreicht wird. Der Payload des Callbacks sind die Analogwerte des Joystick.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit request/joystick_bricklet/<UID>/set_debounce_period() gesetzt, ausgelöst.

register/joystick_bricklet/<UID>/pressed¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	keine Nutzdaten

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/joystick_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_bricklet/<UID>/pressed[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn die Taste gedrückt wird.

register/joystick_bricklet/<UID>/released¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	keine Nutzdaten

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/joystick_bricklet/<UID>/released[/<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_bricklet/<UID>/released[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn die Taste losgelassen wird.