C/C++ - CO2 Bricklet

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

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

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

    // Create device object
    CO2 co2;
    co2_create(&co2, 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 CO2 concentration
    uint16_t co2_concentration;
    if(co2_get_co2_concentration(&co2, &co2_concentration) < 0) {
        fprintf(stderr, "Could not get CO2 concentration, probably timeout\n");
        return 1;
    }

    printf("CO2 Concentration: %u ppm\n", co2_concentration);

    printf("Press key to exit\n");
    getchar();
    co2_destroy(&co2);
    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_co2.h"

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

// Callback function for CO2 concentration callback
void cb_co2_concentration(uint16_t co2_concentration, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("CO2 Concentration: %u ppm\n", co2_concentration);
}

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

    // Create device object
    CO2 co2;
    co2_create(&co2, 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 CO2 concentration callback to function cb_co2_concentration
    co2_register_callback(&co2,
                          CO2_CALLBACK_CO2_CONCENTRATION,
                          (void *)cb_co2_concentration,
                          NULL);

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

    printf("Press key to exit\n");
    getchar();
    co2_destroy(&co2);
    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_co2.h"

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

// Callback function for CO2 concentration reached callback
void cb_co2_concentration_reached(uint16_t co2_concentration, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("CO2 Concentration: %u ppm\n", co2_concentration);
}

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

    // Create device object
    CO2 co2;
    co2_create(&co2, 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)
    co2_set_debounce_period(&co2, 10000);

    // Register CO2 concentration reached callback to function
    // cb_co2_concentration_reached
    co2_register_callback(&co2,
                          CO2_CALLBACK_CO2_CONCENTRATION_REACHED,
                          (void *)cb_co2_concentration_reached,
                          NULL);

    // Configure threshold for CO2 concentration "greater than 750 ppm"
    co2_set_co2_concentration_callback_threshold(&co2, '>', 750, 0);

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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void co2_create(CO2 *co2, const char *uid, IPConnection *ipcon)

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

CO2 co2;
co2_create(&co2, "YOUR_DEVICE_UID", &ipcon);

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

void co2_destroy(CO2 *co2)

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

int co2_get_co2_concentration(CO2 *co2, uint16_t *ret_co2_concentration)

Gibt die gemessene CO2-Konzentration zurück. Der Wert ist in ppm (Teile pro Million) und im Bereich von 0 bis 10000.

Wenn die CO2-Konzentration periodisch abgefragt werden soll, wird empfohlen den CO2_CALLBACK_CO2_CONCENTRATION Callback zu nutzen und die Periode mit co2_set_co2_concentration_callback_period() vorzugeben.

Fortgeschrittene Funktionen

int co2_get_api_version(CO2 *co2, 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 co2_get_response_expected(CO2 *co2, 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 co2_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.

Siehe co2_set_response_expected() für die Liste der verfügbaren Funktions ID Defines für diese Funktion.

int co2_set_response_expected(CO2 *co2, 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 Funktions ID Defines sind für diese Funktion verfügbar:

  • CO2_FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD = 2
  • CO2_FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD = 4
  • CO2_FUNCTION_SET_DEBOUNCE_PERIOD = 6
int co2_set_response_expected_all(CO2 *co2, bool response_expected)

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

int co2_get_identity(CO2 *co2, 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 co2_register_callback(CO2 *co2, int16_t callback_id, void *function, 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 co2_set_co2_concentration_callback_period(CO2 *co2, uint32_t period)

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

Der CO2_CALLBACK_CO2_CONCENTRATION Callback wird nur ausgelöst wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

int co2_get_co2_concentration_callback_period(CO2 *co2, uint32_t *ret_period)

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

int co2_set_co2_concentration_callback_threshold(CO2 *co2, char option, uint16_t min, uint16_t max)

Setzt den Schwellwert für den CO2_CALLBACK_CO2_CONCENTRATION_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

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

  • CO2_THRESHOLD_OPTION_OFF = 'x'
  • CO2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • CO2_THRESHOLD_OPTION_INSIDE = 'i'
  • CO2_THRESHOLD_OPTION_SMALLER = '<'
  • CO2_THRESHOLD_OPTION_GREATER = '>'
int co2_get_co2_concentration_callback_threshold(CO2 *co2, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)

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

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

  • CO2_THRESHOLD_OPTION_OFF = 'x'
  • CO2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • CO2_THRESHOLD_OPTION_INSIDE = 'i'
  • CO2_THRESHOLD_OPTION_SMALLER = '<'
  • CO2_THRESHOLD_OPTION_GREATER = '>'
int co2_set_debounce_period(CO2 *co2, uint32_t debounce)

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

int co2_get_debounce_period(CO2 *co2, uint32_t *ret_debounce)

Gibt die Entprellperiode zurück, wie von co2_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 co2_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);
}

co2_register_callback(&co2, CO2_CALLBACK_EXAMPLE, (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.

CO2_CALLBACK_CO2_CONCENTRATION
void callback(uint16_t co2_concentration, void *user_data)

Dieser Callback wird mit der Periode, wie gesetzt mit co2_set_co2_concentration_callback_period(), ausgelöst. Der Parameter ist die gemessene CO2-Konzentration des Sensors.

Der CO2_CALLBACK_CO2_CONCENTRATION Callback wird nur ausgelöst wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

CO2_CALLBACK_CO2_CONCENTRATION_REACHED
void callback(uint16_t co2_concentration, void *user_data)

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von co2_set_co2_concentration_callback_threshold() gesetzt, erreicht wird. Der Parameter ist die gemessene CO2-Konzentration.

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

Konstanten

CO2_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein CO2 Bricklet zu identifizieren.

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

CO2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines CO2 Bricklet dar.