Neighbor Info Module Usage
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 LoRaLoRaA low-power, long-range wireless communication technology used by Meshtastic devices to enable communication over distances of several kilometers without the need for cellular, Wi-Fi, or other traditional network infrastructures..
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 and enabling "Transmit Over LoRaLoRaA low-power, long-range wireless communication technology used by Meshtastic devices to enable communication over distances of several kilometers without the need for cellular, Wi-Fi, or other traditional network infrastructures.", your node will periodically send out a packet with a list of its direct neighbors and the quality (SNRSNR (Signal-to-Noise Ratio). A measure used in communications to quantify the level of a desired signal to the level of background noise. In Meshtastic and other wireless systems, a higher SNR indicates a clearer signal that can enhance the reliability and quality of data transmission.) 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. MQTTMQTT (Message Queuing Telemetry Transport). A lightweight messaging protocol designed for small sensors and mobile devices, enabling efficient data transmission in the Meshtastic network for Internet connectivity and integration with IoT platforms. See https://en.wikipedia.org/wiki/MQTT. In Meshtastic, MQTT is used to connect a node to the internet, and can be used to connect multiple meshes to each other. 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.
Neighbor Info Module Config Values
Enabled
Enables the Neighbor Info Module.
Update Interval
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 MQTTMQTT (Message Queuing Telemetry Transport). A lightweight messaging protocol designed for small sensors and mobile devices, enabling efficient data transmission in the Meshtastic network for Internet connectivity and integration with IoT platforms. See https://en.wikipedia.org/wiki/MQTT. In Meshtastic, MQTT is used to connect a node to the internet, and can be used to connect multiple meshes to each other. and a connected app. If enabled, the neighbor info will be sent on the primary channel over LoRaLoRaA low-power, long-range wireless communication technology used by Meshtastic devices to enable communication over distances of several kilometers without the need for cellular, Wi-Fi, or other traditional network infrastructures.. Only available when the primary channel is not the public channel with default key and name.
Neighbor Info Module Client Availability
- Android
- Apple
- CLI
- Web
Android
All Neighbor Info Module config options are available for Android in app version 2.2.0 and higher.
- Open the Meshtastic App
- Navigate to: Settings > Neighbor Info
Apple
Not yet implemented.
All Neighbor Info Module config options are available in the python CLICLI (Command Line Interface). A text-based interface used for interacting with software or devices like Meshtastic. version 2.2.0 and higher.
Example commands are below:
meshtastic --set neighbor_info.enabled true
meshtastic --set neighbor_info.enabled false
meshtastic --set neighbor_info.update_interval 18000
meshtastic --set neighbor_info.transmit_over_lora true
meshtastic --get neighbor_info
All Neighbor Info module config options are available in the Web UI.