Rust - Voltage/Current Bricklet

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

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

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let vc = VoltageCurrentBricklet::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.
    let voltage = vc.get_voltage().recv()?;
    println!("Voltage: {} V", voltage as f32 / 1000.0);

    // Get current current.
    let current = vc.get_current().recv()?;
    println!("Current: {} A", current 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
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, voltage_current_bricklet::*};

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

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

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

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

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

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

    let power_reached_receiver = vc.get_power_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `vc` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for power_reached in power_reached_receiver {
            println!("Power: {} W", power_reached as f32 / 1000.0);
        }
    });

    // Configure threshold for power "greater than 10 W".
    vc.set_power_callback_threshold('>', 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.

Grundfunktionen

pub fn VoltageCurrentBricklet::new(uid: &str, ip_connection: &IpConnection) → VoltageCurrentBricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • voltage_current – Typ: VoltageCurrentBricklet

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

let voltage_current = VoltageCurrentBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn VoltageCurrentBricklet::get_current(&self) → ConvertingReceiver<i32>
Rückgabe:
  • current – Typ: i32, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Gibt die gemessenen Stromstärke zurück.

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

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

Gibt die gemessenen Spannung zurück.

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

pub fn VoltageCurrentBricklet::get_power(&self) → ConvertingReceiver<i32>
Rückgabe:
  • power – Typ: i32, Einheit: 1 mW, Wertebereich: [0 bis 720000]

Gibt die gemessenen Leistung zurück.

Wenn die Leistung periodisch abgefragt werden soll, wird empfohlen den VoltageCurrentBricklet::get_power_callback_receiver Callback zu nutzen und die Periode mit VoltageCurrentBricklet::set_power_callback_period vorzugeben.

pub fn VoltageCurrentBricklet::set_configuration(&self, averaging: u8, voltage_conversion_time: u8, current_conversion_time: u8) → ConvertingReceiver<()>
Parameter:
  • averaging – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • voltage_conversion_time – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 4
  • current_conversion_time – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 4

Setzt die Konfiguration des Voltage/Current Bricklet. Es ist möglich die Anzahl für die Durchschnittsbildung, und die Wandlungszeit für Spannung und Stromstärke zu definieren.

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

Für averaging:

  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_1 = 0
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_4 = 1
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_16 = 2
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_64 = 3
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_128 = 4
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_256 = 5
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_512 = 6
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_1024 = 7

Für voltage_conversion_time:

  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_140US = 0
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_204US = 1
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_332US = 2
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_588US = 3
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_1_1MS = 4
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_2_116MS = 5
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_4_156MS = 6
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_8_244MS = 7

Für current_conversion_time:

  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_140US = 0
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_204US = 1
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_332US = 2
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_588US = 3
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_1_1MS = 4
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_2_116MS = 5
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_4_156MS = 6
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_8_244MS = 7
pub fn VoltageCurrentBricklet::get_configuration(&self) → ConvertingReceiver<Configuration>
Rückgabeobjekt:
  • averaging – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • voltage_conversion_time – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 4
  • current_conversion_time – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 4

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

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

Für averaging:

  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_1 = 0
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_4 = 1
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_16 = 2
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_64 = 3
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_128 = 4
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_256 = 5
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_512 = 6
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_1024 = 7

Für voltage_conversion_time:

  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_140US = 0
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_204US = 1
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_332US = 2
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_588US = 3
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_1_1MS = 4
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_2_116MS = 5
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_4_156MS = 6
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_8_244MS = 7

Für current_conversion_time:

  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_140US = 0
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_204US = 1
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_332US = 2
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_588US = 3
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_1_1MS = 4
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_2_116MS = 5
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_4_156MS = 6
  • VOLTAGE_CURRENT_BRICKLET_CONVERSION_TIME_8_244MS = 7

Fortgeschrittene Funktionen

pub fn VoltageCurrentBricklet::set_calibration(&self, gain_multiplier: u16, gain_divisor: u16) → ConvertingReceiver<()>
Parameter:
  • gain_multiplier – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • gain_divisor – Typ: u16, Wertebereich: [0 bis 216 - 1]

Da der Shunt-Widerstand über den die Stromstärke gemessen wird keine perfekte Genauigkeit hat, ist es nötig einen Multiplikator und einen Divisor zu setzen, falls sehr genaue Messwerte nötig sind.

Zum Beispiel: Wenn eine Messung von 1000mA erwartet wird, das Voltage/Current Bricklet aber 1023mA zurück gibt, sollte der Multiplikator auf 1000 und der Divisor auf 1023 gesetzt werden.

pub fn VoltageCurrentBricklet::get_calibration(&self) → ConvertingReceiver<Calibration>
Rückgabeobjekt:
  • gain_multiplier – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • gain_divisor – Typ: u16, Wertebereich: [0 bis 216 - 1]

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

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

Konfigurationsfunktionen für Callbacks

pub fn VoltageCurrentBricklet::set_current_callback_period(&self, period: u32) → ConvertingReceiver<()>
Parameter:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der VoltageCurrentBricklet::get_current_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

pub fn VoltageCurrentBricklet::get_current_callback_period(&self) → ConvertingReceiver<u32>
Rückgabe:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

pub fn VoltageCurrentBricklet::set_voltage_callback_period(&self, period: u32) → ConvertingReceiver<()>
Parameter:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der VoltageCurrentBricklet::get_voltage_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

pub fn VoltageCurrentBricklet::get_voltage_callback_period(&self) → ConvertingReceiver<u32>
Rückgabe:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

pub fn VoltageCurrentBricklet::set_power_callback_period(&self, period: u32) → ConvertingReceiver<()>
Parameter:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der VoltageCurrentBricklet::get_power_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der VoltageCurrentBricklet::get_power_callback_receiver Callback wird nur ausgelöst, wenn sich die Leistung seit der letzten Auslösung geändert hat.

pub fn VoltageCurrentBricklet::get_power_callback_period(&self) → ConvertingReceiver<u32>
Rückgabe:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von VoltageCurrentBricklet::get_power_callback_period gesetzt

pub fn VoltageCurrentBricklet::set_current_callback_threshold(&self, option: char, min: i32, max: i32) → ConvertingReceiver<()>
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: i32, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: i32, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Setzt den Schwellwert für den VoltageCurrentBricklet::get_current_reached_callback_receiver Callback.

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)

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

