Skip to content
English
go to www.sentinum.de
  • There are no suggestions because the search field is empty.

Apollon-Q T/R/TR Payload Description

You are looking for a payload description for the Apollon-Q-T/R/TR

Here you will find a payload description for the  Apollon-Q-T/R/TR 👇

 
📄 You can view the PDF above or download it here.

This chapter describes the structure of the telemetry data. The number of bytes in the payload depends on the configuration of the sensor. The structure of the data depends on which sensors are present in your product. In principle, each version has a header. This has information about the version and status of the sensor and also contains a master measured value. This measured value can simply be assumed to be the current measured value. The header is followed by an additional payload part that contains further information, such as special parameters for the measuring principle or settings for position and opening detection. Not every sensor has an additional payload part.

PAYLOAD DESCRIPTION

Term Description
Byte No. Byte number starting at 1
Alias Comprehensible name of the variable
Description of the variable Description of the variable
Designation Designation in the Dataconverter
Unit Unit of the variable
Datahub .json key Key in the .json when using the Data Hub

Structure of the moodle key 

Byte 1

Byte 2

Bit 7 - 4

Bit 3 - 0

Bit 7 - 4

Bit 3 - 0

Basic ID module e.g. Sentiface, Senticom, Sentivisor

Major version (SW/HW version)

Minor version (SW/HW version)

Product version (sensors, e.g. TH, THL, ACC, ...)

Port assignment for WiFi SSID scan payload, GNSS scan payload and regular payload

Feature LoRaWAN Port Port description
GNSS scan payload 192 Raw data (satellite ID, time, etc.) is sent to the geolocation backend.
WiFi SSID scan payload 197 Scanned MAC addresses and RSSI data are transmitted for localization.
Regular telemetry data 1 Regular payload data from the sensor, such as temperature, relative humidity, angle, and battery voltage.

Example for the WIFI SSID scan payload:

Apollon Q T/R/TR/SW payload description

Byte number Alias name Unit Designation in decoder Module key Datahub .json key
1 – 2 Module key module_key XXX1 module_key
Description:
Byte 1
• 4-bit MSB: Module code. For Mioty exclusively "Sentiface" telemetry module (always 0x1).
• 4-bit LSB: Major version. FW of the same major version but larger minor version remains compatible with older decoders (byte count may change).

Byte 2
• 4-bit MSB: Minor version. New SW versions may add telemetry incrementally.
• 4-bit LSB: Sub/Product version. With Helios, these bits encode the specific configuration of connected sensors.
3 Uplink counter uplink_counter XXX1 uplink_counter
Description: Protocol-independent counter up to 255; rolls over to 0.
4 – 5 Battery voltage mV battery_voltage XXX1 battery_voltage
Description: Current battery voltage in millivolts.
// voltage in volts
battery_voltage = (dataBytes[3] << 8 | dataBytes[4]) / 1000.0;
6 Internal temperature °C internal_temperature XXX1 internal_temperature
Description: Internal temperature of the sensor.
// temp in °C
internal_temperature = dataBytes[5] - 128;
7 Alarm variable alarm XXX1 alarm
Description: Uplink caused by an alarm.
• 0: Alarm not triggered  • 1: Alarm triggered
New sensors (bit-mapped):
• 1: Delta alarm  • 2: Temperature alarm  • 4: Opening alarm  • 8: Vandalism alarm
8 – 9 Master measured value mm master_value XXX1 master_value
Description:
• APOQ-XXXX-T: current ToF distance (mm).
• APOQ-XXXX-R: radar maximum peak distance (mm).
• APOQ-XXXX-TR: calculated value from both measuring principles (mm).
 
Note: For the remaining bytes, please refer to the specific hardware version of the sensor (T, R, TR, SW), as the payload may differ.

Apollon Q T version payload description (without radar)

Byte number Alias name Unit Designation in payload decoder Module key Datahub .json key
10 Status ToF sensor tof_status XXX1 tof_status
Description:
Status of the sensor in relation to the last measured value.
• 0: Valid range
• 2 / 4: Out of bounds
• 5: Hardware fail
• 7: Wrapped target
• 8: Algorithm fail
• 14: Invalid range
• 99: More than one valid target detected
11 – 12 Distance mm tof_distance XXX1 tof_distance
Description:
Current measured distance of the ToF sensor in mm.
(See master value if the source of the sensor is the same.)
13 Mode ToF (Index) tof_index XXX1 tof_index
Description:
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

Apollon Q R version payload description (without ToF)

Byte number Alias name Unit Designation in payload decoder Module key Datahub .json key
10 Status radar 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 with maximum peak in millimeters.
14 – 15 Peak 1 dBsm radar_ra_1 XXX1 radar_ra_1
Description:
Peak value corresponding to distance 1 in dBsm.
16 – 17 Distance 2 mm radar_distance_2 XXX1 radar_distance_2
Description:
Distance with the second highest peak in millimeters.
18 – 19 Peak 2 dBsm radar_ra_2 XXX1 radar_ra_2
Description:
Peak value corresponding to distance 2 in dBsm.
20 – 21 Distance 3 mm radar_distance_3 XXX1 radar_distance_3
Description:
Distance with the third highest peak in millimeters.
22 – 23 Peak 3 dBsm radar_ra_3 XXX1 radar_ra_3
Description:
Peak value corresponding to distance 3 in dBsm.

