Rust - Laser Range Finder Bricklet 2.0¶

Simple¶

Download (example_simple.rs)

 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

use std::{error::Error, io, thread, time::Duration};
use tinkerforge::{ip_connection::IpConnection, laser_range_finder_v2_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Laser Range Finder Bricklet 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let lrf = LaserRangeFinderV2Bricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    // Turn laser on and wait 250ms for very first measurement to be ready
    lrf.set_enable(true).recv()?;
    thread::sleep(Duration::from_millis(250));

    // Get current distance.
    let distance = lrf.get_distance().recv()?;
    println!("Distance: {} cm", distance);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;

    // Turn laser off
    lrf.set_enable(false).recv()?;

    ipcon.disconnect();
    Ok(())
}

Callback¶

Download (example_callback.rs)

 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

use std::{error::Error, io, thread, time::Duration};
use tinkerforge::{ip_connection::IpConnection, laser_range_finder_v2_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Laser Range Finder Bricklet 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let lrf = LaserRangeFinderV2Bricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    // Turn laser on and wait 250ms for very first measurement to be ready
    lrf.set_enable(true).recv()?;
    thread::sleep(Duration::from_millis(250));

    let distance_receiver = lrf.get_distance_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `lrf` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for distance in distance_receiver {
            println!("Distance: {} cm", distance);
        }
    });

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

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;

    // Turn laser off
    lrf.set_enable(false).recv()?;

    ipcon.disconnect();
    Ok(())
}

Threshold¶

Download (example_threshold.rs)

 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

use std::{error::Error, io, thread, time::Duration};
use tinkerforge::{ip_connection::IpConnection, laser_range_finder_v2_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Laser Range Finder Bricklet 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let lrf = LaserRangeFinderV2Bricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    // Turn laser on and wait 250ms for very first measurement to be ready
    lrf.set_enable(true).recv()?;
    thread::sleep(Duration::from_millis(250));

    let distance_receiver = lrf.get_distance_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `lrf` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for distance in distance_receiver {
            println!("Distance: {} cm", distance);
        }
    });

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

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;

    // Turn laser off
    lrf.set_enable(false).recv()?;

    ipcon.disconnect();
    Ok(())
}

Grundfunktionen¶

pub fn LaserRangeFinderV2Bricklet::new(uid: &str, ip_connection: &IpConnection) → LaserRangeFinderV2Bricklet¶

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	laser_range_finder_v2 – Typ: LaserRangeFinderV2Bricklet

Erzeugt ein neues LaserRangeFinderV2Bricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IP-Connection ip_connection hinzu:

let laser_range_finder_v2 = LaserRangeFinderV2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn LaserRangeFinderV2Bricklet::get_distance(&self) → ConvertingReceiver<i16>¶

Rückgabe:	distance – Typ: i16, Einheit: 1 cm, Wertebereich: [0 bis 4000]

Gibt die gemessene Distanz zurück.

Der Laser muss aktiviert werden, siehe LaserRangeFinderV2Bricklet::set_enable.

Wenn der Wert periodisch benötigt wird, kann auch der LaserRangeFinderV2Bricklet::get_distance_callback_receiver Callback verwendet werden. Der Callback wird mit der Funktion LaserRangeFinderV2Bricklet::set_distance_callback_configuration konfiguriert.

pub fn LaserRangeFinderV2Bricklet::get_velocity(&self) → ConvertingReceiver<i16>¶

Rückgabe:	velocity – Typ: i16, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]

Gibt die gemessene Geschwindigkeit zurück.

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

Wenn der Wert periodisch benötigt wird, kann auch der LaserRangeFinderV2Bricklet::get_velocity_callback_receiver Callback verwendet werden. Der Callback wird mit der Funktion LaserRangeFinderV2Bricklet::set_velocity_callback_configuration konfiguriert.

pub fn LaserRangeFinderV2Bricklet::set_enable(&self, enable: bool) → ConvertingReceiver<()>¶

Parameter:	enable – Typ: bool, Standardwert: false

Aktiviert den Laser des LIDAR wenn auf true gesetzt.

Wir empfehlen nach dem Aktivieren des Lasers 250ms zu warten bis zum ersten Aufruf von LaserRangeFinderV2Bricklet::get_distance um stabile Messwerte zu garantieren.

