Software / API Bindings / C/C++ / API Referenz und Beispiele / Bricklets / Barometer Bricklet

C/C++ - Barometer Bricklet¶

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

Callback¶

Download (example_callback.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_barometer.h"

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

// Callback function for air pressure callback
void cb_air_pressure(int32_t air_pressure, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Air Pressure: %f hPa\n", air_pressure/1000.0);
}

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

    // Create device object
    Barometer b;
    barometer_create(&b, 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 air pressure callback to function cb_air_pressure
    barometer_register_callback(&b,
                                BAROMETER_CALLBACK_AIR_PRESSURE,
                                (void (*)(void))cb_air_pressure,
                                NULL);

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

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

Simple¶

Download (example_simple.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_barometer.h"

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

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

    // Create device object
    Barometer b;
    barometer_create(&b, 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 air pressure
    int32_t air_pressure;
    if(barometer_get_air_pressure(&b, &air_pressure) < 0) {
        fprintf(stderr, "Could not get air pressure, probably timeout\n");
        return 1;
    }

    printf("Air Pressure: %f hPa\n", air_pressure/1000.0);

    // Get current altitude
    int32_t altitude;
    if(barometer_get_altitude(&b, &altitude) < 0) {
        fprintf(stderr, "Could not get altitude, probably timeout\n");
        return 1;
    }

    printf("Altitude: %f m\n", altitude/100.0);

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

Threshold¶

Download (example_threshold.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_barometer.h"

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

// Callback function for air pressure reached callback
void cb_air_pressure_reached(int32_t air_pressure, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Air Pressure: %f hPa\n", air_pressure/1000.0);
    printf("Enjoy the potentially good weather!\n");
}

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

    // Create device object
    Barometer b;
    barometer_create(&b, 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)
    barometer_set_debounce_period(&b, 10000);

    // Register air pressure reached callback to function cb_air_pressure_reached
    barometer_register_callback(&b,
                                BAROMETER_CALLBACK_AIR_PRESSURE_REACHED,
                                (void (*)(void))cb_air_pressure_reached,
                                NULL);

    // Configure threshold for air pressure "greater than 1025 hPa"
    barometer_set_air_pressure_callback_threshold(&b, '>', 1025*1000, 0);

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

API¶

Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code) zurück. 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 (seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
E_ALREADY_CONNECTED = -7
E_NOT_CONNECTED = -8
E_INVALID_PARAMETER = -9
E_NOT_SUPPORTED = -10
E_UNKNOWN_ERROR_CODE = -11
E_STREAM_OUT_OF_SYNC = -12
E_INVALID_UID = -13
E_NON_ASCII_CHAR_IN_SECRET = -14
E_WRONG_DEVICE_TYPE = -15
E_DEVICE_REPLACED = -16
E_WRONG_RESPONSE_LENGTH = -17

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

void barometer_create(Barometer *barometer, const char *uid, IPConnection *ipcon)¶

Parameter:	barometer – Typ: Barometer * uid – Typ: const char * ipcon – Typ: IPConnection *

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

Barometer barometer;
barometer_create(&barometer, "YOUR_DEVICE_UID", &ipcon);

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

void barometer_destroy(Barometer *barometer)¶

Parameter:	barometer – Typ: Barometer *

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

int barometer_get_air_pressure(Barometer *barometer, int32_t *ret_air_pressure)¶

Parameter:	barometer – Typ: Barometer *
Ausgabeparameter:	ret_air_pressure – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [10000 bis 1200000]
Rückgabe:	e_code – Typ: int

Gibt den Luftdruck des Luftdrucksensors zurück.

Wenn der Luftdruck periodisch abgefragt werden soll, wird empfohlen den BAROMETER_CALLBACK_AIR_PRESSURE Callback zu nutzen und die Periode mit barometer_set_air_pressure_callback_period() vorzugeben.

int barometer_get_altitude(Barometer *barometer, int32_t *ret_altitude)¶

Parameter:	barometer – Typ: Barometer *
Ausgabeparameter:	ret_altitude – Typ: int32_t, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	e_code – Typ: int

Gibt die relative Höhe des Luftdrucksensors zurück. Der Wert wird auf Basis der Differenz zwischen dem aktuellen Luftdruck und dem Referenzluftdruck berechnet, welcher mit barometer_set_reference_air_pressure() gesetzt werden kann.

Wenn die Höhe periodisch abgefragt werden soll, wird empfohlen den BAROMETER_CALLBACK_ALTITUDE Callback zu nutzen und die Periode mit barometer_set_altitude_callback_period() vorzugeben.

int barometer_set_reference_air_pressure(Barometer *barometer, int32_t air_pressure)¶

Parameter:	barometer – Typ: Barometer * air_pressure – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [0, 10000 bis 1200000], Standardwert: 1013250
Rückgabe:	e_code – Typ: int

Setzt den Referenzluftdruck für die Höhenberechnung. Wenn der aktuelle Luftdruckwert als Referenz übergeben wird dann gibt die Höhenberechnung 0cm aus. Als Abkürzung kann auch 0 übergeben werden, dadurch wird der Referenzluftdruck intern auf den aktuellen Luftdruckwert gesetzt.

Wohl bekannte Referenzluftdruckwerte, die in der Luftfahrt verwendet werden, sind QNH und QFE aus dem Q-Schlüssel.

int barometer_get_reference_air_pressure(Barometer *barometer, int32_t *ret_air_pressure)¶

Parameter:	barometer – Typ: Barometer *
Ausgabeparameter:	ret_air_pressure – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [10000 bis 1200000], Standardwert: 1013250
Rückgabe:	e_code – Typ: int

Gibt den Referenzluftdruckwert zurück, wie von barometer_set_reference_air_pressure() gesetzt.

Fortgeschrittene Funktionen¶

int barometer_get_chip_temperature(Barometer *barometer, int16_t *ret_temperature)¶

Parameter:	barometer – Typ: Barometer *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1/100 °C, Wertebereich: [-4000 bis 8500]
Rückgabe:	e_code – Typ: int

Gibt die Temperatur des Luftdrucksensors zurück.

Diese Temperatur wird intern zur Temperaturkompensation der Luftdruckmessung verwendet. Sie ist nicht so genau wie die Temperatur die vom Temperature Bricklet oder dem Temperature IR Bricklet gemessen wird.

int barometer_set_averaging(Barometer *barometer, uint8_t moving_average_pressure, uint8_t average_pressure, uint8_t average_temperature)¶

Parameter:	barometer – Typ: Barometer * moving_average_pressure – Typ: uint8_t, Wertebereich: [0 bis 25], Standardwert: 25 average_pressure – Typ: uint8_t, Wertebereich: [0 bis 10], Standardwert: 10 average_temperature – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 10
Rückgabe:	e_code – Typ: int

Setzt die unterschiedlichen Averaging-Parameter (Mittelwertbildung). Es ist möglich die Länge des Mittelwerts für Temperatur und Luftdruck anzugeben. Zusätzlich gibt kann die Länge für einen gleitenden Mittelwert für den Luftdruck angegeben werden. Der gleitende Mittelwert wird mit den Werten des normalen Mittelwerts berechnet. Es gibt keinen gleitenden Mittelwert für die Temperatur.

Wenn alle drei Parameter auf 0 gesetzt werden, ist das Averaging komplett aus. In diesem Fall gibt es viel Rauschen auf den Daten, allerdings sind die Daten dann ohne Verzögerung. Wir empfehlen das Averaging auszustellen wenn die Daten des Barometer Bricklets zusammen mit anderen Sensordaten fusioniert werden sollen.

Neu in Version 2.0.1 (Plugin).

int barometer_get_averaging(Barometer *barometer, uint8_t *ret_moving_average_pressure, uint8_t *ret_average_pressure, uint8_t *ret_average_temperature)¶

Parameter:	barometer – Typ: Barometer *
Ausgabeparameter:	ret_moving_average_pressure – Typ: uint8_t, Wertebereich: [0 bis 25], Standardwert: 25 ret_average_pressure – Typ: uint8_t, Wertebereich: [0 bis 10], Standardwert: 10 ret_average_temperature – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 10
Rückgabe:	e_code – Typ: int

Gibt die Averaging-Konfiguration zurück, wie von barometer_set_averaging() gesetzt.

Neu in Version 2.0.1 (Plugin).

int barometer_set_i2c_mode(Barometer *barometer, uint8_t mode)¶

Parameter:	barometer – Typ: Barometer * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt den I2C Modus. Mögliche Modi sind:

0: Fast (400kHz)
1: Slow (100kHz)

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

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

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

Für mode:

BAROMETER_I2C_MODE_FAST = 0
BAROMETER_I2C_MODE_SLOW = 1

Neu in Version 2.0.3 (Plugin).

int barometer_get_i2c_mode(Barometer *barometer, uint8_t *ret_mode)¶

Parameter:	barometer – Typ: Barometer *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_mode:

BAROMETER_I2C_MODE_FAST = 0
BAROMETER_I2C_MODE_SLOW = 1

Neu in Version 2.0.3 (Plugin).

int barometer_get_identity(Barometer *barometer, 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:	barometer – Typ: Barometer *
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¶

void barometer_register_callback(Barometer *barometer, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	barometer – Typ: Barometer * callback_id – Typ: int16_t function – Typ: void ()(void) user_data* – Typ: void *

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

int barometer_set_air_pressure_callback_period(Barometer *barometer, uint32_t period)¶

Parameter:	barometer – Typ: Barometer * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

int barometer_get_air_pressure_callback_period(Barometer *barometer, uint32_t *ret_period)¶

Parameter:	barometer – Typ: Barometer *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int barometer_set_altitude_callback_period(Barometer *barometer, uint32_t period)¶

Parameter:	barometer – Typ: Barometer * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

Der BAROMETER_CALLBACK_ALTITUDE Callback wird nur ausgelöst, wenn sich Höhe seit der letzten Auslösung geändert hat.

int barometer_get_altitude_callback_period(Barometer *barometer, uint32_t *ret_period)¶

Parameter:	barometer – Typ: Barometer *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int barometer_set_air_pressure_callback_threshold(Barometer *barometer, char option, int32_t min, int32_t max)¶

Parameter:	barometer – Typ: Barometer * option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt den Schwellwert für den BAROMETER_CALLBACK_AIR_PRESSURE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

BAROMETER_THRESHOLD_OPTION_OFF = 'x'
BAROMETER_THRESHOLD_OPTION_OUTSIDE = 'o'
BAROMETER_THRESHOLD_OPTION_INSIDE = 'i'
BAROMETER_THRESHOLD_OPTION_SMALLER = '<'
BAROMETER_THRESHOLD_OPTION_GREATER = '>'

int barometer_get_air_pressure_callback_threshold(Barometer *barometer, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶

Parameter:	barometer – Typ: Barometer *
Ausgabeparameter:	ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' ret_min – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 ret_max – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_option:

BAROMETER_THRESHOLD_OPTION_OFF = 'x'
BAROMETER_THRESHOLD_OPTION_OUTSIDE = 'o'
BAROMETER_THRESHOLD_OPTION_INSIDE = 'i'
BAROMETER_THRESHOLD_OPTION_SMALLER = '<'
BAROMETER_THRESHOLD_OPTION_GREATER = '>'

int barometer_set_altitude_callback_threshold(Barometer *barometer, char option, int32_t min, int32_t max)¶

Parameter:	barometer – Typ: Barometer * option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32_t, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32_t, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt den Schwellwert für den BAROMETER_CALLBACK_ALTITUDE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

BAROMETER_THRESHOLD_OPTION_OFF = 'x'
BAROMETER_THRESHOLD_OPTION_OUTSIDE = 'o'
BAROMETER_THRESHOLD_OPTION_INSIDE = 'i'
BAROMETER_THRESHOLD_OPTION_SMALLER = '<'
BAROMETER_THRESHOLD_OPTION_GREATER = '>'

int barometer_get_altitude_callback_threshold(Barometer *barometer, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶

Parameter:	barometer – Typ: Barometer *
Ausgabeparameter:	ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' ret_min – Typ: int32_t, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 ret_max – Typ: int32_t, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_option:

BAROMETER_THRESHOLD_OPTION_OFF = 'x'
BAROMETER_THRESHOLD_OPTION_OUTSIDE = 'o'
BAROMETER_THRESHOLD_OPTION_INSIDE = 'i'
BAROMETER_THRESHOLD_OPTION_SMALLER = '<'
BAROMETER_THRESHOLD_OPTION_GREATER = '>'

int barometer_set_debounce_period(Barometer *barometer, uint32_t debounce)¶

Parameter:	barometer – Typ: Barometer * debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100
Rückgabe:	e_code – Typ: int

Setzt die Periode mit welcher die Schwellwert Callbacks

BAROMETER_CALLBACK_AIR_PRESSURE_REACHED,
BAROMETER_CALLBACK_ALTITUDE_REACHED

ausgelöst werden, wenn die Schwellwerte

barometer_set_air_pressure_callback_threshold(),
barometer_set_altitude_callback_threshold()

weiterhin erreicht bleiben.

int barometer_get_debounce_period(Barometer *barometer, uint32_t *ret_debounce)¶

Parameter:	barometer – Typ: Barometer *
Ausgabeparameter:	ret_debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100
Rückgabe:	e_code – Typ: int

Gibt die Entprellperiode zurück, wie von barometer_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 barometer_register_callback() Funktion durchgeführt werden:

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

barometer_register_callback(&barometer,
                            BAROMETER_CALLBACK_EXAMPLE,
                            (void (*)(void))my_callback,
                            NULL);

Die verfügbaren Konstanten mit den zugehörigen 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.

BAROMETER_CALLBACK_AIR_PRESSURE¶

void callback(int32_t air_pressure, void *user_data)

Callback-Parameter:	air_pressure – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [10000 bis 1200000] user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit barometer_set_air_pressure_callback_period(), ausgelöst. Der Parameter ist der Luftdruck des Luftdrucksensors.

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

BAROMETER_CALLBACK_ALTITUDE¶

void callback(int32_t altitude, void *user_data)

Callback-Parameter:	altitude – Typ: int32_t, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1] user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit barometer_set_altitude_callback_period(), ausgelöst. Der Parameter ist die Höhe des Luftdrucksensors.

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

BAROMETER_CALLBACK_AIR_PRESSURE_REACHED¶

void callback(int32_t air_pressure, void *user_data)

Callback-Parameter:	air_pressure – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [10000 bis 1200000] user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von barometer_set_air_pressure_callback_threshold() gesetzt, erreicht wird. Der Parameter ist der Luftdruck des Luftdrucksensors.

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

BAROMETER_CALLBACK_ALTITUDE_REACHED¶

void callback(int32_t altitude, void *user_data)

Callback-Parameter:	altitude – Typ: int32_t, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1] user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von barometer_set_altitude_callback_threshold() gesetzt, erreicht wird. Der Parameter ist die Höhe des Luftdrucksensors.

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

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

int barometer_get_api_version(Barometer *barometer, uint8_t ret_api_version[3])¶

Parameter:	barometer – Typ: Barometer *
Ausgabeparameter:	ret_api_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

int barometer_get_response_expected(Barometer *barometer, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	barometer – Typ: Barometer * 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 barometer_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:

BAROMETER_FUNCTION_SET_AIR_PRESSURE_CALLBACK_PERIOD = 3
BAROMETER_FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 5
BAROMETER_FUNCTION_SET_AIR_PRESSURE_CALLBACK_THRESHOLD = 7
BAROMETER_FUNCTION_SET_ALTITUDE_CALLBACK_THRESHOLD = 9
BAROMETER_FUNCTION_SET_DEBOUNCE_PERIOD = 11
BAROMETER_FUNCTION_SET_REFERENCE_AIR_PRESSURE = 13
BAROMETER_FUNCTION_SET_AVERAGING = 20
BAROMETER_FUNCTION_SET_I2C_MODE = 22

int barometer_set_response_expected(Barometer *barometer, uint8_t function_id, bool response_expected)¶

Parameter:	barometer – Typ: Barometer * 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:

BAROMETER_FUNCTION_SET_AIR_PRESSURE_CALLBACK_PERIOD = 3
BAROMETER_FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 5
BAROMETER_FUNCTION_SET_AIR_PRESSURE_CALLBACK_THRESHOLD = 7
BAROMETER_FUNCTION_SET_ALTITUDE_CALLBACK_THRESHOLD = 9
BAROMETER_FUNCTION_SET_DEBOUNCE_PERIOD = 11
BAROMETER_FUNCTION_SET_REFERENCE_AIR_PRESSURE = 13
BAROMETER_FUNCTION_SET_AVERAGING = 20
BAROMETER_FUNCTION_SET_I2C_MODE = 22

int barometer_set_response_expected_all(Barometer *barometer, bool response_expected)¶

Parameter:	barometer – Typ: Barometer * 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.

Konstanten¶

BAROMETER_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Barometer Bricklet zu identifizieren.

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

BAROMETER_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Barometer Bricklet dar.