Rust - Industrial Digital In 4 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

use std::{error::Error, io};

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

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

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

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

    // Get current value as bitmask.
    let value_mask = idi4.get_value().recv()?;
    println!("Value Mask: {:b}", value_mask);

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

Interrupt¶

Download (example_interrupt.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::{industrial_digital_in_4_bricklet::*, ip_connection::IpConnection};

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

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

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

    let interrupt_receiver = idi4.get_interrupt_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `idi4` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for interrupt in interrupt_receiver {
            println!("Interrupt Mask: {:b}", interrupt.interrupt_mask);
            println!("Value Mask: {:b}", interrupt.value_mask);
            println!();
        }
    });

    // Enable interrupt on pin 0
    idi4.set_interrupt(1 << 0).recv()?;

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

Grundfunktionen¶

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

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	industrial_digital_in_4 – Typ: IndustrialDigitalIn4Bricklet

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

let industrial_digital_in_4 = IndustrialDigitalIn4Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

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

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

Gibt die Ausgabewerte mit einer Bitmaske zurück. Die Bitmaske ist 16Bit lang. true bedeutet logisch 1 und false logisch 0.

Zum Beispiel: Der Wert 3 bzw. 0b0011 bedeutet, dass die Pins 0-1 auf logisch 1 und alle anderen auf logisch 0 sind.

Falls keine Gruppen verwendet werden (siehe IndustrialDigitalIn4Bricklet::set_group), entsprechen die Pins der Beschriftung auf dem Industrial Digital In 4 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.

pub fn IndustrialDigitalIn4Bricklet::get_edge_count(&self, pin: u8, reset_counter: bool) → ConvertingReceiver<u32>¶

Parameter:	pin – Typ: u8, Wertebereich: [0 bis 3] reset_counter – Typ: bool
Rückgabe:	count – Typ: u32, Wertebereich: [0 bis 232 - 1]

Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Pin zurück. Die zu zählenden Flanken können mit IndustrialDigitalIn4Bricklet::set_edge_count_config konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

Die Flankenzähler benutzen die Gruppierung, wie von IndustrialDigitalIn4Bricklet::set_group gesetzt.

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen¶

pub fn IndustrialDigitalIn4Bricklet::set_group(&self, group: [char; 4]) → ConvertingReceiver<()>¶

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

Setzt eine Gruppe von Digital In 4 Bricklets die zusammenarbeiten sollen. Mögliche Gruppierungen können mit der Funktion IndustrialDigitalIn4Bricklet::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 Digital In 4 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 IndustrialDigitalIn4Bricklet::get_value beide Bricklets gleichzeitig auszulesen.

Änderungen an der Gruppeneinteilung setzt die Konfiguration und Zählerwerte aller Flankenzähler zurück.

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

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

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

pub fn IndustrialDigitalIn4Bricklet::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 IndustrialDigitalIn4Bricklet::set_edge_count_config(&self, selection_mask: u16, edge_type: u8, debounce: u8) → ConvertingReceiver<()>¶

Parameter:	selection_mask – Typ: u16, Wertebereich: [0 bis 216 - 1] edge_type – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0 debounce – Typ: u8, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Konfiguriert den Flankenzähler für die ausgewählten Pins. Eine Bitmaske von 9 bzw. 0b1001 aktiviert den Flankenzähler für die Pins 0 und 3.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden für Pins die als Eingang konfiguriert sind. Mögliche Flankentypen sind:

• 0 = steigend
• 1 = fallend
• 2 = beide

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

Die Flankenzähler benutzen die Gruppierung, wie von IndustrialDigitalIn4Bricklet::set_group gesetzt.

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

Für edge_type:

• INDUSTRIAL_DIGITAL_IN_4_BRICKLET_EDGE_TYPE_RISING = 0
• INDUSTRIAL_DIGITAL_IN_4_BRICKLET_EDGE_TYPE_FALLING = 1
• INDUSTRIAL_DIGITAL_IN_4_BRICKLET_EDGE_TYPE_BOTH = 2

Neu in Version 2.0.1 (Plugin).

pub fn IndustrialDigitalIn4Bricklet::get_edge_count_config(&self, pin: u8) → ConvertingReceiver<EdgeCountConfig>¶

Parameter:	pin – Typ: u8, Wertebereich: [0 bis 255]
Rückgabeobjekt:	edge_type – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0 debounce – Typ: u8, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Pin zurück, wie von IndustrialDigitalIn4Bricklet::set_edge_count_config gesetzt.

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

Für edge_type:

