Rust - IO-16 Bricklet 2.0

Dies ist die Beschreibung der Rust API Bindings für das IO-16 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IO-16 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).

Output

Download (example_output.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
use std::{error::Error, io, thread, time::Duration};
use tinkerforge::{io16_v2_bricklet::*, ip_connection::IpConnection};

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

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

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

    // Configure channel 7 as output low
    io.set_configuration(7, 'o', false);

    // Set channel 7 alternating high/low 10 times with 100 ms delay
    for _i in 0..10 {
        thread::sleep(Duration::from_millis(100));
        io.set_selected_value(7, true);
        thread::sleep(Duration::from_millis(100));
        io.set_selected_value(7, false);
    }

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

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

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

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

    let input_value_receiver = io.get_input_value_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `io` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for input_value in input_value_receiver {
            println!("Channel: {}", input_value.channel);
            println!("Changed: {}", input_value.changed);
            println!("Value: {}", input_value.value);
            println!();
        }
    });

    // Set period for input value (channel 4) callback to 0.5s (500ms).
    io.set_input_value_callback_configuration(4, 500, 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.

Das Bricklet hat sechzehn Kanäle die in der API von 0 bis 15 benannt sind. Die entsprechenden Anschlüsse auf dem Bricklet sind mit A0 bis A7 für die Kanäle 0 bis 7 und B0 bis B7 für die Kanäle 8 bis 15 benannt.

Grundfunktionen

pub fn Io16V2Bricklet::new(uid: &str, ip_connection: &IpConnection) → Io16V2Bricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • io16_v2 – Typ: Io16V2Bricklet

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

let io16_v2 = Io16V2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn Io16V2Bricklet::set_value(&self, value: [bool; 16]) → ConvertingReceiver<()>
Parameter:
  • value – Typ: [bool; 16]

Setzt den Zustand aller sechzehn Kanäle. Der Wert true bzw. false erzeugen logisch 1 bzw. logisch 0 auf dem entsprechenden Kanal.

Mittels Io16V2Bricklet::set_selected_value können auch einzelnen Kanäle gesetzt werden.

Beispiel: (True, True, False, False, ..., False) setzt die Kanäle 0-1 auf logisch 1 und die Kanäle 2-15 auf logisch 0.

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

Bemerkung

Diese Funktion bewirkt keine Änderung an Kanälen die als Eingang konfiguriert sind. Pull-Up Widerstände können mit Io16V2Bricklet::set_configuration zugeschaltet werden.

pub fn Io16V2Bricklet::get_value(&self) → ConvertingReceiver<[bool; 16]>
Rückgabe:
  • value – Typ: [bool; 16]

Gibt die aktuell gemessenen Zustände zurück. Diese Funktion gibt die Zustände aller Kanäle zurück, unabhängig ob diese als Ein- oder Ausgang konfiguriert sind.

pub fn Io16V2Bricklet::set_selected_value(&self, channel: u8, value: bool) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 15]
  • value – Typ: bool

Setzt den Ausgabewert des ausgewählten Kanals ohne die anderen Kanäle zu beeinflussen.

Ein laufender Monoflop Timer für den ausgewählten Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

Diese Funktion bewirkt keine Änderung an Kanälen die als Eingang konfiguriert sind. Pull-Up Widerstände können mit Io16V2Bricklet::set_configuration zugeschaltet werden.

pub fn Io16V2Bricklet::set_configuration(&self, channel: u8, direction: char, value: bool) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 15]
  • direction – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'i'
  • value – Typ: bool, Standardwert: true

Konfiguriert den Zustand und die Richtung eines angegebenen Kanals. Mögliche Richtungen sind 'i' und 'o' für Ein- und Ausgang.

Wenn die Richtung als Ausgang konfiguriert ist, ist der Zustand entweder logisch 1 oder logisch 0 (gesetzt als true oder false).

Wenn die Richtung als Eingang konfiguriert ist, ist der Zustand entweder Pull-Up oder Standard (gesetzt als true oder false).

