Software / API Bindings / C/C++ for Microcontrollers / API Reference and Examples / Bricklets / Barometer Bricklet 2.0

C/C++ for Microcontrollers - Barometer Bricklet 2.0¶

This is the description of the C/C++ for Microcontrollers API bindings for the Barometer Bricklet 2.0. General information and technical specifications for the Barometer Bricklet 2.0 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).

Simple¶

Download (example_simple.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_barometer_v2.h"

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

static TF_BarometerV2 b;

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

    // Get current air pressure
    int32_t air_pressure;
    check(tf_barometer_v2_get_air_pressure(&b, &air_pressure), "get air pressure");

    tf_hal_printf("Air Pressure: %d 1/%d hPa\n", air_pressure, 1000);

    // Get current altitude
    int32_t altitude;
    check(tf_barometer_v2_get_altitude(&b, &altitude), "get altitude");

    tf_hal_printf("Altitude: %d 1/%d m\n", altitude, 1000);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 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_barometer_v2.h"

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

// Callback function for air pressure callback
static void air_pressure_handler(TF_BarometerV2 *device, int32_t air_pressure,
                                 void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Air Pressure: %d 1/%d hPa\n", air_pressure, 1000);
}

static TF_BarometerV2 b;

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

    // Register air pressure callback to function air_pressure_handler
    tf_barometer_v2_register_air_pressure_callback(&b,
                                                   air_pressure_handler,
                                                   NULL);

    // Set period for air pressure callback to 1s (1000ms) without a threshold
    tf_barometer_v2_set_air_pressure_callback_configuration(&b, 1000, false, 'x', 0, 0);
}

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

Threshold¶

Download (example_threshold.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_barometer_v2.h"

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

// Callback function for air pressure callback
static void air_pressure_handler(TF_BarometerV2 *device, int32_t air_pressure,
                                 void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Air Pressure: %d 1/%d hPa\n", air_pressure, 1000);
    tf_hal_printf("Enjoy the potentially good weather!\n");
}

static TF_BarometerV2 b;

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

    // Register air pressure callback to function air_pressure_handler
    tf_barometer_v2_register_air_pressure_callback(&b,
                                                   air_pressure_handler,
                                                   NULL);

    // Configure threshold for air pressure "greater than 1025 hPa"
    // with a debounce period of 1s (1000ms)
    tf_barometer_v2_set_air_pressure_callback_configuration(&b, 1000, false, '>', 1025*1000, 0);
}

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_barometer_v2_create(TF_BarometerV2 *barometer_v2, const char *uid_or_port_name, TF_HAL *hal)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 * uid – Type: const char * hal – Type: TF_HAL *
Returns:	e_code – Type: int

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

TF_BarometerV2 barometer_v2;
tf_barometer_v2_create(&barometer_v2, NULL, &hal);

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

int tf_barometer_v2_destroy(TF_BarometerV2 *barometer_v2)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 *
Returns:	e_code – Type: int

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

int tf_barometer_v2_get_air_pressure(TF_BarometerV2 *barometer_v2, int32_t *ret_air_pressure)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 *
Output Parameters:	ret_air_pressure – Type: int32_t, Unit: 1/1000 hPa, Range: [260000 to 1260000]
Returns:	e_code – Type: int

Returns the measured air pressure.

If you want to get the value periodically, it is recommended to use the Air Pressure callback. You can set the callback configuration with tf_barometer_v2_set_air_pressure_callback_configuration().

int tf_barometer_v2_get_altitude(TF_BarometerV2 *barometer_v2, int32_t *ret_altitude)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 *
Output Parameters:	ret_altitude – Type: int32_t, Unit: 1 mm, Range: [-2³¹ to 2³¹ - 1]
Returns:	e_code – Type: int

Returns the relative altitude of the air pressure sensor. The value is calculated based on the difference between the current air pressure and the reference air pressure that can be set with tf_barometer_v2_set_reference_air_pressure().

If you want to get the value periodically, it is recommended to use the Altitude callback. You can set the callback configuration with tf_barometer_v2_set_altitude_callback_configuration().

int tf_barometer_v2_get_temperature(TF_BarometerV2 *barometer_v2, int32_t *ret_temperature)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 *
Output Parameters:	ret_temperature – Type: int32_t, Unit: 1/100 °C, Range: [-4000 to 8500]
Returns:	e_code – Type: int

Returns the temperature of the air pressure sensor.

This temperature is used internally for temperature compensation of the air pressure measurement. It is not as accurate as the temperature measured by the Temperature Bricklet 2.0 or the Temperature IR Bricklet 2.0.

