Dies ist die Beschreibung der MQTT API Bindings für das Distance IR Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Distance IR Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die MQTT API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 | # Change XYZ to the UID of your Distance IR Bricklet 2.0
setup:
# Get current distance
subscribe to tinkerforge/response/distance_ir_v2_bricklet/XYZ/get_distance
publish '' to tinkerforge/request/distance_ir_v2_bricklet/XYZ/get_distance
|
Download (example-callback.txt)
1 2 3 4 5 6 7 8 9 | # Change XYZ to the UID of your Distance IR Bricklet 2.0
setup:
# Handle incoming distance callbacks
subscribe to tinkerforge/callback/distance_ir_v2_bricklet/XYZ/distance
publish '{"register": true}' to tinkerforge/register/distance_ir_v2_bricklet/XYZ/distance # Register distance callback
# Set period for distance callback to 1s (1000ms) without a threshold
publish '{"period": 1000, "value_has_to_change": false, "option": "off", "min": 0, "max": 0}' to tinkerforge/request/distance_ir_v2_bricklet/XYZ/set_distance_callback_configuration
|
Download (example-threshold.txt)
1 2 3 4 5 6 7 8 9 10 | # Change XYZ to the UID of your Distance IR Bricklet 2.0
setup:
# Handle incoming distance callbacks
subscribe to tinkerforge/callback/distance_ir_v2_bricklet/XYZ/distance
publish '{"register": true}' to tinkerforge/register/distance_ir_v2_bricklet/XYZ/distance # Register distance callback
# Configure threshold for distance "smaller than 30 cm"
# with a debounce period of 1s (1000ms)
publish '{"period": 1000, "value_has_to_change": false, "option": "smaller", "min": 300, "max": 0}' to tinkerforge/request/distance_ir_v2_bricklet/XYZ/set_distance_callback_configuration
|
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/...
.
request/
distance_ir_v2_bricklet/
<UID>/
get_distance
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die gemessene Entfernung des Sensors zurück. Die möglichen Entfernungsbereiche sind 40 bis 300, 100 bis 800 und 200 bis 1500, in Abhängigkeit vom gewählten IR Sensor.
Wenn der Wert periodisch benötigt wird, kann auch der register/distance_ir_v2_bricklet/<UID>/distance
Callback
verwendet werden. Der Callback wird mit der Funktion
request/distance_ir_v2_bricklet/<UID>/set_distance_callback_configuration
konfiguriert.
request/
distance_ir_v2_bricklet/
<UID>/
get_analog_value
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt den Analogwert des Analog/Digital-Wandler zurück.
Dieser Wert ist ein unverarbeiteter Rohwert. Wir haben sichergestellt, dass die Integrationszeit des ADCs kleiner ist als das Messintervall des Sensors (10ms vs 16,5ms). Dadurch ist sichergestellt das keine Informationen verloren gehen können.
Der Analogwert kann genutzt werden wenn eine eigene Kalibrierung oder Lookup-Tabelle benötigt wird.
Wenn der Wert periodisch benötigt wird, kann auch der register/distance_ir_v2_bricklet/<UID>/analog_value
Callback
verwendet werden. Der Callback wird mit der Funktion
request/distance_ir_v2_bricklet/<UID>/set_analog_value_callback_configuration
konfiguriert.
request/
distance_ir_v2_bricklet/
<UID>/
set_moving_average_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt die Länge eines gleitenden Mittelwerts für die Distanz.
Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.
Einer neue Wert wird alle ~10ms gemessen. Mit einer Mittelwerts-Länge von 1000 hat das resultierende gleitende Fenster eine Zeitspanne von ca. 10s. Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.
request/
distance_ir_v2_bricklet/
<UID>/
get_moving_average_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Moving Average-Konfiguration zurück, wie von request/distance_ir_v2_bricklet/<UID>/set_moving_average_configuration
gesetzt.
request/
distance_ir_v2_bricklet/
<UID>/
set_distance_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Konfiguriert die Distanz-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option mit der LED die Distanz anzuzeigen (heller = Objekt näher).
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
distance_ir_v2_bricklet/
<UID>/
get_distance_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die LED-Konfiguration zurück, wie von request/distance_ir_v2_bricklet/<UID>/set_distance_led_config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
distance_ir_v2_bricklet/
<UID>/
set_sensor_type
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt den Sensor-Typ.
Das Bricklet kommt vorkonfiguriert mit dem korrektem Sensor und der Sensor-Typ wird im Flash gespeichert (d.h. das Bricklet behält die Einstellung auch wenn es vom Strom getrennt wird).
Die Einstellung kann im Brick Viewer vorgenommen werden. Diese Funktion sollte in einem externen Programm also nicht ausgeführt werden müssen.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für sensor:
request/
distance_ir_v2_bricklet/
<UID>/
get_sensor_type
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt den Sensor-Typ zurück, wie von request/distance_ir_v2_bricklet/<UID>/set_sensor_type
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für sensor:
request/
distance_ir_v2_bricklet/
<UID>/
get_spitfp_error_count
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
request/
distance_ir_v2_bricklet/
<UID>/
set_status_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
distance_ir_v2_bricklet/
<UID>/
get_status_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Konfiguration zurück, wie von request/distance_ir_v2_bricklet/<UID>/set_status_led_config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
distance_ir_v2_bricklet/
<UID>/
get_chip_temperature
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
request/
distance_ir_v2_bricklet/
<UID>/
reset
¶Anfrage: |
|
---|---|
Antwort: |
|
Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
request/
distance_ir_v2_bricklet/
<UID>/
get_identity
¶Anfrage: |
|
---|---|
Antwort: |
|
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 Distance IR 2.0.
request/
distance_ir_v2_bricklet/
<UID>/
set_distance_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/distance_ir_v2_bricklet/<UID>/distance
Callback ausgelöst wird. Ein Wert von 0
schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.
Der option-Parameter zusammen mit min/max setzt einen Threshold für den register/distance_ir_v2_bricklet/<UID>/distance
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Threshold ist abgeschaltet |
'o' | Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind |
'i' | Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind |
'<' | Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert) |
'>' | Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert) |
Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für option:
request/
distance_ir_v2_bricklet/
<UID>/
get_distance_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels request/distance_ir_v2_bricklet/<UID>/set_distance_callback_configuration
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für option:
request/
distance_ir_v2_bricklet/
<UID>/
set_analog_value_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/distance_ir_v2_bricklet/<UID>/analog_value
Callback ausgelöst wird. Ein Wert von 0
schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.
Der option-Parameter zusammen mit min/max setzt einen Threshold für den register/distance_ir_v2_bricklet/<UID>/analog_value
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Threshold ist abgeschaltet |
'o' | Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind |
'i' | Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind |
'<' | Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert) |
'>' | Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert) |
Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für option:
request/
distance_ir_v2_bricklet/
<UID>/
get_analog_value_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels request/distance_ir_v2_bricklet/<UID>/set_analog_value_callback_configuration
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für option:
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_ir_v2_bricklet/
<UID>/
distance
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/distance_ir_v2_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_ir_v2_bricklet/<UID>/distance[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
request/distance_ir_v2_bricklet/<UID>/set_distance_callback_configuration
gesetzten Konfiguration
Der Payload des Callbacks ist der gleiche wie request/distance_ir_v2_bricklet/<UID>/get_distance
.
register/
distance_ir_v2_bricklet/
<UID>/
analog_value
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/distance_ir_v2_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/distance_ir_v2_bricklet/<UID>/analog_value[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
request/distance_ir_v2_bricklet/<UID>/set_analog_value_callback_configuration
gesetzten Konfiguration
Der Payload des Callbacks ist der gleiche wie request/distance_ir_v2_bricklet/<UID>/get_analog_value
.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
request/
distance_ir_v2_bricklet/
<UID>/
set_bootloader_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
Für status:
request/
distance_ir_v2_bricklet/
<UID>/
get_bootloader_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt den aktuellen Bootloader-Modus zurück, siehe request/distance_ir_v2_bricklet/<UID>/set_bootloader_mode
.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
request/
distance_ir_v2_bricklet/
<UID>/
set_write_firmware_pointer
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt den Firmware-Pointer für request/distance_ir_v2_bricklet/<UID>/write_firmware
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
request/
distance_ir_v2_bricklet/
<UID>/
write_firmware
¶Anfrage: |
|
---|---|
Antwort: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
request/distance_ir_v2_bricklet/<UID>/set_write_firmware_pointer
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
request/
distance_ir_v2_bricklet/
<UID>/
write_uid
¶Anfrage: |
|
---|---|
Antwort: |
|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
request/
distance_ir_v2_bricklet/
<UID>/
read_uid
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.