Rust - Line Bricklet

Dies ist die Beschreibung der Rust API Bindings für das Line Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Line 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::{ip_connection::IpConnection, line_bricklet::*};

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

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

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

    // Get current reflectivity.
    let reflectivity = l.get_reflectivity().recv()?;
    println!("Reflectivity: {}", reflectivity);

    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::{ip_connection::IpConnection, line_bricklet::*};

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

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

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

    let reflectivity_receiver = l.get_reflectivity_callback_receiver();

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

    // Set period for reflectivity receiver to 1s (1000ms).
    // Note: The reflectivity callback is only called every second
    //       if the reflectivity has changed since the last call!
    l.set_reflectivity_callback_period(1000);

    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::{ip_connection::IpConnection, line_bricklet::*};

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let l = LineBricklet::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 1 second (1000ms).
    l.set_debounce_period(1000);

    let reflectivity_reached_receiver = l.get_reflectivity_reached_callback_receiver();

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

    // Configure threshold for reflectivity "greater than 2000".
    l.set_reflectivity_callback_threshold('>', 2000, 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 LineBricklet::new(uid: &str, ip_connection: &IpConnection) → LineBricklet

Erzeugt ein neues LineBricklet-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 LineBricklet::get_reflectivity(&self) → ConvertingReceiver<u16>

Gibt die aktuell gemessene Reflektivität zurück. Die Reflektivität ist ein Wert zwischen 0 (nicht reflektiv) und 4095 (sehr reflektiv).

Normalerweise hat schwarz eine geringe Reflektivität während weiß eine hohe Reflektivität hat.

Wenn die Reflektivität periodisch abgefragt werden soll, wird empfohlen den LineBricklet::get_reflectivity_callback_receiver Callback zu nutzen und die Periode mit LineBricklet::set_reflectivity_callback_period vorzugeben.

Fortgeschrittene Funktionen

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

  • LINE_BRICKLET_FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD = 2
  • LINE_BRICKLET_FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD = 4
  • LINE_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
pub fn LineBricklet::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 Konstanten sind für diese Funktion verfügbar:

  • LINE_BRICKLET_FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD = 2
  • LINE_BRICKLET_FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD = 4
  • LINE_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
pub fn LineBricklet::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 LineBricklet::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 LineBricklet::set_reflectivity_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

Der LineBricklet::get_reflectivity_callback_receiver Callback wird nur ausgelöst, wenn sich die Reflektivität seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

pub fn LineBricklet::get_reflectivity_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von LineBricklet::set_reflectivity_callback_period gesetzt.

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

Setzt den Schwellwert für den LineBricklet::get_reflectivity_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Reflektivität außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Reflektivität innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Reflektivität kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Reflektivität 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:

  • LINE_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • LINE_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • LINE_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • LINE_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • LINE_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn LineBricklet::get_reflectivity_callback_threshold(&self) → ConvertingReceiver<ReflectivityCallbackThreshold>

Gibt den Schwellwert zurück, wie von LineBricklet::set_reflectivity_callback_threshold gesetzt.

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

  • LINE_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • LINE_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • LINE_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • LINE_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • LINE_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn LineBricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

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

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

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

Dieser Callback wird mit der Periode, wie gesetzt mit LineBricklet::set_reflectivity_callback_period, ausgelöst. Der empfangene Variable ist die Reflektivität des Sensors.

Der LineBricklet::get_reflectivity_callback_receiver Callback wird nur ausgelöst, wenn sich die Reflektivität seit der letzten Auslösung geändert hat.

pub fn LineBricklet::get_reflectivity_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von LineBricklet::set_reflectivity_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist die Reflektivität des Sensors.

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

Konstanten

LineBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Line Bricklet zu identifizieren.

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

LineBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Line Bricklet dar.