Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / Outdoor Weather Bricklet

C/C++ für Mikrocontroller - Outdoor Weather Bricklet¶

Dies ist die Beschreibung der C/C++ für Mikrocontroller 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 C/C++ für Mikrocontroller API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Callback¶

Download (example_callback.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_outdoor_weather.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

// Callback function for station data callback
static void station_data_handler(TF_OutdoorWeather *device, uint8_t identifier,
                                 int16_t temperature, uint8_t humidity,
                                 uint32_t wind_speed, uint32_t gust_speed, uint32_t rain,
                                 uint8_t wind_direction, bool battery_low,
                                 void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Identifier (Station): %I8u\n", identifier);
    tf_hal_printf("Temperature (Station): %d 1/%d °C\n", temperature, 10);
    tf_hal_printf("Humidity (Station): %I8u %%RH\n", humidity);
    tf_hal_printf("Wind Speed (Station): %d 1/%d m/s\n", wind_speed, 10);
    tf_hal_printf("Gust Speed (Station): %d 1/%d m/s\n", gust_speed, 10);
    tf_hal_printf("Rain (Station): %d 1/%d mm\n", rain, 10);

    if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_N) {
        tf_hal_printf("Wind Direction (Station): N\n");
    } else if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_NNE) {
        tf_hal_printf("Wind Direction (Station): NNE\n");
    } else if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_NE) {
        tf_hal_printf("Wind Direction (Station): NE\n");
    } else if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_ENE) {
        tf_hal_printf("Wind Direction (Station): ENE\n");
    } else if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_E) {
        tf_hal_printf("Wind Direction (Station): E\n");
    } else if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_ESE) {
        tf_hal_printf("Wind Direction (Station): ESE\n");
    } else if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_SE) {
        tf_hal_printf("Wind Direction (Station): SE\n");
    } else if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_SSE) {
        tf_hal_printf("Wind Direction (Station): SSE\n");
    } else if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_S) {
        tf_hal_printf("Wind Direction (Station): S\n");
    } else if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_SSW) {
        tf_hal_printf("Wind Direction (Station): SSW\n");
    } else if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_SW) {
        tf_hal_printf("Wind Direction (Station): SW\n");
    } else if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_WSW) {
        tf_hal_printf("Wind Direction (Station): WSW\n");
    } else if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_W) {
        tf_hal_printf("Wind Direction (Station): W\n");
    } else if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_WNW) {
        tf_hal_printf("Wind Direction (Station): WNW\n");
    } else if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_NW) {
        tf_hal_printf("Wind Direction (Station): NW\n");
    } else if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_NNW) {
        tf_hal_printf("Wind Direction (Station): NNW\n");
    } else if (wind_direction == TF_OUTDOOR_WEATHER_WIND_DIRECTION_ERROR) {
        tf_hal_printf("Wind Direction (Station): Error\n");
    }

    tf_hal_printf("Battery Low (Station): %s\n", battery_low ? "true" : "false");
    tf_hal_printf("\n");
}

// Callback function for sensor data callback
static void sensor_data_handler(TF_OutdoorWeather *device, uint8_t identifier,
                                int16_t temperature, uint8_t humidity, void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Identifier (Sensor): %I8u\n", identifier);
    tf_hal_printf("Temperature (Sensor): %d 1/%d °C\n", temperature, 10);
    tf_hal_printf("Humidity (Sensor): %I8u %%RH\n", humidity);
    tf_hal_printf("\n");
}

static TF_OutdoorWeather ow;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_outdoor_weather_create(&ow, NULL, hal), "create device object");

    // Enable station data callbacks
    check(tf_outdoor_weather_set_station_callback_configuration(&ow,
                                                                true), "call set_station_callback_configuration");

    // Enable sensor data callbacks
    check(tf_outdoor_weather_set_sensor_callback_configuration(&ow,
                                                               true), "call set_sensor_callback_configuration");

    // Register station data callback to function station_data_handler
    tf_outdoor_weather_register_station_data_callback(&ow,
                                                      station_data_handler,
                                                      NULL);

    // Register sensor data callback to function sensor_data_handler
    tf_outdoor_weather_register_sensor_data_callback(&ow,
                                                     sensor_data_handler,
                                                     NULL);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

API¶

Die meistens Funktionen der C/C++ Bindings für Mikrocontroller geben einen Fehlercode (e_code) zurück

