Rust - Energy Monitor Bricklet

Dies ist die Beschreibung der Rust API Bindings für das Energy Monitor Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Energy Monitor 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
30
31
32
33
use std::{error::Error, io};

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

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

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

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

    // Get current Energy Data.
    let energy_data = em.get_energy_data().recv()?;

    println!("Voltage: {} V", energy_data.voltage as f32 / 100.0);
    println!("Current: {} A", energy_data.current as f32 / 100.0);
    println!("Energy: {} Wh", energy_data.energy as f32 / 100.0);
    println!("Real Power: {} h", energy_data.real_power as f32 / 100.0);
    println!("Apparent Power: {} VA", energy_data.apparent_power as f32 / 100.0);
    println!("Reactive Power: {} VAR", energy_data.reactive_power as f32 / 100.0);
    println!("Power Factor: {}", energy_data.power_factor as f32 / 1000.0);
    println!("Frequency: {} Hz", energy_data.frequency as f32 / 100.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
39
40
41
42
use std::{error::Error, io, thread};
use tinkerforge::{energy_monitor_bricklet::*, ip_connection::IpConnection};

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

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

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

    let energy_data_receiver = em.get_energy_data_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `em` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for energy_data in energy_data_receiver {
            println!("Voltage: {} V", energy_data.voltage as f32 / 100.0);
            println!("Current: {} A", energy_data.current as f32 / 100.0);
            println!("Energy: {} Wh", energy_data.energy as f32 / 100.0);
            println!("Real Power: {} h", energy_data.real_power as f32 / 100.0);
            println!("Apparent Power: {} VA", energy_data.apparent_power as f32 / 100.0);
            println!("Reactive Power: {} VAR", energy_data.reactive_power as f32 / 100.0);
            println!("Power Factor: {}", energy_data.power_factor as f32 / 1000.0);
            println!("Frequency: {} Hz", energy_data.frequency as f32 / 100.0);
            println!();
        }
    });

    // Set period for Energy Data callback to 1s (1000ms).
    em.set_energy_data_callback_configuration(1000, false);

    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 EnergyMonitorBricklet::new(uid: &str, ip_connection: &IpConnection) → EnergyMonitorBricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • energy_monitor – Typ: EnergyMonitorBricklet

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

let energy_monitor = EnergyMonitorBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn EnergyMonitorBricklet::get_energy_data(&self) → ConvertingReceiver<EnergyData>
Rückgabeobjekt:
  • voltage – Typ: i32, Einheit: 1/100 V, Wertebereich: [-231 bis 231 - 1]
  • current – Typ: i32, Einheit: 1/100 A, Wertebereich: [-231 bis 231 - 1]
  • energy – Typ: i32, Einheit: 1/100 Wh, Wertebereich: [-231 bis 231 - 1]
  • real_power – Typ: i32, Einheit: 1/100 W, Wertebereich: [-231 bis 231 - 1]
  • apparent_power – Typ: i32, Einheit: 1/100 VA, Wertebereich: [-231 bis 231 - 1]
  • reactive_power – Typ: i32, Einheit: 1/100 var, Wertebereich: [-231 bis 231 - 1]
  • power_factor – Typ: u16, Einheit: 1/1000, Wertebereich: [0 bis 216 - 1]
  • frequency – Typ: u16, Einheit: 1/100 Hz, Wertebereich: [0 bis 216 - 1]

Gibt alle Messdaten des Energy Monitor Bricklets zurück.

  • Voltage: RMS-Spannung (Effektivwert)
  • Current: RMS-Strom (Effektivwert)
  • Energy: Energie (integriert über Zeit)
  • Real Power: Wirkleistung
  • Apparent Power: Scheinleistung
  • Reactive Power: Blindleistung
  • Power Factor: Leistungsfaktor
  • Frequency: AC-Frequenz der Netzspannung

Die Frequenz wird alle 6 Sekunden neu berechnet.

Alle anderen Werte werden über 10 Nulldurchgänge der Spannungs-Sinuskurve integriert. Mit einer Standard Netzspannungsfrequenz von 50Hz entspricht das 5 Messungen pro Sekunde (oder einer Integrationszeit von 200ms pro Messung).

Wenn kein Spannungstransformator angeschlossen ist, nutzt das Bricklet den Kurvenverlauf des Stroms, um die Frequenz zu bestimmen und die Integrationszeit beträgt 10 Nulldurchläufe der Strom-Sinuskurve.

