C/C++ - Distance IR Bricklet

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

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

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

    // Create device object
    DistanceIR dir;
    distance_ir_create(&dir, 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
    uint16_t distance;
    if(distance_ir_get_distance(&dir, &distance) < 0) {
        fprintf(stderr, "Could not get distance, probably timeout\n");
        return 1;
    }

    printf("Distance: %f cm\n", distance/10.0);

    printf("Press key to exit\n");
    getchar();
    distance_ir_destroy(&dir);
    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_ir.h"

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

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

    printf("Distance: %f cm\n", distance/10.0);
}

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

    // Create device object
    DistanceIR dir;
    distance_ir_create(&dir, 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 callback to function cb_distance
    distance_ir_register_callback(&dir,
                                  DISTANCE_IR_CALLBACK_DISTANCE,
                                  (void *)cb_distance,
                                  NULL);

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

    printf("Press key to exit\n");
    getchar();
    distance_ir_destroy(&dir);
    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_ir.h"

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

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

    printf("Distance: %f cm\n", distance/10.0);
}

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

    // Create device object
    DistanceIR dir;
    distance_ir_create(&dir, 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_ir_set_debounce_period(&dir, 10000);

    // Register distance reached callback to function cb_distance_reached
    distance_ir_register_callback(&dir,
                                  DISTANCE_IR_CALLBACK_DISTANCE_REACHED,
                                  (void *)cb_distance_reached,
                                  NULL);

    // Configure threshold for distance "smaller than 30 cm"
    distance_ir_set_distance_callback_threshold(&dir, '<', 30*10, 0);

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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void distance_ir_create(DistanceIR *distance_ir, const char *uid, IPConnection *ipcon)

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

DistanceIR distance_ir;
distance_ir_create(&distance_ir, "YOUR_DEVICE_UID", &ipcon);

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

void distance_ir_destroy(DistanceIR *distance_ir)

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

int distance_ir_get_distance(DistanceIR *distance_ir, uint16_t *ret_distance)

Gibt die gemessene Entfernung des Sensors zurück. Der Wert ist in mm und die möglichen Entfernungsbereiche sind 40 bis 300, 100 bis 800 und 200 bis 1500, in Abhängigkeit vom gewählten IR Sensor.

Wenn die Entfernung periodisch abgefragt werden soll, wird empfohlen den DISTANCE_IR_CALLBACK_DISTANCE Callback zu nutzen und die Periode mit distance_ir_set_distance_callback_period() vorzugeben.

Fortgeschrittene Funktionen

int distance_ir_get_analog_value(DistanceIR *distance_ir, uint16_t *ret_value)

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Bemerkung

Der von distance_ir_get_distance() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während distance_ir_get_analog_value() unverarbeitete Analogwerte zurück gibt. Der einzige Grund distance_ir_get_analog_value() zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den DISTANCE_IR_CALLBACK_ANALOG_VALUE Callback zu nutzen und die Periode mit distance_ir_set_analog_value_callback_period() vorzugeben.

int distance_ir_set_sampling_point(DistanceIR *distance_ir, uint8_t position, uint16_t distance)

Setzt einen Messpunkt für eine vorgegebene Position in der Wertetabelle. Die Wertetabelle beinhaltet 128 äquidistante Analogwerte mit entsprechenden Entfernungen.

Wenn eine Entfernung von 50cm bei einem Analogwert von 2048 gemessen wird, dann sollte der Aufruf der Funktion mit (64, 5000) erfolgen. Der verwendete Analog-Digital-Wandler hat eine Auflösung von 12 Bit. Mit 128 Messpunkten im gesamten Bereich bedeutet das, dass jeder Messpunkt 32 Analogwerte umfasst. Daher wird dem Analogwert 2048 der Messpunkt 64 = 2048/32 zugeordnet.

Messpunkte werden im EEPROM des Distance IR Bricklet gespeichert und werden bei jedem Hochfahren geladen.

Bemerkung

Ein einfacher Weg, die Messpunkte des Distance IR Bricklet zu kalibrieren, ist im Brick Viewer implementiert. Wenn der Bricklet kalibriert werden soll wird dringend empfohlen diese Implementierung zu nutzen.

int distance_ir_get_sampling_point(DistanceIR *distance_ir, uint8_t position, uint16_t *ret_distance)

Gibt die Entfernung eines Messpunktes zurück, wie von distance_ir_set_sampling_point() gesetzt.

int distance_ir_get_api_version(DistanceIR *distance_ir, 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 distance_ir_get_response_expected(DistanceIR *distance_ir, 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 distance_ir_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 distance_ir_set_response_expected() für die Liste der verfügbaren Funktions ID Defines für diese Funktion.

int distance_ir_set_response_expected(DistanceIR *distance_ir, 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:

  • DISTANCE_IR_FUNCTION_SET_SAMPLING_POINT = 3
  • DISTANCE_IR_FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 5
  • DISTANCE_IR_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • DISTANCE_IR_FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 9
  • DISTANCE_IR_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • DISTANCE_IR_FUNCTION_SET_DEBOUNCE_PERIOD = 13
int distance_ir_set_response_expected_all(DistanceIR *distance_ir, bool response_expected)

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

int distance_ir_get_identity(DistanceIR *distance_ir, 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 Bricklet.

Konfigurationsfunktionen für Callbacks

void distance_ir_register_callback(DistanceIR *distance_ir, int16_t callback_id, void *function, 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 distance_ir_set_distance_callback_period(DistanceIR *distance_ir, uint32_t period)

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

Der DISTANCE_IR_CALLBACK_DISTANCE Callback wird nur ausgelöst wenn sich der Strom seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

int distance_ir_get_distance_callback_period(DistanceIR *distance_ir, uint32_t *ret_period)

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

int distance_ir_set_analog_value_callback_period(DistanceIR *distance_ir, uint32_t period)

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

Der DISTANCE_IR_CALLBACK_ANALOG_VALUE Callback wird nur ausgelöst wenn sich der Analogwert seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

int distance_ir_get_analog_value_callback_period(DistanceIR *distance_ir, uint32_t *ret_period)

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

int distance_ir_set_distance_callback_threshold(DistanceIR *distance_ir, char option, uint16_t min, uint16_t max)

Setzt den Schwellwert für den DISTANCE_IR_CALLBACK_DISTANCE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

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

  • DISTANCE_IR_THRESHOLD_OPTION_OFF = 'x'
  • DISTANCE_IR_THRESHOLD_OPTION_OUTSIDE = 'o'
  • DISTANCE_IR_THRESHOLD_OPTION_INSIDE = 'i'
  • DISTANCE_IR_THRESHOLD_OPTION_SMALLER = '<'
  • DISTANCE_IR_THRESHOLD_OPTION_GREATER = '>'
int distance_ir_get_distance_callback_threshold(DistanceIR *distance_ir, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)

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

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

  • DISTANCE_IR_THRESHOLD_OPTION_OFF = 'x'
  • DISTANCE_IR_THRESHOLD_OPTION_OUTSIDE = 'o'
  • DISTANCE_IR_THRESHOLD_OPTION_INSIDE = 'i'
  • DISTANCE_IR_THRESHOLD_OPTION_SMALLER = '<'
  • DISTANCE_IR_THRESHOLD_OPTION_GREATER = '>'
int distance_ir_set_analog_value_callback_threshold(DistanceIR *distance_ir, char option, uint16_t min, uint16_t max)

Setzt den Schwellwert für den DISTANCE_IR_CALLBACK_ANALOG_VALUE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

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

  • DISTANCE_IR_THRESHOLD_OPTION_OFF = 'x'
  • DISTANCE_IR_THRESHOLD_OPTION_OUTSIDE = 'o'
  • DISTANCE_IR_THRESHOLD_OPTION_INSIDE = 'i'
  • DISTANCE_IR_THRESHOLD_OPTION_SMALLER = '<'
  • DISTANCE_IR_THRESHOLD_OPTION_GREATER = '>'
int distance_ir_get_analog_value_callback_threshold(DistanceIR *distance_ir, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)

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

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

  • DISTANCE_IR_THRESHOLD_OPTION_OFF = 'x'
  • DISTANCE_IR_THRESHOLD_OPTION_OUTSIDE = 'o'
  • DISTANCE_IR_THRESHOLD_OPTION_INSIDE = 'i'
  • DISTANCE_IR_THRESHOLD_OPTION_SMALLER = '<'
  • DISTANCE_IR_THRESHOLD_OPTION_GREATER = '>'
int distance_ir_set_debounce_period(DistanceIR *distance_ir, uint32_t debounce)

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

int distance_ir_get_debounce_period(DistanceIR *distance_ir, uint32_t *ret_debounce)

Gibt die Entprellperiode zurück, wie von distance_ir_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 Funktion distance_ir_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);
}

distance_ir_register_callback(&distance_ir, DISTANCE_IR_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.

DISTANCE_IR_CALLBACK_DISTANCE
void callback(uint16_t distance, void *user_data)

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

Der DISTANCE_IR_CALLBACK_DISTANCE Callback wird nur ausgelöst wenn sich der Strom seit der letzten Auslösung geändert hat.

DISTANCE_IR_CALLBACK_ANALOG_VALUE
void callback(uint16_t value, void *user_data)

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

Der DISTANCE_IR_CALLBACK_ANALOG_VALUE Callback wird nur ausgelöst wenn sich der Analogwert seit der letzten Auslösung geändert hat.

DISTANCE_IR_CALLBACK_DISTANCE_REACHED
void callback(uint16_t distance, void *user_data)

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

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

DISTANCE_IR_CALLBACK_ANALOG_VALUE_REACHED
void callback(uint16_t value, void *user_data)

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

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

Konstanten

DISTANCE_IR_DEVICE_IDENTIFIER

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

Die distance_ir_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_IR_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Distance IR Bricklet dar.