30
Chapter 6 - Details of User Commands:
The intended use of the EA-1 Adapter is primarily for OEM customers who wish to embed the device inside their own
laser system. In order to allow customers to control the device using their own software package, a set of “User
Commands” are provided which allow control and query of all the features of the device.
This chapter contains general rules about using the user commands, and includes a complete list of all the user
commands available.
General Rules:
All commands and replies from the EA-1 Adapter use ASCII symbols
All user commands begin with the “$” symbol (ASCII code 0x24)
All user commands consist of a two letter code, in either upper or lower case ASCII characters
All user commands should be terminated by “[CR] [LF]” (ASCII codes 0x13 0x10, \r \n in “C” code)
User commands can optionally contain parameters in addition to the two letter code command (details below)
The first parameter of a command can be attached to the command or separated with at least 1 space, for
example “$WN 1” or “$WN1”. Both are OK
Any leading or trailing spaces (ASCII code 0x20) are ignored, but the first 3 symbols must be “$xx” where “xx” is
the command code.
All subsequent parameters, in the event that there are more than one, should be separated by 1 or more spaces
All replies from the EA-1 are terminated by “[CR] [LF]“
Replies from the EA-1 begin with a “*” symbol (ASCII code 0x2A) if there are no errors
Replies from the EA-1 begin with a “?” symbol (ASCII code 0x3F) if there is any kind of error: for example, the
command is unknown (?UC) or contains an incorrect parameter
All commands, both query commands and action commands, respond with “*” or “?”, sometimes with extra text
describing what happened, acknowledging the new status or providing instructions. Details are provided with
each command as appropriate.
Note:
In the sections below detailing all the User Commands, all commands and replies should be terminated by [CR]
[LF] symbols. These symbols are omitted from the text for clarity.
Note:
The < > symbols surrounding text indicates a parameter to be filled in by the user as appropriate or a value
returned by the device as appropriate.
Special Rules When Using Telnet:
If using a Telnet connection (via a “terminal” or direct using software code), the following extra rules apply:
All commands are echoed back by the device before the reply is sent (see $EE command)
All replies contain a “>” symbol after the final “[CR] [LF]”
The “>” symbol at the end should not be used as the “end of reply” symbol because further “>” symbols may
appear inside the bulk of the reply (before the end).
UDP Protocol:
If using a UDP connection, a special protocol is defined to enable sending commands to the EA-1 device and receive
back replies. This sub-section details the special UDP protocol.
In order to send commands to the EA-1 device via UDP: