From bde566883dc3fa61ecb8df4b427cb5edc1776459 Mon Sep 17 00:00:00 2001 From: GUVWAF Date: Sun, 31 Mar 2024 14:39:07 +0200 Subject: [PATCH] Clarify NeighborInfo is informative only --- docs/configuration/module/neighbor-info.mdx | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/configuration/module/neighbor-info.mdx b/docs/configuration/module/neighbor-info.mdx index 4f97721c..e0d6226d 100644 --- a/docs/configuration/module/neighbor-info.mdx +++ b/docs/configuration/module/neighbor-info.mdx @@ -8,11 +8,15 @@ description: This module allows you to send information about your immediate(0 h import Tabs from "@theme/Tabs"; 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 and Update Interval. + +:::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. +::: 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 use it, make sure your devices use firmware version 2.2.0 or higher. +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