Rust - Laser Range Finder Bricklet

Dies ist die Beschreibung der Rust 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 Rust API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf docs.rs.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.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
use std::{error::Error, io, thread, time::Duration};
use tinkerforge::{ip_connection::IpConnection, laser_range_finder_bricklet::*};

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let lrf = LaserRangeFinderBricklet::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.enable_laser();
    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)?;
    lrf.disable_laser(); // Turn laser off
    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
use std::{error::Error, io, thread, time::Duration};
use tinkerforge::{ip_connection::IpConnection, laser_range_finder_bricklet::*};

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let lrf = LaserRangeFinderBricklet::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.enable_laser();
    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 receiver to 0.2s (200ms).
    // Note: The distance callback is only called every 0.2 seconds
    //       if the distance has changed since the last call!
    lrf.set_distance_callback_period(200);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    lrf.disable_laser(); // Turn laser off
    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
use std::{error::Error, io, thread, time::Duration};
use tinkerforge::{ip_connection::IpConnection, laser_range_finder_bricklet::*};

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let lrf = LaserRangeFinderBricklet::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.enable_laser();
    thread::sleep(Duration::from_millis(250));

    // Get threshold receivers with a debounce time of 10 seconds (10000ms).
    lrf.set_debounce_period(10000);

    let distance_reached_receiver = lrf.get_distance_reached_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_reached in distance_reached_receiver {
            println!("Distance: {} cm", distance_reached);
        }
    });

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

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    lrf.disable_laser(); // Turn laser off
    ipcon.disconnect();
    Ok(())
}

API

Um eine nicht-blockierende Verwendung zu erlauben, gibt fast jede Funktion der Rust-Bindings einen Wrapper um einen mpsc::Receiver zurück. Um das Ergebnis eines Funktionsaufrufs zu erhalten und zu blockieren, bis das Gerät die Anfrage verarbeitet hat, können die recv-Varianten des Receivers verwendet werden. Diese geben entweder das vom Gerät gesendete Ergebnis, oder einen aufgetretenen Fehler zurück.

Funktionen die direkt ein Result zurückgeben, blockieren bis das Gerät die Anfrage verarbeitet hat.

Alle folgend aufgelisteten Funktionen sind Thread-sicher, diese, die einen Receiver zurückgeben, sind Lock-frei.

Grundfunktionen

pub fn LaserRangeFinderBricklet::new(uid: &str, ip_connection: &IpConnection) → LaserRangeFinderBricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • laser_range_finder – Typ: LaserRangeFinderBricklet

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

let laser_range_finder = LaserRangeFinderBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn LaserRangeFinderBricklet::get_distance(&self) → ConvertingReceiver<u16>
Rückgabe:
  • distance – Typ: u16, Einheit: 1 cm, Wertebereich: [0 bis 4000]

Gibt die gemessene Distanz zurück.

Sensor Hardware Version 1 (siehe LaserRangeFinderBricklet::get_sensor_hardware_version) kann nicht gleichzeitig Distanz und Geschwindigkeit messen. Daher muss mittels LaserRangeFinderBricklet::set_mode der Distanzmodus aktiviert sein. Sensor Hardware Version 3 kann gleichzeitig Distanz und Geschwindigkeit messen. Zusätzlich muss der Laser aktiviert werden, siehe LaserRangeFinderBricklet::enable_laser.

Wenn der Entfernungswert periodisch abgefragt werden soll, wird empfohlen den LaserRangeFinderBricklet::get_distance_callback_receiver Callback zu nutzen und die Periode mit LaserRangeFinderBricklet::set_distance_callback_period vorzugeben.

pub fn LaserRangeFinderBricklet::get_velocity(&self) → ConvertingReceiver<i16>
Rückgabe:
  • velocity – Typ: i16, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]

Gibt die gemessene Geschwindigkeit zurück.

Sensor Hardware Version 1 (siehe LaserRangeFinderBricklet::get_sensor_hardware_version) kann nicht gleichzeitig Distanz und Geschwindigkeit messen. Daher muss mittels LaserRangeFinderBricklet::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 LaserRangeFinderBricklet::set_configuration) eingestellt ist. Zusätzlich muss der Laser aktiviert werden, siehe LaserRangeFinderBricklet::enable_laser.

