Rust - Voltage/Current Bricklet 2.0

Dies ist die Beschreibung der Rust API Bindings für das Voltage/Current Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Voltage/Current Bricklet 2.0 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_v2_bricklet::*};

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let vc = VoltageCurrentV2Bricklet::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
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, voltage_current_v2_bricklet::*};

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let vc = VoltageCurrentV2Bricklet::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 callback to 1s (1000ms) without a threshold.
    vc.set_current_callback_configuration(1000, false, 'x', 0, 0);

    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
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, voltage_current_v2_bricklet::*};

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

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

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

    let power_receiver = vc.get_power_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 in power_receiver {
            println!("power: {} W", power as f32 / 1000.0);
        }
    });

    // Configure threshold for power "greater than 10 W"
    // with a debounce period of 1s (1000ms).
    vc.set_power_callback_configuration(1000, false, '>', 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 VoltageCurrentV2Bricklet::new(uid: &str, ip_connection: &IpConnection) → VoltageCurrentV2Bricklet

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

Gibt die gemessenen Stromstärke zurück. Der Wert ist in mA und im Bereich von -20000mA bis 20000mA.

Wenn der Wert periodisch benötigt wird, kann auch der VoltageCurrentV2Bricklet::get_current_callback_receiver Callback verwendet werden. Der Callback wird mit der Funktion VoltageCurrentV2Bricklet::set_current_callback_configuration konfiguriert.

pub fn VoltageCurrentV2Bricklet::get_voltage(&self) → ConvertingReceiver<i32>

Gibt die gemessenen Spannung zurück. Der Wert ist in mV und im Bereich von 0mV bis 36000mV.

Wenn der Wert periodisch benötigt wird, kann auch der VoltageCurrentV2Bricklet::get_voltage_callback_receiver Callback verwendet werden. Der Callback wird mit der Funktion VoltageCurrentV2Bricklet::set_voltage_callback_configuration konfiguriert.

pub fn VoltageCurrentV2Bricklet::get_power(&self) → ConvertingReceiver<i32>

Gibt die gemessenen Leistung zurück. Der Wert ist in mW und im Bereich von 0mW bis 720000mW.

Wenn der Wert periodisch benötigt wird, kann auch der VoltageCurrentV2Bricklet::get_power_callback_receiver Callback verwendet werden. Der Callback wird mit der Funktion VoltageCurrentV2Bricklet::set_power_callback_configuration konfiguriert.

pub fn VoltageCurrentV2Bricklet::set_configuration(&self, averaging: u8, voltage_conversion_time: u8, current_conversion_time: u8) → ConvertingReceiver<()>

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

Durchschnittsbildung:

Wert Anzahl
0 1
1 4
2 16
3 64
4 128
5 256
6 512
>=7 1024

Wandlungszeit für Spannung/Stromstärke:

Wert Wandlungszeit
0 140µs
1 204µs
2 332µs
3 588µs
4 1.1ms
5 2.116ms
6 4.156ms
>=7 8.244ms

Die Standardwerte sind 3, 4 und 4 (64, 1.1ms, 1.1ms) für die Durchschnittsbildung und die Spannungs/Stromstärkenwandlungszeit.

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

  • VOLTAGE_CURRENT_V2_BRICKLET_AVERAGING_1 = 0
  • VOLTAGE_CURRENT_V2_BRICKLET_AVERAGING_4 = 1
  • VOLTAGE_CURRENT_V2_BRICKLET_AVERAGING_16 = 2
  • VOLTAGE_CURRENT_V2_BRICKLET_AVERAGING_64 = 3
  • VOLTAGE_CURRENT_V2_BRICKLET_AVERAGING_128 = 4
  • VOLTAGE_CURRENT_V2_BRICKLET_AVERAGING_256 = 5
  • VOLTAGE_CURRENT_V2_BRICKLET_AVERAGING_512 = 6
  • VOLTAGE_CURRENT_V2_BRICKLET_AVERAGING_1024 = 7
  • VOLTAGE_CURRENT_V2_BRICKLET_CONVERSION_TIME_140US = 0
  • VOLTAGE_CURRENT_V2_BRICKLET_CONVERSION_TIME_204US = 1
  • VOLTAGE_CURRENT_V2_BRICKLET_CONVERSION_TIME_332US = 2
  • VOLTAGE_CURRENT_V2_BRICKLET_CONVERSION_TIME_588US = 3
  • VOLTAGE_CURRENT_V2_BRICKLET_CONVERSION_TIME_1_1MS = 4
  • VOLTAGE_CURRENT_V2_BRICKLET_CONVERSION_TIME_2_116MS = 5
  • VOLTAGE_CURRENT_V2_BRICKLET_CONVERSION_TIME_4_156MS = 6
  • VOLTAGE_CURRENT_V2_BRICKLET_CONVERSION_TIME_8_244MS = 7
pub fn VoltageCurrentV2Bricklet::get_configuration(&self) → ConvertingReceiver<Configuration>

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

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

  • VOLTAGE_CURRENT_V2_BRICKLET_AVERAGING_1 = 0
  • VOLTAGE_CURRENT_V2_BRICKLET_AVERAGING_4 = 1
  • VOLTAGE_CURRENT_V2_BRICKLET_AVERAGING_16 = 2
  • VOLTAGE_CURRENT_V2_BRICKLET_AVERAGING_64 = 3
  • VOLTAGE_CURRENT_V2_BRICKLET_AVERAGING_128 = 4
  • VOLTAGE_CURRENT_V2_BRICKLET_AVERAGING_256 = 5
  • VOLTAGE_CURRENT_V2_BRICKLET_AVERAGING_512 = 6
  • VOLTAGE_CURRENT_V2_BRICKLET_AVERAGING_1024 = 7

Fortgeschrittene Funktionen

pub fn VoltageCurrentV2Bricklet::set_calibration(&self, voltage_multiplier: u16, voltage_divisor: u16, current_multiplier: u16, current_divisor: u16) → ConvertingReceiver<()>

Da der ADC und der Shunt-Widerstand für die Messungen verwendet werden nicht perfekt sind, 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 2.0 aber 1023mA zurück gibt, sollte der Multiplikator auf 1000 und der Divisor auf 1023 gesetzt werden. Das gleiches gilt für die Spannung.

Die Kalibrierung wird in den EEPROM des Voltage/Current Bricklet gespeichert und muss nur einmal gesetzt werden.

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

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

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

  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 6
  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_SET_POWER_CALLBACK_CONFIGURATION = 10
  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 13
  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_SET_CALIBRATION = 15
  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_RESET = 243
  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn VoltageCurrentV2Bricklet::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:

  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 6
  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_SET_POWER_CALLBACK_CONFIGURATION = 10
  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 13
  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_SET_CALIBRATION = 15
  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_RESET = 243
  • VOLTAGE_CURRENT_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn VoltageCurrentV2Bricklet::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 VoltageCurrentV2Bricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

pub fn VoltageCurrentV2Bricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

  • VOLTAGE_CURRENT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • VOLTAGE_CURRENT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • VOLTAGE_CURRENT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • VOLTAGE_CURRENT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • VOLTAGE_CURRENT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • VOLTAGE_CURRENT_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • VOLTAGE_CURRENT_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • VOLTAGE_CURRENT_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • VOLTAGE_CURRENT_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • VOLTAGE_CURRENT_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • VOLTAGE_CURRENT_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn VoltageCurrentV2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>

Gibt den aktuellen Bootloader-Modus zurück, siehe VoltageCurrentV2Bricklet::set_bootloader_mode.

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

  • VOLTAGE_CURRENT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • VOLTAGE_CURRENT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • VOLTAGE_CURRENT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • VOLTAGE_CURRENT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • VOLTAGE_CURRENT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn VoltageCurrentV2Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>

Setzt den Firmware-Pointer für VoltageCurrentV2Bricklet::write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

pub fn VoltageCurrentV2Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>

Schreibt 64 Bytes Firmware an die Position die vorher von VoltageCurrentV2Bricklet::set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

pub fn VoltageCurrentV2Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

  • VOLTAGE_CURRENT_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • VOLTAGE_CURRENT_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • VOLTAGE_CURRENT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • VOLTAGE_CURRENT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn VoltageCurrentV2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>

Gibt die Konfiguration zurück, wie von VoltageCurrentV2Bricklet::set_status_led_config gesetzt.

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

  • VOLTAGE_CURRENT_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • VOLTAGE_CURRENT_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • VOLTAGE_CURRENT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • VOLTAGE_CURRENT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn VoltageCurrentV2Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

pub fn VoltageCurrentV2Bricklet::reset(&self) → ConvertingReceiver<()>

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

pub fn VoltageCurrentV2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

pub fn VoltageCurrentV2Bricklet::read_uid(&self) → ConvertingReceiver<u32>

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

pub fn VoltageCurrentV2Bricklet::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 VoltageCurrentV2Bricklet::set_current_callback_configuration(&self, period: u32, value_has_to_change: bool, option: char, min: i32, max: i32) → ConvertingReceiver<()>

Die Periode in ms ist die Periode mit der der VoltageCurrentV2Bricklet::get_current_callback_receiver Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den VoltageCurrentV2Bricklet::get_current_callback_receiver Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentV2Bricklet::get_current_callback_configuration(&self) → ConvertingReceiver<CurrentCallbackConfiguration>

Gibt die Callback-Konfiguration zurück, wie mittels VoltageCurrentV2Bricklet::set_current_callback_configuration gesetzt.

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

  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentV2Bricklet::set_voltage_callback_configuration(&self, period: u32, value_has_to_change: bool, option: char, min: i32, max: i32) → ConvertingReceiver<()>

Die Periode in ms ist die Periode mit der der VoltageCurrentV2Bricklet::get_voltage_callback_receiver Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den VoltageCurrentV2Bricklet::get_voltage_callback_receiver Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentV2Bricklet::get_voltage_callback_configuration(&self) → ConvertingReceiver<VoltageCallbackConfiguration>

Gibt die Callback-Konfiguration zurück, wie mittels VoltageCurrentV2Bricklet::set_voltage_callback_configuration gesetzt.

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

  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentV2Bricklet::set_power_callback_configuration(&self, period: u32, value_has_to_change: bool, option: char, min: i32, max: i32) → ConvertingReceiver<()>

Die Periode in ms ist die Periode mit der der VoltageCurrentV2Bricklet::get_power_callback_receiver Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den VoltageCurrentV2Bricklet::get_power_callback_receiver Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentV2Bricklet::get_power_callback_configuration(&self) → ConvertingReceiver<PowerCallbackConfiguration>

Gibt die Callback-Konfiguration zurück, wie mittels VoltageCurrentV2Bricklet::set_power_callback_configuration gesetzt.

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

  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

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 VoltageCurrentV2Bricklet::get_current_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels VoltageCurrentV2Bricklet::set_current_callback_configuration gesetzten Konfiguration

Der empfangene Variable ist der gleiche wie VoltageCurrentV2Bricklet::get_current.

pub fn VoltageCurrentV2Bricklet::get_voltage_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels VoltageCurrentV2Bricklet::set_voltage_callback_configuration gesetzten Konfiguration

Der empfangene Variable ist der gleiche wie VoltageCurrentV2Bricklet::get_voltage.

pub fn VoltageCurrentV2Bricklet::get_power_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels VoltageCurrentV2Bricklet::set_power_callback_configuration gesetzten Konfiguration

Der empfangene Variable ist der gleiche wie VoltageCurrentV2Bricklet::get_power.

Konstanten

VoltageCurrentV2Bricklet::DEVICE_IDENTIFIER

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

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

VoltageCurrentV2Bricklet::DEVICE_DISPLAY_NAME

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