Review edits 1

This commit is contained in:
apt105 2021-04-13 20:18:52 +01:00
parent f3d7a9eeba
commit 0fe4576524
5 changed files with 33 additions and 35 deletions

View file

@ -51,6 +51,7 @@ These are the settings that can be configured.
For basic usage, start with:
ext_notification_plugin_enabled = 1
ext_notification_plugin_alert_message = 1
Depending on how your external cirtcuit configured is configured, you may need to set the active state to true.

View file

@ -26,6 +26,10 @@ These are the settings that can be configured.
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.
:::note
The device must be restarted after the settings have been changed for the plugin to take effect.
:::
### Usage Notes
For basic usage, you will need two devices both with a GPS. A device with a paired phone with GPS may work, I have not tried it.
@ -54,11 +58,13 @@ Recommended settings for a sender at different radio settings:
Sender
meshtastic --set range_test_plugin_enabled 1
meshtastic --set range_test_plugin_sender 60
Receiver
meshtastic --set range_test_plugin_enabled 1
meshtastic --set range_test_plugin_save 1
### Other things to keep in mind
@ -71,8 +77,6 @@ Also be mindful of your space usage on the file system. It has protections from
### Google Integration
@jfirwin on our forum [meshtastic.discourse.org](https://meshtastic.discourse.group/t/new-plugin-rangetestplugin/2591/49?u=mc-hamster) shared how to integrate the resulting csv file with Google Products.
#### Earth
Steps:
@ -126,6 +130,4 @@ Q: Why is this operating on incoming messages instead of the existing location d
## Need more help?
Go to the Meshtastic Discourse Group if you have any questions or to share how you have used this.
https://meshtastic.discourse.group
Go to the [Meshtastic Forum](https://meshtastic.discourse.group) if you have any questions or to share how you have used this.

View file

@ -6,37 +6,32 @@ sidebar_label: Serial communication
## About
A simple interface to send messages over the mesh network by sending strings
over a serial port.
This is a simple interface to send messages over the mesh network by sending strings over a serial port.
Default is to use RX GPIO 16 and TX GPIO 17.
## Basic Usage:
1) Enable the plugin by setting serialplugin_enabled to 1.
2) Set the pins (serialplugin_rxd / serialplugin_rxd) for your preferred RX and TX GPIO pins.
On tbeam, recommend to use:
RXD 35
TXD 15
3) Set serialplugin_timeout to the amount of time to wait before we consider
your packet as "done".
4) (Optional) In SerialPlugin.h set the port to PortNum_TEXT_MESSAGE_APP if you want to
send messages to/from the general text message channel.
5) Connect to your device over the serial interface at 38400 8N1.
6) Send a packet up to 240 bytes in length. This will get relayed over the mesh network.
7) (Optional) Set serialplugin_echo to 1 and any message you send out will be echoed back
to your device.
1. Enable the plugin by setting serialplugin_enabled to 1.
2. Set the pins (serialplugin_rxd / serialplugin_rxd) for your preferred RX and TX GPIO pins. On tbeam boards it is recommend to use:
* RXD 35
* TXD 15
3. Set serialplugin_timeout to the amount of time to wait before we consider your packet as "done".
4. (Optional) In SerialPlugin.h set the port to `PortNum_TEXT_MESSAGE_APP`if you want to send messages to/from the general text message channel.
5. Connect to your device over the serial interface at `38400 8N1`.
6. Send a packet up to 240 bytes in length. This will get relayed over the mesh network.
7. (Optional) Set serialplugin_echo to 1 and any message you send out will be echoed back to your device.
## TODO (in this order):
* Define a verbose RX mode to report on mesh and packet infomration.
- This won't happen any time soon.
:::note
This won't happen any time soon.
:::
## Known Problems
* Until the plugin is initilized by the startup sequence, the TX pin is in a floating
state. Device connected to that pin may see this as "noise".
* Until the plugin is initilized by the startup sequence, the TX pin is in a floating state. Device connected to that pin may see this as "noise".
* Will not work on NRF and the Linux device targets.
## Need help?

View file

@ -5,7 +5,7 @@ sidebar_label: Store and forward
---
## About
:::warning
:::caution
This is a work in progress and is not yet available.
:::

View file

@ -26,16 +26,6 @@ module.exports = {
},
],
},
{
"Plugins": [
"software/plugins/plugins",
"software/plugins/store-forward-plugin",
"software/plugins/range-test-plugin",
"software/plugins/environment-plugin",
"software/plugins/ext-notif-plugin",
"software/plugins/serial-plugin",
],
},
{
"Meshtastic-python": [
{
@ -45,6 +35,16 @@ module.exports = {
},
],
},
{
"Plugins": [
"software/plugins/plugins",
"software/plugins/range-test-plugin",
"software/plugins/ext-notif-plugin",
"software/plugins/serial-plugin",
"software/plugins/store-forward-plugin",
"software/plugins/environment-plugin",
],
},
{
Other: [
"software/other/sw-design",