C/C++ für Mikrocontroller - Barometer Bricklet 2.0

Dies ist die Beschreibung der C/C++ für Mikrocontroller 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++ 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)

 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
// 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_barometer_v2.h"

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

static TF_BarometerV2 b;

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

    // Get current air pressure
    int32_t air_pressure;
    check(tf_barometer_v2_get_air_pressure(&b, &air_pressure), "get air pressure");

    tf_hal_printf("Air Pressure: %d 1/%d hPa\n", air_pressure, 1000);

    // Get current altitude
    int32_t altitude;
    check(tf_barometer_v2_get_altitude(&b, &altitude), "get altitude");

    tf_hal_printf("Altitude: %d 1/%d m\n", altitude, 1000);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 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
// 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_barometer_v2.h"

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

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

    tf_hal_printf("Air Pressure: %d 1/%d hPa\n", air_pressure, 1000);
}

static TF_BarometerV2 b;

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

    // Register air pressure callback to function air_pressure_handler
    tf_barometer_v2_register_air_pressure_callback(&b,
                                                   air_pressure_handler,
                                                   NULL);

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

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 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
// 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_barometer_v2.h"

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

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

    tf_hal_printf("Air Pressure: %d 1/%d hPa\n", air_pressure, 1000);
    tf_hal_printf("Enjoy the potentially good weather!\n");
}

static TF_BarometerV2 b;

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

    // Register air pressure callback to function air_pressure_handler
    tf_barometer_v2_register_air_pressure_callback(&b,
                                                   air_pressure_handler,
                                                   NULL);

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

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_barometer_v2_create(TF_BarometerV2 *barometer_v2, const char *uid, TF_HAL *hal)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • uid – Typ: const char *
  • hal – Typ: TF_HAL *
Rückgabe:
  • e_code – Typ: int

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

TF_BarometerV2 barometer_v2;
tf_barometer_v2_create(&barometer_v2, 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_barometer_v2_destroy(TF_BarometerV2 *barometer_v2)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
Rückgabe:
  • e_code – Typ: int

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

int tf_barometer_v2_get_air_pressure(TF_BarometerV2 *barometer_v2, int32_t *ret_air_pressure)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
Ausgabeparameter:
  • ret_air_pressure – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [260000 bis 1260000]
Rückgabe:
  • e_code – Typ: int

Gibt den Luftdruck des Luftdrucksensors zurück.

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

int tf_barometer_v2_get_altitude(TF_BarometerV2 *barometer_v2, int32_t *ret_altitude)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
Ausgabeparameter:
  • ret_altitude – Typ: int32_t, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 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 tf_barometer_v2_set_reference_air_pressure() gesetzt werden kann.

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

int tf_barometer_v2_get_temperature(TF_BarometerV2 *barometer_v2, int32_t *ret_temperature)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
Ausgabeparameter:
  • ret_temperature – Typ: int32_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 2.0 oder dem Temperature IR Bricklet 2.0 gemessen wird.

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

int tf_barometer_v2_set_moving_average_configuration(TF_BarometerV2 *barometer_v2, uint16_t moving_average_length_air_pressure, uint16_t moving_average_length_temperature)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • moving_average_length_air_pressure – Typ: uint16_t, Wertebereich: [1 bis 1000], Standardwert: 100
  • moving_average_length_temperature – Typ: uint16_t, Wertebereich: [1 bis 1000], Standardwert: 100
Rückgabe:
  • e_code – Typ: int

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.

Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

int tf_barometer_v2_get_moving_average_configuration(TF_BarometerV2 *barometer_v2, uint16_t *ret_moving_average_length_air_pressure, uint16_t *ret_moving_average_length_temperature)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
Ausgabeparameter:
  • ret_moving_average_length_air_pressure – Typ: uint16_t, Wertebereich: [1 bis 1000], Standardwert: 100
  • ret_moving_average_length_temperature – Typ: uint16_t, Wertebereich: [1 bis 1000], Standardwert: 100
Rückgabe:
  • e_code – Typ: int

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

int tf_barometer_v2_set_reference_air_pressure(TF_BarometerV2 *barometer_v2, int32_t air_pressure)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • air_pressure – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000], 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 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.

int tf_barometer_v2_get_reference_air_pressure(TF_BarometerV2 *barometer_v2, int32_t *ret_air_pressure)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
Ausgabeparameter:
  • ret_air_pressure – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [260000 bis 1260000], Standardwert: 1013250
Rückgabe:
  • e_code – Typ: int

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

Fortgeschrittene Funktionen

int tf_barometer_v2_set_calibration(TF_BarometerV2 *barometer_v2, int32_t measured_air_pressure, int32_t actual_air_pressure)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • measured_air_pressure – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000]
  • actual_air_pressure – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000]
Rückgabe:
  • e_code – Typ: int

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 an diese Funktion übergeben werden.

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

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

int tf_barometer_v2_get_calibration(TF_BarometerV2 *barometer_v2, int32_t *ret_measured_air_pressure, int32_t *ret_actual_air_pressure)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
Ausgabeparameter:
  • ret_measured_air_pressure – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000]
  • ret_actual_air_pressure – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000]
