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

Apollon-Q PP Payload Description

You are looking for a payload description for the Apollo-Q-PP

Here you can find a payload description for the Apollon-Q PP 👇

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

This section 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.

Terms 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, ...)

Uplink example 

Apollon-Q PP Payload description 

Byte number Alias Name Unit Designation in the payload decoder Module key Datahub .json key
1 – 2Module keymodule_keyXXX1module_key
Description:
Byte 1:
• 4 bit MSB: Module code. For Mioty exclusively "Sentiface" telemetry module, i.e. always 0x1.
• 4 bit LSB: Major version. FW of the same major version but larger minor version remain compatible with older decoders. However, the number of bytes may change!
Byte 2:
• 4 bit MSB: Minor version. New SW versions may incrementally add new telemetry to the data packet.
• 4 bit LSB: Sub / Product Version. With Helios, these bits encode the specific configuration of connected sensors.
3Uplink counteruplink_counterXXX1uplink_counter
Description:
Protocol-independent uplink counter that reaches a maximum of 255. After that, the counter starts again at 0.
4 – 5Battery voltagemVbattery_voltageXXX1battery_voltage
Description:
Current voltage of the battery in millivolts
//Voltage in volts battery_voltage: (dataBytes[3] << 8 | dataBytes[4]) / 1000.0
6Internal temperature°Cinternal_temperatureXXX1internal_temperature
Description:
Internal temperature of the sensor + 128
//Temp. in °C internal_temperature: dataBytes[5] - 128
7Alarm variablealarmXXX1alarm
Description:
Variable that indicates whether error codes and values are being transmitted.
An error occurs with values >16
255: Internal hardware error ToF
For all values <16 are levels that were measured
8Status object, ToF sensor statusobject_statusXXX1object_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
9 – 10Distancemmobject_distanceXXX1object_distance
Description:
Distance to the current object in mm
11 – 12Object sigmaobject_sigmaXXX1object_sigma
Description:
Minimum variance and standard deviation with which a target is perceived as a target. If the sigma is too small, the probability of false detections increases
13 – 14Object signalobject_signalXXX1object_signal
Description:
Minimum number of photons, minimum reflectivity that must come back from the target in order to be recognized as a target
15 – 16Object Ambientobject_ambientXXX1object_ambient
Description:
Ambient light of the target, not qualitative

Decoding example ( Febris) 

Payload: 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₂ ALARM
15 00 Alarm

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