C/C++ - Compass Bricklet

Dies ist die Beschreibung der C/C++ API Bindings für das Compass Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Compass Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die C/C++ API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.c)

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

#include "ip_connection.h"
#include "bricklet_compass.h"

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

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

    // Create device object
    Compass c;
    compass_create(&c, 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 heading
    int16_t heading;
    if(compass_get_heading(&c, &heading) < 0) {
        fprintf(stderr, "Could not get heading, probably timeout\n");
        return 1;
    }

    printf("Heading: %f °\n", heading/10.0);

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

Callback

Download (example_callback.c)

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

#include "ip_connection.h"
#include "bricklet_compass.h"

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

// Callback function for heading callback
void cb_heading(int16_t heading, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Heading: %f °\n", heading/10.0);
}

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

    // Create device object
    Compass c;
    compass_create(&c, 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 heading callback to function cb_heading
    compass_register_callback(&c,
                              COMPASS_CALLBACK_HEADING,
                              (void (*)(void))cb_heading,
                              NULL);

    // Set period for heading callback to 0.1s (100ms) without a threshold
    compass_set_heading_callback_configuration(&c, 100, false, 'x', 0, 0);

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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void compass_create(Compass *compass, const char *uid, IPConnection *ipcon)
Parameter:
  • compass – Typ: Compass *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

Compass compass;
compass_create(&compass, "YOUR_DEVICE_UID", &ipcon);

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

void compass_destroy(Compass *compass)
Parameter:
  • compass – Typ: Compass *

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

int compass_get_heading(Compass *compass, int16_t *ret_heading)
Parameter:
  • compass – Typ: Compass *
Ausgabeparameter:
  • ret_heading – Typ: int16_t, Einheit: 1/10 °, Wertebereich: [0 bis 3600]
Rückgabe:
  • error_code – Typ: int

Gibt die Richtung zurück (Norden = 0 Grad, Osten = 90 Grad).

Alternativ kann die Funktion compass_get_magnetic_flux_density() genutzt werden um die Richtung per heading = atan2(y, x) * 180 / PI zu bestimmen.

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

int compass_get_magnetic_flux_density(Compass *compass, int32_t *ret_x, int32_t *ret_y, int32_t *ret_z)
Parameter:
  • compass – Typ: Compass *
Ausgabeparameter:
  • ret_x – Typ: int32_t, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000]
  • ret_y – Typ: int32_t, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000]
  • ret_z – Typ: int32_t, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000]
Rückgabe:
  • error_code – Typ: int

Gibt die magnetische Flussdichte (magnetische Induktion) für alle drei Achsen zurück.

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

int compass_set_configuration(Compass *compass, uint8_t data_rate, bool background_calibration)
Parameter:
  • compass – Typ: Compass *
  • data_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
  • background_calibration – Typ: bool, Standardwert: true
Rückgabe:
  • error_code – Typ: int

Konfiguriert die Datenrate und Hintergrundkalibrierung:

  • Data Rate: Setzt die Datenrate des eingesetzten Magnetometers. Je niedriger die Datenrate ist, desto weniger Rauschen befindet sich auf den Daten.
  • Background Calibration: Aktiviert die automatische Hintergrundkalibrierung, wenn auf true gesetzt. Wenn die Hintergrundkalibrierung aktiviert ist, ändert das Bricklet einmal pro Sekunde die Erfassungspolarität, um damit automatisch temperaturabhängige Offsets zu entfernen. Das Ändern der Polarität dauert ungefähr 20ms. Daher werden einmal pro Sekunde für 20ms keine neuen Daten generiert, wenn die Kalibrierung aktiviert ist. Wir empfehlen die Kalibrierung nur zu deaktivieren, falls diese 20ms Auszeit ein großes Problem in der Anwendung des Bricklets darstellen.

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

Für data_rate:

  • COMPASS_DATA_RATE_100HZ = 0
  • COMPASS_DATA_RATE_200HZ = 1
  • COMPASS_DATA_RATE_400HZ = 2
  • COMPASS_DATA_RATE_600HZ = 3
int compass_get_configuration(Compass *compass, uint8_t *ret_data_rate, bool *ret_background_calibration)
Parameter:
  • compass – Typ: Compass *
Ausgabeparameter:
  • ret_data_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
  • ret_background_calibration – Typ: bool, Standardwert: true
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_data_rate:

  • COMPASS_DATA_RATE_100HZ = 0
  • COMPASS_DATA_RATE_200HZ = 1
  • COMPASS_DATA_RATE_400HZ = 2
  • COMPASS_DATA_RATE_600HZ = 3

Fortgeschrittene Funktionen

