Caution! Article for developers
Information on this page is intended particularly for users with advanced technical knowledge.Node Telemetry
Mar 29, 2023 · 3 minutes to read
This article describes the Node Telemetry feature in Treon Aito Release 7.0 for Gateway and higher releases.
In Treon Aito Release 7.0 for Gateway and higher, 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.
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"}
| JSON | Description |
|---|---|
| Timestamp | Unix epoch (ms) when the Treon Gateway received the message. |
| HopCount | The number of “hops” the node is away from sink. The Treon Gateway has a HopCount of 0. A node connected directly to the gateway has a HopCount of 1. |
| TravelTime | The time messages take to reach the sink. |
| NextHopRSSI | The RSSI (signal strength) in dB for the next node closer to sink. |
| NextHopAddr | The Wirepas address of the next node closer to sink. |
| SinkAddr | The Wirepas address of the Treon Gateway the node is connected to. |
| Role | This value is represented in decimal, but Wirepas documentation can show these as hex sometimes. 130 is Routing ON, 3 is non-routing and 20 is for the sink (Treon Gateway). |
| AccessCycle | How many miliseconds the node sleeps in between access cycles. |
| NextHopCost | A calculated value for Wirepas diagnostics that is used by nodes to select the optimal route to the sink. |
| SensorNodeId | The serial number the node uses. In this data set and apart from this value, the nodes are identified by their Wirepas address instead. |
Please also see the full JSON specification according to JSON Schema.
Activating Node Telemetry
In Treon Aito Release 7.0.1 for Gateway, the Node Telemetry feature needs to be activated manually via a small configuration change.
(In the next Treon Aito Release for Gateway, it is planned that it will be possible to enable the feature and setting the message interval via DM-commands over an MQTT connection.)
- Connect via SSH to the Treon Gateway.
- Active your desired Diagnostic Interval with:
sudo sed -i "/DiagnosticInterval=/c\DiagnosticInterval=600" /opt/iotgw/conf.d/wirepas_override.conf
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.
- Create a .conf file in /opt/iotgw/conf.d/:
echo -e "[Startup]\nDataProcessors3 += WpDiag" > /opt/iotgw/conf.d/nodetelemetry.conf
- Apply the changes with:
sudo systemctl restart iotgw
Treon Customer Support
If you have further questions, please contact Treon Customer Support.
