Rust - IO-4 Bricklet 2.0

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

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

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

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

    // Set channel 3 alternating high/low 10 times with 100 ms delay
    for _i in 0..10 {
        thread::sleep(Duration::from_millis(100));
        io.set_selected_value(3, true);
        thread::sleep(Duration::from_millis(100));
        io.set_selected_value(3, 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::{io4_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-4 Bricklet 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let io = Io4V2Bricklet::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 1) callback to 0.5s (500ms).
    io.set_input_value_callback_configuration(1, 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.

Grundfunktionen

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

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

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

pub fn Io4V2Bricklet::set_value(&self, value: [bool; 4]) → ConvertingReceiver<()>

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

Mit der Funktionen Io4V2Bricklet::set_selected_value können einzelnen Kanäle gesetzt werden.

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

Alle laufenden Monoflop Timer und PWMs 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 Io4V2Bricklet::set_configuration zugeschaltet werden.

pub fn Io4V2Bricklet::get_value(&self) → ConvertingReceiver<[bool; 4]>

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 Io4V2Bricklet::set_selected_value(&self, channel: u8, value: bool) → ConvertingReceiver<()>

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

Ein laufender Monoflop Timer oder PWM 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 Io4V2Bricklet::set_configuration zugeschaltet werden.

pub fn Io4V2Bricklet::set_configuration(&self, channel: u8, direction: char, value: bool) → ConvertingReceiver<()>

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 oder PWM für den angegebenen Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

Die Standardkonfiguration ist Eingang mit Pull-Up.

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

  • IO4_V2_BRICKLET_DIRECTION_IN = 'i'
  • IO4_V2_BRICKLET_DIRECTION_OUT = 'o'
pub fn Io4V2Bricklet::get_configuration(&self, channel: u8) → ConvertingReceiver<Configuration>

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

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

  • IO4_V2_BRICKLET_DIRECTION_IN = 'i'
  • IO4_V2_BRICKLET_DIRECTION_OUT = 'o'

Fortgeschrittene Funktionen

pub fn Io4V2Bricklet::set_monoflop(&self, channel: u8, value: bool, time: u32) → ConvertingReceiver<()>

Der erste Parameter ist der gewünschte Zustand des Kanals (true bedeutet high und false low). Der zweite Parameter stellt die Zeit (in ms) dar, in welcher der Kanal den Zustand halten soll.

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

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

Ein Monoflop kann als Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein IO-4 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 eingeschaltet sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Kanal nach spätestens zwei Sekunden ausschalten.

pub fn Io4V2Bricklet::get_monoflop(&self, channel: u8) → ConvertingReceiver<Monoflop>

Gibt (für den angegebenen Kanal) den aktuellen Zustand und die Zeit, wie von Io4V2Bricklet::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 Io4V2Bricklet::get_edge_count(&self, channel: u8, reset_counter: bool) → ConvertingReceiver<u32>

Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Kanal zurück. Die zu zählenden Flanken können mit Io4V2Bricklet::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.

Bemerkung

Aufrufen dieser Funktion ist nur für Kanäle erlaubt, die als Eingang konfiguriert sind.

pub fn Io4V2Bricklet::set_edge_count_configuration(&self, channel: u8, edge_type: u8, debounce: u8) → ConvertingReceiver<()>

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 (Standard)
  • 1 = fallend
  • 2 = beide

Die Entprellzeit (debounce) wird in ms angegeben.

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.

Standardwerte: 0 (edge type) und 100ms (debounce).

Bemerkung

Aufrufen dieser Funktion ist nur für Kanäle erlaubt, die als Eingang konfiguriert sind.

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

  • IO4_V2_BRICKLET_EDGE_TYPE_RISING = 0
  • IO4_V2_BRICKLET_EDGE_TYPE_FALLING = 1
  • IO4_V2_BRICKLET_EDGE_TYPE_BOTH = 2
pub fn Io4V2Bricklet::get_edge_count_configuration(&self, channel: u8) → ConvertingReceiver<EdgeCountConfiguration>

Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Kanal zurück, wie von Io4V2Bricklet::set_edge_count_configuration gesetzt.

Bemerkung

Aufrufen dieser Funktion ist nur für Kanäle erlaubt, die als Eingang konfiguriert sind.

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

  • IO4_V2_BRICKLET_EDGE_TYPE_RISING = 0
  • IO4_V2_BRICKLET_EDGE_TYPE_FALLING = 1
  • IO4_V2_BRICKLET_EDGE_TYPE_BOTH = 2
pub fn Io4V2Bricklet::set_pwm_configuration(&self, channel: u8, frequency: u32, duty_cycle: u16) → ConvertingReceiver<()>

Aktiviert ein PWM auf dem angegebenen Kanal. Die Frequenz wird in 1/10Hz angegeben und die Duty Cycle in 1/100%.

Bevor diese Funktion aufgerufen wird, muss der Kanal als Ausgabe konfiguriert werden, ansonsten wird ein "invalid parameter"-Fehler gemeldet. Um die PWM wieder auszustellen, kann die Frequenz auf 0 gesetzt werden oder eine andere Funktion aufgerufen werden die Einstellungen am Kanal verändert (z.B. Io4V2Bricklet::set_selected_value).

Der maximale Frequenzwert beträgt 320000000 (32MHz). Der Maximale Duty Cycle-Wert beträgt 10000 (100%).

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

Die Standardwerte sind 0, 0.

pub fn Io4V2Bricklet::get_pwm_configuration(&self, channel: u8) → ConvertingReceiver<PwmConfiguration>

Gibt die PWM Konfiguration zurück, wie von Io4V2Bricklet::set_pwm_configuration gesetzt.

pub fn Io4V2Bricklet::get_api_version(&self) → [u8; 3]

Gibt die Version der API Definition (Major, Minor, Revision) 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 Io4V2Bricklet::get_response_expected(&mut self, function_id: u8) → 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 Io4V2Bricklet::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:

  • IO4_V2_BRICKLET_FUNCTION_SET_VALUE = 1
  • IO4_V2_BRICKLET_FUNCTION_SET_SELECTED_VALUE = 3
  • IO4_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 4
  • IO4_V2_BRICKLET_FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION = 6
  • IO4_V2_BRICKLET_FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION = 8
  • IO4_V2_BRICKLET_FUNCTION_SET_MONOFLOP = 10
  • IO4_V2_BRICKLET_FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 13
  • IO4_V2_BRICKLET_FUNCTION_SET_PWM_CONFIGURATION = 15
  • IO4_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • IO4_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • IO4_V2_BRICKLET_FUNCTION_RESET = 243
  • IO4_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn Io4V2Bricklet::set_response_expected(&mut self, function_id: u8, response_expected: 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:

  • IO4_V2_BRICKLET_FUNCTION_SET_VALUE = 1
  • IO4_V2_BRICKLET_FUNCTION_SET_SELECTED_VALUE = 3
  • IO4_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 4
  • IO4_V2_BRICKLET_FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION = 6
  • IO4_V2_BRICKLET_FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION = 8
  • IO4_V2_BRICKLET_FUNCTION_SET_MONOFLOP = 10
  • IO4_V2_BRICKLET_FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 13
  • IO4_V2_BRICKLET_FUNCTION_SET_PWM_CONFIGURATION = 15
  • IO4_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • IO4_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • IO4_V2_BRICKLET_FUNCTION_RESET = 243
  • IO4_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn Io4V2Bricklet::set_response_expected_all(&mut self, response_expected: bool) → ()

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

pub fn Io4V2Bricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>

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 Io4V2Bricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>

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

  • IO4_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • IO4_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • IO4_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • IO4_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • IO4_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • IO4_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • IO4_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • IO4_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • IO4_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • IO4_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • IO4_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn Io4V2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>

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

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

  • IO4_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • IO4_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • IO4_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • IO4_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • IO4_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn Io4V2Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>

Setzt den Firmware-Pointer für Io4V2Bricklet::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 Io4V2Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>

Schreibt 64 Bytes Firmware an die Position die vorher von Io4V2Bricklet::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 Io4V2Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>

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:

  • IO4_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • IO4_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • IO4_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • IO4_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn Io4V2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>

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

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

  • IO4_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • IO4_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • IO4_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • IO4_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn Io4V2Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>

Gibt die Temperatur in °C, 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 Io4V2Bricklet::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 Io4V2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>

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 Io4V2Bricklet::read_uid(&self) → ConvertingReceiver<u32>

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 Io4V2Bricklet::get_identity(&self) → ConvertingReceiver<Identity>

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 kann 'a', 'b', 'c' oder 'd' sein.

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 Io4V2Bricklet::set_input_value_callback_configuration(&self, channel: u8, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode in ms ist die Periode mit der der Io4V2Bricklet::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.

Der Standardwert ist (0, false).

pub fn Io4V2Bricklet::get_input_value_callback_configuration(&self, channel: u8) → ConvertingReceiver<InputValueCallbackConfiguration>

Gibt die Callback-Konfiguration für den gegebenen Kanal zurück, wie mittels Io4V2Bricklet::set_input_value_callback_configuration gesetzt.

pub fn Io4V2Bricklet::set_all_input_value_callback_configuration(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>

Die Periode in ms ist die Periode mit der der Io4V2Bricklet::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.

Der Standardwert ist (0, false).

pub fn Io4V2Bricklet::get_all_input_value_callback_configuration(&self) → ConvertingReceiver<AllInputValueCallbackConfiguration>

Gibt die Callback-Konfiguration zurück, wie mittels Io4V2Bricklet::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 Io4V2Bricklet::get_input_value_callback_receiver(&self) → ConvertingCallbackReceiver<InputValueEvent>

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels Io4V2Bricklet::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 Io4V2Bricklet::get_all_input_value_callback_receiver(&self) → ConvertingCallbackReceiver<AllInputValueEvent>

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

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

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

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

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).

Konstanten

Io4V2Bricklet::DEVICE_IDENTIFIER

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

Die Io4V2Bricklet::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.

Io4V2Bricklet::DEVICE_DISPLAY_NAME

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