C/C++ - Distance US Bricklet

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

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

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

    // Create device object
    DistanceUS dus;
    distance_us_create(&dus, 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 distance value
    uint16_t distance;
    if(distance_us_get_distance_value(&dus, &distance) < 0) {
        fprintf(stderr, "Could not get distance value, probably timeout\n");
        return 1;
    }

    printf("Distance Value: %u\n", distance);

    printf("Press key to exit\n");
    getchar();
    distance_us_destroy(&dus);
    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_distance_us.h"

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

// Callback function for distance value callback
void cb_distance(uint16_t distance, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Distance Value: %u\n", distance);
}

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

    // Create device object
    DistanceUS dus;
    distance_us_create(&dus, 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 distance value callback to function cb_distance
    distance_us_register_callback(&dus,
                                  DISTANCE_US_CALLBACK_DISTANCE,
                                  (void (*)(void))cb_distance,
                                  NULL);

    // Set period for distance value callback to 0.2s (200ms)
    // Note: The distance value callback is only called every 0.2 seconds
    //       if the distance value has changed since the last call!
    distance_us_set_distance_callback_period(&dus, 200);

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

Threshold

Download (example_threshold.c)

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

#include "ip_connection.h"
#include "bricklet_distance_us.h"

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

// Callback function for distance value reached callback
void cb_distance_reached(uint16_t distance, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Distance Value: %u\n", distance);
}

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

    // Create device object
    DistanceUS dus;
    distance_us_create(&dus, 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 10 seconds (10000ms)
    distance_us_set_debounce_period(&dus, 10000);

    // Register distance value reached callback to function cb_distance_reached
    distance_us_register_callback(&dus,
                                  DISTANCE_US_CALLBACK_DISTANCE_REACHED,
                                  (void (*)(void))cb_distance_reached,
                                  NULL);

    // Configure threshold for distance value "smaller than 200"
    distance_us_set_distance_callback_threshold(&dus, '<', 200, 0);

    printf("Press key to exit\n");
    getchar();
    distance_us_destroy(&dus);
    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 distance_us_create(DistanceUS *distance_us, const char *uid, IPConnection *ipcon)
Parameter:
  • distance_us – Typ: DistanceUS *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

DistanceUS distance_us;
distance_us_create(&distance_us, "YOUR_DEVICE_UID", &ipcon);

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

void distance_us_destroy(DistanceUS *distance_us)
Parameter:
  • distance_us – Typ: DistanceUS *

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

int distance_us_get_distance_value(DistanceUS *distance_us, uint16_t *ret_distance)
Parameter:
  • distance_us – Typ: DistanceUS *
Ausgabeparameter:
  • ret_distance – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt den aktuellen Entfernungswert zurück. Der Wert hat einen Wertebereich von 0 bis 4095. Ein kleiner Wert entspricht einer kleinen Entfernung, ein großer Wert entspricht einer großen Entfernung. Das Verhältnis zwischen gemessenem Entfernungswert und wirklicher Entfernung wird durch die 5V Versorgungsspannung beeinflusst (Abweichungen der Versorgungsspannung führen zu Abweichungen in den Entfernungswerten) und ist nicht-linear (Auflösung ist größer im Nahbereich).

Wenn der Entfernungswert periodisch abgefragt werden soll, wird empfohlen den DISTANCE_US_CALLBACK_DISTANCE Callback zu nutzen und die Periode mit distance_us_set_distance_callback_period() vorzugeben.

Fortgeschrittene Funktionen

int distance_us_set_moving_average(DistanceUS *distance_us, uint8_t average)
Parameter:
  • distance_us – Typ: DistanceUS *
  • average – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Setzt die Länge eines gleitenden Mittelwerts für den Entfernungswert.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 0-100.

Der Standardwert ist 20.

int distance_us_get_moving_average(DistanceUS *distance_us, uint8_t *ret_average)
Parameter:
  • distance_us – Typ: DistanceUS *
Ausgabeparameter:
  • ret_average – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Gibt die Länge des gleitenden Mittelwerts zurück, wie von distance_us_set_moving_average() gesetzt.

int distance_us_get_api_version(DistanceUS *distance_us, uint8_t ret_api_version[3])
Parameter:
  • distance_us – Typ: DistanceUS *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

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 distance_us_get_response_expected(DistanceUS *distance_us, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • distance_us – Typ: DistanceUS *
  • 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 distance_us_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:

  • DISTANCE_US_FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 2
  • DISTANCE_US_FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 4
  • DISTANCE_US_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • DISTANCE_US_FUNCTION_SET_MOVING_AVERAGE = 10
int distance_us_set_response_expected(DistanceUS *distance_us, uint8_t function_id, bool response_expected)
Parameter:
  • distance_us – Typ: DistanceUS *
  • 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:

  • DISTANCE_US_FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 2
  • DISTANCE_US_FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 4
  • DISTANCE_US_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • DISTANCE_US_FUNCTION_SET_MOVING_AVERAGE = 10
int distance_us_set_response_expected_all(DistanceUS *distance_us, bool response_expected)
Parameter:
  • distance_us – Typ: DistanceUS *
  • 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.

int distance_us_get_identity(DistanceUS *distance_us, 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:
  • distance_us – Typ: DistanceUS *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char
  • ret_hardware_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
  • ret_firmware_version – Typ: uint8_t[3], 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 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 distance_us_register_callback(DistanceUS *distance_us, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • distance_us – Typ: DistanceUS *
  • 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 distance_us_set_distance_callback_period(DistanceUS *distance_us, uint32_t period)
Parameter:
  • distance_us – Typ: DistanceUS *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

Der DISTANCE_US_CALLBACK_DISTANCE Callback wird nur ausgelöst, wenn sich der Entfernungswert seit der letzten Auslösung geändert hat.

int distance_us_get_distance_callback_period(DistanceUS *distance_us, uint32_t *ret_period)
Parameter:
  • distance_us – Typ: DistanceUS *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

int distance_us_set_distance_callback_threshold(DistanceUS *distance_us, char option, uint16_t min, uint16_t max)
Parameter:
  • distance_us – Typ: DistanceUS *
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • max – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Setzt den Schwellwert für den DISTANCE_US_CALLBACK_DISTANCE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

Der Standardwert ist ('x', 0, 0).

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

Für option:

  • DISTANCE_US_THRESHOLD_OPTION_OFF = 'x'
  • DISTANCE_US_THRESHOLD_OPTION_OUTSIDE = 'o'
  • DISTANCE_US_THRESHOLD_OPTION_INSIDE = 'i'
  • DISTANCE_US_THRESHOLD_OPTION_SMALLER = '<'
  • DISTANCE_US_THRESHOLD_OPTION_GREATER = '>'
int distance_us_get_distance_callback_threshold(DistanceUS *distance_us, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)
Parameter:
  • distance_us – Typ: DistanceUS *
Ausgabeparameter:
  • ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • ret_min – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • ret_max – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_option:

  • DISTANCE_US_THRESHOLD_OPTION_OFF = 'x'
  • DISTANCE_US_THRESHOLD_OPTION_OUTSIDE = 'o'
  • DISTANCE_US_THRESHOLD_OPTION_INSIDE = 'i'
  • DISTANCE_US_THRESHOLD_OPTION_SMALLER = '<'
  • DISTANCE_US_THRESHOLD_OPTION_GREATER = '>'
int distance_us_set_debounce_period(DistanceUS *distance_us, uint32_t debounce)
Parameter:
  • distance_us – Typ: DistanceUS *
  • debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:
  • error_code – Typ: int

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

int distance_us_get_debounce_period(DistanceUS *distance_us, uint32_t *ret_debounce)
Parameter:
  • distance_us – Typ: DistanceUS *
Ausgabeparameter:
  • ret_debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:
  • error_code – Typ: int

Gibt die Entprellperiode zurück, wie von distance_us_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 distance_us_register_callback() Funktion durchgeführt werden:

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

distance_us_register_callback(&distance_us, DISTANCE_US_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.

DISTANCE_US_CALLBACK_DISTANCE
void callback(uint16_t distance, void *user_data)
Callback-Parameter:
  • distance – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit distance_us_set_distance_callback_period(), ausgelöst. Der Parameter ist die Entfernungswert des Sensors.

Der DISTANCE_US_CALLBACK_DISTANCE Callback wird nur ausgelöst, wenn sich der Entfernungswert seit der letzten Auslösung geändert hat.

DISTANCE_US_CALLBACK_DISTANCE_REACHED
void callback(uint16_t distance, void *user_data)
Callback-Parameter:
  • distance – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von distance_us_set_distance_callback_threshold() gesetzt, erreicht wird. Der Parameter ist der Entfernungswert des Sensors.

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

Konstanten

DISTANCE_US_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Distance US Bricklet zu identifizieren.

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

DISTANCE_US_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Distance US Bricklet dar.