Rust - Analog Out Bricklet

Dies ist die Beschreibung der Rust API Bindings für das Analog Out Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Analog Out 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
use std::{error::Error, io};

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

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

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

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

    // Set output voltage to 3.3V
    ao.set_voltage(3300);

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

Erzeugt ein neues AnalogOutBricklet-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 AnalogOutBricklet::set_voltage(&self, voltage: u16) → ConvertingReceiver<()>

Setzt die Spannung in mV. Der mögliche Bereich ist 0V bis 5V (0-5000). Dieser Funktionsaufruf setzt den Modus auf 0 (siehe AnalogOutBricklet::set_mode).

Der Standardwert ist 0 (im Modus 1).

pub fn AnalogOutBricklet::get_voltage(&self) → ConvertingReceiver<u16>

Gibt die Spannung zurück, wie von AnalogOutBricklet::set_voltage gesetzt.

pub fn AnalogOutBricklet::set_mode(&self, mode: u8) → ConvertingReceiver<()>

Setzt den Modus des Analogwertes. Mögliche Modi:

  • 0: normaler Modus (Analogwert, wie von AnalogOutBricklet::set_voltage gesetzt, wird ausgegeben.)
  • 1: 1k Ohm Widerstand gegen Masse
  • 2: 100k Ohm Widerstand gegen Masse
  • 3: 500k Ohm Widerstand gegen Masse

Ein setzten des Modus auf 0 resultiert in einer Ausgabespannung von 0. Es kann auf eine höhere Ausgabespannung direkt gewechselt werden über einen Aufruf von AnalogOutBricklet::set_voltage.

Der Standardmodus ist 1.

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

  • ANALOG_OUT_BRICKLET_MODE_ANALOG_VALUE = 0
  • ANALOG_OUT_BRICKLET_MODE_1K_TO_GROUND = 1
  • ANALOG_OUT_BRICKLET_MODE_100K_TO_GROUND = 2
  • ANALOG_OUT_BRICKLET_MODE_500K_TO_GROUND = 3
pub fn AnalogOutBricklet::get_mode(&self) → ConvertingReceiver<u8>

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

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

  • ANALOG_OUT_BRICKLET_MODE_ANALOG_VALUE = 0
  • ANALOG_OUT_BRICKLET_MODE_1K_TO_GROUND = 1
  • ANALOG_OUT_BRICKLET_MODE_100K_TO_GROUND = 2
  • ANALOG_OUT_BRICKLET_MODE_500K_TO_GROUND = 3

Fortgeschrittene Funktionen

pub fn AnalogOutBricklet::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 AnalogOutBricklet::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 AnalogOutBricklet::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 AnalogOutBricklet::set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

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

  • ANALOG_OUT_BRICKLET_FUNCTION_SET_VOLTAGE = 1
  • ANALOG_OUT_BRICKLET_FUNCTION_SET_MODE = 3
pub fn AnalogOutBricklet::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 AnalogOutBricklet::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.

Konstanten

AnalogOutBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Analog Out Bricklet zu identifizieren.

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

AnalogOutBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Analog Out Bricklet dar.