Rust - Dual Relay Bricklet¶

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

use std::{error::Error, io, thread, time::Duration};
use tinkerforge::{dual_relay_bricklet::*, ip_connection::IpConnection};

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

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

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

    // Turn relays alternating on/off 10 times with 1 second delay
    for _i in 0..5 {
        thread::sleep(Duration::from_millis(1000));
        dr.set_state(true, false).recv()?;
        thread::sleep(Duration::from_millis(1000));
        dr.set_state(false, true).recv()?;
    }

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Grundfunktionen¶

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

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	dual_relay – Typ: DualRelayBricklet

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

let dual_relay = DualRelayBricklet::new("YOUR_DEVICE_UID", &ip_connection);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden.

pub fn DualRelayBricklet::set_state(&self, relay1: bool, relay2: bool) → ConvertingReceiver<()>¶

Parameter:	relay1 – Typ: bool, Standardwert: false relay2 – Typ: bool, Standardwert: false

Setzt den Zustand der Relais, true bedeutet ein und false aus. Beispiel: (true, false) schaltet Relais 1 ein und Relais 2 aus.

Wenn nur eines der Relais gesetzt werden soll und der aktuelle Zustand des anderen Relais nicht bekannt ist, dann kann der Zustand mit DualRelayBricklet::get_state ausgelesen werden oder es kann DualRelayBricklet::set_selected_state genutzt werden.

Alle laufenden Monoflop Timer werden abgebrochen, wenn diese Funktion aufgerufen wird.

pub fn DualRelayBricklet::get_state(&self) → ConvertingReceiver<State>¶

Rückgabeobjekt:	relay1 – Typ: bool, Standardwert: false relay2 – Typ: bool, Standardwert: false

Gibt den Zustand der Relais zurück, true bedeutet ein und false aus.

Fortgeschrittene Funktionen¶

pub fn DualRelayBricklet::set_monoflop(&self, relay: u8, state: bool, time: u32) → ConvertingReceiver<()>¶

Parameter:	relay – Typ: u8, Wertebereich: [1 bis 2] state – Typ: bool time – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Der erste Parameter kann 1 oder 2 sein (Relais 1 oder Relais 2). Der zweite Parameter ist der gewünschte Zustand des Relais (true bedeutet ein und false aus). Der dritte Parameter stellt die Zeit dar, welche das Relais den Zustand halten soll.

Wenn diese Funktion mit den Parametern (1, true, 1500) aufgerufen wird: Relais 1 wird angeschaltet und nach 1,5s wieder ausgeschaltet.

Ein Monoflop kann als Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein Dual Relay Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Das Relais wird die gesamte Zeit ein sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird das Relais nach spätestens zwei Sekunden ausschalten.

pub fn DualRelayBricklet::get_monoflop(&self, relay: u8) → ConvertingReceiver<Monoflop>¶

Parameter:	relay – Typ: u8, Wertebereich: [1 bis 2]
Rückgabeobjekt:	state – Typ: bool time – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] time_remaining – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Gibt (für das angegebene Relais) den aktuellen Zustand und die Zeit, wie von DualRelayBricklet::set_monoflop gesetzt, sowie die noch verbleibende Zeit bis zum Zustandswechsel, zurück.

Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.

pub fn DualRelayBricklet::set_selected_state(&self, relay: u8, state: bool) → ConvertingReceiver<()>¶

Parameter:	relay – Typ: u8, Wertebereich: [1 bis 2] state – Typ: bool

Setzt den Zustand des ausgewählte Relais (1 oder 2), true bedeutet ein und false aus.

Ein laufender Monoflop Timer für das ausgewählte Relais wird abgebrochen, wenn diese Funktion aufgerufen wird.

Das andere Relais bleibt unangetastet.

pub fn DualRelayBricklet::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', '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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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.

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.

pub fn DualRelayBricklet::get_monoflop_done_callback_receiver(&self) → ConvertingCallbackReceiver<MonoflopDoneEvent>¶

Event-Objekt:	relay – Typ: u8, Wertebereich: [1 bis 2] state – Typ: bool

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

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Die Parameter enthalten das auslösende Relais (1 oder 2) und den aktuellen Zustand des Relais (der Zustand nach dem Monoflop).

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

• DUAL_RELAY_BRICKLET_FUNCTION_SET_STATE = 1
• DUAL_RELAY_BRICKLET_FUNCTION_SET_MONOFLOP = 3
• DUAL_RELAY_BRICKLET_FUNCTION_SET_SELECTED_STATE = 6

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

• DUAL_RELAY_BRICKLET_FUNCTION_SET_STATE = 1
• DUAL_RELAY_BRICKLET_FUNCTION_SET_MONOFLOP = 3
• DUAL_RELAY_BRICKLET_FUNCTION_SET_SELECTED_STATE = 6

pub fn DualRelayBricklet::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 DualRelayBricklet::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Dual Relay Bricklet zu identifizieren.

Die DualRelayBricklet::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 DualRelayBricklet::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Dual Relay Bricklet dar.