C/C++ - Laser Range Finder Bricklet

Dies ist die Beschreibung der C/C++ API Bindings für das Laser Range Finder Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Laser Range Finder 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
41
42
43
44
45
46
47
48
49
#define IPCON_EXPOSE_MILLISLEEP

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_laser_range_finder.h"

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

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

    // Create device object
    LaserRangeFinder lrf;
    laser_range_finder_create(&lrf, 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

    // Turn laser on and wait 250ms for very first measurement to be ready
    laser_range_finder_enable_laser(&lrf);
    millisleep(250);

    // Get current distance
    uint16_t distance;
    if(laser_range_finder_get_distance(&lrf, &distance) < 0) {
        fprintf(stderr, "Could not get distance, probably timeout\n");
        return 1;
    }

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

    printf("Press key to exit\n");
    getchar();

    laser_range_finder_disable_laser(&lrf); // Turn laser off

    laser_range_finder_destroy(&lrf);
    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
50
51
52
53
54
55
56
57
58
#define IPCON_EXPOSE_MILLISLEEP

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_laser_range_finder.h"

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

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

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

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

    // Create device object
    LaserRangeFinder lrf;
    laser_range_finder_create(&lrf, 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

    // Turn laser on and wait 250ms for very first measurement to be ready
    laser_range_finder_enable_laser(&lrf);
    millisleep(250);

    // Register distance callback to function cb_distance
    laser_range_finder_register_callback(&lrf,
                                         LASER_RANGE_FINDER_CALLBACK_DISTANCE,
                                         (void (*)(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!
    laser_range_finder_set_distance_callback_period(&lrf, 200);

    printf("Press key to exit\n");
    getchar();

    laser_range_finder_disable_laser(&lrf); // Turn laser off

    laser_range_finder_destroy(&lrf);
    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
51
52
53
54
55
56
57
58
59
#define IPCON_EXPOSE_MILLISLEEP

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_laser_range_finder.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Laser Range Finder 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: %u cm\n", distance);
}

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

    // Create device object
    LaserRangeFinder lrf;
    laser_range_finder_create(&lrf, 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

    // Turn laser on and wait 250ms for very first measurement to be ready
    laser_range_finder_enable_laser(&lrf);
    millisleep(250);

    // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    laser_range_finder_set_debounce_period(&lrf, 10000);

    // Register distance reached callback to function cb_distance_reached
    laser_range_finder_register_callback(&lrf,
                                         LASER_RANGE_FINDER_CALLBACK_DISTANCE_REACHED,
                                         (void (*)(void))cb_distance_reached,
                                         NULL);

    // Configure threshold for distance "greater than 20 cm"
    laser_range_finder_set_distance_callback_threshold(&lrf, '>', 20, 0);

    printf("Press key to exit\n");
    getchar();

    laser_range_finder_disable_laser(&lrf); // Turn laser off

    laser_range_finder_destroy(&lrf);
    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 laser_range_finder_create(LaserRangeFinder *laser_range_finder, const char *uid, IPConnection *ipcon)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

LaserRangeFinder laser_range_finder;
laser_range_finder_create(&laser_range_finder, "YOUR_DEVICE_UID", &ipcon);

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

void laser_range_finder_destroy(LaserRangeFinder *laser_range_finder)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *

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

int laser_range_finder_get_distance(LaserRangeFinder *laser_range_finder, uint16_t *ret_distance)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
Ausgabeparameter:
  • ret_distance – Typ: uint16_t, Einheit: 1 cm, Wertebereich: [0 bis 4000]
Rückgabe:
  • error_code – Typ: int

Gibt die gemessene Distanz zurück.

Sensor Hardware Version 1 (siehe laser_range_finder_get_sensor_hardware_version()) kann nicht gleichzeitig Distanz und Geschwindigkeit messen. Daher muss mittels laser_range_finder_set_mode() der Distanzmodus aktiviert sein. Sensor Hardware Version 3 kann gleichzeitig Distanz und Geschwindigkeit messen. Zusätzlich muss der Laser aktiviert werden, siehe laser_range_finder_enable_laser().

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

int laser_range_finder_get_velocity(LaserRangeFinder *laser_range_finder, int16_t *ret_velocity)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
Ausgabeparameter:
  • ret_velocity – Typ: int16_t, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]
Rückgabe:
  • error_code – Typ: int

Gibt die gemessene Geschwindigkeit zurück.

Sensor Hardware Version 1 (siehe laser_range_finder_get_sensor_hardware_version()) kann nicht gleichzeitig Distanz und Geschwindigkeit messen. Daher muss mittels laser_range_finder_set_mode() ein Geschwindigkeitsmodus aktiviert sein. Sensor Hardware Version 3 kann gleichzeitig Distanz und Geschwindigkeit messen, jedoch liefert die Geschwindigkeitsmessung nur dann stabile Werte, wenn eine feste Messfrequenz (siehe laser_range_finder_set_configuration()) eingestellt ist. Zusätzlich muss der Laser aktiviert werden, siehe laser_range_finder_enable_laser().

Wenn der Geschwindigkeitswert periodisch abgefragt werden soll, wird empfohlen den LASER_RANGE_FINDER_CALLBACK_VELOCITY Callback zu nutzen und die Periode mit laser_range_finder_set_velocity_callback_period() vorzugeben.

int laser_range_finder_set_mode(LaserRangeFinder *laser_range_finder, uint8_t mode)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
  • mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Bemerkung

Diese Funktion ist nur verfügbar, wenn ein LIDAR-Lite Sensor mit Hardware Version 1 verbaut ist. Für Hardware Version 3 gibt es laser_range_finder_set_configuration(). die Hardware Version des Sensors kann mittels laser_range_finder_get_sensor_hardware_version() abgefragt werden.

Der LIDAR-Lite Sensor (Hardware Version 1) hat fünf verschiedene Modi. Ein Modus ist für Distanzmessungen und vier Modi sind für Geschwindigkeitsmessungen mit unterschiedlichen Wertebereichen.

Die folgenden Modi können genutzt werden:

  • 0: Distanz wird gemessen mit Auflösung 1,0 cm und Wertebereich 0-4000 cm
  • 1: Geschwindigkeit wird gemessen mit Auflösung 0,1 m/s und Wertebereich 0-12,7 m/s
  • 2: Geschwindigkeit wird gemessen mit Auflösung 0,25 m/s und Wertebereich 0-31,75 m/s
  • 3: Geschwindigkeit wird gemessen mit Auflösung 0,5 m/s und Wertebereich 0-63,5 m/s
  • 4: Geschwindigkeit wird gemessen mit Auflösung 1,0 m/s und Wertebereich 0-127 m/s

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

Für mode:

  • LASER_RANGE_FINDER_MODE_DISTANCE = 0
  • LASER_RANGE_FINDER_MODE_VELOCITY_MAX_13MS = 1
  • LASER_RANGE_FINDER_MODE_VELOCITY_MAX_32MS = 2
  • LASER_RANGE_FINDER_MODE_VELOCITY_MAX_64MS = 3
  • LASER_RANGE_FINDER_MODE_VELOCITY_MAX_127MS = 4
int laser_range_finder_get_mode(LaserRangeFinder *laser_range_finder, uint8_t *ret_mode)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
Ausgabeparameter:
  • ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt den Modus zurück, wie von laser_range_finder_set_mode() gesetzt.

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

Für ret_mode:

  • LASER_RANGE_FINDER_MODE_DISTANCE = 0
  • LASER_RANGE_FINDER_MODE_VELOCITY_MAX_13MS = 1
  • LASER_RANGE_FINDER_MODE_VELOCITY_MAX_32MS = 2
  • LASER_RANGE_FINDER_MODE_VELOCITY_MAX_64MS = 3
  • LASER_RANGE_FINDER_MODE_VELOCITY_MAX_127MS = 4
int laser_range_finder_enable_laser(LaserRangeFinder *laser_range_finder)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
Rückgabe:
  • error_code – Typ: int

Aktiviert den Laser des LIDAR.

Wir empfehlen nach dem aktivieren des Lasers 250ms zu warten bis zum ersten Aufruf von laser_range_finder_get_distance() um stabile Messwerte zu garantieren.

int laser_range_finder_disable_laser(LaserRangeFinder *laser_range_finder)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
Rückgabe:
  • error_code – Typ: int

Deaktiviert den Laser des LIDAR.

int laser_range_finder_is_laser_enabled(LaserRangeFinder *laser_range_finder, bool *ret_laser_enabled)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
Ausgabeparameter:
  • ret_laser_enabled – Typ: bool
Rückgabe:
  • error_code – Typ: int

Gibt true zurück wenn der Laser aktiviert ist, false sonst.

int laser_range_finder_set_configuration(LaserRangeFinder *laser_range_finder, uint8_t acquisition_count, bool enable_quick_termination, uint8_t threshold_value, uint16_t measurement_frequency)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
  • acquisition_count – Typ: uint8_t, Wertebereich: [1 bis 255], Standardwert: 128
  • enable_quick_termination – Typ: bool, Standardwert: false
  • threshold_value – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 0
  • measurement_frequency – Typ: uint16_t, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Bemerkung

Diese Funktion ist nur verfügbar, wenn ein LIDAR-Lite Sensor mit Hardware Version 3 verbaut ist. Für Hardware Version 1 gibt es laser_range_finder_set_mode(). Die Hardware Version des Sensors kann mittels laser_range_finder_get_sensor_hardware_version() abgefragt werden.

Der Parameter Acquisition Count definiert die Anzahl der Datenerfassungen die integriert werden, um eine Korrelation zu finden. Mit einer größeren Anzahl kann das Bricklet höhere Distanzen messen, mit einer kleineren Anzahl ist die Messrate höher. Erlaubte Werte sind 1-255.

Wenn der Parameter Enable Quick Termination auf true gesetzt wird, wird die Distanzmessung abgeschlossen, sobald das erste mal ein hoher Peak erfasst wird. Dadurch kann eine höhere Messrate erreicht werden wobei gleichzeitig Messungen mit langer Distanz möglich sind. Die Wahrscheinlichkeit einer Falschmessung erhöht sich allerdings.

Normalerweise wird die Distanz mit Hilfe eines Detektionsalgorithmus berechnet. Dieser verwendet Peak-Werte, Signalstärke und Rauschen. Es ist möglich stattdessen über den Parameter Threshold Value einen festen Schwellwert zu setzen der zur Distanzbestimmung genutzt werden soll. Um den Abstand zu einem Objekt mit sehr niedriger Reflektivität zu messen (z.B. Glas) kann der Wert niedrig gesetzt werden. Um den Abstand zu einem Objekt mit sehr hoher Reflektivität zu messen (z.B. Spiegel) kann der Wert sehr hoch gesetzt werden. Mit einem Wert von 0 wird der Standardalgorithmus genutzt. Ansonsten ist der erlaubte Wertebereich 1-255.

Der Measurement Frequency Parameter wird gesetzt. Er erzwingt eine feste Messfrequenz. Wenn der Wert auf 0 gesetzt wird, nutzt das Laser Range Finder Bricklet die optimale Frequenz je nach Konfiguration und aktuell gemessener Distanz. Da die Messrate in diesem Fall nicht fest ist, ist die Geschwindigkeitsmessung nicht stabil. Für eine stabile Geschwindigkeitsmessung sollte eine feste Messfrequenz eingestellt werden. Je niedriger die Frequenz ist, desto größer ist die Auflösung der Geschwindigkeitsmessung. Der erlaubte Wertbereich ist 10Hz-500Hz (und 0 um die feste Messfrequenz auszustellen).

Neu in Version 2.0.3 (Plugin).

int laser_range_finder_get_configuration(LaserRangeFinder *laser_range_finder, uint8_t *ret_acquisition_count, bool *ret_enable_quick_termination, uint8_t *ret_threshold_value, uint16_t *ret_measurement_frequency)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
Ausgabeparameter:
  • ret_acquisition_count – Typ: uint8_t, Wertebereich: [1 bis 255], Standardwert: 128
  • ret_enable_quick_termination – Typ: bool, Standardwert: false
  • ret_threshold_value – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 0
  • ret_measurement_frequency – Typ: uint16_t, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

Neu in Version 2.0.3 (Plugin).

Fortgeschrittene Funktionen

int laser_range_finder_set_moving_average(LaserRangeFinder *laser_range_finder, uint8_t distance_average_length, uint8_t velocity_average_length)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
  • distance_average_length – Typ: uint8_t, Wertebereich: [0 bis 30], Standardwert: 10
  • velocity_average_length – Typ: uint8_t, Wertebereich: [0 bis 30], Standardwert: 10
Rückgabe:
  • error_code – Typ: int

Setzt die Länge eines gleitenden Mittelwerts für die Entfernung und Geschwindigkeit.

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.

int laser_range_finder_get_moving_average(LaserRangeFinder *laser_range_finder, uint8_t *ret_distance_average_length, uint8_t *ret_velocity_average_length)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
Ausgabeparameter:
  • ret_distance_average_length – Typ: uint8_t, Wertebereich: [0 bis 30], Standardwert: 10
  • ret_velocity_average_length – Typ: uint8_t, Wertebereich: [0 bis 30], Standardwert: 10
Rückgabe:
  • error_code – Typ: int

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

int laser_range_finder_get_sensor_hardware_version(LaserRangeFinder *laser_range_finder, uint8_t *ret_version)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
Ausgabeparameter:
  • ret_version – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

Gibt die LIDAR-Lite Hardware version zurück.

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

Für ret_version:

  • LASER_RANGE_FINDER_VERSION_1 = 1
  • LASER_RANGE_FINDER_VERSION_3 = 3

Neu in Version 2.0.3 (Plugin).

int laser_range_finder_get_identity(LaserRangeFinder *laser_range_finder, 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:
  • laser_range_finder – Typ: LaserRangeFinder *
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 laser_range_finder_register_callback(LaserRangeFinder *laser_range_finder, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
  • 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 laser_range_finder_set_distance_callback_period(LaserRangeFinder *laser_range_finder, uint32_t period)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
  • 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 LASER_RANGE_FINDER_CALLBACK_DISTANCE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

int laser_range_finder_get_distance_callback_period(LaserRangeFinder *laser_range_finder, uint32_t *ret_period)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
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 laser_range_finder_set_distance_callback_period() gesetzt.

int laser_range_finder_set_velocity_callback_period(LaserRangeFinder *laser_range_finder, uint32_t period)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
  • 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 LASER_RANGE_FINDER_CALLBACK_VELOCITY Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

int laser_range_finder_get_velocity_callback_period(LaserRangeFinder *laser_range_finder, uint32_t *ret_period)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
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 laser_range_finder_set_velocity_callback_period() gesetzt.

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

Setzt den Schwellwert für den LASER_RANGE_FINDER_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)

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

Für option:

  • LASER_RANGE_FINDER_THRESHOLD_OPTION_OFF = 'x'
  • LASER_RANGE_FINDER_THRESHOLD_OPTION_OUTSIDE = 'o'
  • LASER_RANGE_FINDER_THRESHOLD_OPTION_INSIDE = 'i'
  • LASER_RANGE_FINDER_THRESHOLD_OPTION_SMALLER = '<'
  • LASER_RANGE_FINDER_THRESHOLD_OPTION_GREATER = '>'
int laser_range_finder_get_distance_callback_threshold(LaserRangeFinder *laser_range_finder, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
Ausgabeparameter:
  • ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • ret_min – Typ: uint16_t, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • ret_max – Typ: uint16_t, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_option:

  • LASER_RANGE_FINDER_THRESHOLD_OPTION_OFF = 'x'
  • LASER_RANGE_FINDER_THRESHOLD_OPTION_OUTSIDE = 'o'
  • LASER_RANGE_FINDER_THRESHOLD_OPTION_INSIDE = 'i'
  • LASER_RANGE_FINDER_THRESHOLD_OPTION_SMALLER = '<'
  • LASER_RANGE_FINDER_THRESHOLD_OPTION_GREATER = '>'
int laser_range_finder_set_velocity_callback_threshold(LaserRangeFinder *laser_range_finder, char option, int16_t min, int16_t max)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int16_t, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: int16_t, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt den Schwellwert für den LASER_RANGE_FINDER_CALLBACK_VELOCITY_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • LASER_RANGE_FINDER_THRESHOLD_OPTION_OFF = 'x'
  • LASER_RANGE_FINDER_THRESHOLD_OPTION_OUTSIDE = 'o'
  • LASER_RANGE_FINDER_THRESHOLD_OPTION_INSIDE = 'i'
  • LASER_RANGE_FINDER_THRESHOLD_OPTION_SMALLER = '<'
  • LASER_RANGE_FINDER_THRESHOLD_OPTION_GREATER = '>'
int laser_range_finder_get_velocity_callback_threshold(LaserRangeFinder *laser_range_finder, char *ret_option, int16_t *ret_min, int16_t *ret_max)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
Ausgabeparameter:
  • ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • ret_min – Typ: int16_t, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • ret_max – Typ: int16_t, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_option:

  • LASER_RANGE_FINDER_THRESHOLD_OPTION_OFF = 'x'
  • LASER_RANGE_FINDER_THRESHOLD_OPTION_OUTSIDE = 'o'
  • LASER_RANGE_FINDER_THRESHOLD_OPTION_INSIDE = 'i'
  • LASER_RANGE_FINDER_THRESHOLD_OPTION_SMALLER = '<'
  • LASER_RANGE_FINDER_THRESHOLD_OPTION_GREATER = '>'
int laser_range_finder_set_debounce_period(LaserRangeFinder *laser_range_finder, uint32_t debounce)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
  • 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 laser_range_finder_get_debounce_period(LaserRangeFinder *laser_range_finder, uint32_t *ret_debounce)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
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 laser_range_finder_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 laser_range_finder_register_callback() Funktion durchgeführt werden:

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

laser_range_finder_register_callback(&laser_range_finder,
                                     LASER_RANGE_FINDER_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.

LASER_RANGE_FINDER_CALLBACK_DISTANCE
void callback(uint16_t distance, void *user_data)
Callback-Parameter:
  • distance – Typ: uint16_t, Einheit: 1 cm, Wertebereich: [0 bis 4000]
  • user_data – Typ: void *

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

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

LASER_RANGE_FINDER_CALLBACK_VELOCITY
void callback(int16_t velocity, void *user_data)
Callback-Parameter:
  • velocity – Typ: int16_t, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]
  • user_data – Typ: void *

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

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

LASER_RANGE_FINDER_CALLBACK_DISTANCE_REACHED
void callback(uint16_t distance, void *user_data)
Callback-Parameter:
  • distance – Typ: uint16_t, Einheit: 1 cm, Wertebereich: [0 bis 4000]
  • user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von laser_range_finder_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 laser_range_finder_set_debounce_period() gesetzt, ausgelöst.

LASER_RANGE_FINDER_CALLBACK_VELOCITY_REACHED
void callback(int16_t velocity, void *user_data)
Callback-Parameter:
  • velocity – Typ: int16_t, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]
  • user_data – Typ: void *

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

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit laser_range_finder_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 laser_range_finder_get_api_version(LaserRangeFinder *laser_range_finder, uint8_t ret_api_version[3])
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
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 laser_range_finder_get_response_expected(LaserRangeFinder *laser_range_finder, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
  • 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 laser_range_finder_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:

  • LASER_RANGE_FINDER_FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 3
  • LASER_RANGE_FINDER_FUNCTION_SET_VELOCITY_CALLBACK_PERIOD = 5
  • LASER_RANGE_FINDER_FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 7
  • LASER_RANGE_FINDER_FUNCTION_SET_VELOCITY_CALLBACK_THRESHOLD = 9
  • LASER_RANGE_FINDER_FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • LASER_RANGE_FINDER_FUNCTION_SET_MOVING_AVERAGE = 13
  • LASER_RANGE_FINDER_FUNCTION_SET_MODE = 15
  • LASER_RANGE_FINDER_FUNCTION_ENABLE_LASER = 17
  • LASER_RANGE_FINDER_FUNCTION_DISABLE_LASER = 18
  • LASER_RANGE_FINDER_FUNCTION_SET_CONFIGURATION = 25
int laser_range_finder_set_response_expected(LaserRangeFinder *laser_range_finder, uint8_t function_id, bool response_expected)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
  • 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:

  • LASER_RANGE_FINDER_FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 3
  • LASER_RANGE_FINDER_FUNCTION_SET_VELOCITY_CALLBACK_PERIOD = 5
  • LASER_RANGE_FINDER_FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 7
  • LASER_RANGE_FINDER_FUNCTION_SET_VELOCITY_CALLBACK_THRESHOLD = 9
  • LASER_RANGE_FINDER_FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • LASER_RANGE_FINDER_FUNCTION_SET_MOVING_AVERAGE = 13
  • LASER_RANGE_FINDER_FUNCTION_SET_MODE = 15
  • LASER_RANGE_FINDER_FUNCTION_ENABLE_LASER = 17
  • LASER_RANGE_FINDER_FUNCTION_DISABLE_LASER = 18
  • LASER_RANGE_FINDER_FUNCTION_SET_CONFIGURATION = 25
int laser_range_finder_set_response_expected_all(LaserRangeFinder *laser_range_finder, bool response_expected)
Parameter:
  • laser_range_finder – Typ: LaserRangeFinder *
  • 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

LASER_RANGE_FINDER_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Laser Range Finder Bricklet zu identifizieren.

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

LASER_RANGE_FINDER_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Laser Range Finder Bricklet dar.