Wenn der Geschwindigkeitswert periodisch abgefragt werden soll, wird empfohlen den LaserRangeFinderBricklet::get_velocity_callback_receiver Callback zu nutzen und die Periode mit LaserRangeFinderBricklet::set_velocity_callback_period vorzugeben.

pub fn LaserRangeFinderBricklet::set_mode(&self, mode: u8) → ConvertingReceiver<()>
Parameter:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

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 LaserRangeFinderBricklet::set_configuration. die Hardware Version des Sensors kann mittels LaserRangeFinderBricklet::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_BRICKLET_MODE_DISTANCE = 0
  • LASER_RANGE_FINDER_BRICKLET_MODE_VELOCITY_MAX_13MS = 1
  • LASER_RANGE_FINDER_BRICKLET_MODE_VELOCITY_MAX_32MS = 2
  • LASER_RANGE_FINDER_BRICKLET_MODE_VELOCITY_MAX_64MS = 3
  • LASER_RANGE_FINDER_BRICKLET_MODE_VELOCITY_MAX_127MS = 4
pub fn LaserRangeFinderBricklet::get_mode(&self) → ConvertingReceiver<u8>
Rückgabe:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt den Modus zurück, wie von LaserRangeFinderBricklet::set_mode gesetzt.

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

Für mode:

  • LASER_RANGE_FINDER_BRICKLET_MODE_DISTANCE = 0
  • LASER_RANGE_FINDER_BRICKLET_MODE_VELOCITY_MAX_13MS = 1
  • LASER_RANGE_FINDER_BRICKLET_MODE_VELOCITY_MAX_32MS = 2
  • LASER_RANGE_FINDER_BRICKLET_MODE_VELOCITY_MAX_64MS = 3
  • LASER_RANGE_FINDER_BRICKLET_MODE_VELOCITY_MAX_127MS = 4
pub fn LaserRangeFinderBricklet::enable_laser(&self) → ConvertingReceiver<()>

Aktiviert den Laser des LIDAR.

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

pub fn LaserRangeFinderBricklet::disable_laser(&self) → ConvertingReceiver<()>

Deaktiviert den Laser des LIDAR.

pub fn LaserRangeFinderBricklet::is_laser_enabled(&self) → ConvertingReceiver<bool>
Rückgabe:
  • laser_enabled – Typ: bool

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

pub fn LaserRangeFinderBricklet::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

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 LaserRangeFinderBricklet::set_mode. Die Hardware Version des Sensors kann mittels LaserRangeFinderBricklet::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).

pub fn LaserRangeFinderBricklet::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 LaserRangeFinderBricklet::set_configuration gesetzt.

Neu in Version 2.0.3 (Plugin).

Fortgeschrittene Funktionen

pub fn LaserRangeFinderBricklet::set_moving_average(&self, distance_average_length: u8, velocity_average_length: u8) → ConvertingReceiver<()>
Parameter:
  • distance_average_length – Typ: u8, Wertebereich: [0 bis 30], Standardwert: 10
  • velocity_average_length – Typ: u8, Wertebereich: [0 bis 30], 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 LaserRangeFinderBricklet::get_moving_average(&self) → ConvertingReceiver<MovingAverage>
Rückgabeobjekt:
  • distance_average_length – Typ: u8, Wertebereich: [0 bis 30], Standardwert: 10
  • velocity_average_length – Typ: u8, Wertebereich: [0 bis 30], Standardwert: 10

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

pub fn LaserRangeFinderBricklet::get_sensor_hardware_version(&self) → ConvertingReceiver<u8>
Rückgabe:
  • version – Typ: u8, Wertebereich: Siehe Konstanten

Gibt die LIDAR-Lite Hardware version zurück.

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

Für version:

  • LASER_RANGE_FINDER_BRICKLET_VERSION_1 = 1
  • LASER_RANGE_FINDER_BRICKLET_VERSION_3 = 3

Neu in Version 2.0.3 (Plugin).

pub fn LaserRangeFinderBricklet::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', 'i', '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 '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

pub fn LaserRangeFinderBricklet::set_distance_callback_period(&self, period: u32) → ConvertingReceiver<()>
Parameter:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

pub fn LaserRangeFinderBricklet::get_distance_callback_period(&self) → ConvertingReceiver<u32>
Rückgabe:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von LaserRangeFinderBricklet::set_distance_callback_period gesetzt.

pub fn LaserRangeFinderBricklet::set_velocity_callback_period(&self, period: u32) → ConvertingReceiver<()>
Parameter:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

