Rust - Industrial Quad 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
29
30
31
32

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

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let iqr = IndustrialQuadRelayBricklet::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 100 ms delay
    for _i in 0..10 {
        thread::sleep(Duration::from_millis(100));
        iqr.set_value(1 << 0).recv()?;
        thread::sleep(Duration::from_millis(100));
        iqr.set_value(1 << 1).recv()?;
        thread::sleep(Duration::from_millis(100));
        iqr.set_value(1 << 2).recv()?;
        thread::sleep(Duration::from_millis(100));
        iqr.set_value(1 << 3).recv()?;
    }

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

Grundfunktionen¶

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

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	industrial_quad_relay – Typ: IndustrialQuadRelayBricklet

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

let industrial_quad_relay = IndustrialQuadRelayBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn IndustrialQuadRelayBricklet::set_value(&self, value_mask: u16) → ConvertingReceiver<()>¶

Parameter:	value_mask – Typ: u16, Wertebereich: [0 bis 216 - 1]

Setzt die Ausgabewerte mit einer Bitmaske (16Bit). Eine 1 in der Bitmaske bedeutet Relais geschlossen und eine 0 in der Bitmaske bedeutet Relais offen.

Zum Beispiel: Der Wert 3 bzw. 0b0011 wird die Relais 0-1 schließen und alle anderen öffnen.

Falls keine Gruppen verwendet werden (siehe IndustrialQuadRelayBricklet::set_group), entsprechen die Pins der Beschriftung auf dem Industrial Quad Relay Bricklet.

Falls Gruppen verwendet werden, entsprechen die Pins den Elementen der Gruppe. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

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

pub fn IndustrialQuadRelayBricklet::get_value(&self) → ConvertingReceiver<u16>¶

Rückgabe:	value_mask – Typ: u16, Wertebereich: [0 bis 216 - 1]

Gibt die Bitmaske zurück, wie von IndustrialQuadRelayBricklet::set_value gesetzt.

Fortgeschrittene Funktionen¶

pub fn IndustrialQuadRelayBricklet::set_monoflop(&self, selection_mask: u16, value_mask: u16, time: u32) → ConvertingReceiver<()>¶

Parameter:	selection_mask – Typ: u16, Wertebereich: [0 bis 216 - 1] value_mask – Typ: u16, Wertebereich: [0 bis 216 - 1] time – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Konfiguriert einen Monoflop für die Pins, wie mittels der Bitmaske des ersten Parameters festgelegt.

Der zweite Parameter ist eine Bitmaske mit den gewünschten Zuständen der festgelegten Pins. Eine 1 in der Bitmaske bedeutet Relais geschlossen und eine 0 in der Bitmaske bedeutet Relais offen.

Der dritte Parameter stellt die Zeit dar, welche die Pins den Zustand halten sollen.

Wenn diese Funktion mit den Parametern (9, 1, 1500) bzw. (0b1001, 0b0001, 1500) aufgerufen wird: Pin 0 wird auf geschlossen und Pin 3 auf geöffnet gesetzt. Nach 1,5s wird Pin 0 wieder geöffnet und Pin 3 geschlossen.

Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein Quad Relay Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Pin wird die gesamte Zeit im Zustand geschlossen sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Pin nach spätestens zwei Sekunden in den Zustand geöffnet wechseln.

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

Parameter:	pin – Typ: u8, Wertebereich: [0 bis 15]
Rückgabeobjekt:	value – Typ: u16, Wertebereich: [0 bis 1] 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 den angegebenen Pin) den aktuellen Zustand und die Zeit, wie von IndustrialQuadRelayBricklet::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 IndustrialQuadRelayBricklet::set_group(&self, group: [char; 4]) → ConvertingReceiver<()>¶

Parameter:	group – Typ: [char; 4], Wertebereich: ['a' bis 'd', 'n']

Setzt eine Gruppe von Quad Relay Bricklets die zusammenarbeiten sollen. Mögliche Gruppierungen können mit der Funktion IndustrialQuadRelayBricklet::get_available_for_group gefunden werden.

Eine Gruppe besteht aus 4 Element. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

Jedes Element kann entweder auf einen der Ports ('a' bis 'd') gesetzt werden oder falls nicht genutzt 'n' gesetzt werden.

