EA-1 User Manual
33
Chapter 6 - Details of User Commands:
The intended use of the EA-1 Adapter is 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:
These rules apply for all communication protocols available for the device. Any exceptions will be listed separately
below.
All commands and replies 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 13 10, Hex 0x0D 0x0A, \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 are terminated by “[CR] [LF]“
Replies begin with a “*” symbol (ASCII code 0x2A) if there are no errors
Replies 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.
Using the USB Connection:
The USB connection on the EA-1 device uses a Virtual COM Port, or “VCP”. This allows the PC to connect to the EA-1
device in the same way it would connect to a regular RS232 device, using the same tools as used to open and
communicate with a COM port. Any standard RS232 terminal programs such as “HyperTerminal” or “Termite” can be
used. Standard settings are 115200 baud, no parity, 1 stop bit, no hardware control.
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).