932502G / 0618 7. FIRMWARE COMMANDS AND RESPONSES
7.1.4. Dollar Response Records
SHOW and STEP commands respond with a single dollar response record followed immediately
by a percent response record. All valid dollar response records for each command are listed in
the command dictionary.
The following list provides the general form of each dollar response record for the MCB API. In
this list, lower case letters represent numeric values. The letters “ccc” always represent an 8-bit
unsigned checksum of all characters on the record up to but not including the checksum
characters, and <CR> represents the ASCII carriage return character.
$Axxxccc<CR> xxx is a single 8-bit unsigned number.
$Cxxxxxccc<CR> xxxxx is a single 16-bit unsigned number.
$Dxxxxxyyyyyccc<CR> xxxxx and yyyyy are 16-bit unsigned numbers.
$Exxxxxccc<CR> xxxxx is a single 16-bit alarm mask.
$Fssss...<CR> ssss... is a variable length ASCII character sequence (no checksum
is sent with this record).
$Gxxxxxxxxxxccc<CR> xxxxxxxxxx is a single 32-bit unsigned number.
$IT<CR> True response to a SHOW command (no checksum).
$IF<CR> False response to a SHOW command (no checksum).
$Jxxxxxyyyyy...ccc<CR> Response to SHOW_CONFIGURATION command.
$Mxxxxxxxxxx...ccc<CR> Response to SHOW_STATUS command.
$Nxxxyyyzzzccc<CR> xxx, yyy, and zzz are 8-bit unsigned numbers.
7.1.5. Command Catalog
This section lists each command with a description of its operation. The descriptions include a
list of any unusual responses that may result. The no-errors response from a command is a
%000000069<CR> (Ethernet interface); or a macro error code of 0 and a micro error code of 0
(USB interface). Though syntax and communication error responses may result from any com-
mand, in practice, these error responses rarely occur on systems with reliable communication
hardware running debugged software.
The commands are listed in alphabetical order, each starting with a command prototype line.
Uppercase letters, numeric digits, blank space, and special symbols such as the underscore “_”
and comma 13 “,” in the prototype line are literal text to be sent to the MCB exactly as they
appear. Lowercase letters in the prototype line represent numeric values as described in the
accompanying text; they should not be sent literally to the MCB but should be replaced by an
appropriate numeric value. Lower-case letters enclosed in quotes represent alphanumeric
character strings rather than numerical values. Items in the command prototype that are sur-
rounded by square brackets “[...]” are optional items and are not always required. In this section
81
To Next Page
Loading...
Need help?
General