If you want to get the value periodically, it is recommended to use the Temperature callback. You can set the callback configuration with tf_barometer_v2_set_temperature_callback_configuration().

int tf_barometer_v2_set_moving_average_configuration(TF_BarometerV2 *barometer_v2, uint16_t moving_average_length_air_pressure, uint16_t moving_average_length_temperature)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 * moving_average_length_air_pressure – Type: uint16_t, Range: [1 to 1000], Default: 100 moving_average_length_temperature – Type: uint16_t, Range: [1 to 1000], Default: 100
Returns:	e_code – Type: int

Sets the length of a moving averaging for the air pressure and temperature measurements.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

If you want to do long term measurements the longest moving average will give the cleanest results.

int tf_barometer_v2_get_moving_average_configuration(TF_BarometerV2 *barometer_v2, uint16_t *ret_moving_average_length_air_pressure, uint16_t *ret_moving_average_length_temperature)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 *
Output Parameters:	ret_moving_average_length_air_pressure – Type: uint16_t, Range: [1 to 1000], Default: 100 ret_moving_average_length_temperature – Type: uint16_t, Range: [1 to 1000], Default: 100
Returns:	e_code – Type: int

Returns the moving average configuration as set by tf_barometer_v2_set_moving_average_configuration().

int tf_barometer_v2_set_reference_air_pressure(TF_BarometerV2 *barometer_v2, int32_t air_pressure)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 * air_pressure – Type: int32_t, Unit: 1/1000 hPa, Range: [0, 260000 to 1260000], Default: 1013250
Returns:	e_code – Type: int

Sets the reference air pressure for the altitude calculation. Setting the reference to the current air pressure results in a calculated altitude of 0mm. Passing 0 is a shortcut for passing the current air pressure as reference.

Well known reference values are the Q codes QNH and QFE used in aviation.

int tf_barometer_v2_get_reference_air_pressure(TF_BarometerV2 *barometer_v2, int32_t *ret_air_pressure)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 *
Output Parameters:	ret_air_pressure – Type: int32_t, Unit: 1/1000 hPa, Range: [260000 to 1260000], Default: 1013250
Returns:	e_code – Type: int

Returns the reference air pressure as set by tf_barometer_v2_set_reference_air_pressure().

Advanced Functions¶

int tf_barometer_v2_set_calibration(TF_BarometerV2 *barometer_v2, int32_t measured_air_pressure, int32_t actual_air_pressure)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 * measured_air_pressure – Type: int32_t, Unit: 1/1000 hPa, Range: [0, 260000 to 1260000] actual_air_pressure – Type: int32_t, Unit: 1/1000 hPa, Range: [0, 260000 to 1260000]
Returns:	e_code – Type: int

Sets the one point calibration (OPC) values for the air pressure measurement.

Before the Bricklet can be calibrated any previous calibration has to be removed by setting measured air pressure and actual air pressure to 0.

Then the current air pressure has to be measured using the Bricklet (measured air pressure) and with an accurate reference barometer (actual air pressure) at the same time and passed to this function.

After proper calibration the air pressure measurement can achieve an accuracy up to 0.2 hPa.

The calibration is saved in the EEPROM of the Bricklet and only needs to be configured once.

int tf_barometer_v2_get_calibration(TF_BarometerV2 *barometer_v2, int32_t *ret_measured_air_pressure, int32_t *ret_actual_air_pressure)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 *
Output Parameters:	ret_measured_air_pressure – Type: int32_t, Unit: 1/1000 hPa, Range: [0, 260000 to 1260000] ret_actual_air_pressure – Type: int32_t, Unit: 1/1000 hPa, Range: [0, 260000 to 1260000]
Returns:	e_code – Type: int

Returns the air pressure one point calibration values as set by tf_barometer_v2_set_calibration().

int tf_barometer_v2_set_sensor_configuration(TF_BarometerV2 *barometer_v2, uint8_t data_rate, uint8_t air_pressure_low_pass_filter)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 * data_rate – Type: uint8_t, Range: See constants, Default: 4 air_pressure_low_pass_filter – Type: uint8_t, Range: See constants, Default: 1
Returns:	e_code – Type: int

Configures the data rate and air pressure low pass filter. The low pass filter cut-off frequency (if enabled) can be set to 1/9th or 1/20th of the configure data rate to decrease the noise on the air pressure data.

The low pass filter configuration only applies to the air pressure measurement. There is no low pass filter for the temperature measurement.

A higher data rate will result in a less precise temperature because of self-heating of the sensor. If the accuracy of the temperature reading is important to you, we would recommend the 1Hz data rate.

