Rust - Distance IR Bricklet

Dies ist die Beschreibung der Rust API Bindings für das Distance IR Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Distance IR Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die 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
use std::{error::Error, io};

use tinkerforge::{distance_ir_bricklet::*, ip_connection::IpConnection};

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

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

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

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

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

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

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

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

    let distance_receiver = dir.get_distance_callback_receiver();

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

    // 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!
    dir.set_distance_callback_period(200);

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

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

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

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

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

    let distance_reached_receiver = dir.get_distance_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `dir` 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 as f32 / 10.0);
        }
    });

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

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    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 DistanceIrBricklet::new(uid: &str, ip_connection: &IpConnection) → DistanceIrBricklet

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

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

pub fn DistanceIrBricklet::get_distance(&self) → ConvertingReceiver<u16>

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

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

Fortgeschrittene Funktionen

pub fn DistanceIrBricklet::get_analog_value(&self) → ConvertingReceiver<u16>

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

Bemerkung

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

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den DistanceIrBricklet::get_analog_value_callback_receiver Callback zu nutzen und die Periode mit DistanceIrBricklet::set_analog_value_callback_period vorzugeben.

pub fn DistanceIrBricklet::set_sampling_point(&self, position: u8, distance: u16) → ConvertingReceiver<()>

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

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

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

Bemerkung

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

pub fn DistanceIrBricklet::get_sampling_point(&self, position: u8) → ConvertingReceiver<u16>

Gibt die Entfernung eines Messpunktes zurück, wie von DistanceIrBricklet::set_sampling_point gesetzt.

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

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

pub fn DistanceIrBricklet::get_response_expected(&mut self, function_id: u8) → 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 DistanceIrBricklet::set_response_expected. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Siehe DistanceIrBricklet::set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

pub fn DistanceIrBricklet::set_response_expected(&mut self, function_id: u8, response_expected: 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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • DISTANCE_IR_BRICKLET_FUNCTION_SET_SAMPLING_POINT = 3
  • DISTANCE_IR_BRICKLET_FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 5
  • DISTANCE_IR_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • DISTANCE_IR_BRICKLET_FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 9
  • DISTANCE_IR_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • DISTANCE_IR_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 13
pub fn DistanceIrBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()

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

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

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

pub fn DistanceIrBricklet::set_distance_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

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

Der Standardwert ist 0.

pub fn DistanceIrBricklet::get_distance_callback_period(&self) → ConvertingReceiver<u32>

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

pub fn DistanceIrBricklet::set_analog_value_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

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

Der Standardwert ist 0.

pub fn DistanceIrBricklet::get_analog_value_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von DistanceIrBricklet::set_analog_value_callback_period gesetzt.

pub fn DistanceIrBricklet::set_distance_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>

Setzt den Schwellwert für den DistanceIrBricklet::get_distance_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

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

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

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

  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn DistanceIrBricklet::get_distance_callback_threshold(&self) → ConvertingReceiver<DistanceCallbackThreshold>

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

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

  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn DistanceIrBricklet::set_analog_value_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>

Setzt den Schwellwert für den DistanceIrBricklet::get_analog_value_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

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

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

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

  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn DistanceIrBricklet::get_analog_value_callback_threshold(&self) → ConvertingReceiver<AnalogValueCallbackThreshold>

Gibt den Schwellwert zurück, wie von DistanceIrBricklet::set_analog_value_callback_threshold gesetzt.

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

  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • DISTANCE_IR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn DistanceIrBricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

pub fn DistanceIrBricklet::get_debounce_period(&self) → ConvertingReceiver<u32>

Gibt die Entprellperiode zurück, wie von DistanceIrBricklet::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 DistanceIrBricklet::get_distance_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

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

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

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

pub fn DistanceIrBricklet::get_analog_value_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

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

Dieser Callback wird mit der Periode, wie gesetzt mit DistanceIrBricklet::set_analog_value_callback_period, ausgelöst. Der empfangene Variable ist der Analogwert des Sensors.

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

pub fn DistanceIrBricklet::get_distance_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

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

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

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

pub fn DistanceIrBricklet::get_analog_value_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

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

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von DistanceIrBricklet::set_analog_value_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist der Analogwert des Sensors.

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

Konstanten

DistanceIrBricklet::DEVICE_IDENTIFIER

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

Die DistanceIrBricklet::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.

DistanceIrBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Distance IR Bricklet dar.