Beispiele:

  • (0, 'i', true) setzt Kanal-0 als Eingang mit Pull-Up.
  • (1, 'i', false) setzt Kanal-1 als Standard Eingang (potentialfrei wenn nicht verbunden).
  • (2, 'o', true) setzt Kanal-2 als Ausgang im Zustand logisch 1.
  • (3, 'o', false) setzt Kanal-3 als Ausgang im Zustand logisch 0.

Ein laufender Monoflop Timer für den angegebenen Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

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

Für direction:

  • IO16_V2_BRICKLET_DIRECTION_IN = 'i'
  • IO16_V2_BRICKLET_DIRECTION_OUT = 'o'
pub fn Io16V2Bricklet::get_configuration(&self, channel: u8) → ConvertingReceiver<Configuration>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 15]
Rückgabeobjekt:
  • direction – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'i'
  • value – Typ: bool, Standardwert: true

Gibt die Kanal-Konfiguration zurück, wie von Io16V2Bricklet::set_configuration gesetzt.

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

Für direction:

  • IO16_V2_BRICKLET_DIRECTION_IN = 'i'
  • IO16_V2_BRICKLET_DIRECTION_OUT = 'o'

Fortgeschrittene Funktionen

pub fn Io16V2Bricklet::set_monoflop(&self, channel: u8, value: bool, time: u32) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 15]
  • value – Typ: bool
  • time – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Konfiguriert einen Monoflop für den angegebenen Kanal.

Der zweite Parameter ist eine der gewünschten Zustände des festgelegten Kanals. Eine true bedeutet Relais geschlossen und ein *false bedeutet Relais offen.

Der dritte Parameter ist die Zeit die der Kanal den Zustand halten sollen.

Wenn diese Funktion mit den Parametern (0, 1, 1500) aufgerufen wird, wird Kanal 0 geschlossen und nach 1,5s wieder geöffnet.

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

pub fn Io16V2Bricklet::get_monoflop(&self, channel: u8) → ConvertingReceiver<Monoflop>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 15]
Rückgabeobjekt:
  • value – 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 den angegebenen Kanal) den aktuellen Zustand und die Zeit, wie von Io16V2Bricklet::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 Io16V2Bricklet::get_edge_count(&self, channel: u8, reset_counter: bool) → ConvertingReceiver<u32>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 15]
  • 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 Kanal zurück. Die zu zählenden Flanken können mit Io16V2Bricklet::set_edge_count_configuration konfiguriert werden.

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

pub fn Io16V2Bricklet::set_edge_count_configuration(&self, channel: u8, edge_type: u8, debounce: u8) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 15]
  • 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 einen bestimmten Kanal.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden für Kanäle 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 folgenden Konstanten sind für diese Funktion verfügbar:

Für edge_type:

  • IO16_V2_BRICKLET_EDGE_TYPE_RISING = 0
  • IO16_V2_BRICKLET_EDGE_TYPE_FALLING = 1
  • IO16_V2_BRICKLET_EDGE_TYPE_BOTH = 2
pub fn Io16V2Bricklet::get_edge_count_configuration(&self, channel: u8) → ConvertingReceiver<EdgeCountConfiguration>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 15]
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 Kanals zurück, wie von Io16V2Bricklet::set_edge_count_configuration gesetzt.

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

Für edge_type:

  • IO16_V2_BRICKLET_EDGE_TYPE_RISING = 0
  • IO16_V2_BRICKLET_EDGE_TYPE_FALLING = 1
  • IO16_V2_BRICKLET_EDGE_TYPE_BOTH = 2
pub fn Io16V2Bricklet::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 Io16V2Bricklet::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:

  • IO16_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • IO16_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • IO16_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • IO16_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • IO16_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • IO16_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • IO16_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • IO16_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • IO16_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • IO16_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • IO16_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn Io16V2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>
Rückgabe:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten

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

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

Für mode:

  • IO16_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • IO16_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • IO16_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • IO16_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • IO16_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn Io16V2Bricklet::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 Io16V2Bricklet::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 Io16V2Bricklet::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 Io16V2Bricklet::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 Io16V2Bricklet::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:

  • IO16_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • IO16_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • IO16_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • IO16_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn Io16V2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>