int compass_set_calibration(Compass *compass, int16_t offset[3], int16_t gain[3])
Parameter:
  • compass – Typ: Compass *
  • offset – Typ: int16_t[3]
    • 0: x – Typ: int16_t, Einheit: 1/100 µT, Wertebereich: [-215 bis 215 - 1]
    • 1: y – Typ: int16_t, Einheit: 1/100 µT, Wertebereich: [-215 bis 215 - 1]
    • 2: z – Typ: int16_t, Einheit: 1/100 µT, Wertebereich: [-215 bis 215 - 1]
  • gain – Typ: int16_t[3]
    • 0: x – Typ: int16_t, Wertebereich: [-215 bis 215 - 1]
    • 1: y – Typ: int16_t, Wertebereich: [-215 bis 215 - 1]
    • 2: z – Typ: int16_t, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • error_code – Typ: int

Setzt Offset und Gain für alle drei Achsen.

Das Bricklet ist ab Werk kalibriert. Wenn eine Rekalibrierung durchgeführt werden soll, empfehlen wir dafür den Brick Viewer zu nutzen.

Die Kalibrierung wird in nicht-flüchtigem Speicher gespeichert und muss nur einmal durchgeführt werden.

int compass_get_calibration(Compass *compass, int16_t ret_offset[3], int16_t ret_gain[3])
Parameter:
  • compass – Typ: Compass *
Ausgabeparameter:
  • ret_offset – Typ: int16_t[3]
    • 0: x – Typ: int16_t, Einheit: 1/100 µT, Wertebereich: [-215 bis 215 - 1]
    • 1: y – Typ: int16_t, Einheit: 1/100 µT, Wertebereich: [-215 bis 215 - 1]
    • 2: z – Typ: int16_t, Einheit: 1/100 µT, Wertebereich: [-215 bis 215 - 1]
  • ret_gain – Typ: int16_t[3]
    • 0: x – Typ: int16_t, Wertebereich: [-215 bis 215 - 1]
    • 1: y – Typ: int16_t, Wertebereich: [-215 bis 215 - 1]
    • 2: z – Typ: int16_t, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die Kalibrierungsparameter zurück, wie von compass_set_calibration() gesetzt.

