Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / Air Quality Bricklet

C/C++ für Mikrocontroller - Air Quality Bricklet¶

Dies ist die Beschreibung der C/C++ für Mikrocontroller 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++ für Mikrocontroller API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (example_simple.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_air_quality.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static TF_AirQuality aq;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_air_quality_create(&aq, NULL, hal), "create device object");

    // Get current all values
    int32_t iaq_index, temperature, humidity, air_pressure; uint8_t iaq_index_accuracy;
    check(tf_air_quality_get_all_values(&aq, &iaq_index, &iaq_index_accuracy,
                                        &temperature, &humidity,
                                        &air_pressure), "get all values");

    tf_hal_printf("IAQ Index: %I32d\n", iaq_index);

    if (iaq_index_accuracy == TF_AIR_QUALITY_ACCURACY_UNRELIABLE) {
        tf_hal_printf("IAQ Index Accuracy: Unreliable\n");
    } else if (iaq_index_accuracy == TF_AIR_QUALITY_ACCURACY_LOW) {
        tf_hal_printf("IAQ Index Accuracy: Low\n");
    } else if (iaq_index_accuracy == TF_AIR_QUALITY_ACCURACY_MEDIUM) {
        tf_hal_printf("IAQ Index Accuracy: Medium\n");
    } else if (iaq_index_accuracy == TF_AIR_QUALITY_ACCURACY_HIGH) {
        tf_hal_printf("IAQ Index Accuracy: High\n");
    }

    tf_hal_printf("Temperature: %d 1/%d °C\n", temperature, 100);
    tf_hal_printf("Humidity: %d 1/%d %%RH\n", humidity, 100);
    tf_hal_printf("Air Pressure: %d 1/%d hPa\n", air_pressure, 100);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

Callback¶

Download (example_callback.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_air_quality.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

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

    tf_hal_printf("IAQ Index: %I32d\n", iaq_index);

    if (iaq_index_accuracy == TF_AIR_QUALITY_ACCURACY_UNRELIABLE) {
        tf_hal_printf("IAQ Index Accuracy: Unreliable\n");
    } else if (iaq_index_accuracy == TF_AIR_QUALITY_ACCURACY_LOW) {
        tf_hal_printf("IAQ Index Accuracy: Low\n");
    } else if (iaq_index_accuracy == TF_AIR_QUALITY_ACCURACY_MEDIUM) {
        tf_hal_printf("IAQ Index Accuracy: Medium\n");
    } else if (iaq_index_accuracy == TF_AIR_QUALITY_ACCURACY_HIGH) {
        tf_hal_printf("IAQ Index Accuracy: High\n");
    }

    tf_hal_printf("Temperature: %d 1/%d °C\n", temperature, 100);
    tf_hal_printf("Humidity: %d 1/%d %%RH\n", humidity, 100);
    tf_hal_printf("Air Pressure: %d 1/%d hPa\n", air_pressure, 100);
    tf_hal_printf("\n");
}

static TF_AirQuality aq;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_air_quality_create(&aq, NULL, hal), "create device object");

    // Register all values callback to function all_values_handler
    tf_air_quality_register_all_values_callback(&aq,
                                                all_values_handler,
                                                NULL);

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

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

API¶

Die meistens Funktionen der C/C++ Bindings für Mikrocontroller geben einen Fehlercode (e_code) zurück

Mögliche Fehlercodes sind:

TF_E_OK = 0
TF_E_TIMEOUT = -1
TF_E_INVALID_PARAMETER = -2
TF_E_NOT_SUPPORTED = -3
TF_E_UNKNOWN_ERROR_CODE = -4
TF_E_STREAM_OUT_OF_SYNC = -5
TF_E_INVALID_CHAR_IN_UID = -6
TF_E_UID_TOO_LONG = -7
TF_E_UID_OVERFLOW = -8
TF_E_TOO_MANY_DEVICES = -9
TF_E_DEVICE_NOT_FOUND = -10
TF_E_WRONG_DEVICE_TYPE = -11
TF_E_CALLBACK_EXEC = -12
TF_E_PORT_NOT_FOUND = -13

(wie in errors.h definiert), sowie die Fehlercodes des verwendeten Hardware-Abstraction-Layers (HALs). Mit tf_hal_strerror (im Header das HALs definiert) kann ein Fehlerstring zu einem Fehlercode abgefragt werden.

Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet. Die Bindings schreiben einen Ausgabeparameter nicht, wenn NULL bzw. nullptr übergeben wird. So können uninteressante Ausgaben ignoriert werden.

