102 | Appendices ~ Appendix E: Serial Commands |
Appendix E: Serial Commands
The XAP 400 accepts serial commands through the serial port or the expansion bus. The commands in this manual pertain only to the XAP 400.
Conventions
The following typographic conventions are used in this document to describe the different serial commands. use the Command structure section and the examples as a guide when creating your serial commands.
Convention Description
<X> | Parameters enclosed in < > indicate a mandatory parameter. |
[X]Parameters enclosed in [ ] indicate an optional parameter.
Parameters separated by a - indicate a range between the values. | |
4,7,9 | Parameters separated by a , indicate a list of available values. |
MREF | Words in uppercase bold indicate command text. |
DEVICE | Indicates the device type and device number on the expansion bus network. It is composed of a |
| device type character and a device number. The device type for the XAP 400 is always 7 and the |
| device ID will always be |
Command structure
Commands can be either UPPER CASE or lower case. Also, extra spaces or tabs between arguments in text commands are allowed. Return values are always in upper case. In order for a command to be recognized by the serial port, the command must be terminated by a carriage return.
The structure of serial commands is as follows: #DEVICE COMMAND [X] [X]
# | indicates the start of a command line |
DEVICE | represents the device type and device number |
COMMAND | is the command text |
[X] [X] | represents any additional options in the order that they |
| appear in the command descriptions that follow |
Example
A command to enable
#70 AA 1 1. In this command line, 7=XAP 400, 0=unit 0, AA=command, 1=Telco channel 1, 1=on state. If a command calls for a "null" value, leave a blank in the command line. For example, "#70 AA" would return the current
Command responses will have a carriage return line feed. Example: #70 AA 1 1 carriage return line feed.
