meshtastic/docs/settings/range-test-module.md
2022-03-18 14:53:31 +01:00

8.3 KiB

id title sidebar_label
range-test-module Range Test Module Settings Range Test Module

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';

Overview

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, Google Maps - My Maps, or any other program capable of processing .csv files. This can enable you to visualize your mesh.

:::tip Once module settings are changed, a reset is required for them to take effect. :::

Settings

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

range_test_module_enabled

Enables the module.

Enable/Disable the module

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --set range_test_module_enabled true
meshtastic --set range_test_module_enabled true

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

range_test_module_save

If enabled, we will save a log of all received messages to /static/rangetest.csv which you can access from the web server. We will abort writing if there is less than 50k of space on the filesystem to prevent filling up the storage.

Enable/Disable range test save csv

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --set range_test_module_save true
meshtastic --set range_test_module_save false

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

range_test_module_sender

Number of seconds to wait between sending packets. Using the long_slow channel configuration, it's best not to go more frequent than once every 60 seconds. You can be more aggressive with faster settings. 0 is default which disables sending messages.

Enable/Disable range test sender

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --set range_test_module_sender 60
meshtastic --set range_test_module_sender 0

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

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 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 are sent on. :::

Accessing your CSV

Connect to your device over WiFi, either using the software access point or WiFi Client. Then navigate to meshtastic.local (or your IP address) /static/rangetest.csv where your file will be available for download.

http://meshtastic.local/static/rangetest.csv
http://198.168.0.X/static/rangetest.csv
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'}, ]}>

meshtastic --set range_test_module_enabled true
meshtastic --set range_test_module_sender 60

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

Receiver Node

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --set range_test_module_enabled true
meshtastic --set range_test_module_save true

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::