pub fn LaserRangeFinderV2Bricklet::get_enable(&self) → ConvertingReceiver<bool>¶

Rückgabe:	enable – Typ: bool, Standardwert: false

Gibt den Wert zurück wie von LaserRangeFinderV2Bricklet::set_enable gesetzt.

pub fn LaserRangeFinderV2Bricklet::set_configuration(&self, acquisition_count: u8, enable_quick_termination: bool, threshold_value: u8, measurement_frequency: u16) → ConvertingReceiver<()>¶

Parameter:	acquisition_count – Typ: u8, Wertebereich: [1 bis 255], Standardwert: 128 enable_quick_termination – Typ: bool, Standardwert: false threshold_value – Typ: u8, Wertebereich: [0 bis 255], Standardwert: 0 measurement_frequency – Typ: u16, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0

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.

pub fn LaserRangeFinderV2Bricklet::get_configuration(&self) → ConvertingReceiver<Configuration>¶

Rückgabeobjekt:	acquisition_count – Typ: u8, Wertebereich: [1 bis 255], Standardwert: 128 enable_quick_termination – Typ: bool, Standardwert: false threshold_value – Typ: u8, Wertebereich: [0 bis 255], Standardwert: 0 measurement_frequency – Typ: u16, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0

Gibt die Konfiguration zurück, wie von LaserRangeFinderV2Bricklet::set_configuration gesetzt.

pub fn LaserRangeFinderV2Bricklet::set_distance_led_config(&self, config: u8) → ConvertingReceiver<()>¶

Parameter:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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_BRICKLET_DISTANCE_LED_CONFIG_OFF = 0
• LASER_RANGE_FINDER_V2_BRICKLET_DISTANCE_LED_CONFIG_ON = 1
• LASER_RANGE_FINDER_V2_BRICKLET_DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
• LASER_RANGE_FINDER_V2_BRICKLET_DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3

pub fn LaserRangeFinderV2Bricklet::get_distance_led_config(&self) → ConvertingReceiver<u8>¶

Rückgabe:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von LaserRangeFinderV2Bricklet::set_distance_led_config gesetzt.

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

Für config:

• LASER_RANGE_FINDER_V2_BRICKLET_DISTANCE_LED_CONFIG_OFF = 0
• LASER_RANGE_FINDER_V2_BRICKLET_DISTANCE_LED_CONFIG_ON = 1
• LASER_RANGE_FINDER_V2_BRICKLET_DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
• LASER_RANGE_FINDER_V2_BRICKLET_DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3

Fortgeschrittene Funktionen¶

pub fn LaserRangeFinderV2Bricklet::set_moving_average(&self, distance_average_length: u8, velocity_average_length: u8) → ConvertingReceiver<()>¶

Parameter:	distance_average_length – Typ: u8, Wertebereich: [0 bis 255], Standardwert: 10 velocity_average_length – Typ: u8, Wertebereich: [0 bis 255], Standardwert: 10

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.

pub fn LaserRangeFinderV2Bricklet::get_moving_average(&self) → ConvertingReceiver<MovingAverage>¶

Rückgabeobjekt:	distance_average_length – Typ: u8, Wertebereich: [0 bis 255], Standardwert: 10 velocity_average_length – Typ: u8, Wertebereich: [0 bis 255], Standardwert: 10

Gibt die Länge des gleitenden Mittelwerts zurück, wie von LaserRangeFinderV2Bricklet::set_moving_average gesetzt.

pub fn LaserRangeFinderV2Bricklet::set_offset_calibration(&self, offset: i16) → ConvertingReceiver<()>¶

Parameter:	offset – Typ: i16, Einheit: 1 cm, Wertebereich: [-215 bis 28767]

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.

pub fn LaserRangeFinderV2Bricklet::get_offset_calibration(&self) → ConvertingReceiver<i16>¶

Rückgabe:	offset – Typ: i16, Einheit: 1 cm, Wertebereich: [-215 bis 28767]

Gibt den Offset-Wert zurück, wie von LaserRangeFinderV2Bricklet::set_offset_calibration gesetzt.

pub fn LaserRangeFinderV2Bricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>¶

