TCP/IP - DMX Bricklet¶

Grundfunktionen¶

BrickletDMX.set_dmx_mode¶

Funktions-ID:	1
Anfrage:	dmx_mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0
Antwort:	keine Antwort

Setzt den DMX Modus entweder auf Master oder Slave.

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

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für dmx_mode:

• 0 = Master
• 1 = Slave

BrickletDMX.get_dmx_mode¶

Funktions-ID:	2
Anfrage:	keine Nutzdaten
Antwort:	dmx_mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0

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

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für dmx_mode:

• 0 = Master
• 1 = Slave

BrickletDMX.write_frame_low_level¶

Funktions-ID:	3
Anfrage:	frame_length – Typ: uint16, Wertebereich: [0 bis 29] frame_chunk_offset – Typ: uint16, Wertebereich: [0 bis 216 - 1] frame_chunk_data – Typ: uint8[60], Wertebereich: [0 bis 255]
Antwort:	keine Antwort

Schreibt einen 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 CALLBACK_FRAME_STARTED 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 set_frame_duration.

Genereller Ansatz:

• Setze Frame Duration auf einen Wert welcher der Anzahl der Bilder pro Sekunde entspricht die erreicht werden sollen.
• Setze alle Kanäle für den ersten Frame.
• Warte auf CALLBACK_FRAME_STARTED Callback.
• Setze alle Kanäle für den nächsten Frame.
• Warte auf CALLBACK_FRAME_STARTED Callback.
• Und so weiter.

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

Diese Funktion kann nur im Master Modus aufgerufen werden.

BrickletDMX.read_frame_low_level¶

Funktions-ID:	4
Anfrage:	keine Nutzdaten
Antwort:	frame_length – Typ: uint16, Wertebereich: [0 bis 29] frame_chunk_offset – Typ: uint16, Wertebereich: [0 bis 216 - 1] frame_chunk_data – Typ: uint8[56], Wertebereich: [0 bis 255] frame_number – Typ: uint32, Wertebereich: [0 bis 232 - 1]

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 CALLBACK_FRAME_AVAILABLE Callback aufgerufen wurde.

Genereller Ansatz:

• Aufruf von read_frame_low_level um das erste Frame zu bekommen.
• Warten auf den CALLBACK_FRAME_AVAILABLE Callback.
• Aufruf von read_frame_low_level um das zweite Frame zu bekommen.
• Warten auf den CALLBACK_FRAME_AVAILABLE Callback.
• Und so weiter.

Anstatt das diese Funktion gepollt wird, kann auch der CALLBACK_FRAME_LOW_LEVEL Callback genutzt werden. Der Callback kann mit 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.

BrickletDMX.set_frame_duration¶

Funktions-ID:	5
Anfrage:	frame_duration – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100
Antwort:	keine Antwort

Setzt die Dauer eines Frames.

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.

BrickletDMX.get_frame_duration¶

Funktions-ID:	6
Anfrage:	keine Nutzdaten
Antwort:	frame_duration – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100

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

Fortgeschrittene Funktionen¶

BrickletDMX.get_frame_error_count¶

Funktions-ID:	7
Anfrage:	keine Nutzdaten
Antwort:	overrun_error_count – Typ: uint32, Wertebereich: [0 bis 232 - 1] framing_error_count – Typ: uint32, Wertebereich: [0 bis 232 - 1]

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

BrickletDMX.set_communication_led_config¶

Funktions-ID:	8
Anfrage:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
Antwort:	keine Antwort

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 Bootloadermodus befindet ist die LED aus.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Communication

BrickletDMX.get_communication_led_config¶

Funktions-ID:	9
Anfrage:	keine Nutzdaten
Antwort:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

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

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Communication

BrickletDMX.set_error_led_config¶

Funktions-ID:	10
Anfrage:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
Antwort:	keine Antwort

Setzt die Konfiguration der Error-LED.

Standardmäßig geht die LED an, wenn ein Error auftritt (siehe CALLBACK_FRAME_ERROR_COUNT 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 Bootloadermodus befindet ist die LED aus.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Error

BrickletDMX.get_error_led_config¶

Funktions-ID:	11
Anfrage:	keine Nutzdaten
Antwort:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

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

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Error

BrickletDMX.get_spitfp_error_count¶

Funktions-ID:	234
Anfrage:	keine Nutzdaten
Antwort:	error_count_ack_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1] error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1] error_count_frame – Typ: uint32, Wertebereich: [0 bis 232 - 1] error_count_overflow – Typ: uint32, 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.

BrickletDMX.set_status_led_config¶

Funktions-ID:	239
Anfrage:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
Antwort:	keine Antwort

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Status

BrickletDMX.get_status_led_config¶

Funktions-ID:	240
Anfrage:	keine Nutzdaten
Antwort:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

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

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Status

BrickletDMX.get_chip_temperature¶