Keine der folgend aufgelisteten Funktionen ist Thread-sicher. Details finden sich in der Beschreibung der API-Bindings.

Grundfunktionen¶

int tf_air_quality_create(TF_AirQuality *air_quality, const char *uid, TF_HAL *hal)¶

Parameter:	air_quality – Typ: TF_AirQuality * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

Erzeugt ein Geräteobjekt air_quality mit der optionalen eindeutigen Geräte ID oder dem Portnamen uid_or_port_name und fügt es dem HAL hal hinzu:

TF_AirQuality air_quality;
tf_air_quality_create(&air_quality, NULL, &ipcon);

Im Normalfall kann uid_or_port_name auf NULL belassen werden. Für weitere Details siehe Abschnitt UID oder Port-Name.

int tf_air_quality_destroy(TF_AirQuality *air_quality)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Rückgabe:	e_code – Typ: int

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

int tf_air_quality_get_all_values(TF_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)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Ausgabeparameter:	ret_iaq_index – Typ: int32_t, Wertebereich: [0 bis 500] ret_iaq_index_accuracy – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_temperature – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1] ret_humidity – Typ: int32_t, Einheit: 1/100 %, Wertebereich: [-2³¹ bis 2³¹ - 1] ret_air_pressure – Typ: int32_t, Einheit: 1/100 hPa, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	e_code – Typ: int

Gibt alle Werte zurück, die das Air Quality Bricklet misst. Diese Werte umfassen: IAQ (Indoor Air Quality = Innenraumluftqualität) Index (ein höherer Werte bedeutet eine stärkere Luftverschmutzung), IAQ Index Genauigkeit, Temperatur, Luftfeuchte und Luftdruck.

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

Für ret_iaq_index_accuracy:

TF_AIR_QUALITY_ACCURACY_UNRELIABLE = 0
TF_AIR_QUALITY_ACCURACY_LOW = 1
TF_AIR_QUALITY_ACCURACY_MEDIUM = 2
TF_AIR_QUALITY_ACCURACY_HIGH = 3

int tf_air_quality_set_temperature_offset(TF_AirQuality *air_quality, int32_t offset)¶

Parameter:	air_quality – Typ: TF_AirQuality * offset – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	e_code – Typ: int

Setzt ein Temperatur-Offset. 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 tf_air_quality_get_temperature_offset(TF_AirQuality *air_quality, int32_t *ret_offset)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Ausgabeparameter:	ret_offset – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	e_code – Typ: int

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

int tf_air_quality_get_iaq_index(TF_AirQuality *air_quality, int32_t *ret_iaq_index, uint8_t *ret_iaq_index_accuracy)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Ausgabeparameter:	ret_iaq_index – Typ: int32_t, Wertebereich: [0 bis 500] ret_iaq_index_accuracy – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Gibt den IAQ Index und dessen Genaugkeit zurück. Ein höherer Werte bedeutet eine stärkere Luftverschmutzung.

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

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

Für ret_iaq_index_accuracy:

TF_AIR_QUALITY_ACCURACY_UNRELIABLE = 0
TF_AIR_QUALITY_ACCURACY_LOW = 1
TF_AIR_QUALITY_ACCURACY_MEDIUM = 2
TF_AIR_QUALITY_ACCURACY_HIGH = 3

int tf_air_quality_get_temperature(TF_AirQuality *air_quality, int32_t *ret_temperature)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Ausgabeparameter:	ret_temperature – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	e_code – Typ: int

Gibt die Temperatur zurück.

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

int tf_air_quality_get_humidity(TF_AirQuality *air_quality, int32_t *ret_humidity)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Ausgabeparameter:	ret_humidity – Typ: int32_t, Einheit: 1/100 %, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	e_code – Typ: int

Gibt die relative Luftfeuchtigkeit zurück.

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

int tf_air_quality_get_air_pressure(TF_AirQuality *air_quality, int32_t *ret_air_pressure)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Ausgabeparameter:	ret_air_pressure – Typ: int32_t, Einheit: 1/100 hPa, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	e_code – Typ: int

Gibt den Luftdruck Schritten zurück.

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

Fortgeschrittene Funktionen¶

int tf_air_quality_remove_calibration(TF_AirQuality *air_quality)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Rückgabe:	e_code – Typ: int

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 tf_air_quality_set_background_calibration_duration(TF_AirQuality *air_quality, uint8_t duration)¶

Parameter:	air_quality – Typ: TF_AirQuality * duration – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:	e_code – Typ: int

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 Konstanten sind für diese Funktion verfügbar:

