Rust - Industrial Analog Out Bricklet

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

Download (example_simple_current.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
use std::{error::Error, io};

use tinkerforge::{industrial_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 Industrial Analog Out Bricklet.

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

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

    // Set output current to 4.5mA
    iao.set_current(4500);
    iao.enable();

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

Simple Voltage

Download (example_simple_voltage.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
use std::{error::Error, io};

use tinkerforge::{industrial_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 Industrial Analog Out Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let iao = IndustrialAnalogOutBricklet::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
    iao.set_voltage(3300);
    iao.enable();

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    iao.disable();
    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 IndustrialAnalogOutBricklet::new(uid: &str, ip_connection: &IpConnection) → IndustrialAnalogOutBricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • industrial_analog_out – Typ: IndustrialAnalogOutBricklet

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

let industrial_analog_out = IndustrialAnalogOutBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn IndustrialAnalogOutBricklet::enable(&self) → ConvertingReceiver<()>

Aktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

pub fn IndustrialAnalogOutBricklet::disable(&self) → ConvertingReceiver<()>

Deaktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

pub fn IndustrialAnalogOutBricklet::is_enabled(&self) → ConvertingReceiver<bool>
Rückgabe:
  • enabled – Typ: bool, Standardwert: false

Gibt true zurück falls die Ausgabe von Spannung und Strom aktiviert ist, false sonst.

pub fn IndustrialAnalogOutBricklet::set_voltage(&self, voltage: u16) → ConvertingReceiver<()>
Parameter:
  • voltage – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 10000]

Setzt die Ausgangsspannung.

Die Ausgangsspannung und der Ausgangsstrom sind gekoppelt. Eine Änderung der Ausgangsspannung führt auch zu einer Änderung des Ausgangsstroms.

pub fn IndustrialAnalogOutBricklet::get_voltage(&self) → ConvertingReceiver<u16>
Rückgabe:
  • voltage – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 10000]

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

pub fn IndustrialAnalogOutBricklet::set_current(&self, current: u16) → ConvertingReceiver<()>
Parameter:
  • current – Typ: u16, Einheit: 1 µA, Wertebereich: [0 bis 24000]

Setzt den Ausgangsstrom.

Der Ausgangsstrom und die Ausgangsspannung sind gekoppelt. Eine Änderung des Ausgangsstroms führt auch zu einer Änderung der Ausgangsspannung.

pub fn IndustrialAnalogOutBricklet::get_current(&self) → ConvertingReceiver<u16>
Rückgabe:
  • current – Typ: u16, Einheit: 1 µA, Wertebereich: [0 bis 24000]

Gibt die Spannung zurück, wie von IndustrialAnalogOutBricklet::set_current gesetzt.

Fortgeschrittene Funktionen

pub fn IndustrialAnalogOutBricklet::set_configuration(&self, voltage_range: u8, current_range: u8) → ConvertingReceiver<()>
Parameter:
  • voltage_range – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 1
  • current_range – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Konfiguriert die Spannungs- und Stromwertebereiche.

Einstellbare Spannungswertebereiche sind:

  • 0V bis 5V
  • 0V bis 10V

Einstellbare Stromwertebereiche sind:

  • 4mA bis 20mA
  • 0mA bis 20mA
  • 0mA bis 24mA

Die Auflösung ist immer 12 Bit. Dass heißt, die Genauigkeit erhöht sich bei kleineren Wertebereichen.

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

Für voltage_range:

  • INDUSTRIAL_ANALOG_OUT_BRICKLET_VOLTAGE_RANGE_0_TO_5V = 0
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_VOLTAGE_RANGE_0_TO_10V = 1

Für current_range:

  • INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_4_TO_20MA = 0
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_0_TO_20MA = 1
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_0_TO_24MA = 2
pub fn IndustrialAnalogOutBricklet::get_configuration(&self) → ConvertingReceiver<Configuration>
Rückgabeobjekt:
  • voltage_range – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 1
  • current_range – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Konfiguration zurück, wie von IndustrialAnalogOutBricklet::set_configuration gesetzt.

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

Für voltage_range:

  • INDUSTRIAL_ANALOG_OUT_BRICKLET_VOLTAGE_RANGE_0_TO_5V = 0
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_VOLTAGE_RANGE_0_TO_10V = 1

Für current_range:

  • INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_4_TO_20MA = 0
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_0_TO_20MA = 1
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_0_TO_24MA = 2
pub fn IndustrialAnalogOutBricklet::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.

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 IndustrialAnalogOutBricklet::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 IndustrialAnalogOutBricklet::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 IndustrialAnalogOutBricklet::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:

  • INDUSTRIAL_ANALOG_OUT_BRICKLET_FUNCTION_ENABLE = 1
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_FUNCTION_DISABLE = 2
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_FUNCTION_SET_VOLTAGE = 4
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_FUNCTION_SET_CURRENT = 6
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_FUNCTION_SET_CONFIGURATION = 8
pub fn IndustrialAnalogOutBricklet::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:

  • INDUSTRIAL_ANALOG_OUT_BRICKLET_FUNCTION_ENABLE = 1
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_FUNCTION_DISABLE = 2
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_FUNCTION_SET_VOLTAGE = 4
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_FUNCTION_SET_CURRENT = 6
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_FUNCTION_SET_CONFIGURATION = 8
pub fn IndustrialAnalogOutBricklet::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 IndustrialAnalogOutBricklet::DEVICE_IDENTIFIER

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

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

Diese Konstante stellt den Anzeigenamen eines Industrial Analog Out Bricklet dar.