Deutsch
English
Menu
Software / API Bindings / C/C++ / API Reference and Examples / Bricklets / Air Quality Bricklet

C/C++ - Air Quality Bricklet

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

Examples

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

Simple

Download (example_simple.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_air_quality.h"

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

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

    // Create device object
    AirQuality aq;
    air_quality_create(&aq, 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

    // Get current all values
    int32_t iaq_index, temperature, humidity, air_pressure; uint8_t iaq_index_accuracy;
    if(air_quality_get_all_values(&aq, &iaq_index, &iaq_index_accuracy, &temperature,
                                  &humidity, &air_pressure) < 0) {
        fprintf(stderr, "Could not get all values, probably timeout\n");
        return 1;
    }

    printf("IAQ Index: %d\n", iaq_index);

    if(iaq_index_accuracy == AIR_QUALITY_ACCURACY_UNRELIABLE) {
        printf("IAQ Index Accuracy: Unreliable\n");
    } else if(iaq_index_accuracy == AIR_QUALITY_ACCURACY_LOW) {
        printf("IAQ Index Accuracy: Low\n");
    } else if(iaq_index_accuracy == AIR_QUALITY_ACCURACY_MEDIUM) {
        printf("IAQ Index Accuracy: Medium\n");
    } else if(iaq_index_accuracy == AIR_QUALITY_ACCURACY_HIGH) {
        printf("IAQ Index Accuracy: High\n");
    }

    printf("Temperature: %f °C\n", temperature/100.0);
    printf("Humidity: %f %%RH\n", humidity/100.0);
    printf("Air Pressure: %f hPa\n", air_pressure/100.0);

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

Callback

Download (example_callback.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_air_quality.h"

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

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

    printf("IAQ Index: %d\n", iaq_index);

    if(iaq_index_accuracy == AIR_QUALITY_ACCURACY_UNRELIABLE) {
        printf("IAQ Index Accuracy: Unreliable\n");
    } else if(iaq_index_accuracy == AIR_QUALITY_ACCURACY_LOW) {
        printf("IAQ Index Accuracy: Low\n");
    } else if(iaq_index_accuracy == AIR_QUALITY_ACCURACY_MEDIUM) {
        printf("IAQ Index Accuracy: Medium\n");
    } else if(iaq_index_accuracy == AIR_QUALITY_ACCURACY_HIGH) {
        printf("IAQ Index Accuracy: High\n");
    }

    printf("Temperature: %f °C\n", temperature/100.0);
    printf("Humidity: %f %%RH\n", humidity/100.0);
    printf("Air Pressure: %f hPa\n", air_pressure/100.0);
    printf("\n");
}

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

    // Create device object
    AirQuality aq;
    air_quality_create(&aq, 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

    // Register all values callback to function cb_all_values
    air_quality_register_callback(&aq,
                                  AIR_QUALITY_CALLBACK_ALL_VALUES,
                                  (void (*)(void))cb_all_values,
                                  NULL);

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

    printf("Press key to exit\n");
    getchar();
    air_quality_destroy(&aq);
    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 air_quality_create(AirQuality *air_quality, const char *uid, IPConnection *ipcon)
Parameters:
  • air_quality – Type: AirQuality *
  • uid – Type: const char *
  • ipcon – Type: IPConnection *

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

AirQuality air_quality;
air_quality_create(&air_quality, "YOUR_DEVICE_UID", &ipcon);

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

void air_quality_destroy(AirQuality *air_quality)
Parameters:
  • air_quality – Type: AirQuality *

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

int air_quality_get_all_values(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: 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: [-231 to 231 - 1]
  • ret_humidity – Type: int32_t, Unit: 1/100 %, Range: [-231 to 231 - 1]
  • ret_air_pressure – Type: int32_t, Unit: 1/100 hPa, Range: [-231 to 231 - 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.

Air Quality Index description

The following constants are available for this function:

For ret_iaq_index_accuracy:

  • AIR_QUALITY_ACCURACY_UNRELIABLE = 0
  • AIR_QUALITY_ACCURACY_LOW = 1
  • AIR_QUALITY_ACCURACY_MEDIUM = 2
  • AIR_QUALITY_ACCURACY_HIGH = 3
int air_quality_set_temperature_offset(AirQuality *air_quality, int32_t offset)
Parameters:
  • air_quality – Type: AirQuality *
  • offset – Type: int32_t, Unit: 1/100 °C, Range: [-231 to 231 - 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 air_quality_get_temperature_offset(AirQuality *air_quality, int32_t *ret_offset)
Parameters:
  • air_quality – Type: AirQuality *
Output Parameters:
  • ret_offset – Type: int32_t, Unit: 1/100 °C, Range: [-231 to 231 - 1]
Returns:
  • e_code – Type: int

Returns the temperature offset as set by air_quality_set_temperature_offset().

int air_quality_get_iaq_index(AirQuality *air_quality, int32_t *ret_iaq_index, uint8_t *ret_iaq_index_accuracy)
Parameters:
  • air_quality – Type: 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.

IAQ index description

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

The following constants are available for this function:

For ret_iaq_index_accuracy:

  • AIR_QUALITY_ACCURACY_UNRELIABLE = 0
  • AIR_QUALITY_ACCURACY_LOW = 1
  • AIR_QUALITY_ACCURACY_MEDIUM = 2
  • AIR_QUALITY_ACCURACY_HIGH = 3
int air_quality_get_temperature(AirQuality *air_quality, int32_t *ret_temperature)
Parameters:
  • air_quality – Type: AirQuality *
Output Parameters:
  • ret_temperature – Type: int32_t, Unit: 1/100 °C, Range: [-231 to 231 - 1]
Returns:
  • e_code – Type: int

Returns temperature.

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

int air_quality_get_humidity(AirQuality *air_quality, int32_t *ret_humidity)
Parameters:
  • air_quality – Type: AirQuality *
Output Parameters:
  • ret_humidity – Type: int32_t, Unit: 1/100 %, Range: [-231 to 231 - 1]
Returns:
  • e_code – Type: int

Returns relative humidity.

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

int air_quality_get_air_pressure(AirQuality *air_quality, int32_t *ret_air_pressure)
Parameters:
  • air_quality – Type: AirQuality *
Output Parameters:
  • ret_air_pressure – Type: int32_t, Unit: 1/100 hPa, Range: [-231 to 231 - 1]
Returns:
  • e_code – Type: int

Returns air pressure.

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

Advanced Functions

int air_quality_remove_calibration(AirQuality *air_quality)
Parameters:
  • air_quality – Type: 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 air_quality_set_background_calibration_duration(AirQuality *air_quality, uint8_t duration)
Parameters:
  • air_quality – Type: 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:

  • AIR_QUALITY_DURATION_4_DAYS = 0
  • AIR_QUALITY_DURATION_28_DAYS = 1

New in version 2.0.3 (Plugin).

int air_quality_get_background_calibration_duration(AirQuality *air_quality, uint8_t *ret_duration)
Parameters:
  • air_quality – Type: 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 air_quality_set_background_calibration_duration().

The following constants are available for this function:

For ret_duration:

  • AIR_QUALITY_DURATION_4_DAYS = 0
  • AIR_QUALITY_DURATION_28_DAYS = 1

New in version 2.0.3 (Plugin).

int air_quality_get_spitfp_error_count(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: AirQuality *
Output Parameters:
  • ret_error_count_ack_checksum – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_message_checksum – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_frame – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_overflow – Type: uint32_t, Range: [0 to 232 - 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 air_quality_set_status_led_config(AirQuality *air_quality, uint8_t config)
Parameters:
  • air_quality – Type: 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:

  • AIR_QUALITY_STATUS_LED_CONFIG_OFF = 0
  • AIR_QUALITY_STATUS_LED_CONFIG_ON = 1
  • AIR_QUALITY_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • AIR_QUALITY_STATUS_LED_CONFIG_SHOW_STATUS = 3
int air_quality_get_status_led_config(AirQuality *air_quality, uint8_t *ret_config)
Parameters:
  • air_quality – Type: AirQuality *
Output Parameters:
  • ret_config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • e_code – Type: int

Returns the configuration as set by air_quality_set_status_led_config()

The following constants are available for this function:

For ret_config:

  • AIR_QUALITY_STATUS_LED_CONFIG_OFF = 0
  • AIR_QUALITY_STATUS_LED_CONFIG_ON = 1
  • AIR_QUALITY_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • AIR_QUALITY_STATUS_LED_CONFIG_SHOW_STATUS = 3
int air_quality_get_chip_temperature(AirQuality *air_quality, int16_t *ret_temperature)
Parameters:
  • air_quality – Type: AirQuality *
Output Parameters:
  • ret_temperature – Type: int16_t, Unit: 1 °C, Range: [-215 to 215 - 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 air_quality_reset(AirQuality *air_quality)
Parameters:
  • air_quality – Type: 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 air_quality_get_identity(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: 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 216 - 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 air_quality_register_callback(AirQuality *air_quality, int16_t callback_id, void (*function)(void), void *user_data)
Parameters:
  • air_quality – Type: AirQuality *
  • 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 air_quality_set_all_values_callback_configuration(AirQuality *air_quality, uint32_t period, bool value_has_to_change)
Parameters:
  • air_quality – Type: AirQuality *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
Returns:
  • e_code – Type: int

The period is the period with which the AIR_QUALITY_CALLBACK_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 air_quality_get_all_values_callback_configuration(AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change)
Parameters:
  • air_quality – Type: AirQuality *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • ret_value_has_to_change – Type: bool, Default: false
Returns:
  • e_code – Type: int

Returns the callback configuration as set by air_quality_set_all_values_callback_configuration().

int air_quality_set_iaq_index_callback_configuration(AirQuality *air_quality, uint32_t period, bool value_has_to_change)
Parameters:
  • air_quality – Type: AirQuality *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
Returns:
  • e_code – Type: int

The period is the period with which the AIR_QUALITY_CALLBACK_IAQ_INDEX 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 air_quality_get_iaq_index_callback_configuration(AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change)
Parameters:
  • air_quality – Type: AirQuality *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • ret_value_has_to_change – Type: bool, Default: false
Returns:
  • e_code – Type: int

Returns the callback configuration as set by air_quality_set_iaq_index_callback_configuration().

int air_quality_set_temperature_callback_configuration(AirQuality *air_quality, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)
Parameters:
  • air_quality – Type: AirQuality *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 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: [-231 to 231 - 1], Default: 0
  • max – Type: int32_t, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0
Returns:
  • e_code – Type: int

The period is the period with which the AIR_QUALITY_CALLBACK_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 AIR_QUALITY_CALLBACK_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:

  • AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'
int air_quality_get_temperature_callback_configuration(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: AirQuality *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 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: [-231 to 231 - 1], Default: 0
  • ret_max – Type: int32_t, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0
Returns:
  • e_code – Type: int

Returns the callback configuration as set by air_quality_set_temperature_callback_configuration().

The following constants are available for this function:

For ret_option:

  • AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'
int air_quality_set_humidity_callback_configuration(AirQuality *air_quality, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)
Parameters:
  • air_quality – Type: AirQuality *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 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: [-231 to 231 - 1], Default: 0
  • max – Type: int32_t, Unit: 1/100 %, Range: [-231 to 231 - 1], Default: 0
Returns:
  • e_code – Type: int

The period is the period with which the AIR_QUALITY_CALLBACK_HUMIDITY 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_QUALITY_CALLBACK_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:

  • AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'
int air_quality_get_humidity_callback_configuration(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: AirQuality *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 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: [-231 to 231 - 1], Default: 0
  • ret_max – Type: int32_t, Unit: 1/100 %, Range: [-231 to 231 - 1], Default: 0
Returns:
  • e_code – Type: int

Returns the callback configuration as set by air_quality_set_humidity_callback_configuration().

The following constants are available for this function:

For ret_option:

  • AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'
int air_quality_set_air_pressure_callback_configuration(AirQuality *air_quality, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)
Parameters:
  • air_quality – Type: AirQuality *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 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: [-231 to 231 - 1], Default: 0
  • max – Type: int32_t, Unit: 1/100 hPa, Range: [-231 to 231 - 1], Default: 0
Returns:
  • e_code – Type: int

The period is the period with which the AIR_QUALITY_CALLBACK_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_QUALITY_CALLBACK_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:

  • AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'
int air_quality_get_air_pressure_callback_configuration(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: AirQuality *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 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: [-231 to 231 - 1], Default: 0
  • ret_max – Type: int32_t, Unit: 1/100 hPa, Range: [-231 to 231 - 1], Default: 0
Returns:
  • e_code – Type: int

Returns the callback configuration as set by air_quality_set_air_pressure_callback_configuration().

The following constants are available for this function:

For ret_option:

  • AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • 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 air_quality_register_callback() function:

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

air_quality_register_callback(&air_quality,
                              AIR_QUALITY_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.

AIR_QUALITY_CALLBACK_ALL_VALUES
void callback(int32_t iaq_index, uint8_t iaq_index_accuracy, int32_t temperature, int32_t humidity, int32_t air_pressure, void *user_data)
Callback Parameters:
  • 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: [-231 to 231 - 1]
  • humidity – Type: int32_t, Unit: 1/100 %, Range: [-231 to 231 - 1]
  • air_pressure – Type: int32_t, Unit: 1/100 hPa, Range: [-231 to 231 - 1]
  • user_data – Type: void *

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

The parameters are the same as air_quality_get_all_values().

The following constants are available for this function:

For iaq_index_accuracy:

  • AIR_QUALITY_ACCURACY_UNRELIABLE = 0
  • AIR_QUALITY_ACCURACY_LOW = 1
  • AIR_QUALITY_ACCURACY_MEDIUM = 2
  • AIR_QUALITY_ACCURACY_HIGH = 3
AIR_QUALITY_CALLBACK_IAQ_INDEX
void callback(int32_t iaq_index, uint8_t iaq_index_accuracy, void *user_data)
Callback Parameters:
  • 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 air_quality_set_iaq_index_callback_configuration().

The parameters are the same as air_quality_get_iaq_index().

The following constants are available for this function:

For iaq_index_accuracy:

  • AIR_QUALITY_ACCURACY_UNRELIABLE = 0
  • AIR_QUALITY_ACCURACY_LOW = 1
  • AIR_QUALITY_ACCURACY_MEDIUM = 2
  • AIR_QUALITY_ACCURACY_HIGH = 3
AIR_QUALITY_CALLBACK_TEMPERATURE
void callback(int32_t temperature, void *user_data)
Callback Parameters:
  • temperature – Type: int32_t, Unit: 1/100 °C, Range: [-231 to 231 - 1]
  • user_data – Type: void *

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

The parameter is the same as air_quality_get_temperature().

AIR_QUALITY_CALLBACK_HUMIDITY
void callback(int32_t humidity, void *user_data)
Callback Parameters:
  • humidity – Type: int32_t, Unit: 1/100 %, Range: [-231 to 231 - 1]
  • user_data – Type: void *

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

The parameter is the same as air_quality_get_humidity().

AIR_QUALITY_CALLBACK_AIR_PRESSURE
void callback(int32_t air_pressure, void *user_data)
Callback Parameters:
  • air_pressure – Type: int32_t, Unit: 1/100 hPa, Range: [-231 to 231 - 1]
  • user_data – Type: void *

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

The parameter is the same as 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. They can be called without the corresponding IP Connection object being connected.

int air_quality_get_api_version(AirQuality *air_quality, uint8_t ret_api_version[3])
Parameters:
  • air_quality – Type: AirQuality *
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 air_quality_get_response_expected(AirQuality *air_quality, uint8_t function_id, bool *ret_response_expected)
Parameters:
  • air_quality – Type: 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 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:

  • AIR_QUALITY_FUNCTION_SET_TEMPERATURE_OFFSET = 2
  • AIR_QUALITY_FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 4
  • AIR_QUALITY_FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION = 8
  • AIR_QUALITY_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 12
  • AIR_QUALITY_FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 16
  • AIR_QUALITY_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20
  • AIR_QUALITY_FUNCTION_REMOVE_CALIBRATION = 23
  • AIR_QUALITY_FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
  • AIR_QUALITY_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • AIR_QUALITY_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • AIR_QUALITY_FUNCTION_RESET = 243
  • AIR_QUALITY_FUNCTION_WRITE_UID = 248
int air_quality_set_response_expected(AirQuality *air_quality, uint8_t function_id, bool response_expected)
Parameters:
  • air_quality – Type: 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.

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:

  • AIR_QUALITY_FUNCTION_SET_TEMPERATURE_OFFSET = 2
  • AIR_QUALITY_FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 4
  • AIR_QUALITY_FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION = 8
  • AIR_QUALITY_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 12
  • AIR_QUALITY_FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 16
  • AIR_QUALITY_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20
  • AIR_QUALITY_FUNCTION_REMOVE_CALIBRATION = 23
  • AIR_QUALITY_FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
  • AIR_QUALITY_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • AIR_QUALITY_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • AIR_QUALITY_FUNCTION_RESET = 243
  • AIR_QUALITY_FUNCTION_WRITE_UID = 248
int air_quality_set_response_expected_all(AirQuality *air_quality, bool response_expected)
Parameters:
  • air_quality – Type: 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 air_quality_set_bootloader_mode(AirQuality *air_quality, uint8_t mode, uint8_t *ret_status)
Parameters:
  • air_quality – Type: 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:

  • AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER = 0
  • AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE = 1
  • AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

  • AIR_QUALITY_BOOTLOADER_STATUS_OK = 0
  • AIR_QUALITY_BOOTLOADER_STATUS_INVALID_MODE = 1
  • AIR_QUALITY_BOOTLOADER_STATUS_NO_CHANGE = 2
  • AIR_QUALITY_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • AIR_QUALITY_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • AIR_QUALITY_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int air_quality_get_bootloader_mode(AirQuality *air_quality, uint8_t *ret_mode)
Parameters:
  • air_quality – Type: AirQuality *
Output Parameters:
  • ret_mode – Type: uint8_t, Range: See constants
Returns:
  • e_code – Type: int

Returns the current bootloader mode, see air_quality_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

  • AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER = 0
  • AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE = 1
  • AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int air_quality_set_write_firmware_pointer(AirQuality *air_quality, uint32_t pointer)
Parameters:
  • air_quality – Type: AirQuality *
  • pointer – Type: uint32_t, Unit: 1 B, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

Sets the firmware pointer for 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 air_quality_write_firmware(AirQuality *air_quality, uint8_t data[64], uint8_t *ret_status)
Parameters:
  • air_quality – Type: AirQuality *
  • 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 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 air_quality_write_uid(AirQuality *air_quality, uint32_t uid)
Parameters:
  • air_quality – Type: AirQuality *
  • uid – Type: uint32_t, Range: [0 to 232 - 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 air_quality_read_uid(AirQuality *air_quality, uint32_t *ret_uid)
Parameters:
  • air_quality – Type: AirQuality *
Output Parameters:
  • ret_uid – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

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

Constants

AIR_QUALITY_DEVICE_IDENTIFIER

This constant is used to identify a Air Quality Bricklet.

The air_quality_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.

AIR_QUALITY_DEVICE_DISPLAY_NAME

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