C/C++ - Humidity Bricklet 2.0

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

#include "ip_connection.h"
#include "bricklet_humidity_v2.h"

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

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

    // Create device object
    HumidityV2 h;
    humidity_v2_create(&h, 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 humidity
    uint16_t humidity;
    if(humidity_v2_get_humidity(&h, &humidity) < 0) {
        fprintf(stderr, "Could not get humidity, probably timeout\n");
        return 1;
    }

    printf("Humidity: %f %%RH\n", humidity/100.0);

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

#include "ip_connection.h"
#include "bricklet_humidity_v2.h"

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

// Callback function for humidity callback
void cb_humidity(uint16_t humidity, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Humidity: %f %%RH\n", humidity/100.0);
}

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

    // Create device object
    HumidityV2 h;
    humidity_v2_create(&h, 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 humidity callback to function cb_humidity
    humidity_v2_register_callback(&h,
                                  HUMIDITY_V2_CALLBACK_HUMIDITY,
                                  (void *)cb_humidity,
                                  NULL);

    // Set period for humidity callback to 1s (1000ms) without a threshold
    humidity_v2_set_humidity_callback_configuration(&h, 1000, false, 'x', 0, 0);

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

Threshold

Download (example_threshold.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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_humidity_v2.h"

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

// Callback function for humidity callback
void cb_humidity(uint16_t humidity, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Humidity: %f %%RH\n", humidity/100.0);
    printf("Recommended humidity for human comfort is 30 to 60 %%RH.\n");
}

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

    // Create device object
    HumidityV2 h;
    humidity_v2_create(&h, 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 humidity callback to function cb_humidity
    humidity_v2_register_callback(&h,
                                  HUMIDITY_V2_CALLBACK_HUMIDITY,
                                  (void *)cb_humidity,
                                  NULL);

    // Configure threshold for humidity "outside of 30 to 60 %RH"
    // with a debounce period of 10s (10000ms)
    humidity_v2_set_humidity_callback_configuration(&h, 10000, false, 'o', 30*100, 60*100);

    printf("Press key to exit\n");
    getchar();
    humidity_v2_destroy(&h);
    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 humidity_v2_create(HumidityV2 *humidity_v2, const char *uid, IPConnection *ipcon)

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

HumidityV2 humidity_v2;
humidity_v2_create(&humidity_v2, "YOUR_DEVICE_UID", &ipcon);

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

void humidity_v2_destroy(HumidityV2 *humidity_v2)

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

int humidity_v2_get_humidity(HumidityV2 *humidity_v2, uint16_t *ret_humidity)

Returns the humidity measured by the sensor. The value has a range of 0 to 10000 and is given in %RH/100 (Relative Humidity), i.e. a value of 4223 means that a humidity of 42.23 %RH is measured.

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

int humidity_v2_get_temperature(HumidityV2 *humidity_v2, int16_t *ret_temperature)

Returns the temperature measured by the sensor. The value has a range of -4000 to 16500 and is given in °C/100, i.e. a value of 3200 means that a temperature of 32.00 °C is measured.

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

int humidity_v2_set_heater_configuration(HumidityV2 *humidity_v2, uint8_t heater_config)

Enables/disables the heater. The heater can be used to dry the sensor in extremely wet conditions.

By default the heater is disabled.

The following defines are available for this function:

  • HUMIDITY_V2_HEATER_CONFIG_DISABLED = 0
  • HUMIDITY_V2_HEATER_CONFIG_ENABLED = 1
int humidity_v2_get_heater_configuration(HumidityV2 *humidity_v2, uint8_t *ret_heater_config)

Returns the heater configuration as set by humidity_v2_set_heater_configuration().

The following defines are available for this function:

  • HUMIDITY_V2_HEATER_CONFIG_DISABLED = 0
  • HUMIDITY_V2_HEATER_CONFIG_ENABLED = 1
int humidity_v2_set_moving_average_configuration(HumidityV2 *humidity_v2, uint16_t moving_average_length_humidity, uint16_t moving_average_length_temperature)

Sets the length of a moving averaging for the humidity and temperature.

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

The range for the averaging is 1-1000.

New data is gathered every 50ms*. With a moving average of length 1000 the resulting averaging window has a length of 50s. If you want to do long term measurements the longest moving average will give the cleanest results.

The default value is 5.

* In firmware version 2.0.3 we added the humidity_v2_set_samples_per_second() function. It configures the measurement frequency. Since high frequencies can result in self-heating of th IC, changed the default value from 20 samples per second to 1. With 1 sample per second a moving average length of 1000 would result in an averaging window of 1000 seconds!

int humidity_v2_get_moving_average_configuration(HumidityV2 *humidity_v2, uint16_t *ret_moving_average_length_humidity, uint16_t *ret_moving_average_length_temperature)

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

int humidity_v2_set_samples_per_second(HumidityV2 *humidity_v2, uint8_t sps)

Sets the samples per second that are gathered by the humidity/temperature sensor HDC1080.

We added this function since we found out that a high measurement frequency can lead to self-heating of the sensor. Which can distort the temperature measurement.

If you don't need a lot of measurements, you can use the lowest available measurement frequency of 0.1 samples per second for the least amount of self-heating.

Before version 2.0.3 the default was 20 samples per second. The new default is 1 sample per second.

The following defines are available for this function:

  • HUMIDITY_V2_SPS_20 = 0
  • HUMIDITY_V2_SPS_10 = 1
  • HUMIDITY_V2_SPS_5 = 2
  • HUMIDITY_V2_SPS_1 = 3
  • HUMIDITY_V2_SPS_02 = 4
  • HUMIDITY_V2_SPS_01 = 5

New in version 2.0.3 (Plugin).

int humidity_v2_get_samples_per_second(HumidityV2 *humidity_v2, uint8_t *ret_sps)

Returnes the samples per second, as set by humidity_v2_set_samples_per_second().

The following defines are available for this function:

  • HUMIDITY_V2_SPS_20 = 0
  • HUMIDITY_V2_SPS_10 = 1
  • HUMIDITY_V2_SPS_5 = 2
  • HUMIDITY_V2_SPS_1 = 3
  • HUMIDITY_V2_SPS_02 = 4
  • HUMIDITY_V2_SPS_01 = 5

New in version 2.0.3 (Plugin).

Advanced Functions

int humidity_v2_get_api_version(HumidityV2 *humidity_v2, 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 humidity_v2_get_response_expected(HumidityV2 *humidity_v2, 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 humidity_v2_set_response_expected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

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

int humidity_v2_set_response_expected(HumidityV2 *humidity_v2, 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:

  • HUMIDITY_V2_FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 2
  • HUMIDITY_V2_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 6
  • HUMIDITY_V2_FUNCTION_SET_HEATER_CONFIGURATION = 9
  • HUMIDITY_V2_FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 11
  • HUMIDITY_V2_FUNCTION_SET_SAMPLES_PER_SECOND = 13
  • HUMIDITY_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • HUMIDITY_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • HUMIDITY_V2_FUNCTION_RESET = 243
  • HUMIDITY_V2_FUNCTION_WRITE_UID = 248
int humidity_v2_set_response_expected_all(HumidityV2 *humidity_v2, bool response_expected)

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

int humidity_v2_get_spitfp_error_count(HumidityV2 *humidity_v2, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)

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 humidity_v2_set_bootloader_mode(HumidityV2 *humidity_v2, 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:

  • HUMIDITY_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • HUMIDITY_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • HUMIDITY_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • HUMIDITY_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • HUMIDITY_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • HUMIDITY_V2_BOOTLOADER_STATUS_OK = 0
  • HUMIDITY_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • HUMIDITY_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • HUMIDITY_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • HUMIDITY_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • HUMIDITY_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int humidity_v2_get_bootloader_mode(HumidityV2 *humidity_v2, uint8_t *ret_mode)

Returns the current bootloader mode, see humidity_v2_set_bootloader_mode().

The following defines are available for this function:

  • HUMIDITY_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • HUMIDITY_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • HUMIDITY_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • HUMIDITY_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • HUMIDITY_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int humidity_v2_set_write_firmware_pointer(HumidityV2 *humidity_v2, uint32_t pointer)

Sets the firmware pointer for humidity_v2_write_firmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

int humidity_v2_write_firmware(HumidityV2 *humidity_v2, uint8_t data[64], uint8_t *ret_status)

Writes 64 Bytes of firmware at the position as written by humidity_v2_set_write_firmware_pointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

int humidity_v2_set_status_led_config(HumidityV2 *humidity_v2, 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:

  • HUMIDITY_V2_STATUS_LED_CONFIG_OFF = 0
  • HUMIDITY_V2_STATUS_LED_CONFIG_ON = 1
  • HUMIDITY_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • HUMIDITY_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int humidity_v2_get_status_led_config(HumidityV2 *humidity_v2, uint8_t *ret_config)

Returns the configuration as set by humidity_v2_set_status_led_config()

The following defines are available for this function:

  • HUMIDITY_V2_STATUS_LED_CONFIG_OFF = 0
  • HUMIDITY_V2_STATUS_LED_CONFIG_ON = 1
  • HUMIDITY_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • HUMIDITY_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int humidity_v2_get_chip_temperature(HumidityV2 *humidity_v2, 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 humidity_v2_reset(HumidityV2 *humidity_v2)

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 humidity_v2_write_uid(HumidityV2 *humidity_v2, 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 humidity_v2_read_uid(HumidityV2 *humidity_v2, uint32_t *ret_uid)

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

int humidity_v2_get_identity(HumidityV2 *humidity_v2, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)

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 humidity_v2_register_callback(HumidityV2 *humidity_v2, 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 humidity_v2_set_humidity_callback_configuration(HumidityV2 *humidity_v2, uint32_t period, bool value_has_to_change, char option, uint16_t min, uint16_t max)

The period in ms is the period with which the HUMIDITY_V2_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 HUMIDITY_V2_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 default value is (0, false, 'x', 0, 0).

The following defines are available for this function:

  • HUMIDITY_V2_THRESHOLD_OPTION_OFF = 'x'
  • HUMIDITY_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • HUMIDITY_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • HUMIDITY_V2_THRESHOLD_OPTION_SMALLER = '<'
  • HUMIDITY_V2_THRESHOLD_OPTION_GREATER = '>'
int humidity_v2_get_humidity_callback_configuration(HumidityV2 *humidity_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)

Returns the callback configuration as set by humidity_v2_set_humidity_callback_configuration().

The following defines are available for this function:

  • HUMIDITY_V2_THRESHOLD_OPTION_OFF = 'x'
  • HUMIDITY_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • HUMIDITY_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • HUMIDITY_V2_THRESHOLD_OPTION_SMALLER = '<'
  • HUMIDITY_V2_THRESHOLD_OPTION_GREATER = '>'
int humidity_v2_set_temperature_callback_configuration(HumidityV2 *humidity_v2, uint32_t period, bool value_has_to_change, char option, int16_t min, int16_t max)

The period in ms is the period with which the HUMIDITY_V2_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 HUMIDITY_V2_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 default value is (0, false, 'x', 0, 0).

The following defines are available for this function:

  • HUMIDITY_V2_THRESHOLD_OPTION_OFF = 'x'
  • HUMIDITY_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • HUMIDITY_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • HUMIDITY_V2_THRESHOLD_OPTION_SMALLER = '<'
  • HUMIDITY_V2_THRESHOLD_OPTION_GREATER = '>'
int humidity_v2_get_temperature_callback_configuration(HumidityV2 *humidity_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int16_t *ret_min, int16_t *ret_max)

Returns the callback configuration as set by humidity_v2_set_temperature_callback_configuration().

The following defines are available for this function:

  • HUMIDITY_V2_THRESHOLD_OPTION_OFF = 'x'
  • HUMIDITY_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • HUMIDITY_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • HUMIDITY_V2_THRESHOLD_OPTION_SMALLER = '<'
  • HUMIDITY_V2_THRESHOLD_OPTION_GREATER = '>'

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the humidity_v2_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);
}

humidity_v2_register_callback(&humidity_v2, HUMIDITY_V2_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.

HUMIDITY_V2_CALLBACK_HUMIDITY
void callback(uint16_t humidity, void *user_data)

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

The parameter is the same as humidity_v2_get_humidity().

HUMIDITY_V2_CALLBACK_TEMPERATURE
void callback(int16_t temperature, void *user_data)

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

The parameter is the same as humidity_v2_get_temperature().

Constants

HUMIDITY_V2_DEVICE_IDENTIFIER

This constant is used to identify a Humidity Bricklet 2.0.

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

HUMIDITY_V2_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Humidity Bricklet 2.0.