pub fn LaserRangeFinderBricklet::get_velocity_callback_period(&self) → ConvertingReceiver<u32>
Rückgabe:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von LaserRangeFinderBricklet::set_velocity_callback_period gesetzt.

pub fn LaserRangeFinderBricklet::set_distance_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: u16, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: u16, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den LaserRangeFinderBricklet::get_distance_reached_callback_receiver 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_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn LaserRangeFinderBricklet::get_distance_callback_threshold(&self) → ConvertingReceiver<DistanceCallbackThreshold>
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: u16, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: u16, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von LaserRangeFinderBricklet::set_distance_callback_threshold gesetzt.

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

Für option:

  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn LaserRangeFinderBricklet::set_velocity_callback_threshold(&self, option: char, min: i16, max: i16) → ConvertingReceiver<()>
Parameter:
  • 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

Setzt den Schwellwert für den LaserRangeFinderBricklet::get_velocity_reached_callback_receiver 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_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn LaserRangeFinderBricklet::get_velocity_callback_threshold(&self) → ConvertingReceiver<VelocityCallbackThreshold>
Rückgabeobjekt:
  • 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 den Schwellwert zurück, wie von LaserRangeFinderBricklet::set_velocity_callback_threshold gesetzt.

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

Für option:

  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • LASER_RANGE_FINDER_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn LaserRangeFinderBricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>
Parameter:
  • debounce – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

pub fn LaserRangeFinderBricklet::get_debounce_period(&self) → ConvertingReceiver<u32>
Rückgabe:
  • debounce – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von LaserRangeFinderBricklet::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 entsprechenden get_*_callback_receiver-Function durchgeführt werden, welche einen Receiver für Callback-Events zurück gibt.

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.

pub fn LaserRangeFinderBricklet::get_distance_callback_receiver(&self) → ConvertingCallbackReceiver<u16>
Event:
  • distance – Typ: u16, Einheit: 1 cm, Wertebereich: [0 bis 4000]

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

Dieser Callback wird mit der Periode, wie gesetzt mit LaserRangeFinderBricklet::set_distance_callback_period, ausgelöst. Der empfangene Variable ist die Entfernungswert des Sensors.

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

pub fn LaserRangeFinderBricklet::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 mit der Periode, wie gesetzt mit LaserRangeFinderBricklet::set_velocity_callback_period, ausgelöst. Der empfangene Variable ist die Geschwindigkeit des Sensors.

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

pub fn LaserRangeFinderBricklet::get_distance_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>
Event:
  • distance – Typ: u16, Einheit: 1 cm, Wertebereich: [0 bis 4000]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von LaserRangeFinderBricklet::set_distance_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist der Entfernungswert des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit LaserRangeFinderBricklet::set_debounce_period gesetzt, ausgelöst.

pub fn LaserRangeFinderBricklet::get_velocity_reached_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 Reached-Events.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von LaserRangeFinderBricklet::set_velocity_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist der Geschwindigkeitswert des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit LaserRangeFinderBricklet::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.

pub fn LaserRangeFinderBricklet::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 LaserRangeFinderBricklet::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 LaserRangeFinderBricklet::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_BRICKLET_FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 3
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_SET_VELOCITY_CALLBACK_PERIOD = 5
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 7
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_SET_VELOCITY_CALLBACK_THRESHOLD = 9
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_SET_MOVING_AVERAGE = 13
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_SET_MODE = 15
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_ENABLE_LASER = 17
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_DISABLE_LASER = 18
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_SET_CONFIGURATION = 25
pub fn LaserRangeFinderBricklet::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_BRICKLET_FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 3
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_SET_VELOCITY_CALLBACK_PERIOD = 5
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 7
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_SET_VELOCITY_CALLBACK_THRESHOLD = 9
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_SET_MOVING_AVERAGE = 13
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_SET_MODE = 15
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_ENABLE_LASER = 17
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_DISABLE_LASER = 18
  • LASER_RANGE_FINDER_BRICKLET_FUNCTION_SET_CONFIGURATION = 25
pub fn LaserRangeFinderBricklet::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.

Konstanten

pub const LaserRangeFinderBricklet::DEVICE_IDENTIFIER

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

Die LaserRangeFinderBricklet::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 LaserRangeFinderBricklet::DEVICE_DISPLAY_NAME

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