Rust - Industrial Dual Analog In Bricklet

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

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

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

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

    // Get current voltage from channel 1.
    let voltage = idai.get_voltage(1).recv()?;
    println!("Voltage (Channel 1): {} V", voltage as f32 / 1000.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
37
38
use std::{error::Error, io, thread};
use tinkerforge::{industrial_dual_analog_in_bricklet::*, ip_connection::IpConnection};

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

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

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

    let voltage_receiver = idai.get_voltage_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `idai` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for voltage in voltage_receiver {
            println!("Channel: {}", voltage.channel);
            println!("Voltage: {} V", voltage.voltage as f32 / 1000.0);
            println!();
        }
    });

    // Set period for voltage (channel 1) receiver to 1s (1000ms).
    // Note: The voltage (channel 1) callback is only called every second
    //       if the voltage (channel 1) has changed since the last call!
    idai.set_voltage_callback_period(1, 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
38
39
use std::{error::Error, io, thread};
use tinkerforge::{industrial_dual_analog_in_bricklet::*, ip_connection::IpConnection};

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let idai = IndustrialDualAnalogInBricklet::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).
    idai.set_debounce_period(10000);

    let voltage_reached_receiver = idai.get_voltage_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `idai` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for voltage_reached in voltage_reached_receiver {
            println!("Channel: {}", voltage_reached.channel);
            println!("Voltage: {} V", voltage_reached.voltage as f32 / 1000.0);
            println!();
        }
    });

    // Configure threshold for voltage (channel 1) "greater than 10 V".
    idai.set_voltage_callback_threshold(1, '>', 10 * 1000, 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.

Das Bricklet hat zwei Eingangskanäle. Funktionen die sich direkt auf einen der Kanäle beziehen haben einen channel Parameter, um den Kanal anzugeben. Gültige Werte für das channel Parameter sind 0 und 1.

Grundfunktionen

pub fn IndustrialDualAnalogInBricklet::new(uid: &str, ip_connection: &IpConnection) → IndustrialDualAnalogInBricklet

Erzeugt ein neues IndustrialDualAnalogInBricklet-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 IndustrialDualAnalogInBricklet::get_voltage(&self, channel: u8) → ConvertingReceiver<i32>

Gibt die Spannung für den übergebenen Kanal in mV zurück.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den IndustrialDualAnalogInBricklet::get_voltage_callback_receiver Callback zu nutzen und die Periode mit IndustrialDualAnalogInBricklet::set_voltage_callback_period vorzugeben.

Fortgeschrittene Funktionen

pub fn IndustrialDualAnalogInBricklet::set_sample_rate(&self, rate: u8) → ConvertingReceiver<()>

Setzt die Abtastrate. Der Wertebereich der verfügbare Abtastraten liegt zwischen 1 Wert pro Sekunde und 976 Werte pro Sekunde. Ein Verringern der Abtastrate wird auch das Rauschen auf den Daten verringern.

Der Standardwert ist 6 (2 Werte pro Sekunde).

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

  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_976_SPS = 0
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_488_SPS = 1
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_244_SPS = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_122_SPS = 3
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_61_SPS = 4
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_4_SPS = 5
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_2_SPS = 6
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_1_SPS = 7
pub fn IndustrialDualAnalogInBricklet::get_sample_rate(&self) → ConvertingReceiver<u8>

Gibt die Abtastrate zurück, wie von IndustrialDualAnalogInBricklet::set_sample_rate gesetzt.

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

  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_976_SPS = 0
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_488_SPS = 1
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_244_SPS = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_122_SPS = 3
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_61_SPS = 4
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_4_SPS = 5
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_2_SPS = 6
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_SAMPLE_RATE_1_SPS = 7
pub fn IndustrialDualAnalogInBricklet::set_calibration(&self, offset: [i32; 2], gain: [i32; 2]) → ConvertingReceiver<()>

Setzt Offset und Gain der MCP3911 internen Kalibrierungsregister.

Siehe MCP3911 Datenblatt 7.7 und 7.8. Das Industrial Dual Analog In Bricklet wird von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte nicht notwendig sein.

pub fn IndustrialDualAnalogInBricklet::get_calibration(&self) → ConvertingReceiver<Calibration>

Gibt die Kalibrierung zurück, wie von IndustrialDualAnalogInBricklet::set_calibration gesetzt.

pub fn IndustrialDualAnalogInBricklet::get_adc_values(&self) → ConvertingReceiver<[i32; 2]>

Gibt die ADC-Werte des MCP3911 ICs zurück. Diese Funktion wird für die Kalibrierung benötigt, siehe IndustrialDualAnalogInBricklet::set_calibration.

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

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

  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 4
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_FUNCTION_SET_SAMPLE_RATE = 8
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_FUNCTION_SET_CALIBRATION = 10
pub fn IndustrialDualAnalogInBricklet::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 IndustrialDualAnalogInBricklet::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 IndustrialDualAnalogInBricklet::set_voltage_callback_period(&self, channel: u8, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der IndustrialDualAnalogInBricklet::get_voltage_callback_receiver Callback für den übergebenen Kanal ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der IndustrialDualAnalogInBricklet::get_voltage_callback_receiver Callback wird nur ausgelöst wenn sich die Spannung seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

pub fn IndustrialDualAnalogInBricklet::get_voltage_callback_period(&self, channel: u8) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von IndustrialDualAnalogInBricklet::set_voltage_callback_period gesetzt.

pub fn IndustrialDualAnalogInBricklet::set_voltage_callback_threshold(&self, channel: u8, option: char, min: i32, max: i32) → ConvertingReceiver<()>

Setzt den Schwellwert des IndustrialDualAnalogInBricklet::get_voltage_reached_callback_receiver Callbacks für den übergebenen Kanal.

Die folgenden Optionen sind möglich:

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

  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn IndustrialDualAnalogInBricklet::get_voltage_callback_threshold(&self, channel: u8) → ConvertingReceiver<VoltageCallbackThreshold>

Gibt den Schwellwert zurück, wie von IndustrialDualAnalogInBricklet::set_voltage_callback_threshold gesetzt.

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

  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • INDUSTRIAL_DUAL_ANALOG_IN_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn IndustrialDualAnalogInBricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der Schwellwert Callback

ausgelöst werden, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

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

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

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

Dieser Callback wird mit der Periode, wie gesetzt mit IndustrialDualAnalogInBricklet::set_voltage_callback_period, ausgelöst. Der empfangene Variable ist die Spannung des Kanals.

Der IndustrialDualAnalogInBricklet::get_voltage_callback_receiver Callback wird nur ausgelöst wenn sich die Spannung seit der letzten Auslösung geändert hat.

pub fn IndustrialDualAnalogInBricklet::get_voltage_reached_callback_receiver(&self) → ConvertingCallbackReceiver<VoltageReachedEvent>

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

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von IndustrialDualAnalogInBricklet::set_voltage_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist die Spannung des Kanals.

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

Konstanten

IndustrialDualAnalogInBricklet::DEVICE_IDENTIFIER

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

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

IndustrialDualAnalogInBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Industrial Dual Analog In Bricklet dar.