TCP/IP - Outdoor Weather Bricklet

Dies ist die Beschreibung des TCP/IP Protokolls für das Outdoor Weather Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Outdoor Weather Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen

BrickletOutdoorWeather.get_station_identifiers_low_level
Funktions-ID:
  • 1
Anfrage:
  • keine Nutzdaten
Antwort:
  • identifiers_length – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • identifiers_chunk_offset – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • identifiers_chunk_data – Typ: uint8[60], 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.

BrickletOutdoorWeather.get_sensor_identifiers_low_level
Funktions-ID:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • identifiers_length – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • identifiers_chunk_offset – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • identifiers_chunk_data – Typ: uint8[60], 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.

BrickletOutdoorWeather.get_station_data
Funktions-ID:
  • 3
Anfrage:
  • identifier – Typ: uint8, Wertebereich: [0 bis 255]
Antwort:
  • temperature – Typ: int16, Wertebereich: [-215 bis 215 - 1]
  • humidity – Typ: uint8, Wertebereich: [0 bis 255]
  • wind_speed – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • gust_speed – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • rain – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • wind_direction – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • battery_low – Typ: bool
  • last_change – Typ: uint16, 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 in °C/10,
  • Luftfeuchte in %RH,
  • Windgeschwindigkeit in m/10s,
  • Windböengeschwindigkeit in m/10s,
  • Niederschlag in mm/10,
  • Windrichtung (N, NNE, NE, ENE, E, ESE, SE, SSE, S, SSW, SW, WSW, W, WNW, NW, NNW),
  • Batteriewarnung (true oder false) und
  • Letzte Änderung (Zeit in Sekunden seitdem diese Daten empfangen wurden).

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für wind_direction:

  • 0 = N
  • 1 = NNE
  • 2 = NE
  • 3 = ENE
  • 4 = E
  • 5 = ESE
  • 6 = SE
  • 7 = SSE
  • 8 = S
  • 9 = SSW
  • 10 = SW
  • 11 = WSW
  • 12 = W
  • 13 = WNW
  • 14 = NW
  • 15 = NNW
  • 255 = Error
BrickletOutdoorWeather.get_sensor_data
Funktions-ID:
  • 4
Anfrage:
  • identifier – Typ: uint8, Wertebereich: [0 bis 255]
Antwort:
  • temperature – Typ: int16, Wertebereich: [-215 bis 215 - 1]
  • humidity – Typ: uint8, Wertebereich: [0 bis 255]
  • last_change – Typ: uint16, 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 in °C/10,
  • Luftfeuchte in %RH und
  • Letzte Änderung (Zeit in Sekunden seitdem diese Daten empfangen wurden).

Fortgeschrittene Funktionen

BrickletOutdoorWeather.get_spitfp_error_count
Funktions-ID:
  • 234
Anfrage:
  • keine Nutzdaten
Antwort:
  • error_count_ack_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: uint32, 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.

BrickletOutdoorWeather.set_bootloader_mode
Funktions-ID:
  • 235
Anfrage:
  • mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • status – Typ: uint8, Wertebereich: Siehe Bedeutungen

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot

Für status:

  • 0 = OK
  • 1 = Invalid Mode
  • 2 = No Change
  • 3 = Entry Function Not Present
  • 4 = Device Identifier Incorrect
  • 5 = CRC Mismatch
BrickletOutdoorWeather.get_bootloader_mode
Funktions-ID:
  • 236
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot
BrickletOutdoorWeather.set_write_firmware_pointer
Funktions-ID:
  • 237
Anfrage:
  • pointer – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Setzt den Firmware-Pointer für 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.

BrickletOutdoorWeather.write_firmware
Funktions-ID:
  • 238
Anfrage:
  • data – Typ: uint8[64], Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: uint8, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von 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.

BrickletOutdoorWeather.set_status_led_config
Funktions-ID:
  • 239
Anfrage:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen
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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletOutdoorWeather.get_status_led_config
Funktions-ID:
  • 240
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt die Konfiguration zurück, wie von set_status_led_config gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletOutdoorWeather.get_chip_temperature
Funktions-ID:
  • 242
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int16, Wertebereich: [-215 bis 215 - 1]

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.

BrickletOutdoorWeather.reset
Funktions-ID:
  • 243
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.

BrickletOutdoorWeather.write_uid
Funktions-ID:
  • 248
Anfrage:
  • uid – Typ: uint32, 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.

BrickletOutdoorWeather.read_uid
Funktions-ID:
  • 249
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: uint32, 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.

BrickletOutdoorWeather.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char
  • hardware_version – Typ: uint8[3], Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3], Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]

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. 

Konfigurationsfunktionen für Callbacks

BrickletOutdoorWeather.set_station_callback_configuration
Funktions-ID:
  • 5
Anfrage:
  • enable_callback – Typ: bool
Antwort:
  • keine Antwort

Aktiviert/Deaktiviert den Callback für Stationsdaten. Standardmäßig ist der Callback deaktiviert.

BrickletOutdoorWeather.get_station_callback_configuration
Funktions-ID:
  • 6
Anfrage:
  • keine Nutzdaten
Antwort:
  • enable_callback – Typ: bool

Gibt die Konfiguration zurück wie von set_station_callback_configuration gesetzt.

BrickletOutdoorWeather.set_sensor_callback_configuration
Funktions-ID:
  • 7
Anfrage:
  • enable_callback – Typ: bool
Antwort:
  • keine Antwort

Aktiviert/Deaktiviert den Callback für Sensordaten. Standardmäßig ist der Callback deaktiviert.

BrickletOutdoorWeather.get_sensor_callback_configuration
Funktions-ID:
  • 8
Anfrage:
  • keine Nutzdaten
Antwort:
  • enable_callback – Typ: bool

Gibt die Konfiguration zurück wie von set_sensor_callback_configuration gesetzt.

Callbacks

BrickletOutdoorWeather.CALLBACK_STATION_DATA
Funktions-ID:
  • 9
Antwort:
  • identifier – Typ: uint8, Wertebereich: [0 bis 255]
  • temperature – Typ: int16, Wertebereich: [-215 bis 215 - 1]
  • humidity – Typ: uint8, Wertebereich: [0 bis 255]
  • wind_speed – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • gust_speed – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • rain – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • wind_direction – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • battery_low – Typ: bool

Meldet die Stationsdaten bei jedem eingehenden Datenpaket. Siehe 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 set_station_callback_configuration aktiviert/deaktiviert werden (standardmäßig ist der Callback deaktiviert).

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für wind_direction:

  • 0 = N
  • 1 = NNE
  • 2 = NE
  • 3 = ENE
  • 4 = E
  • 5 = ESE
  • 6 = SE
  • 7 = SSE
  • 8 = S
  • 9 = SSW
  • 10 = SW
  • 11 = WSW
  • 12 = W
  • 13 = WNW
  • 14 = NW
  • 15 = NNW
  • 255 = Error
BrickletOutdoorWeather.CALLBACK_SENSOR_DATA
Funktions-ID:
  • 10
Antwort:
  • identifier – Typ: uint8, Wertebereich: [0 bis 255]
  • temperature – Typ: int16, Wertebereich: [-215 bis 215 - 1]
  • humidity – Typ: uint8, Wertebereich: [0 bis 255]

Meldet die Sensordaten bei jedem eingehenden Datenpaket. Siehe 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 set_sensor_callback_configuration aktiviert/deaktiviert werden (standardmäßig ist der Callback deaktiviert).