C/C++ - Air Quality Bricklet

Dies ist die Beschreibung der C/C++ API Bindings für das Air Quality Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Air Quality 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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_air_quality.h"

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

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

    // Create device object
    AirQuality aq;
    air_quality_create(&aq, 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 all values
    int32_t iaq_index, temperature, humidity, air_pressure; uint8_t iaq_index_accuracy;
    if(air_quality_get_all_values(&aq, &iaq_index, &iaq_index_accuracy, &temperature,
                                  &humidity, &air_pressure) < 0) {
        fprintf(stderr, "Could not get all values, probably timeout\n");
        return 1;
    }

    printf("IAQ Index: %d\n", iaq_index);

    if(iaq_index_accuracy == AIR_QUALITY_ACCURACY_UNRELIABLE) {
        printf("IAQ Index Accuracy: Unreliable\n");
    } else if(iaq_index_accuracy == AIR_QUALITY_ACCURACY_LOW) {
        printf("IAQ Index Accuracy: Low\n");
    } else if(iaq_index_accuracy == AIR_QUALITY_ACCURACY_MEDIUM) {
        printf("IAQ Index Accuracy: Medium\n");
    } else if(iaq_index_accuracy == AIR_QUALITY_ACCURACY_HIGH) {
        printf("IAQ Index Accuracy: High\n");
    }

    printf("Temperature: %f °C\n", temperature/100.0);
    printf("Humidity: %f %%RH\n", humidity/100.0);
    printf("Air Pressure: %f mbar\n", air_pressure/100.0);

    printf("Press key to exit\n");
    getchar();
    air_quality_destroy(&aq);
    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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_air_quality.h"

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

// Callback function for all values callback
void cb_all_values(int32_t iaq_index, uint8_t iaq_index_accuracy, int32_t temperature,
                   int32_t humidity, int32_t air_pressure, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("IAQ Index: %d\n", iaq_index);

    if(iaq_index_accuracy == AIR_QUALITY_ACCURACY_UNRELIABLE) {
        printf("IAQ Index Accuracy: Unreliable\n");
    } else if(iaq_index_accuracy == AIR_QUALITY_ACCURACY_LOW) {
        printf("IAQ Index Accuracy: Low\n");
    } else if(iaq_index_accuracy == AIR_QUALITY_ACCURACY_MEDIUM) {
        printf("IAQ Index Accuracy: Medium\n");
    } else if(iaq_index_accuracy == AIR_QUALITY_ACCURACY_HIGH) {
        printf("IAQ Index Accuracy: High\n");
    }

    printf("Temperature: %f °C\n", temperature/100.0);
    printf("Humidity: %f %%RH\n", humidity/100.0);
    printf("Air Pressure: %f mbar\n", air_pressure/100.0);
    printf("\n");
}

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

    // Create device object
    AirQuality aq;
    air_quality_create(&aq, 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 all values callback to function cb_all_values
    air_quality_register_callback(&aq,
                                  AIR_QUALITY_CALLBACK_ALL_VALUES,
                                  (void (*)(void))cb_all_values,
                                  NULL);

    // Set period for all values callback to 1s (1000ms)
    air_quality_set_all_values_callback_configuration(&aq, 1000, false);

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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void air_quality_create(AirQuality *air_quality, const char *uid, IPConnection *ipcon)

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

AirQuality air_quality;
air_quality_create(&air_quality, "YOUR_DEVICE_UID", &ipcon);

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

void air_quality_destroy(AirQuality *air_quality)

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

int air_quality_get_all_values(AirQuality *air_quality, int32_t *ret_iaq_index, uint8_t *ret_iaq_index_accuracy, int32_t *ret_temperature, int32_t *ret_humidity, int32_t *ret_air_pressure)

Gibt alle Werte zurück, die das Air Quality Bricklet misst. Diese Werte umfassen: IAQ (Indoor Air Quality = Innenraumluftqualität) Index, IAQ Index Genauigkeit, Temperatur, Luftfeuchte und Luftdruck.

Air Quality Index description

Die Werte haben diese Bereiche und Einheiten:

  • IAQ Index: 0 bis 500, ein höhere Werte bedeutet eine stärkere Luftverschmutzung
  • IAQ Index Genauigkeit: 0 = unzuverlässig bis 3 = hoch
  • Temperatur: in 0,01 °C Schritten
  • Luftfeuchte: in 0,01 %RH Schritten
  • Luftdruck: in 0,01 mbar Schritten

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

  • AIR_QUALITY_ACCURACY_UNRELIABLE = 0
  • AIR_QUALITY_ACCURACY_LOW = 1
  • AIR_QUALITY_ACCURACY_MEDIUM = 2
  • AIR_QUALITY_ACCURACY_HIGH = 3
int air_quality_set_temperature_offset(AirQuality *air_quality, int32_t offset)

Setzt ein Temperatur-Offset mit Auflösung 1/100°C. Ein Offset von 10 verringert die gemessene Temperatur um 0,1°C.

Wenn das Bricklet in einem Gehäuse verbaut wird, aber die Umgebungstemperatur außerhalb des Gehäuses gemessen werden soll, dann muss vom gemessenen Temperatur ein bestimmter Wert abgezogen werden, um den Messfehler durch das Aufheizen des Gehäuses zu kompensieren.

Wir empfehlen den Messaufbau im Gehäuse mindestens 24 Stunden laufen zu lassen, damit sich ein Temperaturgleichgewicht einstellt. Danach muss die Temperatur außerhalb des Gehäuses gemessen werden und die Differenz zur Temperatur innerhalb des Gehäuses als Offset eingestellt werden.

Dieses Temperatur-Offset geht in die Berechnung der Luftfeuchte und des IAQ Index mit ein. Um die Genauigkeit der Messwerte innerhalb eines Gehäuses zu verbessern sollte der Temperatur-Offset unbedingt bestimmt und eingestellt werden.

int air_quality_get_temperature_offset(AirQuality *air_quality, int32_t *ret_offset)

Gibt das Temperatur-Offset zurück, wie mittels air_quality_set_temperature_offset() gesetzt.

int air_quality_get_iaq_index(AirQuality *air_quality, int32_t *ret_iaq_index, uint8_t *ret_iaq_index_accuracy)

Gibt den IAQ Index und dessen Genaugkeit zurück. Der IAQ Index hate einen Wertebereich von 0 bis 500, ein höhere Werte bedeutet eine stärkere Luftverschmutzung.

IAQ Index Beschreibung

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

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

  • AIR_QUALITY_ACCURACY_UNRELIABLE = 0
  • AIR_QUALITY_ACCURACY_LOW = 1
  • AIR_QUALITY_ACCURACY_MEDIUM = 2
  • AIR_QUALITY_ACCURACY_HIGH = 3
int air_quality_get_temperature(AirQuality *air_quality, int32_t *ret_temperature)

Gibt die Temperatur in 0,01 °C Schritten zurück.

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

int air_quality_get_humidity(AirQuality *air_quality, int32_t *ret_humidity)

Gibt die relative Luftfeuchtigkeit in 0,01 %RH Schritten zurück.

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

int air_quality_get_air_pressure(AirQuality *air_quality, int32_t *ret_air_pressure)

Gibt den Luftdruck in 0,01 mbar Schritten zurück.

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

Fortgeschrittene Funktionen

int air_quality_remove_calibration(AirQuality *air_quality)

Löscht die Kalibrierung auf dem Flash. Nach dem diese Funktion aufgerufen wird muss das Air Quality Bricklet vom Strom getrennt werden.

Beim nächsten starten des Bricklet wird eine komplett neue Kalibrierung gestartet, wie beim allerersten Starten des Bricklets.

Die Kalibrierung basiert auf den Daten der letzten vier Tage, daher dauert es vier Tage bis eine volle Kalibrierung wieder hergestellt ist.

Neu in Version 2.0.3 (Plugin).

int air_quality_set_background_calibration_duration(AirQuality *air_quality, uint8_t duration)

Das Air Quality Bricklet nutzt eine automatische Hintergrundkalibrierung um den IAQ-Index zu bestimmen. Der Kalibrierungsmechanismus nutzt eine Historie von gemessenen Werte. Die Länge dieser Historie kann zwischen 4 und 28 Tagen konfiguriert werden.

Wenn das Bricklet hauptsächlich am gleichen Ort bleibt und die Umgebung nicht oft verändert wird, empfehlen wir eine Länge von 28 Tagen zu verwenden.

Wenn die Länge geändert wird,wird die aktuelle Kalibrierung verworfen und die Kalibrierung beginnt von vorne. Die Konfiguration der Länge wird im Flash gespeichert, diese Funktion sollte also nur einmal in der Lebenszeit des Bricklets aufgerufen werden müssen.

Eine Änderung der Kalibrierungslänge wird beim nächsten Start des Bricklets übernommen.

Vor Firmware-Version 2.0.3 war die Hintergrundkalibrierungslänge 4 Tage und nicht konfigurierbare.

Der Standardwert (seit Firmware-Version 2.0.3) beträgt 28 Tage.

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

  • AIR_QUALITY_DURATION_4_DAYS = 0
  • AIR_QUALITY_DURATION_28_DAYS = 1

Neu in Version 2.0.3 (Plugin).

int air_quality_get_background_calibration_duration(AirQuality *air_quality, uint8_t *ret_duration)

Gibt die Länge der Hintergrundkalibrierung zurück, wie von air_quality_set_background_calibration_duration() gesetzt.

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

  • AIR_QUALITY_DURATION_4_DAYS = 0
  • AIR_QUALITY_DURATION_28_DAYS = 1

Neu in Version 2.0.3 (Plugin).

int air_quality_get_api_version(AirQuality *air_quality, 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 air_quality_get_response_expected(AirQuality *air_quality, 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 air_quality_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 air_quality_set_response_expected() für die Liste der verfügbaren Funktions ID Defines für diese Funktion.

int air_quality_set_response_expected(AirQuality *air_quality, 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:

  • AIR_QUALITY_FUNCTION_SET_TEMPERATURE_OFFSET = 2
  • AIR_QUALITY_FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 4
  • AIR_QUALITY_FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION = 8
  • AIR_QUALITY_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 12
  • AIR_QUALITY_FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 16
  • AIR_QUALITY_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20
  • AIR_QUALITY_FUNCTION_REMOVE_CALIBRATION = 23
  • AIR_QUALITY_FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
  • AIR_QUALITY_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • AIR_QUALITY_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • AIR_QUALITY_FUNCTION_RESET = 243
  • AIR_QUALITY_FUNCTION_WRITE_UID = 248
int air_quality_set_response_expected_all(AirQuality *air_quality, bool response_expected)

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

int air_quality_get_spitfp_error_count(AirQuality *air_quality, 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 air_quality_set_bootloader_mode(AirQuality *air_quality, 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 Defines sind für diese Funktion verfügbar:

  • AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER = 0
  • AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE = 1
  • AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • AIR_QUALITY_BOOTLOADER_STATUS_OK = 0
  • AIR_QUALITY_BOOTLOADER_STATUS_INVALID_MODE = 1
  • AIR_QUALITY_BOOTLOADER_STATUS_NO_CHANGE = 2
  • AIR_QUALITY_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • AIR_QUALITY_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • AIR_QUALITY_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int air_quality_get_bootloader_mode(AirQuality *air_quality, uint8_t *ret_mode)

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

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

  • AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER = 0
  • AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE = 1
  • AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int air_quality_set_write_firmware_pointer(AirQuality *air_quality, uint32_t pointer)

Setzt den Firmware-Pointer für air_quality_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 air_quality_write_firmware(AirQuality *air_quality, uint8_t data[64], uint8_t *ret_status)

Schreibt 64 Bytes Firmware an die Position die vorher von air_quality_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 air_quality_set_status_led_config(AirQuality *air_quality, 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 Defines sind für diese Funktion verfügbar:

  • AIR_QUALITY_STATUS_LED_CONFIG_OFF = 0
  • AIR_QUALITY_STATUS_LED_CONFIG_ON = 1
  • AIR_QUALITY_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • AIR_QUALITY_STATUS_LED_CONFIG_SHOW_STATUS = 3
int air_quality_get_status_led_config(AirQuality *air_quality, uint8_t *ret_config)

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

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

  • AIR_QUALITY_STATUS_LED_CONFIG_OFF = 0
  • AIR_QUALITY_STATUS_LED_CONFIG_ON = 1
  • AIR_QUALITY_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • AIR_QUALITY_STATUS_LED_CONFIG_SHOW_STATUS = 3
int air_quality_get_chip_temperature(AirQuality *air_quality, 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 air_quality_reset(AirQuality *air_quality)

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 air_quality_write_uid(AirQuality *air_quality, 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 air_quality_read_uid(AirQuality *air_quality, 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 air_quality_get_identity(AirQuality *air_quality, 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 air_quality_register_callback(AirQuality *air_quality, 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 air_quality_set_all_values_callback_configuration(AirQuality *air_quality, uint32_t period, bool value_has_to_change)

Die Periode in ms ist die Periode mit der der AIR_QUALITY_CALLBACK_ALL_VALUES 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.

Der Standardwert ist (0, false).

int air_quality_get_all_values_callback_configuration(AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change)

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

int air_quality_set_iaq_index_callback_configuration(AirQuality *air_quality, uint32_t period, bool value_has_to_change)

Die Periode in ms ist die Periode mit der der AIR_QUALITY_CALLBACK_IAQ_INDEX 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.

Der Standardwert ist (0, false).

int air_quality_get_iaq_index_callback_configuration(AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change)

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

int air_quality_set_temperature_callback_configuration(AirQuality *air_quality, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)

Die Periode in ms ist die Periode mit der der AIR_QUALITY_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 AIR_QUALITY_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.

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

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

  • AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'
int air_quality_get_temperature_callback_configuration(AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)

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

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

  • AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'
int air_quality_set_humidity_callback_configuration(AirQuality *air_quality, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)

Die Periode in ms ist die Periode mit der der AIR_QUALITY_CALLBACK_HUMIDITY 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 AIR_QUALITY_CALLBACK_HUMIDITY 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 Defines sind für diese Funktion verfügbar:

  • AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'
int air_quality_get_humidity_callback_configuration(AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)

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

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

  • AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'
int air_quality_set_air_pressure_callback_configuration(AirQuality *air_quality, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)

Die Periode in ms ist die Periode mit der der AIR_QUALITY_CALLBACK_AIR_PRESSURE 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 AIR_QUALITY_CALLBACK_AIR_PRESSURE 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 Defines sind für diese Funktion verfügbar:

  • AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'
int air_quality_get_air_pressure_callback_configuration(AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)

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

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

  • AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • AIR_QUALITY_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 air_quality_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);
}

air_quality_register_callback(&air_quality, AIR_QUALITY_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.

AIR_QUALITY_CALLBACK_ALL_VALUES
void callback(int32_t iaq_index, uint8_t iaq_index_accuracy, int32_t temperature, int32_t humidity, int32_t air_pressure, void *user_data)

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

Die Parameter sind der gleiche wie air_quality_get_all_values().

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

  • AIR_QUALITY_ACCURACY_UNRELIABLE = 0
  • AIR_QUALITY_ACCURACY_LOW = 1
  • AIR_QUALITY_ACCURACY_MEDIUM = 2
  • AIR_QUALITY_ACCURACY_HIGH = 3
AIR_QUALITY_CALLBACK_IAQ_INDEX
void callback(int32_t iaq_index, uint8_t iaq_index_accuracy, void *user_data)

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

Die Parameter sind die gleichen wie air_quality_get_iaq_index().

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

  • AIR_QUALITY_ACCURACY_UNRELIABLE = 0
  • AIR_QUALITY_ACCURACY_LOW = 1
  • AIR_QUALITY_ACCURACY_MEDIUM = 2
  • AIR_QUALITY_ACCURACY_HIGH = 3
AIR_QUALITY_CALLBACK_TEMPERATURE
void callback(int32_t temperature, void *user_data)

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

Der Parameter ist der gleiche wie air_quality_get_temperature().

AIR_QUALITY_CALLBACK_HUMIDITY
void callback(int32_t humidity, void *user_data)

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

Der Parameter ist der gleiche wie air_quality_get_humidity().

AIR_QUALITY_CALLBACK_AIR_PRESSURE
void callback(int32_t air_pressure, void *user_data)

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

Der Parameter ist der gleiche wie air_quality_get_air_pressure().

Konstanten

AIR_QUALITY_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Air Quality Bricklet zu identifizieren.

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

AIR_QUALITY_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Air Quality Bricklet dar.