C/C++ - Hall Effect Bricklet

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

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

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

    // Create device object
    HallEffect he;
    hall_effect_create(&he, 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 edge count without reset
    uint32_t count;
    if(hall_effect_get_edge_count(&he, false, &count) < 0) {
        fprintf(stderr, "Could not get edge count without reset, probably timeout\n");
        return 1;
    }

    printf("Count: %u\n", count);

    printf("Press key to exit\n");
    getchar();
    hall_effect_destroy(&he);
    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
48
49
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_hall_effect.h"

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

// Callback function for edge count callback
void cb_edge_count(uint32_t count, bool value, void *user_data) {
    (void)value; (void)user_data; // avoid unused parameter warning

    printf("Count: %u\n", count);
}

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

    // Create device object
    HallEffect he;
    hall_effect_create(&he, 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 edge count callback to function cb_edge_count
    hall_effect_register_callback(&he,
                                  HALL_EFFECT_CALLBACK_EDGE_COUNT,
                                  (void (*)(void))cb_edge_count,
                                  NULL);

    // Set period for edge count callback to 0.05s (50ms)
    // Note: The edge count callback is only called every 0.05 seconds
    //       if the edge count has changed since the last call!
    hall_effect_set_edge_count_callback_period(&he, 50);

    printf("Press key to exit\n");
    getchar();
    hall_effect_destroy(&he);
    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 hall_effect_create(HallEffect *hall_effect, const char *uid, IPConnection *ipcon)

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

HallEffect hall_effect;
hall_effect_create(&hall_effect, "YOUR_DEVICE_UID", &ipcon);

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

void hall_effect_destroy(HallEffect *hall_effect)

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

int hall_effect_get_value(HallEffect *hall_effect, bool *ret_value)

Gibt true zurück wenn ein Magnetfeld mit 35 Gauss (3,5mT) oder größer detektiert wird.

int hall_effect_get_edge_count(HallEffect *hall_effect, bool reset_counter, uint32_t *ret_count)

Gibt den aktuellen Wert des Flankenzählers zurück. Die zu zählenden Flanken (steigend, fallend, beide) können mit hall_effect_set_edge_count_config() konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

Fortgeschrittene Funktionen

int hall_effect_set_edge_count_config(HallEffect *hall_effect, uint8_t edge_type, uint8_t debounce)

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. Mögliche Flankentypen sind:

  • 0 = steigend (Standard)
  • 1 = fallend
  • 2 = beide

Wird ein Magnet in die Nähe des Bricklets gebracht (>35 Gauss) erzeugt dies ein low-Signal (fallende Flanke), wenn ein Magnet vom Bricklet entfernt (<25 Gauss) wird entsteht ein high-Signal (steigende Flanke).

Die Entprellzeit (debounce) wird in ms angegeben.

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

Standardwerte: 0 (edge type) und 100ms (debounce).

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

  • HALL_EFFECT_EDGE_TYPE_RISING = 0
  • HALL_EFFECT_EDGE_TYPE_FALLING = 1
  • HALL_EFFECT_EDGE_TYPE_BOTH = 2
int hall_effect_get_edge_count_config(HallEffect *hall_effect, uint8_t *ret_edge_type, uint8_t *ret_debounce)

Gibt den Flankentyp sowie die Entprellzeit zurück, wie von hall_effect_set_edge_count_config() gesetzt.

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

  • HALL_EFFECT_EDGE_TYPE_RISING = 0
  • HALL_EFFECT_EDGE_TYPE_FALLING = 1
  • HALL_EFFECT_EDGE_TYPE_BOTH = 2
int hall_effect_get_api_version(HallEffect *hall_effect, 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 hall_effect_get_response_expected(HallEffect *hall_effect, 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 hall_effect_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 hall_effect_set_response_expected() für die Liste der verfügbaren Funktions ID Defines für diese Funktion.

int hall_effect_set_response_expected(HallEffect *hall_effect, 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:

  • HALL_EFFECT_FUNCTION_SET_EDGE_COUNT_CONFIG = 3
  • HALL_EFFECT_FUNCTION_SET_EDGE_INTERRUPT = 5
  • HALL_EFFECT_FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7
int hall_effect_set_response_expected_all(HallEffect *hall_effect, bool response_expected)

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

int hall_effect_get_identity(HallEffect *hall_effect, 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 hall_effect_register_callback(HallEffect *hall_effect, 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 hall_effect_set_edge_interrupt(HallEffect *hall_effect, uint32_t edges)

Setzt die Anzahl der zu zählenden Flanken bis ein Interrupt aufgerufen wird.

Wenn edges auf n gesetzt ist, wird der Interrupt nach jeder n-ten detektierten Flanke aufgerufen.

Wenn edges auf 0 gesetzt ist, wird der Interrupt deaktiviert.

Standardwert ist 0.

int hall_effect_get_edge_interrupt(HallEffect *hall_effect, uint32_t *ret_edges)

Gibt edges zurück, wie von hall_effect_set_edge_interrupt() gesetzt.

int hall_effect_set_edge_count_callback_period(HallEffect *hall_effect, uint32_t period)

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

Der HALL_EFFECT_CALLBACK_EDGE_COUNT Callback wird nur ausgelöst, wenn sich die Flankenzählung seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

int hall_effect_get_edge_count_callback_period(HallEffect *hall_effect, uint32_t *ret_period)

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

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion hall_effect_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);
}

hall_effect_register_callback(&hall_effect, HALL_EFFECT_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.

HALL_EFFECT_CALLBACK_EDGE_COUNT
void callback(uint32_t count, bool value, void *user_data)

Dieser Callback wird mit der Periode, wie gesetzt mit hall_effect_set_edge_count_callback_period(), ausgelöst. Die Parameter sind der aktuelle Zählerstand und der aktuelle Wert (siehe hall_effect_get_value() and hall_effect_get_edge_count()).

Der HALL_EFFECT_CALLBACK_EDGE_COUNT Callback wird nur ausgelöst, wenn sich mindestens einer der beiden Werte seit der letzten Auslösung geändert hat.

Konstanten

HALL_EFFECT_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Hall Effect Bricklet zu identifizieren.

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

HALL_EFFECT_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Hall Effect Bricklet dar.