Node Telemetry

Sep 11, 2023 · 5 minutes to read

Introduction

From Treon Aito Release 7.1 for Gateway onward, it is possible to enable sending telemetry data from the nodes in the mesh network to the MQTT broker. This can be very helpful in monitoring the deployment quality and performance of the mesh network.

For example, issues such as low connection quality between individual nodes, long routing chains that may lead to increased power consumption, or message buffers maxing out on select nodes can easily be identified.

Please note: The feature already exists in Treon Aito Release 7.0 for Gateway, but needs to be activated manually in this release version.

The telemetry data will be sent to your backend with a time interval that is specified JSON format. An example of the data is:

{"DiagInterval":{"sink0":{"Interval":60,"SinkAddr":"11299123"}},"DiagData":{"13088562":{"Timestamp":1678698843805,"HopCount":1,"DeviceType":"unknown","TravelTime":0,"NextHopRSSI":-58,"NextHopAddr":11299123,"SinkAddr":11299123,"Role":130,"AccessCycle":8000,"NextHopCost":2,"SensorNodeId":"f933b7c7"},"11299123":{"Timestamp":1678698895593,"HopCount":1,"DeviceType":"unknown","TravelTime":23,"Role":20,"WirepasVersion":83886592}},"GatewayId":"52824fad","Type":"WirepasDiag","Ver":"1.0.0"}

The fields are defined as following:

Please also see the full JSON specification according to JSON Schema.

 

Activating Node Telemetry with SSH

In Treon Aito Release 7.0 for Gateway, the Node Telemetry feature needs to be activated manually via a small configuration change when connected to the Treon Gateway via SSH.

1. Connect via SSH to the Treon Gateway.
2. Active the desired Diagnostic Interval with the command:

sudo sed -i "/DiagnosticInterval=/c\DiagnosticInterval=600" /opt/iotgw/conf.d/wirepas_override.conf

Replace 600 with the desired Diagnostic Interval value in seconds. The only accepted values are: 0, 30, 60, 120, 300, 600 and 1800. A value of 0 will deactivate diagnostics completely.

3. Create a .conf file in /opt/iotgw/conf.d/:

echo -e "[Startup]\nDataProcessors3 += WpDiag" > /opt/iotgw/conf.d/nodetelemetry.conf

4. Apply the changes with: sudo systemctl restart iotgw

Activating Node Telemetry with DM commands

In Treon Aito Release 7.1.1 for Gateway and higher, the Node Telemetry feature can also be activated via Device Management commands.

1. To activate/deactivate Node Telemetry with DM commands, you need to first enable the feature by turning it on or off with the following commands

Turn ON  
{"Ver": "2", "Cmd": "set", "T" : [33580,0],"Res":[7],"Val": ["AQ=="],"I":22}  

Turn OFF  
{"Ver": "2", "Cmd": "set", "T" : [33580,0],"Res":[7],"Val": ["AA=="],"I":22}  

2. Optional you can change the diagnostic interval with the following command

{"Ver": "2", "Cmd": "set", "T" : [33580,0],"Res":[5],"Val": ["AAA="],"I":22}  

Replace 600 with the desired value in seconds. The only accepted values are: 0,30,60,120,300,600 and 1800. A value of 0 will deactivate diagnostics.

3. You need to reboot the Treon Gateway to apply the changes with the command:

{"Ver": "2", "Cmd": "execute", "T" : [3,0],"Res":[4],"Val": ["AA=="],"I":22}

Using Node Telemetry

The diagnostic data you receive as JSON message will look as follows:

{
    "DiagInterval":
        {
         "sink0":
            {"Interval":300,"SinkAddr":"10000000"
            }
        },
    "DiagData":
        {
         "12345678":
            {"Timestamp":1600602053770,"HopCount":1,"DeviceType":"unknown","TravelTime":20,"NextHopRSSI":-40,"NextHopAddr":12000000,
             "SinkAddr":10000000,"Role":130,"AccessCycle":8000,"NextHopCost":4,"SensorNodeId":"a1a1a1a1"},
              },
    "GatewayId":"aaaaaaaa",
    "Type":"WirepasDiag",
    "Ver":"1.0.0"
}

