mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-09-19 23:57:31 -07:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update serial.md

Browse source
This commit is contained in:
apt105 2021-04-13 22:22:29 +01:00
parent a0bf15e3c2
commit 632c7a6051
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
website/docs/software/plugins/serial.md
View file

@ -12,15 +12,15 @@ 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 boards it is recommend to use:
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".
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.
7. (Optional) Set `serialplugin_echo` to `1` and any message you send out will be echoed back to your device.
:::note
The device must be restarted after the settings have been changed for the plugin to take effect.
@ -29,6 +29,7 @@ The device must be restarted after the settings have been changed for the plugin
## TODO (in this order):
* Define a verbose RX mode to report on mesh and packet infomration.
:::note
This won't happen any time soon.
:::