Software / API Bindings / C/C++ for Microcontrollers / API Reference and Examples / Bricklets / Air Quality Bricklet

C/C++ for Microcontrollers - Air Quality Bricklet¶

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

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_air_quality.h"

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

static TF_AirQuality aq;

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

    // Get current all values
    int32_t iaq_index, temperature, humidity, air_pressure; uint8_t iaq_index_accuracy;
    check(tf_air_quality_get_all_values(&aq, &iaq_index, &iaq_index_accuracy,
                                        &temperature, &humidity,
                                        &air_pressure), "get all values");

    tf_hal_printf("IAQ Index: %I32d\n", iaq_index);

    if (iaq_index_accuracy == TF_AIR_QUALITY_ACCURACY_UNRELIABLE) {
        tf_hal_printf("IAQ Index Accuracy: Unreliable\n");
    } else if (iaq_index_accuracy == TF_AIR_QUALITY_ACCURACY_LOW) {
        tf_hal_printf("IAQ Index Accuracy: Low\n");
    } else if (iaq_index_accuracy == TF_AIR_QUALITY_ACCURACY_MEDIUM) {
        tf_hal_printf("IAQ Index Accuracy: Medium\n");
    } else if (iaq_index_accuracy == TF_AIR_QUALITY_ACCURACY_HIGH) {
        tf_hal_printf("IAQ Index Accuracy: High\n");
    }

    tf_hal_printf("Temperature: %d 1/%d °C\n", temperature, 100);
    tf_hal_printf("Humidity: %d 1/%d %%RH\n", humidity, 100);
    tf_hal_printf("Air Pressure: %d 1/%d hPa\n", air_pressure, 100);
}

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_air_quality.h"

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

// Callback function for all values callback
static void all_values_handler(TF_AirQuality *device, int32_t iaq_index,
                               uint8_t iaq_index_accuracy, int32_t temperature,
                               int32_t humidity, int32_t air_pressure, void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("IAQ Index: %I32d\n", iaq_index);

    if (iaq_index_accuracy == TF_AIR_QUALITY_ACCURACY_UNRELIABLE) {
        tf_hal_printf("IAQ Index Accuracy: Unreliable\n");
    } else if (iaq_index_accuracy == TF_AIR_QUALITY_ACCURACY_LOW) {
        tf_hal_printf("IAQ Index Accuracy: Low\n");
    } else if (iaq_index_accuracy == TF_AIR_QUALITY_ACCURACY_MEDIUM) {
        tf_hal_printf("IAQ Index Accuracy: Medium\n");
    } else if (iaq_index_accuracy == TF_AIR_QUALITY_ACCURACY_HIGH) {
        tf_hal_printf("IAQ Index Accuracy: High\n");
    }

    tf_hal_printf("Temperature: %d 1/%d °C\n", temperature, 100);
    tf_hal_printf("Humidity: %d 1/%d %%RH\n", humidity, 100);
    tf_hal_printf("Air Pressure: %d 1/%d hPa\n", air_pressure, 100);
    tf_hal_printf("\n");
}

static TF_AirQuality aq;

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

    // Register all values callback to function all_values_handler
    tf_air_quality_register_all_values_callback(&aq,
                                                all_values_handler,
                                                NULL);

    // Set period for all values callback to 1s (1000ms)
    tf_air_quality_set_all_values_callback_configuration(&aq, 1000, false);
}

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_air_quality_create(TF_AirQuality *air_quality, const char *uid_or_port_name, TF_HAL *hal)¶

Parameters:	air_quality – Type: TF_AirQuality * uid – Type: const char * hal – Type: TF_HAL *
Returns:	e_code – Type: int

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

TF_AirQuality air_quality;
tf_air_quality_create(&air_quality, NULL, &hal);

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

int tf_air_quality_destroy(TF_AirQuality *air_quality)¶

Parameters:	air_quality – Type: TF_AirQuality *
Returns:	e_code – Type: int

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

int tf_air_quality_get_all_values(TF_AirQuality *air_quality, int32_t *ret_iaq_index, uint8_t *ret_iaq_index_accuracy, int32_t *ret_temperature, int32_t *ret_humidity, int32_t *ret_air_pressure)¶

Parameters:	air_quality – Type: TF_AirQuality *
Output Parameters:	ret_iaq_index – Type: int32_t, Range: [0 to 500] ret_iaq_index_accuracy – Type: uint8_t, Range: See constants ret_temperature – Type: int32_t, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1] ret_humidity – Type: int32_t, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1] ret_air_pressure – Type: int32_t, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1]
Returns:	e_code – Type: int

