Die Terminal Schnittstelle
Die Terminal Schnittstelle wurde in DMXControl 2 implementiert, um den Zugriff über Ethernet auf das Programm zu ermöglichen. DMXControl 2 erwartet die Verbindung auf Port 2145. Jedes Programm, welches Zeichenketten (Strings) verschicken kann ist damit in der lage DMXControl 2 fernzusteuern. Ein Beispiel ist das bekannte Programm "Putty".
Anwendung
Die Schnittstelle wird unter anderem von PDA-2-DMXC und vom Web-Interface bzw. der PHP-Klasse sowie verschiedener anderer Steuerungen (beispielsweise für Android) verwendet. Die Schnittstelle ist öffentlich, deshalb ist es auch für jeden möglich über ein beliebiges Programm auf DMXControl 2 zuzugreifen.
Funktionsweise
Die Schnittstelle funktioniert bidirektional, es können also Daten gesendet und angefragt werden. Eine Tabelle der möglichen Befehle ist weiter unten zu finden. Manche Befehle liefern nach dem Ausführen einen Wert als Bestätigung zurück, andere nicht.
Jeder Befehl der an DMXControl 2 gesendet wird, muss mit einem Zeilenumbruch (in Java und C# "\n") abgeschlossen werden.
Schnittstelle
Die folgende Tabelle ist eine Liste der Befehle, und wie die Antworten von DMXControl 2 aussehen. Entwickler spielen am besten etwas mit einem Terminalprogramm wie Putty herum. Dann erkennt man sofort, wie die Antworten aussehen. Alle Befehle werden von DMXControl 2 unabhängig von Groß / Kleinschreibung interpretiert. Anstelle von SetChannel kann also auch sEtChAnNeL ;-) geschrieben werden.
Die Abkürzung CV steht für ChannelValue und CVC für ChannelValueChanged
| Anfrage an DMXC 2 | Antwort von DMXC 2 | Beschreibung | Beispiel |
| SetChannel Channel Wert | CV Channel Wert | Setzt den Kanal Channel auf den Wert Wert. | SetChannel 1 200 -> CV 1 200 |
| SC Channel Wert | CV Channel Wert | Kurzschreibweise für SetChannel. | SC 1 200 -> CV 1 200 |
| GetChannel Channel | CV Channel Wert | Fragt den Wert des Kanals Channel an. | GetChannel 1 -> CV 1 200 |
| GC Channel | CV Channel Wert | Kurzschreibweise für GetChannel. | GC 1 -> CV 1 200 |
| GetAllDevices | Liste der Geräte | Fragt alle in DMXControl vorhandenen Geräte ab. | GetAllDevices ->
1. PAR-1 2. PAR-2 ... 10. Botex SP-1500 Stroboskop |
| GetDeviceInfo DeviceID | Geräteinformationen | Fragt genauere Informationen zum Gerät mit der Nummer DeviceID ab. Dabei existieren für PanTilt drei Möglichkeiten: No, Coarse, Fine. Bei Coarse oder Fine folgen die Kanäle von Pan Tilt, bei einem Scanner also: PanTilt: Coarse 0 1 bei einem 16 bit Scanner PanTilt: Fine 0 1 14 15. Die Reihenfolge ist dabei Pan Tilt PanFine TiltFine. Nach Channels: Anzahl wird eine Liste mit allen Namen der Kanäle angehängt, wie sie im DDF hinterlegt sind. | GetDeviceInfo 10 ->
Name: Botex SP-1500 Stroboskop StartAddress: 257 PanTilt: No Channels: 2 Channel1: Frequenz Channel2: Helligkeit |
| StartChannelNotification StartChannel EndChannel | Keine | Aktiviert die Asynchrone Information über Kanaländerungen. Wenn sich in DMXControl ein Kanal zwischen StartChannel und EndChannel ändert, sendet DMXControl eine Nachricht mit dem neuen Wert. Ein weiteres senden von StartChannelNotification überschreibt den alten Bereich. | StartChannelNotification 1 10. Nach Wertänderung von Kanal 5 auf 255: -> CVC 5 255 |
| StopChannelNotification | Keine | Deaktiviert die Benachrichtigung über Kanaländerungen. | StopChannelNotification |
| GetCommandPossibilities Dropdown-Index Vorgänger-Index | Liste der Möglichkeiten | Ein Befehl setzt sich aus einzelnen Teilen zusammen. Modul, Gerät/Funktion, Kanal, .... Da die folgende Auswahl auf der vorhergehenden basiert muss der reihe nach von vorne abgefragt werden. Mit GetCommandPossibilities 1 erhält man eine Liste der Modulmöglichkeiten. Jede Möglichkeit hat eine ID. Mit GetCommandPossibilities 2 2 erhält man die Auswahl für Gerät/Funktion, auf Basis von Modul 2. | GetCommandPossibilities 1 ->
1. Geräte 2. Audiotrack ... |
| RunCommand Index1 Index2 Index3 Flags Value | Keine | Mit diesem Command führt man den Befehl aus. Index1, Index2 und Index3 sind dabei die Indizes von GetCommandPossibilities.
Flags ist ein binär codierter Integer. Bit 0 steht für Umschalt-Modus und Bit 1 für Angegebenen Wert verwenden. Value ist ein DMX-Wert in Prozent von 0.000 bis 100.000 (als 16Bit Integer-Wert). Der Integer-Wert berechnet sich aus: Integer-Wert = DMX-Prozentwert * (100000 / 100%) |
RunCommand 2 5 3 0 |