MQTT - Rotary Poti Bricklet

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

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

Callback

Download (example-callback.txt)

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

setup:
    # Handle incoming position callbacks
    subscribe to tinkerforge/callback/rotary_poti_bricklet/XYZ/position
    publish '{"register": true}' to tinkerforge/register/rotary_poti_bricklet/XYZ/position # Register position callback
    
    # Set period for position callback to 0.05s (50ms)
    # Note: The position callback is only called every 0.05 seconds
    #       if the position has changed since the last call!
    publish '{"period": 50}' to tinkerforge/request/rotary_poti_bricklet/XYZ/set_position_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"-Attribut 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_poti_bricklet/<UID>/get_position
Response-Payload:
  • position -- int

Gibt die Position des Drehpotentiometers zurück. Der Wertebereich ist in Grad und ist von -150° (links gedreht) und 150° (rechts gedreht).

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

Fortgeschrittene Funktionen

request/rotary_poti_bricklet/<UID>/get_analog_value
Response-Payload:
  • value -- int

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Bemerkung

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

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den register/rotary_poti_bricklet/<UID>/analog_value Callback zu nutzen und die Periode mit request/rotary_poti_bricklet/<UID>/set_analog_value_callback_period vorzugeben.

request/rotary_poti_bricklet/<UID>/get_identity
Response-Payload:
  • uid -- string
  • connected_uid -- string
  • position -- string
  • hardware_version -- [int,int,int]
  • firmware_version -- [int,int,int]
  • device_identifier -- int (hat Symbole)
  • _display_name -- 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 kann 'a', 'b', 'c' oder 'd' sein.

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

Konfigurationsfunktionen für Callbacks

request/rotary_poti_bricklet/<UID>/set_position_callback_period
Request-Payload:
  • period -- int

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

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

Der Standardwert ist 0.

request/rotary_poti_bricklet/<UID>/get_position_callback_period
Response-Payload:
  • period -- int

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

request/rotary_poti_bricklet/<UID>/set_analog_value_callback_period
Request-Payload:
  • period -- int

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

Der register/rotary_poti_bricklet/<UID>/analog_value Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

request/rotary_poti_bricklet/<UID>/get_analog_value_callback_period
Response-Payload:
  • period -- int

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

request/rotary_poti_bricklet/<UID>/set_position_callback_threshold
Request-Payload:
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

Setzt den Schwellwert für den register/rotary_poti_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 der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Position größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0).

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

für option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'
request/rotary_poti_bricklet/<UID>/get_position_callback_threshold
Response-Payload:
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

Gibt den Schwellwert zurück, wie von request/rotary_poti_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/rotary_poti_bricklet/<UID>/set_analog_value_callback_threshold
Request-Payload:
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

Setzt den Schwellwert für den register/rotary_poti_bricklet/<UID>/analog_value_reached Callback.

Die folgenden Optionen sind möglich:

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

Der Standardwert ist ('x', 0, 0).

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

für option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'
request/rotary_poti_bricklet/<UID>/get_analog_value_callback_threshold
Response-Payload:
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

Gibt den Schwellwert zurück, wie von request/rotary_poti_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/rotary_poti_bricklet/<UID>/set_debounce_period
Request-Payload:
  • debounce -- int

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

request/rotary_poti_bricklet/<UID>/get_debounce_period
Response-Payload:
  • debounce -- int

Gibt die Entprellperiode zurück, wie von request/rotary_poti_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_poti_bricklet/<UID>/position
Request-Payload:
  • register -- bool
Response-Payload:
  • position -- int

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

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

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

register/rotary_poti_bricklet/<UID>/analog_value
Request-Payload:
  • register -- bool
Response-Payload:
  • value -- int

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/rotary_poti_bricklet/<UID>/set_analog_value_callback_period, ausgelöst. Der Payload des Callbacks ist der Analogwert des Drehpotentiometers.

Der register/rotary_poti_bricklet/<UID>/analog_value Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

register/rotary_poti_bricklet/<UID>/position_reached
Request-Payload:
  • register -- bool
Response-Payload:
  • position -- int

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

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

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

register/rotary_poti_bricklet/<UID>/analog_value_reached
Request-Payload:
  • register -- bool
Response-Payload:
  • value -- int

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/rotary_poti_bricklet/<UID>/set_analog_value_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist der Analogwert des Drehpotentiometers.

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