Returns all values measured by the Air Quality Bricklet. The values are IAQ (Indoor Air Quality) Index (higher value means greater level of air pollution), IAQ Index Accuracy, Temperature, Humidity and Air Pressure.

The following constants are available for this function:

For ret_iaq_index_accuracy:

TF_AIR_QUALITY_ACCURACY_UNRELIABLE = 0
TF_AIR_QUALITY_ACCURACY_LOW = 1
TF_AIR_QUALITY_ACCURACY_MEDIUM = 2
TF_AIR_QUALITY_ACCURACY_HIGH = 3

int tf_air_quality_set_temperature_offset(TF_AirQuality *air_quality, int32_t offset)¶

Parameters:	air_quality – Type: TF_AirQuality * offset – Type: int32_t, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1]
Returns:	e_code – Type: int

Sets a temperature offset. A offset of 10 will decrease the measured temperature by 0.1 °C.

If you install this Bricklet into an enclosure and you want to measure the ambient temperature, you may have to decrease the measured temperature by some value to compensate for the error because of the heating inside of the enclosure.

We recommend that you leave the parts in the enclosure running for at least 24 hours such that a temperature equilibrium can be reached. After that you can measure the temperature directly outside of enclosure and set the difference as offset.

This temperature offset is used to calculate the relative humidity and IAQ index measurements. In case the Bricklet is installed in an enclosure, we recommend to measure and set the temperature offset to improve the accuracy of the measurements.

int tf_air_quality_get_temperature_offset(TF_AirQuality *air_quality, int32_t *ret_offset)¶

Parameters:	air_quality – Type: TF_AirQuality *
Output Parameters:	ret_offset – Type: int32_t, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1]
Returns:	e_code – Type: int

Returns the temperature offset as set by tf_air_quality_set_temperature_offset().

int tf_air_quality_get_iaq_index(TF_AirQuality *air_quality, int32_t *ret_iaq_index, uint8_t *ret_iaq_index_accuracy)¶

Parameters:	air_quality – Type: TF_AirQuality *
Output Parameters:	ret_iaq_index – Type: int32_t, Range: [0 to 500] ret_iaq_index_accuracy – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

Returns the IAQ index and accuracy. The higher the IAQ index, the greater the level of air pollution.

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

The following constants are available for this function:

For ret_iaq_index_accuracy:

TF_AIR_QUALITY_ACCURACY_UNRELIABLE = 0
TF_AIR_QUALITY_ACCURACY_LOW = 1
TF_AIR_QUALITY_ACCURACY_MEDIUM = 2
TF_AIR_QUALITY_ACCURACY_HIGH = 3

int tf_air_quality_get_temperature(TF_AirQuality *air_quality, int32_t *ret_temperature)¶

Parameters:	air_quality – Type: TF_AirQuality *
Output Parameters:	ret_temperature – Type: int32_t, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1]
Returns:	e_code – Type: int

Returns temperature.

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

int tf_air_quality_get_humidity(TF_AirQuality *air_quality, int32_t *ret_humidity)¶

Parameters:	air_quality – Type: TF_AirQuality *
Output Parameters:	ret_humidity – Type: int32_t, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1]
Returns:	e_code – Type: int

Returns relative humidity.

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

int tf_air_quality_get_air_pressure(TF_AirQuality *air_quality, int32_t *ret_air_pressure)¶

Parameters:	air_quality – Type: TF_AirQuality *
Output Parameters:	ret_air_pressure – Type: int32_t, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1]
Returns:	e_code – Type: int

Returns 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_air_quality_set_air_pressure_callback_configuration().

Advanced Functions¶

int tf_air_quality_remove_calibration(TF_AirQuality *air_quality)¶

Parameters:	air_quality – Type: TF_AirQuality *
Returns:	e_code – Type: int

Deletes the calibration from flash. After you call this function, you need to power cycle the Air Quality Bricklet.

On the next power up the Bricklet will start a new calibration, as if it was started for the very first time.

The calibration is based on the data of the last four days, so it takes four days until a full calibration is re-established.

New in version 2.0.3 (Plugin).

int tf_air_quality_set_background_calibration_duration(TF_AirQuality *air_quality, uint8_t duration)¶

Parameters:	air_quality – Type: TF_AirQuality * duration – Type: uint8_t, Range: See constants, Default: 1
Returns:	e_code – Type: int

The Air Quality Bricklet uses an automatic background calibration mechanism to calculate the IAQ Index. This calibration mechanism considers a history of measured data. The duration of this history can be configured to either be 4 days or 28 days.

