MQTT - Distance IR Bricklet

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

setup:
    # Get current distance
    subscribe to tinkerforge/response/distance_ir_bricklet/XYZ/get_distance
    publish '' to tinkerforge/request/distance_ir_bricklet/XYZ/get_distance

Callback

Download (example-callback.txt)

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

setup:
    # Handle incoming distance callbacks
    subscribe to tinkerforge/callback/distance_ir_bricklet/XYZ/distance
    publish '{"register": true}' to tinkerforge/register/distance_ir_bricklet/XYZ/distance # Register distance callback
    
    # Set period for distance callback to 0.2s (200ms)
    # Note: The distance callback is only called every 0.2 seconds
    #       if the distance has changed since the last call!
    publish '{"period": 200}' to tinkerforge/request/distance_ir_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 IR Bricklet

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/distance-ir_bricklet/XYZ/set_debounce_period
    
    # Handle incoming distance reached callbacks
    subscribe to tinkerforge/callback/distance_ir_bricklet/XYZ/distance_reached
    publish '{"register": true}' to tinkerforge/register/distance_ir_bricklet/XYZ/distance_reached # Register distance_reached callback
    
    # Configure threshold for distance "smaller than 30 cm"
    publish '{"option": "smaller", "min": 300, "max": 0}' to tinkerforge/request/distance_ir_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"-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/distance_ir_bricklet/<UID>/get_distance
Response-Payload:
 
  • distance -- int

Gibt die gemessene Entfernung des Sensors zurück. Der Wert ist in mm und die möglichen Entfernungsbereiche sind 40 bis 300, 100 bis 800 und 200 bis 1500, in Abhängigkeit vom gewählten IR Sensor.

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

Fortgeschrittene Funktionen

request/distance_ir_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/distance_ir_bricklet/<UID>/get_distance zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während request/distance_ir_bricklet/<UID>/get_analog_value unverarbeitete Analogwerte zurück gibt. Der einzige Grund request/distance_ir_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/distance_ir_bricklet/<UID>/analog_value Callback zu nutzen und die Periode mit request/distance_ir_bricklet/<UID>/set_analog_value_callback_period vorzugeben.

request/distance_ir_bricklet/<UID>/set_sampling_point
Request-Payload:
 
  • position -- int
  • distance -- int

Setzt einen Messpunkt für eine vorgegebene Position in der Wertetabelle. Die Wertetabelle beinhaltet 128 äquidistante Analogwerte mit entsprechenden Entfernungen.

Wenn eine Entfernung von 50cm bei einem Analogwert von 2048 gemessen wird, dann sollte der Aufruf der Funktion mit (64, 5000) erfolgen. Der verwendete Analog-Digital-Wandler hat eine Auflösung von 12 Bit. Mit 128 Messpunkten im gesamten Bereich bedeutet das, dass jeder Messpunkt 32 Analogwerte umfasst. Daher wird dem Analogwert 2048 der Messpunkt 64 = 2048/32 zugeordnet.

Messpunkte werden im EEPROM des Distance IR Bricklet gespeichert und werden bei jedem Hochfahren geladen.

Bemerkung

Ein einfacher Weg, die Messpunkte des Distance IR Bricklet zu kalibrieren, ist im Brick Viewer implementiert. Wenn der Bricklet kalibriert werden soll wird dringend empfohlen diese Implementierung zu nutzen.

request/distance_ir_bricklet/<UID>/get_sampling_point
Request-Payload:
 
  • position -- int
Response-Payload:
 
  • distance -- int

Gibt die Entfernung eines Messpunktes zurück, wie von request/distance_ir_bricklet/<UID>/set_sampling_point gesetzt.

request/distance_ir_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 Distance IR.

Konfigurationsfunktionen für Callbacks

request/distance_ir_bricklet/<UID>/set_distance_callback_period
Request-Payload:
 
  • period -- int

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

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

Der Standardwert ist 0.

request/distance_ir_bricklet/<UID>/get_distance_callback_period
Response-Payload:
 
  • period -- int

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

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

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

Der register/distance_ir_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/distance_ir_bricklet/<UID>/get_analog_value_callback_period
Response-Payload:
 
  • period -- int

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

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

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

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst wenn die Entfernung außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst wenn die Entfernung innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst wenn die Entfernung kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst wenn die Entfernung 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/distance_ir_bricklet/<UID>/get_distance_callback_threshold
Response-Payload:
 
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

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

Setzt den Schwellwert für den register/distance_ir_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 des min und max Wertes ist
'i' Callback wird ausgelöst wenn der Analogwert innerhalb des min und max Wertes 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/distance_ir_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/distance_ir_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/distance_ir_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/distance_ir_bricklet/<UID>/get_debounce_period
Response-Payload:
 
  • debounce -- int

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

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

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

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

register/distance_ir_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/distance_ir_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_bricklet/<UID>/analog_value[/<SUFFIX>]-Topic veröffentlicht.

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

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

register/distance_ir_bricklet/<UID>/distance_reached
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • distance -- int

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

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

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

register/distance_ir_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/distance_ir_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/distance_ir_bricklet/<UID>/analog_value_reached[/<SUFFIX>]-Topic veröffentlicht.

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

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