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

C/C++ - Line Bricklet¶

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

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_line.h"

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

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

    // Create device object
    Line l;
    line_create(&l, 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 reflectivity
    uint16_t reflectivity;
    if(line_get_reflectivity(&l, &reflectivity) < 0) {
        fprintf(stderr, "Could not get reflectivity, probably timeout\n");
        return 1;
    }

    printf("Reflectivity: %u\n", reflectivity);

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

Callback¶

Download (example_callback.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_line.h"

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

// Callback function for reflectivity callback
void cb_reflectivity(uint16_t reflectivity, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Reflectivity: %u\n", reflectivity);
}

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

    // Create device object
    Line l;
    line_create(&l, 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 reflectivity callback to function cb_reflectivity
    line_register_callback(&l,
                           LINE_CALLBACK_REFLECTIVITY,
                           (void (*)(void))cb_reflectivity,
                           NULL);

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

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

Threshold¶

Download (example_threshold.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_line.h"

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

// Callback function for reflectivity reached callback
void cb_reflectivity_reached(uint16_t reflectivity, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Reflectivity: %u\n", reflectivity);
}

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

    // Create device object
    Line l;
    line_create(&l, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Get threshold callbacks with a debounce time of 1 second (1000ms)
    line_set_debounce_period(&l, 1000);

    // Register reflectivity reached callback to function cb_reflectivity_reached
    line_register_callback(&l,
                           LINE_CALLBACK_REFLECTIVITY_REACHED,
                           (void (*)(void))cb_reflectivity_reached,
                           NULL);

    // Configure threshold for reflectivity "greater than 2000"
    line_set_reflectivity_callback_threshold(&l, '>', 2000, 0);

    printf("Press key to exit\n");
    getchar();
    line_destroy(&l);
    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
E_WRONG_DEVICE_TYPE = -15
E_DEVICE_REPLACED = -16
E_WRONG_RESPONSE_LENGTH = -17

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

void line_create(Line *line, const char *uid, IPConnection *ipcon)¶

Parameter:	line – Typ: Line * uid – Typ: const char * ipcon – Typ: IPConnection *

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

Line line;
line_create(&line, "YOUR_DEVICE_UID", &ipcon);

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

void line_destroy(Line *line)¶

Parameter:	line – Typ: Line *

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

int line_get_reflectivity(Line *line, uint16_t *ret_reflectivity)¶

Parameter:	line – Typ: Line *
Ausgabeparameter:	ret_reflectivity – Typ: uint16_t, Wertebereich: [0 bis 2¹² - 1]
Rückgabe:	error_code – Typ: int

Gibt die aktuell gemessene Reflektivität zurück. Die Reflektivität ist ein Wert zwischen 0 (nicht reflektiv) und 4095 (sehr reflektiv).

Normalerweise hat schwarz eine geringe Reflektivität während weiß eine hohe Reflektivität hat.

Wenn die Reflektivität periodisch abgefragt werden soll, wird empfohlen den LINE_CALLBACK_REFLECTIVITY Callback zu nutzen und die Periode mit line_set_reflectivity_callback_period() vorzugeben.

Fortgeschrittene Funktionen¶

int line_get_identity(Line *line, 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:	line – Typ: Line *
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 2¹⁶ - 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 line_register_callback(Line *line, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	line – Typ: Line * 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 line_set_reflectivity_callback_period(Line *line, uint32_t period)¶

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

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

Der LINE_CALLBACK_REFLECTIVITY Callback wird nur ausgelöst, wenn sich die Reflektivität seit der letzten Auslösung geändert hat.

int line_get_reflectivity_callback_period(Line *line, uint32_t *ret_period)¶

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

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

int line_set_reflectivity_callback_threshold(Line *line, char option, uint16_t min, uint16_t max)¶

Parameter:	line – Typ: Line * option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Rückgabe:	error_code – Typ: int

Setzt den Schwellwert für den LINE_CALLBACK_REFLECTIVITY_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

LINE_THRESHOLD_OPTION_OFF = 'x'
LINE_THRESHOLD_OPTION_OUTSIDE = 'o'
LINE_THRESHOLD_OPTION_INSIDE = 'i'
LINE_THRESHOLD_OPTION_SMALLER = '<'
LINE_THRESHOLD_OPTION_GREATER = '>'

int line_get_reflectivity_callback_threshold(Line *line, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)¶

Parameter:	line – Typ: Line *
Ausgabeparameter:	ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' ret_min – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 ret_max – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Rückgabe:	error_code – Typ: int

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

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

Für ret_option:

LINE_THRESHOLD_OPTION_OFF = 'x'
LINE_THRESHOLD_OPTION_OUTSIDE = 'o'
LINE_THRESHOLD_OPTION_INSIDE = 'i'
LINE_THRESHOLD_OPTION_SMALLER = '<'
LINE_THRESHOLD_OPTION_GREATER = '>'

int line_set_debounce_period(Line *line, uint32_t debounce)¶

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

Setzt die Periode mit welcher die Schwellwert Callback

LINE_CALLBACK_REFLECTIVITY_REACHED

ausgelöst wird, wenn der Schwellwert

line_set_reflectivity_callback_threshold()

weiterhin erreicht bleibt.

int line_get_debounce_period(Line *line, uint32_t *ret_debounce)¶

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

Gibt die Entprellperiode zurück, wie von line_set_debounce_period() gesetzt.

Callbacks¶

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

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

line_register_callback(&line,
                       LINE_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.

LINE_CALLBACK_REFLECTIVITY¶

void callback(uint16_t reflectivity, void *user_data)

Callback-Parameter:	reflectivity – Typ: uint16_t, Wertebereich: [0 bis 2¹² - 1] user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit line_set_reflectivity_callback_period(), ausgelöst. Der Parameter ist die Reflektivität des Sensors.

Der LINE_CALLBACK_REFLECTIVITY Callback wird nur ausgelöst, wenn sich die Reflektivität seit der letzten Auslösung geändert hat.

LINE_CALLBACK_REFLECTIVITY_REACHED¶

void callback(uint16_t reflectivity, void *user_data)

Callback-Parameter:	reflectivity – Typ: uint16_t, Wertebereich: [0 bis 2¹² - 1] user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von line_set_reflectivity_callback_threshold() gesetzt, erreicht wird. Der Parameter ist die Reflektivität des Sensors.

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

Virtuelle Funktionen¶

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

int line_get_api_version(Line *line, uint8_t ret_api_version[3])¶

Parameter:	line – Typ: Line *
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 line_get_response_expected(Line *line, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	line – Typ: Line * 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 line_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:

LINE_FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD = 2
LINE_FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD = 4
LINE_FUNCTION_SET_DEBOUNCE_PERIOD = 6

int line_set_response_expected(Line *line, uint8_t function_id, bool response_expected)¶

Parameter:	line – Typ: Line * 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.

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

Für function_id:

LINE_FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD = 2
LINE_FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD = 4
LINE_FUNCTION_SET_DEBOUNCE_PERIOD = 6

int line_set_response_expected_all(Line *line, bool response_expected)¶

Parameter:	line – Typ: Line * 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¶

LINE_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Line Bricklet zu identifizieren.

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

LINE_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Line Bricklet dar.