Rust - Industrial Dual Analog In Bricklet 2.0

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

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_dual_analog_in_v2_bricklet::*, ip_connection::IpConnection};

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

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

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

    // Get current voltage from channel 0.
    let voltage = idai.get_voltage(0).recv()?;
    println!("Voltage (Channel 0): {} V", voltage as f32 / 1000.0);

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

Callback

Download (example_callback.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_dual_analog_in_v2_bricklet::*, ip_connection::IpConnection};

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

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

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

    let voltage_receiver = idai.get_voltage_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `idai` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for voltage in voltage_receiver {
            println!("Channel: {}", voltage.channel);
            println!("Voltage: {} V", voltage.voltage as f32 / 1000.0);
            println!();
        }
    });

    // Set period for voltage (channel 0) callback to 1s (1000ms) without a threshold.
    idai.set_voltage_callback_configuration(0, 1000, false, 'x', 0, 0);

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

Threshold

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

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

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

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

    let voltage_receiver = idai.get_voltage_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `idai` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for voltage in voltage_receiver {
            println!("Channel: {}", voltage.channel);
            println!("Voltage: {} V", voltage.voltage as f32 / 1000.0);
            println!();
        }
    });

    // Configure threshold for voltage (channel 0) "greater than 10 V"
    // with a debounce period of 10s (10000ms).
    idai.set_voltage_callback_configuration(0, 10000, false, '>', 10 * 1000, 0);

    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 zwei Eingangskanäle. Funktionen die sich direkt auf einen der Kanäle beziehen haben einen channel Parameter, um den Kanal anzugeben. Gültige Werte für der channel Parameter sind 0 und 1.

Grundfunktionen

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

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

let industrial_dual_analog_in_v2 = IndustrialDualAnalogInV2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn IndustrialDualAnalogInV2Bricklet::get_voltage(&self, channel: u8) → ConvertingReceiver<i32>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 1]
Rückgabe:
  • voltage – Typ: i32, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

Gibt die Spannung für den übergebenen Kanal zurück.

Wenn der Wert periodisch benötigt wird, kann auch der IndustrialDualAnalogInV2Bricklet::get_voltage_callback_receiver Callback verwendet werden. Der Callback wird mit der Funktion IndustrialDualAnalogInV2Bricklet::set_voltage_callback_configuration konfiguriert.

pub fn IndustrialDualAnalogInV2Bricklet::set_channel_led_config(&self, channel: u8, config: u8) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 1]
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Jeder Kanal hat eine dazugehörige LED. Die LEDs können individuell an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der Kanalstatus angezeigt werden. Falls Kanalstatus gewählt wird kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des gemessenen Wertes skaliert werden.

Das Verhalten des Kanalstatus kann mittels IndustrialDualAnalogInV2Bricklet::set_channel_led_status_config eingestellt werden.

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

Für config:

  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_CONFIG_OFF = 0
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_CONFIG_ON = 1
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
pub fn IndustrialDualAnalogInV2Bricklet::get_channel_led_config(&self, channel: u8) → ConvertingReceiver<u8>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 1]
Rückgabe:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Kanal-LED-Konfiguration zurück, wie von IndustrialDualAnalogInV2Bricklet::set_channel_led_config gesetzt.

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

Für config:

  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_CONFIG_OFF = 0
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_CONFIG_ON = 1
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
pub fn IndustrialDualAnalogInV2Bricklet::set_channel_led_status_config(&self, channel: u8, min: i32, max: i32, config: u8) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 1]
  • min – Typ: i32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: i32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 10000
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 1

Setzt die Kanal-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn die Kanal-LED auf Kanalstatus eingestellt ist, siehe IndustrialDualAnalogInV2Bricklet::set_channel_led_config.

Für jeden Kanal kann zwischen Schwellwert- und Intensitätsmodus gewählt werden.

Im Schwellwertmodus kann ein positiver oder negativer Schwellwert definiert werden. Für einen positiven Schwellwert muss der "min" Parameter auf den gewünschten Schwellwert in mV gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 10V wird die LED eingeschaltet sobald die gemessene Spannung über 10V steigt und wieder ausgeschaltet sobald der Strom unter 10V fällt. Für einen negativen Schwellwert muss der "max" Parameter auf den gewünschten Schwellwert in mV gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 10mA wird die LED eingeschaltet sobald die gemessene Spannung unter 10V fällt und wieder ausgeschaltet sobald der Strom über 10V steigt.

Im Intensitätsmodus kann ein Bereich in mV angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=4V und max=20V: Die LED ist bei 4V und darunter aus, bei 20V und darüber an und zwischen 4V und 20V wird die Helligkeit linear skaliert. Wenn der min Wert größer als der max Wert ist, dann wird die Helligkeit andersherum skaliert.

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

Für config:

  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1
pub fn IndustrialDualAnalogInV2Bricklet::get_channel_led_status_config(&self, channel: u8) → ConvertingReceiver<ChannelLedStatusConfig>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 1]
Rückgabeobjekt:
  • min – Typ: i32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: i32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 10000
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt die Kanal-LED-Status-Konfiguration zurück, wie von IndustrialDualAnalogInV2Bricklet::set_channel_led_status_config gesetzt.

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

Für config:

  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

Fortgeschrittene Funktionen

pub fn IndustrialDualAnalogInV2Bricklet::set_sample_rate(&self, rate: u8) → ConvertingReceiver<()>
Parameter:
  • rate – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 6

