C/C++ - Barometer Bricklet 2.0

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

 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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_barometer_v2.h"

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

// 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 mbar\n", air_pressure/1000.0);
}

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

    // Create device object
    BarometerV2 b;
    barometer_v2_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_v2_register_callback(&b,
                                   BAROMETER_V2_CALLBACK_AIR_PRESSURE,
                                   (void (*)(void))cb_air_pressure,
                                   NULL);

    // Set period for air pressure callback to 1s (1000ms) without a threshold
    barometer_v2_set_air_pressure_callback_configuration(&b, 1000, false, 'x', 0, 0);

    printf("Press key to exit\n");
    getchar();
    barometer_v2_destroy(&b);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_barometer_v2.h"

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

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

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

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

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

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

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

Threshold

Download (example_threshold.c)

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

#include "ip_connection.h"
#include "bricklet_barometer_v2.h"

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

// 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 mbar\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
    BarometerV2 b;
    barometer_v2_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_v2_register_callback(&b,
                                   BAROMETER_V2_CALLBACK_AIR_PRESSURE,
                                   (void (*)(void))cb_air_pressure,
                                   NULL);

    // Configure threshold for air pressure "greater than 1025 mbar"
    // with a debounce period of 1s (1000ms)
    barometer_v2_set_air_pressure_callback_configuration(&b, 1000, false, '>', 1025*1000, 0);

    printf("Press key to exit\n");
    getchar();
    barometer_v2_destroy(&b);
    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 barometer_v2_create(BarometerV2 *barometer_v2, const char *uid, IPConnection *ipcon)

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

BarometerV2 barometer_v2;
barometer_v2_create(&barometer_v2, "YOUR_DEVICE_UID", &ipcon);

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

void barometer_v2_destroy(BarometerV2 *barometer_v2)

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

int barometer_v2_get_air_pressure(BarometerV2 *barometer_v2, int32_t *ret_air_pressure)

Gibt den Luftdruck des Luftdrucksensors zurück. Der Wertbereich geht von 260000 bis 1260000 und ist in mbar/1000 angegeben, d.h. bei einem Wert von 1001092 wurde ein Luftdruck von 1001,092 mbar gemessen.

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

int barometer_v2_get_altitude(BarometerV2 *barometer_v2, int32_t *ret_altitude)

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

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

int barometer_v2_get_temperature(BarometerV2 *barometer_v2, int32_t *ret_temperature)

Gibt die Temperatur des Luftdrucksensors zurück. Der Wertbereich ist von -4000 bis 8500 und ist in °C/100 angegeben, d.h. bei einem Wert von 2007 wurde eine Temperatur von 20,07 °C gemessen.

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

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

int barometer_v2_set_moving_average_configuration(BarometerV2 *barometer_v2, uint16_t moving_average_length_air_pressure, uint16_t moving_average_length_temperature)

Setzt die Länge eines gleitenden Mittelwerts für die Luftdruck- und Temperaturmessung.

Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 1-1000.

Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

Der Standardwert ist 100.

int barometer_v2_get_moving_average_configuration(BarometerV2 *barometer_v2, uint16_t *ret_moving_average_length_air_pressure, uint16_t *ret_moving_average_length_temperature)

Gibt die Moving Average-Konfiguration zurück, wie von barometer_v2_set_moving_average_configuration() gesetzt.

int barometer_v2_set_reference_air_pressure(BarometerV2 *barometer_v2, int32_t air_pressure)

Setzt den Referenzluftdruck in mbar/1000 für die Höhenberechnung. Gültige Werte liegen zwischen 260000 und 1260000. Wenn der aktuelle Luftdruckwert als Referenz übergeben wird dann gibt die Höhenberechnung 0mm 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.

Der Standardwert ist 1013,25mbar.

int barometer_v2_get_reference_air_pressure(BarometerV2 *barometer_v2, int32_t *ret_air_pressure)

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

Fortgeschrittene Funktionen

int barometer_v2_set_calibration(BarometerV2 *barometer_v2, int32_t measured_air_pressure, int32_t actual_air_pressure)

Setzt den One Point Calibration (OPC) Werte für die Luftdruckmessung.

Bevor das Bricklet kalibriert werden kann muss die möglicherweise vorhandene Kalibierung gelöschet werden, dazu muss Measured Air Pressure und Actual Air Pressure auf 0 gesetzt werden.

