9.2.3 Commands and Responses
Command execution starts when the command line has been completed (<CR><LF>) and ends when the result code for the command is sent consisting of either a success or error response.
The formatting of these responses depends on the current verbosity level set by the ATV command. All responses consist of the format <RESPONSE><CR><LF>.
Level |
Success Response Format |
Error Response Format |
---|---|---|
0 |
0 |
1 |
1 |
0 |
1:<STATUS_CODE> |
2 |
OK |
ERROR |
3 |
OK |
ERROR:<STATUS_CODE> |
4 |
OK |
ERROR:<STATUS_MSG> ERROR:<STATUS_CODE> (if no message defined) |
5 |
OK |
ERROR:<STATUS_CODE>[,<STATUS_MSG>] |
Field |
Type |
Description |
---|---|---|
<STATUS_CODE> |
Integer |
Numeric status code, see Status Response Codes |
<STATUS_MSG> |
String |
Descriptive text detailing the error |
If a command requires longer to process the request, then the success response will be used to indicate that the command was accepted. Command processing continues asynchronously, further responses are indicated via AECs.
<CR>+CMDNAME:ERRORRSP<CR><LF>
<CR>+SOCKBR:ERROR:4<CR><LF>