Abbreviated ASCII
This message format is designed to make entering and viewing commands and logs simple. The data is represented as simple ASCII characters, separated by spaces or commas and arranged in an easy to understand format. There is no 32-bit CRC for error detection because it is meant for viewing by the user.
The Abbreviated ASCII message header structure is described in Table: Abbreviated ASCII Message Header Structure.
Field |
Field Name |
Field Type |
Description |
Ignored on Input |
1 |
Sync |
Char |
Sync character. The Abbreviated ASCII message is always preceded by a single ‘<’ symbol |
N |
2 |
Message |
Char[] |
The ASCII name of the log or command |
N |
3 |
Port |
Char[] |
The name of the port from which the log was generated. The string is made up of the port name followed by an _x where x is a number from 1 to 31 denoting the virtual address of the port. If no virtual address is indicated, it is assumed to be address 0 |
Y |
4 |
Sequence # |
Long |
Used for multiple related logs. It is a number that counts down from N-1 to 0, where 0 means it is the last one of the set. Most logs only come out one at a time in which case this number is 0 |
N |
5 |
% Idle Time |
Float |
The minimum percentage of time the processor is idle, calculated once per second |
Y |
6 |
Time Status |
Enum |
The value indicates the quality of the GPS reference time (see Table: GPS Reference Time Status) |
Y |
7 |
Week |
Ulong |
GPS reference week number |
Y |
8 |
Seconds |
GPSec |
Seconds from the beginning of the GPS reference week; accurate to the millisecond level |
Y |
9 |
Receiver Status |
Ulong |
An eight digit hexadecimal number representing the status of various hardware and software components of the receiver (see Table: Receiver Status) |
Y |
10 |
Reserved |
Ulong |
Reserved for internal use |
Y |
11 |
Receiver |
Ulong |
A value (0 - 65535) representing the receiver software build number |
Y |
12 |
CR/LF |
Char |
A carriage return / line feed indicates the end of the header |
N |
Example Command:
log pppsatsa ontime 1
Resultant Log:
<PPPSATS COM1 0 80.0 FINESTEERING 1735 345300.000 02000000 ce3f 44027
< 12
< GPS 3 GOOD 00000003
< GPS 5 GOOD 00000003
< GPS 6 GOOD 00000003
< GPS 7 GOOD 00000003
< GPS 8 GOOD 00000003
< GPS 10 GOOD 00000003
< GPS 13 GOOD 00000003
< GPS 16 GOOD 00000003
< GPS 19 GOOD 00000003
< GPS 23 GOOD 00000003
< GPS 26 GOOD 00000003
< GPS 28 GOOD 00000003
The array of 12 entries are offset from the left hand side and start with ‘<’.