Rückgabeobjekt:	error_count_ack_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1] error_count_message_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1] error_count_frame – Typ: u32, Wertebereich: [0 bis 232 - 1] error_count_overflow – Typ: u32, Wertebereich: [0 bis 232 - 1]

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.

pub fn LaserRangeFinderV2Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>¶

Parameter:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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_BRICKLET_STATUS_LED_CONFIG_OFF = 0
• LASER_RANGE_FINDER_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
• LASER_RANGE_FINDER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• LASER_RANGE_FINDER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn LaserRangeFinderV2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>¶

Rückgabe:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von LaserRangeFinderV2Bricklet::set_status_led_config gesetzt.

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

Für config:

• LASER_RANGE_FINDER_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
• LASER_RANGE_FINDER_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
• LASER_RANGE_FINDER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• LASER_RANGE_FINDER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn LaserRangeFinderV2Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>¶

Rückgabe:	temperature – Typ: i16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

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.

pub fn LaserRangeFinderV2Bricklet::reset(&self) → ConvertingReceiver<()>¶

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.

pub fn LaserRangeFinderV2Bricklet::get_identity(&self) → ConvertingReceiver<Identity>¶

Rückgabeobjekt:

uid – Typ: String, Länge: bis zu 8 connected_uid – Typ: String, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardware_version – Typ: [u8; 3] 0: major – Typ: u8, Wertebereich: [0 bis 255] 1: minor – Typ: u8, Wertebereich: [0 bis 255] 2: revision – Typ: u8, Wertebereich: [0 bis 255] firmware_version – Typ: [u8; 3] 0: major – Typ: u8, Wertebereich: [0 bis 255] 1: minor – Typ: u8, Wertebereich: [0 bis 255] 2: revision – Typ: u8, Wertebereich: [0 bis 255] device_identifier – Typ: u16, Wertebereich: [0 bis 216 - 1]

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¶

pub fn LaserRangeFinderV2Bricklet::set_distance_callback_configuration(&self, period: u32, value_has_to_change: bool, option: char, min: i16, max: i16) → ConvertingReceiver<()>¶

Parameter:	period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: i16, Einheit: 1 cm, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: i16, Einheit: 1 cm, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Die Periode ist die Periode mit der der LaserRangeFinderV2Bricklet::get_distance_callback_receiver 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 LaserRangeFinderV2Bricklet::get_distance_callback_receiver 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_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn LaserRangeFinderV2Bricklet::get_distance_callback_configuration(&self) → ConvertingReceiver<DistanceCallbackConfiguration>¶

Rückgabeobjekt:	period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: i16, Einheit: 1 cm, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: i16, Einheit: 1 cm, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels LaserRangeFinderV2Bricklet::set_distance_callback_configuration gesetzt.

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

Für option:

• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn LaserRangeFinderV2Bricklet::set_velocity_callback_configuration(&self, period: u32, value_has_to_change: bool, option: char, min: i16, max: i16) → ConvertingReceiver<()>¶

Parameter:	period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: i16, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: i16, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Die Periode ist die Periode mit der der LaserRangeFinderV2Bricklet::get_velocity_callback_receiver 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 LaserRangeFinderV2Bricklet::get_velocity_callback_receiver 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_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn LaserRangeFinderV2Bricklet::get_velocity_callback_configuration(&self) → ConvertingReceiver<VelocityCallbackConfiguration>¶

Rückgabeobjekt:	period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: i16, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: i16, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels LaserRangeFinderV2Bricklet::set_velocity_callback_configuration gesetzt.

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

Für option:

• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• LASER_RANGE_FINDER_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden get_*_callback_receiver-Function durchgeführt werden, welche einen Receiver für Callback-Events zurück gibt.

pub fn LaserRangeFinderV2Bricklet::get_distance_callback_receiver(&self) → ConvertingCallbackReceiver<i16>¶

Event:	distance – Typ: i16, Einheit: 1 cm, Wertebereich: [0 bis 4000]

Receiver die mit dieser Funktion erstellt werden, empfangen Distance-Events.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels LaserRangeFinderV2Bricklet::set_distance_callback_configuration gesetzten Konfiguration

Der empfangene Variable ist der gleiche wie LaserRangeFinderV2Bricklet::get_distance.