pub fn EnergyMonitorBricklet::reset_energy(&self) → ConvertingReceiver<()>

Setzt den Energiewert (siehe EnergyMonitorBricklet::get_energy_data) zurück auf 0Wh

pub fn EnergyMonitorBricklet::get_waveform(&self) → Result<Vec<i16>, BrickletRecvTimeoutError>
Rückgabe:
  • waveform – Typ: [i16; 1536], Wertebereich: [-215 bis 215 - 1]

Gibt eine Momentaufnahme des Spannungs- und Stromkurvenverlaufs zurück. Die Werte im zurückgegebenen Array alternieren zwischen Spannung und Strom. Die Daten eines Getter-Aufrufs beinhalten 768 Datenpunkte für Spannung und Strom, diese korrespondieren zu ungefähr 3 vollen Sinuskurven.

Die Spannung hat eine Auflösung von 100mV und der Strom hat eine Auflösung von 10mA.

Die Daten können für eine grafische Repräsentation (nicht-Realzeit) der Kurvenverläufe genutzt werden.

pub fn EnergyMonitorBricklet::get_transformer_status(&self) → ConvertingReceiver<TransformerStatus>
Rückgabeobjekt:
  • voltage_transformer_connected – Typ: bool
  • current_transformer_connected – Typ: bool

Gibt true zurück wenn ein Spannungs-/Stromtransformator mit dem Bricklet verbunden ist.

pub fn EnergyMonitorBricklet::set_transformer_calibration(&self, voltage_ratio: u16, current_ratio: u16, phase_shift: i16) → ConvertingReceiver<()>
Parameter:
  • voltage_ratio – Typ: u16, Wertebereich: [0 bis 216 - 1], Standardwert: 1923
  • current_ratio – Typ: u16, Wertebereich: [0 bis 216 - 1], Standardwert: 3000
  • phase_shift – Typ: i16, Wertebereich: [0], Standardwert: 0

Setzt das Transformer-Verhältnis für Strom und Spannung in Hundertstel.

Beispiel: Wenn die Netzspannung 230V beträgt und ein 9V Spannungstransformer sowie eine 1V:30A Spannungszange verwendet wird, ergibt das ein Spannungsverhältnis von 230/9 = 25,56 und ein Stromverhältnis von 30/1 = 30.

In diesem Fall müssten also die Werte 2556 und 3000 gesetzt werden.

Die Kalibrierung wird in nicht-flüchtigem Speicher gespeichert und muss nur einmal gesetzt werden.

Der Parameter Phase Shift muss auf 0 gesetzt werden. Dieser Parameter wird aktuell von der Firmware nicht genutzt.

pub fn EnergyMonitorBricklet::get_transformer_calibration(&self) → ConvertingReceiver<TransformerCalibration>
Rückgabeobjekt:
  • voltage_ratio – Typ: u16, Wertebereich: [0 bis 216 - 1], Standardwert: 1923
  • current_ratio – Typ: u16, Wertebereich: [0 bis 216 - 1], Standardwert: 3000
  • phase_shift – Typ: i16, Wertebereich: [0], Standardwert: 0

Gibt die Transformator-Kalibrierung zurück, wie von EnergyMonitorBricklet::set_transformer_calibration gesetzt.

pub fn EnergyMonitorBricklet::calibrate_offset(&self) → ConvertingReceiver<()>

Ein Aufruf dieser Funktion startet eine Offset-Kalibrierung. Dazu werden die Spannungs- und Stromkurvenverläufe über einen längeren Zeitraum aufsummiert, um den Nulldurchgangspunkt der Sinuskurve zu finden.

Der Offset für das Bricklet wird von Tinkerforge ab Werk kalibriert. Ein Aufruf dieser Funktion sollte also nicht notwendig sein.

Wenn der Offset rekalibriert werden soll, empfehlen wir entweder eine Last anzuschließen, die eine glatte Sinuskurve für Spannung und Strom erzeugt, oder die beiden Eingänge kurzzuschließen.

Die Kalibrierung wird in nicht-flüchtigem Speicher gespeichert und muss nur einmal gesetzt werden.

Fortgeschrittene Funktionen

pub fn EnergyMonitorBricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>
Rückgabeobjekt:
  • error_count_ack_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: u32, Wertebereich: [0 bis 232 - 1]

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 EnergyMonitorBricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>
Parameter:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: u8, Wertebereich: Siehe Konstanten

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

