C/C++ - Temperature Bricklet

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

Simple

Download (example_simple.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
#include <stdio.h>

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

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

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

    // Create device object
    Temperature t;
    temperature_create(&t, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

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

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

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

Callback

Download (example_callback.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
#include <stdio.h>

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

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

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

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

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

    // Create device object
    Temperature t;
    temperature_create(&t, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Register temperature callback to function cb_temperature
    temperature_register_callback(&t,
                                  TEMPERATURE_CALLBACK_TEMPERATURE,
                                  (void (*)(void))cb_temperature,
                                  NULL);

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

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

Threshold

Download (example_threshold.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
#include <stdio.h>

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

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

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

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

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

    // Create device object
    Temperature t;
    temperature_create(&t, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

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

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

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

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

API

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_create(Temperature *temperature, const char *uid, IPConnection *ipcon)

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

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

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

void temperature_destroy(Temperature *temperature)

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

int temperature_get_temperature(Temperature *temperature, int16_t *ret_temperature)

Gibt die Temperatur des Sensors zurück. Der Wertebereich ist von -2500 bis 8500 und 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 TEMPERATURE_CALLBACK_TEMPERATURE Callback zu nutzen und die Periode mit temperature_set_temperature_callback_period() vorzugeben.

Fortgeschrittene Funktionen

int temperature_set_i2c_mode(Temperature *temperature, uint8_t mode)

Setzt den I2C Modus. Mögliche Modi sind:

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

Wenn Probleme mit offensichtlichen Ausreißern in den Temperature Bricklet Messungen auftreten, können diese eventuell aufgrund von elektromagnetischen Störungen sein. In diesem Fall kann es helfen die I2C Geschwindigkeit zu verringern.

Falls in einem System ein hoher Durchsatz an Nachrichten erwünscht ist, sollte die I2C Geschwindigkeit allerdings nicht verringert werden.

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

  • TEMPERATURE_I2C_MODE_FAST = 0
  • TEMPERATURE_I2C_MODE_SLOW = 1

Neu in Version 2.0.1 (Plugin).

int temperature_get_i2c_mode(Temperature *temperature, uint8_t *ret_mode)

Gibt den I2C Modus zurück, wie von temperature_set_i2c_mode() gesetzt.

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

  • TEMPERATURE_I2C_MODE_FAST = 0
  • TEMPERATURE_I2C_MODE_SLOW = 1

Neu in Version 2.0.1 (Plugin).

int temperature_get_api_version(Temperature *temperature, 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_get_response_expected(Temperature *temperature, 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_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_FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
  • TEMPERATURE_FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
  • TEMPERATURE_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • TEMPERATURE_FUNCTION_SET_I2C_MODE = 10
int temperature_set_response_expected(Temperature *temperature, 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_FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
  • TEMPERATURE_FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
  • TEMPERATURE_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • TEMPERATURE_FUNCTION_SET_I2C_MODE = 10
int temperature_set_response_expected_all(Temperature *temperature, bool response_expected)

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

int temperature_get_identity(Temperature *temperature, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)

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_register_callback(Temperature *temperature, 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_set_temperature_callback_period(Temperature *temperature, uint32_t period)

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

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

Der Standardwert ist 0.

int temperature_get_temperature_callback_period(Temperature *temperature, uint32_t *ret_period)

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

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

Setzt den Schwellwert für den TEMPERATURE_CALLBACK_TEMPERATURE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

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

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

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

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

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

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

int temperature_get_debounce_period(Temperature *temperature, uint32_t *ret_debounce)

Gibt die Entprellperiode zurück, wie von temperature_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 Funktion temperature_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_register_callback(&temperature, TEMPERATURE_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_CALLBACK_TEMPERATURE
void callback(int16_t temperature, void *user_data)

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

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

TEMPERATURE_CALLBACK_TEMPERATURE_REACHED
void callback(int16_t temperature, void *user_data)

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

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

Konstanten

TEMPERATURE_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Temperature Bricklet zu identifizieren.

Die temperature_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_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Temperature Bricklet dar.