MQTT - Distance US Bricklet

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

setup:
    # Get current distance value
    subscribe to tinkerforge/response/distance_us_bricklet/XYZ/get_distance_value
    publish '' to tinkerforge/request/distance_us_bricklet/XYZ/get_distance_value

Callback

Download (example-callback.txt)

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

setup:
    # Handle incoming distance value callbacks
    subscribe to tinkerforge/callback/distance_us_bricklet/XYZ/distance
    publish '{"register": true}' to tinkerforge/register/distance_us_bricklet/XYZ/distance # Register distance callback
    
    # Set period for distance value callback to 0.2s (200ms)
    # Note: The distance value callback is only called every 0.2 seconds
    #       if the distance value has changed since the last call!
    publish '{"period": 200}' to tinkerforge/request/distance_us_bricklet/XYZ/set_distance_callback_period

Threshold

Download (example-threshold.txt)

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

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/distance-us_bricklet/XYZ/set_debounce_period
    
    # Handle incoming distance value reached callbacks
    subscribe to tinkerforge/callback/distance_us_bricklet/XYZ/distance_reached
    publish '{"register": true}' to tinkerforge/register/distance_us_bricklet/XYZ/distance_reached # Register distance_reached callback
    
    # Configure threshold for distance value "smaller than 200"
    publish '{"option": "smaller", "min": 200, "max": 0}' to tinkerforge/request/distance_us_bricklet/XYZ/set_distance_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/distance_us_bricklet/<UID>/get_distance_value
Anfrage:
  • keine Nutzdaten
Antwort:
  • distance – Typ: int, Wertebereich: [0 bis 4095]

Gibt den aktuellen Entfernungswert zurück. Ein kleiner Wert entspricht einer kleinen Entfernung, ein großer Wert entspricht einer großen Entfernung. Das Verhältnis zwischen gemessenem Entfernungswert und wirklicher Entfernung wird durch die 5V Versorgungsspannung beeinflusst (Abweichungen der Versorgungsspannung führen zu Abweichungen in den Entfernungswerten) und ist nicht-linear (Auflösung ist größer im Nahbereich).

Wenn der Entfernungswert periodisch abgefragt werden soll, wird empfohlen den register/distance_us_bricklet/<UID>/distance Callback zu nutzen und die Periode mit request/distance_us_bricklet/<UID>/set_distance_callback_period vorzugeben.

Fortgeschrittene Funktionen

request/distance_us_bricklet/<UID>/set_moving_average
Anfrage:
  • average – Typ: int, Wertebereich: [0 bis 100], Standardwert: 20
Antwort:
  • keine Antwort

Setzt die Länge eines gleitenden Mittelwerts für den Entfernungswert.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

request/distance_us_bricklet/<UID>/get_moving_average
Anfrage:
  • keine Nutzdaten
Antwort:
  • average – Typ: int, Wertebereich: [0 bis 100], Standardwert: 20

Gibt die Länge des gleitenden Mittelwerts zurück, wie von request/distance_us_bricklet/<UID>/set_moving_average gesetzt.

request/distance_us_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
  • hardware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3, 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 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 Distance US.

Konfigurationsfunktionen für Callbacks

request/distance_us_bricklet/<UID>/set_distance_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/distance_us_bricklet/<UID>/distance Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

request/distance_us_bricklet/<UID>/get_distance_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/distance_us_bricklet/<UID>/set_distance_callback_period gesetzt.

request/distance_us_bricklet/<UID>/set_distance_callback_threshold
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Wertebereich: [0 bis 4095]
  • max – Typ: int, Wertebereich: [0 bis 4095]
Antwort:
  • keine Antwort

Setzt den Schwellwert für den register/distance_us_bricklet/<UID>/distance_reached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn der Entfernungswert außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn der Entfernungswert innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn der Entfernungswert kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn der Entfernungswert 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/distance_us_bricklet/<UID>/get_distance_callback_threshold
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Wertebereich: [0 bis 4095]
  • max – Typ: int, Wertebereich: [0 bis 4095]

Gibt den Schwellwert zurück, wie von request/distance_us_bricklet/<UID>/set_distance_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/distance_us_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 die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

request/distance_us_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/distance_us_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/distance_us_bricklet/<UID>/distance
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • distance – Typ: int, Wertebereich: [0 bis 4095]

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/distance_us_bricklet/<UID>/set_distance_callback_period, ausgelöst. Der Payload des Callbacks ist die Entfernungswert des Sensors.

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

register/distance_us_bricklet/<UID>/distance_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • distance – Typ: int, Wertebereich: [0 bis 4095]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/distance_us_bricklet/<UID>/set_distance_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist der Entfernungswert des Sensors.

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