C/C++ - Temperature IR Bricklet

Dies ist die Beschreibung der C/C++ API Bindings für das Temperature IR Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Temperature IR Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die C/C++ API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.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_ir.h"

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

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

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

int main(void) {
    // 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");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Register object temperature callback to function cb_object_temperature
    temperature_ir_register_callback(&tir,
                                     TEMPERATURE_IR_CALLBACK_OBJECT_TEMPERATURE,
                                     (void (*)(void))cb_object_temperature,
                                     NULL);

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

    printf("Press key to exit\n");
    getchar();
    temperature_ir_destroy(&tir);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_temperature_ir.h"

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

int main(void) {
    // 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");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Get current ambient temperature
    int16_t ambient_temperature;
    if(temperature_ir_get_ambient_temperature(&tir, &ambient_temperature) < 0) {
        fprintf(stderr, "Could not get ambient temperature, probably timeout\n");
        return 1;
    }

    printf("Ambient Temperature: %f °C\n", ambient_temperature/10.0);

    // Get current object temperature
    int16_t object_temperature;
    if(temperature_ir_get_object_temperature(&tir, &object_temperature) < 0) {
        fprintf(stderr, "Could not get object temperature, probably timeout\n");
        return 1;
    }

    printf("Object Temperature: %f °C\n", object_temperature/10.0);

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

Water Boiling

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

#include "ip_connection.h"
#include "bricklet_temperature_ir.h"

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

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

    printf("Object Temperature: %f °C\n", temperature/10.0);
    printf("The water is boiling!\n");
}

int main(void) {
    // 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");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
    temperature_ir_set_emissivity(&tir, 64224);

    // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    temperature_ir_set_debounce_period(&tir, 10000);

    // Register object temperature reached callback to function
    // cb_object_temperature_reached
    temperature_ir_register_callback(&tir,
                                     TEMPERATURE_IR_CALLBACK_OBJECT_TEMPERATURE_REACHED,
                                     (void (*)(void))cb_object_temperature_reached,
                                     NULL);

    // Configure threshold for object temperature "greater than 100 °C"
    temperature_ir_set_object_temperature_callback_threshold(&tir, '>', 100*10, 0);

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

API

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

  • 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 (wird seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
  • 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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void temperature_ir_create(TemperatureIR *temperature_ir, const char *uid, IPConnection *ipcon)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

Erzeugt ein Geräteobjekt temperature_ir mit der eindeutigen Geräte ID uid und fügt es der IP Connection ipcon hinzu:

TemperatureIR temperature_ir;
temperature_ir_create(&temperature_ir, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.

void temperature_ir_destroy(TemperatureIR *temperature_ir)
Parameter:
  • temperature_ir – Typ: TemperatureIR *

Entfernt das Geräteobjekt temperature_ir von dessen IP Connection und zerstört es. Das Geräteobjekt kann hiernach nicht mehr verwendet werden.

int temperature_ir_get_ambient_temperature(TemperatureIR *temperature_ir, int16_t *ret_temperature)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
Ausgabeparameter:
  • ret_temperature – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]
Rückgabe:
  • error_code – Typ: int

Gibt die Umgebungstemperatur des Sensors zurück.

Wenn die Umgebungstemperatur periodisch abgefragt werden soll, wird empfohlen den TEMPERATURE_IR_CALLBACK_AMBIENT_TEMPERATURE Callback zu nutzen und die Periode mit temperature_ir_set_ambient_temperature_callback_period() vorzugeben.

int temperature_ir_get_object_temperature(TemperatureIR *temperature_ir, int16_t *ret_temperature)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
Ausgabeparameter:
  • ret_temperature – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]
Rückgabe:
  • error_code – Typ: int

Gibt die Objekttemperatur des Sensors zurück, z.B. die Temperatur der Oberfläche auf welche der Sensor zielt.

Die Temperatur von unterschiedlichen Materialien ist abhängig von ihrem Emissionsgrad. Der Emissionsgrad des Materials kann mit temperature_ir_set_emissivity() gesetzt werden.

Wenn die Objekttemperatur periodisch abgefragt werden soll, wird empfohlen den TEMPERATURE_IR_CALLBACK_OBJECT_TEMPERATURE Callback zu nutzen und die Periode mit temperature_ir_set_object_temperature_callback_period() vorzugeben.

Fortgeschrittene Funktionen

int temperature_ir_set_emissivity(TemperatureIR *temperature_ir, uint16_t emissivity)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
  • emissivity – Typ: uint16_t, Einheit: 1/65535, Wertebereich: [6553 bis 216 - 1], Standardwert: 216 - 1
Rückgabe:
  • error_code – Typ: int

Setzt den Emissionsgrad, welcher zur Berechnung der Oberflächentemperatur benutzt wird, wie von temperature_ir_get_object_temperature() zurückgegeben.

Der Emissionsgrad wird normalerweise als Wert zwischen 0,0 und 1,0 angegeben. Eine Liste von Emissionsgraden unterschiedlicher Materialien ist hier zu finden.

Der Parameter von temperature_ir_set_emissivity() muss mit eine Faktor von 65535 (16-Bit) vorgegeben werden. Beispiel: Ein Emissionsgrad von 0,1 kann mit dem Wert 6553 gesetzt werden, ein Emissionsgrad von 0,5 mit dem Wert 32767 und so weiter.

Bemerkung

Wenn eine exakte Messung der Objekttemperatur notwendig ist, ist es entscheidend eine exakten Emissionsgrad anzugeben.

Der Emissionsgrad wird in nicht-flüchtigem Speicher gespeichert und wird auch noch einem Neustart weiter genutzt.

int temperature_ir_get_emissivity(TemperatureIR *temperature_ir, uint16_t *ret_emissivity)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
Ausgabeparameter:
  • ret_emissivity – Typ: uint16_t, Einheit: 1/65535, Wertebereich: [6553 bis 216 - 1], Standardwert: 216 - 1
Rückgabe:
  • error_code – Typ: int

Gibt den Emissionsgrad zurück, wie von temperature_ir_set_emissivity() gesetzt.

int temperature_ir_get_identity(TemperatureIR *temperature_ir, 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)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • ret_hardware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_firmware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

void temperature_ir_register_callback(TemperatureIR *temperature_ir, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
  • callback_id – Typ: int16_t
  • function – Typ: void (*)(void)
  • user_data – Typ: void *

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

int temperature_ir_set_ambient_temperature_callback_period(TemperatureIR *temperature_ir, uint32_t period)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt die Periode mit welcher der TEMPERATURE_IR_CALLBACK_AMBIENT_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der TEMPERATURE_IR_CALLBACK_AMBIENT_TEMPERATURE Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

int temperature_ir_get_ambient_temperature_callback_period(TemperatureIR *temperature_ir, uint32_t *ret_period)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt die Periode zurück, wie von temperature_ir_set_ambient_temperature_callback_period() gesetzt.

int temperature_ir_set_object_temperature_callback_period(TemperatureIR *temperature_ir, uint32_t period)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt die Periode mit welcher der TEMPERATURE_IR_CALLBACK_OBJECT_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der TEMPERATURE_IR_CALLBACK_OBJECT_TEMPERATURE Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

int temperature_ir_get_object_temperature_callback_period(TemperatureIR *temperature_ir, uint32_t *ret_period)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt die Periode zurück, wie von temperature_ir_set_object_temperature_callback_period() gesetzt.

int temperature_ir_set_ambient_temperature_callback_threshold(TemperatureIR *temperature_ir, char option, int16_t min, int16_t max)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt den Schwellwert für den TEMPERATURE_IR_CALLBACK_AMBIENT_TEMPERATURE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Umgebungstemperatur außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Umgebungstemperatur innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Umgebungstemperatur kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Umgebungstemperatur größer als der min Wert ist (max wird ignoriert)

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für option:

  • TEMPERATURE_IR_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_IR_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_IR_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_IR_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_IR_THRESHOLD_OPTION_GREATER = '>'
int temperature_ir_get_ambient_temperature_callback_threshold(TemperatureIR *temperature_ir, char *ret_option, int16_t *ret_min, int16_t *ret_max)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
Ausgabeparameter:
  • ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • ret_min – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • ret_max – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt den Schwellwert zurück, wie von temperature_ir_set_ambient_temperature_callback_threshold() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_option:

  • TEMPERATURE_IR_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_IR_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_IR_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_IR_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_IR_THRESHOLD_OPTION_GREATER = '>'
int temperature_ir_set_object_temperature_callback_threshold(TemperatureIR *temperature_ir, char option, int16_t min, int16_t max)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt den Schwellwert für den TEMPERATURE_IR_CALLBACK_OBJECT_TEMPERATURE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Objekttemperatur außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Objekttemperatur innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Objekttemperatur kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Objekttemperatur größer als der min Wert ist (max wird ignoriert)

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für option:

  • TEMPERATURE_IR_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_IR_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_IR_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_IR_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_IR_THRESHOLD_OPTION_GREATER = '>'
int temperature_ir_get_object_temperature_callback_threshold(TemperatureIR *temperature_ir, char *ret_option, int16_t *ret_min, int16_t *ret_max)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
Ausgabeparameter:
  • ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • ret_min – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • ret_max – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt den Schwellwert zurück, wie von temperature_ir_set_object_temperature_callback_threshold() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ret_option:

  • TEMPERATURE_IR_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_IR_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_IR_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_IR_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_IR_THRESHOLD_OPTION_GREATER = '>'
int temperature_ir_set_debounce_period(TemperatureIR *temperature_ir, uint32_t debounce)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
  • debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:
  • error_code – Typ: int

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

int temperature_ir_get_debounce_period(TemperatureIR *temperature_ir, uint32_t *ret_debounce)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
Ausgabeparameter:
  • ret_debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:
  • error_code – Typ: int

Gibt die Entprellperiode zurück, wie von temperature_ir_set_debounce_period() gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der temperature_ir_register_callback() Funktion durchgeführt werden:

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

temperature_ir_register_callback(&temperature_ir,
                                 TEMPERATURE_IR_CALLBACK_EXAMPLE,
                                 (void (*)(void))my_callback,
                                 NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

TEMPERATURE_IR_CALLBACK_AMBIENT_TEMPERATURE
void callback(int16_t temperature, void *user_data)
Callback-Parameter:
  • temperature – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit temperature_ir_set_ambient_temperature_callback_period(), ausgelöst. Der Parameter ist die Temperatur des Sensors.

Der TEMPERATURE_IR_CALLBACK_AMBIENT_TEMPERATURE Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

TEMPERATURE_IR_CALLBACK_OBJECT_TEMPERATURE
void callback(int16_t temperature, void *user_data)
Callback-Parameter:
  • temperature – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit temperature_ir_set_object_temperature_callback_period(), ausgelöst. Der Parameter ist die Objekttemperatur des Sensors.

Der TEMPERATURE_IR_CALLBACK_OBJECT_TEMPERATURE Callback wird nur ausgelöst, wenn sich die Objekttemperatur seit der letzten Auslösung geändert hat.

TEMPERATURE_IR_CALLBACK_AMBIENT_TEMPERATURE_REACHED
void callback(int16_t temperature, void *user_data)
Callback-Parameter:
  • temperature – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]
  • user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von temperature_ir_set_ambient_temperature_callback_threshold() gesetzt, erreicht wird. Der Parameter ist die Umgebungstemperatur des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit temperature_ir_set_debounce_period() gesetzt, ausgelöst.

TEMPERATURE_IR_CALLBACK_OBJECT_TEMPERATURE_REACHED
void callback(int16_t temperature, void *user_data)
Callback-Parameter:
  • temperature – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]
  • user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von temperature_ir_set_object_temperature_callback_threshold() gesetzt, erreicht wird. Der Parameter ist die Objekttemperatur des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit temperature_ir_set_debounce_period() gesetzt, ausgelöst.

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

int temperature_ir_get_api_version(TemperatureIR *temperature_ir, uint8_t ret_api_version[3])
Parameter:
  • temperature_ir – Typ: TemperatureIR *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

int temperature_ir_get_response_expected(TemperatureIR *temperature_ir, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels temperature_ir_set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

  • TEMPERATURE_IR_FUNCTION_SET_EMISSIVITY = 3
  • TEMPERATURE_IR_FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
  • TEMPERATURE_IR_FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
  • TEMPERATURE_IR_FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
  • TEMPERATURE_IR_FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
  • TEMPERATURE_IR_FUNCTION_SET_DEBOUNCE_PERIOD = 13
int temperature_ir_set_response_expected(TemperatureIR *temperature_ir, uint8_t function_id, bool response_expected)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

  • TEMPERATURE_IR_FUNCTION_SET_EMISSIVITY = 3
  • TEMPERATURE_IR_FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
  • TEMPERATURE_IR_FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
  • TEMPERATURE_IR_FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
  • TEMPERATURE_IR_FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
  • TEMPERATURE_IR_FUNCTION_SET_DEBOUNCE_PERIOD = 13
int temperature_ir_set_response_expected_all(TemperatureIR *temperature_ir, bool response_expected)
Parameter:
  • temperature_ir – Typ: TemperatureIR *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

TEMPERATURE_IR_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Temperature IR Bricklet zu identifizieren.

Die temperature_ir_get_identity() Funktion und der IPCON_CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

TEMPERATURE_IR_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Temperature IR Bricklet dar.