C/C++ - Temperature IR Bricklet 2.0

Dies ist die Beschreibung der C/C++ API Bindings für das Temperature IR Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Temperature IR Bricklet 2.0 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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_temperature_ir_v2.h"

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

// 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
    TemperatureIRV2 tir;
    temperature_ir_v2_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_v2_register_callback(&tir,
                                        TEMPERATURE_IR_V2_CALLBACK_OBJECT_TEMPERATURE,
                                        (void (*)(void))cb_object_temperature,
                                        NULL);

    // Set period for object temperature callback to 1s (1000ms) without a threshold
    temperature_ir_v2_set_object_temperature_callback_configuration(&tir, 1000, false, 'x', 0, 0);

    printf("Press key to exit\n");
    getchar();
    temperature_ir_v2_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_v2.h"

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

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

    // Create device object
    TemperatureIRV2 tir;
    temperature_ir_v2_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_v2_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_v2_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_v2_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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_temperature_ir_v2.h"

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

// Callback function for object temperature reached 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);
    printf("The water is boiling!\n");
}

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

    // Create device object
    TemperatureIRV2 tir;
    temperature_ir_v2_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_v2_set_emissivity(&tir, 64224);

    // Register object temperature reached callback to function cb_object_temperature
    temperature_ir_v2_register_callback(&tir,
                                        TEMPERATURE_IR_V2_CALLBACK_OBJECT_TEMPERATURE,
                                        (void (*)(void))cb_object_temperature,
                                        NULL);

    // Configure threshold for object temperature "greater than 100 °C"
    // with a debounce period of 10s (10000ms)
    temperature_ir_v2_set_object_temperature_callback_configuration(&tir, 10000, false, '>', 100*10, 0);

    printf("Press key to exit\n");
    getchar();
    temperature_ir_v2_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 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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void temperature_ir_v2_create(TemperatureIRV2 *temperature_ir_v2, const char *uid, IPConnection *ipcon)

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