pub fn LaserRangeFinderV2Bricklet::get_velocity_callback_receiver(&self) → ConvertingCallbackReceiver<i16>¶

Event:	velocity – Typ: i16, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]

Receiver die mit dieser Funktion erstellt werden, empfangen Velocity-Events.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels LaserRangeFinderV2Bricklet::set_velocity_callback_configuration gesetzten Konfiguration

Der empfangene Variable ist der gleiche wie LaserRangeFinderV2Bricklet::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.

pub fn LaserRangeFinderV2Bricklet::get_api_version(&self) → [u8; 3]¶

Rückgabeobjekt:	api_version – Typ: [u8; 3] 0: major – Typ: u8, Wertebereich: [0 bis 255] 1: minor – Typ: u8, Wertebereich: [0 bis 255] 2: revision – Typ: u8, Wertebereich: [0 bis 255]

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.

pub fn LaserRangeFinderV2Bricklet::get_response_expected(&mut self, function_id: u8) → bool¶

Parameter:	function_id – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:	response_expected – Typ: bool

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 LaserRangeFinderV2Bricklet::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_BRICKLET_FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_SET_VELOCITY_CALLBACK_CONFIGURATION = 6
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_SET_ENABLE = 9
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 11
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_SET_MOVING_AVERAGE = 13
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_SET_OFFSET_CALIBRATION = 15
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_SET_DISTANCE_LED_CONFIG = 17
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_RESET = 243
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_WRITE_UID = 248

pub fn LaserRangeFinderV2Bricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()¶

Parameter:	function_id – Typ: u8, Wertebereich: Siehe Konstanten response_expected – Typ: bool

Ä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_V2_BRICKLET_FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_SET_VELOCITY_CALLBACK_CONFIGURATION = 6
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_SET_ENABLE = 9
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 11
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_SET_MOVING_AVERAGE = 13
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_SET_OFFSET_CALIBRATION = 15
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_SET_DISTANCE_LED_CONFIG = 17
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_RESET = 243
• LASER_RANGE_FINDER_V2_BRICKLET_FUNCTION_WRITE_UID = 248

pub fn LaserRangeFinderV2Bricklet::set_response_expected_all(&mut self, response_expected: bool) → ()¶

Parameter:	response_expected – Typ: bool

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

pub fn LaserRangeFinderV2Bricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>¶

Parameter:	mode – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: u8, Wertebereich: Siehe Konstanten

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_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
• LASER_RANGE_FINDER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
• LASER_RANGE_FINDER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• LASER_RANGE_FINDER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• LASER_RANGE_FINDER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• LASER_RANGE_FINDER_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
• LASER_RANGE_FINDER_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
• LASER_RANGE_FINDER_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
• LASER_RANGE_FINDER_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• LASER_RANGE_FINDER_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• LASER_RANGE_FINDER_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5

pub fn LaserRangeFinderV2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>¶

Rückgabe:	mode – Typ: u8, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe LaserRangeFinderV2Bricklet::set_bootloader_mode.

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

Für mode:

• LASER_RANGE_FINDER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
• LASER_RANGE_FINDER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
• LASER_RANGE_FINDER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• LASER_RANGE_FINDER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• LASER_RANGE_FINDER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

pub fn LaserRangeFinderV2Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>¶

Parameter:	pointer – Typ: u32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für LaserRangeFinderV2Bricklet::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.

pub fn LaserRangeFinderV2Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>¶

Parameter:	data – Typ: [u8; 64], Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: u8, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von LaserRangeFinderV2Bricklet::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.

pub fn LaserRangeFinderV2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>¶

Parameter:	uid – Typ: u32, Wertebereich: [0 bis 232 - 1]

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.

pub fn LaserRangeFinderV2Bricklet::read_uid(&self) → ConvertingReceiver<u32>¶

Rückgabe:	uid – Typ: u32, Wertebereich: [0 bis 232 - 1]

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

Konstanten¶

pub const LaserRangeFinderV2Bricklet::DEVICE_IDENTIFIER¶

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

Die LaserRangeFinderV2Bricklet::get_identity Funktion und der IpConnection::get_enumerate_callback_receiver Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

pub const LaserRangeFinderV2Bricklet::DEVICE_DISPLAY_NAME¶

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