Software / API Bindings / C/C++ / API Referenz und Beispiele / Bricklets / Laser Range Finder Bricklet 2.0

C/C++ - Laser Range Finder Bricklet 2.0¶

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

#define IPCON_EXPOSE_MILLISLEEP

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_laser_range_finder_v2.h"

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

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

    // Create device object
    LaserRangeFinderV2 lrf;
    laser_range_finder_v2_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_v2_set_enable(&lrf, true);
    millisleep(250);

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

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

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

    // Turn laser off
    laser_range_finder_v2_set_enable(&lrf, false);

    laser_range_finder_v2_destroy(&lrf);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Callback¶

Download (example_callback.c)

#define IPCON_EXPOSE_MILLISLEEP

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_laser_range_finder_v2.h"

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

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

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

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

    // Create device object
    LaserRangeFinderV2 lrf;
    laser_range_finder_v2_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_v2_set_enable(&lrf, true);
    millisleep(250);

    // Register distance callback to function cb_distance
    laser_range_finder_v2_register_callback(&lrf,
                                            LASER_RANGE_FINDER_V2_CALLBACK_DISTANCE,
                                            (void (*)(void))cb_distance,
                                            NULL);

    // Set period for distance callback to 0.2s (200ms) without a threshold
    laser_range_finder_v2_set_distance_callback_configuration(&lrf, 200, false, 'x', 0, 0);

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

    // Turn laser off
    laser_range_finder_v2_set_enable(&lrf, false);

    laser_range_finder_v2_destroy(&lrf);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Threshold¶

Download (example_threshold.c)

#define IPCON_EXPOSE_MILLISLEEP

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_laser_range_finder_v2.h"

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

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

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

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

    // Create device object
    LaserRangeFinderV2 lrf;
    laser_range_finder_v2_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_v2_set_enable(&lrf, true);
    millisleep(250);

    // Register distance callback to function cb_distance
    laser_range_finder_v2_register_callback(&lrf,
                                            LASER_RANGE_FINDER_V2_CALLBACK_DISTANCE,
                                            (void (*)(void))cb_distance,
                                            NULL);

    // Configure threshold for distance "greater than 20 cm"
    // with a debounce period of 1s (1000ms)
    laser_range_finder_v2_set_distance_callback_configuration(&lrf, 1000, false, '>', 20, 0);

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

    // Turn laser off
    laser_range_finder_v2_set_enable(&lrf, false);

    laser_range_finder_v2_destroy(&lrf);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API¶

Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code) zurück. 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 (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_v2_create(LaserRangeFinderV2 *laser_range_finder_v2, const char *uid, IPConnection *ipcon)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * uid – Typ: const char * ipcon – Typ: IPConnection *

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

LaserRangeFinderV2 laser_range_finder_v2;
laser_range_finder_v2_create(&laser_range_finder_v2, "YOUR_DEVICE_UID", &ipcon);

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

void laser_range_finder_v2_destroy(LaserRangeFinderV2 *laser_range_finder_v2)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *

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

int laser_range_finder_v2_get_distance(LaserRangeFinderV2 *laser_range_finder_v2, int16_t *ret_distance)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
Ausgabeparameter:	ret_distance – Typ: int16_t, Einheit: 1 cm, Wertebereich: [0 bis 4000]
Rückgabe:	e_code – Typ: int

Gibt die gemessene Distanz zurück.

Der Laser muss aktiviert werden, siehe laser_range_finder_v2_set_enable().

Wenn der Wert periodisch benötigt wird, kann auch der LASER_RANGE_FINDER_V2_CALLBACK_DISTANCE Callback verwendet werden. Der Callback wird mit der Funktion laser_range_finder_v2_set_distance_callback_configuration() konfiguriert.

int laser_range_finder_v2_get_velocity(LaserRangeFinderV2 *laser_range_finder_v2, int16_t *ret_velocity)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
Ausgabeparameter:	ret_velocity – Typ: int16_t, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]
Rückgabe:	e_code – Typ: int

Gibt die gemessene Geschwindigkeit zurück.

Die Geschwindigkeitsmessung liefert nur dann stabile Werte, wenn eine feste Messfrequenz (siehe laser_range_finder_v2_set_configuration()) eingestellt ist. Zusätzlich muss der Laser aktiviert werden, siehe laser_range_finder_v2_set_enable().

Wenn der Wert periodisch benötigt wird, kann auch der LASER_RANGE_FINDER_V2_CALLBACK_VELOCITY Callback verwendet werden. Der Callback wird mit der Funktion laser_range_finder_v2_set_velocity_callback_configuration() konfiguriert.