Mögliche Fehlercodes sind:

TF_E_OK = 0
TF_E_TIMEOUT = -1
TF_E_INVALID_PARAMETER = -2
TF_E_NOT_SUPPORTED = -3
TF_E_UNKNOWN_ERROR_CODE = -4
TF_E_STREAM_OUT_OF_SYNC = -5
TF_E_INVALID_CHAR_IN_UID = -6
TF_E_UID_TOO_LONG = -7
TF_E_UID_OVERFLOW = -8
TF_E_TOO_MANY_DEVICES = -9
TF_E_DEVICE_NOT_FOUND = -10
TF_E_WRONG_DEVICE_TYPE = -11
TF_E_CALLBACK_EXEC = -12
TF_E_PORT_NOT_FOUND = -13

(wie in errors.h definiert), sowie die Fehlercodes des verwendeten Hardware-Abstraction-Layers (HALs). Mit tf_hal_strerror (im Header das HALs definiert) kann ein Fehlerstring zu einem Fehlercode abgefragt werden.

Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet. Die Bindings schreiben einen Ausgabeparameter nicht, wenn NULL bzw. nullptr übergeben wird. So können uninteressante Ausgaben ignoriert werden.

Keine der folgend aufgelisteten Funktionen ist Thread-sicher. Details finden sich in der Beschreibung der API-Bindings.

Grundfunktionen¶

int tf_outdoor_weather_create(TF_OutdoorWeather *outdoor_weather, const char *uid, TF_HAL *hal)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

Erzeugt ein Geräteobjekt outdoor_weather mit der optionalen eindeutigen Geräte ID oder dem Portnamen uid_or_port_name und fügt es dem HAL hal hinzu:

TF_OutdoorWeather outdoor_weather;
tf_outdoor_weather_create(&outdoor_weather, NULL, &ipcon);

Im Normalfall kann uid_or_port_name auf NULL belassen werden. Für weitere Details siehe Abschnitt UID oder Port-Name.

int tf_outdoor_weather_destroy(TF_OutdoorWeather *outdoor_weather)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather *
Rückgabe:	e_code – Typ: int

Entfernt das Geräteobjekt outdoor_weather von dessen HAL und zerstört es. Das Geräteobjekt kann hiernach nicht mehr verwendet werden.

int tf_outdoor_weather_get_station_identifiers(TF_OutdoorWeather *outdoor_weather, uint8_t *ret_identifiers, uint16_t *ret_identifiers_length)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather *
Ausgabeparameter:	ret_identifiers – Typ: uint8_t , Wertebereich: [0 bis 255] ret_identifiers_length* – Typ: uint16_t
Rückgabe:	e_code – Typ: int

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.

int tf_outdoor_weather_get_sensor_identifiers(TF_OutdoorWeather *outdoor_weather, uint8_t *ret_identifiers, uint16_t *ret_identifiers_length)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather *
Ausgabeparameter:	ret_identifiers – Typ: uint8_t , Wertebereich: [0 bis 255] ret_identifiers_length* – Typ: uint16_t
Rückgabe:	e_code – Typ: int

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.

int tf_outdoor_weather_get_station_data(TF_OutdoorWeather *outdoor_weather, uint8_t identifier, int16_t *ret_temperature, uint8_t *ret_humidity, uint32_t *ret_wind_speed, uint32_t *ret_gust_speed, uint32_t *ret_rain, uint8_t *ret_wind_direction, bool *ret_battery_low, uint16_t *ret_last_change)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather * identifier – Typ: uint8_t, Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-400 bis 650] ret_humidity – Typ: uint8_t, Einheit: 1 %, Wertebereich: [10 bis 99] ret_wind_speed – Typ: uint32_t, Einheit: 1/10 m/s, Wertebereich: [0 bis 2³² - 1] ret_gust_speed – Typ: uint32_t, Einheit: 1/10 m/s, Wertebereich: [0 bis 2³² - 1] ret_rain – Typ: uint32_t, Einheit: 1/10 mm, Wertebereich: [0 bis 2³² - 1] ret_wind_direction – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_battery_low – Typ: bool ret_last_change – Typ: uint16_t, Einheit: 1 s, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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 (kumuliert seit dem Einschalten der Station),
Windrichtung,
Batteriewarnung (true wenn der Batteriestand niedrig ist) und
Letzte Änderung (Sekunden seitdem diese Daten empfangen wurden).

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