Setzt die Abtastrate. Der Wertebereich der verfügbare Abtastraten liegt zwischen 1 Wert pro Sekunde und 976 Werte pro Sekunde. Ein Verringern der Abtastrate wird auch das Rauschen auf den Daten verringern.

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

Für rate:

  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_976_SPS = 0
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_488_SPS = 1
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_244_SPS = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_122_SPS = 3
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_61_SPS = 4
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_4_SPS = 5
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_2_SPS = 6
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_1_SPS = 7
pub fn IndustrialDualAnalogInV2Bricklet::get_sample_rate(&self) → ConvertingReceiver<u8>
Rückgabe:
  • rate – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 6

Gibt die Abtastrate zurück, wie von IndustrialDualAnalogInV2Bricklet::set_sample_rate gesetzt.

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

Für rate:

  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_976_SPS = 0
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_488_SPS = 1
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_244_SPS = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_122_SPS = 3
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_61_SPS = 4
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_4_SPS = 5
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_2_SPS = 6
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_SAMPLE_RATE_1_SPS = 7
pub fn IndustrialDualAnalogInV2Bricklet::set_calibration(&self, offset: [i32; 2], gain: [i32; 2]) → ConvertingReceiver<()>
Parameter:
  • offset – Typ: [i32; 2], Wertebereich: [-8388608 bis 8388607]
  • gain – Typ: [i32; 2], Wertebereich: [-8388608 bis 8388607]

Setzt Offset und Gain der MCP3911 internen Kalibrierungsregister.

Siehe MCP3911 Datenblatt 7.7 und 7.8. Das Industrial Dual Analog In Bricklet 2.0 wird von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte nicht notwendig sein.

pub fn IndustrialDualAnalogInV2Bricklet::get_calibration(&self) → ConvertingReceiver<Calibration>
Rückgabeobjekt:
  • offset – Typ: [i32; 2], Wertebereich: [-8388608 bis 8388607]
  • gain – Typ: [i32; 2], Wertebereich: [-8388608 bis 8388607]

Gibt die Kalibrierung zurück, wie von IndustrialDualAnalogInV2Bricklet::set_calibration gesetzt.

pub fn IndustrialDualAnalogInV2Bricklet::get_adc_values(&self) → ConvertingReceiver<[i32; 2]>
Rückgabe:
  • value – Typ: [i32; 2], Wertebereich: [-8388608 bis 8388607]

Gibt die ADC-Werte des MCP3911 ICs zurück. Diese Funktion wird für die Kalibrierung benötigt, siehe IndustrialDualAnalogInV2Bricklet::set_calibration.

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

  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn IndustrialDualAnalogInV2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>
Rückgabe:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten

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

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

Für mode:

  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn IndustrialDualAnalogInV2Bricklet::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 IndustrialDualAnalogInV2Bricklet::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 IndustrialDualAnalogInV2Bricklet::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 IndustrialDualAnalogInV2Bricklet::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 IndustrialDualAnalogInV2Bricklet::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:

  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn IndustrialDualAnalogInV2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>
Rückgabe:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn IndustrialDualAnalogInV2Bricklet::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 IndustrialDualAnalogInV2Bricklet::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 IndustrialDualAnalogInV2Bricklet::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 IndustrialDualAnalogInV2Bricklet::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 IndustrialDualAnalogInV2Bricklet::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 IndustrialDualAnalogInV2Bricklet::set_voltage_callback_configuration(&self, channel: u8, period: u32, value_has_to_change: bool, option: char, min: i32, max: i32) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 1]
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: i32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: i32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode ist die Periode mit der der IndustrialDualAnalogInV2Bricklet::get_voltage_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.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den IndustrialDualAnalogInV2Bricklet::get_voltage_callback_receiver Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn IndustrialDualAnalogInV2Bricklet::get_voltage_callback_configuration(&self, channel: u8) → ConvertingReceiver<VoltageCallbackConfiguration>
Parameter:
  • channel – Typ: u8, Wertebereich: [0 bis 1]
Rückgabeobjekt:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: i32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: i32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels IndustrialDualAnalogInV2Bricklet::set_voltage_callback_configuration gesetzt.

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

Für option:

  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

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 IndustrialDualAnalogInV2Bricklet::get_voltage_callback_receiver(&self) → ConvertingCallbackReceiver<VoltageEvent>
Event-Objekt:
  • channel – Typ: u8, Wertebereich: [0 bis 1]
  • voltage – Typ: i32, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

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

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

Der empfangene Variable ist der gleiche wie IndustrialDualAnalogInV2Bricklet::get_voltage.

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 IndustrialDualAnalogInV2Bricklet::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 IndustrialDualAnalogInV2Bricklet::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 IndustrialDualAnalogInV2Bricklet::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_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_SET_SAMPLE_RATE = 5
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_SET_CALIBRATION = 7
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_SET_CHANNEL_LED_CONFIG = 10
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_RESET = 243
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn IndustrialDualAnalogInV2Bricklet::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_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_SET_SAMPLE_RATE = 5
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_SET_CALIBRATION = 7
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_SET_CHANNEL_LED_CONFIG = 10
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_RESET = 243
  • INDUSTRIAL_DUAL_ANALOG_IN_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn IndustrialDualAnalogInV2Bricklet::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 IndustrialDualAnalogInV2Bricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Dual Analog In Bricklet 2.0 zu identifizieren.

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

Diese Konstante stellt den Anzeigenamen eines Industrial Dual Analog In Bricklet 2.0 dar.