Software / API Bindings / C/C++ for Microcontrollers / API Reference and Examples / Bricklets / Outdoor Weather Bricklet

C/C++ for Microcontrollers - Outdoor Weather Bricklet¶

This is the description of the C/C++ for Microcontrollers API bindings for the Outdoor Weather Bricklet. General information and technical specifications for the Outdoor Weather Bricklet are summarized in its hardware description.

An installation guide for the C/C++ for Microcontrollers API bindings is part of their general description.

Examples¶

The example code below is 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¶

Most functions of the C/C++ bindings for microcontrollers return an error code (e_code).

Possible error codes are:

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_LOCKED = -12
TF_E_PORT_NOT_FOUND = -13

(as defined in errors.h) as well as the errors returned from the hardware abstraction layer (HAL) that is used.

Use :cpp:func`tf_hal_strerror` (defined in the HAL's header file) to get an error string for an error code.

Data returned from the device, when a getter is called, is handled via output parameters. These parameters are labeled with the ret_ prefix. The bindings will not write to an output parameter if NULL or nullptr is passed. This can be used to ignore outputs that you are not interested in.

None of the functions listed below are thread-safe. See the API bindings description for details.

Basic Functions¶

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

Parameters:	outdoor_weather – Type: TF_OutdoorWeather * uid – Type: const char * hal – Type: TF_HAL *
Returns:	e_code – Type: int

Creates the device object outdoor_weather with the optional unique device ID or port name uid_or_port_name and adds it to the HAL hal:

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

Normally uid_or_port_name can stay NULL. For more details about this see section UID or Port Name.

int tf_outdoor_weather_destroy(TF_OutdoorWeather *outdoor_weather)¶

Parameters:	outdoor_weather – Type: TF_OutdoorWeather *
Returns:	e_code – Type: int

Removes the device object outdoor_weather from its HAL and destroys it. The device object cannot be used anymore afterwards.

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

Parameters:	outdoor_weather – Type: TF_OutdoorWeather *
Output Parameters:	ret_identifiers – Type: uint8_t , Range: [0 to 255] ret_identifiers_length* – Type: uint16_t
Returns:	e_code – Type: int

Returns the identifiers (number between 0 and 255) of all stations that have been seen since the startup of the Bricklet.

Each station gives itself a random identifier on first startup.

Since firmware version 2.0.2 a station is removed from the list if no data was received for 12 hours.

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

Parameters:	outdoor_weather – Type: TF_OutdoorWeather *
Output Parameters:	ret_identifiers – Type: uint8_t , Range: [0 to 255] ret_identifiers_length* – Type: uint16_t
Returns:	e_code – Type: int

Returns the identifiers (number between 0 and 255) of all sensors that have been seen since the startup of the Bricklet.

Each sensor gives itself a random identifier on first startup.

Since firmware version 2.0.2 a sensor is removed from the list if no data was received for 12 hours.

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)¶

Parameters:	outdoor_weather – Type: TF_OutdoorWeather * identifier – Type: uint8_t, Range: [0 to 255]
Output Parameters:	ret_temperature – Type: int16_t, Unit: 1/10 °C, Range: [-400 to 650] ret_humidity – Type: uint8_t, Unit: 1 %, Range: [10 to 99] ret_wind_speed – Type: uint32_t, Unit: 1/10 m/s, Range: [0 to 2³² - 1] ret_gust_speed – Type: uint32_t, Unit: 1/10 m/s, Range: [0 to 2³² - 1] ret_rain – Type: uint32_t, Unit: 1/10 mm, Range: [0 to 2³² - 1] ret_wind_direction – Type: uint8_t, Range: See constants ret_battery_low – Type: bool ret_last_change – Type: uint16_t, Unit: 1 s, Range: [0 to 2¹⁶ - 1]
Returns:	e_code – Type: int

Returns the last received data for a station with the given identifier. Call tf_outdoor_weather_get_station_identifiers() for a list of all available identifiers.

The return values are:

Temperature,
Humidity,
Wind Speed,
Gust Speed,
Rain Fall (accumulated since station power-up),
Wind Direction,
Battery Low (true if battery is low) and
Last Change (seconds since the reception of this data).

The following constants are available for this function:

For 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)¶

Parameters:	outdoor_weather – Type: TF_OutdoorWeather * identifier – Type: uint8_t, Range: [0 to 255]
Output Parameters:	ret_temperature – Type: int16_t, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1] ret_humidity – Type: uint8_t, Unit: 1 %, Range: [0 to 255] ret_last_change – Type: uint16_t, Unit: 1 s, Range: [0 to 2¹⁶ - 1]
Returns:	e_code – Type: int