Zum Beispiel: Falls zwei Quad Relay Bricklets mit Port A und Port B verbunden sind, könnte diese Funktion mit ['a', 'b', 'n', 'n'] aufgerufen werden.

In diesem Fall wären die Pins von Port A den Werten 0-3 zugewiesen und die Pins von Port B den Werten 4-7. Es ist jetzt möglich mit der Funktion IndustrialQuadRelayBricklet::set_value beide Bricklets gleichzeitig zu kontrollieren.

pub fn IndustrialQuadRelayBricklet::get_group(&self) → ConvertingReceiver<[char; 4]>¶

Rückgabe:	group – Typ: [char; 4], Wertebereich: ['a' bis 'd', 'n']

Gibt die Gruppierung zurück, wie von IndustrialQuadRelayBricklet::set_group gesetzt.

pub fn IndustrialQuadRelayBricklet::get_available_for_group(&self) → ConvertingReceiver<u8>¶

Rückgabe:	available – Typ: u8, Wertebereich: [0 bis 15]

Gibt eine Bitmaske von Ports zurück die für die Gruppierung zur Verfügung stehen. Zum Beispiel bedeutet der Wert 5 bzw. 0b0101: Port A und Port C sind mit Bricklets verbunden die zusammen gruppiert werden können.

pub fn IndustrialQuadRelayBricklet::set_selected_values(&self, selection_mask: u16, value_mask: u16) → ConvertingReceiver<()>¶

Parameter:	selection_mask – Typ: u16, Wertebereich: [0 bis 216 - 1] value_mask – Typ: u16, Wertebereich: [0 bis 216 - 1]

Setzt die Ausgabewerte mit einer Bitmaske, entsprechend der Selektionsmaske. Die Bitmaske ist 16 Bit lang. true steht für ein geschlossenes Relais und false für ein offenes Relay.

Zum Beispiel: Die Werte (3, 1) bzw. (0b0011, 0b0001) wird das Relais 0 schließen, das Relais 1 öffnen und alle anderen unangetastet lassen.

Falls keine Gruppen verwendet werden (siehe IndustrialQuadRelayBricklet::set_group), entsprechen die Pins der Beschriftung auf dem Industrial Quad Relay Bricklet.

Falls Gruppen verwendet werden, entsprechen die Pins den Elementen der Gruppe. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

Laufende Monoflop Timer für die ausgewählten Relais werden abgebrochen, wenn diese Funktion aufgerufen wird.

pub fn IndustrialQuadRelayBricklet::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 IndustrialQuadRelayBricklet::get_monoflop_done_callback_receiver(&self) → ConvertingCallbackReceiver<MonoflopDoneEvent>¶

Event-Objekt:	selection_mask – Typ: u16, Wertebereich: [0 bis 216 - 1] value_mask – Typ: u16, Wertebereich: [0 bis 216 - 1]

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

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Felder der empfangenen Struktur enthalten die beteiligten Pins als Bitmaske und den aktuellen Zustand als Bitmaske (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 IndustrialQuadRelayBricklet::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 IndustrialQuadRelayBricklet::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 IndustrialQuadRelayBricklet::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:

• INDUSTRIAL_QUAD_RELAY_BRICKLET_FUNCTION_SET_VALUE = 1
• INDUSTRIAL_QUAD_RELAY_BRICKLET_FUNCTION_SET_MONOFLOP = 3
• INDUSTRIAL_QUAD_RELAY_BRICKLET_FUNCTION_SET_GROUP = 5
• INDUSTRIAL_QUAD_RELAY_BRICKLET_FUNCTION_SET_SELECTED_VALUES = 9

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

• INDUSTRIAL_QUAD_RELAY_BRICKLET_FUNCTION_SET_VALUE = 1
• INDUSTRIAL_QUAD_RELAY_BRICKLET_FUNCTION_SET_MONOFLOP = 3
• INDUSTRIAL_QUAD_RELAY_BRICKLET_FUNCTION_SET_GROUP = 5
• INDUSTRIAL_QUAD_RELAY_BRICKLET_FUNCTION_SET_SELECTED_VALUES = 9

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

Diese Konstante wird verwendet um ein Industrial Quad Relay Bricklet zu identifizieren.

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

Diese Konstante stellt den Anzeigenamen eines Industrial Quad Relay Bricklet dar.