C/C++ - Outdoor Weather Bricklet¶

This is the description of the C/C++ 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++ API bindings is part of their general description.

Examples¶

The example code below is Public Domain (CC0 1.0).

Callback¶

Download (example_callback.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_outdoor_weather.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Outdoor Weather Bricklet

// Callback function for station data callback
void cb_station_data(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)user_data; // avoid unused parameter warning

    printf("Identifier (Station): %u\n", identifier);
    printf("Temperature (Station): %f °C\n", temperature/10.0);
    printf("Humidity (Station): %u %%RH\n", humidity);
    printf("Wind Speed (Station): %f m/s\n", wind_speed/10.0);
    printf("Gust Speed (Station): %f m/s\n", gust_speed/10.0);
    printf("Rain (Station): %f mm\n", rain/10.0);

    if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_N) {
        printf("Wind Direction (Station): N\n");
    } else if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_NNE) {
        printf("Wind Direction (Station): NNE\n");
    } else if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_NE) {
        printf("Wind Direction (Station): NE\n");
    } else if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_ENE) {
        printf("Wind Direction (Station): ENE\n");
    } else if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_E) {
        printf("Wind Direction (Station): E\n");
    } else if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_ESE) {
        printf("Wind Direction (Station): ESE\n");
    } else if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_SE) {
        printf("Wind Direction (Station): SE\n");
    } else if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_SSE) {
        printf("Wind Direction (Station): SSE\n");
    } else if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_S) {
        printf("Wind Direction (Station): S\n");
    } else if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_SSW) {
        printf("Wind Direction (Station): SSW\n");
    } else if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_SW) {
        printf("Wind Direction (Station): SW\n");
    } else if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_WSW) {
        printf("Wind Direction (Station): WSW\n");
    } else if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_W) {
        printf("Wind Direction (Station): W\n");
    } else if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_WNW) {
        printf("Wind Direction (Station): WNW\n");
    } else if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_NW) {
        printf("Wind Direction (Station): NW\n");
    } else if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_NNW) {
        printf("Wind Direction (Station): NNW\n");
    } else if(wind_direction == OUTDOOR_WEATHER_WIND_DIRECTION_ERROR) {
        printf("Wind Direction (Station): Error\n");
    }

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

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

    printf("Identifier (Sensor): %u\n", identifier);
    printf("Temperature (Sensor): %f °C\n", temperature/10.0);
    printf("Humidity (Sensor): %u %%RH\n", humidity);
    printf("\n");
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    OutdoorWeather ow;
    outdoor_weather_create(&ow, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Enable station data callbacks
    outdoor_weather_set_station_callback_configuration(&ow, true);

    // Enable sensor data callbacks
    outdoor_weather_set_sensor_callback_configuration(&ow, true);

    // Register station data callback to function cb_station_data
    outdoor_weather_register_callback(&ow,
                                      OUTDOOR_WEATHER_CALLBACK_STATION_DATA,
                                      (void (*)(void))cb_station_data,
                                      NULL);

    // Register sensor data callback to function cb_sensor_data
    outdoor_weather_register_callback(&ow,
                                      OUTDOOR_WEATHER_CALLBACK_SENSOR_DATA,
                                      (void (*)(void))cb_sensor_data,
                                      NULL);

    printf("Press key to exit\n");
    getchar();
    outdoor_weather_destroy(&ow);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API¶

Most functions of the C/C++ bindings return an error code (e_code). Data returned from the device, when a getter is called, is handled via output parameters. These parameters are labeled with the ret_ prefix.

Possible error codes are:

E_OK = 0
E_TIMEOUT = -1
E_NO_STREAM_SOCKET = -2
E_HOSTNAME_INVALID = -3
E_NO_CONNECT = -4
E_NO_THREAD = -5
E_NOT_ADDED = -6 (unused since C/C++ bindings version 2.0.0)
E_ALREADY_CONNECTED = -7
E_NOT_CONNECTED = -8
E_INVALID_PARAMETER = -9
E_NOT_SUPPORTED = -10
E_UNKNOWN_ERROR_CODE = -11
E_STREAM_OUT_OF_SYNC = -12
E_INVALID_UID = -13
E_NON_ASCII_CHAR_IN_SECRET = -14
E_WRONG_DEVICE_TYPE = -15
E_DEVICE_REPLACED = -16
E_WRONG_RESPONSE_LENGTH = -17

as defined in ip_connection.h.

All functions listed below are thread-safe.

Basic Functions¶

void outdoor_weather_create(OutdoorWeather *outdoor_weather, const char *uid, IPConnection *ipcon)¶

Parameters:	outdoor_weather – Type: OutdoorWeather * uid – Type: const char * ipcon – Type: IPConnection *

Creates the device object outdoor_weather with the unique device ID uid and adds it to the IPConnection ipcon:

OutdoorWeather outdoor_weather;
outdoor_weather_create(&outdoor_weather, "YOUR_DEVICE_UID", &ipcon);

This device object can be used after the IP connection has been connected.

void outdoor_weather_destroy(OutdoorWeather *outdoor_weather)¶

Parameters:	outdoor_weather – Type: OutdoorWeather *

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

int outdoor_weather_get_station_identifiers(OutdoorWeather *outdoor_weather, uint8_t *ret_identifiers, uint16_t *ret_identifiers_length)¶

Parameters:	outdoor_weather – Type: 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 outdoor_weather_get_sensor_identifiers(OutdoorWeather *outdoor_weather, uint8_t *ret_identifiers, uint16_t *ret_identifiers_length)¶

Parameters:	outdoor_weather – Type: 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 outdoor_weather_get_station_data(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: 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 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:

OUTDOOR_WEATHER_WIND_DIRECTION_N = 0
OUTDOOR_WEATHER_WIND_DIRECTION_NNE = 1
OUTDOOR_WEATHER_WIND_DIRECTION_NE = 2
OUTDOOR_WEATHER_WIND_DIRECTION_ENE = 3
OUTDOOR_WEATHER_WIND_DIRECTION_E = 4
OUTDOOR_WEATHER_WIND_DIRECTION_ESE = 5
OUTDOOR_WEATHER_WIND_DIRECTION_SE = 6
OUTDOOR_WEATHER_WIND_DIRECTION_SSE = 7
OUTDOOR_WEATHER_WIND_DIRECTION_S = 8
OUTDOOR_WEATHER_WIND_DIRECTION_SSW = 9
OUTDOOR_WEATHER_WIND_DIRECTION_SW = 10
OUTDOOR_WEATHER_WIND_DIRECTION_WSW = 11
OUTDOOR_WEATHER_WIND_DIRECTION_W = 12
OUTDOOR_WEATHER_WIND_DIRECTION_WNW = 13
OUTDOOR_WEATHER_WIND_DIRECTION_NW = 14
OUTDOOR_WEATHER_WIND_DIRECTION_NNW = 15
OUTDOOR_WEATHER_WIND_DIRECTION_ERROR = 255

int outdoor_weather_get_sensor_data(OutdoorWeather *outdoor_weather, uint8_t identifier, int16_t *ret_temperature, uint8_t *ret_humidity, uint16_t *ret_last_change)¶

Parameters:	outdoor_weather – Type: 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 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 outdoor_weather_get_spitfp_error_count(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: 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 outdoor_weather_set_status_led_config(OutdoorWeather *outdoor_weather, uint8_t config)¶

Parameters:	outdoor_weather – Type: 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:

OUTDOOR_WEATHER_STATUS_LED_CONFIG_OFF = 0
OUTDOOR_WEATHER_STATUS_LED_CONFIG_ON = 1
OUTDOOR_WEATHER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
OUTDOOR_WEATHER_STATUS_LED_CONFIG_SHOW_STATUS = 3

int outdoor_weather_get_status_led_config(OutdoorWeather *outdoor_weather, uint8_t *ret_config)¶

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

Returns the configuration as set by outdoor_weather_set_status_led_config()

The following constants are available for this function:

For ret_config:

OUTDOOR_WEATHER_STATUS_LED_CONFIG_OFF = 0
OUTDOOR_WEATHER_STATUS_LED_CONFIG_ON = 1
OUTDOOR_WEATHER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
OUTDOOR_WEATHER_STATUS_LED_CONFIG_SHOW_STATUS = 3

int outdoor_weather_get_chip_temperature(OutdoorWeather *outdoor_weather, int16_t *ret_temperature)¶

Parameters:	outdoor_weather – Type: 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 outdoor_weather_reset(OutdoorWeather *outdoor_weather)¶

Parameters:	outdoor_weather – Type: 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 outdoor_weather_get_identity(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: 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¶

void outdoor_weather_register_callback(OutdoorWeather *outdoor_weather, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameters:	outdoor_weather – Type: OutdoorWeather * callback_id – Type: int16_t function – Type: void ()(void) user_data* – Type: void *

Registers the given function with the given callback_id. The user_data will be passed as the last parameter to the function.

The available callback IDs with corresponding function signatures are listed below.

int outdoor_weather_set_station_callback_configuration(OutdoorWeather *outdoor_weather, bool enable_callback)¶

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

Turns callback for station data on or off.

int outdoor_weather_get_station_callback_configuration(OutdoorWeather *outdoor_weather, bool *ret_enable_callback)¶

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

Returns the configuration as set by outdoor_weather_set_station_callback_configuration().

int outdoor_weather_set_sensor_callback_configuration(OutdoorWeather *outdoor_weather, bool enable_callback)¶

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

Turns callback for sensor data on or off.

int outdoor_weather_get_sensor_callback_configuration(OutdoorWeather *outdoor_weather, bool *ret_enable_callback)¶

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

Returns the configuration as set by 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 outdoor_weather_register_callback() function:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

outdoor_weather_register_callback(&outdoor_weather,
                                  OUTDOOR_WEATHER_CALLBACK_EXAMPLE,
                                  (void (*)(void))my_callback,
                                  NULL);

The available constants with corresponding function signatures are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

OUTDOOR_WEATHER_CALLBACK_STATION_DATA¶

void callback(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:	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 *

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 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 outdoor_weather_set_station_callback_configuration() (by default it is turned off).

The following constants are available for this function:

For wind_direction:

OUTDOOR_WEATHER_WIND_DIRECTION_N = 0
OUTDOOR_WEATHER_WIND_DIRECTION_NNE = 1
OUTDOOR_WEATHER_WIND_DIRECTION_NE = 2
OUTDOOR_WEATHER_WIND_DIRECTION_ENE = 3
OUTDOOR_WEATHER_WIND_DIRECTION_E = 4
OUTDOOR_WEATHER_WIND_DIRECTION_ESE = 5
OUTDOOR_WEATHER_WIND_DIRECTION_SE = 6
OUTDOOR_WEATHER_WIND_DIRECTION_SSE = 7
OUTDOOR_WEATHER_WIND_DIRECTION_S = 8
OUTDOOR_WEATHER_WIND_DIRECTION_SSW = 9
OUTDOOR_WEATHER_WIND_DIRECTION_SW = 10
OUTDOOR_WEATHER_WIND_DIRECTION_WSW = 11
OUTDOOR_WEATHER_WIND_DIRECTION_W = 12
OUTDOOR_WEATHER_WIND_DIRECTION_WNW = 13
OUTDOOR_WEATHER_WIND_DIRECTION_NW = 14
OUTDOOR_WEATHER_WIND_DIRECTION_NNW = 15
OUTDOOR_WEATHER_WIND_DIRECTION_ERROR = 255

OUTDOOR_WEATHER_CALLBACK_SENSOR_DATA¶

void callback(uint8_t identifier, int16_t temperature, uint8_t humidity, void *user_data)

Callback Parameters:	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 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 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. They can be called without the corresponding IP Connection object being connected.

int outdoor_weather_get_api_version(OutdoorWeather *outdoor_weather, uint8_t ret_api_version[3])¶

Parameters:	outdoor_weather – Type: OutdoorWeather *
Output Parameters:	ret_api_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]
Returns:	e_code – Type: int

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

int outdoor_weather_get_response_expected(OutdoorWeather *outdoor_weather, uint8_t function_id, bool *ret_response_expected)¶

Parameters:	outdoor_weather – Type: 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 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:

OUTDOOR_WEATHER_FUNCTION_SET_STATION_CALLBACK_CONFIGURATION = 5
OUTDOOR_WEATHER_FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION = 7
OUTDOOR_WEATHER_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
OUTDOOR_WEATHER_FUNCTION_SET_STATUS_LED_CONFIG = 239
OUTDOOR_WEATHER_FUNCTION_RESET = 243
OUTDOOR_WEATHER_FUNCTION_WRITE_UID = 248

int outdoor_weather_set_response_expected(OutdoorWeather *outdoor_weather, uint8_t function_id, bool response_expected)¶

Parameters:	outdoor_weather – Type: 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:

OUTDOOR_WEATHER_FUNCTION_SET_STATION_CALLBACK_CONFIGURATION = 5
OUTDOOR_WEATHER_FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION = 7
OUTDOOR_WEATHER_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
OUTDOOR_WEATHER_FUNCTION_SET_STATUS_LED_CONFIG = 239
OUTDOOR_WEATHER_FUNCTION_RESET = 243
OUTDOOR_WEATHER_FUNCTION_WRITE_UID = 248

int outdoor_weather_set_response_expected_all(OutdoorWeather *outdoor_weather, bool response_expected)¶

Parameters:	outdoor_weather – Type: 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 outdoor_weather_set_bootloader_mode(OutdoorWeather *outdoor_weather, uint8_t mode, uint8_t *ret_status)¶

Parameters:	outdoor_weather – Type: 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:

OUTDOOR_WEATHER_BOOTLOADER_MODE_BOOTLOADER = 0
OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE = 1
OUTDOOR_WEATHER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

OUTDOOR_WEATHER_BOOTLOADER_STATUS_OK = 0
OUTDOOR_WEATHER_BOOTLOADER_STATUS_INVALID_MODE = 1
OUTDOOR_WEATHER_BOOTLOADER_STATUS_NO_CHANGE = 2
OUTDOOR_WEATHER_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
OUTDOOR_WEATHER_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
OUTDOOR_WEATHER_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int outdoor_weather_get_bootloader_mode(OutdoorWeather *outdoor_weather, uint8_t *ret_mode)¶

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

Returns the current bootloader mode, see outdoor_weather_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

OUTDOOR_WEATHER_BOOTLOADER_MODE_BOOTLOADER = 0
OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE = 1
OUTDOOR_WEATHER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int outdoor_weather_set_write_firmware_pointer(OutdoorWeather *outdoor_weather, uint32_t pointer)¶

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

Sets the firmware pointer for 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 outdoor_weather_write_firmware(OutdoorWeather *outdoor_weather, uint8_t data[64], uint8_t *ret_status)¶

Parameters:	outdoor_weather – Type: OutdoorWeather * data – Type: 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 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 outdoor_weather_write_uid(OutdoorWeather *outdoor_weather, uint32_t uid)¶

Parameters:	outdoor_weather – Type: 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 outdoor_weather_read_uid(OutdoorWeather *outdoor_weather, uint32_t *ret_uid)¶

Parameters:	outdoor_weather – Type: 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¶

OUTDOOR_WEATHER_DEVICE_IDENTIFIER¶

This constant is used to identify a Outdoor Weather Bricklet.

The outdoor_weather_get_identity() function and the IPCON_CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

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