MQTT - Line Bricklet

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

setup:
    # Get current reflectivity
    subscribe to tinkerforge/response/line_bricklet/XYZ/get_reflectivity
    publish '' to tinkerforge/request/line_bricklet/XYZ/get_reflectivity

Callback

Download (example-callback.txt)

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

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

    # Set period for reflectivity callback to 1s (1000ms)
    # Note: The reflectivity callback is only called every second
    #       if the reflectivity has changed since the last call!
    publish '{"period": 1000}' to tinkerforge/request/line_bricklet/XYZ/set_reflectivity_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 Line Bricklet

setup:
    # Get threshold callbacks with a debounce time of 1 second (1000ms)
    publish '{"debounce": 1000}' to tinkerforge/request/line_bricklet/XYZ/set_debounce_period

    # Handle incoming reflectivity reached callbacks
    subscribe to tinkerforge/callback/line_bricklet/XYZ/reflectivity_reached
    publish '{"register": true}' to tinkerforge/register/line_bricklet/XYZ/reflectivity_reached # Register reflectivity_reached callback

    # Configure threshold for reflectivity "greater than 2000"
    publish '{"option": "greater", "min": 2000, "max": 0}' to tinkerforge/request/line_bricklet/XYZ/set_reflectivity_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/line_bricklet/<UID>/get_reflectivity
Anfrage:
  • keine Nutzdaten
Antwort:
  • reflectivity – Typ: int, Wertebereich: [0 bis 212 - 1]

Gibt die aktuell gemessene Reflektivität zurück. Die Reflektivität ist ein Wert zwischen 0 (nicht reflektiv) und 4095 (sehr reflektiv).

Normalerweise hat schwarz eine geringe Reflektivität während weiß eine hohe Reflektivität hat.

Wenn die Reflektivität periodisch abgefragt werden soll, wird empfohlen den register/line_bricklet/<UID>/reflectivity Callback zu nutzen und die Periode mit request/line_bricklet/<UID>/set_reflectivity_callback_period vorzugeben.

Fortgeschrittene Funktionen

request/line_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 Line.

Konfigurationsfunktionen für Callbacks

request/line_bricklet/<UID>/set_reflectivity_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/line_bricklet/<UID>/reflectivity Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/line_bricklet/<UID>/reflectivity Callback wird nur ausgelöst, wenn sich die Reflektivität seit der letzten Auslösung geändert hat.

request/line_bricklet/<UID>/get_reflectivity_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/line_bricklet/<UID>/set_reflectivity_callback_period gesetzt.

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

Setzt den Schwellwert für den register/line_bricklet/<UID>/reflectivity_reached Callback.

Die folgenden Optionen sind möglich:

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

Gibt den Schwellwert zurück, wie von request/line_bricklet/<UID>/set_reflectivity_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/line_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 Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

request/line_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/line_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/line_bricklet/<UID>/reflectivity
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • reflectivity – Typ: int, Wertebereich: [0 bis 212 - 1]

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/line_bricklet/<UID>/set_reflectivity_callback_period, ausgelöst. Der Payload des Callbacks ist die Reflektivität des Sensors.

Der register/line_bricklet/<UID>/reflectivity Callback wird nur ausgelöst, wenn sich die Reflektivität seit der letzten Auslösung geändert hat.

register/line_bricklet/<UID>/reflectivity_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • reflectivity – Typ: int, Wertebereich: [0 bis 212 - 1]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/line_bricklet/<UID>/set_reflectivity_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist die Reflektivität des Sensors.

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