Returns the last measured data for a sensor with the given identifier. Call tf_outdoor_weather_get_sensor_identifiers() for a list of all available identifiers.

The return values are:

Temperature,
Humidity and
Last Change (seconds since the last reception of data).

Advanced Functions¶

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)¶

Parameters:	outdoor_weather – Type: TF_OutdoorWeather *
Output Parameters:	ret_error_count_ack_checksum – Type: uint32_t, Range: [0 to 2³² - 1] ret_error_count_message_checksum – Type: uint32_t, Range: [0 to 2³² - 1] ret_error_count_frame – Type: uint32_t, Range: [0 to 2³² - 1] ret_error_count_overflow – Type: uint32_t, Range: [0 to 2³² - 1]
Returns:	e_code – Type: int

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

ACK checksum errors,
message checksum errors,
framing errors and
overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

int tf_outdoor_weather_set_status_led_config(TF_OutdoorWeather *outdoor_weather, uint8_t config)¶

Parameters:	outdoor_weather – Type: TF_OutdoorWeather * config – Type: uint8_t, Range: See constants, Default: 3
Returns:	e_code – Type: int

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For 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)¶

Parameters:	outdoor_weather – Type: TF_OutdoorWeather *
Output Parameters:	ret_config – Type: uint8_t, Range: See constants, Default: 3
Returns:	e_code – Type: int

Returns the configuration as set by tf_outdoor_weather_set_status_led_config()

The following constants are available for this function:

For 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)¶

Parameters:	outdoor_weather – Type: TF_OutdoorWeather *
Output Parameters:	ret_temperature – Type: int16_t, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]
Returns:	e_code – Type: int

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

int tf_outdoor_weather_reset(TF_OutdoorWeather *outdoor_weather)¶

Parameters:	outdoor_weather – Type: TF_OutdoorWeather *
Returns:	e_code – Type: int

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

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)¶

Parameters:	outdoor_weather – Type: TF_OutdoorWeather *
Output Parameters:	ret_uid – Type: char[8] ret_connected_uid – Type: char[8] ret_position – Type: char, Range: ['a' to 'h', 'z'] ret_hardware_version – Type: uint8_t[3] 0: major – Type: uint8_t, Range: [0 to 255] 1: minor – Type: uint8_t, Range: [0 to 255] 2: revision – Type: uint8_t, Range: [0 to 255] ret_firmware_version – Type: uint8_t[3] 0: major – Type: uint8_t, Range: [0 to 255] 1: minor – Type: uint8_t, Range: [0 to 255] 2: revision – Type: uint8_t, Range: [0 to 255] ret_device_identifier – Type: uint16_t, Range: [0 to 2¹⁶ - 1]
Returns:	e_code – Type: int

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

int tf_outdoor_weather_set_station_callback_configuration(TF_OutdoorWeather *outdoor_weather, bool enable_callback)¶

Parameters:	outdoor_weather – Type: TF_OutdoorWeather * enable_callback – Type: bool, Default: false
Returns:	e_code – Type: int

Turns callback for station data on or off.

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

Parameters:	outdoor_weather – Type: TF_OutdoorWeather *
Output Parameters:	ret_enable_callback – Type: bool, Default: false
Returns:	e_code – Type: int

Returns the configuration as set by tf_outdoor_weather_set_station_callback_configuration().

int tf_outdoor_weather_set_sensor_callback_configuration(TF_OutdoorWeather *outdoor_weather, bool enable_callback)¶

Parameters:	outdoor_weather – Type: TF_OutdoorWeather * enable_callback – Type: bool, Default: false
Returns:	e_code – Type: int

Turns callback for sensor data on or off.

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

Parameters:	outdoor_weather – Type: TF_OutdoorWeather *
Output Parameters:	ret_enable_callback – Type: bool, Default: false
Returns:	e_code – Type: int

Returns the configuration as set by tf_outdoor_weather_set_sensor_callback_configuration().

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding tf_outdoor_weather_register_*_callback function. The user_data passed to the registration function as well as the device that triggered the callback are passed to the registered callback handler.

Only one handler can be registered to a callback at the same time. To deregister a callback, call the tf_outdoor_weather_register_*_callback function with NULL as handler.

Note

Using callbacks for recurring events is preferred compared to using getters. Polling for a callback requires writing one byte only. See here Optimizing Performance.

Warning

Calling bindings function from inside a callback handler is not allowed. See here Thread safety.

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

