C/C++ - Thermocouple Bricklet 2.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_thermocouple_v2.h"

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

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

    // Create device object
    ThermocoupleV2 t;
    thermocouple_v2_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
    int32_t temperature;
    if(thermocouple_v2_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();
    thermocouple_v2_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

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_thermocouple_v2.h"

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

// Callback function for temperature callback
void cb_temperature(int32_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
    ThermocoupleV2 t;
    thermocouple_v2_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
    thermocouple_v2_register_callback(&t,
                                      THERMOCOUPLE_V2_CALLBACK_TEMPERATURE,
                                      (void (*)(void))cb_temperature,
                                      NULL);

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

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

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_thermocouple_v2.h"

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

// Callback function for temperature callback
void cb_temperature(int32_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
    ThermocoupleV2 t;
    thermocouple_v2_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
    thermocouple_v2_register_callback(&t,
                                      THERMOCOUPLE_V2_CALLBACK_TEMPERATURE,
                                      (void (*)(void))cb_temperature,
                                      NULL);

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

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

Grundfunktionen¶

void thermocouple_v2_create(ThermocoupleV2 *thermocouple_v2, const char *uid, IPConnection *ipcon)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 * uid – Typ: const char * ipcon – Typ: IPConnection *

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

ThermocoupleV2 thermocouple_v2;
thermocouple_v2_create(&thermocouple_v2, "YOUR_DEVICE_UID", &ipcon);

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

void thermocouple_v2_destroy(ThermocoupleV2 *thermocouple_v2)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 *

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

int thermocouple_v2_get_temperature(ThermocoupleV2 *thermocouple_v2, int32_t *ret_temperature)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 *
Ausgabeparameter:	ret_temperature – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-21000 bis 180000]
Rückgabe:	e_code – Typ: int

Gibt die Temperatur des Thermoelements zurück. Der Wert wird in °C/100 angegeben, z.B. bedeutet ein Wert von 4223 eine gemessene Temperatur von 42,23 °C.

Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen den THERMOCOUPLE_V2_CALLBACK_TEMPERATURE Callback zu nutzen und die Periode mit thermocouple_v2_set_temperature_callback_configuration() vorzugeben.

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

Fortgeschrittene Funktionen¶

int thermocouple_v2_set_configuration(ThermocoupleV2 *thermocouple_v2, uint8_t averaging, uint8_t thermocouple_type, uint8_t filter)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 * averaging – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 16 thermocouple_type – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3 filter – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Konfiguriert werden können Averaging-Größe, Thermoelement-Typ und Frequenz-Filterung.

Mögliche Averaging-Größen sind 1, 2, 4, 8 und 16 Samples.

Als Thermoelement-Typ stehen B, E, J, K, N, R, S und T zur Verfügung. Falls ein anderes Thermoelement benutzt werden soll, können G8 und G32 genutzt werden. Mit diesen Typen wird der Wert nicht in °C/100 zurückgegeben sondern er wird durch folgende Formeln bestimmt:

• G8: Wert = 8 * 1.6 * 2^17 * Vin
• G32: Wert = 32 * 1.6 * 2^17 * Vin

dabei ist Vin die Eingangsspannung des Thermoelements.

Der Frequenz-Filter kann auf 50Hz und 60Hz konfiguriert werden. Er sollte abhängig von der lokalen Netzfrequenz gewählt werden.

Die Konvertierungszeit ist abhängig von der Averaging-Größe und der Frequenz-Filter-Konfiguration. Sie kann wie folgt bestimmt werden:

• 60Hz: Zeit = 82 + (Samples - 1) * 16.67
• 50Hz: Zeit = 98 + (Samples - 1) * 20

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

Für averaging:

• THERMOCOUPLE_V2_AVERAGING_1 = 1
• THERMOCOUPLE_V2_AVERAGING_2 = 2
• THERMOCOUPLE_V2_AVERAGING_4 = 4
• THERMOCOUPLE_V2_AVERAGING_8 = 8
• THERMOCOUPLE_V2_AVERAGING_16 = 16

Für thermocouple_type:

• THERMOCOUPLE_V2_TYPE_B = 0
• THERMOCOUPLE_V2_TYPE_E = 1
• THERMOCOUPLE_V2_TYPE_J = 2
• THERMOCOUPLE_V2_TYPE_K = 3
• THERMOCOUPLE_V2_TYPE_N = 4
• THERMOCOUPLE_V2_TYPE_R = 5
• THERMOCOUPLE_V2_TYPE_S = 6
• THERMOCOUPLE_V2_TYPE_T = 7
• THERMOCOUPLE_V2_TYPE_G8 = 8
• THERMOCOUPLE_V2_TYPE_G32 = 9

Für filter:

• THERMOCOUPLE_V2_FILTER_OPTION_50HZ = 0
• THERMOCOUPLE_V2_FILTER_OPTION_60HZ = 1

int thermocouple_v2_get_configuration(ThermocoupleV2 *thermocouple_v2, uint8_t *ret_averaging, uint8_t *ret_thermocouple_type, uint8_t *ret_filter)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 *
Ausgabeparameter:	ret_averaging – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 16 ret_thermocouple_type – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3 ret_filter – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_averaging:

• THERMOCOUPLE_V2_AVERAGING_1 = 1
• THERMOCOUPLE_V2_AVERAGING_2 = 2
• THERMOCOUPLE_V2_AVERAGING_4 = 4
• THERMOCOUPLE_V2_AVERAGING_8 = 8
• THERMOCOUPLE_V2_AVERAGING_16 = 16

Für ret_thermocouple_type:

• THERMOCOUPLE_V2_TYPE_B = 0
• THERMOCOUPLE_V2_TYPE_E = 1
• THERMOCOUPLE_V2_TYPE_J = 2
• THERMOCOUPLE_V2_TYPE_K = 3
• THERMOCOUPLE_V2_TYPE_N = 4
• THERMOCOUPLE_V2_TYPE_R = 5
• THERMOCOUPLE_V2_TYPE_S = 6
• THERMOCOUPLE_V2_TYPE_T = 7
• THERMOCOUPLE_V2_TYPE_G8 = 8
• THERMOCOUPLE_V2_TYPE_G32 = 9

Für ret_filter:

• THERMOCOUPLE_V2_FILTER_OPTION_50HZ = 0
• THERMOCOUPLE_V2_FILTER_OPTION_60HZ = 1

int thermocouple_v2_get_error_state(ThermocoupleV2 *thermocouple_v2, bool *ret_over_under, bool *ret_open_circuit)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 *
Ausgabeparameter:	ret_over_under – Typ: bool ret_open_circuit – Typ: bool
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Error-Status zurück. Es gibt zwei mögliche Status:

• Over/Under Voltage und
• Open Circuit.

Over/Under Voltage bei Spannungen unter 0V oder über 3.3V ausgelöst. In diesem Fall ist mit hoher Wahrscheinlichkeit das Thermoelement defekt. Ein Open Circuit-Error deutet darauf hin, das kein Thermoelement angeschlossen ist.

Der THERMOCOUPLE_V2_CALLBACK_ERROR_STATE Callback wird automatisch jedes mal ausgelöst, wenn sich der Error-Status ändert.

int thermocouple_v2_get_spitfp_error_count(ThermocoupleV2 *thermocouple_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)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 232 - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_code – Typ: int

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 thermocouple_v2_set_status_led_config(ThermocoupleV2 *thermocouple_v2, uint8_t config)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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:

Für config:

• THERMOCOUPLE_V2_STATUS_LED_CONFIG_OFF = 0
• THERMOCOUPLE_V2_STATUS_LED_CONFIG_ON = 1
• THERMOCOUPLE_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• THERMOCOUPLE_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int thermocouple_v2_get_status_led_config(ThermocoupleV2 *thermocouple_v2, uint8_t *ret_config)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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

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

Für ret_config:

• THERMOCOUPLE_V2_STATUS_LED_CONFIG_OFF = 0
• THERMOCOUPLE_V2_STATUS_LED_CONFIG_ON = 1
• THERMOCOUPLE_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• THERMOCOUPLE_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int thermocouple_v2_get_chip_temperature(ThermocoupleV2 *thermocouple_v2, int16_t *ret_temperature)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
Rückgabe:	e_code – Typ: int

Gibt die Temperatur, 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 thermocouple_v2_reset(ThermocoupleV2 *thermocouple_v2)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 *
Rückgabe:	e_code – Typ: int

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 thermocouple_v2_get_identity(ThermocoupleV2 *thermocouple_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)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', '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:	e_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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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 thermocouple_v2_register_callback(ThermocoupleV2 *thermocouple_v2, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 * 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 thermocouple_v2_set_temperature_callback_configuration(ThermocoupleV2 *thermocouple_v2, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)¶

Parameter:

thermocouple_v2 – Typ: ThermocoupleV2 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Rückgabe:

e_code – Typ: int

Die Periode ist die Periode mit der der THERMOCOUPLE_V2_CALLBACK_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 THERMOCOUPLE_V2_CALLBACK_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.

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

Für option:

• THERMOCOUPLE_V2_THRESHOLD_OPTION_OFF = 'x'
• THERMOCOUPLE_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
• THERMOCOUPLE_V2_THRESHOLD_OPTION_INSIDE = 'i'
• THERMOCOUPLE_V2_THRESHOLD_OPTION_SMALLER = '<'
• THERMOCOUPLE_V2_THRESHOLD_OPTION_GREATER = '>'

int thermocouple_v2_get_temperature_callback_configuration(ThermocoupleV2 *thermocouple_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' ret_min – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 ret_max – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_option:

• THERMOCOUPLE_V2_THRESHOLD_OPTION_OFF = 'x'
• THERMOCOUPLE_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
• THERMOCOUPLE_V2_THRESHOLD_OPTION_INSIDE = 'i'
• THERMOCOUPLE_V2_THRESHOLD_OPTION_SMALLER = '<'
• THERMOCOUPLE_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 thermocouple_v2_register_callback() Funktion durchgeführt werden:

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

thermocouple_v2_register_callback(&thermocouple_v2,
                                  THERMOCOUPLE_V2_CALLBACK_EXAMPLE,
                                  (void (*)(void))my_callback,
                                  NULL);

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

THERMOCOUPLE_V2_CALLBACK_TEMPERATURE¶

void callback(int32_t temperature, void *user_data)

Callback-Parameter:	temperature – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-21000 bis 180000] user_data – Typ: void *

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

Der Parameter ist der gleiche wie thermocouple_v2_get_temperature().

THERMOCOUPLE_V2_CALLBACK_ERROR_STATE¶

void callback(bool over_under, bool open_circuit, void *user_data)

Callback-Parameter:	over_under – Typ: bool open_circuit – Typ: bool user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Error-Status sich verändert (siehe thermocouple_v2_get_error_state()).

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 thermocouple_v2_get_api_version(ThermocoupleV2 *thermocouple_v2, uint8_t ret_api_version[3])¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 *
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:	e_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 thermocouple_v2_get_response_expected(ThermocoupleV2 *thermocouple_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_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 thermocouple_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:

Für function_id:

• THERMOCOUPLE_V2_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 2
• THERMOCOUPLE_V2_FUNCTION_SET_CONFIGURATION = 5
• THERMOCOUPLE_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• THERMOCOUPLE_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
• THERMOCOUPLE_V2_FUNCTION_RESET = 243
• THERMOCOUPLE_V2_FUNCTION_WRITE_UID = 248

int thermocouple_v2_set_response_expected(ThermocoupleV2 *thermocouple_v2, uint8_t function_id, bool response_expected)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_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:

• THERMOCOUPLE_V2_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 2
• THERMOCOUPLE_V2_FUNCTION_SET_CONFIGURATION = 5
• THERMOCOUPLE_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• THERMOCOUPLE_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
• THERMOCOUPLE_V2_FUNCTION_RESET = 243
• THERMOCOUPLE_V2_FUNCTION_WRITE_UID = 248

int thermocouple_v2_set_response_expected_all(ThermocoupleV2 *thermocouple_v2, bool response_expected)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

int thermocouple_v2_set_bootloader_mode(ThermocoupleV2 *thermocouple_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für mode:

• THERMOCOUPLE_V2_BOOTLOADER_MODE_BOOTLOADER = 0
• THERMOCOUPLE_V2_BOOTLOADER_MODE_FIRMWARE = 1
• THERMOCOUPLE_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• THERMOCOUPLE_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• THERMOCOUPLE_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

• THERMOCOUPLE_V2_BOOTLOADER_STATUS_OK = 0
• THERMOCOUPLE_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
• THERMOCOUPLE_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
• THERMOCOUPLE_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• THERMOCOUPLE_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• THERMOCOUPLE_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int thermocouple_v2_get_bootloader_mode(ThermocoupleV2 *thermocouple_v2, uint8_t *ret_mode)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

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

Für ret_mode:

• THERMOCOUPLE_V2_BOOTLOADER_MODE_BOOTLOADER = 0
• THERMOCOUPLE_V2_BOOTLOADER_MODE_FIRMWARE = 1
• THERMOCOUPLE_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• THERMOCOUPLE_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• THERMOCOUPLE_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int thermocouple_v2_set_write_firmware_pointer(ThermocoupleV2 *thermocouple_v2, uint32_t pointer)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für thermocouple_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 thermocouple_v2_write_firmware(ThermocoupleV2 *thermocouple_v2, uint8_t data[64], uint8_t *ret_status)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 * data – Typ: uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von thermocouple_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 thermocouple_v2_write_uid(ThermocoupleV2 *thermocouple_v2, uint32_t uid)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 * uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_code – Typ: int

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 thermocouple_v2_read_uid(ThermocoupleV2 *thermocouple_v2, uint32_t *ret_uid)¶

Parameter:	thermocouple_v2 – Typ: ThermocoupleV2 *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_code – Typ: int

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

Konstanten¶

THERMOCOUPLE_V2_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Thermocouple Bricklet 2.0 zu identifizieren.

Die thermocouple_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.

THERMOCOUPLE_V2_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Thermocouple Bricklet 2.0 dar.