Examples
How to use this page
The examples shown on this page combine the application and transport layers to show the actual bytes on the physical serial link.
When developing against this document, be aware of the separation between the transport layer (CRC, encoding, and encapsulation) and the application layer (operation codes, parameters).
Be aware that the byte offsets described in the application layer always refer to the application layer, and not the byte offsets after encoding for the transport layer.
Module Configuration
CFG_W Configuration Write
The asset sends a CFG_WR request setting payload acknowledgement bit = 1, add geolocation bit = 1, ephemeris enable = 0, deep sleep enable = 0, payload ack event pin mask = 1, reset notification event pin mask = 1. This give 3 bytes of parameters: 0x03 (0b0011), 0x00, 0x03 (0b11).
| Start | ID | Parameters | Checksum | End | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| STX | CFG_WR=0x05 | 0x03 0x00 0x03 | LSB | MSB | ETX | ||||||||
| 0x02 | 0x30 | 0x35 | 0x30 | 0x33 | 0x30 | 0x30 | 0x30 | 0x33 | 0x42 | 0x36 | 0x35 | 0x31 | 0x03 |
The module would reply with a CFG_WA:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | CFG_WA=0x85 | None | LSB | MSB | ETX | |||
| 0x02 | 0x38 | 0x35 | None | 0x44 | 0x44 | 0x32 | 0x30 | 0x03 |
WIF_W Wi-Fi Configuration Write
The Asset sends a WIF_WR request. Some example details are used here:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | WIF_WR=0x06 | WLAN_SSID=“my_wifi_ssid” WLAN_KEY=“my_wifi_password“ AUTH_TOKEN=“6nxGR4eWYb4R8fEsXx2h1hGoR6nvku2TvGvTuFzxiGYPpICAAroZKttHnzXTQSLEilvCTT7r7E7urZ7iEW42fdibmXG4ROQz” | LSB | MSB | ETX | |||
| 0x02 | 0x30 | 0x36 | 0x36 0x44 0x37 0x39 0x35 0x46 0x37 0x37 0x36 0x39 0x36 0x36 0x36 0x39 0x35 0x46 0x37 0x33 0x37 0x33 0x36 0x39 0x36 0x34 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x36 0x44 0x37 0x39 0x35 0x46 0x37 0x37 0x36 0x39 0x36 0x36 0x36 0x39 0x35 0x46 0x37 0x30 0x36 0x31 0x37 0x33 0x37 0x33 0x37 0x37 0x36 0x46 0x37 0x32 0x36 0x34 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x33 0x36 0x36 0x45 0x37 0x38 0x34 0x37 0x35 0x32 0x33 0x34 0x36 0x35 0x35 0x37 0x35 0x39 0x36 0x32 0x33 0x34 0x35 0x32 0x33 0x38 0x36 0x36 0x34 0x35 0x37 0x33 0x35 0x38 0x37 0x38 0x33 0x32 0x36 0x38 0x33 0x31 0x36 0x38 0x34 0x37 0x36 0x46 0x35 0x32 0x33 0x36 0x36 0x45 0x37 0x36 0x36 0x42 0x37 0x35 0x33 0x32 0x35 0x34 0x37 0x36 0x34 0x37 0x37 0x36 0x35 0x34 0x37 0x35 0x34 0x36 0x37 0x41 0x37 0x38 0x36 0x39 0x34 0x37 0x35 0x39 0x35 0x30 0x37 0x30 0x34 0x39 0x34 0x33 0x34 0x31 0x34 0x31 0x37 0x32 0x36 0x46 0x35 0x41 0x34 0x42 0x37 0x34 0x37 0x34 0x34 0x38 0x36 0x45 0x37 0x41 0x35 0x38 0x35 0x34 0x35 0x31 0x35 0x33 0x34 0x43 0x34 0x35 0x36 0x39 0x36 0x43 0x37 0x36 0x34 0x33 0x35 0x34 0x35 0x34 0x33 0x37 0x37 0x32 0x33 0x37 0x34 0x35 0x33 0x37 0x37 0x35 0x37 0x32 0x35 0x41 0x33 0x37 0x36 0x39 0x34 0x35 0x35 0x37 0x33 0x34 0x33 0x32 0x36 0x36 0x36 0x34 0x36 0x39 0x36 0x32 0x36 0x44 0x35 0x38 0x34 0x37 0x33 0x34 0x35 0x32 0x34 0x46 0x35 0x31 0x37 0x41 0x30 0x30 | 0x38 | 0x35 | 0x37 | 0x45 | 0x03 |
The module would reply with a WIF_WA:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | WIF_WA=0x86 | None | LSB | MSB | ETX | |||
| 0x02 | 0x38 | 0x36 | None | 0x42 | 0x45 | 0x31 | 0x30 | 0x03 |
The module will then use new custom Wi-Fi configuration parameters.
CFG_R Configuration Read
The asset sends a CFG_RR request:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | CFG_RR=0x15 | None | LSB | MSB | ETX | |||
| 0x02 | 0x31 | 0x35 | 0x36 | 0x34 | 0x41 | 0x33 | 0x03 | |
The module would reply with CFG_RA. The default configuration is shown:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | CFG_RA=0x95 | 0x03 0x01 0x02 0x01 0x00 0x05 0x00 0x01 | LSB | MSB | ETX | |||
| 0x02 | 0x39 | 0x35 | 0x30 0x33 0x30 0x31 0x30 0x32 0x30 0x31 0x30 0x30 0x00 0x35 0x30 0x30 0x30 0x31 | 0x32 | 0x36 | 0x32 | 0x39 | 0x03 |
This shows:
- Device Type ID = 3
- Hardware Revision = 1
- Firmware Major Version = 2
- Firmware Minor Version = 1
- Firmware Revision = 0
- Configuration Register = 0x05 0x00 0x01 (payload acknowledgements on; geolocation off; ephemeris enabled; deep sleep disabled; payload ack event pin mask on; reset notification event pin mask off).
CFG_S Configuration Save
The asset sends a CFG_SR request:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | CFG_SR=0x10 | None | LSB | MSB | ETX | |||
| 0x02 | 0x31 | 0x30 | 0x43 | 0x31 | 0x46 | 0x33 | 0x03 | |
The module would reply with CFG_SA indicating the configuration has been saved:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | CFG_SA=0x90 | None | LSB | MSB | ETX | |||
| 0x02 | 0x39 | 0x30 | 0x34 | 0x39 | 0x36 | 0x32 | 0x03 | |
CFG_F Factory Reset
The asset sends a CFG_FR request:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | CFG_FR=0x11 | None | LSB | MSB | ETX | |||
| 0x02 | 0x31 | 0x30 | 0x45 | 0x30 | 0x45 | 0x33 | 0x03 | |
The module would reply with CFG_SA indicating the configuration has been reverted to the defaults:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | CFG_FA=0x91 | None | LSB | MSB | ETX | |||
| 0x02 | 0x39 | 0x31 | 0x36 | 0x38 | 0x37 | 0x32 | 0x03 | |
Module Information
RTC_R RTC Read
The asset sends a RTC_RR request:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | RTC_RR=0x17 | None | LSB | MSB | ETX | |||
| 0x02 | 0x31 | 0x37 | 0x32 | 0x36 | 0x38 | 0x33 | 0x03 | |
The module will answer with a RTC_RA answer. In this example the RTC time is 63’072’000 (1 Jan 2020 0h00) becomes 0x03C26700 in big endian which is 0x0067C203 in little endian.
CRC of 0x970067C203 is 0x0EFC which becomes 0x30 0x45 0x46 0x43.
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | RTC_RA=0x97 | RTC time = 63072000 | LSB | MSB | ETX | |||
| 0x02 | 0x39 | 0x37 | 0x30 0x30 0x36 0x37 0x43 0x32 0x30 0x33 | 0x46 | 0x43 | 0x30 | 0x45 | 0x03 |
NCO_R Next Contact Opportunity Read
The asset sends a NCO_RR request:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | NCO_RR=0x18 | None | LSB | MSB | ETX | |||
| 0x02 | 0x31 | 0x38 | 0x43 | 0x39 | 0x37 | 0x32 | 0x03 | |
The module will answer with a NCO_RA answer. In this example, the next pass window start is in 11700 (3h15min0s) becomes 0x2DB4 in big endian which is 0xB42D in little endian.
CRC of 0x98B42D is 0x3A02 which becomes 0x33 0x41 0x30 0x32.
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | NCO_RA=0x98 | Next window start = 11700 | LSB | MSB | ETX | |||
| 0x02 | 0x39 | 0x38 | 0x42 0x34 0x32 0x44 | 0x30 | 0x32 | 0x33 | 0x41 | 0x03 |
MGI_R Module GUID Read
The asset may query the GUID with MGI_RR:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | MGI_RR=0x19 | None | LSB | MSB | ETX | |||
| 0x02 | 0x31 | 0x39 | 0x45 | 0x38 | 0x36 | 0x32 | 0x03 | |
The module will answer with an MGI_RA answer. Here the example is a18bebf0-15dd-a3e3-903a-46006acfae8e. The 'a' is 0x61, which becomes 0x36 0x31. The '1' is 0x31, which becomes 0x33 0x31.
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | MGI_RA=0x99 | GUID = a18bebf0-15dd-a3e3-903a-46006acfae8e | LSB | MSB | ETX | |||
| 0x02 | 0x39 | 0x39 | 0x36 0x31 0x33 0x31 0x33 0x38 0x36 0x32 0x36 0x35 0x36 0x32 0x36 0x36 0x33 0x30 0x32 0x44 0x33 0x31 0x33 0x35 0x36 0x34 0x36 0x34 0x32 0x44 0x36 0x31 0x33 0x33 0x36 0x35 0x33 0x33 0x32 0x44 0x33 0x39 0x33 0x30 0x33 0x33 0x36 0x31 0x32 0x44 0x33 0x34 0x33 0x36 0x33 0x30 0x33 0x30 0x33 0x36 0x36 0x31 0x36 0x33 0x36 0x36 0x36 0x31 0x36 0x35 0x33 0x38 0x36 0x35 | 0x35 | 0x43 | 0x33 | 0x35 | 0x03 |
MSN_R Module Serial Number Read
The asset may query the serial number with MSN_RR:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | MSN_RR=0x1A | None | LSB | MSB | ETX | |||
| 0x02 | 0x31 | 0x41 | 0x38 | 0x42 | 0x35 | 0x32 | 0x03 | |
The terminal will answer with an MSN_RA answer. Here the example serial number is DKW2114AS1000510. The 'D' is 0x44, which becomes 0x34 0x34. The 'K' is 0x4B, which becomes 0x34 0x42.
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | MSN_RA=0x9A | Serial Number = DKW2114AS1000510 | LSB | MSB | ETX | |||
| 0x02 | 0x39 | 0x41 | 0x34 0x34 0x34 0x42 0x35 0x37 0x33 0x32 0x33 0x31 0x33 0x31 0x33 0x34 0x34 0x31 0x35 0x33 0x33 0x31 0x33 0x30 0x33 0x30 0x33 0x30 0x33 0x35 0x33 0x31 0x33 0x30 | 0x35 | 0x43 | 0x33 | 0x35 | 0x03 |
Message Management
PLD_E Enqueue Payload
The asset may queue a payload with PLD_ER. In this example, a payload ID of 1001 is used:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | PLD_ER=0x25 | ID=1001 Payload="Test" | LSB | MSB | ETX | |||
| 0x02 | 0x32 | 0x35 | 0x65 0x39 0x30 0x33 0x35 0x34 0x36 0x35 0x37 0x33 0x37 0x34 | 0x44 | 0x46 | 0x36 | 0x37 | 0x03 |
The module will answer with a PLD_EA answer, containing the same payload ID. In this example the payload ID is 1001.
| Start | ID | Parameters | Checksum | End | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| STX | PLD_EA=0xA5 | 0xE9 | 0x03 | LSB | MSB | ETX | |||||
| 0x02 | 0x41 | 0x35 | 0x45 | 0x39 | 0x30 | 0x33 | 0x42 | 0x39 | 0x30 | 0x30 | 0x03 |
PLD_D Dequeue Payload
The asset may dequeue the oldest payload with the PLD_DR:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | PLD_DR=0x26 | None | LSB | MSB | ETX | |||
| 0x02 | 0x32 | 0x36 | 0x35 | 0x34 | 0x41 | 0x35 | 0x03 | |
The module will answer with a PLD_DA answer, containing the payload ID of the payload that was dequeued. In this example the payload ID is 89.
| Start | ID | Parameters | Checksum | End | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| STX | PLD_DA=0xA6 | 0x59 | 0x00 | LSB | MSB | ETX | |||||
| 0x02 | 0x41 | 0x36 | 0x35 | 0x39 | 0x30 | 0x30 | 0x38 | 0x37 | 0x37 | 0x37 | 0x03 |
PLD_F Clear/Free Payloads
The asset may clear/free the payload queue with PLD_FR:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | PLD_FR=0x27 | None | LSB | MSB | ETX | |||
| 0x02 | 0x32 | 0x37 | 0x37 | 0x35 | 0x42 | 0x35 | 0x03 | |
The module will answer with a PLD_FA answer.
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | PLD_FA=0xA7 | None | LSB | MSB | ETX | |||
| 0x02 | 0x41 | 0x37 | 0x46 | 0x44 | 0x32 | 0x34 | 0x03 | |
GEO_W Geolocation Write
The asset may set the location with GEO_WR. Latitude and longitude in degrees should be multiplied by 10’000’000, and converted to little endian hex.
For example 46.53434° becomes 465’343’400, which is 0x1BBC93A8 big endian, and 0xA893BC1B little endian.
6.578747° becomes 65’787’470, which is 0x03EBD64E, and 0x4ED6EB03 little endian.| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | GEO_WR=0x35 | Lat=46.53434° Lng=6.578747° | LSB | MSB | ETX | |||
| 0x02 | 0x33 | 0x35 | 0x41 0x38 0x39 0x33 0x42 0x43 0x31 0x42 0x34 0x45 0x44 0x36 0x45 0x42 0x30 0x33 | 0x42 | 0x43 | 0x42 | 0x38 | 0x03 |
The module will answer with a GEO_WA answer.
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | GEO_WA=0xB5 | None | LSB | MSB | ETX | |||
| 0x02 | 0x42 | 0x35 | 0x38 | 0x45 | 0x31 | 0x36 | 0x03 | |
SAK_R Read Satellite ACK
The asset can read satellite message acknowledgements with the SAK_RR request:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | SAK_RR=0x45 | None | LSB | MSB | ETX | |||
| 0x02 | 0x34 | 0x35 | None | 0x39 | 0x31 | 0x46 | 0x39 | 0x03 |
If an ack is available, the module will answer with a SAK_RA answer. In this example the payload ID 61763 is returned.
| Start | ID | Parameters | Checksum | End | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| STX | SAK_RA=0xC5 | 43 | F1 | LSB | MSB | ETX | |||||
| 0x02 | 0x43 | 0x35 | 0x34 | 0x33 | 0x46 | 0x31 | 0x33 | 0x41 | 0x41 | 0x36 | 0x03 |
SAK_C Clear Satellite ACK
If the asset has sent a SAK_RR request, and the module has responded indicating a payload ID has been acknowledged, then the asset may clear the acknowledgment with SAK_CR.
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | SAK_CR=0x46 | None | LSB | MSB | ETX | |||
| 0x02 | 0x34 | 0x36 | None | 0x46 | 0x32 | 0x43 | 0x39 | 0x03 |
Normally the module will respond with SAK_CA.
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | SAK_CA=0xC6 | None | LSB | MSB | ETX | |||
| 0x02 | 0x43 | 0x36 | None | 0x37 | 0x41 | 0x35 | 0x38 | 0x03 |
If the module has not received a prior SAK_RR, then the response to SAK_CR would be an error code NO_CLEAR.
Command Management
CMD_R Command Read
You can read the latest command with CMD_RR:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | CMD_RR=0x47 | None | LSB | MSB | ETX | |||
| 0x02 | 0x34 | 0x37 | None | 0x44 | 0x33 | 0x44 | 0x39 | 0x03 |
If a command is available, the module will reply with CMD_RA:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | CMD_RA=0xC7 | created_date: 1261000, cmd: [0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x74, 0x68, 0x65, 0x72, 0x65, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00] | LSB | MSB | ETX | |||
| 0x02 | 0x63 | 0x37 | 0x63 0x38 0x33 0x64 0x31 0x33 0x30 0x30 0x34 0x38 0x36 0x35 0x36 0x63 0x36 0x63 0x36 0x66 0x32 0x30 0x37 0x34 0x36 0x38 0x36 0x35 0x37 0x32 0x36 0x35 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 | 0x34 | 0x44 | 0x41 | 0x36 | 0x03 |
CMD_C Command Clear
After a CMD_RR command, asset should clear the buffer using CMD_CR:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | CMD_CR=0x48 | None | LSB | MSB | ETX | |||
| 0x02 | 0x34 | 0x38 | None | 0x33 | 0x43 | 0x32 | 0x38 | 0x03 |
If there is no command to clear, the module will answer with an ERROR:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | ERROR=0xFF | NO_COMMAND_CLEAR (0x4801) | LSB | MSB | ETX | |||
| 0x02 | 0x66 | 0x66 | 0x30 0x31 0x34 0x38 | 0x30 | 0x32 | 0x46 | 0x39 | 0x03 |
Manufacturing Commands
TTX_S Test Transmit Start
Duration = 20
TTX_SR| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | TTX_SR=0x61 | 0x14 | LSB | MSB | ETX | |||
| 0x02 | 0x36 | 0x31 | 0x31 0x34 | 0x41 | 0x31 | 0x37 | 0x37 | 0x03 |
TTX_SAremaining_count = 1| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | TTX_SA=0xE1 | 0x01 | LSB | MSB | ETX | |||
| 0x02 | 0x65 | 0x31 | 0x30 0x31 | 0x41 | 0x44 | 0x32 | 0x45 | 0x03 |
Advanced Commands
RES_C Clear Reset Event
The asset may clear the module reset bit with RES_CR:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | RES_CR=0x55 | None | LSB | MSB | ETX | |||
| 0x02 | 0x35 | 0x35 | 0x41 | 0x30 | 0x45 | 0x42 | 0x03 | |
Normally the terminal will respond with RES_CA.
The reset bit is cleared, and the event pin is reset.
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | RES_CA=0xD5 | None | LSB | MSB | ETX | |||
| 0x02 | 0x44 | 0x35 | 0x32 | 0x38 | 0x37 | 0x41 | 0x03 | |
EVT_R Event Register Read
The asset may query the event register with EVT_RR:
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | EVT_RR=0x65 | None | LSB | MSB | ETX | |||
| 0x02 | 0x36 | 0x35 | None | 0x46 | 0x33 | 0x44 | 0x44 | 0x03 |
The module will answer with an EVT_RA answer. In this example the acknowledgement bit is 1, and the reset notification bit is 0.
| Start | ID | Parameters | Checksum | End | ||||
|---|---|---|---|---|---|---|---|---|
| STX | EVT_RA=0xE5 | Downlink Event Register0x01 | LSB | MSB | ETX | |||
| 0x02 | 0x45 | 0x35 | 0x30 0x31 | 0x36 | 0x39 | 0x45 | 0x32 | 0x03 |
Example Message Flow
In normal operation, the asset can expect to queue up to 8 payloads at any time. This would be with the PLD_ER request and corresponding PLD_EA answer. The asset should specify a payload ID to identify each payload inserted into the queue.
The module, left powered, will attempt to upload the payloads to the satellites. The module will determine when satellites are available and try to upload the payloads as soon as possible.
As they are uploaded and acknowledged, the module will provide this information to the asset. If an acknowledgement is available, the event pin will go high. The asset may detect this high state, or it may poll the event register with the EVT_RR request.
If a downlink is available, the asset should read the satellite acknowledgement wit the SAK_RR request. The SAK_RA will contain the payload ID identifying the payload.
The asset should then clear the ack with SAK_CR.
If there are more events available, the event pin and event register will be high/set. The asset should then repeat the process with SAK_RR.