C/C++ - Particulate Matter Bricklet

This is the description of the C/C++ API bindings for the Particulate Matter Bricklet. General information and technical specifications for the Particulate Matter 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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_particulate_matter.h"

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

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

    // Create device object
    ParticulateMatter pm;
    particulate_matter_create(&pm, 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 PM concentration
    uint16_t pm10, pm25, pm100;
    if(particulate_matter_get_pm_concentration(&pm, &pm10, &pm25, &pm100) < 0) {
        fprintf(stderr, "Could not get PM concentration, probably timeout\n");
        return 1;
    }

    printf("PM 1.0: %u µg/m³\n", pm10);
    printf("PM 2.5: %u µg/m³\n", pm25);
    printf("PM 10.0: %u µg/m³\n", pm100);

    printf("Press key to exit\n");
    getchar();
    particulate_matter_destroy(&pm);
    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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_particulate_matter.h"

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

// Callback function for PM concentration callback
void cb_pm_concentration(uint16_t pm10, uint16_t pm25, uint16_t pm100, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("PM 1.0: %u µg/m³\n", pm10);
    printf("PM 2.5: %u µg/m³\n", pm25);
    printf("PM 10.0: %u µg/m³\n", pm100);
    printf("\n");
}

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

    // Create device object
    ParticulateMatter pm;
    particulate_matter_create(&pm, 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 PM concentration callback to function cb_pm_concentration
    particulate_matter_register_callback(&pm,
                                         PARTICULATE_MATTER_CALLBACK_PM_CONCENTRATION,
                                         (void *)cb_pm_concentration,
                                         NULL);

    // Set period for PM concentration callback to 1s (1000ms)
    particulate_matter_set_pm_concentration_callback_configuration(&pm, 1000, false);

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

API

Every function of the C/C++ bindings returns an integer which describes an error code. Data returned from the device, when a getter is called, is handled via call by reference. 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 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

as defined in ip_connection.h.

All functions listed below are thread-safe.

Basic Functions

void particulate_matter_create(ParticulateMatter *particulate_matter, const char *uid, IPConnection *ipcon)

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

ParticulateMatter particulate_matter;
particulate_matter_create(&particulate_matter, "YOUR_DEVICE_UID", &ipcon);

This device object can be used after the IP connection has been connected (see examples above).

void particulate_matter_destroy(ParticulateMatter *particulate_matter)

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

int particulate_matter_get_pm_concentration(ParticulateMatter *particulate_matter, uint16_t *ret_pm10, uint16_t *ret_pm25, uint16_t *ret_pm100)

Returns the particulate matter concentration in µg/m³, broken down as:

  • PM1.0,
  • PM2.5 and
  • PM10.0.

If the sensor is disabled (see particulate_matter_set_enable()) then the last known good values from the sensor are returned.

int particulate_matter_get_pm_count(ParticulateMatter *particulate_matter, uint16_t *ret_greater03um, uint16_t *ret_greater05um, uint16_t *ret_greater10um, uint16_t *ret_greater25um, uint16_t *ret_greater50um, uint16_t *ret_greater100um)

Returns the number of particulates in 100 ml of air, broken down by their diameter:

  • greater 0.3µm,
  • greater 0.5µm,
  • greater 1.0µm,
  • greater 2.5µm,
  • greater 5.0µm and
  • greater 10.0µm.

If the sensor is disabled (see particulate_matter_set_enable()) then the last known good value from the sensor is returned.

Advanced Functions

int particulate_matter_set_enable(ParticulateMatter *particulate_matter, bool enable)

Enables/Disables the fan and the laser diode of the sensors. The sensor is enabled by default.

The sensor takes about 30 seconds after it is enabled to settle and produce stable values.

The laser diode has a lifetime of about 8000 hours. If you want to measure in an interval with a long idle time (e.g. hourly) you should turn the laser diode off between the measurements.

int particulate_matter_get_enable(ParticulateMatter *particulate_matter, bool *ret_enable)

Returns the state of the sensor as set by particulate_matter_set_enable().

int particulate_matter_get_sensor_info(ParticulateMatter *particulate_matter, uint8_t *ret_sensor_version, uint8_t *ret_last_error_code, uint8_t *ret_framing_error_count, uint8_t *ret_checksum_error_count)

Returns information about the sensor:

  • the sensor version number,
  • the last error code reported by the sensor (0 means no error) and
  • the number of framing and checksum errors that occurred in the communication with the sensor.
int particulate_matter_get_api_version(ParticulateMatter *particulate_matter, uint8_t ret_api_version[3])

Returns the version of the API definition (major, minor, revision) 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 particulate_matter_get_response_expected(ParticulateMatter *particulate_matter, uint8_t function_id, bool *ret_response_expected)

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 particulate_matter_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 send and errors are silently ignored, because they cannot be detected.

See particulate_matter_set_response_expected() for the list of function ID defines available for this function.

int particulate_matter_set_response_expected(ParticulateMatter *particulate_matter, uint8_t function_id, bool response_expected)

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 send and errors are silently ignored, because they cannot be detected.

The following function ID defines are available for this function:

  • PARTICULATE_MATTER_FUNCTION_SET_ENABLE = 3
  • PARTICULATE_MATTER_FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION = 6
  • PARTICULATE_MATTER_FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION = 8
  • PARTICULATE_MATTER_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • PARTICULATE_MATTER_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • PARTICULATE_MATTER_FUNCTION_RESET = 243
  • PARTICULATE_MATTER_FUNCTION_WRITE_UID = 248
int particulate_matter_set_response_expected_all(ParticulateMatter *particulate_matter, bool response_expected)

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

int particulate_matter_get_spitfp_error_count(ParticulateMatter *particulate_matter, 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)

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 particulate_matter_set_bootloader_mode(ParticulateMatter *particulate_matter, uint8_t mode, uint8_t *ret_status)

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 defines are available for this function:

  • PARTICULATE_MATTER_BOOTLOADER_MODE_BOOTLOADER = 0
  • PARTICULATE_MATTER_BOOTLOADER_MODE_FIRMWARE = 1
  • PARTICULATE_MATTER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • PARTICULATE_MATTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • PARTICULATE_MATTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • PARTICULATE_MATTER_BOOTLOADER_STATUS_OK = 0
  • PARTICULATE_MATTER_BOOTLOADER_STATUS_INVALID_MODE = 1
  • PARTICULATE_MATTER_BOOTLOADER_STATUS_NO_CHANGE = 2
  • PARTICULATE_MATTER_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • PARTICULATE_MATTER_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • PARTICULATE_MATTER_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int particulate_matter_get_bootloader_mode(ParticulateMatter *particulate_matter, uint8_t *ret_mode)

Returns the current bootloader mode, see particulate_matter_set_bootloader_mode().

The following defines are available for this function:

  • PARTICULATE_MATTER_BOOTLOADER_MODE_BOOTLOADER = 0
  • PARTICULATE_MATTER_BOOTLOADER_MODE_FIRMWARE = 1
  • PARTICULATE_MATTER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • PARTICULATE_MATTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • PARTICULATE_MATTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int particulate_matter_set_write_firmware_pointer(ParticulateMatter *particulate_matter, uint32_t pointer)

Sets the firmware pointer for particulate_matter_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 particulate_matter_write_firmware(ParticulateMatter *particulate_matter, uint8_t data[64], uint8_t *ret_status)

Writes 64 Bytes of firmware at the position as written by particulate_matter_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 particulate_matter_set_status_led_config(ParticulateMatter *particulate_matter, uint8_t config)

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 defines are available for this function:

  • PARTICULATE_MATTER_STATUS_LED_CONFIG_OFF = 0
  • PARTICULATE_MATTER_STATUS_LED_CONFIG_ON = 1
  • PARTICULATE_MATTER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • PARTICULATE_MATTER_STATUS_LED_CONFIG_SHOW_STATUS = 3
int particulate_matter_get_status_led_config(ParticulateMatter *particulate_matter, uint8_t *ret_config)

Returns the configuration as set by particulate_matter_set_status_led_config()

The following defines are available for this function:

  • PARTICULATE_MATTER_STATUS_LED_CONFIG_OFF = 0
  • PARTICULATE_MATTER_STATUS_LED_CONFIG_ON = 1
  • PARTICULATE_MATTER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • PARTICULATE_MATTER_STATUS_LED_CONFIG_SHOW_STATUS = 3
int particulate_matter_get_chip_temperature(ParticulateMatter *particulate_matter, int16_t *ret_temperature)

Returns the temperature in °C 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 particulate_matter_reset(ParticulateMatter *particulate_matter)

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 particulate_matter_write_uid(ParticulateMatter *particulate_matter, uint32_t uid)

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 particulate_matter_read_uid(ParticulateMatter *particulate_matter, uint32_t *ret_uid)

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

int particulate_matter_get_identity(ParticulateMatter *particulate_matter, 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)

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' or 'd'.

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

Callback Configuration Functions

void particulate_matter_register_callback(ParticulateMatter *particulate_matter, int16_t callback_id, void *function, void *user_data)

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 particulate_matter_set_pm_concentration_callback_configuration(ParticulateMatter *particulate_matter, uint32_t period, bool value_has_to_change)

The period in ms is the period with which the PARTICULATE_MATTER_CALLBACK_PM_CONCENTRATION 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.

The default value is (0, false).

int particulate_matter_get_pm_concentration_callback_configuration(ParticulateMatter *particulate_matter, uint32_t *ret_period, bool *ret_value_has_to_change)

Returns the callback configuration as set by particulate_matter_set_pm_concentration_callback_configuration().

int particulate_matter_set_pm_count_callback_configuration(ParticulateMatter *particulate_matter, uint32_t period, bool value_has_to_change)

The period in ms is the period with which the PARTICULATE_MATTER_CALLBACK_PM_COUNT 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.

The default value is (0, false).

int particulate_matter_get_pm_count_callback_configuration(ParticulateMatter *particulate_matter, uint32_t *ret_period, bool *ret_value_has_to_change)

Returns the callback configuration as set by particulate_matter_set_pm_count_callback_configuration().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the particulate_matter_register_callback() function. The parameters consist of the device object, the callback ID, the callback function and optional user data:

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

particulate_matter_register_callback(&particulate_matter, PARTICULATE_MATTER_CALLBACK_EXAMPLE, (void *)my_callback, NULL);

The available constants with corresponding callback 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.

PARTICULATE_MATTER_CALLBACK_PM_CONCENTRATION
void callback(uint16_t pm10, uint16_t pm25, uint16_t pm100, void *user_data)

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

The parameters are the same as particulate_matter_get_pm_concentration().

PARTICULATE_MATTER_CALLBACK_PM_COUNT
void callback(uint16_t greater03um, uint16_t greater05um, uint16_t greater10um, uint16_t greater25um, uint16_t greater50um, uint16_t greater100um, void *user_data)

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

The parameters are the same as particulate_matter_get_pm_count().

Constants

PARTICULATE_MATTER_DEVICE_IDENTIFIER

This constant is used to identify a Particulate Matter Bricklet.

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

PARTICULATE_MATTER_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Particulate Matter Bricklet.