If you keep the Bricklet mostly at one place and it does not get moved around to different environments, we recommend that you use a duration of 28 days.

If you change the duration, the current calibration will be discarded and the calibration will start from beginning again. The configuration of the duration is saved in flash, so you should only have to call this function once in the lifetime of the Bricklet.

The Bricklet has to be power cycled after this function is called for a duration change to take effect.

Before firmware version 2.0.3 this was not configurable and the duration was 4 days.

The default value (since firmware version 2.0.3) is 28 days.

The following constants are available for this function:

For duration:

TF_AIR_QUALITY_DURATION_4_DAYS = 0
TF_AIR_QUALITY_DURATION_28_DAYS = 1

New in version 2.0.3 (Plugin).

int tf_air_quality_get_background_calibration_duration(TF_AirQuality *air_quality, uint8_t *ret_duration)¶

Parameters:	air_quality – Type: TF_AirQuality *
Output Parameters:	ret_duration – Type: uint8_t, Range: See constants, Default: 1
Returns:	e_code – Type: int

Returns the background calibration duration as set by tf_air_quality_set_background_calibration_duration().

The following constants are available for this function:

For ret_duration:

TF_AIR_QUALITY_DURATION_4_DAYS = 0
TF_AIR_QUALITY_DURATION_28_DAYS = 1

New in version 2.0.3 (Plugin).

int tf_air_quality_get_spitfp_error_count(TF_AirQuality *air_quality, 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:	air_quality – Type: TF_AirQuality *
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_air_quality_set_status_led_config(TF_AirQuality *air_quality, uint8_t config)¶

Parameters:	air_quality – Type: TF_AirQuality * 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_AIR_QUALITY_STATUS_LED_CONFIG_OFF = 0
TF_AIR_QUALITY_STATUS_LED_CONFIG_ON = 1
TF_AIR_QUALITY_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_AIR_QUALITY_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_air_quality_get_status_led_config(TF_AirQuality *air_quality, uint8_t *ret_config)¶

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

Returns the configuration as set by tf_air_quality_set_status_led_config()

The following constants are available for this function:

For ret_config:

TF_AIR_QUALITY_STATUS_LED_CONFIG_OFF = 0
TF_AIR_QUALITY_STATUS_LED_CONFIG_ON = 1
TF_AIR_QUALITY_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_AIR_QUALITY_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_air_quality_get_chip_temperature(TF_AirQuality *air_quality, int16_t *ret_temperature)¶

Parameters:	air_quality – Type: TF_AirQuality *
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_air_quality_reset(TF_AirQuality *air_quality)¶

Parameters:	air_quality – Type: TF_AirQuality *
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_air_quality_get_identity(TF_AirQuality *air_quality, 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:	air_quality – Type: TF_AirQuality *
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_air_quality_set_all_values_callback_configuration(TF_AirQuality *air_quality, uint32_t period, bool value_has_to_change)¶

Parameters:	air_quality – Type: TF_AirQuality * period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false
Returns:	e_code – Type: int

The period is the period with which the All Values 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 at least one of the values has changed. If the values 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.

int tf_air_quality_get_all_values_callback_configuration(TF_AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameters:	air_quality – Type: TF_AirQuality *
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
Returns:	e_code – Type: int

Returns the callback configuration as set by tf_air_quality_set_all_values_callback_configuration().

int tf_air_quality_set_iaq_index_callback_configuration(TF_AirQuality *air_quality, uint32_t period, bool value_has_to_change)¶

Parameters:	air_quality – Type: TF_AirQuality * period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false
Returns:	e_code – Type: int

The period is the period with which the IAQ Index 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.

int tf_air_quality_get_iaq_index_callback_configuration(TF_AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameters:	air_quality – Type: TF_AirQuality *
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
Returns:	e_code – Type: int

Returns the callback configuration as set by tf_air_quality_set_iaq_index_callback_configuration().

int tf_air_quality_set_temperature_callback_configuration(TF_AirQuality *air_quality, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)¶

Parameters:

Parameters:	air_quality – Type: TF_AirQuality * 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

air_quality – Type: TF_AirQuality *
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 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 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_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
TF_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
TF_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
TF_AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'

int tf_air_quality_get_temperature_callback_configuration(TF_AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶

Parameters:	air_quality – Type: TF_AirQuality *
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_air_quality_set_temperature_callback_configuration().

The following constants are available for this function:

For ret_option:

TF_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
TF_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
TF_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
TF_AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'

int tf_air_quality_set_humidity_callback_configuration(TF_AirQuality *air_quality, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)¶

Parameters:

Parameters:	air_quality – Type: TF_AirQuality * 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 %, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32_t, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1], Default: 0
Returns:	e_code – Type: int

air_quality – Type: TF_AirQuality *
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 %, Range: [-2³¹ to 2³¹ - 1], Default: 0
max – Type: int32_t, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns:

e_code – Type: int

The period is the period with which the Humidity 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 Humidity 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_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
TF_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
TF_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
TF_AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'

int tf_air_quality_get_humidity_callback_configuration(TF_AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶

Parameters:	air_quality – Type: TF_AirQuality *
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 %, Range: [-2³¹ to 2³¹ - 1], Default: 0 ret_max – Type: int32_t, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1], Default: 0
Returns:	e_code – Type: int

Returns the callback configuration as set by tf_air_quality_set_humidity_callback_configuration().

The following constants are available for this function:

For ret_option:

TF_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
TF_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
TF_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
TF_AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'

int tf_air_quality_set_air_pressure_callback_configuration(TF_AirQuality *air_quality, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)¶

Parameters:

Parameters:	air_quality – Type: TF_AirQuality * 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 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32_t, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0
Returns:	e_code – Type: int

air_quality – Type: TF_AirQuality *
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 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0
max – Type: int32_t, Unit: 1/100 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 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_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
TF_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
TF_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
TF_AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'

int tf_air_quality_get_air_pressure_callback_configuration(TF_AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶

Parameters:	air_quality – Type: TF_AirQuality *
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 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0 ret_max – Type: int32_t, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0
Returns:	e_code – Type: int

Returns the callback configuration as set by tf_air_quality_set_air_pressure_callback_configuration().

The following constants are available for this function:

For ret_option:

TF_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
TF_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
TF_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
TF_AIR_QUALITY_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_air_quality_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_air_quality_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_air_quality_register_all_values_callback(TF_AirQuality *air_quality, TF_AirQuality_AllValuesHandler handler, void *user_data)¶

void handler(TF_AirQuality *air_quality, int32_t iaq_index, uint8_t iaq_index_accuracy, int32_t temperature, int32_t humidity, int32_t air_pressure, void *user_data)

Callback Parameters:

Callback Parameters:	air_quality – Type: TF_AirQuality * iaq_index – Type: int32_t, Range: [0 to 500] iaq_index_accuracy – Type: uint8_t, Range: See constants temperature – Type: int32_t, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1] humidity – Type: int32_t, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1] air_pressure – Type: int32_t, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1] user_data – Type: void *

air_quality – Type: TF_AirQuality *
iaq_index – Type: int32_t, Range: [0 to 500]
iaq_index_accuracy – Type: uint8_t, Range: See constants
temperature – Type: int32_t, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1]
humidity – Type: int32_t, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1]
air_pressure – Type: int32_t, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1]
user_data – Type: void *

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

