MQTT - Temperature IR Bricklet

Dies ist die Beschreibung der MQTT API Bindings für das Temperature IR Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Temperature 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
 7
 8
 9
10
# Change XYZ to the UID of your Temperature IR Bricklet

setup:
    # Get current ambient temperature
    subscribe to tinkerforge/response/temperature_ir_bricklet/XYZ/get_ambient_temperature
    publish '' to tinkerforge/request/temperature_ir_bricklet/XYZ/get_ambient_temperature
    
    # Get current object temperature
    subscribe to tinkerforge/response/temperature_ir_bricklet/XYZ/get_object_temperature
    publish '' to tinkerforge/request/temperature_ir_bricklet/XYZ/get_object_temperature

Callback

Download (example-callback.txt)

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

setup:
    # Handle incoming object temperature callbacks
    subscribe to tinkerforge/callback/temperature_ir_bricklet/XYZ/object_temperature
    publish '{"register": true}' to tinkerforge/register/temperature_ir_bricklet/XYZ/object_temperature # Register object_temperature callback
    
    # Set period for object temperature callback to 1s (1000ms)
    # Note: The object temperature callback is only called every second
    #       if the object temperature has changed since the last call!
    publish '{"period": 1000}' to tinkerforge/request/temperature_ir_bricklet/XYZ/set_object_temperature_callback_period

Water Boiling

Download (example-water-boiling.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
# Change XYZ to the UID of your Temperature IR Bricklet

setup:
    # Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
    publish '{"emissivity": 64224}' to tinkerforge/request/temperature_ir_bricklet/XYZ/set_emissivity 
    
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/temperature-ir_bricklet/XYZ/set_debounce_period
    
    # Handle incoming object temperature reached callbacks
    subscribe to tinkerforge/callback/temperature_ir_bricklet/XYZ/object_temperature_reached
    publish '{"register": true}' to tinkerforge/register/temperature_ir_bricklet/XYZ/object_temperature_reached # Register object_temperature_reached callback
    
    # Configure threshold for object temperature "greater than 100 °C"
    publish '{"option": "greater", "min": 1000, "max": 0}' to tinkerforge/request/temperature_ir_bricklet/XYZ/set_object_temperature_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/temperature_ir_bricklet/<UID>/get_ambient_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]

Gibt die Umgebungstemperatur des Sensors zurück.

Wenn die Umgebungstemperatur periodisch abgefragt werden soll, wird empfohlen den register/temperature_ir_bricklet/<UID>/ambient_temperature Callback zu nutzen und die Periode mit request/temperature_ir_bricklet/<UID>/set_ambient_temperature_callback_period vorzugeben.

request/temperature_ir_bricklet/<UID>/get_object_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]

Gibt die Objekttemperatur des Sensors zurück, z.B. die Temperatur der Oberfläche auf welche der Sensor zielt.

Die Temperatur von unterschiedlichen Materialien ist abhängig von ihrem Emissionsgrad. Der Emissionsgrad des Materials kann mit request/temperature_ir_bricklet/<UID>/set_emissivity gesetzt werden.

Wenn die Objekttemperatur periodisch abgefragt werden soll, wird empfohlen den register/temperature_ir_bricklet/<UID>/object_temperature Callback zu nutzen und die Periode mit request/temperature_ir_bricklet/<UID>/set_object_temperature_callback_period vorzugeben.

Fortgeschrittene Funktionen

request/temperature_ir_bricklet/<UID>/set_emissivity
Anfrage:
  • emissivity – Typ: int, Einheit: 1/65535, Wertebereich: [6553 bis 216 - 1], Standardwert: 216 - 1
Antwort:
  • keine Antwort

Setzt den Emissionsgrad, welcher zur Berechnung der Oberflächentemperatur benutzt wird, wie von request/temperature_ir_bricklet/<UID>/get_object_temperature zurückgegeben.

Der Emissionsgrad wird normalerweise als Wert zwischen 0,0 und 1,0 angegeben. Eine Liste von Emissionsgraden unterschiedlicher Materialien ist hier zu finden.

Der Parameter von request/temperature_ir_bricklet/<UID>/set_emissivity muss mit eine Faktor von 65535 (16-Bit) vorgegeben werden. Beispiel: Ein Emissionsgrad von 0,1 kann mit dem Wert 6553 gesetzt werden, ein Emissionsgrad von 0,5 mit dem Wert 32767 und so weiter.

Bemerkung

Wenn eine exakte Messung der Objekttemperatur notwendig ist, ist es entscheidend eine exakten Emissionsgrad anzugeben.

Der Emissionsgrad wird in nicht-flüchtigem Speicher gespeichert und wird auch noch einem Neustart weiter genutzt.

request/temperature_ir_bricklet/<UID>/get_emissivity
Anfrage:
  • keine Nutzdaten
Antwort:
  • emissivity – Typ: int, Einheit: 1/65535, Wertebereich: [6553 bis 216 - 1], Standardwert: 216 - 1

Gibt den Emissionsgrad zurück, wie von request/temperature_ir_bricklet/<UID>/set_emissivity gesetzt.

request/temperature_ir_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 Temperature IR.

Konfigurationsfunktionen für Callbacks

request/temperature_ir_bricklet/<UID>/set_ambient_temperature_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/temperature_ir_bricklet/<UID>/ambient_temperature Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

request/temperature_ir_bricklet/<UID>/get_ambient_temperature_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/temperature_ir_bricklet/<UID>/set_ambient_temperature_callback_period gesetzt.

request/temperature_ir_bricklet/<UID>/set_object_temperature_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/temperature_ir_bricklet/<UID>/object_temperature Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

request/temperature_ir_bricklet/<UID>/get_object_temperature_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/temperature_ir_bricklet/<UID>/set_object_temperature_callback_period gesetzt.

request/temperature_ir_bricklet/<UID>/set_ambient_temperature_callback_threshold
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Schwellwert für den register/temperature_ir_bricklet/<UID>/ambient_temperature_reached Callback.

Die folgenden Optionen sind möglich:

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

Gibt den Schwellwert zurück, wie von request/temperature_ir_bricklet/<UID>/set_ambient_temperature_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/temperature_ir_bricklet/<UID>/set_object_temperature_callback_threshold
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Schwellwert für den register/temperature_ir_bricklet/<UID>/object_temperature_reached Callback.

Die folgenden Optionen sind möglich:

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

Gibt den Schwellwert zurück, wie von request/temperature_ir_bricklet/<UID>/set_object_temperature_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/temperature_ir_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/temperature_ir_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/temperature_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/temperature_ir_bricklet/<UID>/ambient_temperature
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]

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

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

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

register/temperature_ir_bricklet/<UID>/object_temperature
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]

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

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

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

register/temperature_ir_bricklet/<UID>/ambient_temperature_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]

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

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

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

register/temperature_ir_bricklet/<UID>/object_temperature_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]

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

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

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