The following constants are available for this function:

For data_rate:

TF_BAROMETER_V2_DATA_RATE_OFF = 0
TF_BAROMETER_V2_DATA_RATE_1HZ = 1
TF_BAROMETER_V2_DATA_RATE_10HZ = 2
TF_BAROMETER_V2_DATA_RATE_25HZ = 3
TF_BAROMETER_V2_DATA_RATE_50HZ = 4
TF_BAROMETER_V2_DATA_RATE_75HZ = 5

For air_pressure_low_pass_filter:

TF_BAROMETER_V2_LOW_PASS_FILTER_OFF = 0
TF_BAROMETER_V2_LOW_PASS_FILTER_1_9TH = 1
TF_BAROMETER_V2_LOW_PASS_FILTER_1_20TH = 2

int tf_barometer_v2_get_sensor_configuration(TF_BarometerV2 *barometer_v2, uint8_t *ret_data_rate, uint8_t *ret_air_pressure_low_pass_filter)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 *
Output Parameters:	ret_data_rate – Type: uint8_t, Range: See constants, Default: 4 ret_air_pressure_low_pass_filter – Type: uint8_t, Range: See constants, Default: 1
Returns:	e_code – Type: int

Returns the sensor configuration as set by tf_barometer_v2_set_sensor_configuration().

The following constants are available for this function:

For ret_data_rate:

TF_BAROMETER_V2_DATA_RATE_OFF = 0
TF_BAROMETER_V2_DATA_RATE_1HZ = 1
TF_BAROMETER_V2_DATA_RATE_10HZ = 2
TF_BAROMETER_V2_DATA_RATE_25HZ = 3
TF_BAROMETER_V2_DATA_RATE_50HZ = 4
TF_BAROMETER_V2_DATA_RATE_75HZ = 5

For ret_air_pressure_low_pass_filter:

TF_BAROMETER_V2_LOW_PASS_FILTER_OFF = 0
TF_BAROMETER_V2_LOW_PASS_FILTER_1_9TH = 1
TF_BAROMETER_V2_LOW_PASS_FILTER_1_20TH = 2