• INDUSTRIAL_DIGITAL_IN_4_BRICKLET_EDGE_TYPE_RISING = 0
• INDUSTRIAL_DIGITAL_IN_4_BRICKLET_EDGE_TYPE_FALLING = 1
• INDUSTRIAL_DIGITAL_IN_4_BRICKLET_EDGE_TYPE_BOTH = 2

Neu in Version 2.0.1 (Plugin).

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

Konfigurationsfunktionen für Callbacks¶

pub fn IndustrialDigitalIn4Bricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>¶

Parameter:	debounce – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Entprellperiode der IndustrialDigitalIn4Bricklet::get_interrupt_callback_receiver Callback.

Beispiel: Wenn dieser Wert auf 100 gesetzt wird, erhält man den Interrupt maximal alle 100ms. Dies ist notwendig falls etwas prellendes an das Digital In 4 Bricklet angeschlossen ist, wie z.B. einen Schalter.

pub fn IndustrialDigitalIn4Bricklet::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 IndustrialDigitalIn4Bricklet::set_debounce_period gesetzt.

pub fn IndustrialDigitalIn4Bricklet::set_interrupt(&self, interrupt_mask: u16) → ConvertingReceiver<()>¶

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

Setzt durch eine Bitmaske die Pins für welche der Interrupt aktiv ist. Interrupts werden ausgelöst bei Änderung des Spannungspegels eines Pins, z.B. ein Wechsel von logisch 1 zu logisch 0 und logisch 0 zu logisch 1.

Beispiel: Eine Interrupt Bitmaske von 9 bzw. 0b1001 aktiviert den Interrupt für die Pins 0 und 3.

Die Interrupts benutzen die Gruppierung, wie von IndustrialDigitalIn4Bricklet::set_group gesetzt.

Der Interrupt wird mit dem IndustrialDigitalIn4Bricklet::get_interrupt_callback_receiver Callback zugestellt.

pub fn IndustrialDigitalIn4Bricklet::get_interrupt(&self) → ConvertingReceiver<u16>¶

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

Gibt die Interrupt Bitmaske zurück, wie von IndustrialDigitalIn4Bricklet::set_interrupt 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.

pub fn IndustrialDigitalIn4Bricklet::get_interrupt_callback_receiver(&self) → ConvertingCallbackReceiver<InterruptEvent>¶

Event-Objekt:	interrupt_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 Interrupt-Events.

Dieser Callback wird ausgelöst sobald eine Änderung des Spannungspegels detektiert wird, an Pins für welche der Interrupt mit IndustrialDigitalIn4Bricklet::set_interrupt aktiviert wurde.

Die Rückgabewerte sind eine Bitmaske der aufgetretenen Interrupts und der aktuellen Zustände.

Beispiele:

• (1, 1) bzw. (0b0001, 0b0001) bedeutet, dass ein Interrupt am Pin 0 aufgetreten ist und aktuell Pin 0 logisch 1 ist und die Pins 1-3 logisch 0 sind.
• (9, 14) bzw. (0b1001, 0b1110) bedeutet, dass Interrupts an den Pins 0 und 3 aufgetreten sind und aktuell Pin 0 logisch 0 ist und die Pins 1-3 logisch 1 sind.

Die Interrupts benutzen die Gruppierung, wie von IndustrialDigitalIn4Bricklet::set_group gesetzt.

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 IndustrialDigitalIn4Bricklet::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 IndustrialDigitalIn4Bricklet::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 IndustrialDigitalIn4Bricklet::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_DIGITAL_IN_4_BRICKLET_FUNCTION_SET_GROUP = 2
• INDUSTRIAL_DIGITAL_IN_4_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 5
• INDUSTRIAL_DIGITAL_IN_4_BRICKLET_FUNCTION_SET_INTERRUPT = 7
• INDUSTRIAL_DIGITAL_IN_4_BRICKLET_FUNCTION_SET_EDGE_COUNT_CONFIG = 11

pub fn IndustrialDigitalIn4Bricklet::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_DIGITAL_IN_4_BRICKLET_FUNCTION_SET_GROUP = 2
• INDUSTRIAL_DIGITAL_IN_4_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 5
• INDUSTRIAL_DIGITAL_IN_4_BRICKLET_FUNCTION_SET_INTERRUPT = 7
• INDUSTRIAL_DIGITAL_IN_4_BRICKLET_FUNCTION_SET_EDGE_COUNT_CONFIG = 11

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

Diese Konstante wird verwendet um ein Industrial Digital In 4 Bricklet zu identifizieren.

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

Diese Konstante stellt den Anzeigenamen eines Industrial Digital In 4 Bricklet dar.