mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-02-01 00:01:13 -08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Add "Transmit Over LoRa" setting for NeighborInfo Module (#1570)

Browse source 
And document new minimum broadcast interval

Co-authored-by: rcarteraz <robert.l.carter2@gmail.com>
This commit is contained in:
GUVWAF 2024-11-14 20:43:50 +01:00 committed by GitHub
parent 10b4b8f89d
commit d37fd13e7d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 13 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/configuration/module/neighbor-info.mdx
View file

@ -8,13 +8,13 @@ description: This module allows you to send information about your immediate(0 h
import Tabs from "@theme/Tabs"; import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem"; import TabItem from "@theme/TabItem";
The Neighbor Info Module is for sending information on each node's 0-hop neighbors to the mesh. Config options are: Enabled and Update Interval. The Neighbor Info Module is for sending information on each node's 0-hop neighbors to the mesh. Config options are: Enabled, Update Interval and Transmit Over LoRa.
:::info :::info
Neighbor Info is informative only and does not affect the routing behavior of the mesh network. It is therefore optional and disabled by default. Neighbor Info is informative only and does not affect the routing behavior of the mesh network. It is therefore optional and disabled by default.
::: :::
In order to save bandwidth, Meshtastic does not keep track of the route a packet is taking to get to the destination, except when using Traceroute. When enabling this module, your node will periodically send out a packet with a list of its direct neighbors and the quality (SNR) of the corresponding link. If you enable this on all nodes, you can build up a graph of the full network to see how it is connected. At the time of writing, there are no clients visualizing it for you, but you can use e.g. MQTT to gather all the data. In order to save bandwidth, Meshtastic does not keep track of the route a packet is taking to get to the destination, except when using Traceroute. When enabling this module and enabling "Transmit Over LoRa", your node will periodically send out a packet with a list of its direct neighbors and the quality (SNR) of the corresponding link. If you enable this on all nodes, you can build up a graph of the full network to see how it is connected. At the time of writing, there are no clients visualizing it for you, but you can use e.g. MQTT to gather all the data.
In order to use it, make sure your devices use firmware version 2.2.0 or higher. From 2.3.2 on, the module can detect neighbors even if other nodes do not have the module enabled. In order to use it, make sure your devices use firmware version 2.2.0 or higher. From 2.3.2 on, the module can detect neighbors even if other nodes do not have the module enabled.
@ -26,7 +26,11 @@ Enables the Neighbor Info Module.
### Update Interval ### Update Interval
How often the neighbor info is sent to the mesh. How often the neighbor info is sent to the mesh. This cannot be set lower than 4 hours (14400 seconds). The default is 6 hours (21600 seconds).
### Transmit Over LoRa
Available from firmware 2.5.13 and higher. By default, neighbor info will only be sent to MQTT and a connected app. If enabled, the neighbor info will be sent on the primary channel over LoRa. Only available when the primary channel is not the public channel with default key and name.
## Neighbor Info Module Client Availability ## Neighbor Info Module Client Availability
@ -74,8 +78,12 @@ meshtastic --set neighbor_info.enabled true
meshtastic --set neighbor_info.enabled false meshtastic --set neighbor_info.enabled false
``` ```
```shell title="Set the update interval to 10 minutes" ```shell title="Set the update interval to 5 hours"
meshtastic --set neighbor_info.update_interval 600 meshtastic --set neighbor_info.update_interval 18000
```
```shell title="Set transmit over LoRa to true"
meshtastic --set neighbor_info.transmit_over_lora true
``` ```
```shell title="Get the Neighbor Info Module Configuration" ```shell title="Get the Neighbor Info Module Configuration"