mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-11-10 07:34:11 -08:00
87 lines
1.7 KiB
Plaintext
87 lines
1.7 KiB
Plaintext
---
|
|
id: neighbor-info
|
|
title: Neighbor Info Module Usage
|
|
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
|
|
|
|
<Tabs
|
|
groupId="settings"
|
|
defaultValue="cli"
|
|
values={[
|
|
{label: 'Android', value: 'android'},
|
|
{label: 'Apple', value: 'apple'},
|
|
{label: 'CLI', value: 'cli'},
|
|
{label: 'Web', value: 'web'},
|
|
]}>
|
|
<TabItem value="android">
|
|
|
|
|
|
:::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**
|
|
:::
|
|
|
|
</TabItem>
|
|
<TabItem value="apple">
|
|
|
|
Not yet implemented.
|
|
|
|
</TabItem>
|
|
<TabItem value="cli">
|
|
|
|
:::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
|
|
```
|
|
|
|
|
|
</TabItem>
|
|
<TabItem value="web">
|
|
|
|
:::info
|
|
|
|
All Neighbor Info module config options are available in the Web UI.
|
|
|
|
:::
|
|
|
|
</TabItem>
|
|
</Tabs>
|