TemperatureIRV2 temperature_ir_v2;
temperature_ir_v2_create(&temperature_ir_v2, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden wurde (siehe Beispiele oben).

void temperature_ir_v2_destroy(TemperatureIRV2 *temperature_ir_v2)

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

int temperature_ir_v2_get_ambient_temperature(TemperatureIRV2 *temperature_ir_v2, int16_t *ret_temperature)

Gibt die Umgebungstemperatur des Sensors zurück. Der Wertebereich ist von -400 bis 1250 und wird in °C/10 angegeben, z.B. bedeutet ein Wert von 423 eine gemessene Umgebungstemperatur von 42,3 °C.

Wenn der Wert periodisch benötigt wird, kann auch der TEMPERATURE_IR_V2_CALLBACK_AMBIENT_TEMPERATURE Callback verwendet werden. Der Callback wird mit der Funktion temperature_ir_v2_set_ambient_temperature_callback_configuration() konfiguriert.

int temperature_ir_v2_get_object_temperature(TemperatureIRV2 *temperature_ir_v2, int16_t *ret_temperature)

Gibt die Objekttemperatur des Sensors zurück, z.B. die Temperatur der Oberfläche auf welche der Sensor zielt. Der Wertebereich ist von -700 bis 3800 und wird in °C/10 angegeben, z.B. bedeutet ein Wert von 3001 eine gemessene Temperatur von 300,1 °C auf der Oberfläche des Objektes.

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

Wenn der Wert periodisch benötigt wird, kann auch der TEMPERATURE_IR_V2_CALLBACK_OBJECT_TEMPERATURE Callback verwendet werden. Der Callback wird mit der Funktion temperature_ir_v2_set_object_temperature_callback_configuration() konfiguriert.

Fortgeschrittene Funktionen

int temperature_ir_v2_set_emissivity(TemperatureIRV2 *temperature_ir_v2, uint16_t emissivity)

Setzt den Emissionsgrad, welcher zur Berechnung der Oberflächentemperatur benutzt wird, wie von temperature_ir_v2_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_v2_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 Standard Emissionsgrad ist 1,0 (Wert von 65535) und der minimale Emissionsgrad welcher der Sensor verarbeiten kann ist 0,1 (Wert von 6553).

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

int temperature_ir_v2_get_emissivity(TemperatureIRV2 *temperature_ir_v2, uint16_t *ret_emissivity)

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

int temperature_ir_v2_get_api_version(TemperatureIRV2 *temperature_ir_v2, uint8_t ret_api_version[3])

Gibt die Version der API Definition (Major, Minor, Revision) 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_v2_get_response_expected(TemperatureIRV2 *temperature_ir_v2, uint8_t function_id, bool *ret_response_expected)

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_v2_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:

  • TEMPERATURE_IR_V2_FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_CONFIGURATION = 2
  • TEMPERATURE_IR_V2_FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_CONFIGURATION = 6
  • TEMPERATURE_IR_V2_FUNCTION_SET_EMISSIVITY = 9
  • TEMPERATURE_IR_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • TEMPERATURE_IR_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • TEMPERATURE_IR_V2_FUNCTION_RESET = 243
  • TEMPERATURE_IR_V2_FUNCTION_WRITE_UID = 248
int temperature_ir_v2_set_response_expected(TemperatureIRV2 *temperature_ir_v2, uint8_t function_id, bool response_expected)

Ä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:

  • TEMPERATURE_IR_V2_FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_CONFIGURATION = 2
  • TEMPERATURE_IR_V2_FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_CONFIGURATION = 6
  • TEMPERATURE_IR_V2_FUNCTION_SET_EMISSIVITY = 9
  • TEMPERATURE_IR_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • TEMPERATURE_IR_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • TEMPERATURE_IR_V2_FUNCTION_RESET = 243
  • TEMPERATURE_IR_V2_FUNCTION_WRITE_UID = 248
int temperature_ir_v2_set_response_expected_all(TemperatureIRV2 *temperature_ir_v2, bool response_expected)

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

int temperature_ir_v2_get_spitfp_error_count(TemperatureIRV2 *temperature_ir_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)

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

int temperature_ir_v2_set_bootloader_mode(TemperatureIRV2 *temperature_ir_v2, uint8_t mode, uint8_t *ret_status)

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

  • TEMPERATURE_IR_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • TEMPERATURE_IR_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • TEMPERATURE_IR_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • TEMPERATURE_IR_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • TEMPERATURE_IR_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • TEMPERATURE_IR_V2_BOOTLOADER_STATUS_OK = 0
  • TEMPERATURE_IR_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • TEMPERATURE_IR_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • TEMPERATURE_IR_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • TEMPERATURE_IR_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • TEMPERATURE_IR_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int temperature_ir_v2_get_bootloader_mode(TemperatureIRV2 *temperature_ir_v2, uint8_t *ret_mode)

Gibt den aktuellen Bootloader-Modus zurück, siehe temperature_ir_v2_set_bootloader_mode().

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

  • TEMPERATURE_IR_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • TEMPERATURE_IR_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • TEMPERATURE_IR_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • TEMPERATURE_IR_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • TEMPERATURE_IR_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int temperature_ir_v2_set_write_firmware_pointer(TemperatureIRV2 *temperature_ir_v2, uint32_t pointer)

Setzt den Firmware-Pointer für temperature_ir_v2_write_firmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int temperature_ir_v2_write_firmware(TemperatureIRV2 *temperature_ir_v2, uint8_t data[64], uint8_t *ret_status)

Schreibt 64 Bytes Firmware an die Position die vorher von temperature_ir_v2_set_write_firmware_pointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int temperature_ir_v2_set_status_led_config(TemperatureIRV2 *temperature_ir_v2, uint8_t config)

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

  • TEMPERATURE_IR_V2_STATUS_LED_CONFIG_OFF = 0
  • TEMPERATURE_IR_V2_STATUS_LED_CONFIG_ON = 1
  • TEMPERATURE_IR_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • TEMPERATURE_IR_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int temperature_ir_v2_get_status_led_config(TemperatureIRV2 *temperature_ir_v2, uint8_t *ret_config)

Gibt die Konfiguration zurück, wie von temperature_ir_v2_set_status_led_config() gesetzt.

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

  • TEMPERATURE_IR_V2_STATUS_LED_CONFIG_OFF = 0
  • TEMPERATURE_IR_V2_STATUS_LED_CONFIG_ON = 1
  • TEMPERATURE_IR_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • TEMPERATURE_IR_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int temperature_ir_v2_get_chip_temperature(TemperatureIRV2 *temperature_ir_v2, int16_t *ret_temperature)

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

int temperature_ir_v2_reset(TemperatureIRV2 *temperature_ir_v2)

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

int temperature_ir_v2_write_uid(TemperatureIRV2 *temperature_ir_v2, uint32_t uid)

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

int temperature_ir_v2_read_uid(TemperatureIRV2 *temperature_ir_v2, uint32_t *ret_uid)

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

int temperature_ir_v2_get_identity(TemperatureIRV2 *temperature_ir_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)

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 kann 'a', 'b', 'c' oder 'd' sein.

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_v2_register_callback(TemperatureIRV2 *temperature_ir_v2, int16_t callback_id, void (*function)(void), void *user_data)

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_v2_set_ambient_temperature_callback_configuration(TemperatureIRV2 *temperature_ir_v2, uint32_t period, bool value_has_to_change, char option, int16_t min, int16_t max)

Die Periode in ms ist die Periode mit der der TEMPERATURE_IR_V2_CALLBACK_AMBIENT_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den TEMPERATURE_IR_V2_CALLBACK_AMBIENT_TEMPERATURE Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_GREATER = '>'
int temperature_ir_v2_get_ambient_temperature_callback_configuration(TemperatureIRV2 *temperature_ir_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int16_t *ret_min, int16_t *ret_max)

Gibt die Callback-Konfiguration zurück, wie mittels temperature_ir_v2_set_ambient_temperature_callback_configuration() gesetzt.

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

  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_GREATER = '>'
int temperature_ir_v2_set_object_temperature_callback_configuration(TemperatureIRV2 *temperature_ir_v2, uint32_t period, bool value_has_to_change, char option, int16_t min, int16_t max)

Die Periode in ms ist die Periode mit der der TEMPERATURE_IR_V2_CALLBACK_OBJECT_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den TEMPERATURE_IR_V2_CALLBACK_OBJECT_TEMPERATURE Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_GREATER = '>'
int temperature_ir_v2_get_object_temperature_callback_configuration(TemperatureIRV2 *temperature_ir_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int16_t *ret_min, int16_t *ret_max)

Gibt die Callback-Konfiguration zurück, wie mittels temperature_ir_v2_set_object_temperature_callback_configuration() gesetzt.

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

  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_IR_V2_THRESHOLD_OPTION_GREATER = '>'

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion temperature_ir_v2_register_callback() durchgeführt werden. Die Parameter bestehen aus dem Geräteobjekt, der Callback ID, der Callback Funktion und optionalen Benutzer Daten:

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

temperature_ir_v2_register_callback(&temperature_ir_v2, TEMPERATURE_IR_V2_CALLBACK_EXAMPLE, (void (*)(void))my_callback, NULL);

Die verfügbaren IDs mit den zugehörigen Callback 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_V2_CALLBACK_AMBIENT_TEMPERATURE
void callback(int16_t temperature, void *user_data)

Dieser Callback wird periodisch ausgelöst abhängig von der mittels temperature_ir_v2_set_ambient_temperature_callback_configuration() gesetzten Konfiguration

Der Parameter ist der gleiche wie temperature_ir_v2_get_ambient_temperature().

TEMPERATURE_IR_V2_CALLBACK_OBJECT_TEMPERATURE
void callback(int16_t temperature, void *user_data)

Dieser Callback wird periodisch ausgelöst abhängig von der mittels temperature_ir_v2_set_object_temperature_callback_configuration() gesetzten Konfiguration

Der Parameter ist der gleiche wie temperature_ir_v2_get_object_temperature().

Konstanten

TEMPERATURE_IR_V2_DEVICE_IDENTIFIER

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

Die temperature_ir_v2_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_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Temperature IR Bricklet 2.0 dar.