mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-11-10 07:34:11 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Updating docs to correct syntax

Browse source 
Syntax correct from xxx_module_xxx to xxx_plugin_xxx
This commit is contained in:
ayysasha 2022-03-18 04:11:36 -04:00 committed by GitHub
parent 4a85a4dfd6
commit 4e81b0f0d5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
docs/software/modules/range-test.md
View file

@ -10,20 +10,20 @@ This module allows you to test the range of your Meshtastic nodes. It uses two n
These are the settings that can be configured. These are the settings that can be configured.
range_test_module_enabled range_test_plugin_enabled
Is the Module enabled? Is the Module enabled?
0 = Disabled (Default) 0 = Disabled (Default)
1 = Enabled 1 = Enabled
range_test_module_save range_test_plugin_save
If enabled, we will save a log of all received messages to /static/rangetest.csv which you can access from the webserver. We will abort If enabled, we will save a log of all received messages to /static/rangetest.csv which you can access from the webserver. We will abort
writing if there is less than 50k of space on the filesystem to prevent filling up the storage. writing if there is less than 50k of space on the filesystem to prevent filling up the storage.
0 = Disabled (Default) 0 = Disabled (Default)
1 = Enabled 1 = Enabled
range_test_module_sender range_test_plugin_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 agressive with faster settings. 0 is default which disables sending messages. 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 agressive with faster settings. 0 is default which disables sending messages.
:::note :::note
@ -36,36 +36,36 @@ For basic usage, you will need two devices both with a GPS. A device with a pair
The first thing to do is to turn on the module. The device will need to be restarted after applying the settings. With the module turned on, the other settings will be available: The first thing to do is to turn on the module. The device will need to be restarted after applying the settings. With the module turned on, the other settings will be available:
range_test_module_enabled = 1 range_test_plugin_enabled = 1
If you want to send a message every 60 seconds: If you want to send a message every 60 seconds:
range_test_module_sender = 60 range_test_plugin_sender = 60
To save a log of the messages: To save a log of the messages:
range_test_module_save = 1 range_test_plugin_save = 1
Recommended settings for a sender at different radio settings: Recommended settings for a sender at different radio settings:
Long Slow ... range_test_module_sender = 60 Long Slow ... range_test_plugin_sender = 60
Long Alt ... range_test_module_sender = 30 Long Alt ... range_test_plugin_sender = 30
Medium ... range_test_module_sender = 15 Medium ... range_test_plugin_sender = 15
Short Fast ... range_test_module_sender = 15 Short Fast ... range_test_plugin_sender = 15
### Python API Examples ### Python API Examples
Sender Sender
`meshtastic --set range_test_module_enabled 1` `meshtastic --set range_test_plugin_enabled 1`
`meshtastic --set range_test_module_sender 60` `meshtastic --set range_test_plugin_sender 60`
Receiver Receiver
`meshtastic --set range_test_module_enabled 1` `meshtastic --set range_test_plugin_enabled 1`
`meshtastic --set range_test_module_save 1` `meshtastic --set range_test_plugin_save 1`
### Other things to keep in mind ### Other things to keep in mind