MQTT - Outdoor Weather Bricklet

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

Callback

Download (example-callback.txt)

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

setup:
    # Enable station data callbacks
    publish '{"enable_callback": true}' to tinkerforge/request/outdoor_weather_bricklet/XYZ/set_station_callback_configuration 
    
    # Enable sensor data callbacks
    publish '{"enable_callback": true}' to tinkerforge/request/outdoor_weather_bricklet/XYZ/set_sensor_callback_configuration 
    
    # Handle incoming station data callbacks
    subscribe to tinkerforge/callback/outdoor_weather_bricklet/XYZ/station_data
    publish '{"register": true}' to tinkerforge/register/outdoor_weather_bricklet/XYZ/station_data # Register station_data callback
    
    # Handle incoming sensor data callbacks
    subscribe to tinkerforge/callback/outdoor_weather_bricklet/XYZ/sensor_data
    publish '{"register": true}' to tinkerforge/register/outdoor_weather_bricklet/XYZ/sensor_data # Register sensor_data callback

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/outdoor_weather_bricklet/<UID>/get_station_identifiers
Anfrage:
  • keine Nutzdaten
Antwort:
  • identifiers – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 255]

Gibt die Identifier (Zahl zwischen 0 und 255) von allen 'Stationen <https://www.tinkerforge.com/de/shop/accessories/sensors/outdoor-weather-station-ws-6147.html>`__ die seit dem Start des Bricklets entdeckt wurden.

Jede Station gibt sich selbst einen zufälligen Identifier beim ersten Start.

Seit Firmware-Version 2.0.2 wird eine Station von der Liste wieder entfernt wenn für 12 Stunden am Stück keine Daten empfangen werden.

request/outdoor_weather_bricklet/<UID>/get_sensor_identifiers
Anfrage:
  • keine Nutzdaten
Antwort:
  • identifiers – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 255]

Gibt die Identifier (Zahl zwischen 0 und 255) von allen 'Sensoren <https://www.tinkerforge.com/en/shop/accessories/sensors/temperature-humidity-sensor-th-6148.html>`__ die seit dem Start des Bricklets entdeckt wurden.

Jede Sensor gibt sich selbst einen zufälligen Identifier beim ersten Start.

Seit Firmware-Version 2.0.2 wird ein Sensor von der Liste wieder entfernt wenn für 12 Stunden am Stück keine Daten empfangen werden.

request/outdoor_weather_bricklet/<UID>/get_station_data
Anfrage:
  • identifier – Typ: int, Wertebereich: [0 bis 255]
Antwort:
  • temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-400 bis 650]
  • humidity – Typ: int, Einheit: 1 %, Wertebereich: [10 bis 99]
  • wind_speed – Typ: int, Einheit: 1/10 m/s, Wertebereich: [0 bis 232 - 1]
  • gust_speed – Typ: int, Einheit: 1/10 m/s, Wertebereich: [0 bis 232 - 1]
  • rain – Typ: int, Einheit: 1/10 mm, Wertebereich: [0 bis 232 - 1]
  • wind_direction – Typ: int, Wertebereich: Siehe Symbole
  • battery_low – Typ: bool
  • last_change – Typ: int, Einheit: 1 s, Wertebereich: [0 bis 216 - 1]

Gibt die zuletzt empfangenen Daten für die Station mit dem entsprechenden Identifier zurück.

Die Rückgabewerte sind:

  • Temperatur,
  • Luftfeuchte,
  • Windgeschwindigkeit,
  • Windböengeschwindigkeit,
  • Niederschlag,
  • Windrichtung,
  • Batteriewarnung (true wenn der Batteriestand niedrig ist) und
  • Letzte Änderung (Sekunden seitdem diese Daten empfangen wurden).

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

Für wind_direction:

  • "n" = 0
  • "nne" = 1
  • "ne" = 2
  • "ene" = 3
  • "e" = 4
  • "ese" = 5
  • "se" = 6
  • "sse" = 7
  • "s" = 8
  • "ssw" = 9
  • "sw" = 10
  • "wsw" = 11
  • "w" = 12
  • "wnw" = 13
  • "nw" = 14
  • "nnw" = 15
  • "error" = 255
request/outdoor_weather_bricklet/<UID>/get_sensor_data
Anfrage:
  • identifier – Typ: int, Wertebereich: [0 bis 255]
Antwort:
  • temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1]
  • humidity – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 255]
  • last_change – Typ: int, Einheit: 1 s, Wertebereich: [0 bis 216 - 1]

Gibt die zuletzt empfangenen Daten für den Sensor mit dem entsprechenden Identifier zurück.

Die Rückgabewerte sind:

  • Temperatur,
  • Luftfeuchte und
  • Letzte Änderung (Sekunden seitdem diese Daten empfangen wurden).