Für ret_wind_direction:

TF_OUTDOOR_WEATHER_WIND_DIRECTION_N = 0
TF_OUTDOOR_WEATHER_WIND_DIRECTION_NNE = 1
TF_OUTDOOR_WEATHER_WIND_DIRECTION_NE = 2
TF_OUTDOOR_WEATHER_WIND_DIRECTION_ENE = 3
TF_OUTDOOR_WEATHER_WIND_DIRECTION_E = 4
TF_OUTDOOR_WEATHER_WIND_DIRECTION_ESE = 5
TF_OUTDOOR_WEATHER_WIND_DIRECTION_SE = 6
TF_OUTDOOR_WEATHER_WIND_DIRECTION_SSE = 7
TF_OUTDOOR_WEATHER_WIND_DIRECTION_S = 8
TF_OUTDOOR_WEATHER_WIND_DIRECTION_SSW = 9
TF_OUTDOOR_WEATHER_WIND_DIRECTION_SW = 10
TF_OUTDOOR_WEATHER_WIND_DIRECTION_WSW = 11
TF_OUTDOOR_WEATHER_WIND_DIRECTION_W = 12
TF_OUTDOOR_WEATHER_WIND_DIRECTION_WNW = 13
TF_OUTDOOR_WEATHER_WIND_DIRECTION_NW = 14
TF_OUTDOOR_WEATHER_WIND_DIRECTION_NNW = 15
TF_OUTDOOR_WEATHER_WIND_DIRECTION_ERROR = 255

int tf_outdoor_weather_get_sensor_data(TF_OutdoorWeather *outdoor_weather, uint8_t identifier, int16_t *ret_temperature, uint8_t *ret_humidity, uint16_t *ret_last_change)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather * identifier – Typ: uint8_t, Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] ret_humidity – Typ: uint8_t, Einheit: 1 %, Wertebereich: [0 bis 255] ret_last_change – Typ: uint16_t, Einheit: 1 s, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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¶

int tf_outdoor_weather_get_spitfp_error_count(TF_OutdoorWeather *outdoor_weather, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: 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.

int tf_outdoor_weather_set_status_led_config(TF_OutdoorWeather *outdoor_weather, uint8_t config)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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 Konstanten sind für diese Funktion verfügbar:

Für config:

TF_OUTDOOR_WEATHER_STATUS_LED_CONFIG_OFF = 0
TF_OUTDOOR_WEATHER_STATUS_LED_CONFIG_ON = 1
TF_OUTDOOR_WEATHER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_OUTDOOR_WEATHER_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_outdoor_weather_get_status_led_config(TF_OutdoorWeather *outdoor_weather, uint8_t *ret_config)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Gibt die Konfiguration zurück, wie von tf_outdoor_weather_set_status_led_config() gesetzt.

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

Für ret_config:

TF_OUTDOOR_WEATHER_STATUS_LED_CONFIG_OFF = 0
TF_OUTDOOR_WEATHER_STATUS_LED_CONFIG_ON = 1
TF_OUTDOOR_WEATHER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_OUTDOOR_WEATHER_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_outdoor_weather_get_chip_temperature(TF_OutdoorWeather *outdoor_weather, int16_t *ret_temperature)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_outdoor_weather_reset(TF_OutdoorWeather *outdoor_weather)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather *
Rückgabe:	e_code – Typ: int

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.

int tf_outdoor_weather_get_identity(TF_OutdoorWeather *outdoor_weather, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] ret_hardware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_firmware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

int tf_outdoor_weather_set_station_callback_configuration(TF_OutdoorWeather *outdoor_weather, bool enable_callback)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather * enable_callback – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Aktiviert/Deaktiviert den Callback für Stationsdaten.

int tf_outdoor_weather_get_station_callback_configuration(TF_OutdoorWeather *outdoor_weather, bool *ret_enable_callback)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather *
Ausgabeparameter:	ret_enable_callback – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Konfiguration zurück wie von tf_outdoor_weather_set_station_callback_configuration() gesetzt.

int tf_outdoor_weather_set_sensor_callback_configuration(TF_OutdoorWeather *outdoor_weather, bool enable_callback)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather * enable_callback – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Aktiviert/Deaktiviert den Callback für Sensordaten.

int tf_outdoor_weather_get_sensor_callback_configuration(TF_OutdoorWeather *outdoor_weather, bool *ret_enable_callback)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather *
Ausgabeparameter:	ret_enable_callback – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Konfiguration zurück wie von tf_outdoor_weather_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 der entsprechenden tf_outdoor_weather_register_*_callback Funktion durchgeführt werden. Die user_data, sowie das Gerät, dass das Callback ausgelöst hat, werden dem registrierten Callback-Handler übergeben.

Nur ein Handler kann gleichzeitig auf das selbe Callback registriert werden. Um einen Handler zu deregistrieren, kann die tf_outdoor_weather_register_*_callback-Funktion mit NULL als Handler aufgerufen werden.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist gegenüber der Verwendung von Abfragen zu bevorzugen. Es muss nur ein Byte abgefragt werden um zu prüfen ob ein Callback vorliegt. Siehe hier Performanceoptimierungen.

Warnung

Aus Callback-Handlern heraus können keine Bindings-Funktionen verwendet werden. Siehe hier Callbacks.

int tf_outdoor_weather_register_station_data_callback(TF_OutdoorWeather *outdoor_weather, TF_OutdoorWeather_StationDataHandler handler, void *user_data)¶

void handler(TF_OutdoorWeather *outdoor_weather, uint8_t identifier, int16_t temperature, uint8_t humidity, uint32_t wind_speed, uint32_t gust_speed, uint32_t rain, uint8_t wind_direction, bool battery_low, void *user_data)

Callback-Parameter:

Callback-Parameter:	outdoor_weather – Typ: TF_OutdoorWeather * identifier – Typ: uint8_t, Wertebereich: [0 bis 255] temperature – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-400 bis 650] humidity – Typ: uint8_t, Einheit: 1 %, Wertebereich: [10 bis 99] wind_speed – Typ: uint32_t, Einheit: 1/10 m/s, Wertebereich: [0 bis 2³² - 1] gust_speed – Typ: uint32_t, Einheit: 1/10 m/s, Wertebereich: [0 bis 2³² - 1] rain – Typ: uint32_t, Einheit: 1/10 mm, Wertebereich: [0 bis 2³² - 1] wind_direction – Typ: uint8_t, Wertebereich: Siehe Konstanten battery_low – Typ: bool user_data – Typ: void *

