Rust - Linear Poti Bricklet¶

Dies ist die Beschreibung der Rust API Bindings für das Linear Poti Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Linear Poti 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)

use std::{error::Error, io};

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

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

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

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

    // Get current position.
    let position = lp.get_position().recv()?;
    println!("Position: {} %", position); // Range: 0 to 100

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

Callback¶

Download (example_callback.rs)

use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, linear_poti_bricklet::*};

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

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

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

    let position_receiver = lp.get_position_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `lp` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for position in position_receiver {
            println!("Position: {} %", position); // Range: 0 to 100
        }
    });

    // Set period for position receiver to 0.05s (50ms).
    // Note: The position callback is only called every 0.05 seconds
    //       if the position has changed since the last call!
    lp.set_position_callback_period(50);

    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 LinearPotiBricklet::new(uid: &str, ip_connection: &IpConnection) → LinearPotiBricklet¶

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	linear_poti – Typ: LinearPotiBricklet

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

let linear_poti = LinearPotiBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn LinearPotiBricklet::get_position(&self) → ConvertingReceiver<u16>¶

Rückgabe:	position – Typ: u16, Einheit: 1 %, Wertebereich: [0 bis 100]

Gibt die Position des Linearpotentiometers zurück. Der Wertebereich ist von 0% (Schieberegler unten) und 100% (Schieberegler oben).

Wenn die Position periodisch abgefragt werden soll, wird empfohlen den LinearPotiBricklet::get_position_callback_receiver() Callback zu nutzen und die Periode mit LinearPotiBricklet::set_position_callback_period() vorzugeben.

Fortgeschrittene Funktionen¶

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

Rückgabe:	value – Typ: u16, Wertebereich: [0 bis 2¹² - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von LinearPotiBricklet::get_position() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während LinearPotiBricklet::get_analog_value() unverarbeitete Analogwerte zurück gibt. Der einzige Grund LinearPotiBricklet::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 LinearPotiBricklet::get_analog_value_callback_receiver() Callback zu nutzen und die Periode mit LinearPotiBricklet::set_analog_value_callback_period() vorzugeben.

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

Rückgabeobjekt:

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 2¹⁶ - 1]

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 2¹⁶ - 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 LinearPotiBricklet::set_position_callback_period(&self, period: u32) → ConvertingReceiver<()>¶

Parameter:	period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der LinearPotiBricklet::get_position_callback_receiver() Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der LinearPotiBricklet::get_position_callback_receiver() Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

pub fn LinearPotiBricklet::get_position_callback_period(&self) → ConvertingReceiver<u32>¶

Rückgabe:	period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von LinearPotiBricklet::set_position_callback_period() gesetzt.

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

Parameter:	period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der LinearPotiBricklet::get_analog_value_callback_receiver() Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

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

Rückgabe:	period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von LinearPotiBricklet::set_analog_value_callback_period() gesetzt.

pub fn LinearPotiBricklet::set_position_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: u16, Einheit: 1 %, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: u16, Einheit: 1 %, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

Setzt den Schwellwert für den LinearPotiBricklet::get_position_reached_callback_receiver() Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn LinearPotiBricklet::get_position_callback_threshold(&self) → ConvertingReceiver<PositionCallbackThreshold>¶

Rückgabeobjekt:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: u16, Einheit: 1 %, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: u16, Einheit: 1 %, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von LinearPotiBricklet::set_position_callback_threshold() gesetzt.

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

Für option:

LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn LinearPotiBricklet::set_analog_value_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: u16, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: u16, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

Setzt den Schwellwert für den LinearPotiBricklet::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 der min und max Werte ist
'i'	Callback wird ausgelöst, wenn der Analogwert innerhalb der min und max Werte 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)

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

Für option:

LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn LinearPotiBricklet::get_analog_value_callback_threshold(&self) → ConvertingReceiver<AnalogValueCallbackThreshold>¶

Rückgabeobjekt:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: u16, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: u16, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von LinearPotiBricklet::set_analog_value_callback_threshold() gesetzt.

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

Für option:

LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
LINEAR_POTI_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn LinearPotiBricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>¶

Parameter:	debounce – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

LinearPotiBricklet::get_position_reached_callback_receiver(),
LinearPotiBricklet::get_analog_value_reached_callback_receiver()

ausgelöst werden, wenn die Schwellwerte

LinearPotiBricklet::set_position_callback_threshold(),
LinearPotiBricklet::set_analog_value_callback_threshold()

weiterhin erreicht bleiben.

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

Rückgabe:	debounce – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100

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

Event:	position – Typ: u16, Einheit: 1 %, Wertebereich: [0 bis 100]

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

Dieser Callback wird mit der Periode, wie gesetzt mit LinearPotiBricklet::set_position_callback_period(), ausgelöst. Der empfangene Variable ist die Position des Linearpotentiometers.

Der LinearPotiBricklet::get_position_callback_receiver() Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

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

Event:	value – Typ: u16, Wertebereich: [0 bis 2¹² - 1]

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

Dieser Callback wird mit der Periode, wie gesetzt mit LinearPotiBricklet::set_analog_value_callback_period(), ausgelöst. Der empfangene Variable ist der Analogwert des Linearpotentiometers.

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

pub fn LinearPotiBricklet::get_position_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>¶

Event:	position – Typ: u16, Einheit: 1 %, Wertebereich: [0 bis 100]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von LinearPotiBricklet::set_position_callback_threshold() gesetzt, erreicht wird. Der empfangene Variable ist die Position des Linearpotentiometers.

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

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

Event:	value – Typ: u16, Wertebereich: [0 bis 2¹² - 1]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von LinearPotiBricklet::set_analog_value_callback_threshold() gesetzt, erreicht wird. Der empfangene Variable ist der Analogwert des Linearpotentiometers.

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

LINEAR_POTI_BRICKLET_FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
LINEAR_POTI_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
LINEAR_POTI_BRICKLET_FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
LINEAR_POTI_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
LINEAR_POTI_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 11

pub fn LinearPotiBricklet::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.

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

Für function_id:

LINEAR_POTI_BRICKLET_FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
LINEAR_POTI_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
LINEAR_POTI_BRICKLET_FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
LINEAR_POTI_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
LINEAR_POTI_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 11

pub fn LinearPotiBricklet::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 LinearPotiBricklet::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Linear Poti Bricklet zu identifizieren.

Die LinearPotiBricklet::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 LinearPotiBricklet::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Linear Poti Bricklet dar.