Software / API Bindings / Rust / API Referenz und Beispiele / Bricklets / Industrial Analog Out Bricklet 2.0

Rust - Industrial Analog Out Bricklet 2.0¶

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

Download (example_simple_current.rs)

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

use tinkerforge::{industrial_analog_out_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 Analog Out Bricklet 2.0.

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

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

    // Set output current to 4.5mA
    iao.set_current(4500).recv()?;
    iao.set_enabled(true).recv()?;

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

    iao.set_enabled(false).recv()?;

    ipcon.disconnect();
    Ok(())
}

Simple Voltage¶

Download (example_simple_voltage.rs)

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

use tinkerforge::{industrial_analog_out_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 Analog Out Bricklet 2.0.

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

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

    // Set output voltage to 3.3V
    iao.set_voltage(3300).recv()?;
    iao.set_enabled(true).recv()?;

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

    iao.set_enabled(false).recv()?;

    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 IndustrialAnalogOutV2Bricklet::new(uid: &str, ip_connection: &IpConnection) → IndustrialAnalogOutV2Bricklet¶

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2Bricklet

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

let industrial_analog_out_v2 = IndustrialAnalogOutV2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn IndustrialAnalogOutV2Bricklet::set_enabled(&self, enabled: bool) → ConvertingReceiver<()>¶

Parameter:	enabled – Typ: bool, Standardwert: false

Aktiviert/deaktiviert die Ausgabe von Spannung und Strom.

pub fn IndustrialAnalogOutV2Bricklet::get_enabled(&self) → ConvertingReceiver<bool>¶

Rückgabe:	enabled – Typ: bool, Standardwert: false

Gibt true zurück falls die Ausgabe von Spannung und Strom aktiviert ist, false sonst.

pub fn IndustrialAnalogOutV2Bricklet::set_voltage(&self, voltage: u16) → ConvertingReceiver<()>¶

Parameter:	voltage – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 10000]

Setzt die Ausgangsspannung.

Die Ausgangsspannung und der Ausgangsstrom sind gekoppelt. Eine Änderung der Ausgangsspannung führt auch zu einer Änderung des Ausgangsstroms.

pub fn IndustrialAnalogOutV2Bricklet::get_voltage(&self) → ConvertingReceiver<u16>¶

Rückgabe:	voltage – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 10000]

Gibt die Spannung zurück, wie von IndustrialAnalogOutV2Bricklet::set_voltage gesetzt.

pub fn IndustrialAnalogOutV2Bricklet::set_current(&self, current: u16) → ConvertingReceiver<()>¶

Parameter:	current – Typ: u16, Einheit: 1 µA, Wertebereich: [0 bis 24000]

Setzt den Ausgangsstrom.

Der Ausgangsstrom und die Ausgangsspannung sind gekoppelt. Eine Änderung des Ausgangsstroms führt auch zu einer Änderung der Ausgangsspannung.

pub fn IndustrialAnalogOutV2Bricklet::get_current(&self) → ConvertingReceiver<u16>¶

Rückgabe:	current – Typ: u16, Einheit: 1 µA, Wertebereich: [0 bis 24000]

Gibt die Spannung zurück, wie von IndustrialAnalogOutV2Bricklet::set_current gesetzt.

pub fn IndustrialAnalogOutV2Bricklet::set_out_led_config(&self, config: u8) → ConvertingReceiver<()>¶

Parameter:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Die Out LED kann an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der "Out-Status" angezeigt werden. Falls Out-Status gewählt wird kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des Ausgabewertes (Spannung oder Strom) skaliert werden.

Das Verhalten des Out-Status kann mittels IndustrialAnalogOutV2Bricklet::set_out_led_status_config eingestellt werden.

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

Für config:

INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_CONFIG_OFF = 0
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_CONFIG_ON = 1
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_CONFIG_SHOW_OUT_STATUS = 3

pub fn IndustrialAnalogOutV2Bricklet::get_out_led_config(&self) → ConvertingReceiver<u8>¶

Rückgabe:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Out-LED-Konfiguration zurück, wie von IndustrialAnalogOutV2Bricklet::set_out_led_config gesetzt.

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

Für config:

INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_CONFIG_OFF = 0
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_CONFIG_ON = 1
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_CONFIG_SHOW_OUT_STATUS = 3

pub fn IndustrialAnalogOutV2Bricklet::set_out_led_status_config(&self, min: u16, max: u16, config: u8) → ConvertingReceiver<()>¶

Parameter:	min – Typ: u16, Wertebereich: [0 bis 24000], Standardwert: 0 max – Typ: u16, Wertebereich: [0 bis 24000], Standardwert: 10000 config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 1

Setzt die Out-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn die Out-LED auf Out-Status eingestellt ist, siehe IndustrialAnalogOutV2Bricklet::set_out_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 oder µA gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 5V wird die LED eingeschaltet sobald der Ausgabewert über 5V steigt und wieder ausgeschaltet sobald der Ausgabewert unter 5V fällt. Für einen negativen Schwellwert muss der "max" Parameter auf den gewünschten Schwellwert in mV oder µA gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 5V wird die LED eingeschaltet sobald der Ausgabewert unter 5V fällt und wieder ausgeschaltet sobald der Ausgabewert über 5V steigt.

Im Intensitätsmodus kann ein Bereich in mV oder µA angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=2V und max=8V: Die LED ist bei 2V und darunter aus, bei 8V und darüber an und zwischen 2V und 8V 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_ANALOG_OUT_V2_BRICKLET_OUT_LED_STATUS_CONFIG_THRESHOLD = 0
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_STATUS_CONFIG_INTENSITY = 1

