MQTT - Thermocouple Bricklet

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

setup:
    # Get current temperature
    subscribe to tinkerforge/response/thermocouple_bricklet/XYZ/get_temperature
    publish '' to tinkerforge/request/thermocouple_bricklet/XYZ/get_temperature

Callback

Download (example-callback.txt)

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

setup:
    # Handle incoming temperature callbacks
    subscribe to tinkerforge/callback/thermocouple_bricklet/XYZ/temperature
    publish '{"register": true}' to tinkerforge/register/thermocouple_bricklet/XYZ/temperature # Register temperature callback
    
    # Set period for temperature callback to 1s (1000ms)
    # Note: The temperature callback is only called every second
    #       if the temperature has changed since the last call!
    publish '{"period": 1000}' to tinkerforge/request/thermocouple_bricklet/XYZ/set_temperature_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 Thermocouple Bricklet

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/thermocouple_bricklet/XYZ/set_debounce_period
    
    # Handle incoming temperature reached callbacks
    subscribe to tinkerforge/callback/thermocouple_bricklet/XYZ/temperature_reached
    publish '{"register": true}' to tinkerforge/register/thermocouple_bricklet/XYZ/temperature_reached # Register temperature_reached callback
    
    # Configure threshold for temperature "greater than 30 °C"
    publish '{"option": "greater", "min": 3000, "max": 0}' to tinkerforge/request/thermocouple_bricklet/XYZ/set_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/thermocouple_bricklet/<UID>/get_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-21000 bis 180000]

Gibt die Temperatur des Thermoelements zurück.

Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen den register/thermocouple_bricklet/<UID>/temperature Callback zu nutzen und die Periode mit request/thermocouple_bricklet/<UID>/set_temperature_callback_period vorzugeben.

Fortgeschrittene Funktionen

request/thermocouple_bricklet/<UID>/set_configuration
Anfrage:
  • averaging – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 16
  • thermocouple_type – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
  • filter – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
Antwort:
  • keine Antwort

Konfiguriert werden können Averaging-Größe, Thermoelement-Typ und Frequenz-Filterung.

Mögliche Averaging-Größen sind 1, 2, 4, 8 und 16 Samples.

Als Thermoelement-Typ stehen B, E, J, K, N, R, S und T zur Verfügung. Falls ein anderes Thermoelement benutzt werden soll, können G8 und G32 genutzt werden. Mit diesen Typen wird der Wert nicht in °C/100 zurückgegeben sondern er wird durch folgende Formeln bestimmt:

  • G8: Wert = 8 * 1.6 * 2^17 * Vin
  • G32: Wert = 32 * 1.6 * 2^17 * Vin

dabei ist Vin die Eingangsspannung des Thermoelements.

Der Frequenz-Filter kann auf 50Hz und 60Hz konfiguriert werden. Er sollte abhängig von der lokalen Netzfrequenz gewählt werden.

Die Konvertierungszeit ist abhängig von der Averaging-Größe und der Frequenz-Filter-Konfiguration. Sie kann wie folgt bestimmt werden:

  • 60Hz: Zeit = 82 + (Samples - 1) * 16.67
  • 50Hz: Zeit = 98 + (Samples - 1) * 20

Die folgenden Symbole sind für diese Funktion verfügbar:

Für averaging:

  • "1" = 1
  • "2" = 2
  • "4" = 4
  • "8" = 8
  • "16" = 16

Für thermocouple_type:

  • "b" = 0
  • "e" = 1
  • "j" = 2
  • "k" = 3
  • "n" = 4
  • "r" = 5
  • "s" = 6
  • "t" = 7
  • "g8" = 8
  • "g32" = 9

Für filter:

  • "50hz" = 0
  • "60hz" = 1
request/thermocouple_bricklet/<UID>/get_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • averaging – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 16
  • thermocouple_type – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
  • filter – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die Konfiguration zurück, wie von request/thermocouple_bricklet/<UID>/set_configuration gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für averaging:

  • "1" = 1
  • "2" = 2
  • "4" = 4
  • "8" = 8
  • "16" = 16

Für thermocouple_type:

  • "b" = 0
  • "e" = 1
  • "j" = 2
  • "k" = 3
  • "n" = 4
  • "r" = 5
  • "s" = 6
  • "t" = 7
  • "g8" = 8
  • "g32" = 9

Für filter:

  • "50hz" = 0
  • "60hz" = 1
request/thermocouple_bricklet/<UID>/get_error_state
Anfrage:
  • keine Nutzdaten
Antwort:
  • over_under – Typ: bool
  • open_circuit – Typ: bool

Gibt den aktuellen Error-Status zurück. Es gibt zwei mögliche Status:

  • Over/Under Voltage und
  • Open Circuit.

Over/Under Voltage bei Spannungen unter 0V oder über 3.3V ausgelöst. In diesem Fall ist mit hoher Wahrscheinlichkeit das Thermoelement defekt. Ein Open Circuit-Error deutet darauf hin, das kein Thermoelement angeschlossen ist.

Der register/thermocouple_bricklet/<UID>/error_state Callback wird automatisch jedes mal ausgelöst, wenn sich der Error-Status ändert.

request/thermocouple_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 Thermocouple.

Konfigurationsfunktionen für Callbacks

request/thermocouple_bricklet/<UID>/set_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/thermocouple_bricklet/<UID>/temperature Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

request/thermocouple_bricklet/<UID>/get_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/thermocouple_bricklet/<UID>/set_temperature_callback_period gesetzt.

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

Setzt den Schwellwert für den register/thermocouple_bricklet/<UID>/temperature_reached Callback.

Die folgenden Optionen sind möglich:

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

Gibt den Schwellwert zurück, wie von request/thermocouple_bricklet/<UID>/set_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/thermocouple_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/thermocouple_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/thermocouple_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/thermocouple_bricklet/<UID>/temperature
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-21000 bis 180000]

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

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

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

register/thermocouple_bricklet/<UID>/temperature_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-21000 bis 180000]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/thermocouple_bricklet/<UID>/set_temperature_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist die Temperatur des Thermoelements.

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

register/thermocouple_bricklet/<UID>/error_state
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • over_under – Typ: bool
  • open_circuit – Typ: bool

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

Dieser Callback wird ausgelöst, wenn der Error-Status sich verändert (siehe request/thermocouple_bricklet/<UID>/get_error_state).