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

 

Hier finden Sie eine Payload Beschreibung für den Apollon-Q-T/R/TR

Hier finden Sie die Tabelle für eine übersichtliche Dartstellung:

🔽🔽

Apollon-Q T/R/TR Payload Beschreibung Tabelle


Byte: 1-2
Alias: Module key
Description: module_key
Valid for versions: All - base payload, valid and available for all sensors of the Apollon-Q-T/R/TR(-ACC)(-HALL) series
Description:
Byte 1

  • 4-bit MSB: Module code. For mioty only ‘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.

Byte: 1-2
Alias: Uplink Counter
Name: uplink_counter
Valid for versions: All - basic payload, valid and available for all sensors of the Apollon-Q-T/R/TR(-ACC)(-HALL) series
Description: Protocol-independent uplink counter that reaches a maximum of 255. After that, the counter starts again at 0.


Byte: 4-5
Alias: Battery Voltage
Name: internal_temperature
Valid for versions: All - base payload, valid and available for all sensors of the Apollon-Q-T/R/TR(-ACC)(-HALL) series
Description: Current voltage of the battery in millivolts
//Voltage in volts battery_voltage: (dataBytes[3] << 8 | dataBytes[4]) / 1000.0


Byte: 6
Alias: Internal temperature
Name: battery_voltage
Valid for versions: All - base payload, valid and available for all sensors of the Apollon-Q-T/R/TR(-ACC)(-HALL) series
Description: Internal temperature of the sensor + 128 //Temp. in °C internal_temperature: dataBytes[5] - 128.


Byte: 7
Alias: Alarm Variable
Name: alarm
Valid for versions: All - base payload, valid and available for all sensors of the Apollon-Q-T/R/TR(-ACC)(-HALL) series
Description: Uplink was caused by an alarm.

  • 0: Alarm not triggered
  • 1: Alarm triggered
  • 1 set if one of the alarm variables fails (is formed from the logical OR of all alarm variables) Opening alarm deactivated by default!

Byte: 8 - 9
Alias: Master measured value, general measured value
Description: master_value
Valid for versions: All - base payload, valid and available for all sensors of the Apollon-Q-T/R/TR(-ACC)(-HALL) series
Description: 

  • for APOQ-XXXX-T versions corresponds to the
    current measured value of the ToF sensor in mm
  • For APOQ-XXXX-R versions, corresponds to the
    measured value for the maximum peak of the radar
    in mm
  • corresponds for APOQ-XXXX-TR versions to a calculated
    measured value from the current distances of the
    of the two measuring principles in mm

For versions S-APOQ-XXXX-T-(ACC)-(HALL)


Byte: 10
Alias: Status ToF Sensor
Name: tof_status
Valid for versions: S-APOQ-XXXX-T-(ACC)-(HALL)
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

Byte: 11 - 12
Alias: Distance (see master value if the source of the sensor is the same)
Description: tof_distance
Valid for versions: S-APOQ-XXXX-T-(ACC)-(HALL)
Description: Current measured distance of the ToF sensor in mm.


Byte: 13
Alias: Mode ToF (Index)
Name: tof_index
Valid for versions: S-APOQ-XXXX-T-(ACC)-(HALL)
Description: Mode in which the sensor recorded the last value.
recorded.

  • 0: Short Up to 1.3 metres
  • 1: Medium Up to 3 metres
  • 2: Long Up to 4 metres

For versions S-APOQ-XXXX-R-(ACC)-(HALL)


Byte: 10
Alias: Status radar
Name: radar_status
Valid for versions: S-APOQ-XXXX-R-(ACC)-(HALL)
Description: 

  • 0: Error
  • 1: Success

Byte: 11
Alias: Number of peaks
Name: radar_no_peaks
Valid for versions: S-APOQ-XXXX-R-(ACC)-(HALL)
Description: Number of peaks detected.


Byte: 12 - 13
Alias: Distance 1
Name: radar_distance_1
Valid for versions: S-APOQ-XXXX-R-(ACC)-(HALL)
Description: Distance with maximum peak in mm.


Byte: 14 - 15
Alias: Peak 1
Name: radar_peak_1
Valid for versions: S-APOQ-XXXX-R-(ACC)-(HALL)
Description: Distance with maximum peak in mm.


Byte: 16 - 17
Alias: Distance 2
Name: radar_distance_2
Valid for versions: S-APOQ-XXXX-R-(ACC)-(HALL)
Description: Distance with second highest peak in mm.


Byte: 18 - 19
Alias: Peak 2
Name: radar_peak_2
Valid for versions: S-APOQ-XXXX-R-(ACC)-(HALL)
Description: Distance with second highest peak in mm.


Byte: 20 - 21
Alias: Distance 3
Name: radar_distance_3
Valid for versions: S-APOQ-XXXX-R-(ACC)-(HALL)
Description: Distance with third highest peak in mm.


