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

Nyx Payload Description

You are looking for the payload description for Nyx?

NYX – NFC & Downlink Description
📄 You can view the PDF above or download it here .

1. Payload Overview

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.

Terms Description
Byte No. Byte number starting at 1
Alias Comprehensible name of the variable
Description Description of the variables
Designation Designation in the Dataconverter
Unit Unit of the variables
Datahub .json key Key in the .json when using the data hub

Structure of the module key

Byte 1 Byte 2
Bit 7 – 4 Bit 3 – 0 Bit 7 – 4 Bit 3 – 0
Base 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, ...)

The module key of the SENTIFACE module can be taken from the first two bytes of each uplink. The module key is required for the downlink.

Uplink example (not applicable for Nyx)

Uplink payload example
Uplink payload decoding — byte‑wise interpretation of a telemetry payload.

Given is the following payload example for the Helios pressure sensor:

11 11 FE 1A D5 95 06 03 00 23 BE

Bytes 1 2 3 4 5 6 7 8 9 10 11
HEX 11 11 FE 1A D5 95 06 03 00 23 BE
Description Module key Module key Uplink Counter Battery Voltage Battery Voltage Temperature Alarm Flag Alarm Flag Measurement status Pressure mbar Pressure mbar

Nyx payload description

Byte number Alias name Unit Designation in the payload 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, i.e. always 0x1.
• 4-bit LSB: Major version. FW of the same major version but larger minor versions 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.
3 Uplink counter - uplink_counter XXX1 uplink_counter
Description:
Protocol-independent uplink counter that reaches a maximum of 255. After that, the counter starts again at 0.
4 – 5 Battery voltage mV battery_voltage XXX1 battery_voltage
Description:
Current voltage of the battery in millivolts.
(dataBytes[3] << 8 | dataBytes[4]) / 1000.0
6 – 7 Internal temperature °C internal_temperature XXX1 internal_temperature
Description:
((bytes[5] << 8) | bytes[6]) / 10 - 100
Temperature of the sensor according to the technical data sheet.
8 Relative humidity %RH humidity XXX1 humidity
Description:
Relative humidity in percent.
9 – 10 Dew point °C dew_point XXX1 dew_poin
Description:
Dew point in degrees Celsius.
11 Alarm variable - alarm-level XXX1 alarm-leve
Description:
Alarm level corresponding to green, yellow, and red LED states.
12 – 13 Light intensity indicator lux raw_lux XXX1 raw_lux
Description:
Light intensity in lux as an indicator (no direct ambient light measurement).
decoded.lux = (1 << (raw_lux >> 12)) * (raw_lux & 0x0FFF) * 0.01
14 Gas sensor status °C internal_temperature XXX4 internal_temperature
Description:
Jamming status of the gas sensor.
15 – 16 Air pressure %RH pressure XXX4 pressure
Description:
Air pressure value.
17 Indoor Air Quality Status - iaq_status XXX4 iaq_status
Description:
Indoor Air Quality status indicator.
18 – 19 Indoor Air Quality Index - Iaq_index XXX4 Iaq_index
Description:
Indoor Air Quality index value.

IAQ Index

The IAQ index (Indoor Air Quality Index) is an indicator that assesses the quality of indoor air and is often used to describe the health status of indoor air. It is typically calculated on the basis of measurements of various air pollutants.

Objective of the IAQ index

  • Health protection: The IAQ index indicates how safe or healthy the air is for the people in the room.
  • Orientation aid: It enables a simple and comprehensible interpretation of the air quality, often in the form of a scale value or a color classification.

Important parameters for the IAQ index

The IAQ index is based on various factors and measurements, including:

  1. Carbon dioxide (CO₂):
    • High concentrations can cause fatigue, concentration problems, and discomfort.
    • Typical limit: 400–1000 ppm (parts per million) is considered acceptable.
  2. Volatile organic compounds (VOC):
    • Chemical substances released from paints, cleaning products, furniture, or electronic equipment.
    • At high concentrations, VOCs can cause headaches, irritation, or long-term health problems.
  3. Particulate matter (PM2.5 / PM10):
    • Fine particles created by smoke, cooking fumes, or dust.
    • Particulate matter can cause respiratory illnesses and other health problems.
  4. Carbon monoxide (CO):
    • A toxic gas produced by incomplete combustion.
    • Even low concentrations can be dangerous.
  5. Relative humidity and temperature:
    • These values affect well-being and the growth of mold or bacteria.

Classification of the IAQ index

Many IAQ systems use a numerical or color scale to represent air quality. An example classification is shown below.

IAQ value Air quality Description
0 – 50 Excellent No health risks.
51 – 100 Good Low risks for sensitive persons.
101 – 150 Moderate May be problematic for sensitive individuals.
151 – 200 Unhealthy Possible adverse effects for the general population.
201 – 300 Very unhealthy Health problems with prolonged exposure.
301+ Dangerous Serious health risks.

Examples decoding

Payload: 11 11 A2 0D 29 09 38 2B 04 06 00 03 A0

Bytes 1 2 3 4 5 6 7 8 9 10 11 12 13
HEX 11 11 A2 0D 29 09 38 2B 04 06 00 03 A0
Description Module key Module key Uplink counter Battery voltage Battery voltage Temperature Temperature Rel. humidity Dew point Dew point Alarm flag Light intensity Light intensity
Example payload decoder output
Decoded NYX payload output.
LoRaWAN und mioty Logos Nyx device illustration

© Sentinum GmbH – All rights reserved.

All contents of this document, including text, tables, and images, are protected by copyright and are the property of Sentinum GmbH.

All images are subject to the copyright of Sentinum GmbH unless otherwise stated.

Reproduction, distribution, or use — even in excerpts — is not permitted without explicit written permission.

Specifications are subject to change without notice. All information is provided without warranty.