Rückgabe:
  • e_code – Typ: int

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

int tf_barometer_v2_set_sensor_configuration(TF_BarometerV2 *barometer_v2, uint8_t data_rate, uint8_t air_pressure_low_pass_filter)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • data_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 4
  • air_pressure_low_pass_filter – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:
  • e_code – Typ: int

Konfiguriert die Datenrate und den Luftdrucktiefpassfilter. Die Grenzfrequenz des Tiefpassfilters (falls aktiviert) kann auf 1/9 oder 1/20 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 folgenden Konstanten sind für diese Funktion verfügbar:

Für data_rate:

  • TF_BAROMETER_V2_DATA_RATE_OFF = 0
  • TF_BAROMETER_V2_DATA_RATE_1HZ = 1
  • TF_BAROMETER_V2_DATA_RATE_10HZ = 2
  • TF_BAROMETER_V2_DATA_RATE_25HZ = 3
  • TF_BAROMETER_V2_DATA_RATE_50HZ = 4
  • TF_BAROMETER_V2_DATA_RATE_75HZ = 5

Für air_pressure_low_pass_filter:

  • TF_BAROMETER_V2_LOW_PASS_FILTER_OFF = 0
  • TF_BAROMETER_V2_LOW_PASS_FILTER_1_9TH = 1
  • TF_BAROMETER_V2_LOW_PASS_FILTER_1_20TH = 2
int tf_barometer_v2_get_sensor_configuration(TF_BarometerV2 *barometer_v2, uint8_t *ret_data_rate, uint8_t *ret_air_pressure_low_pass_filter)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
Ausgabeparameter:
  • ret_data_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 4
  • ret_air_pressure_low_pass_filter – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:
  • e_code – Typ: int

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

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

Für ret_data_rate:

  • TF_BAROMETER_V2_DATA_RATE_OFF = 0
  • TF_BAROMETER_V2_DATA_RATE_1HZ = 1
  • TF_BAROMETER_V2_DATA_RATE_10HZ = 2
  • TF_BAROMETER_V2_DATA_RATE_25HZ = 3
  • TF_BAROMETER_V2_DATA_RATE_50HZ = 4
  • TF_BAROMETER_V2_DATA_RATE_75HZ = 5

Für ret_air_pressure_low_pass_filter:

  • TF_BAROMETER_V2_LOW_PASS_FILTER_OFF = 0
  • TF_BAROMETER_V2_LOW_PASS_FILTER_1_9TH = 1
  • TF_BAROMETER_V2_LOW_PASS_FILTER_1_20TH = 2
int tf_barometer_v2_get_spitfp_error_count(TF_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)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
Ausgabeparameter:
  • ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 232 - 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_barometer_v2_set_status_led_config(TF_BarometerV2 *barometer_v2, uint8_t config)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • 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_BAROMETER_V2_STATUS_LED_CONFIG_OFF = 0
  • TF_BAROMETER_V2_STATUS_LED_CONFIG_ON = 1
  • TF_BAROMETER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • TF_BAROMETER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int tf_barometer_v2_get_status_led_config(TF_BarometerV2 *barometer_v2, uint8_t *ret_config)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
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_barometer_v2_set_status_led_config() gesetzt.

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

Für ret_config:

  • TF_BAROMETER_V2_STATUS_LED_CONFIG_OFF = 0
  • TF_BAROMETER_V2_STATUS_LED_CONFIG_ON = 1
  • TF_BAROMETER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • TF_BAROMETER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int tf_barometer_v2_get_chip_temperature(TF_BarometerV2 *barometer_v2, int16_t *ret_temperature)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
