MQTT - Temperature Bricklet 2.0

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

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

Callback

Download (example-callback.txt)

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

setup:
    # Handle incoming temperature callbacks
    subscribe to tinkerforge/callback/temperature_v2_bricklet/XYZ/temperature
    publish '{"register": true}' to tinkerforge/register/temperature_v2_bricklet/XYZ/temperature # Register temperature callback
    
    # Set period for temperature callback to 1s (1000ms) without a threshold
    publish '{"period": 1000, "value_has_to_change": false, "option": "off", "min": 0, "max": 0}' to tinkerforge/request/temperature_v2_bricklet/XYZ/set_temperature_callback_configuration

Threshold

Download (example-threshold.txt)

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

setup:
    # Handle incoming temperature callbacks
    subscribe to tinkerforge/callback/temperature_v2_bricklet/XYZ/temperature
    publish '{"register": true}' to tinkerforge/register/temperature_v2_bricklet/XYZ/temperature # Register temperature callback
    
    # Configure threshold for temperature "greater than 30 °C"
    # with a debounce period of 1s (1000ms)
    publish '{"period": 1000, "value_has_to_change": false, "option": "greater", "min": 3000, "max": 0}' to tinkerforge/request/temperature_v2_bricklet/XYZ/set_temperature_callback_configuration

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/temperature_v2_bricklet/<UID>/get_temperature
Response-Payload:
 
  • temperature -- int

Gibt die gemessene Temperatur des Sensors zurück. Der Wertebereich ist von -4500 bis 13000 und wird in °C/100 angegeben, z.B. bedeutet ein Wert von 3200 eine gemessene Temperatur von 32,00 °C.

Wenn der Wert periodisch benötigt wird, kann auch der register/temperature_v2_bricklet/<UID>/temperature Callback verwendet werden. Der Callback wird mit der Funktion request/temperature_v2_bricklet/<UID>/set_temperature_callback_configuration konfiguriert.

request/temperature_v2_bricklet/<UID>/set_heater_configuration
Request-Payload:
 
  • heater_config -- int (hat Symbole)

Aktiviert/deaktiviert das Heizelement. Das Heizelement kann genutzt werden um den Sensor zu testen.

Standardmäßig ist das Heizelement deaktiviert.

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

für heater_config:

  • "Disabled" = 0
  • "Enabled" = 1
request/temperature_v2_bricklet/<UID>/get_heater_configuration
Response-Payload:
 
  • heater_config -- int (hat Symbole)

Gibt die Heizelement-Konfiguration zurück, wie von request/temperature_v2_bricklet/<UID>/set_heater_configuration gesetzt.

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

für heater_config:

  • "Disabled" = 0
  • "Enabled" = 1

Fortgeschrittene Funktionen

request/temperature_v2_bricklet/<UID>/get_spitfp_error_count
Response-Payload:
 
  • error_count_ack_checksum -- int
  • error_count_message_checksum -- int
  • error_count_frame -- int
  • error_count_overflow -- int

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

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/temperature_v2_bricklet/<UID>/set_bootloader_mode
Request-Payload:
 
  • mode -- int (hat Symbole)
Response-Payload:
 
  • status -- int (hat Symbole)

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 Bootlodaer- 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:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4

für status:

  • "OK" = 0
  • "InvalidMode" = 1
  • "NoChange" = 2
  • "EntryFunctionNotPresent" = 3
  • "DeviceIdentifierIncorrect" = 4
  • "CRCMismatch" = 5
request/temperature_v2_bricklet/<UID>/get_bootloader_mode
Response-Payload:
 
  • mode -- int (hat Symbole)

Gibt den aktuellen Bootloader-Modus zurück, siehe request/temperature_v2_bricklet/<UID>/set_bootloader_mode.

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

für mode:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4
request/temperature_v2_bricklet/<UID>/set_write_firmware_pointer
Request-Payload:
 
  • pointer -- int

Setzt den Firmware-Pointer für request/temperature_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/temperature_v2_bricklet/<UID>/write_firmware
Request-Payload:
 
  • data -- [int,... (x64)]
Response-Payload:
 
  • status -- int

Schreibt 64 Bytes Firmware an die Position die vorher von request/temperature_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/temperature_v2_bricklet/<UID>/set_status_led_config
Request-Payload:
 
  • config -- int (hat Symbole)

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:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/temperature_v2_bricklet/<UID>/get_status_led_config
Response-Payload:
 
  • config -- int (hat Symbole)

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

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

für config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/temperature_v2_bricklet/<UID>/get_chip_temperature
Response-Payload:
 
  • temperature -- int

Gibt die Temperatur in °C, 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/temperature_v2_bricklet/<UID>/reset

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/temperature_v2_bricklet/<UID>/write_uid
Request-Payload:
 
  • uid -- int

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/temperature_v2_bricklet/<UID>/read_uid
Response-Payload:
 
  • uid -- int

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

request/temperature_v2_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 Temperature 2.0.

Konfigurationsfunktionen für Callbacks

request/temperature_v2_bricklet/<UID>/set_temperature_callback_configuration
Request-Payload:
 
  • period -- int
  • value_has_to_change -- bool
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

Die Periode in ms ist die Periode mit der der register/temperature_v2_bricklet/<UID>/temperature 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/temperature_v2_bricklet/<UID>/temperature 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.

Der Standardwert ist (0, false, '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/temperature_v2_bricklet/<UID>/get_temperature_callback_configuration
Response-Payload:
 
  • period -- int
  • value_has_to_change -- bool
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

Gibt die Callback-Konfiguration zurück, wie mittels request/temperature_v2_bricklet/<UID>/set_temperature_callback_configuration gesetzt.

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

für option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'

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_v2_bricklet/<UID>/temperature
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • temperature -- int

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/temperature_v2_bricklet/<UID>/set_temperature_callback_configuration gesetzten Konfiguration

Der Payload des Callbacks ist der gleiche wie request/temperature_v2_bricklet/<UID>/get_temperature.