Add two-way traceroute and SNR per hop description (#1555)

* Add two-way traceroute and SNR per hop functionality

* Update traceroute availability for web

* Clarify firmware version and misc.

Co-authored-by: rcarteraz <robert.l.carter2@gmail.com>

* Update docs/configuration/module/traceroute.mdx

Co-authored-by: rcarteraz <robert.l.carter2@gmail.com>

* Clarify web instructions for traceroute

Co-authored-by: rcarteraz <robert.l.carter2@gmail.com>

---------

Co-authored-by: rcarteraz <robert.l.carter2@gmail.com>
This commit is contained in:
GUVWAF 2024-11-05 18:46:34 +01:00 committed by GitHub
parent 133b686a14
commit dec8ccc9ee
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -16,6 +16,8 @@ Only nodes that know the encryption key of the channel you use can be tracked. A
In order to use it, make sure your devices use firmware version 2.0.8 or higher.
From firmware version ≥ 2.5, the route back to the origin is recorded, along with the Signal-to-Noise Ratio (SNR) for each link. Nodes with older firmware or those unable to decrypt the traceroute will be shown as "Unknown" (represented by an ID equal to 4294967295 or 0xFFFFFFFF in hexadecimal) if all nodes in the route are using at least firmware version 2.3.12.
<object data="https://www.youtube.com/embed/PKUmaELKaUo?autohide=1&autoplay=0" width="100%" height="400"></object>
## Repeater Behavior
@ -63,18 +65,20 @@ Where for `destinationId` you have to fill in the ID of the destination you want
meshtastic --traceroute '!bff18ce4'
Connected to radio
Sending traceroute request to !bff18ce4 (this could take a while)
Route traced:
!25048234 --> !ba4bf9d0 --> !bff18ce4
Route traced towards destination:
!25048234 --> !ba4bf9d0 (6.0dB) --> !bff18ce4 (-3.5dB)
Route traced back to us:
!bff18ce4 --> !ba4bf9d0 (-2.75dB) --> !25048234 (5.25dB)
```
The first ID shown is the device you are connected to with the CLI. As you can see, this packet went through one other node to get to its destination.
The first ID shown is the origin device connected via the CLI. As demonstrated in the image above, the packet traveled through one additional node to reach its destination and return.
</TabItem>
<TabItem value="web">
#### Web
Not yet implemented.
After selecting a node from the list, click the "route" button in the top-right corner to send a traceroute request to the selected node. The result will be displayed on the nodes message page.
</TabItem>
</Tabs>