Ausgabeparameter:
  • ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 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_barometer_v2_reset(TF_BarometerV2 *barometer_v2)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
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_barometer_v2_get_identity(TF_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)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
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 216 - 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_barometer_v2_set_air_pressure_callback_configuration(TF_BarometerV2 *barometer_v2, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 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/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 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.

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

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

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

Der option-Parameter zusammen mit min/max setzt einen Threshold für den Air 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_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'
int tf_barometer_v2_get_air_pressure_callback_configuration(TF_BarometerV2 *barometer_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 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/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • ret_max – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • e_code – Typ: int

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

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

Für ret_option:

  • TF_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'
int tf_barometer_v2_set_altitude_callback_configuration(TF_BarometerV2 *barometer_v2, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 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 mm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32_t, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • e_code – Typ: int

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

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

Für option:

  • TF_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'
int tf_barometer_v2_get_altitude_callback_configuration(TF_BarometerV2 *barometer_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 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 mm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • ret_max – Typ: int32_t, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • e_code – Typ: int

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

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

Für ret_option:

  • TF_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'
int tf_barometer_v2_set_temperature_callback_configuration(TF_BarometerV2 *barometer_v2, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 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: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 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_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'
int tf_barometer_v2_get_temperature_callback_configuration(TF_BarometerV2 *barometer_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 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: [-231 bis 231 - 1], Standardwert: 0
  • ret_max – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • e_code – Typ: int

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

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

Für ret_option:

  • TF_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • TF_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • TF_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 entsprechenden tf_barometer_v2_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_barometer_v2_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_barometer_v2_register_air_pressure_callback(TF_BarometerV2 *barometer_v2, TF_BarometerV2_AirPressureHandler handler, void *user_data)
void handler(TF_BarometerV2 *barometer_v2, int32_t air_pressure, void *user_data)
Callback-Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • air_pressure – Typ: int32_t, Einheit: 1/1000 hPa, Wertebereich: [260000 bis 1260000]
  • user_data – Typ: void *

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

Der Parameter ist der gleiche wie tf_barometer_v2_get_air_pressure().

int tf_barometer_v2_register_altitude_callback(TF_BarometerV2 *barometer_v2, TF_BarometerV2_AltitudeHandler handler, void *user_data)
void handler(TF_BarometerV2 *barometer_v2, int32_t altitude, void *user_data)
Callback-Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • altitude – Typ: int32_t, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1]
  • user_data – Typ: void *

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

Der Parameter ist der gleiche wie tf_barometer_v2_get_altitude().

int tf_barometer_v2_register_temperature_callback(TF_BarometerV2 *barometer_v2, TF_BarometerV2_TemperatureHandler handler, void *user_data)
void handler(TF_BarometerV2 *barometer_v2, int32_t temperature, void *user_data)
Callback-Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • temperature – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-4000 bis 8500]
  • user_data – Typ: void *

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

Der Parameter ist der gleiche wie tf_barometer_v2_get_temperature().

Virtuelle Funktionen

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

int tf_barometer_v2_get_response_expected(TF_BarometerV2 *barometer_v2, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • 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_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.

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

Für function_id:

  • TF_BAROMETER_V2_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 2
  • TF_BAROMETER_V2_FUNCTION_SET_ALTITUDE_CALLBACK_CONFIGURATION = 6
  • TF_BAROMETER_V2_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 10
  • TF_BAROMETER_V2_FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 13
  • TF_BAROMETER_V2_FUNCTION_SET_REFERENCE_AIR_PRESSURE = 15
  • TF_BAROMETER_V2_FUNCTION_SET_CALIBRATION = 17
  • TF_BAROMETER_V2_FUNCTION_SET_SENSOR_CONFIGURATION = 19
  • TF_BAROMETER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • TF_BAROMETER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • TF_BAROMETER_V2_FUNCTION_RESET = 243
  • TF_BAROMETER_V2_FUNCTION_WRITE_UID = 248
int tf_barometer_v2_set_response_expected(TF_BarometerV2 *barometer_v2, uint8_t function_id, bool response_expected)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • 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.

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_BAROMETER_V2_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 2
  • TF_BAROMETER_V2_FUNCTION_SET_ALTITUDE_CALLBACK_CONFIGURATION = 6
  • TF_BAROMETER_V2_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 10
  • TF_BAROMETER_V2_FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 13
  • TF_BAROMETER_V2_FUNCTION_SET_REFERENCE_AIR_PRESSURE = 15
  • TF_BAROMETER_V2_FUNCTION_SET_CALIBRATION = 17
  • TF_BAROMETER_V2_FUNCTION_SET_SENSOR_CONFIGURATION = 19
  • TF_BAROMETER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • TF_BAROMETER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • TF_BAROMETER_V2_FUNCTION_RESET = 243
  • TF_BAROMETER_V2_FUNCTION_WRITE_UID = 248
int tf_barometer_v2_set_response_expected_all(TF_BarometerV2 *barometer_v2, bool response_expected)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • 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_barometer_v2_set_bootloader_mode(TF_BarometerV2 *barometer_v2, uint8_t mode, uint8_t *ret_status)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • 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_BAROMETER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • TF_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • TF_BAROMETER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • TF_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • TF_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

  • TF_BAROMETER_V2_BOOTLOADER_STATUS_OK = 0
  • TF_BAROMETER_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • TF_BAROMETER_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • TF_BAROMETER_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • TF_BAROMETER_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • TF_BAROMETER_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int tf_barometer_v2_get_bootloader_mode(TF_BarometerV2 *barometer_v2, uint8_t *ret_mode)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
Ausgabeparameter:
  • ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • e_code – Typ: int

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

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

Für ret_mode:

  • TF_BAROMETER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • TF_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • TF_BAROMETER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • TF_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • TF_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int tf_barometer_v2_set_write_firmware_pointer(TF_BarometerV2 *barometer_v2, uint32_t pointer)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • e_code – Typ: int

Setzt den Firmware-Pointer für tf_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 tf_barometer_v2_write_firmware(TF_BarometerV2 *barometer_v2, const uint8_t data[64], uint8_t *ret_status)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • 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_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 tf_barometer_v2_write_uid(TF_BarometerV2 *barometer_v2, uint32_t uid)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
  • uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 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_barometer_v2_read_uid(TF_BarometerV2 *barometer_v2, uint32_t *ret_uid)
Parameter:
  • barometer_v2 – Typ: TF_BarometerV2 *
Ausgabeparameter:
  • ret_uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 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_BAROMETER_V2_DEVICE_IDENTIFIER

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

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

TF_BAROMETER_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Barometer Bricklet 2.0 dar.