This is the description of the C/C++ API bindings for the Temperature IR Bricklet. General information and technical specifications for the Temperature IR Bricklet are summarized in its hardware description.
An installation guide for the C/C++ API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
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 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_temperature_ir.h"
#define HOST "localhost"
#define PORT 4223
#define UID "abcde" // Change to your UID
int main() {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
TemperatureIR tir;
temperature_ir_create(&tir, UID, &ipcon);
// Connect to brickd
if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
fprintf(stderr, "Could not connect\n");
exit(1);
}
// Don't use device before ipcon is connected
// Get current ambient and object temperatures (unit is °C/10)
int16_t obj;
int16_t amb;
temperature_ir_get_object_temperature(&tir, &obj);
temperature_ir_get_ambient_temperature(&tir, &amb);
printf("Object Temperature: %f °C\n", obj/10.0);
printf("Ambient Temperature: %f °C\n", amb/10.0);
printf("Press key to exit\n");
getchar();
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
}
|
Download (example_water_boiling.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 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_temperature_ir.h"
#define HOST "localhost"
#define PORT 4223
#define UID "abcde" // Change to your UID
// Callback for object temperature greater than 100 °C
// (parameter has unit °C/10)
void cb_reached(uint16_t temperature, void *user_data) {
(void)user_data; // avoid unused parameter warning
printf("The surface has a temperature of %f °C\n", temperature/10.0);
printf("The water is boiling!\n");
}
int main() {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
TemperatureIR tir;
temperature_ir_create(&tir, UID, &ipcon);
// Connect to brickd
if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
fprintf(stderr, "Could not connect\n");
exit(1);
}
// Don't use device before ipcon is connected
// Set emissivity to 0.98 (emissivity of water)
temperature_ir_set_emissivity(&tir, (int)0xFFFF*0.98);
// Get threshold callbacks with a debounce time of 10 seconds (10000ms)
temperature_ir_set_debounce_period(&tir, 10000);
// Register threshold reached callback to function cb_reached
temperature_ir_register_callback(&tir,
TEMPERATURE_IR_CALLBACK_OBJECT_TEMPERATURE_REACHED,
(void *)cb_reached,
NULL);
// Configure threshold for "greater than 100 °C" (unit is °C/10)
temperature_ir_set_object_temperature_callback_threshold(&tir,
'>',
100*10,
0);
printf("Press key to exit\n");
getchar();
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
}
|
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 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_temperature_ir.h"
#define HOST "localhost"
#define PORT 4223
#define UID "abcde" // Change to your UID
// Callback functions for object/ambient temperature callbacks
// (parameters have unit °C/10)
void cb_object(uint16_t temperature, void *user_data) {
(void)user_data; // avoid unused parameter warning
printf("Object Temperature: %f °C.\n", temperature/10.0);
}
void cb_ambient(uint16_t temperature, void *user_data) {
(void)user_data; // avoid unused parameter warning
printf("Ambient Temperature: %f °C.\n", temperature/10.0);
}
int main() {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
TemperatureIR tir;
temperature_ir_create(&tir, UID, &ipcon);
// Connect to brickd
if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
fprintf(stderr, "Could not connect\n");
exit(1);
}
// Don't use device before ipcon is connected
// Set Period for temperature callbacks to 1s (1000ms)
// Note: The callbacks are only called every second if the
// value has changed since the last call!
temperature_ir_set_object_temperature_callback_period(&tir, 1000);
temperature_ir_set_ambient_temperature_callback_period(&tir, 1000);
// Register object temperature callback to function cb_object
temperature_ir_register_callback(&tir,
TEMPERATURE_IR_CALLBACK_OBJECT_TEMPERATURE,
(void *)cb_object,
NULL);
// Register ambient temperature callback to function cb_ambient
temperature_ir_register_callback(&tir,
TEMPERATURE_IR_CALLBACK_AMBIENT_TEMPERATURE,
(void *)cb_ambient,
NULL);
printf("Press key to exit\n");
getchar();
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
}
|
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:
as defined in ip_connection.h.
All functions listed below are thread-safe.
Creates the device object temperature_ir with the unique device ID uid and adds it to the IPConnection ipcon:
TemperatureIR temperature_ir;
temperature_ir_create(&temperature_ir, "YOUR_DEVICE_UID", &ipcon);
This device object can be used after the IP connection has been connected (see examples above).
Removes the device object temperature_ir from its IPConnection and destroys it. The device object cannot be used anymore afterwards.
Returns the ambient temperature of the sensor. The value has a range of -400 to 1250 and is given in °C/10, e.g. a value of 423 means that an ambient temperature of 42.3 °C is measured.
If you want to get the ambient temperature periodically, it is recommended to use the callback TEMPERATURE_IR_CALLBACK_AMBIENT_TEMPERATURE and set the period with temperature_ir_set_ambient_temperature_callback_period().
Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at. The value has a range of -700 to 3800 and is given in °C/10, e.g. a value of 3001 means that a temperature of 300.1 °C is measured on the surface of the object.
The temperature of different materials is dependent on their emissivity. The emissivity of the material can be set with temperature_ir_set_emissivity().
If you want to get the object temperature periodically, it is recommended to use the callback TEMPERATURE_IR_CALLBACK_OBJECT_TEMPERATURE and set the period with temperature_ir_set_object_temperature_callback_period().
Sets the emissivity that is used to calculate the surface temperature as returned by temperature_ir_get_object_temperature().
The emissivity is usually given as a value between 0.0 and 1.0. A list of emissivities of different materials can be found here.
The parameter of temperature_ir_set_emissivity() has to be given with a factor of 65535 (16-bit). For example: An emissivity of 0.1 can be set with the value 6553, an emissivity of 0.5 with the value 32767 and so on.
Note
If you need a precise measurement for the object temperature, it is absolutely crucial that you also provide a precise emissivity.
The default emissivity is 1.0 (value of 65535) and the minimum emissivity the sensor can handle is 0.1 (value of 6553).
Returns the emissivity as set by temperature_ir_set_emissivity().
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.
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_ir_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_ir_set_response_expected() for the list of function ID defines available for this function.
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 and callbacks it is always disabled.
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:
Changes the response expected flag for all setter and callback configuration functions of this device at once.
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.
Registers a callback with ID id to the function callback. The user_data will be given as a parameter of the callback.
The available IDs with corresponding function signatures are listed below.
Sets the period in ms with which the TEMPERATURE_IR_CALLBACK_AMBIENT_TEMPERATURE callback is triggered periodically. A value of 0 turns the callback off.
TEMPERATURE_IR_CALLBACK_AMBIENT_TEMPERATURE is only triggered if the temperature has changed since the last triggering.
The default value is 0.
Returns the period as set by temperature_ir_set_ambient_temperature_callback_period().
Sets the period in ms with which the TEMPERATURE_IR_CALLBACK_OBJECT_TEMPERATURE callback is triggered periodically. A value of 0 turns the callback off.
TEMPERATURE_IR_CALLBACK_OBJECT_TEMPERATURE is only triggered if the temperature has changed since the last triggering.
The default value is 0.
Returns the period as set by temperature_ir_set_object_temperature_callback_period().
Sets the thresholds for the TEMPERATURE_IR_CALLBACK_AMBIENT_TEMPERATURE_REACHED callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the ambient temperature is outside the min and max values |
'i' | Callback is triggered when the ambient temperature is inside the min and max values |
'<' | Callback is triggered when the ambient temperature is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the ambient 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:
Returns the threshold as set by temperature_ir_set_ambient_temperature_callback_threshold().
The following defines are available for this function:
Sets the thresholds for the TEMPERATURE_IR_CALLBACK_OBJECT_TEMPERATURE_REACHED callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the object temperature is outside the min and max values |
'i' | Callback is triggered when the object temperature is inside the min and max values |
'<' | Callback is triggered when the object temperature is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the object 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:
Returns the threshold as set by temperature_ir_set_object_temperature_callback_threshold().
The following defines are available for this function:
Sets the period in ms with which the threshold callbacks
are triggered, if the thresholds
keep being reached.
The default value is 100.
Returns the debounce period as set by temperature_ir_set_debounce_period().
Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the temperature_ir_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_ir_register_callback(&temperature_ir, TEMPERATURE_IR_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.
void callback(int16_t temperature, void *user_data)
This callback is triggered periodically with the period that is set by temperature_ir_set_ambient_temperature_callback_period(). The parameter is the ambient temperature of the sensor.
TEMPERATURE_IR_CALLBACK_AMBIENT_TEMPERATURE is only triggered if the ambient temperature has changed since the last triggering.
void callback(int16_t temperature, void *user_data)
This callback is triggered periodically with the period that is set by temperature_ir_set_object_temperature_callback_period(). The parameter is the object temperature of the sensor.
TEMPERATURE_IR_CALLBACK_OBJECT_TEMPERATURE is only triggered if the object temperature has changed since the last triggering.
void callback(int16_t temperature, void *user_data)
This callback is triggered when the threshold as set by temperature_ir_set_ambient_temperature_callback_threshold() is reached. The parameter is the ambient temperature of the sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by temperature_ir_set_debounce_period().
void callback(int16_t temperature, void *user_data)
This callback is triggered when the threshold as set by temperature_ir_set_object_temperature_callback_threshold() is reached. The parameter is the object temperature of the sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by temperature_ir_set_debounce_period().
This constant is used to identify a Temperature IR Bricklet.
The temperature_ir_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.