C/C++ - Temperature Bricklet

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

#include "ip_connection.h"
#include "bricklet_temperature.h"

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

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

    // Create device object
    Temperature t;
    temperature_create(&t, 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 temperature
    int16_t temperature;
    if(temperature_get_temperature(&t, &temperature) < 0) {
        fprintf(stderr, "Could not get temperature, probably timeout\n");
        return 1;
    }

    printf("Temperature: %f °C\n", temperature/100.0);

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

#include "ip_connection.h"
#include "bricklet_temperature.h"

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

// Callback function for temperature callback
void cb_temperature(int16_t temperature, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Temperature: %f °C\n", temperature/100.0);
}

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

    // Create device object
    Temperature t;
    temperature_create(&t, 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 temperature callback to function cb_temperature
    temperature_register_callback(&t,
                                  TEMPERATURE_CALLBACK_TEMPERATURE,
                                  (void *)cb_temperature,
                                  NULL);

    // Set period for temperature callback to 1s (1000ms)
    // Note: The temperature callback is only called every second
    //       if the temperature has changed since the last call!
    temperature_set_temperature_callback_period(&t, 1000);

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

#include "ip_connection.h"
#include "bricklet_temperature.h"

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

// Callback function for temperature reached callback
void cb_temperature_reached(int16_t temperature, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Temperature: %f °C\n", temperature/100.0);
    printf("It is too hot, we need air conditioning!\n");
}

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

    // Create device object
    Temperature t;
    temperature_create(&t, 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 threshold callbacks with a debounce time of 10 seconds (10000ms)
    temperature_set_debounce_period(&t, 10000);

    // Register temperature reached callback to function cb_temperature_reached
    temperature_register_callback(&t,
                                  TEMPERATURE_CALLBACK_TEMPERATURE_REACHED,
                                  (void *)cb_temperature_reached,
                                  NULL);

    // Configure threshold for temperature "greater than 30 °C"
    temperature_set_temperature_callback_threshold(&t, '>', 30*100, 0);

    printf("Press key to exit\n");
    getchar();
    temperature_destroy(&t);
    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 temperature_create(Temperature *temperature, const char *uid, IPConnection *ipcon)

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

Temperature temperature;
temperature_create(&temperature, "YOUR_DEVICE_UID", &ipcon);

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

void temperature_destroy(Temperature *temperature)

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

int temperature_get_temperature(Temperature *temperature, int16_t *ret_temperature)

Returns the temperature of the sensor. The value has a range of -2500 to 8500 and is given in °C/100, e.g. a value of 4223 means that a temperature of 42.23 °C is measured.

If you want to get the temperature periodically, it is recommended to use the TEMPERATURE_CALLBACK_TEMPERATURE callback and set the period with temperature_set_temperature_callback_period().

Advanced Functions

int temperature_set_i2c_mode(Temperature *temperature, uint8_t mode)

Sets the I2C mode. Possible modes are:

  • 0: Fast (400kHz, default)
  • 1: Slow (100kHz)

If you have problems with obvious outliers in the Temperature Bricklet measurements, they may be caused by EMI issues. In this case it may be helpful to lower the I2C speed.

It is however not recommended to lower the I2C speed in applications where a high throughput needs to be achieved.

The following defines are available for this function:

  • TEMPERATURE_I2C_MODE_FAST = 0
  • TEMPERATURE_I2C_MODE_SLOW = 1

New in version 2.0.1 (Plugin).

int temperature_get_i2c_mode(Temperature *temperature, uint8_t *ret_mode)

Returns the I2C mode as set by temperature_set_i2c_mode().

The following defines are available for this function:

  • TEMPERATURE_I2C_MODE_FAST = 0
  • TEMPERATURE_I2C_MODE_SLOW = 1

New in version 2.0.1 (Plugin).

int temperature_get_api_version(Temperature *temperature, 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 temperature_get_response_expected(Temperature *temperature, 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 temperature_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 temperature_set_response_expected() for the list of function ID defines available for this function.

int temperature_set_response_expected(Temperature *temperature, 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:

  • TEMPERATURE_FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
  • TEMPERATURE_FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
  • TEMPERATURE_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • TEMPERATURE_FUNCTION_SET_I2C_MODE = 10
int temperature_set_response_expected_all(Temperature *temperature, bool response_expected)

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

int temperature_get_identity(Temperature *temperature, 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 temperature_register_callback(Temperature *temperature, 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 temperature_set_temperature_callback_period(Temperature *temperature, uint32_t period)

Sets the period in ms with which the TEMPERATURE_CALLBACK_TEMPERATURE callback is triggered periodically. A value of 0 turns the callback off.

The TEMPERATURE_CALLBACK_TEMPERATURE callback is only triggered if the temperature has changed since the last triggering.

The default value is 0.

int temperature_get_temperature_callback_period(Temperature *temperature, uint32_t *ret_period)

Returns the period as set by temperature_set_temperature_callback_period().

int temperature_set_temperature_callback_threshold(Temperature *temperature, char option, int16_t min, int16_t max)

Sets the thresholds for the TEMPERATURE_CALLBACK_TEMPERATURE_REACHED callback.

The following options are possible:

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

The default value is ('x', 0, 0).

The following defines are available for this function:

  • TEMPERATURE_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_THRESHOLD_OPTION_GREATER = '>'
int temperature_get_temperature_callback_threshold(Temperature *temperature, char *ret_option, int16_t *ret_min, int16_t *ret_max)

Returns the threshold as set by temperature_set_temperature_callback_threshold().

The following defines are available for this function:

  • TEMPERATURE_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_THRESHOLD_OPTION_GREATER = '>'
int temperature_set_debounce_period(Temperature *temperature, uint32_t debounce)

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

int temperature_get_debounce_period(Temperature *temperature, uint32_t *ret_debounce)

Returns the debounce period as set by temperature_set_debounce_period().

Callbacks

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

temperature_register_callback(&temperature, TEMPERATURE_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.

TEMPERATURE_CALLBACK_TEMPERATURE
void callback(int16_t temperature, void *user_data)

This callback is triggered periodically with the period that is set by temperature_set_temperature_callback_period(). The parameter is the temperature of the sensor.

The TEMPERATURE_CALLBACK_TEMPERATURE callback is only triggered if the temperature has changed since the last triggering.

TEMPERATURE_CALLBACK_TEMPERATURE_REACHED
void callback(int16_t temperature, void *user_data)

This callback is triggered when the threshold as set by temperature_set_temperature_callback_threshold() is reached. The parameter is the temperature of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by temperature_set_debounce_period().

Constants

TEMPERATURE_DEVICE_IDENTIFIER

This constant is used to identify a Temperature Bricklet.

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

TEMPERATURE_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Temperature Bricklet.