Für mode:

  • ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn EnergyMonitorBricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>
Rückgabe:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten

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

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

Für mode:

  • ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn EnergyMonitorBricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>
Parameter:
  • pointer – Typ: u32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für EnergyMonitorBricklet::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 EnergyMonitorBricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>
Parameter:
  • data – Typ: [u8; 64], Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: u8, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von EnergyMonitorBricklet::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 EnergyMonitorBricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>
Parameter:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

Für config:

  • ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn EnergyMonitorBricklet::get_status_led_config(&self) → ConvertingReceiver<u8>
Rückgabe:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

  • ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn EnergyMonitorBricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>
Rückgabe:
  • temperature – Typ: i16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, 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 EnergyMonitorBricklet::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 EnergyMonitorBricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>
Parameter:
  • uid – Typ: u32, Wertebereich: [0 bis 232 - 1]

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 EnergyMonitorBricklet::read_uid(&self) → ConvertingReceiver<u32>
Rückgabe:
  • uid – Typ: u32, Wertebereich: [0 bis 232 - 1]

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 EnergyMonitorBricklet::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 EnergyMonitorBricklet::set_energy_data_callback_configuration(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>
Parameter:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der EnergyMonitorBricklet::get_energy_data_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.

pub fn EnergyMonitorBricklet::get_energy_data_callback_configuration(&self) → ConvertingReceiver<EnergyDataCallbackConfiguration>
Rückgabeobjekt:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels EnergyMonitorBricklet::set_energy_data_callback_configuration 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 EnergyMonitorBricklet::get_energy_data_callback_receiver(&self) → ConvertingCallbackReceiver<EnergyDataEvent>
Event-Objekt:
  • voltage – Typ: i32, Einheit: 1/100 V, Wertebereich: [-231 bis 231 - 1]
  • current – Typ: i32, Einheit: 1/100 A, Wertebereich: [-231 bis 231 - 1]
  • energy – Typ: i32, Einheit: 1/100 Wh, Wertebereich: [-231 bis 231 - 1]
  • real_power – Typ: i32, Einheit: 1/100 W, Wertebereich: [-231 bis 231 - 1]
  • apparent_power – Typ: i32, Einheit: 1/100 VA, Wertebereich: [-231 bis 231 - 1]
  • reactive_power – Typ: i32, Einheit: 1/100 var, Wertebereich: [-231 bis 231 - 1]
  • power_factor – Typ: u16, Einheit: 1/1000, Wertebereich: [0 bis 216 - 1]
  • frequency – Typ: u16, Einheit: 1/100 Hz, Wertebereich: [0 bis 216 - 1]

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

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

Die Felder der empfangenen Struktur sind der gleiche wie EnergyMonitorBricklet::get_energy_data.

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

  • ENERGY_MONITOR_BRICKLET_FUNCTION_RESET_ENERGY = 2
  • ENERGY_MONITOR_BRICKLET_FUNCTION_SET_TRANSFORMER_CALIBRATION = 5
  • ENERGY_MONITOR_BRICKLET_FUNCTION_CALIBRATE_OFFSET = 7
  • ENERGY_MONITOR_BRICKLET_FUNCTION_SET_ENERGY_DATA_CALLBACK_CONFIGURATION = 8
  • ENERGY_MONITOR_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • ENERGY_MONITOR_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • ENERGY_MONITOR_BRICKLET_FUNCTION_RESET = 243
  • ENERGY_MONITOR_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn EnergyMonitorBricklet::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:

  • ENERGY_MONITOR_BRICKLET_FUNCTION_RESET_ENERGY = 2
  • ENERGY_MONITOR_BRICKLET_FUNCTION_SET_TRANSFORMER_CALIBRATION = 5
  • ENERGY_MONITOR_BRICKLET_FUNCTION_CALIBRATE_OFFSET = 7
  • ENERGY_MONITOR_BRICKLET_FUNCTION_SET_ENERGY_DATA_CALLBACK_CONFIGURATION = 8
  • ENERGY_MONITOR_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • ENERGY_MONITOR_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • ENERGY_MONITOR_BRICKLET_FUNCTION_RESET = 243
  • ENERGY_MONITOR_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn EnergyMonitorBricklet::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 EnergyMonitorBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Energy Monitor Bricklet zu identifizieren.

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

Diese Konstante stellt den Anzeigenamen eines Energy Monitor Bricklet dar.