Apollon Q TR / SW payload description (with radar and ToF)

Byte number Alias name Unit Designation in payload decoder Module key Datahub .json key
10 Status ToF sensor tof_status XXX1 tof_status
Byte description:
Status of the sensor in relation to the last measured value.
• 0: Valid range • 2/4: Out of bounds • 5: Hardware fail • 7: Wrapped target • 8: Algorithm fail • 14: Invalid range • 99: More than one valid target detected
11 – 12 Distance (see master value if same source) mm tof_distance XXX1 tof_distance
Byte description:
Current measured distance of the ToF sensor in mm.
13 Mode ToF (Index) tof_index XXX1 tof_index
Byte description:
Mode in which the last value was recorded:
• 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
Byte description:
• 0: Error • 1: Success
15 Number of peaks radar_no_peaks XXX1 radar_no_peaks
Byte description:
Number of peaks detected.
16 – 17Distance 1mmradar_distance_1XXX1radar_distance_1
Byte description:
Distance with maximum peak in mm.
18 – 19Peak 1dBsmradar_ra_1XXX1radar_ra_1
Byte description:
Maximum peak (amplitude) in dBsm.
20 – 21Distance 2mmradar_distance_2XXX1radar_distance_2
Byte description:
Distance with second highest peak in mm.
22 – 23Peak 2dBsmradar_ra_2XXX1radar_ra_2
Byte description:
Second highest peak (amplitude) in dBsm.
24 – 25Distance 3mmradar_distance_3XXX1radar_distance_3
Byte description:
Distance with third highest peak in mm.
26 – 27Peak 3dBsmradar_ra_3XXX1radar_ra_3
Byte description:
Third highest peak (amplitude) in dBsm.

Apollon Q attached bytes — ACC / HALL (any ToF/Radar, not PP)

Attached bytes Alias name Unit Name in payload decoder Module key Datahub .json key
1 Sensor status (ACC) acc_status XXX1 acc_status
Alias description:
Returns the status of the acceleration sensor:
• 0: OK • other: Error
1 Orientation (ACC) acc_orientation XXX1 acc_orientation
Alias description:
Sensor orientation:
• 0: Vertical (lying on its side) • 1: Face Up (lens to ceiling) • 2: Face Down (lens to floor) • 3: Error
1 Flap open (ACC) acc_open XXX1 acc_open
Alias description:
Indicates whether the cover is still open after a defined interval.
1 Openings lifetime counter (ACC) acc_open_cnt XXX1 acc_open_cnt
Alias description:
Total number of openings over the device lifetime.
1 Vandalism alarm (ACC) acc_impact XXX1 acc_impact
Alias description:
Indicates whether a vandalism event is active:
• 0: No vandalism event • 1: Vandalism event
1 Flap open (HALL) hall_open XXX1 hall_open
Alias description:
Indicates whether a flap (with attached sensor) is open:
• 1: Open • 0: Closed
1 Openings lifetime (HALL) hall_open_cnt XXX1 hall_open_cnt
Alias description:
Total number of openings over the device lifetime (Hall sensor).

Apollon Q attached bytes — histogram debug data (ToF versions = 2)

Attached bytes Alias name Unit Designation in payload decoder Module key Datahub .json key
1 byte attached Histogram type / version histo_type XXX1 histo_type
Alias description:
Specifies whether only histogram values are transmitted or also values from the usual average algorithm:
• 0: Only histogram values appended (appear in master_value or tof_distance)
• 1: Histogram values plus the usual average values are transmitted
1 byte appended Histogram status tof_hist_stat XXX1 tof_hist_stat
Alias description:
For detailed interpretation, please contact the manufacturer.
2 bytes appended Histogram distance mm tof_hist_dist XXX1 tof_hist_dist
Alias description:
Distance measured (in mm) by the histogram feature algorithm. In normal operation, these values should only slightly deviate from the standard distance values and can help compensate heavy lens soiling.

For versions S-(i)APOQ-XXXX-T-(ACC)-(HALL), S-(i)APOQ-XXXX-TR-(ACC)-(HALL) - appended bytes histogram debug data valid for ToF versions = 2!

The histogram data can be used with the usual distance parameters tof_distance (bytes 11-12) to compensate for heavy soiling on the sensor. In normal operation, these should only deviate slightly from the measured distances.

These functions should only be used after consultation and by experienced users!

Decoding Example (Febris)

Payload: 11 11 CE 14 8E 07 EE 1D 00 02 03 D6 01 D1 00
Bytes HEX Description
111Module key
211Module key
3CEUplink counter
414Battery voltage
58EBattery voltage
607Internal temperature
7EEInternal temperature
81DRelative humidity
900Dew point
1002Dew point
1103Air pressure
12D6Air pressure
1301CO₂
14D1CO₂
1500Alarm

Specifications subject to change without notice. All information provided without guarantee.

 

Documentation Links

You can find the links for further documentation on Apollon-Q T/R/TR here: