Rust - Industrial Dual 0-20mA Bricklet

Dies ist die Beschreibung der Rust API Bindings für das Industrial Dual 0-20mA Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Dual 0-20mA 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_0_20ma_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 0-20mA Bricklet.

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

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

    // Get current current from sensor 1.
    let current = id020.get_current(1).recv()?;
    println!("Current (Sensor 1): {} mA", current as f32 / 1000000.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_0_20ma_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 0-20mA Bricklet.

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

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

    let current_receiver = id020.get_current_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `id020` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for current in current_receiver {
            println!("Sensor: {}", current.sensor);
            println!("Current: {} mA", current.current as f32 / 1000000.0);
            println!();
        }
    });

    // Set period for current (sensor 1) receiver to 1s (1000ms).
    // Note: The current (sensor 1) callback is only called every second
    //       if the current (sensor 1) has changed since the last call!
    id020.set_current_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_0_20ma_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 0-20mA Bricklet.

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

    let current_reached_receiver = id020.get_current_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `id020` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for current_reached in current_reached_receiver {
            println!("Sensor: {}", current_reached.sensor);
            println!("Current: {} mA", current_reached.current as f32 / 1000000.0);
            println!();
        }
    });

    // Configure threshold for current (sensor 1) "greater than 10 mA".
    id020.set_current_callback_threshold(1, '>', 10 * 1000000, 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.

Es können zwei Sensoren an das Bricklet angeschlossen werden. Funktionen die sich direkt auf einen der Sensoren beziehen haben einen sensor Parameter, um den Sensor anzugeben. Gültige Werte für den sensor Parameter sind 0 und 1.

Grundfunktionen

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

Erzeugt ein neues IndustrialDual020maBricklet-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 IndustrialDual020maBricklet::get_current(&self, sensor: u8) → ConvertingReceiver<i32>

Gibt die gemessenen Stromstärke des angegebenen Sensors (0 oder 1) zurück. Der Wert ist in nA und im Bereich von 0nA bis 22505322nA (22,5mA).

Es ist möglich zu erkennen ob ein IEC 60381-1-kompatibler Sensor angeschlossen ist und ob er funktionsfähig ist.

Falls die zurückgegebene Stromstärke kleiner als 4mA ist, ist wahrscheinlich kein Sensor angeschlossen oder der Sensor ist defekt. Falls die zurückgegebene Stromstärke über 20mA ist, besteht entweder ein Kurzschluss oder der Sensor ist defekt. Somit ist erkennbar ob ein Sensor angeschlossen und funktionsfähig ist.

Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen den IndustrialDual020maBricklet::get_current_callback_receiver Callback zu nutzen und die Periode mit IndustrialDual020maBricklet::set_current_callback_period vorzugeben.

Fortgeschrittene Funktionen

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

Setzt die Abtastrate auf 240, 60, 15 oder 4 Samples pro Sekunde. Die Auflösung für die Raten sind 12, 14, 16 und 18 Bit respektive.

Wert Beschreibung
0 240 Samples pro Sekunde, 12 Bit Auflösung
1 60 Samples pro Sekunde, 14 Bit Auflösung
2 15 Samples pro Sekunde, 16 Bit Auflösung
3 4 Samples pro Sekunde, 18 Bit Auflösung

Der Standardwert ist 3 (4 Samples pro Sekunde mit 18 Bit Auflösung).

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

  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_SAMPLE_RATE_240_SPS = 0
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_SAMPLE_RATE_60_SPS = 1
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_SAMPLE_RATE_15_SPS = 2
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_SAMPLE_RATE_4_SPS = 3
pub fn IndustrialDual020maBricklet::get_sample_rate(&self) → ConvertingReceiver<u8>

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

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

  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_SAMPLE_RATE_240_SPS = 0
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_SAMPLE_RATE_60_SPS = 1
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_SAMPLE_RATE_15_SPS = 2
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_SAMPLE_RATE_4_SPS = 3
pub fn IndustrialDual020maBricklet::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 IndustrialDual020maBricklet::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 IndustrialDual020maBricklet::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:

  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_FUNCTION_SET_SAMPLE_RATE = 8
pub fn IndustrialDual020maBricklet::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:

  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_FUNCTION_SET_SAMPLE_RATE = 8
pub fn IndustrialDual020maBricklet::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 IndustrialDual020maBricklet::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 IndustrialDual020maBricklet::set_current_callback_period(&self, sensor: u8, period: u32) → ConvertingReceiver<()>

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

Der IndustrialDual020maBricklet::get_current_callback_receiver Callback wird nur ausgelöst, wenn sich die Stromstärke seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

pub fn IndustrialDual020maBricklet::get_current_callback_period(&self, sensor: u8) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von IndustrialDual020maBricklet::set_current_callback_period gesetzt.

pub fn IndustrialDual020maBricklet::set_current_callback_threshold(&self, sensor: u8, option: char, min: i32, max: i32) → ConvertingReceiver<()>

Setzt den Schwellwert des IndustrialDual020maBricklet::get_current_reached_callback_receiver Callbacks für den übergebenen Sensor.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Stromstärke außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Stromstärke innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Stromstärke kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Stromstärke 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_0_20MA_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn IndustrialDual020maBricklet::get_current_callback_threshold(&self, sensor: u8) → ConvertingReceiver<CurrentCallbackThreshold>

Gibt den Schwellwert zurück, wie von IndustrialDual020maBricklet::set_current_callback_threshold gesetzt.

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

  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn IndustrialDual020maBricklet::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 IndustrialDual020maBricklet::get_debounce_period(&self) → ConvertingReceiver<u32>

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

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

Dieser Callback wird mit der Periode, wie gesetzt mit IndustrialDual020maBricklet::set_current_callback_period, ausgelöst. Der empfangene Variable ist die Stromstärke des Sensors.

Der IndustrialDual020maBricklet::get_current_callback_receiver Callback wird nur ausgelöst, wenn sich die Stromstärke seit der letzten Auslösung geändert hat.

pub fn IndustrialDual020maBricklet::get_current_reached_callback_receiver(&self) → ConvertingCallbackReceiver<CurrentReachedEvent>

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von IndustrialDual020maBricklet::set_current_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist die Stromstärke des Sensors.

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

Konstanten

IndustrialDual020maBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Dual 0-20mA Bricklet zu identifizieren.

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

IndustrialDual020maBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Industrial Dual 0-20mA Bricklet dar.