Shell - DMX Bricklet¶

Simple¶

Download (example-simple.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your DMX Bricklet

# Configure Bricklet as DMX master
tinkerforge call dmx-bricklet $uid set-dmx-mode dmx-mode-master

# Write DMX frame with 3 channels
tinkerforge call dmx-bricklet $uid write-frame 255,128,0

Befehlsstruktur¶

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call dmx-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des DMX Bricklet aufzurufen. Der Befehl kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
• --list-functions zeigt eine Liste der bekannten Funktionen des DMX Bricklet an und endet dann

tinkerforge dispatch dmx-bricklet [<option>..] <uid> <callback>¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des DMX Bricklet abzufertigen. Der Befehl kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
• --list-callbacks zeigt eine Liste der bekannten Callbacks des DMX Bricklet an und endet dann

tinkerforge call dmx-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

• --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

• --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

• --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch dmx-bricklet <uid> <callback> [<option>..]¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifische <callback> an und endet dann
• --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen¶

tinkerforge call dmx-bricklet <uid> set-dmx-mode <dmx-mode>¶

Parameter:	<dmx-mode> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
Ausgabe:	keine Ausgabe

Setzt den DMX Modus entweder auf Master oder Slave.

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

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

Für <dmx-mode>:

• dmx-mode-master = 0
• dmx-mode-slave = 1

tinkerforge call dmx-bricklet <uid> get-dmx-mode¶

Ausgabe:	dmx-mode – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt den DMX Modus zurück, wie von set-dmx-mode gesetzt.

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

Für dmx-mode:

• dmx-mode-master = 0
• dmx-mode-slave = 1

tinkerforge call dmx-bricklet <uid> write-frame <frame>¶

Parameter:	<frame> – Typ: Int Array, Länge: variabel, Wertebereich: [0 bis 255]
Ausgabe:	keine Ausgabe

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 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 frame-started Callback.
• Setze alle Kanäle für den nächsten Frame.
• Warte auf 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.

tinkerforge call dmx-bricklet <uid> read-frame¶

Ausgabe:	frame – Typ: Int Array, Länge: variabel, Wertebereich: [0 bis 255] frame-number – Typ: Int, 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 frame-available Callback aufgerufen wurde.

Genereller Ansatz:

• Aufruf von read-frame um das erste Frame zu bekommen.
• Warten auf den frame-available Callback.
• Aufruf von read-frame um das zweite Frame zu bekommen.
• Warten auf den frame-available Callback.
• Und so weiter.

Anstatt das diese Funktion gepollt wird, kann auch der frame 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.

tinkerforge call dmx-bricklet <uid> set-frame-duration <frame-duration>¶

Parameter:	<frame-duration> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100
Ausgabe:	keine Ausgabe

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.

tinkerforge call dmx-bricklet <uid> get-frame-duration¶

Ausgabe:	frame-duration – Typ: Int, 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¶

tinkerforge call dmx-bricklet <uid> get-frame-error-count¶

Ausgabe:	overrun-error-count – Typ: Int, Wertebereich: [0 bis 232 - 1] framing-error-count – Typ: Int, Wertebereich: [0 bis 232 - 1]

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

tinkerforge call dmx-bricklet <uid> set-communication-led-config <config>¶

Parameter:	<config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:	keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <config>:

• communication-led-config-off = 0
• communication-led-config-on = 1
• communication-led-config-show-heartbeat = 2
• communication-led-config-show-communication = 3

tinkerforge call dmx-bricklet <uid> get-communication-led-config¶

Ausgabe:	config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von set-communication-led-config gesetzt.

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

Für config:

• communication-led-config-off = 0
• communication-led-config-on = 1
• communication-led-config-show-heartbeat = 2
• communication-led-config-show-communication = 3

tinkerforge call dmx-bricklet <uid> set-error-led-config <config>¶

Parameter:	<config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:	keine Ausgabe

Setzt die Konfiguration der Error-LED.

Standardmäßig geht die LED an, wenn ein Error auftritt (siehe 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 Symbole sind für diese Funktion verfügbar:

Für <config>:

• error-led-config-off = 0
• error-led-config-on = 1
• error-led-config-show-heartbeat = 2
• error-led-config-show-error = 3

tinkerforge call dmx-bricklet <uid> get-error-led-config¶

Ausgabe:	config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von set-error-led-config gesetzt.

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

Für config:

• error-led-config-off = 0
• error-led-config-on = 1
• error-led-config-show-heartbeat = 2
• error-led-config-show-error = 3

tinkerforge call dmx-bricklet <uid> get-spitfp-error-count¶

Ausgabe:	error-count-ack-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1] error-count-message-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1] error-count-frame – Typ: Int, Wertebereich: [0 bis 232 - 1] error-count-overflow – Typ: Int, 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.

