Extended position messages
The extended position messages are sent if the bit 18 of the config_flags parameter is set, otherwise these payloads are only used in angle detection feature.
All these position messages contain the age of the position in byte 5 and 6.
Common header | Common header | Common header | Position information data | Position information data |
---|---|---|---|---|
Byte 0 | Byte 1-3 | Byte 4 | Bytes 5-6 | (1) |
Type=0x0E | Status/Batt/Temp. | ACK/OPT | Age | Extended Position data |
Age: Time difference between the fix and the LoRaWAN transmission. It is expressed in seconds. The value is in big endian (MSB first).
(1) The size of data part depends on the type of position message.
Opt: type of position message
- 0: GPS fix
- 1: GPS timeout
- 3: WIFI timeout
- 4: WIFI failure
- 5, 6: LPGPS data (encrypted, not described in this document)
- 7: BLE beacon scan with MAC address
- 8: BLE beacon failure
- 9: WIFI BSSIDs
- 10: BLE beacon scan with short identifier
- 11: BLE beacon scan with long identifier
Extended GPS fix payload
Common header with Type=0x0E and Opt=0x0 Extended Position data
Byte 7 | Byte 8-11 | Byte 12-15 | Byte 16-17 | Byte 18 | Byte 19-20 | Byte 21-22 | Byte 23-25 |
---|---|---|---|---|---|---|---|
Flag | Latitude | Longitude | Altitude | EHPE | COG | SOG | Last Fix |
Flag: it is a bitmap
- Bit:0: fix status
- 0: 2D fix
- 1: 3D fix
- Bit:1: Payload type
- Altitude and EHPE format 0
- Altitude and EHPE format 1
- Bit:2-7: not used
Latitude: Latitude of the position (expressed in degree) calculated as follow:
Latitude = Latitude << 8
If Latitude > 0x7FFFFFFF then Latitude = Latitude - 0x100000000
Latitude = Latitude / 107
Longitude: Longitude of the position (expressed in degree) calculated as follow:
Longitude = Longitude << 8
If Longitude \ 0x7FFFFFFF then Longitude = Longitude - 0x100000000
Longitude = Longitude / 107
Altitude:
- if Status Payload type is 0, Altitude is in centimeter
- if Status Payload type is 1, Altitude is in meter 3D fix
EHPE: Estimated Horizontal Position Error, expressed in meters.
If status payload type bit1=0 (Encoded using lo= 0, hi= 1000, nbits= 8, nresv= 0. The step is 3.9 meters ).
If status payload type bit1=1: It is encoded as follows:
Coded value | EHPE in meters |
---|---|
0-250 | 0-250 in meter |
251 | 250 < EHPE <= 500 |
252 | 500 < EHPE <= 1000 |
253 | 1000 < EHPE <= 2000 |
254 | 2000 < EHPE <= 4000 |
255 | EHPE >4 000 |
COG: (Course Over Ground) The direction the tracker is moving over the ground expressed in 1/100 degrees
SOG: (Speed Over Ground) The speed the tracker is moving over the ground. It is expressed in cm/second
Previous fix age: Previous fix age in seconds. Encoded form using lo= 0, hi= 2040, nbits= 8, resv= 0. Expressed in seconds. The step is 8 seconds.
Previous fix Delta: difference with the position given in the payload
Extended GPS timeout payload
Common header with Type=0x0E and Opt=0x1 Extended Position data
Byte 7 | Byte 8 | Byte 9 | Byte 10 | Byte 11 |
---|---|---|---|---|
Cause | C/N 0 | C/N 1 | C/N 2 | C/N 3 |
Cause: Timeout cause
- 0: Default timeout cause (when it is not due to Cause 1 or 2)
- 1: Timeout caused by the parameter gps_t0_timeout
- 2: Timeout caused by the parameter gps_fix_timeout
C/N 0: Carrier over noise (dBm) for the first satellite seen.
C/N 1: Carrier over noise (dBm) for the second satellite seen.
C/N 2: Carrier over noise (dBm) for the third satellite seen.
C/N 3: Carrier over noise (dBm) for the fourth satellite seen.
- The satellites are ordered based on their C/N. The best is sent in C/N 0.
- C/N encoding uses: lo= 0, hi=50, nbits=8, nresv= 0. It is expressed in dBm with a step of 0,2 dBm
- Encoded form is detailed in the Encoded form section.
Extended WIFI timeout payload
Common header with Type=0x0E and Opt=0x3 Extended Position data
Byte 7 | Byte 8 | Byte 9 | Byte 10 | Byte 11 | Byte 12 |
---|---|---|---|---|---|
v_bat1 | v_bat2 | v_bat3 | v_bat4 | v_bat5 | v_bat6 |
- V_bat1: Encoded voltage at the start time (T0) of the WIFI scan.
- V_bat2: Encoded voltage at T0 + 0.5 second.
- V_bat3: Encoded voltage at T0 + 1 second.
- V_bat4: Encoded at T0 + 1.5 second.
- V_bat5: Encoded voltage at T0 + 2 seconds.
- V_bat6: Encoded voltage at T0 + 2.5 seconds.
- Most of time a WIFI timeout occurs due to low battery.
- V_bat encoding uses: lo= 2.8, hi=4.2, nbits=8, nresv= 2. It is expressed in volts with a step of 5.5mV
- Encoded form is detailed in the Encoded form section.
Extended WIFI failure payload
Common header with Type=0x0E and Opt=0x4 Extended Position data
Byte 7 | Byte 8 | Byte 9 | Byte 10 | Byte 11 | Byte 12 | Byte 13 |
---|---|---|---|---|---|---|
v_bat1 | v_bat2 | v_bat3 | v_bat4 | v_bat5 | v_bat6 | Error |
- V_bat1: Encoded voltage at the start time (T0) of the WIFI scan.
- V_bat2: Encoded voltage at T0 + 0.5 second.
- V_bat3: Encoded voltage at T0 + 1 second.
- V_bat4: Encoded voltage at T0 + 1.5 second.
- V_bat5: Encoded voltage at T0 + 2 seconds.
- V_bat6: Encoded voltage at T0 + 2.5 seconds.
Error:
- 0: WIFI connection failure (no communication between WiFi and MCU)
- 1: Scan failure (scan of WiFi BSSID failed)
- 2: Antenna unavailable
- 3: WIFI not supported on this device
- Most of time a WIFI timeout occurs due to a low battery condition.
- V_bat encoding uses: lo= 2.8, hi=4.2, nbits=8, nresv= 2. It is expressed in volts with a step of 5.5mV
- Encoded form is detailed in the Encoded form section.
Extended WIFI BSSID payload
Common header with Type=0x0E and Opt=0x9 Extended Position data
Byte 7-12 | Byte 13 | Byte 14-19 | Byte 20 | Byte 21-26 | Byte 27 | Byte 28-33 | Byte 34 |
---|---|---|---|---|---|---|---|
BSSID0 | RSSI0 | BSSID1 | RSSI1 | BSSID2 | RSSI2 | BSSID3 | RSSI23 |
BSSIDx: BSSID of the WIFI station x.
RSSIx: Receive Signal Strength Indication of the WIFI station x. Non encoded form (negative value, refer to the section Two's complement Encoding for information for the encoding). It is expressed in dBm.
When long WIFI payload is activated in config_flags parameter and transmit strategy is not well chosen, too long payload could not be transmitted. In this case, after 5 discarded uplinks, the tracker sends an uplink length error message which is described here.
- The payload contains the listened WIFI stations (up to 12 if bit 12 of config_flags parameter is set, up to 4 if it is reset).
- If less than 4 stations are listened to, the payload will be reduced.
- BSSID address is provided in big endian format. So, byte 6 of the payload contains the MSB of the BSSID0, while byte 11 contains its LSB.
- The data rate and the transmit strategy must be adapted to the payload size, or the payload will be rejected by the LoRaWAN™ MAC, and won't be sent. Refer to the application note AN- 002_LoRa_Transmission_strategy for more details.
Extended BLE beacon scan payload (MAC address)
Common header with Type=0x0E and Opt=0x7 Extended Position data
Byte 7-12 | Byte 13 | Byte 14-19 | Byte 20 | Byte 21-26 | Byte 27 | Byte 28-33 | Byte 34 |
---|---|---|---|---|---|---|---|
MACADR0 | RSSI0 | MACADR1 | RSSI1 | MACADR2 | RSSI2 | MACADR3 | RSSI3 |
MAC ADRx: MAC Address of the BLE beacon x. RSSIx: Receive Signal Strength Indication of the BLE beacon x. Non-encoded form (negative value, refer to the section Two's complement Encoding for information for the encoding) and expressed in dBm.
- The payload contains the listened BLE beacons (up to 4, it is configurable using ble_beacon_cnt parameter), during ble_beacon_timeout delay.
- If less than 4 BLE beacons are listened, the payload will be reduced.
- Refer to the application not AN-006_Position_BLE_filtering for more details.
Extended BLE beacon scan payload (short identifier)
Common header with Type=0x0E and Opt=0xA Extended Position data
Byte 7-12 | Byte 13 | Byte 14-19 | Byte 20 | Byte 21-26 | Byte 27 | Byte 28-33 | Byte 34 |
---|---|---|---|---|---|---|---|
short BID0 | RSSI0 | short BID1 | RSSI1 | short BID2 | RSSI2 | short BID3 | RSSI3 |
Short BIDx:
[Eddystone UID beacon]{.ul}
: 6 last bytes of the Instance ID field
[Altbeacon UID beacon]{.ul}
: 6 last bytes of the beacon UID
[Ibeacon UID beacon]{.ul}:
If *position_ble_report_type*= 1
: 6 last bytes of the Ibeacon UUID
If *position_ble_report_type*= 3
: 2 last bytes of the UUID field, the Major number and the Minor
RSSIx: Receive Signal Strength Indication of the BLE beacon x. Non-encoded form (negative value, refer to the section Two's complement Encoding for information for the encoding).and expressed in dBm.
- The payload contains the listened BLE beacons (up to 4, it is configurable using ble_beacon_cnt parameter), during ble_beacon_timeout delay.
- If less than 4 BLE beacons are listened to, the payload is reduced.
- Short ID is not supported for Eddystone url beacons.
- Refer to the application not AN-006_Position_BLE_filtering for more details.
Extended BLE beacon scan payload (long ID)
Common header with Type=0x0E and Opt=0xB Extended Position data
Byte 7-22 | Byte 23 |
---|---|
long BID0 | RSSI0 |
Long BIDx: Eddystone UID beacon: Name space + instance ID (16 bytes) Ibeacon UID beacon: 16 last bytes of the Ibeacon UUID Altbeacon UID beacon: 16 last bytes of the beacon UID
RSSIx: Receive Signal Strength Indication of the BLE beacon x. Non-encoded form (negative value, refer to the section Two's complement Encoding for information for the encoding).and expressed in dBm.
1- The payload contains the long ID of only one beacon. 2- Long ID is not supported for Eddystone URL frame type. 3- Refer to the application note AN-006_Position_BLE_filtering for more details.
Extended BLE failure payload
Common header with Type=0x0E and Opt=0x8 Extended Position data
Byte 7 |
---|
Error |
Error:
- 0x00: BLE is not responding
- 0x01: Internal error
- 0x02: Shared antenna not available
- 0x03: Scan already on going
- 0x04: BLE busy (should not occur)
- 0x05: No beacon detected
- 0x06: Hardware incompatibility
- 0xFF: Unknown/wrong BLE firmware version