int laser_range_finder_v2_set_enable(LaserRangeFinderV2 *laser_range_finder_v2, bool enable)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * enable – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Aktiviert den Laser des LIDAR wenn auf true gesetzt.

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

int laser_range_finder_v2_get_enable(LaserRangeFinderV2 *laser_range_finder_v2, bool *ret_enable)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
Ausgabeparameter:	ret_enable – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt den Wert zurück wie von laser_range_finder_v2_set_enable() gesetzt.

int laser_range_finder_v2_set_configuration(LaserRangeFinderV2 *laser_range_finder_v2, uint8_t acquisition_count, bool enable_quick_termination, uint8_t threshold_value, uint16_t measurement_frequency)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * 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:	e_code – Typ: int

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).

Die Standardwerte für Acquisition Count, Enable Quick Termination, Threshold Value und Measurement Frequency sind 128, false, 0 und 0.

int laser_range_finder_v2_get_configuration(LaserRangeFinderV2 *laser_range_finder_v2, uint8_t *ret_acquisition_count, bool *ret_enable_quick_termination, uint8_t *ret_threshold_value, uint16_t *ret_measurement_frequency)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
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:	e_code – Typ: int

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

int laser_range_finder_v2_set_distance_led_config(LaserRangeFinderV2 *laser_range_finder_v2, uint8_t config)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Konfiguriert die Distanz-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option mit der LED die Distanz anzuzeigen (heller = Objekt näher).

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

Für config:

LASER_RANGE_FINDER_V2_DISTANCE_LED_CONFIG_OFF = 0
LASER_RANGE_FINDER_V2_DISTANCE_LED_CONFIG_ON = 1
LASER_RANGE_FINDER_V2_DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
LASER_RANGE_FINDER_V2_DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3

int laser_range_finder_v2_get_distance_led_config(LaserRangeFinderV2 *laser_range_finder_v2, uint8_t *ret_config)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Gibt die LED-Konfiguration zurück, wie von laser_range_finder_v2_set_distance_led_config() gesetzt.

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

Für ret_config:

LASER_RANGE_FINDER_V2_DISTANCE_LED_CONFIG_OFF = 0
LASER_RANGE_FINDER_V2_DISTANCE_LED_CONFIG_ON = 1
LASER_RANGE_FINDER_V2_DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
LASER_RANGE_FINDER_V2_DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3

Fortgeschrittene Funktionen¶

int laser_range_finder_v2_set_moving_average(LaserRangeFinderV2 *laser_range_finder_v2, uint8_t distance_average_length, uint8_t velocity_average_length)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * distance_average_length – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 10 velocity_average_length – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 10
Rückgabe:	e_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_v2_get_moving_average(LaserRangeFinderV2 *laser_range_finder_v2, uint8_t *ret_distance_average_length, uint8_t *ret_velocity_average_length)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
Ausgabeparameter:	ret_distance_average_length – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 10 ret_velocity_average_length – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 10
Rückgabe:	e_code – Typ: int

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

int laser_range_finder_v2_set_offset_calibration(LaserRangeFinderV2 *laser_range_finder_v2, int16_t offset)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * offset – Typ: int16_t, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 28767]
Rückgabe:	e_code – Typ: int

Der Offset wird auf die Distanz addiert. Es wird in nicht-flüchtigen Speicher gespeichert und muss nur einmal gesetzt werden.

Der Offset wird für das Bricklet pro Sensor von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte also nicht notwendig sein.

Wenn der Offset re-kalibriert werden soll muss er zuerst auf 0 gesetzt. Danach kann der Offset wieder gesetzt werden in dem die Differenz zu einer bekannte Distanz gemessen wird.

int laser_range_finder_v2_get_offset_calibration(LaserRangeFinderV2 *laser_range_finder_v2, int16_t *ret_offset)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
Ausgabeparameter:	ret_offset – Typ: int16_t, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 28767]
Rückgabe:	e_code – Typ: int

Gibt den Offset-Wert zurück, wie von laser_range_finder_v2_set_offset_calibration() gesetzt.

