mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-11-09 23:24:10 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #554 from GUVWAF/traceroute

Browse source 
Traceroute usage guide
This commit is contained in:
Garth Vander Houwen 2023-01-05 11:15:23 -08:00 committed by GitHub
parent e222c0165f abde4627f1
commit b77c095aa6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 67 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/configuration/module-config/index.mdx
View file

@ -17,3 +17,4 @@ Modules are included in the firmware and allow users to extend the functionality
| [Range Test](/docs/settings/moduleconfig/range-test) | Send messages with GPS location at an interval to test the distance your devices can communicate. Requires (at least) one device set up as a sender and one as a receiver. The receiver(s) will log all incoming messages to a CSV. |
| [Serial Module](/docs/settings/moduleconfig/serial) | Send messages across the mesh by sending strings over a serial port. |
| [Telemetry](/docs/settings/moduleconfig/telemetry) | Attach sensors to the device and transmit readings on a regular interval to the mesh. |
| [Traceroute](/docs/settings/moduleconfig/traceroute) | Track which nodes are used to hop a message to a certain destination. |

66
docs/configuration/module-config/traceroute.mdx Normal file
View file

@ -0,0 +1,66 @@
---
id: traceroute
title: Traceroute Module Usage
slug: /settings/moduleconfig/traceroute
sidebar_label: Traceroute
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Due to the limited bandwidth of LoRa, Meshtastic does not keep track of the nodes a message used to hop to the destination. However, from firmware 2.0.8 on, there is a Traceroute Module that can show you this.
Only nodes that know the encryption key of the channel you use can be tracked. Also note that a message may arrive via multiple routes due to duplication because of rebroadcasting. This module will only track the hops of the first packet containing the traceroute request that arrived at the destination.
In order to use it, make sure your devices use firmware version 2.0.8 or higher.
## Traceroute Module Client Availability
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'CLI', value: 'cli'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="android">
Not yet implemented.
</TabItem>
<TabItem value="apple">
Make sure the app is at least version 2.0.9.
Under Contacts > Direct Messages, long hold a destination node and select 'Trace Route' to send the request. Depending on the amount of hops that is needed, this might take a while. The result will be shown in the Mesh Log.
</TabItem>
<TabItem value="cli">
Make sure the CLI is at least version 2.0.6. Then use this command:
```shell title="CLI traceroute command"
meshtastic --traceroute 'destinationId'
```
Where for `destinationId` you have to fill in the ID of the destination you want to track the hops to, which you can get from running `meshtastic --nodes`. Depending on your OS, you might need quotation marks around the ID. Then it will send a specific message to track the hops. For example, this is what you will get:
```shell title="Traceroute from !25048234 to !bff18ce4"
meshtastic --traceroute '!bff18ce4'
Connected to radio
Sending traceroute request to !bff18ce4 (this could take a while)
Route traced:
!25048234 --> !ba4bf9d0 --> !bff18ce4
```
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.
</TabItem>
<TabItem value="web">
Not yet implemented.
</TabItem>
</Tabs>