Neighbor Info Module is designed for transmitting information about each node's 0-hop neighbors within the mesh network. The configuration options include: Enabled, Update Interval, and Transmit Over LoRa.
Note: The Neighbor Info feature is purely informational and does not influence the routing behavior of the mesh network. As such, it is optional and is disabled by default.
To conserve bandwidth, Meshtastic does not track the route a packet takes to reach its destination, except when using Traceroute. When this module is activated and "Transmit Over LoRa" is enabled, your node will periodically send out packets containing a list of its direct neighbors along with the quality (SNR) of the corresponding links. If you enable this feature on all nodes, you can compile a graph of the entire network to observe how it is connected. As of now, there are no clients that visualize this data for you, but you can utilize MQTT to collect all the information.
To use this feature, ensure your devices are running firmware version 2.2.0 or higher. Starting from version 2.3.2, the module is capable of detecting neighbors even if other nodes do not have it enabled.
Neighbor Info Module Configuration Values
-
Enabled: Enables the Neighbor Info Module.
-
Update Interval: The frequency at which neighbor information is sent to the mesh cannot be set to less than 4 hours (14,400 seconds). The default interval is 6 hours (21,600 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 transmitted on the primary channel over LoRa. This feature is only available when the primary channel is not the public channel with the default key and name.
Neighbor Info Module Client
Android
All Neighbor Info Module configuration options are accessible for Android in app version 2.2.0 and higher.
-
Open the Meshtastic App.
-
Navigate to: Vertical Ellipsis (3 dots in the top right) > Radio Configuration > Neighbor Info.
Apple
Not yet implemented.
CLI
All Neighbor Info Module configuration options are available in the Python CLI version 2.2.0 and higher. For example:
-
Enable/Disable the Neighbor Info Module
| meshtastic --set neighbor_info.enabled true meshtastic --set neighbor_info.enabled false |
-
Set the update interval to 5 hours
| meshtastic --set neighbor_info.update_interval 18000 |
-
Set transmit over LoRa to true
| meshtastic --set neighbor_info.transmit_over_lora true |
-
Get the Neighbor Info Module Configuration
| meshtastic --get neighbor_info |
Web
All Neighbor Info Module configuration options are accessible in the Web UI.
