Rust - DMX Bricklet

Dies ist die Beschreibung der Rust API Bindings für das DMX Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des DMX Bricklet 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
26
27
use std::{error::Error, io};

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

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

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

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

    // Configure Bricklet as DMX master
    dmx.set_dmx_mode(DMX_BRICKLET_DMX_MODE_MASTER);

    // Write DMX frame with 3 channels
    dmx.write_frame(&[255, 128, 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.

Grundfunktionen

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

Erzeugt ein neues DmxBricklet-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 DmxBricklet::set_dmx_mode(&self, dmx_mode: u8) → ConvertingReceiver<()>

Setzt den DMX Modus entweder auf Master oder Slave.

Ein Aufruf dieser Funktion setzt die Frame-Nummer auf 0.

Der Standardwert ist 0 (Master).

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

  • DMX_BRICKLET_DMX_MODE_MASTER = 0
  • DMX_BRICKLET_DMX_MODE_SLAVE = 1
pub fn DmxBricklet::get_dmx_mode(&self) → ConvertingReceiver<u8>

Gibt den DMX Modus zurück, wie von DmxBricklet::set_dmx_mode gesetzt.

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

  • DMX_BRICKLET_DMX_MODE_MASTER = 0
  • DMX_BRICKLET_DMX_MODE_SLAVE = 1
pub fn DmxBricklet::write_frame(&self, frame: u8) → Result<(), BrickletRecvTimeoutError>

Schreibt ein DMX Frame. Die maximale Framegröße ist 512 Byte. Jedes Byte stellt dabei einen Kanal dar.

Das nächste Frame kann geschrieben werden nachdem der DmxBricklet::get_frame_started_callback_receiver Callback aufgerufen wurde. Das Frame verfügt über einen Doublebuffer, so dass ein neues Frame geschrieben werden kann, sobald das vorherige Frame geschrieben wurde.

Die Daten werden transferiert, wenn die nächste Frame Duration abgelaufen ist, siehe see DmxBricklet::set_frame_duration.

Genereller Ansatz:

Dieser Ansatz garantiert, dass DMX Daten mit einer festen Framerate gesetzt werden.

Diese Funktion kann nur im Master Modus aufgerufen werden.

pub fn DmxBricklet::read_frame(&self) → Result<(Vec<u8>, u32), BrickletRecvTimeoutError>

Gibt das letzte Frame zurück, dass von dem DMX Master geschrieben wurde. Die Größe des Arrays ist identisch zu der Anzahl der Kanäle im Frame. Jedes Byte repräsentiert ein Kanal.

Das nächste Frame ist verfügbar nachdem der DmxBricklet::get_frame_available_callback_receiver Callback aufgerufen wurde.

Genereller Ansatz:

Anstatt das diese Funktion gepollt wird, kann auch der DmxBricklet::get_frame_callback_receiver Callback genutzt werden. Der Callback kann mit DmxBricklet::set_frame_callback_config aktiviert werden.

Die frame number startet mit 0 und wird für jedes empfangene Frame erhöht.

Diese Funktion kann nur im Slave Modus aufgerufen werden.

pub fn DmxBricklet::set_frame_duration(&self, frame_duration: u16) → ConvertingReceiver<()>

Setzt die Dauer eines Frames in ms.

Beispiel: Wenn 20 Frames pro Sekunde erreicht werden sollen, muss die frame duration auf 50ms gesetzt werden (50ms * 20 = 1 Sekunde).

Soll jeweils ein Frame so schnell wie möglich gesendet werden, so sollte die frame duration auf 0 gesetzt werden.

Diese Einstellung wird nur im Master Modus genutzt.

Standardwert: 100ms (10 Frames pro Sekunde)

pub fn DmxBricklet::get_frame_duration(&self) → ConvertingReceiver<u16>

Gibt die Frame duration zurück die mittels DmxBricklet::set_frame_duration gesetzt wurde.

Fortgeschrittene Funktionen

pub fn DmxBricklet::get_frame_error_count(&self) → ConvertingReceiver<FrameErrorCount>

Gibt die aktuelle Anzahl an Overrun und Framing Fehlern zurück.

pub fn DmxBricklet::set_communication_led_config(&self, config: u8) → ConvertingReceiver<()>

Setzt die Konfiguration der Kommunikations-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:

  • DMX_BRICKLET_COMMUNICATION_LED_CONFIG_OFF = 0
  • DMX_BRICKLET_COMMUNICATION_LED_CONFIG_ON = 1
  • DMX_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • DMX_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3
pub fn DmxBricklet::get_communication_led_config(&self) → ConvertingReceiver<u8>

Gibt die Konfiguration zurück, wie von DmxBricklet::set_communication_led_config gesetzt.

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

  • DMX_BRICKLET_COMMUNICATION_LED_CONFIG_OFF = 0
  • DMX_BRICKLET_COMMUNICATION_LED_CONFIG_ON = 1
  • DMX_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • DMX_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3
pub fn DmxBricklet::set_error_led_config(&self, config: u8) → ConvertingReceiver<()>

Setzt die Konfiguration der Error-LED.

Standardmäßig geht die LED an, wenn ein Error auftritt (siehe DmxBricklet::get_frame_error_count_callback_receiver Callback). Wenn diese Funktion danach nochmal mit der Show-Error-Option aufgerufen wird, geht die LED wieder aus bis der nächste Error auftritt.

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:

  • DMX_BRICKLET_ERROR_LED_CONFIG_OFF = 0
  • DMX_BRICKLET_ERROR_LED_CONFIG_ON = 1
  • DMX_BRICKLET_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
  • DMX_BRICKLET_ERROR_LED_CONFIG_SHOW_ERROR = 3
pub fn DmxBricklet::get_error_led_config(&self) → ConvertingReceiver<u8>

Gibt die Konfiguration zurück, wie von DmxBricklet::set_error_led_config gesetzt.

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

  • DMX_BRICKLET_ERROR_LED_CONFIG_OFF = 0
  • DMX_BRICKLET_ERROR_LED_CONFIG_ON = 1
  • DMX_BRICKLET_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
  • DMX_BRICKLET_ERROR_LED_CONFIG_SHOW_ERROR = 3
pub fn DmxBricklet::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 DmxBricklet::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 DmxBricklet::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:

  • DMX_BRICKLET_FUNCTION_SET_DMX_MODE = 1
  • DMX_BRICKLET_FUNCTION_WRITE_FRAME = 3
  • DMX_BRICKLET_FUNCTION_SET_FRAME_DURATION = 5
  • DMX_BRICKLET_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 8
  • DMX_BRICKLET_FUNCTION_SET_ERROR_LED_CONFIG = 10
  • DMX_BRICKLET_FUNCTION_SET_FRAME_CALLBACK_CONFIG = 12
  • DMX_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • DMX_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • DMX_BRICKLET_FUNCTION_RESET = 243
  • DMX_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn DmxBricklet::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:

  • DMX_BRICKLET_FUNCTION_SET_DMX_MODE = 1
  • DMX_BRICKLET_FUNCTION_WRITE_FRAME = 3
  • DMX_BRICKLET_FUNCTION_SET_FRAME_DURATION = 5
  • DMX_BRICKLET_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 8
  • DMX_BRICKLET_FUNCTION_SET_ERROR_LED_CONFIG = 10
  • DMX_BRICKLET_FUNCTION_SET_FRAME_CALLBACK_CONFIG = 12
  • DMX_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • DMX_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • DMX_BRICKLET_FUNCTION_RESET = 243
  • DMX_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn DmxBricklet::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 DmxBricklet::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 DmxBricklet::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:

  • DMX_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • DMX_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • DMX_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • DMX_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • DMX_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • DMX_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • DMX_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • DMX_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn DmxBricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>

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

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

  • DMX_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • DMX_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn DmxBricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>

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

Schreibt 64 Bytes Firmware an die Position die vorher von DmxBricklet::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 DmxBricklet::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:

  • DMX_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • DMX_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • DMX_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • DMX_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn DmxBricklet::get_status_led_config(&self) → ConvertingReceiver<u8>

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

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

  • DMX_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • DMX_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • DMX_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • DMX_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn DmxBricklet::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 DmxBricklet::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 DmxBricklet::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 DmxBricklet::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 DmxBricklet::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 DmxBricklet::set_frame_callback_config(&self, frame_started_callback_enabled: bool, frame_available_callback_enabled: bool, frame_callback_enabled: bool, frame_error_count_callback_enabled: bool) → ConvertingReceiver<()>

Aktiviert/Deaktiviert die verschiedenen Callback. Standardmäßig sind der DmxBricklet::get_frame_started_callback_receiver Callback und der DmxBricklet::get_frame_available_callback_receiver Callback aktiviert, während der DmxBricklet::get_frame_callback_receiver Callback und der DmxBricklet::get_frame_error_count_callback_receiver Callback deaktiviert sind.

Wenn der DmxBricklet::get_frame_callback_receiver Callback aktiviert wird dann kann der DmxBricklet::get_frame_available_callback_receiver Callback deaktiviert werden, da dieser dann redundant ist.

pub fn DmxBricklet::get_frame_callback_config(&self) → ConvertingReceiver<FrameCallbackConfig>

Gibt die Frame Callback Konfiguration zurück, wie von DmxBricklet::set_frame_callback_config 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 DmxBricklet::get_frame_started_callback_receiver(&self) → ConvertingCallbackReceiver<()>

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

Dieser Callback wird ausgelöst sobald ein neuer Frame gestartet wurde. Nachdem dieser Callback empfangen wurde sollten die Daten für den nächsten Frame geschrieben werden.

Für eine Erklärung siehe die Beschreibung in der Funktion DmxBricklet::write_frame.

Der Callback kann mittels DmxBricklet::set_frame_callback_config aktiviert werden.

Dieser Callback wird nur im Master Modus ausgelöst.

pub fn DmxBricklet::get_frame_available_callback_receiver(&self) → ConvertingCallbackReceiver<u32>

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

Dieser Callback wird im Slave Modus ausgelöst, wenn ein neuer Frame vom DMX Master empfangen wurde und nun ausgelesen werden kann. Der Frame muss ausgelesen werden, bevor der Master ein neues Frame schreibt. Siehe DmxBricklet::read_frame für weitere Details.

Der Parameter ist die Frame-Nummer, diese wird für jeden empfangenen Frame um eins erhöht.

Der Callback kann mittels DmxBricklet::set_frame_callback_config aktiviert werden.

Dieser Callback kann nur im Slave Modus ausgelöst werden.

pub fn DmxBricklet::get_frame_callback_receiver(&self) → ConvertingHighLevelCallbackReceiver<u8, FrameResult, FrameLowLevelEvent>

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

Dieser Callback wird aufgerufen sobald ein neuer Frame verfügbar ist (vim DMX Master geschrieben).

Die Größe des Arrays ist gleichbedeutend zu der Anzahl an Kanälen in dem Frame. Jedes Byte stellt einen Kanal dar.

Der Callback kann mittels DmxBricklet::set_frame_callback_config aktiviert werden.

Dieser Callback kann nur im Slave Modus ausgelöst werden.

pub fn DmxBricklet::get_frame_error_count_callback_receiver(&self) → ConvertingCallbackReceiver<FrameErrorCountEvent>

Receiver die mit dieser Funktion erstellt werden, empfangen Frame Error Count-Events.

Dieser Callback wird aufgerufen wenn ein neuer Fehler auftritt. Er gibt die Anzahl der aufgetreten Overrun und Framing Fehler zurück.

Konstanten

DmxBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein DMX Bricklet zu identifizieren.

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

DmxBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines DMX Bricklet dar.