Automation Control Protocol
The SOS Automation Interface (also known as the show floor control protocol) is available via a TCP connection to the main SOS system. This interface allows extensive control of the operation of SOS by an external computer, as a coordinated part of a larger exhibit. For example, SOS could be synchronized with films or PowerPoint display programs, controlled by an interactive kiosk, or run on an automatic daily schedule of timed presentations.
Establishing and Using a ConnectionPermalink to Establishing and Using a Connection
To use the SOS Automation Interface, establish a TCP connection to socket 2468 on the main SOS host. The SOS Automation Interface uses an ASCII line-oriented protocol. Each command is a single line of text. Every command will result in a response from the SOS system. After establishing the TCP connection, it may be kept open and used for multiple commands, but the very first command must be the word “enable”. This is neither an actionable command nor a real password, but is used as a simple-minded way to avoid dealing with random socket probes and scans.
Command responses are also ASCII and line-oriented. The error response is the letter “E” (for Error) followed by a two-digit error code, all on a single line. Future error codes may be more precise, but at present this is almost always the string “E04”.
The default successful command response is the letter “R” (for Ready) on a single line. This indicates successful completion of commands that have no return value (e.g. stop). It also indicates success and the end of the list for commands that return more than one line (e.g. get_clip_info *). Commands that always return a single line of information (e.g. get_frame_count) return only that line of information in the successful case, and don’t return an “R” character.