Dann muss der aktuelle Luftdruck gleichzeitig mit dem Bricklet (Measured Air Pressure) und einem genauen Referenzbarometer (Actual Air Pressure) gemessen und die Werte in mbar/1000 an diese Funktion übergeben werden.

Nach einer ordentlichen Kalibrierung kann der Luftdruck mit bis zu 0,2 mbar Genauigkeit gemessen werden

Die Kalibrierung wird im EEPROM des Bricklets gespeichert und muss nur einmal gesetzt werden.

int barometer_v2_get_calibration(BarometerV2 *barometer_v2, int32_t *ret_measured_air_pressure, int32_t *ret_actual_air_pressure)

Gibt die Luftdruck One Point Calibration Werte zurück, wie von barometer_v2_set_calibration() gesetzt.

int barometer_v2_set_sensor_configuration(BarometerV2 *barometer_v2, uint8_t data_rate, uint8_t air_pressure_low_pass_filter)

Konfiguriert die Datenrate und de Luftdrucktiefpassfilter. Die Grenzfrequenz des Tiefpassfilters (falls aktiviert) kann auf 1/9tel oder 1/20stel der eingestellten Datenrate gesetzt werden, um das Rauschen auf den Luftdruckdaten zu verringert.

Die Tiefpassfiltereinstellung gilt nur für die Luftdruckmessung. Es gibt keinen Tiefpassfilter für die Temperaturmessung.

Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten. Eine hohe Datenrate erhöht zusätzlich die Selbsterhitzung des Sensors. Wenn eine hohe Temperaturgenauigkeit wichtig ist empfehlen wir eine Datenrate von 1Hz.

Die Standardwerte sind 50Hz Datenrate und 1/9tel Tiefpassfilter.

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

  • BAROMETER_V2_DATA_RATE_OFF = 0
  • BAROMETER_V2_DATA_RATE_1HZ = 1
  • BAROMETER_V2_DATA_RATE_10HZ = 2
  • BAROMETER_V2_DATA_RATE_25HZ = 3
  • BAROMETER_V2_DATA_RATE_50HZ = 4
  • BAROMETER_V2_DATA_RATE_75HZ = 5
  • BAROMETER_V2_LOW_PASS_FILTER_OFF = 0
  • BAROMETER_V2_LOW_PASS_FILTER_1_9TH = 1
  • BAROMETER_V2_LOW_PASS_FILTER_1_20TH = 2
int barometer_v2_get_sensor_configuration(BarometerV2 *barometer_v2, uint8_t *ret_data_rate, uint8_t *ret_air_pressure_low_pass_filter)

Gibt die Sensor-Konfiguration zurück, wie von barometer_v2_set_sensor_configuration() gesetzt.

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

  • BAROMETER_V2_DATA_RATE_OFF = 0
  • BAROMETER_V2_DATA_RATE_1HZ = 1
  • BAROMETER_V2_DATA_RATE_10HZ = 2
  • BAROMETER_V2_DATA_RATE_25HZ = 3
  • BAROMETER_V2_DATA_RATE_50HZ = 4
  • BAROMETER_V2_DATA_RATE_75HZ = 5
  • BAROMETER_V2_LOW_PASS_FILTER_OFF = 0
  • BAROMETER_V2_LOW_PASS_FILTER_1_9TH = 1
  • BAROMETER_V2_LOW_PASS_FILTER_1_20TH = 2
