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.
Tx Operations
TCO
Start Tx Continuous
The asset sends a TCO_R
request with mid frequency and continuous wave parameters.
Start | ID | Sub-ID | Parameters | Checksum | End | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
STX | HOM_R=0x03 | TCO_R=0x01 | 0x01 0x00 | LSB | MSB | ETX | |||||||
0x02 | 0x30 | 0x33 | 0x30 | 0x31 | 0x30 | 0x31 | 0x30 | 0x30 | 0x31 | 0x44 | 0x31 | 0x42 | 0x03 |
The module would reply with a TCO_A
:
Start | ID | Sub-ID | Parameters | Checksum | End | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
STX | HOM_A=0x83 | TCO_A=0x81 | 0x00 | LSB | MSB | ETX | |||||
0x02 | 0x38 | 0x33 | 0x38 | 0x31 | 0x30 | 0x30 | 0x33 | 0x46 | 0x38 | 0x36 | 0x03 |
TDC
Start Tx Duty Cycle
The asset sends a TDC_R
request.
Start | ID | Sub-ID | Parameters | Checksum | End | |||||
---|---|---|---|---|---|---|---|---|---|---|
STX | HOM_R=0x03 | TDC_R=0x02 | None | LSB | MSB | ETX | ||||
0x02 | 0x30 | 0x33 | 0x30 | 0x32 | None | 0x31 | 0x45 | 0x36 | 0x38 | 0x03 |
The module would reply with a TDC_A
:
Start | ID | Sub-ID | Parameters | Checksum | End | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
STX | HOM_A=0x83 | TDC_A=0x82 | 0x00 | LSB | MSB | ETX | |||||
0x02 | 0x38 | 0x33 | 0x38 | 0x32 | 0x30 | 0x30 | 0x36 | 0x43 | 0x44 | 0x33 | 0x03 |
TFH
Start Tx Frequency Hopping
The asset sends a TFH_R
request with highest channel parameter and “low and high” frequencies hopping pattern.
Start | ID | Sub-ID | Parameters | Checksum | End | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
STX | HOM_R=0x03 | TFH_R=0x03 | 0x02 0x00 | LSB | MSB | ETX | |||||||
0x02 | 0x30 | 0x33 | 0x30 | 0x33 | 0x30 | 0x32 | 0x30 | 0x30 | 0x32 | 0x45 | 0x32 | 0x30 | 0x03 |
The module would reply with a TFH_A
:
Start | ID | Sub-ID | Parameters | Checksum | End | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
STX | HOM_A=0x83 | TFH_A=0x83 | 0x00 | LSB | MSB | ETX | |||||
0x02 | 0x38 | 0x33 | 0x38 | 0x33 | 0x30 | 0x30 | 0x35 | 0x44 | 0x45 | 0x30 | 0x03 |
TLI
Start Tx Link
The asset sends a TLI_R
request.
Start | ID | Sub-ID | Parameters | Checksum | End | |||||
---|---|---|---|---|---|---|---|---|---|---|
STX | HOM_R=0x03 | TLI_R=0x04 | None | LSB | MSB | ETX | ||||
0x02 | 0x30 | 0x33 | 0x30 | 0x34 | None | 0x44 | 0x38 | 0x30 | 0x38 | 0x03 |
For this example, the module could reply with a TLI_A
with a busy result code:
Start | ID | Sub-ID | Parameters | Checksum | End | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
STX | HOM_A=0x83 | TLI_A=0x84 | 0x02 | LSB | MSB | ETX | |||||
0x02 | 0x38 | 0x33 | 0x38 | 0x34 | 0x30 | 0x32 | 0x38 | 0x38 | 0x35 | 0x39 | 0x03 |
Rx Operations
RLI
Start Rx Link
The asset sends a RLI_R
request with reduced Rx Gain.
Start | ID | Sub-ID | Parameters | Checksum | End | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
STX | HOM_R=0x03 | RLI_R=0x05 | 0x01 | LSB | MSB | ETX | |||||
0x02 | 0x30 | 0x33 | 0x30 | 0x35 | 0x30 | 0x31 | 0x31 | 0x38 | 0x37 | 0x41 | 0x03 |
The module would reply with a RLI_A
:
Start | ID | Sub-ID | Parameters | Checksum | End | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
STX | HOM_A=0x83 | TLI_A=0x85 | 0x00 | LSB | MSB | ETX | |||||
0x02 | 0x38 | 0x33 | 0x38 | 0x35 | 0x30 | 0x30 | 0x46 | 0x42 | 0x34 | 0x41 | 0x03 |
Monitor Operations
MOO
Monitor Operations
The asset sends a MOO_R
request.
Start | ID | Sub-ID | Parameters | Checksum | End | |||||
---|---|---|---|---|---|---|---|---|---|---|
STX | HOM_R=0x03 | MOO_R=0x08 | None | LSB | MSB | ETX | ||||
0x02 | 0x30 | 0x33 | 0x30 | 0x38 | None | 0x35 | 0x34 | 0x43 | 0x39 | 0x03 |
The module could reply with a MOO_A
with the following parameters:
- Current Homologation mode: HH_MODE_TX_LINK
- Time since last satellite search: 0
- Last satellite search peak RSSI: 15
- Last MAC Result: Success
- Rx operations attempt count: 55
- Rx operations success count: 54
- Rx operations success moving average: 100
Start | ID | Sub-ID | Parameters | Checksum | End | |||||
---|---|---|---|---|---|---|---|---|---|---|
STX | HOM_A=0x83 | MOO_A=0x88 | 0x79 0x01 0x03 0x63 0x04 0x00 0x00 0x00 0x00 0x62 0x01 0x0f 0x61 0x01 0x01 0x73 0x04 0x37 0x00 0x00 0x00 0x72 0x04 0x36 0x00 0x00 0x00 0x71 0x04 0x64 0x00 0x00 0x00 | LSB | MSB | ETX | ||||
0x02 | 0x38 | 0x33 | 0x38 | 0x38 | 0x37 0x39 0x30 0x31 0x30 0x33 0x36 0x33 0x30 0x34 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x30 0x36 0x32 0x30 0x31 0x30 0x66 0x36 0x31 0x30 0x31 0x30 0x31 0x37 0x33 0x30 0x34 0x33 0x37 0x30 0x30 0x30 0x30 0x30 0x30 0x37 0x32 0x30 0x34 0x33 0x36 0x30 0x30 0x30 0x30 0x30 0x30 0x37 0x31 0x30 0x34 0x36 0x34 0x30 0x30 0x30 0x30 0x30 0x30 | 0x35 | 0x31 | 0x41 | 0x39 | 0x03 |
Stop Operations
STO
Stop Operations
The asset sends a STO_R
request.
Start | ID | Sub-ID | Parameters | Checksum | End | |||||
---|---|---|---|---|---|---|---|---|---|---|
STX | HOM_R=0x03 | STO_R=0x09 | None | LSB | MSB | ETX | ||||
0x02 | 0x30 | 0x33 | 0x30 | 0x39 | None | 0x37 | 0x35 | 0x44 | 0x39 | 0x03 |
The module would reply with a STO_A
:
Start | ID | Sub-ID | Parameters | Checksum | End | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
STX | HOM_A=0x83 | STO_A=0x89 | 0x00 | LSB | MSB | ETX | |||||
0x02 | 0x38 | 0x33 | 0x38 | 0x39 | 0x30 | 0x30 | 0x39 | 0x36 | 0x30 | 0x46 | 0x03 |