Für duration:

TF_AIR_QUALITY_DURATION_4_DAYS = 0
TF_AIR_QUALITY_DURATION_28_DAYS = 1

Neu in Version 2.0.3 (Plugin).

int tf_air_quality_get_background_calibration_duration(TF_AirQuality *air_quality, uint8_t *ret_duration)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Ausgabeparameter:	ret_duration – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:	e_code – Typ: int

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

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

Für ret_duration:

TF_AIR_QUALITY_DURATION_4_DAYS = 0
TF_AIR_QUALITY_DURATION_28_DAYS = 1

Neu in Version 2.0.3 (Plugin).

int tf_air_quality_get_spitfp_error_count(TF_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)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 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 tf_air_quality_set_status_led_config(TF_AirQuality *air_quality, uint8_t config)¶

Parameter:	air_quality – Typ: TF_AirQuality * 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:

TF_AIR_QUALITY_STATUS_LED_CONFIG_OFF = 0
TF_AIR_QUALITY_STATUS_LED_CONFIG_ON = 1
TF_AIR_QUALITY_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_AIR_QUALITY_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_air_quality_get_status_led_config(TF_AirQuality *air_quality, uint8_t *ret_config)¶

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

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

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

Für ret_config:

TF_AIR_QUALITY_STATUS_LED_CONFIG_OFF = 0
TF_AIR_QUALITY_STATUS_LED_CONFIG_ON = 1
TF_AIR_QUALITY_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_AIR_QUALITY_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_air_quality_get_chip_temperature(TF_AirQuality *air_quality, int16_t *ret_temperature)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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 tf_air_quality_reset(TF_AirQuality *air_quality)¶

Parameter:	air_quality – Typ: TF_AirQuality *
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 tf_air_quality_get_identity(TF_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)¶

Parameter:	air_quality – Typ: TF_AirQuality *
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 2¹⁶ - 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¶

int tf_air_quality_set_all_values_callback_configuration(TF_AirQuality *air_quality, uint32_t period, bool value_has_to_change)¶

Parameter:	air_quality – Typ: TF_AirQuality * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

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