pub fn IndustrialAnalogOutV2Bricklet::get_out_led_status_config(&self) → ConvertingReceiver<OutLedStatusConfig>¶

Rückgabeobjekt:	min – Typ: u16, Wertebereich: [0 bis 24000], Standardwert: 0 max – Typ: u16, Wertebereich: [0 bis 24000], Standardwert: 10000 config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt die Out-LED-Status-Konfiguration zurück, wie von IndustrialAnalogOutV2Bricklet::set_out_led_status_config gesetzt.

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

Für config:

INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_STATUS_CONFIG_THRESHOLD = 0
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_STATUS_CONFIG_INTENSITY = 1

Fortgeschrittene Funktionen¶

pub fn IndustrialAnalogOutV2Bricklet::set_configuration(&self, voltage_range: u8, current_range: u8) → ConvertingReceiver<()>¶

Parameter:	voltage_range – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 1 current_range – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Konfiguriert die Spannungs- und Stromwertebereiche.

Einstellbare Spannungswertebereiche sind:

0V bis 5V
0V bis 10V

Einstellbare Stromwertebereiche sind:

4mA bis 20mA
0mA bis 20mA
0mA bis 24mA

Die Auflösung ist immer 12 Bit. Dass heißt, die Genauigkeit erhöht sich bei kleineren Wertebereichen.

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

Für voltage_range:

INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_VOLTAGE_RANGE_0_TO_5V = 0
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_VOLTAGE_RANGE_0_TO_10V = 1

Für current_range:

INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_CURRENT_RANGE_4_TO_20MA = 0
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_CURRENT_RANGE_0_TO_20MA = 1
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_CURRENT_RANGE_0_TO_24MA = 2

pub fn IndustrialAnalogOutV2Bricklet::get_configuration(&self) → ConvertingReceiver<Configuration>¶

Rückgabeobjekt:	voltage_range – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 1 current_range – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Konfiguration zurück, wie von IndustrialAnalogOutV2Bricklet::set_configuration gesetzt.

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

Für voltage_range:

INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_VOLTAGE_RANGE_0_TO_5V = 0
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_VOLTAGE_RANGE_0_TO_10V = 1

Für current_range:

INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_CURRENT_RANGE_4_TO_20MA = 0
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_CURRENT_RANGE_0_TO_20MA = 1
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_CURRENT_RANGE_0_TO_24MA = 2

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

Rückgabeobjekt:	error_count_ack_checksum – Typ: u32, Wertebereich: [0 bis 2³² - 1] error_count_message_checksum – Typ: u32, Wertebereich: [0 bis 2³² - 1] error_count_frame – Typ: u32, Wertebereich: [0 bis 2³² - 1] error_count_overflow – Typ: u32, Wertebereich: [0 bis 2³² - 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 IndustrialAnalogOutV2Bricklet::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_ANALOG_OUT_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn IndustrialAnalogOutV2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>¶

Rückgabe:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn IndustrialAnalogOutV2Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>¶

Rückgabe:	temperature – Typ: i16, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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 IndustrialAnalogOutV2Bricklet::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 IndustrialAnalogOutV2Bricklet::get_identity(&self) → ConvertingReceiver<Identity>¶

Rückgabeobjekt:

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 2¹⁶ - 1]

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 2¹⁶ - 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.

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 IndustrialAnalogOutV2Bricklet::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 IndustrialAnalogOutV2Bricklet::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 IndustrialAnalogOutV2Bricklet::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_ANALOG_OUT_V2_BRICKLET_FUNCTION_SET_ENABLED = 1
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_SET_VOLTAGE = 3
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_SET_CURRENT = 5
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 7
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_SET_OUT_LED_CONFIG = 9
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_SET_OUT_LED_STATUS_CONFIG = 11
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_RESET = 243
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_WRITE_UID = 248

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

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

Für function_id:

INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_SET_ENABLED = 1
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_SET_VOLTAGE = 3
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_SET_CURRENT = 5
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 7
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_SET_OUT_LED_CONFIG = 9
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_SET_OUT_LED_STATUS_CONFIG = 11
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_RESET = 243
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_FUNCTION_WRITE_UID = 248

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

pub fn IndustrialAnalogOutV2Bricklet::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_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5

pub fn IndustrialAnalogOutV2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>¶

Rückgabe:	mode – Typ: u8, Wertebereich: Siehe Konstanten

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

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

Für mode:

INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

pub fn IndustrialAnalogOutV2Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>¶

Parameter:	pointer – Typ: u32, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]

Setzt den Firmware-Pointer für IndustrialAnalogOutV2Bricklet::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 IndustrialAnalogOutV2Bricklet::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 IndustrialAnalogOutV2Bricklet::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 IndustrialAnalogOutV2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>¶

Parameter:	uid – Typ: u32, Wertebereich: [0 bis 2³² - 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 IndustrialAnalogOutV2Bricklet::read_uid(&self) → ConvertingReceiver<u32>¶

Rückgabe:	uid – Typ: u32, Wertebereich: [0 bis 2³² - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

pub const IndustrialAnalogOutV2Bricklet::DEVICE_IDENTIFIER¶

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

Die IndustrialAnalogOutV2Bricklet::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 IndustrialAnalogOutV2Bricklet::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Industrial Analog Out Bricklet 2.0 dar.