mirror of
https://github.com/meshtastic/meshtastic.git
synced 2025-03-05 21:00:08 -08:00
Add Range test module details for 1.3
This commit is contained in:
Garth Vander Houwen
parent
306488f7bc
commit
0f182bcd53
|
|
@ -4,6 +4,15 @@ title: 1.3 Module Configuration
|
|||
sidebar_label: 1.3 Module Config
|
||||
sidebar_position: 2
|
||||
---
|
||||
import ModuleOverviewText from '@site/docs/_blocks/_module_overview_text.mdx';
|
||||
|
||||
<ModuleOverviewText/>
|
||||
Modules are included in the firmware and allow users to extend the functionality of their mesh or device.
|
||||
|
||||
The list of current modules is as follows:
|
||||
|
||||
| Name | Description |
|
||||
|:----:|:-----------:|
|
||||
| [Range Test Module](/docs/settings/moduleconfig/range-test-module) | 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. |
|
||||
|
||||
:::tip
|
||||
Once module settings are changed, a **reset** is required for them to take effect.
|
||||
:::
|
||||
|
|
|
|||
222
docs/settings/moduleconfig/range-test.mdx
Normal file
222
docs/settings/moduleconfig/range-test.mdx
Normal file
|
|
@ -0,0 +1,222 @@
|
|||
---
|
||||
id: range-test-module
|
||||
title: Range Test Module Configuration
|
||||
sidebar_label: Range Test
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
|
||||
The range test module config options are: Enabled, Save, and Sender. Range Test Module config uses an admin message sending a `ConfigModule.RangeTest` protobuf.
|
||||
|
||||
This module allows you to test the range of your Meshtastic nodes. It requires at least two nodes, a sender and a receiver. The receiving node then saves the messages along with the GPS coordinates at which they were received into a .csv file. This .csv file can then be integrated into [Google Earth](https://earth.google.com), [Google Maps - My Maps](https://mymaps.google.com), or any other program capable of processing .csv files. This can enable you to visualize your mesh.
|
||||
|
||||
## Range Test Module Config Values
|
||||
|
||||
### Enabled
|
||||
|
||||
Enables the range test module.
|
||||
|
||||
### Save CSV File
|
||||
|
||||
**ESP32 Only Setting**
|
||||
|
||||
If enabled, we will save a log of all received messages to a file named rangetest.csv which you can access from the web server Extensions > File Browser > rangetest.csv. The file will be created after receiving messages. The device will abort writing if there is less than 50k of space on the filesystem to prevent filling up the storage.
|
||||
|
||||
### Sender Interval
|
||||
|
||||
How long to wait between sending test packets. 0 is default which disables sending messages.
|
||||
|
||||
## Range Test Module Config Client Availability
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="flasher"
|
||||
values={[
|
||||
{label: 'Android', value: 'android'},
|
||||
{label: 'Apple', value: 'apple'},
|
||||
{label: 'Command Line', value: 'cli'},
|
||||
{label: 'Flasher', value: 'flasher'},
|
||||
{label: 'Web', value: 'web'},
|
||||
]}>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Range Test features are available for Android.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="apple">
|
||||
|
||||
:::info
|
||||
Range test module config is not yet available on Apple OS's.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="cli">
|
||||
|
||||
All range test module config options are available in the python CLI. Example commands are below:
|
||||
|
||||
| Setting | Acceptable Values | Default |
|
||||
| :-----------------------: | :-----------------: | :-----: |
|
||||
| range_test_module_enabled | `true`, `false` | `false` |
|
||||
| range_test_module_save | `true`, `false` | `false` |
|
||||
| range_test_module_sender | `integer` (Seconds) | `0` |
|
||||
|
||||
```shell title="Enable the module"
|
||||
meshtastic --set range_test_module_enabled true
|
||||
```
|
||||
|
||||
```shell title="Disable the module"
|
||||
meshtastic --set range_test_module_enabled true
|
||||
```
|
||||
|
||||
```shell title="Enable range test save"
|
||||
meshtastic --set range_test_module_save true
|
||||
```
|
||||
|
||||
```shell title="Disable range test save"
|
||||
meshtastic --set range_test_module_save false
|
||||
```
|
||||
|
||||
```shell title="Enable range test sender (send every 60 seconds)"
|
||||
meshtastic --set range_test_module_sender 60
|
||||
```
|
||||
|
||||
```shell title="Disable range test sender"
|
||||
meshtastic --set range_test_module_sender 0
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="flasher">
|
||||
|
||||
:::info
|
||||
Range test module config is not available in the Flasher.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
Range test module config is not available for the Web UI.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Details
|
||||
|
||||
While a minimum of two radios is required, more can be used. You can have any number of receivers and senders that your mesh is able to handle. You can test having a single sender with multiple receivers or a single receiver with multiple senders. Let us know on the [forum thread](https://meshtastic.discourse.group/t/new-plugin-rangetestplugin/2591) the results of your configuration.
|
||||
|
||||
Be sure to turn off either the module configured as a sender or the device where the module setup as sender when not in use. This will use a lot of time on air and will spam your channel.
|
||||
|
||||
Also be mindful of your space usage on the file system. It has protections from filling up the space but it's best to delete old range test results.
|
||||
|
||||
:::note
|
||||
Leaving this module on can slow down your mesh. Currently, the messages are sent using the same `TEXT_MESSAGE_APP` [port that all other messages](/docs/developers/protobufs/api#portnumsproto) are sent on.
|
||||
:::
|
||||
|
||||
### Accessing your CSV
|
||||
|
||||
Connect to your device over WiFi, either using the [software access point](/docs/settings/wifi#software-access-point) or [WiFi Client](/docs/settings/wifi#wifi-client). Then navigate to `meshtastic.local` (or your IP address). Your file will be available for download under `Extensions > File Browser > rangetest.csv` once it has been created by receiving messages.
|
||||
|
||||
```plaintext title="Example URLs"
|
||||
http://meshtastic.local
|
||||
http://198.168.0.15
|
||||
```
|
||||
|
||||
### Recommended Sender Settings
|
||||
|
||||
| Radio Setting | `range_test_module_sender` |
|
||||
| :-----------: | :------------------------: |
|
||||
| Long Slow | 60 |
|
||||
| Long Alt | 30 |
|
||||
| Medium | 15 |
|
||||
| Short Fast | 15 |
|
||||
|
||||
## Examples
|
||||
|
||||
### Sender Node
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
values={[
|
||||
{label: 'CLI', value: 'cli'},
|
||||
{label: 'Android', value: 'android'},
|
||||
{label: 'iOS', value: 'iOS'},
|
||||
{label: 'Web', value: 'web'},
|
||||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
```shell title="Example - Sender Node"
|
||||
meshtastic --set range_test_module_enabled true
|
||||
meshtastic --set range_test_module_sender 60
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="iOS">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### Receiver Node
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
values={[
|
||||
{label: 'CLI', value: 'cli'},
|
||||
{label: 'Android', value: 'android'},
|
||||
{label: 'iOS', value: 'iOS'},
|
||||
{label: 'Web', value: 'web'},
|
||||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
```shell title="Example - Receiver Node"
|
||||
meshtastic --set range_test_module_enabled true
|
||||
meshtastic --set range_test_module_save true
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="iOS">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
Loading…
Reference in a new issue