int tf_barometer_v2_get_spitfp_error_count(TF_BarometerV2 *barometer_v2, 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:	barometer_v2 – Type: TF_BarometerV2 *
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_barometer_v2_set_status_led_config(TF_BarometerV2 *barometer_v2, uint8_t config)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 * 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_BAROMETER_V2_STATUS_LED_CONFIG_OFF = 0
TF_BAROMETER_V2_STATUS_LED_CONFIG_ON = 1
TF_BAROMETER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_BAROMETER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_barometer_v2_get_status_led_config(TF_BarometerV2 *barometer_v2, uint8_t *ret_config)¶

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

Returns the configuration as set by tf_barometer_v2_set_status_led_config()

The following constants are available for this function:

For ret_config:

TF_BAROMETER_V2_STATUS_LED_CONFIG_OFF = 0
TF_BAROMETER_V2_STATUS_LED_CONFIG_ON = 1
TF_BAROMETER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_BAROMETER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_barometer_v2_get_chip_temperature(TF_BarometerV2 *barometer_v2, int16_t *ret_temperature)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 *
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_barometer_v2_reset(TF_BarometerV2 *barometer_v2)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 *
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_barometer_v2_get_identity(TF_BarometerV2 *barometer_v2, 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:	barometer_v2 – Type: TF_BarometerV2 *
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_barometer_v2_set_air_pressure_callback_configuration(TF_BarometerV2 *barometer_v2, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)¶

Parameters:

Parameters:	barometer_v2 – Type: TF_BarometerV2 * period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int32_t, Unit: 1/1000 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32_t, Unit: 1/1000 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0
Returns:	e_code – Type: int

barometer_v2 – Type: TF_BarometerV2 *
period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
value_has_to_change – Type: bool, Default: false
option – Type: char, Range: See constants, Default: 'x'
min – Type: int32_t, Unit: 1/1000 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0
max – Type: int32_t, Unit: 1/1000 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns:

e_code – Type: int

The period is the period with which the Air Pressure callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the Air Pressure callback.

The following options are possible:

Option	Description
'x'	Threshold is turned off
'o'	Threshold is triggered when the value is outside the min and max values
'i'	Threshold is triggered when the value is inside or equal to the min and max values
'<'	Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

TF_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
TF_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
TF_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
TF_BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'

int tf_barometer_v2_get_air_pressure_callback_configuration(TF_BarometerV2 *barometer_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 *
Output Parameters:	ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 ret_value_has_to_change – Type: bool, Default: false ret_option – Type: char, Range: See constants, Default: 'x' ret_min – Type: int32_t, Unit: 1/1000 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0 ret_max – Type: int32_t, Unit: 1/1000 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0
Returns:	e_code – Type: int

Returns the callback configuration as set by tf_barometer_v2_set_air_pressure_callback_configuration().

The following constants are available for this function:

For ret_option:

TF_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
TF_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
TF_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
TF_BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'

int tf_barometer_v2_set_altitude_callback_configuration(TF_BarometerV2 *barometer_v2, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)¶

Parameters:

Parameters:	barometer_v2 – Type: TF_BarometerV2 * period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int32_t, Unit: 1 mm, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32_t, Unit: 1 mm, Range: [-2³¹ to 2³¹ - 1], Default: 0
Returns:	e_code – Type: int

barometer_v2 – Type: TF_BarometerV2 *
period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
value_has_to_change – Type: bool, Default: false
option – Type: char, Range: See constants, Default: 'x'
min – Type: int32_t, Unit: 1 mm, Range: [-2³¹ to 2³¹ - 1], Default: 0
max – Type: int32_t, Unit: 1 mm, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns:

e_code – Type: int

The period is the period with which the Altitude callback is triggered periodically. A value of 0 turns the callback off.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the Altitude callback.

The following options are possible:

Option	Description
'x'	Threshold is turned off
'o'	Threshold is triggered when the value is outside the min and max values
'i'	Threshold is triggered when the value is inside or equal to the min and max values
'<'	Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

TF_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
TF_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
TF_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
TF_BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'

int tf_barometer_v2_get_altitude_callback_configuration(TF_BarometerV2 *barometer_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 *
Output Parameters:	ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 ret_value_has_to_change – Type: bool, Default: false ret_option – Type: char, Range: See constants, Default: 'x' ret_min – Type: int32_t, Unit: 1 mm, Range: [-2³¹ to 2³¹ - 1], Default: 0 ret_max – Type: int32_t, Unit: 1 mm, Range: [-2³¹ to 2³¹ - 1], Default: 0
Returns:	e_code – Type: int

Returns the callback configuration as set by tf_barometer_v2_set_altitude_callback_configuration().

The following constants are available for this function:

For ret_option:

TF_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
TF_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
TF_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
TF_BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'

int tf_barometer_v2_set_temperature_callback_configuration(TF_BarometerV2 *barometer_v2, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)¶

Parameters:

Parameters:	barometer_v2 – Type: TF_BarometerV2 * period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int32_t, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32_t, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0
Returns:	e_code – Type: int

barometer_v2 – Type: TF_BarometerV2 *
period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
value_has_to_change – Type: bool, Default: false
option – Type: char, Range: See constants, Default: 'x'
min – Type: int32_t, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0
max – Type: int32_t, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns:

e_code – Type: int

The period is the period with which the Temperature callback is triggered periodically. A value of 0 turns the callback off.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the Temperature callback.

The following options are possible:

Option	Description
'x'	Threshold is turned off
'o'	Threshold is triggered when the value is outside the min and max values
'i'	Threshold is triggered when the value is inside or equal to the min and max values
'<'	Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

TF_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
TF_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
TF_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
TF_BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'

int tf_barometer_v2_get_temperature_callback_configuration(TF_BarometerV2 *barometer_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 *
Output Parameters:	ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 ret_value_has_to_change – Type: bool, Default: false ret_option – Type: char, Range: See constants, Default: 'x' ret_min – Type: int32_t, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0 ret_max – Type: int32_t, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0
Returns:	e_code – Type: int

Returns the callback configuration as set by tf_barometer_v2_set_temperature_callback_configuration().

The following constants are available for this function:

For ret_option:

TF_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
TF_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
TF_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
TF_BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding tf_barometer_v2_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_barometer_v2_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_barometer_v2_register_air_pressure_callback(TF_BarometerV2 *barometer_v2, TF_BarometerV2_AirPressureHandler handler, void *user_data)¶

void handler(TF_BarometerV2 *barometer_v2, int32_t air_pressure, void *user_data)

Callback Parameters:	barometer_v2 – Type: TF_BarometerV2 * air_pressure – Type: int32_t, Unit: 1/1000 hPa, Range: [260000 to 1260000] user_data – Type: void *

This callback is triggered periodically according to the configuration set by tf_barometer_v2_set_air_pressure_callback_configuration().

The parameter is the same as tf_barometer_v2_get_air_pressure().

int tf_barometer_v2_register_altitude_callback(TF_BarometerV2 *barometer_v2, TF_BarometerV2_AltitudeHandler handler, void *user_data)¶

void handler(TF_BarometerV2 *barometer_v2, int32_t altitude, void *user_data)

Callback Parameters:	barometer_v2 – Type: TF_BarometerV2 * altitude – Type: int32_t, Unit: 1 mm, Range: [-2³¹ to 2³¹ - 1] user_data – Type: void *

This callback is triggered periodically according to the configuration set by tf_barometer_v2_set_altitude_callback_configuration().

The parameter is the same as tf_barometer_v2_get_altitude().

int tf_barometer_v2_register_temperature_callback(TF_BarometerV2 *barometer_v2, TF_BarometerV2_TemperatureHandler handler, void *user_data)¶

void handler(TF_BarometerV2 *barometer_v2, int32_t temperature, void *user_data)

Callback Parameters:	barometer_v2 – Type: TF_BarometerV2 * temperature – Type: int32_t, Unit: 1/100 °C, Range: [-4000 to 8500] user_data – Type: void *

This callback is triggered periodically according to the configuration set by tf_barometer_v2_set_temperature_callback_configuration().

The parameter is the same as tf_barometer_v2_get_temperature().

Virtual Functions¶

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

int tf_barometer_v2_get_response_expected(TF_BarometerV2 *barometer_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 * 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_barometer_v2_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_BAROMETER_V2_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 2
TF_BAROMETER_V2_FUNCTION_SET_ALTITUDE_CALLBACK_CONFIGURATION = 6
TF_BAROMETER_V2_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 10
TF_BAROMETER_V2_FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 13
TF_BAROMETER_V2_FUNCTION_SET_REFERENCE_AIR_PRESSURE = 15
TF_BAROMETER_V2_FUNCTION_SET_CALIBRATION = 17
TF_BAROMETER_V2_FUNCTION_SET_SENSOR_CONFIGURATION = 19
TF_BAROMETER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_BAROMETER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_BAROMETER_V2_FUNCTION_RESET = 243
TF_BAROMETER_V2_FUNCTION_WRITE_UID = 248

int tf_barometer_v2_set_response_expected(TF_BarometerV2 *barometer_v2, uint8_t function_id, bool response_expected)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 * 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_BAROMETER_V2_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 2
TF_BAROMETER_V2_FUNCTION_SET_ALTITUDE_CALLBACK_CONFIGURATION = 6
TF_BAROMETER_V2_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 10
TF_BAROMETER_V2_FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 13
TF_BAROMETER_V2_FUNCTION_SET_REFERENCE_AIR_PRESSURE = 15
TF_BAROMETER_V2_FUNCTION_SET_CALIBRATION = 17
TF_BAROMETER_V2_FUNCTION_SET_SENSOR_CONFIGURATION = 19
TF_BAROMETER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_BAROMETER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_BAROMETER_V2_FUNCTION_RESET = 243
TF_BAROMETER_V2_FUNCTION_WRITE_UID = 248

int tf_barometer_v2_set_response_expected_all(TF_BarometerV2 *barometer_v2, bool response_expected)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 * 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_barometer_v2_set_bootloader_mode(TF_BarometerV2 *barometer_v2, uint8_t mode, uint8_t *ret_status)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 * 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_BAROMETER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_BAROMETER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

TF_BAROMETER_V2_BOOTLOADER_STATUS_OK = 0
TF_BAROMETER_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_BAROMETER_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_BAROMETER_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_BAROMETER_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_BAROMETER_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_barometer_v2_get_bootloader_mode(TF_BarometerV2 *barometer_v2, uint8_t *ret_mode)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 *
Output Parameters:	ret_mode – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

Returns the current bootloader mode, see tf_barometer_v2_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

TF_BAROMETER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_BAROMETER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_barometer_v2_set_write_firmware_pointer(TF_BarometerV2 *barometer_v2, uint32_t pointer)¶

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

Sets the firmware pointer for tf_barometer_v2_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_barometer_v2_write_firmware(TF_BarometerV2 *barometer_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 * 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_barometer_v2_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_barometer_v2_write_uid(TF_BarometerV2 *barometer_v2, uint32_t uid)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 * 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_barometer_v2_read_uid(TF_BarometerV2 *barometer_v2, uint32_t *ret_uid)¶

Parameters:	barometer_v2 – Type: TF_BarometerV2 *
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_BAROMETER_V2_DEVICE_IDENTIFIER¶

This constant is used to identify a Barometer Bricklet 2.0.

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

TF_BAROMETER_V2_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Barometer Bricklet 2.0.