tinkerforge call dmx-bricklet <uid> set-status-led-config <config>¶

Parameter:	<config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:	keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <config>:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call dmx-bricklet <uid> get-status-led-config¶

Ausgabe:	config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von set-status-led-config gesetzt.

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

Für config:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call dmx-bricklet <uid> get-chip-temperature¶

Ausgabe:	temperature – Typ: Int, 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.

tinkerforge call dmx-bricklet <uid> reset¶

Ausgabe:	keine Ausgabe

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.

tinkerforge call dmx-bricklet <uid> get-identity¶

Ausgabe:

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: Int Array, Länge: 3 0: major – Typ: Int, Wertebereich: [0 bis 255] 1: minor – Typ: Int, Wertebereich: [0 bis 255] 2: revision – Typ: Int, Wertebereich: [0 bis 255] firmware-version – Typ: Int Array, Länge: 3 0: major – Typ: Int, Wertebereich: [0 bis 255] 1: minor – Typ: Int, Wertebereich: [0 bis 255] 2: revision – Typ: Int, Wertebereich: [0 bis 255] device-identifier – Typ: Int, 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¶

tinkerforge call dmx-bricklet <uid> set-frame-callback-config <frame-started-callback-enabled> <frame-available-callback-enabled> <frame-callback-enabled> <frame-error-count-callback-enabled>¶

Parameter:	<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
Ausgabe:	keine Ausgabe

Aktiviert/Deaktiviert die verschiedenen Callback. Standardmäßig sind der frame-started Callback und der frame-available Callback aktiviert, während der frame Callback und der frame-error-count Callback deaktiviert sind.

Wenn der frame Callback aktiviert wird dann kann der frame-available Callback deaktiviert werden, da dieser dann redundant ist.

tinkerforge call dmx-bricklet <uid> get-frame-callback-config¶

Ausgabe:	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¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch dmx-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

tinkerforge dispatch dmx-bricklet <uid> frame-started¶

Ausgabe:	keine Ausgabe

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.

Der Callback kann mittels set-frame-callback-config aktiviert werden.

Dieser Callback wird nur im Master Modus ausgelöst.

tinkerforge dispatch dmx-bricklet <uid> frame-available¶

Ausgabe:	frame-number – Typ: Int, 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 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.

tinkerforge dispatch dmx-bricklet <uid> frame¶

Ausgabe:	frame – Typ: Int Array, Länge: variabel, Wertebereich: [0 bis 255] frame-number – Typ: Int, 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.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit None für frame ausgelöst.

tinkerforge dispatch dmx-bricklet <uid> frame-error-count¶

Ausgabe:	overrun-error-count – Typ: Int, Wertebereich: [0 bis 232 - 1] framing-error-count – Typ: Int, 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.

tinkerforge call dmx-bricklet <uid> set-bootloader-mode <mode>¶

Parameter:	<mode> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:	status – Typ: Int, Wertebereich: Siehe Symbole

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 Symbole sind für diese Funktion verfügbar:

Für <mode>:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

Für status:

• bootloader-status-ok = 0
• bootloader-status-invalid-mode = 1
• bootloader-status-no-change = 2
• bootloader-status-entry-function-not-present = 3
• bootloader-status-device-identifier-incorrect = 4
• bootloader-status-crc-mismatch = 5

tinkerforge call dmx-bricklet <uid> get-bootloader-mode¶

Ausgabe:	mode – Typ: Int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.

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

Für mode:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call dmx-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameter:	<pointer> – Typ: Int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Ausgabe:	keine Ausgabe

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.

tinkerforge call dmx-bricklet <uid> write-firmware <data>¶

Parameter:	<data> – Typ: Int Array, Länge: 64, Wertebereich: [0 bis 255]
Ausgabe:	status – Typ: Int, 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.

tinkerforge call dmx-bricklet <uid> write-uid <uid>¶

Parameter:	<uid> – Typ: Int, Wertebereich: [0 bis 232 - 1]
Ausgabe:	keine Ausgabe

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.

tinkerforge call dmx-bricklet <uid> read-uid¶

Ausgabe:	uid – Typ: Int, 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.