In the process of self-organisation and optimization, the Wirepas mesh network takes multiple factors into account. This means that the NextHopCost value only states the cost factor of sending data to the next Wirepas device, not of sending the data to the sink.

Example

{
    "DiagInterval":
        {
         "sink0":
            {"Interval":300,"SinkAddr":"10000000"
            }
        },
    "DiagData":
        {
         "11111111":
            {"Timestamp":1600602000000,"HopCount":1,"DeviceType":"unknown","TravelTime":20,"NextHopRSSI":-40,"NextHopAddr":10000000,
             "SinkAddr":10000000,"Role":130,"AccessCycle":8000,"NextHopCost":2,"SensorNodeId":"a1a1a1a1"},
              },
{
         "11111112":
            {"Timestamp":1600602000000,"HopCount":2,"DeviceType":"unknown","TravelTime":80,"NextHopRSSI":-40,"NextHopAddr":11111112,
             "SinkAddr":10000000,"Role":130,"AccessCycle":8000,"NextHopCost":2,"SensorNodeId":"a2a2a2a2"},
              },
{
         "11111113":
            {"Timestamp":1600602000000,"HopCount":3,"DeviceType":"unknown","TravelTime":120,"NextHopRSSI":-40,"NextHopAddr":11111112,
             "SinkAddr":10000000,"Role":130,"AccessCycle":8000,"NextHopCost":1,"SensorNodeId":"a3a3a3a3"},
              },
{
         "11111114":
            {"Timestamp":1600602000000,"HopCount":3,"DeviceType":"unknown","TravelTime":140,"NextHopRSSI":-40,"NextHopAddr":11111112,
             "SinkAddr":10000000,"Role":130,"AccessCycle":8000,"NextHopCost":3,"SensorNodeId":"a4a4a4a4"},
              },
{
         "11111115":
            {"Timestamp":1600602000000,"HopCount":4,"DeviceType":"unknown","TravelTime":175,"NextHopRSSI":-40,"NextHopAddr":11111114,
             "SinkAddr":10000000,"Role":130,"AccessCycle":8000,"NextHopCost":4,"SensorNodeId":"a5a5a5a5"},
              },
{
         "11111116":
            {"Timestamp":1600602000000,"HopCount":4,"DeviceType":"unknown","TravelTime":250,"NextHopRSSI":-40,"NextHopAddr":11111114,
             "SinkAddr":10000000,"Role":130,"AccessCycle":8000,"NextHopCost":2,"SensorNodeId":"a6a6a6a6"},
              },
{
         "11111117":
            {"Timestamp":1600602000000,"HopCount":1,"DeviceType":"unknown","TravelTime":10,"NextHopRSSI":-40,"NextHopAddr":10000000,
             "SinkAddr":10000000,"Role":130,"AccessCycle":8000,"NextHopCost":1,"SensorNodeId":"a7a7a7a7"},
              },
{
         "11111118":
            {"Timestamp":1600602000000,"HopCount":1,"DeviceType":"unknown","TravelTime":7,"NextHopRSSI":-50,"NextHopAddr":10000000,
             "SinkAddr":10000000,"Role":3,"AccessCycle":8000,"NextHopCost":1,"SensorNodeId":"a8a8a8a8"},
              },


    "GatewayId":"abcd1234",
    "Type":"WirepasDiag",
    "Ver":"1.0.0"
}

In this example there is 1 Treon Gateway with 8 Treon Industrial Nodes:
1 Treon Industrial Node is connected directly to the Treon Gateway and is non-routing.
1 Treon Industrial Node is connected directly to the Treon Gateway and set to routing, though not routing any data.
1 Treon Industrial Node is connected directly and routing the data from 5 other nodes.

Using the data from NodeTelemetry, you can build the following topology tree in your backend:

 

Treon Support

You still have questions? Our dedicated team of experts is happy to help you! Please contact Treon Support directly by e-mail.

Did you know? Treon offers Premium Support and Maintenance Packages for our customers. Get even more out of Treon and boost your sales - inquire now about features and prices!