The parameters are the same as tf_air_quality_get_all_values().

The following constants are available for this function:

For iaq_index_accuracy:

TF_AIR_QUALITY_ACCURACY_UNRELIABLE = 0
TF_AIR_QUALITY_ACCURACY_LOW = 1
TF_AIR_QUALITY_ACCURACY_MEDIUM = 2
TF_AIR_QUALITY_ACCURACY_HIGH = 3

int tf_air_quality_register_iaq_index_callback(TF_AirQuality *air_quality, TF_AirQuality_IAQIndexHandler handler, void *user_data)¶

void handler(TF_AirQuality *air_quality, int32_t iaq_index, uint8_t iaq_index_accuracy, void *user_data)

Callback Parameters:	air_quality – Type: TF_AirQuality * iaq_index – Type: int32_t, Range: [0 to 500] iaq_index_accuracy – Type: uint8_t, Range: See constants user_data – Type: void *

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

The parameters are the same as tf_air_quality_get_iaq_index().

The following constants are available for this function:

For iaq_index_accuracy:

TF_AIR_QUALITY_ACCURACY_UNRELIABLE = 0
TF_AIR_QUALITY_ACCURACY_LOW = 1
TF_AIR_QUALITY_ACCURACY_MEDIUM = 2
TF_AIR_QUALITY_ACCURACY_HIGH = 3

int tf_air_quality_register_temperature_callback(TF_AirQuality *air_quality, TF_AirQuality_TemperatureHandler handler, void *user_data)¶

void handler(TF_AirQuality *air_quality, int32_t temperature, void *user_data)

Callback Parameters:	air_quality – Type: TF_AirQuality * temperature – Type: int32_t, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1] user_data – Type: void *

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