outdoor_weather – Typ: TF_OutdoorWeather *
identifier – Typ: uint8_t, Wertebereich: [0 bis 255]
temperature – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-400 bis 650]
humidity – Typ: uint8_t, Einheit: 1 %, Wertebereich: [10 bis 99]
wind_speed – Typ: uint32_t, Einheit: 1/10 m/s, Wertebereich: [0 bis 2³² - 1]
gust_speed – Typ: uint32_t, Einheit: 1/10 m/s, Wertebereich: [0 bis 2³² - 1]
rain – Typ: uint32_t, Einheit: 1/10 mm, Wertebereich: [0 bis 2³² - 1]
wind_direction – Typ: uint8_t, Wertebereich: Siehe Konstanten
battery_low – Typ: bool
user_data – Typ: void *

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

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

Für wind_direction:

TF_OUTDOOR_WEATHER_WIND_DIRECTION_N = 0
TF_OUTDOOR_WEATHER_WIND_DIRECTION_NNE = 1
TF_OUTDOOR_WEATHER_WIND_DIRECTION_NE = 2
TF_OUTDOOR_WEATHER_WIND_DIRECTION_ENE = 3
TF_OUTDOOR_WEATHER_WIND_DIRECTION_E = 4
TF_OUTDOOR_WEATHER_WIND_DIRECTION_ESE = 5
TF_OUTDOOR_WEATHER_WIND_DIRECTION_SE = 6
TF_OUTDOOR_WEATHER_WIND_DIRECTION_SSE = 7
TF_OUTDOOR_WEATHER_WIND_DIRECTION_S = 8
TF_OUTDOOR_WEATHER_WIND_DIRECTION_SSW = 9
TF_OUTDOOR_WEATHER_WIND_DIRECTION_SW = 10
TF_OUTDOOR_WEATHER_WIND_DIRECTION_WSW = 11
TF_OUTDOOR_WEATHER_WIND_DIRECTION_W = 12
TF_OUTDOOR_WEATHER_WIND_DIRECTION_WNW = 13
TF_OUTDOOR_WEATHER_WIND_DIRECTION_NW = 14
TF_OUTDOOR_WEATHER_WIND_DIRECTION_NNW = 15
TF_OUTDOOR_WEATHER_WIND_DIRECTION_ERROR = 255