int laser_range_finder_v2_get_spitfp_error_count(LaserRangeFinderV2 *laser_range_finder_v2, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

ACK-Checksummen Fehler,
Message-Checksummen Fehler,
Framing Fehler und
Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

int laser_range_finder_v2_set_status_led_config(LaserRangeFinderV2 *laser_range_finder_v2, uint8_t config)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

LASER_RANGE_FINDER_V2_STATUS_LED_CONFIG_OFF = 0
LASER_RANGE_FINDER_V2_STATUS_LED_CONFIG_ON = 1
LASER_RANGE_FINDER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
LASER_RANGE_FINDER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int laser_range_finder_v2_get_status_led_config(LaserRangeFinderV2 *laser_range_finder_v2, uint8_t *ret_config)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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

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

Für ret_config:

LASER_RANGE_FINDER_V2_STATUS_LED_CONFIG_OFF = 0
LASER_RANGE_FINDER_V2_STATUS_LED_CONFIG_ON = 1
LASER_RANGE_FINDER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
LASER_RANGE_FINDER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int laser_range_finder_v2_get_chip_temperature(LaserRangeFinderV2 *laser_range_finder_v2, int16_t *ret_temperature)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

int laser_range_finder_v2_reset(LaserRangeFinderV2 *laser_range_finder_v2)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
Rückgabe:	e_code – Typ: int

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

int laser_range_finder_v2_get_identity(LaserRangeFinderV2 *laser_range_finder_v2, 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_v2 – Typ: LaserRangeFinderV2 *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', '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:	e_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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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_v2_register_callback(LaserRangeFinderV2 *laser_range_finder_v2, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * 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_v2_set_distance_callback_configuration(LaserRangeFinderV2 *laser_range_finder_v2, uint32_t period, bool value_has_to_change, char option, int16_t min, int16_t max)¶

Parameter:

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int16_t, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max – Typ: int16_t, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
value_has_to_change – Typ: bool, Standardwert: false
option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min – Typ: int16_t, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
max – Typ: int16_t, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

Rückgabe:

e_code – Typ: int

Die Periode ist die Periode mit der der LASER_RANGE_FINDER_V2_CALLBACK_DISTANCE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den LASER_RANGE_FINDER_V2_CALLBACK_DISTANCE Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_OFF = 'x'
LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_INSIDE = 'i'
LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_SMALLER = '<'
LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_GREATER = '>'

int laser_range_finder_v2_get_distance_callback_configuration(LaserRangeFinderV2 *laser_range_finder_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int16_t *ret_min, int16_t *ret_max)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' ret_min – Typ: int16_t, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 ret_max – Typ: int16_t, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels laser_range_finder_v2_set_distance_callback_configuration() gesetzt.

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

Für ret_option:

LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_OFF = 'x'
LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_INSIDE = 'i'
LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_SMALLER = '<'
LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_GREATER = '>'

int laser_range_finder_v2_set_velocity_callback_configuration(LaserRangeFinderV2 *laser_range_finder_v2, uint32_t period, bool value_has_to_change, char option, int16_t min, int16_t max)¶

Parameter:

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int16_t, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max – Typ: int16_t, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
value_has_to_change – Typ: bool, Standardwert: false
option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min – Typ: int16_t, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
max – Typ: int16_t, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

Rückgabe:

e_code – Typ: int

Die Periode ist die Periode mit der der LASER_RANGE_FINDER_V2_CALLBACK_VELOCITY Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den LASER_RANGE_FINDER_V2_CALLBACK_VELOCITY Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_OFF = 'x'
LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_INSIDE = 'i'
LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_SMALLER = '<'
LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_GREATER = '>'

int laser_range_finder_v2_get_velocity_callback_configuration(LaserRangeFinderV2 *laser_range_finder_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int16_t *ret_min, int16_t *ret_max)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' ret_min – Typ: int16_t, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 ret_max – Typ: int16_t, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels laser_range_finder_v2_set_velocity_callback_configuration() gesetzt.

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

Für ret_option:

LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_OFF = 'x'
LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_INSIDE = 'i'
LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_SMALLER = '<'
LASER_RANGE_FINDER_V2_THRESHOLD_OPTION_GREATER = '>'

Callbacks¶

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

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

laser_range_finder_v2_register_callback(&laser_range_finder_v2,
                                        LASER_RANGE_FINDER_V2_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_V2_CALLBACK_DISTANCE¶

void callback(int16_t distance, void *user_data)

Callback-Parameter:	distance – Typ: int16_t, Einheit: 1 cm, Wertebereich: [0 bis 4000] user_data – Typ: void *

Dieser Callback wird periodisch ausgelöst abhängig von der mittels laser_range_finder_v2_set_distance_callback_configuration() gesetzten Konfiguration

Der Parameter ist der gleiche wie laser_range_finder_v2_get_distance().

LASER_RANGE_FINDER_V2_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 periodisch ausgelöst abhängig von der mittels laser_range_finder_v2_set_velocity_callback_configuration() gesetzten Konfiguration

Der Parameter ist der gleiche wie laser_range_finder_v2_get_velocity().

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_v2_get_api_version(LaserRangeFinderV2 *laser_range_finder_v2, uint8_t ret_api_version[3])¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
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:	e_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_v2_get_response_expected(LaserRangeFinderV2 *laser_range_finder_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_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_v2_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_V2_FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
LASER_RANGE_FINDER_V2_FUNCTION_SET_VELOCITY_CALLBACK_CONFIGURATION = 6
LASER_RANGE_FINDER_V2_FUNCTION_SET_ENABLE = 9
LASER_RANGE_FINDER_V2_FUNCTION_SET_CONFIGURATION = 11
LASER_RANGE_FINDER_V2_FUNCTION_SET_MOVING_AVERAGE = 13
LASER_RANGE_FINDER_V2_FUNCTION_SET_OFFSET_CALIBRATION = 15
LASER_RANGE_FINDER_V2_FUNCTION_SET_DISTANCE_LED_CONFIG = 17
LASER_RANGE_FINDER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
LASER_RANGE_FINDER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
LASER_RANGE_FINDER_V2_FUNCTION_RESET = 243
LASER_RANGE_FINDER_V2_FUNCTION_WRITE_UID = 248

int laser_range_finder_v2_set_response_expected(LaserRangeFinderV2 *laser_range_finder_v2, uint8_t function_id, bool response_expected)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_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:

LASER_RANGE_FINDER_V2_FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
LASER_RANGE_FINDER_V2_FUNCTION_SET_VELOCITY_CALLBACK_CONFIGURATION = 6
LASER_RANGE_FINDER_V2_FUNCTION_SET_ENABLE = 9
LASER_RANGE_FINDER_V2_FUNCTION_SET_CONFIGURATION = 11
LASER_RANGE_FINDER_V2_FUNCTION_SET_MOVING_AVERAGE = 13
LASER_RANGE_FINDER_V2_FUNCTION_SET_OFFSET_CALIBRATION = 15
LASER_RANGE_FINDER_V2_FUNCTION_SET_DISTANCE_LED_CONFIG = 17
LASER_RANGE_FINDER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
LASER_RANGE_FINDER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
LASER_RANGE_FINDER_V2_FUNCTION_RESET = 243
LASER_RANGE_FINDER_V2_FUNCTION_WRITE_UID = 248

int laser_range_finder_v2_set_response_expected_all(LaserRangeFinderV2 *laser_range_finder_v2, bool response_expected)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

int laser_range_finder_v2_set_bootloader_mode(LaserRangeFinderV2 *laser_range_finder_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

LASER_RANGE_FINDER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
LASER_RANGE_FINDER_V2_BOOTLOADER_MODE_FIRMWARE = 1
LASER_RANGE_FINDER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
LASER_RANGE_FINDER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
LASER_RANGE_FINDER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

LASER_RANGE_FINDER_V2_BOOTLOADER_STATUS_OK = 0
LASER_RANGE_FINDER_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
LASER_RANGE_FINDER_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
LASER_RANGE_FINDER_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
LASER_RANGE_FINDER_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
LASER_RANGE_FINDER_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int laser_range_finder_v2_get_bootloader_mode(LaserRangeFinderV2 *laser_range_finder_v2, uint8_t *ret_mode)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Bootloader-Modus zurück, siehe laser_range_finder_v2_set_bootloader_mode().

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

Für ret_mode:

LASER_RANGE_FINDER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
LASER_RANGE_FINDER_V2_BOOTLOADER_MODE_FIRMWARE = 1
LASER_RANGE_FINDER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
LASER_RANGE_FINDER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
LASER_RANGE_FINDER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int laser_range_finder_v2_set_write_firmware_pointer(LaserRangeFinderV2 *laser_range_finder_v2, uint32_t pointer)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für laser_range_finder_v2_write_firmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int laser_range_finder_v2_write_firmware(LaserRangeFinderV2 *laser_range_finder_v2, uint8_t data[64], uint8_t *ret_status)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * data – Typ: uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von laser_range_finder_v2_set_write_firmware_pointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int laser_range_finder_v2_write_uid(LaserRangeFinderV2 *laser_range_finder_v2, uint32_t uid)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 * uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

int laser_range_finder_v2_read_uid(LaserRangeFinderV2 *laser_range_finder_v2, uint32_t *ret_uid)¶

Parameter:	laser_range_finder_v2 – Typ: LaserRangeFinderV2 *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

LASER_RANGE_FINDER_V2_DEVICE_IDENTIFIER¶

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

Die laser_range_finder_v2_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_V2_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Laser Range Finder Bricklet 2.0 dar.