1. Help-Desk
  2. Important! Cross-product documentation for sensors

Generic NFC and downlink documentation

Are you looking for generic NFC and downlink documentation or wondering how to interpret certain parameters and values for activation?

Here you can find  NFC and downlink documentation

💡 This documentation is applicable to all Sentinum series sensors that have NFC and downlink functions. It serves as generic documentation. The individual descriptions of the fields can be found in the respective links.

Downlink

Basics of downlinks with Sentinum sensors

📢 All downlinks of the Sentiface and Senticom module are on port 4, all commands of the supervisor module, such as resets, are scheduled on port 5.

Like the payload, the downlink commands are divided into modules. The sensor merely acts as a container that manages and implements the commands. With the help of the downlinks, the sensor can be configured to the specific application. In addition to the configurations, you can also perform downlinks, such as a reset. All commands are protected by minimum and maximum values to prevent incorrect settings.
The structure is hierarchically structured and consists of the following elements:
• Module
• Group
• Property
• Command
A module has several groups, which in turn are made up of several properties.
The following table shows how the structure is generally structured:

 

Byte 0 

Byte 1 to 2 

Byte 3 

Byte 4 

Byte 5 to 8 

 

Token 

Module Key 

Group 

Property 

Value 

Length 

1 Byte 

Module Key 

Group 

Property 

Value 

Description 

Serves to assign a command confirmation to a previously sent command Can be freely selected by the user! (A consecutive number being useful) 

Describes the specific version of the sensor and selects the module 

Selects the group to which the command is assigned. 

Selects an ID (Property ID) in the group. Examples are available within the group. 

Contains the new property value. 

Example as Downlink 

0x01 

0x1111 

0x03 

0x00 

0x00 00 10 00 

💡 The command or the value that is set is always 4 bytes.

Modules and groups of the sensor

📢 All downlinks of the Sentiface and Senticom module are on port 4, all commands of the supervisor module, such as resets, are scheduled on port 5.

💡 Within different subversions, Sentinum guarantees backwards compatibility. This means that a Sentiface module with the key 0x1121 also accepts downlink commands with the key 0x1111.

Structure of the module key

💡 The module key of the SENTIFACE module can be taken from the first 2 bytes of each uplink.

Example Uplink: 11 11 06 1B E1 92 02 00 00 06 86

💡 1111 is the module key.

The module key explained here refers only to the SENTIFACE module. For SENTICOM the module key should always be 0x2111.

Structure of a downlink command

📢 An exception is the reset command. This is shown on page 9.

📢 In the first data packet (uplink) an alarm variable is usually set, since the value is compared with an internal reference value.

Reset command via downlink

The reset command has to be executed in 2 steps or in 2 downlinks on port 5: First the reset has to be sharpened with the command[TOKEN] 31 11 01 01  and can then be triggered with [TOKEN] 31 11 00.

Command HEX
Description
[TOKEN] 31 11 01 01
Reset Focus
[TOKEN] 31 11 00
Reset the sensor

Downlink example 

First we want to configure our sensor. We decide to put the sensor into a confirmed mode. For this we look at the following downlink (HEX code): 

Next, we want to change the measurement interval to 24 times per day (interval of 60 min). We proceed in this way: 

NFC

Basics

In addition to downlinks, the sensor can also be configured with a smartphone app via NFC. The different configurations of the sensor are called . Pass JSON. The app offers an initial configuration option as soon as the sensor is activated. In addition to the sensor settings, the app also allows the configuration of network parameters, such as APPEUI and APPKEY. Analogous to the downlink, the structure is hierarchically structured.

For the NFC configuration, both the modules (module names) and alias names for the individual properties are important. The following table describes the available modules.

Building one . json object

Each sensor profile is passed as a JSON object. Each object begins with { and ends with }. In one object, other objects can be integrated. In general, objects contain an ordered list of properties separated by commas. A property is a key-value pair consisting of a unique key (string) and a value (any element). The key and value are separated by a colon (:) . Let's look at the following example that has been formatted:Untitled (7)

As in the previous JSON example, the object follows a certain structure. The first key-value pair. If the sensor is disabled (power = off), you can activate the sensor with its basic settings, for example by loading an empty JSON and activating the sensor with the app. The setting of settings is also possible during activation.

💡 “power”:”OFF” or “power”:”ON” is a state of the sensor. The sensor responds with off or on to a command. “off” or “on” is not a command.

To restart the sensor (see restart on a PC) the “REBOOT” command must be written in the “power” field: 

{"power":"REBOOT"}

After a few seconds, the sensor writes the value “ON” in the “power” field and thus indicates the completion of the boot process.

Check the functioning of the sensor

With the help of the “REBOOT” command the functionality of the sensor can be checked. Overwrite the sensor. If the sensor does not overwrite the field after 15 seconds and remains in the {"power":"REBOOT"} state, an error has occurred. This usually indicates an empty battery

Activation, deactivation and app

Activation takes place via an NFC app. A smartphone is required for this. The app can be downloaded from the respective app stores. Simply search for "Sentinum LinQs" and download the app.

Untitled (29)

💡 Now locate the NFC tag on the sensor. Depending on the type of smartphone, the reader can be at the top, in the middle or further down.

Untitled (29)

💡 The position of the NFC tag on the sensor can be found in the respective operating instructions or in the Quickstart Guide.

📢 If keys such as app_eui and app_key are changed and then a REBOOT is performed, the original keys are set.

📢 The power key is not assigned to a module group.

You can find instructions for the NFC app here:

https://sentinum.notion.site/LinQs-Anleitungen-b6736b15d07e4452a9f9ea42057391f2?pvs=4

Further information on the NFC APP

💡 There are read only (r), write only (w) and read&wirte (rw) keys and values. For example, keys can be protected.

💡 If a profile is created and transmitted incorrectly, the previous settings are retained. This can happen, for example, if the JSON was created in the wrong format.

💡 When compiling the profile, several module groups can be accessed at once or only individual module groups. The same applies to the properties.

💡 In the latest version of the app, profiles can be created and saved. There will also be a function for reading out the sensors. In addition, data such as the location can be sent to a defined end point.

Saving values via downlink and NFC

💡 Values that are written to the NFC are also saved in the event of a reset or battery change and are retrieved by the sensor.

💡 Values that are set via downlink can be transferred to the NFC tag with an additional downlink command.

Product and application-specific downlink and NFC commands

Product name

Product range

NFC and Downlink Documentation

Helios-P

Helios

NFC und Downlink Dokumentation

Apollon-Q-T/R/TR

Apollon

NFC und Downlink Dokumentation

Febris CO2

Febris

NFC und Downlink Dokumentation

     

Neptun R/U

Neptun

NFC und Downlink Dokumentation

ZETA

Apollon

NFC und Downlink Dokumentation

Febris SCW

Febris

NFC und Downlink Dokumentation

Febris TH

Febris

NFC und Downlinkdokumentation

 

Downlink generic examples

Downlinks
Description
#Port
Cross-sensor
011111000000000005
Measuring period set to 5 minutes
4
Zeta
011111000200000001
Send pause factor 1
4
Zeta
0111110000000000050200000001
Measurement period set to 5 minutes and send pause factor 1
4
Zeta
012111010500000001
Enable downlink response
4
Zeta
07111100000000000A
Measurement period set to 10 minutes
4
Zeta
0121110102000000000400000000
ADR off SF12
4
Zeta

Document history

date
description
06.01.2023
Creation of the document