int barometer_v2_get_api_version(BarometerV2 *barometer_v2, 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 barometer_v2_get_response_expected(BarometerV2 *barometer_v2, 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 barometer_v2_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 barometer_v2_set_response_expected() für die Liste der verfügbaren Funktions ID Defines für diese Funktion.

int barometer_v2_set_response_expected(BarometerV2 *barometer_v2, 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:

  • BAROMETER_V2_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 2
  • BAROMETER_V2_FUNCTION_SET_ALTITUDE_CALLBACK_CONFIGURATION = 6
  • BAROMETER_V2_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 10
  • BAROMETER_V2_FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 13
  • BAROMETER_V2_FUNCTION_SET_REFERENCE_AIR_PRESSURE = 15
  • BAROMETER_V2_FUNCTION_SET_CALIBRATION = 17
  • BAROMETER_V2_FUNCTION_SET_SENSOR_CONFIGURATION = 19
  • BAROMETER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BAROMETER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BAROMETER_V2_FUNCTION_RESET = 243
  • BAROMETER_V2_FUNCTION_WRITE_UID = 248
int barometer_v2_set_response_expected_all(BarometerV2 *barometer_v2, bool response_expected)

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

int barometer_v2_get_spitfp_error_count(BarometerV2 *barometer_v2, 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 barometer_v2_set_bootloader_mode(BarometerV2 *barometer_v2, 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:

  • BAROMETER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BAROMETER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BAROMETER_V2_BOOTLOADER_STATUS_OK = 0
  • BAROMETER_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BAROMETER_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BAROMETER_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BAROMETER_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BAROMETER_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int barometer_v2_get_bootloader_mode(BarometerV2 *barometer_v2, uint8_t *ret_mode)

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

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

  • BAROMETER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BAROMETER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int barometer_v2_set_write_firmware_pointer(BarometerV2 *barometer_v2, uint32_t pointer)

Setzt den Firmware-Pointer für barometer_v2_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 barometer_v2_write_firmware(BarometerV2 *barometer_v2, uint8_t data[64], uint8_t *ret_status)

Schreibt 64 Bytes Firmware an die Position die vorher von barometer_v2_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 barometer_v2_set_status_led_config(BarometerV2 *barometer_v2, 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:

  • BAROMETER_V2_STATUS_LED_CONFIG_OFF = 0
  • BAROMETER_V2_STATUS_LED_CONFIG_ON = 1
  • BAROMETER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BAROMETER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int barometer_v2_get_status_led_config(BarometerV2 *barometer_v2, uint8_t *ret_config)

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

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

  • BAROMETER_V2_STATUS_LED_CONFIG_OFF = 0
  • BAROMETER_V2_STATUS_LED_CONFIG_ON = 1
  • BAROMETER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BAROMETER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int barometer_v2_get_chip_temperature(BarometerV2 *barometer_v2, 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 barometer_v2_reset(BarometerV2 *barometer_v2)

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 barometer_v2_write_uid(BarometerV2 *barometer_v2, 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 barometer_v2_read_uid(BarometerV2 *barometer_v2, 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 barometer_v2_get_identity(BarometerV2 *barometer_v2, 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 barometer_v2_register_callback(BarometerV2 *barometer_v2, 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 barometer_v2_set_air_pressure_callback_configuration(BarometerV2 *barometer_v2, 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 BAROMETER_V2_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 BAROMETER_V2_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:

  • BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'
int barometer_v2_get_air_pressure_callback_configuration(BarometerV2 *barometer_v2, 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 barometer_v2_set_air_pressure_callback_configuration() gesetzt.

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

  • BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'
int barometer_v2_set_altitude_callback_configuration(BarometerV2 *barometer_v2, 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 BAROMETER_V2_CALLBACK_ALTITUDE 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 BAROMETER_V2_CALLBACK_ALTITUDE 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:

  • BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'
int barometer_v2_get_altitude_callback_configuration(BarometerV2 *barometer_v2, 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 barometer_v2_set_altitude_callback_configuration() gesetzt.

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

  • BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'
int barometer_v2_set_temperature_callback_configuration(BarometerV2 *barometer_v2, 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 BAROMETER_V2_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 BAROMETER_V2_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:

  • BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'
int barometer_v2_get_temperature_callback_configuration(BarometerV2 *barometer_v2, 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 barometer_v2_set_temperature_callback_configuration() gesetzt.

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

  • BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BAROMETER_V2_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 barometer_v2_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);
}

barometer_v2_register_callback(&barometer_v2, BAROMETER_V2_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.

BAROMETER_V2_CALLBACK_AIR_PRESSURE
void callback(int32_t air_pressure, void *user_data)

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

Der Parameter ist der gleiche wie barometer_v2_get_air_pressure().

BAROMETER_V2_CALLBACK_ALTITUDE
void callback(int32_t altitude, void *user_data)

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

Der Parameter ist der gleiche wie barometer_v2_get_altitude().

BAROMETER_V2_CALLBACK_TEMPERATURE
void callback(int32_t temperature, void *user_data)

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

Der Parameter ist der gleiche wie barometer_v2_get_temperature().

Konstanten

BAROMETER_V2_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Barometer Bricklet 2.0 zu identifizieren.

Die barometer_v2_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_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Barometer Bricklet 2.0 dar.