diff --git a/docs/configuration/module-config/index.mdx b/docs/configuration/module-config/index.mdx index e2967e5e..38e77cec 100644 --- a/docs/configuration/module-config/index.mdx +++ b/docs/configuration/module-config/index.mdx @@ -14,6 +14,7 @@ Modules are included in the firmware and allow users to extend the functionality | [Canned Message](/docs/settings/moduleconfig/canned-message) | Set a number of predefined messages to send out directly from the device with the use of an input device like a rotary encoder. | | [External Notification](/docs/settings/moduleconfig/external-notification) | Incoming messages are able to alert you using circuits you attach to the device (LEDs, Buzzers, etc). | | [MQTT](/docs/settings/moduleconfig/mqtt) | Forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on another mesh over the internet. | +| [Neighbor Info](/docs/settings/moduleconfig/neighbor-info) | Send info on 0-hop neighbors to the mesh. | | [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. | | [Store & Forward](/docs/settings/moduleconfig/store-and-forward-module) | Stores messages on a device for delivery after disconnected clients rejoin the mesh. | diff --git a/docs/configuration/module-config/neighbor-info.mdx b/docs/configuration/module-config/neighbor-info.mdx new file mode 100644 index 00000000..053a7d4c --- /dev/null +++ b/docs/configuration/module-config/neighbor-info.mdx @@ -0,0 +1,83 @@ +--- +id: neighbor-info +title: Neighbor Info Module Usage +slug: /settings/moduleconfig/neighbor-info +sidebar_label: Neighbor Info +--- + +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. + +In order to use it, make sure your devices use firmware version 2.2.0 or higher. + +## Neighbor Info Module Config Values + +### Enabled + +Enables the Neighbor Info Module. + +### Update Interval + +How often the neighbor info is sent to the mesh. + + +## Neighbor Info Module Client Availability + + + + + +:::info +All Neighbor Info Module config options are available for Android in app version 2.2.0 and higher. + +1. Open the Meshtastic App +2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > Neighbor Info** +::: + + + + +Not yet implemented. + + + + +:::info + +All Neighbor Info Module config options are available in the python CLI version 2.2.0 and higher. + +::: + +Example commands are below: + +```shell title="Enable/Disable the Neighbor Info Module" +meshtastic --set neighbor_info.enabled true +meshtastic --set neighbor_info.enabled false +``` + +```shell title="Set the update interval to 10 minutes" +meshtastic --set neighbor_info.update_interval 600 +``` + +```shell title="Get the Neighbor Info Module Configuration" +meshtastic --get neighbor_info +``` + + + + + +Not yet implemented. + + +