Apollon-Q T/R/TR Payload Description
You are looking for a payload description for the Apollon-Q-T/R/TR
- Payload Description
- Example of a Wi-Fi SSID scan payload
- Apollon Q T/R/TR/SW Payload Description
- Apollon Q T Version Payload Description (without radar)
- Apollon Q R Version Payload Description (without ToF)
- Apollon Q TR / SW Version Payload Description (with Radar and ToF)
- Apollon Q Appended Bytes (ACC / HALL)
- Apollon Q Bytes (Histogram Debug Data)
- Decoding Examples
1. Payload Description
This chapter describes the structure of the telemetry data. The number of bytes within the payload depends on the specific sensor configuration. The data structure is determined by which sensors and functions are present in the product.
Each payload begins with a header. This header contains information on the hardware and software versions, the current device status, and a master measurement value. The master measurement value can generally be interpreted as the sensor's current primary measurement value.
Depending on the sensor configuration, the header is followed by additional payload sections. These contain additional information on the measurement principles, position data, or functions for opening and event detection. Not every product variant includes all additional payload sections.
Payload Field Description
| Term | Description |
|---|---|
| Byte No. | Byte number starting at 1 |
| Alias | Human-readable name of the variable |
| Description | Description of the variable |
| Label | Label in the data converter or payload decoder |
| Unit | Unit of the variable |
| Datahub .json key | Key in the JSON object when using the Datahub |
Structure of the Module Key
| Byte 1 | Byte 2 | ||
|---|---|---|---|
| Bits 7β4 | Bits 3β0 | Bits 7β4 | Bits 3β0 |
| Module base ID (e.g., Sentiface, Senticom, Sentivisor) | Major Version (Software/Hardware Version) | Minor version (software/hardware version) | Product version (e.g., TH, THL, ACC, Radar) |
The module key for the Apollon-Q module can be derived from the first two bytes of each uplink. The module key is required, among other things, for interpreting the payload and for downlink commands.
The module key for the SENTIFACE module can be extracted from the first two bytes of each uplink. The module key is required for the correct interpretation of the payload as well as for downlink commands.
Port Assignment for WiFi SSID Scan, GNSS Scan, and Standard Payload
| Feature | LoRaWAN port | Description |
|---|---|---|
| GNSS Scan Payload | 192 | Raw data such as satellite IDs, time information, and other GNSS measurements are transmitted to the geolocation backend. |
| Wi-Fi SSID Scan Payload | 197 | Detected MAC addresses and RSSI values are transmitted for position determination. |
| Regular Telemetry Data | 1 | Standard payload containing sensor data such as distance values, temperature, battery status, lid detection, or location information. |
2. Example of a Wi-Fi SSID scan payload
3. Apollon Q T/R/TR/SW Payload Description
| Byte Number | Alias Name | Unit | Description in the Decoder | Module Key | Datahub .json Key |
|---|---|---|---|---|---|
| 1 β 2 | Module key | β | module_key |
XXX1 |
module_key |
|
Description: Byte 1: β’ Module code (bits 7β4) β’ Major version (bits 3β0) Byte 2: β’ Minor version (bits 7β4) β’ Product version (bits 3β0) |
|||||
| 3 | Uplink counter | β | uplink_counter |
XXX1 |
uplink_counter |
|
Description: Protocol-independent uplink counter (0β255). |
|||||
| 4 β 5 | Battery voltage | mV | battery_voltage |
XXX1 |
battery_voltage |
|
Description: Current battery voltage in millivolts. |
|||||
| 6 | Internal Temperature | Β°C | internal_temperature |
XXX1 |
internal_temperature |
|
Description: Internal sensor temperature. |
|||||
| 7 | Alarm | β | alarm |
XXX1 |
alarm |
|
Description: Indicates whether an alarm has been triggered. |
|||||
| 8 β 9 | Master reading | mm | master_value |
XXX1 |
master_value |
|
Description: Main measured value of the sensor. |
|||||
For the subsequent bytes, please note the respective hardware version of the sensor (T, R, TR, or SW), as the payload structure may vary.
4. Apollon Q T Version Payload Description (without radar)
| Byte Number | Alias Name | Unit | Name in the Payload Decoder | Module Key | Datahub .json Key |
|---|---|---|---|---|---|
| 10 | ToF Sensor Status | β | tof_status |
XXX1 |
tof_status |
|
Description: Sensor status based on the last measured value. β’ 0: Valid range β’ 2 / 4: Out of bounds β’ 5: Hardware failure β’ 7: Target wrapped β’ 8: Algorithm failure β’ 14: Invalid range β’ 99: More than one valid target detected |
|||||
| 11β12 | Distance | mm | tof_distance |
XXX1 |
tof_distance |
|
Description: Currently measured distance by the ToF sensor in mm. (Compare with Master Value if the measurement source is identical.) |
|||||
| 13 | ToF Mode (Index) | β | tof_index |
XXX1 |
tof_index |
|
Description: The mode in which the sensor recorded the last value. β’ 0: Short (up to 1.3 m) β’ 1: Medium (up to 3 m) β’ 2: Long (up to 4 m) |
|||||
5. Apollon Q R Version Payload Description (without ToF)
| Byte Number | Alias Name | Unit | Description in Payload Decoder | Module Key | Datahub .json Key |
|---|---|---|---|---|---|
| 10 | Radar Status | β | radar_status |
XXX1 |
radar_status |
|
Description: β’ 0: Error β’ 1: Success |
|||||
| 11 | Number of peaks | β | radar_no_peaks |
XXX1 |
radar_no_peaks |
|
Description: Number of detected peaks. |
|||||
| 12β13 | Distance 1 | mm | radar_distance_1 |
XXX1 |
radar_distance_1 |
|
Description: Distance at maximum peak in mm. |
|||||
| 14β15 | Peak 1 | dBsm | radar_ra_1 |
XXX1 |
radar_ra_1 |
|
Description: Distance at maximum peak in dBsm. |
|||||
| 16β17 | Distance 2 | mm | radar_distance_2 |
XXX1 |
radar_distance_2 |
|
Description: Distance with the second-highest peak in mm. |
|||||
| 18β19 | Peak 2 | dBsm | radar_ra_2 |
XXX1 |
radar_ra_2 |
|
Description: Distance with the second-highest peak in dBsm. |
|||||
| 20β21 | Distance 3 | mm | radar_distance_3 |
XXX1 |
radar_distance_3 |
|
Description: Distance with the third-highest peak in mm. |
|||||
| 22β23 | Peak 3 | dBsm | radar_ra_3 |
XXX1 |
radar_ra_3 |
|
Description: Distance with the third-highest peak in dBsm. |
|||||
6. Apollon Q TR / SW Version Payload Description (with Radar and ToF)
| Byte Number | Alias Name | Unit | Designation in the Payload Decoder | Module Key | Datahub .json Key |
|---|---|---|---|---|---|
| 10 | ToF Sensor Status | β | tof_status |
XXX1 |
tof_status |
|
Description: β’ 0 β Valid range β’ 2 / 4 β Out of bounds β’ 5 β Hardware failure β’ 7 β Wrapped target β’ 8 β Algorithm failure β’ 14 β Invalid range β’ 99 β More than one valid target detected |
|||||
| 11 β 12 | Distance (see Master Value) | mm | tof_distance |
XXX1 |
tof_distance |
|
Description: Current measured distance from the ToF sensor in mm. |
|||||
| 13 | ToF Mode (Index) | β | tof_index |
XXX1 |
tof_index |
|
Description: β’ 0 β Short (up to 1.3 m) β’ 1 β Medium (up to 3 m) β’ 2 β Long (up to 4 m) |
|||||
| 14 | Radar Status | β | radar_status |
XXX1 |
radar_status |
|
Description: β’ 0 β Error β’ 1 β Success |
|||||
| 15 | Number of peaks | β | radar_no_peaks |
XXX1 |
radar_no_peaks |
|
Description: Number of detected peaks. |
|||||
| 16β17 | Distance 1 | mm | radar_distance_1 |
XXX1 |
radar_distance_1 |
|
Description: Distance at maximum peak in mm. |
|||||
| 18β19 | Peak 1 | dBsm | radar_ra_1 |
XXX1 |
radar_ra_1 |
|
Description: Distance at maximum peak in dBsm. |
|||||
| 20β21 | Distance 2 | mm | radar_distance_2 |
XXX1 |
radar_distance_2 |
|
Description: Distance with the second-highest peak in mm. |
|||||
| 22β23 | Peak 2 | dBsm | radar_ra_2 |
XXX1 |
radar_ra_2 |
|
Description: Distance with the second-highest peak in dBsm. |
|||||
| 24β25 | Distance 3 | mm | radar_distance_3 |
XXX1 |
radar_distance_3 |
|
Description: Distance with the third-highest peak in mm. | |||||
| 26β27 | Peak 3 | dBsm | radar_ra_3 |
XXX1 |
radar_ra_3 |
|
Description: Distance with the third-highest peak in dBsm. |
|||||
7. Apollon Q β Appended Bytes (ACC / HALL)
| Appended bytes | Alias Name | Unit | Designation in the Payload Decoder | Module key | Datahub .json Key |
|---|---|---|---|---|---|
| 1 | Sensor Status (ACC) | β | acc_status |
XXX1 |
acc_status |
|
Description: Returns the status of the accelerometer: β’ 0: OK β’ Other values: Error |
|||||
| 1 | Orientation (ACC) | β | acc_orientation |
XXX1 |
acc_orientation |
|
Description: Displays the sensor's orientation: β’ 0: Vertical (lying on its side) β’ 1: Face Up (lens facing the ceiling) β’ 2: Face Down (lens facing the floor) β’ 3: Error |
|||||
| 1 | Flap Opening (ACC) | β | acc_open |
XXX1 |
acc_open |
|
Description: Indicates whether the lid is still open after a defined time interval. |
|||||
| 1 | Openings Lifetime Counter (ACC) | β | acc_open_cnt |
XXX1 |
acc_open_cnt |
|
Description: Total number of openings over the entire lifecycle. |
|||||
| 1 | Vandalism Alarm (ACC) | β | acc_impact |
XXX1 |
acc_impact |
|
Description: Indicates whether a vandalism event is active: β’ 0: No vandalism event β’ 1: Vandalism event |
|||||
| 1 | Flap Opening (HALL) | β | hall_open |
XXX1 |
hall_open |
|
Description: Indicates whether a flap (with a sensor attached) is open: β’ 1: Open β’ 0: Closed |
|||||
| 1 | Openings Lifetime (HALL) | β | hall_open_cnt |
XXX1 |
hall_open_cnt |
|
Description: Total number of openings over the entire life cycle (Hall sensor). |
|||||
8. Apollon Q β Appended Bytes (Histogram Debug Data, ToF Version = 2)
| Appended Bytes | Alias Name | Unit | Designation in the Payload Decoder | Module key | Datahub .json key |
|---|---|---|---|---|---|
| 1 byte appended | Histogram Type/Version | β | histo_type |
XXX1 |
histo_type |
|
Description: Specifies whether only values from the histogram function are transmitted or whether values from the averaging algorithm are also transmitted. β’ 0: Histogram values only ( master_value or
tof_distance)β’ 1: Histogram values and values from the averaging algorithm |
|||||
| 1 byte appended | Histogram Status | β | tof_hist_stat |
XXX1 |
tof_hist_stat |
|
Description: For more detailed information, please contact the manufacturer. Applies to variants with histogram type/version = 0 (identified by the payload length plus 5 bytes). |
|||||
| 2 bytes appended | Histogram distance | mm | tof_hist_dist |
XXX1 |
tof_hist_dist |
|
Description: Distance in mm calculated using the histogram feature algorithm. In normal operation, these values should deviate only slightly from the usual distance values and can compensate for heavy contamination on the lens. |
|||||
9. Decoding Examples (Febris)
11 11 CE 14 8E 07 EE 1D 00 02 03 D6 01 D1 00
| Bytes | HEX | Description |
|---|---|---|
| 1 | 11 | Module Key |
| 2 | 11 | Module key |
| 3 | CE | Uplink Counter |
| 4 | 14 | Battery Voltage |
| 5 | 8E | Battery Voltage |
| 6 | 07 | Internal Temperature |
| 7 | EE | Internal temperature |
| 8 | 1D | Relative humidity |
| 9 | 00 | Dew point |
| 10 | 02 | Dew point |
| 11 | 03 | Air Pressure |
| 12 | D6 | Air Pressure |
| 13 | 01 | COβ |
| 14 | D1 | COβ |
| 15 | 00 | Alarm |
Β© Sentinum GmbH β All rights reserved.
All content in this document, including text, tables, and images, is protected by copyright and is the property of Sentinum GmbH.
All images are subject to the copyright of Sentinum GmbH, unless otherwise stated.
Reproduction, distribution, or useβeven in partβis not permitted without express written permission.
Specifications are subject to change. All information is provided without warranty.