Rückgabe:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

  • IO16_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • IO16_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • IO16_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • IO16_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn Io16V2Bricklet::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 Io16V2Bricklet::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 Io16V2Bricklet::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 Io16V2Bricklet::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 Io16V2Bricklet::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 '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 Io16V2Bricklet::set_input_value_callback_configuration(&self, channel: u8, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 15]
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode ist die Periode mit der der Io16V2Bricklet::get_input_value_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 Io16V2Bricklet::get_input_value_callback_configuration(&self, channel: u8) → ConvertingReceiver<InputValueCallbackConfiguration>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 15]
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 Io16V2Bricklet::set_input_value_callback_configuration gesetzt.

pub fn Io16V2Bricklet::set_all_input_value_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 Io16V2Bricklet::get_all_input_value_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 Io16V2Bricklet::get_all_input_value_callback_configuration(&self) → ConvertingReceiver<AllInputValueCallbackConfiguration>
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 Io16V2Bricklet::set_all_input_value_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 Io16V2Bricklet::get_input_value_callback_receiver(&self) → ConvertingCallbackReceiver<InputValueEvent>
Event-Objekt:
  • channel – Typ: u8, Wertebereich: [0 bis 15]
  • changed – Typ: bool
  • value – Typ: bool

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

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

Die Parameter sind der Kanal, Changed und der Wert. Der changed-Parameter ist True wenn sich der Wert seit dem letzten Callback geändert hat.

pub fn Io16V2Bricklet::get_all_input_value_callback_receiver(&self) → ConvertingCallbackReceiver<AllInputValueEvent>
Event-Objekt:
  • changed – Typ: [bool; 16]
  • value – Typ: [bool; 16]

Receiver die mit dieser Funktion erstellt werden, empfangen All Input Value-Events.

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

Die Felder der empfangenen Struktur sind der gleiche wie Io16V2Bricklet::get_value. Zusätzlich ist der changed-Parameter True wenn sich der Wert seit dem letzten Callback geändert hat.

pub fn Io16V2Bricklet::get_monoflop_done_callback_receiver(&self) → ConvertingCallbackReceiver<MonoflopDoneEvent>
Event-Objekt:
  • channel – Typ: u8, Wertebereich: [0 bis 15]
  • value – 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). Felder der empfangenen Struktur enthalten den Kanal und den aktuellen Zustand des Kanals (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 Io16V2Bricklet::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 Io16V2Bricklet::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 Io16V2Bricklet::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:

  • IO16_V2_BRICKLET_FUNCTION_SET_VALUE = 1
  • IO16_V2_BRICKLET_FUNCTION_SET_SELECTED_VALUE = 3
  • IO16_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 4
  • IO16_V2_BRICKLET_FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION = 6
  • IO16_V2_BRICKLET_FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION = 8
  • IO16_V2_BRICKLET_FUNCTION_SET_MONOFLOP = 10
  • IO16_V2_BRICKLET_FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 13
  • IO16_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • IO16_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • IO16_V2_BRICKLET_FUNCTION_RESET = 243
  • IO16_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn Io16V2Bricklet::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:

  • IO16_V2_BRICKLET_FUNCTION_SET_VALUE = 1
  • IO16_V2_BRICKLET_FUNCTION_SET_SELECTED_VALUE = 3
  • IO16_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 4
  • IO16_V2_BRICKLET_FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION = 6
  • IO16_V2_BRICKLET_FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION = 8
  • IO16_V2_BRICKLET_FUNCTION_SET_MONOFLOP = 10
  • IO16_V2_BRICKLET_FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 13
  • IO16_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • IO16_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • IO16_V2_BRICKLET_FUNCTION_RESET = 243
  • IO16_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn Io16V2Bricklet::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 Io16V2Bricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein IO-16 Bricklet 2.0 zu identifizieren.

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

Diese Konstante stellt den Anzeigenamen eines IO-16 Bricklet 2.0 dar.