MQTT - Rotary Encoder Bricklet

Dies ist die Beschreibung der MQTT API Bindings für das Rotary Encoder Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Rotary Encoder 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)

1
2
3
4
5
6
# Change XYZ to the UID of your Rotary Encoder Bricklet

setup:
    # Get current count without reset
    subscribe to tinkerforge/response/rotary_encoder_bricklet/XYZ/get_count
    publish '{"reset": false}' to tinkerforge/request/rotary_encoder_bricklet/XYZ/get_count

Callback

Download (example-callback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Change XYZ to the UID of your Rotary Encoder Bricklet

setup:
    # Handle incoming count callbacks
    subscribe to tinkerforge/callback/rotary_encoder_bricklet/XYZ/count
    publish '{"register": true}' to tinkerforge/register/rotary_encoder_bricklet/XYZ/count # Register count callback
    
    # Set period for count callback to 0.05s (50ms)
    # Note: The count callback is only called every 0.05 seconds
    #       if the count has changed since the last call!
    publish '{"period": 50}' to tinkerforge/request/rotary_encoder_bricklet/XYZ/set_count_callback_period

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/rotary_encoder_bricklet/<UID>/get_count
Anfrage:
  • reset – Typ: bool
Antwort:
  • count – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt den aktuellen Zählerwert des Encoders zurück. Wenn reset auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurück gesetzt.

Der Encoder hat 24 Schritte pro Umdrehung.

Wenn der Encoder nach links gedreht wird wird der Zählerwert dekrementiert, d.h. negative Zählerwerte sind möglich.

request/rotary_encoder_bricklet/<UID>/is_pressed
Anfrage:
  • keine Nutzdaten
Antwort:
  • pressed – Typ: bool

Gibt true zurück wenn der Taster gedrückt ist und sonst false.

Es wird empfohlen die register/rotary_encoder_bricklet/<UID>/pressed und register/rotary_encoder_bricklet/<UID>/released Callbacks zu nutzen, um den Taster programmatisch zu behandeln.

Fortgeschrittene Funktionen

request/rotary_encoder_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", "i", "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 216 - 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 '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 Rotary Encoder.

Konfigurationsfunktionen für Callbacks

request/rotary_encoder_bricklet/<UID>/set_count_callback_period
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt die Periode mit welcher der register/rotary_encoder_bricklet/<UID>/count Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/rotary_encoder_bricklet/<UID>/count Callback wird nur ausgelöst, wenn sich der Zählerwert seit der letzten Auslösung geändert hat.

request/rotary_encoder_bricklet/<UID>/get_count_callback_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/rotary_encoder_bricklet/<UID>/set_count_callback_period gesetzt.

request/rotary_encoder_bricklet/<UID>/set_count_callback_threshold
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Schwellwert für den register/rotary_encoder_bricklet/<UID>/count_reached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn der Zählerwert außerhalb der min und max Werte ist
'i' Callback wird ausgelöst, wenn die Zählerwert innerhalb der min und max Werte ist
'<' Callback wird ausgelöst, wenn die Zählerwert kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Zählerwert größer als der min Wert 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/rotary_encoder_bricklet/<UID>/get_count_callback_threshold
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von request/rotary_encoder_bricklet/<UID>/set_count_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/rotary_encoder_bricklet/<UID>/set_debounce_period
Anfrage:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Antwort:
  • keine Antwort

Setzt die Periode mit welcher der Schwellwert-Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

request/rotary_encoder_bricklet/<UID>/get_debounce_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von request/rotary_encoder_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/rotary_encoder_bricklet/<UID>/count
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • count – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/rotary_encoder_bricklet/<UID>/set_count_callback_period, ausgelöst. Der Payload des Callbacks ist der Zählerwert des Encoders.

Der register/rotary_encoder_bricklet/<UID>/count Callback wird nur ausgelöst, wenn sich der Zähler seit der letzten Auslösung geändert hat.

register/rotary_encoder_bricklet/<UID>/count_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • count – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/rotary_encoder_bricklet/<UID>/set_count_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist der Zählerwert des Encoders.

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

register/rotary_encoder_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/rotary_encoder_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/rotary_encoder_bricklet/<UID>/pressed[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn der Taster gedrückt wird.

register/rotary_encoder_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/rotary_encoder_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/rotary_encoder_bricklet/<UID>/released[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn der Taster losgelassen wird.