Fortgeschrittene Funktionen

request/outdoor_weather_bricklet/<UID>/get_spitfp_error_count
Anfrage:
  • keine Nutzdaten
Antwort:
  • error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 1]

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/outdoor_weather_bricklet/<UID>/set_bootloader_mode
Anfrage:
  • mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • status – Typ: int, Wertebereich: Siehe 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 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:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4

Für status:

  • "ok" = 0
  • "invalid_mode" = 1
  • "no_change" = 2
  • "entry_function_not_present" = 3
  • "device_identifier_incorrect" = 4
  • "crc_mismatch" = 5
request/outdoor_weather_bricklet/<UID>/get_bootloader_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: int, Wertebereich: Siehe Symbole

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

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

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4
request/outdoor_weather_bricklet/<UID>/set_write_firmware_pointer
Anfrage:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Setzt den Firmware-Pointer für request/outdoor_weather_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/outdoor_weather_bricklet/<UID>/write_firmware
Anfrage:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/outdoor_weather_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/outdoor_weather_bricklet/<UID>/set_status_led_config
Anfrage:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:
  • keine 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:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/outdoor_weather_bricklet/<UID>/get_status_led_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

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

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/outdoor_weather_bricklet/<UID>/get_chip_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

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/outdoor_weather_bricklet/<UID>/reset
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine 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/outdoor_weather_bricklet/<UID>/write_uid
Anfrage:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine 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/outdoor_weather_bricklet/<UID>/read_uid
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

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

request/outdoor_weather_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 Outdoor Weather.

Konfigurationsfunktionen für Callbacks

request/outdoor_weather_bricklet/<UID>/set_station_callback_configuration
Anfrage:
  • enable_callback – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Aktiviert/Deaktiviert den Callback für Stationsdaten.

request/outdoor_weather_bricklet/<UID>/get_station_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • enable_callback – Typ: bool, Standardwert: false

Gibt die Konfiguration zurück wie von request/outdoor_weather_bricklet/<UID>/set_station_callback_configuration gesetzt.

request/outdoor_weather_bricklet/<UID>/set_sensor_callback_configuration
Anfrage:
  • enable_callback – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Aktiviert/Deaktiviert den Callback für Sensordaten.

request/outdoor_weather_bricklet/<UID>/get_sensor_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • enable_callback – Typ: bool, Standardwert: false

Gibt die Konfiguration zurück wie von request/outdoor_weather_bricklet/<UID>/set_sensor_callback_configuration 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/outdoor_weather_bricklet/<UID>/station_data
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • identifier – Typ: int, Wertebereich: [0 bis 255]
  • temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-400 bis 650]
  • humidity – Typ: int, Einheit: 1 %, Wertebereich: [10 bis 99]
  • wind_speed – Typ: int, Einheit: 1/10 m/s, Wertebereich: [0 bis 232 - 1]
  • gust_speed – Typ: int, Einheit: 1/10 m/s, Wertebereich: [0 bis 232 - 1]
  • rain – Typ: int, Einheit: 1/10 mm, Wertebereich: [0 bis 232 - 1]
  • wind_direction – Typ: int, Wertebereich: Siehe Symbole
  • battery_low – Typ: bool

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

Meldet die Stationsdaten bei jedem eingehenden Datenpaket. Siehe request/outdoor_weather_bricklet/<UID>/get_station_data für Details über die Daten.

Für jede Station wird dieser Callback ca. alle 45 Sekunden ausgelöst werden.

Der Callback kann mittels request/outdoor_weather_bricklet/<UID>/set_station_callback_configuration aktiviert/deaktiviert werden (standardmäßig ist der Callback deaktiviert).

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

Für wind_direction:

  • "n" = 0
  • "nne" = 1
  • "ne" = 2
  • "ene" = 3
  • "e" = 4
  • "ese" = 5
  • "se" = 6
  • "sse" = 7
  • "s" = 8
  • "ssw" = 9
  • "sw" = 10
  • "wsw" = 11
  • "w" = 12
  • "wnw" = 13
  • "nw" = 14
  • "nnw" = 15
  • "error" = 255
register/outdoor_weather_bricklet/<UID>/sensor_data
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • identifier – Typ: int, Wertebereich: [0 bis 255]
  • temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1]
  • humidity – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 255]

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

Meldet die Sensordaten bei jedem eingehenden Datenpaket. Siehe request/outdoor_weather_bricklet/<UID>/get_sensor_data für Details über die Daten.

Für jeden Sensor wird dieser Callback ca. alle 45 Sekunden ausgelöst werden.

Der Callback kann mittels request/outdoor_weather_bricklet/<UID>/set_sensor_callback_configuration aktiviert/deaktiviert werden (standardmäßig ist der Callback deaktiviert).