The parameter is the same as tf_air_quality_get_temperature().

int tf_air_quality_register_humidity_callback(TF_AirQuality *air_quality, TF_AirQuality_HumidityHandler handler, void *user_data)¶

void handler(TF_AirQuality *air_quality, int32_t humidity, void *user_data)

Callback Parameters:	air_quality – Type: TF_AirQuality * humidity – Type: int32_t, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1] user_data – Type: void *

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

The parameter is the same as tf_air_quality_get_humidity().

int tf_air_quality_register_air_pressure_callback(TF_AirQuality *air_quality, TF_AirQuality_AirPressureHandler handler, void *user_data)¶

void handler(TF_AirQuality *air_quality, int32_t air_pressure, void *user_data)

Callback Parameters:	air_quality – Type: TF_AirQuality * air_pressure – Type: int32_t, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1] user_data – Type: void *

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

The parameter is the same as tf_air_quality_get_air_pressure().

Virtual Functions¶

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

int tf_air_quality_get_response_expected(TF_AirQuality *air_quality, uint8_t function_id, bool *ret_response_expected)¶

Parameters:	air_quality – Type: TF_AirQuality * 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_air_quality_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_AIR_QUALITY_FUNCTION_SET_TEMPERATURE_OFFSET = 2
TF_AIR_QUALITY_FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 4
TF_AIR_QUALITY_FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION = 8
TF_AIR_QUALITY_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 12
TF_AIR_QUALITY_FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 16
TF_AIR_QUALITY_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20
TF_AIR_QUALITY_FUNCTION_REMOVE_CALIBRATION = 23
TF_AIR_QUALITY_FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
TF_AIR_QUALITY_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_AIR_QUALITY_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_AIR_QUALITY_FUNCTION_RESET = 243
TF_AIR_QUALITY_FUNCTION_WRITE_UID = 248

int tf_air_quality_set_response_expected(TF_AirQuality *air_quality, uint8_t function_id, bool response_expected)¶

Parameters:	air_quality – Type: TF_AirQuality * 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_AIR_QUALITY_FUNCTION_SET_TEMPERATURE_OFFSET = 2
TF_AIR_QUALITY_FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 4
TF_AIR_QUALITY_FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION = 8
TF_AIR_QUALITY_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 12
TF_AIR_QUALITY_FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 16
TF_AIR_QUALITY_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20
TF_AIR_QUALITY_FUNCTION_REMOVE_CALIBRATION = 23
TF_AIR_QUALITY_FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
TF_AIR_QUALITY_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_AIR_QUALITY_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_AIR_QUALITY_FUNCTION_RESET = 243
TF_AIR_QUALITY_FUNCTION_WRITE_UID = 248

int tf_air_quality_set_response_expected_all(TF_AirQuality *air_quality, bool response_expected)¶

Parameters:	air_quality – Type: TF_AirQuality * 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_air_quality_set_bootloader_mode(TF_AirQuality *air_quality, uint8_t mode, uint8_t *ret_status)¶

Parameters:	air_quality – Type: TF_AirQuality * 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_AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER = 0
TF_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE = 1
TF_AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

TF_AIR_QUALITY_BOOTLOADER_STATUS_OK = 0
TF_AIR_QUALITY_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_AIR_QUALITY_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_AIR_QUALITY_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_AIR_QUALITY_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_AIR_QUALITY_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_air_quality_get_bootloader_mode(TF_AirQuality *air_quality, uint8_t *ret_mode)¶

Parameters:	air_quality – Type: TF_AirQuality *
Output Parameters:	ret_mode – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

Returns the current bootloader mode, see tf_air_quality_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

TF_AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER = 0
TF_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE = 1
TF_AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_air_quality_set_write_firmware_pointer(TF_AirQuality *air_quality, uint32_t pointer)¶

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

Sets the firmware pointer for tf_air_quality_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_air_quality_write_firmware(TF_AirQuality *air_quality, const uint8_t data[64], uint8_t *ret_status)¶

Parameters:	air_quality – Type: TF_AirQuality * 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_air_quality_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_air_quality_write_uid(TF_AirQuality *air_quality, uint32_t uid)¶

Parameters:	air_quality – Type: TF_AirQuality * 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_air_quality_read_uid(TF_AirQuality *air_quality, uint32_t *ret_uid)¶

Parameters:	air_quality – Type: TF_AirQuality *
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_AIR_QUALITY_DEVICE_IDENTIFIER¶

This constant is used to identify a Air Quality Bricklet.

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

TF_AIR_QUALITY_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Air Quality Bricklet.