Callback Parameters:	outdoor_weather – Type: TF_OutdoorWeather * identifier – Type: uint8_t, Range: [0 to 255] temperature – Type: int16_t, Unit: 1/10 °C, Range: [-400 to 650] humidity – Type: uint8_t, Unit: 1 %, Range: [10 to 99] wind_speed – Type: uint32_t, Unit: 1/10 m/s, Range: [0 to 2³² - 1] gust_speed – Type: uint32_t, Unit: 1/10 m/s, Range: [0 to 2³² - 1] rain – Type: uint32_t, Unit: 1/10 mm, Range: [0 to 2³² - 1] wind_direction – Type: uint8_t, Range: See constants battery_low – Type: bool user_data – Type: void *

outdoor_weather – Type: TF_OutdoorWeather *
identifier – Type: uint8_t, Range: [0 to 255]
temperature – Type: int16_t, Unit: 1/10 °C, Range: [-400 to 650]
humidity – Type: uint8_t, Unit: 1 %, Range: [10 to 99]
wind_speed – Type: uint32_t, Unit: 1/10 m/s, Range: [0 to 2³² - 1]
gust_speed – Type: uint32_t, Unit: 1/10 m/s, Range: [0 to 2³² - 1]
rain – Type: uint32_t, Unit: 1/10 mm, Range: [0 to 2³² - 1]
wind_direction – Type: uint8_t, Range: See constants
battery_low – Type: bool
user_data – Type: void *

Reports the station data every time a new data packet is received. See tf_outdoor_weather_get_station_data() for information about the data.

For each station the callback will be triggered about every 45 seconds.

Turn the callback on/off with tf_outdoor_weather_set_station_callback_configuration() (by default it is turned off).

The following constants are available for this function:

For 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 Parameters:	outdoor_weather – Type: TF_OutdoorWeather * identifier – Type: uint8_t, Range: [0 to 255] temperature – Type: int16_t, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1] humidity – Type: uint8_t, Unit: 1 %, Range: [0 to 255] user_data – Type: void *

Reports the sensor data every time a new data packet is received. See tf_outdoor_weather_get_sensor_data() for information about the data.

For each sensor the callback will be called about every 45 seconds.

Turn the callback on/off with tf_outdoor_weather_set_sensor_callback_configuration() (by default it is turned off).

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object.

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

Parameters:	outdoor_weather – Type: TF_OutdoorWeather * function_id – Type: uint8_t, Range: See constants
Output Parameters:	ret_response_expected – Type: bool
Returns:	e_code – Type: int

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by tf_outdoor_weather_set_response_expected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For 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)¶

Parameters:	outdoor_weather – Type: TF_OutdoorWeather * function_id – Type: uint8_t, Range: See constants response_expected – Type: bool
Returns:	e_code – Type: int

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

The following constants are available for this function:

For 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)¶

Parameters:	outdoor_weather – Type: TF_OutdoorWeather * response_expected – Type: bool
Returns:	e_code – Type: int

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

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

Parameters:	outdoor_weather – Type: TF_OutdoorWeather * mode – Type: uint8_t, Range: See constants
Output Parameters:	ret_status – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For 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

For 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)¶

Parameters:	outdoor_weather – Type: TF_OutdoorWeather *
Output Parameters:	ret_mode – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

Returns the current bootloader mode, see tf_outdoor_weather_set_bootloader_mode().

The following constants are available for this function:

For 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)¶

Parameters:	outdoor_weather – Type: TF_OutdoorWeather * pointer – Type: uint32_t, Unit: 1 B, Range: [0 to 2³² - 1]
Returns:	e_code – Type: int

Sets the firmware pointer for tf_outdoor_weather_write_firmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

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

Parameters:	outdoor_weather – Type: TF_OutdoorWeather * data – Type: const uint8_t[64], Range: [0 to 255]
Output Parameters:	ret_status – Type: uint8_t, Range: [0 to 255]
Returns:	e_code – Type: int

Writes 64 Bytes of firmware at the position as written by tf_outdoor_weather_set_write_firmware_pointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

int tf_outdoor_weather_write_uid(TF_OutdoorWeather *outdoor_weather, uint32_t uid)¶

Parameters:	outdoor_weather – Type: TF_OutdoorWeather * uid – Type: uint32_t, Range: [0 to 2³² - 1]
Returns:	e_code – Type: int

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

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

Parameters:	outdoor_weather – Type: TF_OutdoorWeather *
Output Parameters:	ret_uid – Type: uint32_t, Range: [0 to 2³² - 1]
Returns:	e_code – Type: int

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

TF_OUTDOOR_WEATHER_DEVICE_IDENTIFIER¶

This constant is used to identify a Outdoor Weather Bricklet.

The functions tf_outdoor_weather_get_identity() and tf_hal_get_device_info() have a device_identifier output parameter to specify the Brick's or Bricklet's type.

TF_OUTDOOR_WEATHER_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Outdoor Weather Bricklet.