Escient MP-100 - Manual (Page 113)

P AGE 113
F IRE B ALL -MP I NSTALLATION & U SER ’ S G UIDE - M21101-
A PPENDIX D- E XTERNAL C ONTROL P ROTOCOL
Commands and Responses Overview
The external control protocol is standard ASCII based. ESCX is the four letter preamble that is used for all commands. This preamble must
be uppercase. The commands provided in this protocol allow an external control system to navigate the Escient products, get library informa-
tion to build custom user interfaces, perform transport controls, and receive unsolicited feedback on system status.
All external control commands are made up of the preamble (ESCX), command group (01,02,10,20,50,70), sub command (specific task),
specific data (# of data items, and a size of data packet then the actual data packet repeated for the # of data items), and a carriage return end
marker.
External Control Command Structure
DESCRIPTION
PREAMBLE COMMAND
GROUP
SUB COM
-
MAND # DA
TA
ITEMS
DA
TA
ITEM
#1 SIZE DA
TA
#1
DA
TA
ITEM
#2 SIZE DA
TA
#2
END
MARKER
Bytes 4 2 2 3 4 5 4 3 1
Example ESCX 01 08 002 0005 Hello 0003 Bye Carriage Return
The external control commands are broken down into the following Command Groups:
01 – Command Responses
02 – Unsolicited Events
10 – Remote Button / Keyboard Commands
20 – Database Commands
50 – Status Commands
70 – Control Commands