Funktions-ID:	242
Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int16, 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.

BrickletDMX.reset¶

Funktions-ID:	243
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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.

BrickletDMX.get_identity¶

Funktions-ID:	255
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: char[8] connected_uid – Typ: char[8] position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] firmware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] device_identifier – Typ: uint16, 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 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. 

Konfigurationsfunktionen für Callbacks¶

BrickletDMX.set_frame_callback_config¶

Funktions-ID:	12
Anfrage:	frame_started_callback_enabled – Typ: bool, Standardwert: true frame_available_callback_enabled – Typ: bool, Standardwert: true frame_callback_enabled – Typ: bool, Standardwert: false frame_error_count_callback_enabled – Typ: bool, Standardwert: false
Antwort:	keine Antwort

Aktiviert/Deaktiviert die verschiedenen Callback. Standardmäßig sind der CALLBACK_FRAME_STARTED Callback und der CALLBACK_FRAME_AVAILABLE Callback aktiviert, während der CALLBACK_FRAME_LOW_LEVEL Callback und der CALLBACK_FRAME_ERROR_COUNT Callback deaktiviert sind.

Wenn der CALLBACK_FRAME_LOW_LEVEL Callback aktiviert wird dann kann der CALLBACK_FRAME_AVAILABLE Callback deaktiviert werden, da dieser dann redundant ist.

BrickletDMX.get_frame_callback_config¶

Funktions-ID:	13
Anfrage:	keine Nutzdaten
Antwort:	frame_started_callback_enabled – Typ: bool, Standardwert: true frame_available_callback_enabled – Typ: bool, Standardwert: true frame_callback_enabled – Typ: bool, Standardwert: false frame_error_count_callback_enabled – Typ: bool, Standardwert: false

Gibt die Frame Callback Konfiguration zurück, wie von set_frame_callback_config gesetzt.

Callbacks¶

BrickletDMX.CALLBACK_FRAME_STARTED¶

Funktions-ID:	14
Antwort:	keine Nutzdaten

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

Der Callback kann mittels set_frame_callback_config aktiviert werden.

Dieser Callback wird nur im Master Modus ausgelöst.

BrickletDMX.CALLBACK_FRAME_AVAILABLE¶

Funktions-ID:	15
Antwort:	frame_number – Typ: uint32, Wertebereich: [0 bis 232 - 1]

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 read_frame_low_level 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 set_frame_callback_config aktiviert werden.

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

BrickletDMX.CALLBACK_FRAME_LOW_LEVEL¶

Funktions-ID:	16
Antwort:	frame_length – Typ: uint16, Wertebereich: [0 bis 29] frame_chunk_offset – Typ: uint16, Wertebereich: [0 bis 216 - 1] frame_chunk_data – Typ: uint8[56], Wertebereich: [0 bis 255] frame_number – Typ: uint32, Wertebereich: [0 bis 232 - 1]

Dieser Callback wird aufgerufen sobald ein neuer Frame verfügbar ist (vom 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 set_frame_callback_config aktiviert werden.

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

BrickletDMX.CALLBACK_FRAME_ERROR_COUNT¶

Funktions-ID:	17
Antwort:	overrun_error_count – Typ: uint32, Wertebereich: [0 bis 232 - 1] framing_error_count – Typ: uint32, Wertebereich: [0 bis 232 - 1]

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

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.

BrickletDMX.set_bootloader_mode¶

Funktions-ID:	235
Anfrage:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:	status – Typ: uint8, Wertebereich: Siehe Bedeutungen

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

• 0 = Bootloader
• 1 = Firmware
• 2 = Bootloader Wait For Reboot
• 3 = Firmware Wait For Reboot
• 4 = Firmware Wait For Erase And Reboot

Für status:

• 0 = OK
• 1 = Invalid Mode
• 2 = No Change
• 3 = Entry Function Not Present
• 4 = Device Identifier Incorrect
• 5 = CRC Mismatch

BrickletDMX.get_bootloader_mode¶

Funktions-ID:	236
Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen

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

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

• 0 = Bootloader
• 1 = Firmware
• 2 = Bootloader Wait For Reboot
• 3 = Firmware Wait For Reboot
• 4 = Firmware Wait For Erase And Reboot

BrickletDMX.set_write_firmware_pointer¶

Funktions-ID:	237
Anfrage:	pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:	keine Antwort

Setzt den Firmware-Pointer für 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.

BrickletDMX.write_firmware¶

Funktions-ID:	238
Anfrage:	data – Typ: uint8[64], Wertebereich: [0 bis 255]
Antwort:	status – Typ: uint8, Wertebereich: [0 bis 255]

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

BrickletDMX.write_uid¶

Funktions-ID:	248
Anfrage:	uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Antwort:	keine Antwort

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.

BrickletDMX.read_uid¶

Funktions-ID:	249
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: uint32, 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.