Für option:

  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentBricklet::get_current_callback_threshold(&self) → ConvertingReceiver<CurrentCallbackThreshold>
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: i32, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: i32, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für option:

  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentBricklet::set_voltage_callback_threshold(&self, option: char, min: i32, max: i32) → ConvertingReceiver<()>
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: i32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: i32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Setzt den Schwellwert für den VoltageCurrentBricklet::get_voltage_reached_callback_receiver Callback.

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)

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

Für option:

  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentBricklet::get_voltage_callback_threshold(&self) → ConvertingReceiver<VoltageCallbackThreshold>
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: i32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: i32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für option:

  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentBricklet::set_power_callback_threshold(&self, option: char, min: i32, max: i32) → ConvertingReceiver<()>
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: i32, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: i32, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Setzt den Schwellwert für den VoltageCurrentBricklet::get_power_reached_callback_receiver Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentBricklet::get_power_callback_threshold(&self) → ConvertingReceiver<PowerCallbackThreshold>
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: i32, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: i32, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von VoltageCurrentBricklet::set_power_callback_threshold gesetzt.

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

Für option:

  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentBricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>
Parameter:
  • debounce – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

pub fn VoltageCurrentBricklet::get_debounce_period(&self) → ConvertingReceiver<u32>
Rückgabe:
  • debounce – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von VoltageCurrentBricklet::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 VoltageCurrentBricklet::get_current_callback_receiver(&self) → ConvertingCallbackReceiver<i32>
Event:
  • current – Typ: i32, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

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

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

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

pub fn VoltageCurrentBricklet::get_voltage_callback_receiver(&self) → ConvertingCallbackReceiver<i32>
Event:
  • voltage – Typ: i32, Einheit: 1 mV, Wertebereich: [0 bis 36000]

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

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

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

pub fn VoltageCurrentBricklet::get_power_callback_receiver(&self) → ConvertingCallbackReceiver<i32>
Event:
  • power – Typ: i32, Einheit: 1 mW, Wertebereich: [0 bis 720000]

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

Dieser Callback wird mit der Periode, wie gesetzt mit VoltageCurrentBricklet::set_power_callback_period, ausgelöst. Der empfangene Variable ist die Leistung des Sensors.

Der VoltageCurrentBricklet::get_power_callback_receiver Callback wird nur ausgelöst, wenn sich die Leistung seit der letzten Auslösung geändert hat.

pub fn VoltageCurrentBricklet::get_current_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i32>
Event:
  • current – Typ: i32, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von VoltageCurrentBricklet::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 VoltageCurrentBricklet::set_debounce_period gesetzt, ausgelöst.

pub fn VoltageCurrentBricklet::get_voltage_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i32>
Event:
  • voltage – Typ: i32, Einheit: 1 mV, Wertebereich: [0 bis 36000]

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

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

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

pub fn VoltageCurrentBricklet::get_power_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i32>
Event:
  • power – Typ: i32, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von VoltageCurrentBricklet::set_power_callback_threshold gesetzt, erreicht wird. Der empfangene Variable ist die Spannung des Sensors.

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

  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_CONFIGURATION = 4
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_CALIBRATION = 6
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 20
pub fn VoltageCurrentBricklet::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:

  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_CONFIGURATION = 4
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_CALIBRATION = 6
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 20
pub fn VoltageCurrentBricklet::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 VoltageCurrentBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Voltage/Current Bricklet zu identifizieren.

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

Diese Konstante stellt den Anzeigenamen eines Voltage/Current Bricklet dar.