int tf_outdoor_weather_register_sensor_data_callback(TF_OutdoorWeather *outdoor_weather, TF_OutdoorWeather_SensorDataHandler handler, void *user_data)¶

void handler(TF_OutdoorWeather *outdoor_weather, uint8_t identifier, int16_t temperature, uint8_t humidity, void *user_data)

Callback-Parameter:	outdoor_weather – Typ: TF_OutdoorWeather * identifier – Typ: uint8_t, Wertebereich: [0 bis 255] temperature – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] humidity – Typ: uint8_t, Einheit: 1 %, Wertebereich: [0 bis 255] user_data – Typ: void *

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

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt.

int tf_outdoor_weather_get_response_expected(TF_OutdoorWeather *outdoor_weather, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels tf_outdoor_weather_set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für function_id:

TF_OUTDOOR_WEATHER_FUNCTION_SET_STATION_CALLBACK_CONFIGURATION = 5
TF_OUTDOOR_WEATHER_FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION = 7
TF_OUTDOOR_WEATHER_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_OUTDOOR_WEATHER_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_OUTDOOR_WEATHER_FUNCTION_RESET = 243
TF_OUTDOOR_WEATHER_FUNCTION_WRITE_UID = 248

int tf_outdoor_weather_set_response_expected(TF_OutdoorWeather *outdoor_weather, uint8_t function_id, bool response_expected)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

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

Für function_id:

TF_OUTDOOR_WEATHER_FUNCTION_SET_STATION_CALLBACK_CONFIGURATION = 5
TF_OUTDOOR_WEATHER_FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION = 7
TF_OUTDOOR_WEATHER_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_OUTDOOR_WEATHER_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_OUTDOOR_WEATHER_FUNCTION_RESET = 243
TF_OUTDOOR_WEATHER_FUNCTION_WRITE_UID = 248

int tf_outdoor_weather_set_response_expected_all(TF_OutdoorWeather *outdoor_weather, bool response_expected)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

int tf_outdoor_weather_set_bootloader_mode(TF_OutdoorWeather *outdoor_weather, uint8_t mode, uint8_t *ret_status)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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 Konstanten sind für diese Funktion verfügbar:

Für mode:

TF_OUTDOOR_WEATHER_BOOTLOADER_MODE_BOOTLOADER = 0
TF_OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE = 1
TF_OUTDOOR_WEATHER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_OUTDOOR_WEATHER_BOOTLOADER_STATUS_OK = 0
TF_OUTDOOR_WEATHER_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_OUTDOOR_WEATHER_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_OUTDOOR_WEATHER_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_OUTDOOR_WEATHER_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_OUTDOOR_WEATHER_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_outdoor_weather_get_bootloader_mode(TF_OutdoorWeather *outdoor_weather, uint8_t *ret_mode)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Bootloader-Modus zurück, siehe tf_outdoor_weather_set_bootloader_mode().

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

Für ret_mode:

TF_OUTDOOR_WEATHER_BOOTLOADER_MODE_BOOTLOADER = 0
TF_OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE = 1
TF_OUTDOOR_WEATHER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_outdoor_weather_set_write_firmware_pointer(TF_OutdoorWeather *outdoor_weather, uint32_t pointer)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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

int tf_outdoor_weather_write_firmware(TF_OutdoorWeather *outdoor_weather, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather * data – Typ: const uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

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

int tf_outdoor_weather_write_uid(TF_OutdoorWeather *outdoor_weather, uint32_t uid)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather * uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: 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.

int tf_outdoor_weather_read_uid(TF_OutdoorWeather *outdoor_weather, uint32_t *ret_uid)¶

Parameter:	outdoor_weather – Typ: TF_OutdoorWeather *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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

Konstanten¶

TF_OUTDOOR_WEATHER_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Outdoor Weather Bricklet zu identifizieren.

Die Funktionen tf_outdoor_weather_get_identity() und tf_hal_get_device_info() haben einen device_identifier Ausgabe-Parameter um den Typ des Bricks oder Bricklets anzugeben.

TF_OUTDOOR_WEATHER_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Outdoor Weather Bricklet dar.