int compass_get_spitfp_error_count(Compass *compass, 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:
  • compass – Typ: Compass *
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:
  • error_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 compass_set_bootloader_mode(Compass *compass, uint8_t mode, uint8_t *ret_status)
Parameter:
  • compass – Typ: Compass *
  • mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_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:

  • COMPASS_BOOTLOADER_MODE_BOOTLOADER = 0
  • COMPASS_BOOTLOADER_MODE_FIRMWARE = 1
  • COMPASS_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • COMPASS_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • COMPASS_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

  • COMPASS_BOOTLOADER_STATUS_OK = 0
  • COMPASS_BOOTLOADER_STATUS_INVALID_MODE = 1
  • COMPASS_BOOTLOADER_STATUS_NO_CHANGE = 2
  • COMPASS_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • COMPASS_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • COMPASS_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int compass_get_bootloader_mode(Compass *compass, uint8_t *ret_mode)
Parameter:
  • compass – Typ: Compass *
Ausgabeparameter:
  • ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_mode:

  • COMPASS_BOOTLOADER_MODE_BOOTLOADER = 0
  • COMPASS_BOOTLOADER_MODE_FIRMWARE = 1
  • COMPASS_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • COMPASS_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • COMPASS_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int compass_set_write_firmware_pointer(Compass *compass, uint32_t pointer)
Parameter:
  • compass – Typ: Compass *
  • pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Setzt den Firmware-Pointer für compass_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 compass_write_firmware(Compass *compass, uint8_t data[64], uint8_t *ret_status)
Parameter:
  • compass – Typ: Compass *
  • data – Typ: uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von compass_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 compass_set_status_led_config(Compass *compass, uint8_t config)
Parameter:
  • compass – Typ: Compass *
  • config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • error_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:

  • COMPASS_STATUS_LED_CONFIG_OFF = 0
  • COMPASS_STATUS_LED_CONFIG_ON = 1
  • COMPASS_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • COMPASS_STATUS_LED_CONFIG_SHOW_STATUS = 3
int compass_get_status_led_config(Compass *compass, uint8_t *ret_config)
Parameter:
  • compass – Typ: Compass *
Ausgabeparameter:
  • ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_config:

  • COMPASS_STATUS_LED_CONFIG_OFF = 0
  • COMPASS_STATUS_LED_CONFIG_ON = 1
  • COMPASS_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • COMPASS_STATUS_LED_CONFIG_SHOW_STATUS = 3
int compass_get_chip_temperature(Compass *compass, int16_t *ret_temperature)
Parameter:
  • compass – Typ: Compass *
Ausgabeparameter:
  • ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • error_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 compass_reset(Compass *compass)
Parameter:
  • compass – Typ: Compass *
Rückgabe:
  • error_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 compass_write_uid(Compass *compass, uint32_t uid)
Parameter:
  • compass – Typ: Compass *
  • uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_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 compass_read_uid(Compass *compass, uint32_t *ret_uid)
Parameter:
  • compass – Typ: Compass *
Ausgabeparameter:
  • ret_uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_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.

int compass_get_identity(Compass *compass, 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:
  • compass – Typ: Compass *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'i', '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:
  • error_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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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 compass_register_callback(Compass *compass, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • compass – Typ: Compass *
  • 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 compass_set_heading_callback_configuration(Compass *compass, uint32_t period, bool value_has_to_change, char option, int16_t min, int16_t max)
Parameter:
  • compass – Typ: Compass *
  • 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: int16_t, Einheit: 1/10 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: int16_t, Einheit: 1/10 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

  • COMPASS_THRESHOLD_OPTION_OFF = 'x'
  • COMPASS_THRESHOLD_OPTION_OUTSIDE = 'o'
  • COMPASS_THRESHOLD_OPTION_INSIDE = 'i'
  • COMPASS_THRESHOLD_OPTION_SMALLER = '<'
  • COMPASS_THRESHOLD_OPTION_GREATER = '>'
int compass_get_heading_callback_configuration(Compass *compass, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int16_t *ret_min, int16_t *ret_max)
Parameter:
  • compass – Typ: Compass *
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: int16_t, Einheit: 1/10 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • ret_max – Typ: int16_t, Einheit: 1/10 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_option:

  • COMPASS_THRESHOLD_OPTION_OFF = 'x'
  • COMPASS_THRESHOLD_OPTION_OUTSIDE = 'o'
  • COMPASS_THRESHOLD_OPTION_INSIDE = 'i'
  • COMPASS_THRESHOLD_OPTION_SMALLER = '<'
  • COMPASS_THRESHOLD_OPTION_GREATER = '>'
int compass_set_magnetic_flux_density_callback_configuration(Compass *compass, uint32_t period, bool value_has_to_change)
Parameter:
  • compass – Typ: Compass *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

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

int compass_get_magnetic_flux_density_callback_configuration(Compass *compass, uint32_t *ret_period, bool *ret_value_has_to_change)
Parameter:
  • compass – Typ: Compass *
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
Rückgabe:
  • error_code – Typ: int

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

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der compass_register_callback() Funktion durchgeführt werden:

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

compass_register_callback(&compass,
                          COMPASS_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.

COMPASS_CALLBACK_HEADING
void callback(int16_t heading, void *user_data)
Callback-Parameter:
  • heading – Typ: int16_t, Einheit: 1/10 °, Wertebereich: [0 bis 3600]
  • user_data – Typ: void *

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

Der Parameter ist der gleiche wie compass_get_heading().

COMPASS_CALLBACK_MAGNETIC_FLUX_DENSITY
void callback(int32_t x, int32_t y, int32_t z, void *user_data)
Callback-Parameter:
  • x – Typ: int32_t, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000]
  • y – Typ: int32_t, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000]
  • z – Typ: int32_t, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000]
  • user_data – Typ: void *

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

Die Parameter sind der gleichen wie compass_get_magnetic_flux_density().

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 compass_get_api_version(Compass *compass, uint8_t ret_api_version[3])
Parameter:
  • compass – Typ: Compass *
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:
  • error_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 compass_get_response_expected(Compass *compass, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • compass – Typ: Compass *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_response_expected – Typ: bool
Rückgabe:
  • error_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 compass_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:

  • COMPASS_FUNCTION_SET_HEADING_CALLBACK_CONFIGURATION = 2
  • COMPASS_FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 6
  • COMPASS_FUNCTION_SET_CONFIGURATION = 9
  • COMPASS_FUNCTION_SET_CALIBRATION = 11
  • COMPASS_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • COMPASS_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • COMPASS_FUNCTION_RESET = 243
  • COMPASS_FUNCTION_WRITE_UID = 248
int compass_set_response_expected(Compass *compass, uint8_t function_id, bool response_expected)
Parameter:
  • compass – Typ: Compass *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • error_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:

  • COMPASS_FUNCTION_SET_HEADING_CALLBACK_CONFIGURATION = 2
  • COMPASS_FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 6
  • COMPASS_FUNCTION_SET_CONFIGURATION = 9
  • COMPASS_FUNCTION_SET_CALIBRATION = 11
  • COMPASS_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • COMPASS_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • COMPASS_FUNCTION_RESET = 243
  • COMPASS_FUNCTION_WRITE_UID = 248
int compass_set_response_expected_all(Compass *compass, bool response_expected)
Parameter:
  • compass – Typ: Compass *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

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

Konstanten

COMPASS_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Compass Bricklet zu identifizieren.

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

COMPASS_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Compass Bricklet dar.