int tf_air_quality_get_all_values_callback_configuration(TF_AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

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

int tf_air_quality_set_iaq_index_callback_configuration(TF_AirQuality *air_quality, uint32_t period, bool value_has_to_change)¶

Parameter:	air_quality – Typ: TF_AirQuality * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Die Periode ist die Periode mit der der IAQ Index Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

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

int tf_air_quality_get_iaq_index_callback_configuration(TF_AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

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

int tf_air_quality_set_temperature_callback_configuration(TF_AirQuality *air_quality, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)¶

Parameter:

Parameter:	air_quality – Typ: TF_AirQuality * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

air_quality – Typ: TF_AirQuality *
period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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: [-2³¹ bis 2³¹ - 1], Standardwert: 0
max – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Rückgabe:

e_code – Typ: int

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

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

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

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

Der option-Parameter zusammen mit min/max setzt einen Threshold für den Temperature 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:

TF_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
TF_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
TF_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
TF_AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'

int tf_air_quality_get_temperature_callback_configuration(TF_AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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: [-2³¹ bis 2³¹ - 1], Standardwert: 0 ret_max – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_option:

TF_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
TF_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
TF_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
TF_AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'

int tf_air_quality_set_humidity_callback_configuration(TF_AirQuality *air_quality, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)¶

Parameter:

Parameter:	air_quality – Typ: TF_AirQuality * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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 %, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32_t, Einheit: 1/100 %, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

air_quality – Typ: TF_AirQuality *
period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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 %, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
max – Typ: int32_t, Einheit: 1/100 %, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Rückgabe:

e_code – Typ: int

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

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

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

Für option:

TF_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
TF_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
TF_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
TF_AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'

int tf_air_quality_get_humidity_callback_configuration(TF_AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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 %, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 ret_max – Typ: int32_t, Einheit: 1/100 %, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_option:

TF_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
TF_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
TF_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
TF_AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'

int tf_air_quality_set_air_pressure_callback_configuration(TF_AirQuality *air_quality, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)¶

Parameter:

Parameter:	air_quality – Typ: TF_AirQuality * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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 hPa, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32_t, Einheit: 1/100 hPa, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

air_quality – Typ: TF_AirQuality *
period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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 hPa, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
max – Typ: int32_t, Einheit: 1/100 hPa, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Rückgabe:

e_code – Typ: int

Die Periode ist die Periode mit der der Air Pressure Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

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

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

Für option:

TF_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
TF_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
TF_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
TF_AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'

int tf_air_quality_get_air_pressure_callback_configuration(TF_AirQuality *air_quality, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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 hPa, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 ret_max – Typ: int32_t, Einheit: 1/100 hPa, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_option:

TF_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
TF_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
TF_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
TF_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 entsprechenden tf_air_quality_register_*_callback Funktion durchgeführt werden. Die user_data, sowie das Gerät, dass das Callback ausgelöst hat, werden dem registrierten Callback-Handler übergeben.

Nur ein Handler kann gleichzeitig auf das selbe Callback registriert werden. Um einen Handler zu deregistrieren, kann die tf_air_quality_register_*_callback-Funktion mit NULL als Handler aufgerufen werden.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist gegenüber der Verwendung von Abfragen zu bevorzugen. Es muss nur ein Byte abgefragt werden um zu prüfen ob ein Callback vorliegt. Siehe hier Performanceoptimierungen.

Warnung

Aus Callback-Handlern heraus können keine Bindings-Funktionen verwendet werden. Siehe hier Callbacks.

int tf_air_quality_register_all_values_callback(TF_AirQuality *air_quality, TF_AirQuality_AllValuesHandler handler, void *user_data)¶

void handler(TF_AirQuality *air_quality, int32_t iaq_index, uint8_t iaq_index_accuracy, int32_t temperature, int32_t humidity, int32_t air_pressure, void *user_data)

Callback-Parameter:

Callback-Parameter:	air_quality – Typ: TF_AirQuality * iaq_index – Typ: int32_t, Wertebereich: [0 bis 500] iaq_index_accuracy – Typ: uint8_t, Wertebereich: Siehe Konstanten temperature – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1] humidity – Typ: int32_t, Einheit: 1/100 %, Wertebereich: [-2³¹ bis 2³¹ - 1] air_pressure – Typ: int32_t, Einheit: 1/100 hPa, Wertebereich: [-2³¹ bis 2³¹ - 1] user_data – Typ: void *

air_quality – Typ: TF_AirQuality *
iaq_index – Typ: int32_t, Wertebereich: [0 bis 500]
iaq_index_accuracy – Typ: uint8_t, Wertebereich: Siehe Konstanten
temperature – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1]
humidity – Typ: int32_t, Einheit: 1/100 %, Wertebereich: [-2³¹ bis 2³¹ - 1]
air_pressure – Typ: int32_t, Einheit: 1/100 hPa, Wertebereich: [-2³¹ bis 2³¹ - 1]
user_data – Typ: void *

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

Die Parameter sind der gleiche wie tf_air_quality_get_all_values().

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

Für iaq_index_accuracy:

TF_AIR_QUALITY_ACCURACY_UNRELIABLE = 0
TF_AIR_QUALITY_ACCURACY_LOW = 1
TF_AIR_QUALITY_ACCURACY_MEDIUM = 2
TF_AIR_QUALITY_ACCURACY_HIGH = 3

int tf_air_quality_register_iaq_index_callback(TF_AirQuality *air_quality, TF_AirQuality_IAQIndexHandler handler, void *user_data)¶

void handler(TF_AirQuality *air_quality, int32_t iaq_index, uint8_t iaq_index_accuracy, void *user_data)

Callback-Parameter:	air_quality – Typ: TF_AirQuality * iaq_index – Typ: int32_t, Wertebereich: [0 bis 500] iaq_index_accuracy – Typ: uint8_t, Wertebereich: Siehe Konstanten user_data – Typ: void *

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

Die Parameter sind die gleichen wie tf_air_quality_get_iaq_index().

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

Für iaq_index_accuracy:

TF_AIR_QUALITY_ACCURACY_UNRELIABLE = 0
TF_AIR_QUALITY_ACCURACY_LOW = 1
TF_AIR_QUALITY_ACCURACY_MEDIUM = 2
TF_AIR_QUALITY_ACCURACY_HIGH = 3

int tf_air_quality_register_temperature_callback(TF_AirQuality *air_quality, TF_AirQuality_TemperatureHandler handler, void *user_data)¶

void handler(TF_AirQuality *air_quality, int32_t temperature, void *user_data)

Callback-Parameter:	air_quality – Typ: TF_AirQuality * temperature – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1] user_data – Typ: void *

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

Der Parameter ist der gleiche wie tf_air_quality_get_temperature().

int tf_air_quality_register_humidity_callback(TF_AirQuality *air_quality, TF_AirQuality_HumidityHandler handler, void *user_data)¶

void handler(TF_AirQuality *air_quality, int32_t humidity, void *user_data)

Callback-Parameter:	air_quality – Typ: TF_AirQuality * humidity – Typ: int32_t, Einheit: 1/100 %, Wertebereich: [-2³¹ bis 2³¹ - 1] user_data – Typ: void *

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

Der Parameter ist der gleiche wie tf_air_quality_get_humidity().

int tf_air_quality_register_air_pressure_callback(TF_AirQuality *air_quality, TF_AirQuality_AirPressureHandler handler, void *user_data)¶

void handler(TF_AirQuality *air_quality, int32_t air_pressure, void *user_data)

Callback-Parameter:	air_quality – Typ: TF_AirQuality * air_pressure – Typ: int32_t, Einheit: 1/100 hPa, Wertebereich: [-2³¹ bis 2³¹ - 1] user_data – Typ: void *

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

Der Parameter ist der gleiche wie tf_air_quality_get_air_pressure().

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt.

int tf_air_quality_get_response_expected(TF_AirQuality *air_quality, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	air_quality – Typ: TF_AirQuality * 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 tf_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.

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

Für function_id:

TF_AIR_QUALITY_FUNCTION_SET_TEMPERATURE_OFFSET = 2
TF_AIR_QUALITY_FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 4
TF_AIR_QUALITY_FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION = 8
TF_AIR_QUALITY_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 12
TF_AIR_QUALITY_FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 16
TF_AIR_QUALITY_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20
TF_AIR_QUALITY_FUNCTION_REMOVE_CALIBRATION = 23
TF_AIR_QUALITY_FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
TF_AIR_QUALITY_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_AIR_QUALITY_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_AIR_QUALITY_FUNCTION_RESET = 243
TF_AIR_QUALITY_FUNCTION_WRITE_UID = 248

int tf_air_quality_set_response_expected(TF_AirQuality *air_quality, uint8_t function_id, bool response_expected)¶

Parameter:	air_quality – Typ: TF_AirQuality * 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.

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

Für function_id:

TF_AIR_QUALITY_FUNCTION_SET_TEMPERATURE_OFFSET = 2
TF_AIR_QUALITY_FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 4
TF_AIR_QUALITY_FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION = 8
TF_AIR_QUALITY_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 12
TF_AIR_QUALITY_FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 16
TF_AIR_QUALITY_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20
TF_AIR_QUALITY_FUNCTION_REMOVE_CALIBRATION = 23
TF_AIR_QUALITY_FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
TF_AIR_QUALITY_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_AIR_QUALITY_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_AIR_QUALITY_FUNCTION_RESET = 243
TF_AIR_QUALITY_FUNCTION_WRITE_UID = 248

int tf_air_quality_set_response_expected_all(TF_AirQuality *air_quality, bool response_expected)¶

Parameter:	air_quality – Typ: TF_AirQuality * 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 tf_air_quality_set_bootloader_mode(TF_AirQuality *air_quality, uint8_t mode, uint8_t *ret_status)¶

Parameter:	air_quality – Typ: TF_AirQuality * 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:

TF_AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER = 0
TF_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE = 1
TF_AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_AIR_QUALITY_BOOTLOADER_STATUS_OK = 0
TF_AIR_QUALITY_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_AIR_QUALITY_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_AIR_QUALITY_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_AIR_QUALITY_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_AIR_QUALITY_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_air_quality_get_bootloader_mode(TF_AirQuality *air_quality, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

TF_AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER = 0
TF_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE = 1
TF_AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_air_quality_set_write_firmware_pointer(TF_AirQuality *air_quality, uint32_t pointer)¶

Parameter:	air_quality – Typ: TF_AirQuality * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für tf_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 tf_air_quality_write_firmware(TF_AirQuality *air_quality, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	air_quality – Typ: TF_AirQuality * data – Typ: const 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 tf_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 tf_air_quality_write_uid(TF_AirQuality *air_quality, uint32_t uid)¶

Parameter:	air_quality – Typ: TF_AirQuality * uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 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 tf_air_quality_read_uid(TF_AirQuality *air_quality, uint32_t *ret_uid)¶

Parameter:	air_quality – Typ: TF_AirQuality *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 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¶

TF_AIR_QUALITY_DEVICE_IDENTIFIER¶

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

Die Funktionen tf_air_quality_get_identity() und tf_hal_get_device_info() haben einen device_identifier Ausgabe-Parameter um den Typ des Bricks oder Bricklets anzugeben.

TF_AIR_QUALITY_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Air Quality Bricklet dar.