Skip to main content

 

Electronic Theatre Controls Inc

Eos Family Serial Command Syntax

Eos and Ion versions 1.4.2 and higher, Element 1.6 and higher, and all versions of Gio and Eos Ti support serial control of the system. Network UDP was added in version 1.9.5.

The serial interface allows text to be sent to Eos Family consoles through I/O Gateways. (The physical serial ports on older Ion consoles and Eos/Ion RPUs are not currently supported). Also, as of version 1.9.5, the Eos Family supports both transmitting and receiving UDP string messages via an Ethernet network.  The format for the commands into an Eos family console remains the same.

In Browser->Setup->Show Control, there are buttons to enable and disable serial commands, and to specify the serial group(s) that is listened to. The serial group should match the Serial Group ID set on the I/O Gateway in Gateway Configuration Editor. All text will be stored until a '\r' or '#' is encountered to determine the end of the command. '#' and '\r' also serve as the Enter key for the command line.

If the text begins with a '$', the text that follows it, up until the next '\r' or '#', will be sent to the command line of user 0 and processed as if the user had typed it.
Ex: $ Chan 1 Thru 10 at Full # sets channels 1 thru 10 to full, manually.

All other text will be sent to the Eos event handler, allowing the following formats:

Go 1 fires playback 1
Cue 1 2 run cue 2 from list 1, on the appropriate fader
Cue 1 fire pending cue from list 2
GoCue0 1 GoCue0 playback 1
Release 1 release playback 1
Off 1 turn playback 1 off
Resume 1 resume playback 1
Assert 1 assert playback 1
Stop 1 stop playback 1
Stop Cue 1 2 stop cue 2 from list 1 if it is running
Resume Cue 1 2 resume cue 2 from list 1 if it is stopped
SubAssert 1 assert submaster 1
SubUnload 1 unload sub 1
SubDown 5 presses sub 5's bump button down
SubUp 5 releases sub 5's bump button
SubMove 1 50 sets Sub 1 to 50
PlaybackMove 1 50 sets playback 1 to 50 percent
Grandmaster 1 100 sets grandmaster 1 to full (there's currently only 1 grandmaster)
Macro 1 Fires Macro 1 on User 0

Abbreviations:
M = can be used instead of Macro
Q = can be used instead of Cue

Notes about Syntax:

  1. Multiword commands ("Go To Cue") need an underscore between the words ("Go_To_Cue").
  2. Commands are case insensitive. (Go_To_Cue is the same as go_to_cue or GO_TO_CUE).
  3. The syntax is the exact same as what you see on the command line, or in the macro editor (for non-command line commands).
  4. When in doubt, add a space between each element in the string, including after elements like $ or <U#>
  5. When you add <U#> to the command line, the command will be sent to user #'s command line. Example: "<U10> $ Chan 1 at Full #" will send channel 1 to Full across the system, but the command will have passed through User 10's command line.
  • Was this article helpful?