Byte: 22 - 23
Alias: Peak 3
Name: radar_peak_3
Valid for versions: S-APOQ-XXXX-R-(ACC)-(HALL)
Description: Distance with third highest peak in mm.


For versions S-APOQ-XXXX-TR-(ACC)-(HALL)


Byte: 10
Alias: Status ToF Sensor
Name: tof_status
Valid for versions: S-APOQ-XXXX-TR-(ACC)-(HALL)
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

Byte: 11 - 12
Alias: Distance (see master value if the source of the sensor is the same)
Description: tof_distance
Valid for versions: S-APOQ-XXXX-TR-(ACC)-(HALL)
Description: Current measured distance of the ToF sensor in mm.


Byte: 13
Alias: Mode ToF (Index)
Name: tof_index
Valid for versions: S-APOQ-XXXX-TR-(ACC)-(HALL)
Description: Mode in which the sensor recorded the last value.
recorded.

  • 0: Short Up to 1.3 metres
  • 1: Medium Up to 3 metres
  • 2: Long Up to 4 metres

Byte: 14
Alias: Status radar
Name: radar_status
Valid for versions: S-APOQ-XXXX-TR-(ACC)-(HALL)
Description: 

  • 0: Error
  • 1: Success

Byte: 15
Alias: Number of peaks
Name: radar_no_peaks
Valid for versions: S-APOQ-XXXX-TR-(ACC)-(HALL)
Description: Number of peaks detected.


Byte: 16 - 17
Alias: Distance 1
Name: radar_distance_1
Valid for versions: S-APOQ-XXXX-TR-(ACC)-(HALL)
Description: Distance with maximum peak in mm.


Byte: 18 - 19
Alias: Peak 1
Name: radar_peak_1
Valid for versions: S-APOQ-XXXX-TR-(ACC)-(HALL)
Description: Distance with maximum peak in mm.


Byte: 20 - 21
Alias: Distance 2
Description: radar_distance_2
Valid for versions: S-APOQ-XXXX-TR-(ACC)-(HALL)
Description: Distance with second highest peak in mm.


Byte: 22 - 23
Alias: Peak 2
Description: radar_peak_2
Valid for versions: S-APOQ-XXXX-TR-(ACC)-(HALL)
Description: Distance with second highest peak in mm.


Byte: 24 - 25
Alias: Distance 3
Description: radar_distance_3
Valid for versions: S-APOQ-XXXX-TR-(ACC)-(HALL)
Description: Distance with third highest peak in mm.


Byte: 26 - 27
Alias: Peak 3
Description: radar_peak_3
Valid for versions: S-APOQ-XXXX-TR-(ACC)-(HALL)
Description: Distance with third highest peak in mm.


Für Versionen S-APOQ-XXXX-XX-ACC-HALL - angehängte Bytes


Byte: 1 byte appended
Alias: Sensor status of the acceleration sensor
Name: acc_status
Valid for versions: S-APOQ-XXXX-XX-(ACC)-(HALL)
Description: Returns the status of the sensor

  • 0: OK
  •  others: Error

Byte: 1 byte appended
Alias: Displays the orientation of the sensor
Name: acc_orientation
Valid for versions: S-APOQ-XXXX-XX-(ACC)-(HALL)
Description: Shows the orientation of the sensor:

  • 0: Vertical: Lies on the side
  • 1: Face up: Lens points to the ceiling
  • 2: Face Down: Lens points to the floor
  • 3: Error

Byte: 1 byte appended
Alias: Flap opening acceleration sensor
Designation: acc_open
Valid for versions: S-APOQ-XXXX-XX-(ACC)-(HALL)
Description: Indicates whether the cover is still open after a certain time interval.


Byte: 1 byte appended
Alias: Openings Lifetime Counter Acceleration sensor
Description: acc_open_cnt
Valid for versions: S-APOQ-XXXX-XX-(ACC)-(HALL)
Description: Indicates how many openings have been performed (over the entire life cycle).


Byte: 1 byte appended
Alias: Vandalism alarm
Description: acc_impact
Valid for versions: S-APOQ-XXXX-XX-(ACC)-(HALL)
Description: Indicates whether a vandalism event is acute or not

  • 0: No vandalism event displayed
  •  1: Vandalism event displayed 

Byte: 1 byte appended
Alias: Flap opening hall sensor
Designation: hall_open
Valid for versions: S-APOQ-XXXX-XX-(ACC)-(HALL)
Description:
Indicates whether the sensor is vertical (whether a flap to which the sensor is attached is open).

  • 1: Open
  • 0: Closed

Byte: 1 byte appended
Alias: Openings Lifetime Hall
Designation: hall_open_cnt
Valid for versions: S-APOQ-XXXX-XX-(ACC)-(HALL)
Description: Indicates how many openings were performed (over the entire life cycle).


Documentation Links

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