mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-02-02 08:42:11 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #530 from meshtastic/serial-module

Browse source 
clarify serial module operation
This commit is contained in:
Thomas Göttgens 2022-12-01 22:25:27 +01:00 committed by GitHub
parent c01c685a3f aeda2cde15
commit 6deb7c1d61
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/configuration/module-config/serial.mdx
View file

@ -29,7 +29,7 @@ Defaults to 'Simple'.
Available Values: Available Values:
* `DEFAULT` * `DEFAULT`
* `SIMPLE` operate as an dumb UART tunnel. What goes in will come out, Requires a channel named 'gpio'. * `SIMPLE` operate as an dumb UART tunnel. What goes in will come out, Requires a channel named 'serial'.
* `PROTO` not implemented yet, but will expose the Protobuf Client API on this serial port * `PROTO` not implemented yet, but will expose the Protobuf Client API on this serial port
* `TEXTMSG` Will send the string received over the serial port as a Text Message for Display on the other devices. * `TEXTMSG` Will send the string received over the serial port as a Text Message for Display on the other devices.
* `NMEA` Will output a NMEA 0183 Data stream containing the internal GPS or fixed position and other node locations as Waypoints (WPL). * `NMEA` Will output a NMEA 0183 Data stream containing the internal GPS or fixed position and other node locations as Waypoints (WPL).
@ -159,12 +159,12 @@ This module requires attaching a peripheral accessory to your device. It will no
Default is to use RX GPIO 16 and TX GPIO 17. Default is to use RX GPIO 16 and TX GPIO 17.
### Basic Usage: ### Basic Usage:
1. Enable the module by setting `serial_module_enabled` to `1`. 1. Enable the module by setting `serial.enabled` to `1`.
2. Set the pins (`serial.rxd` / `serial.txd`) for your preferred RX and TX GPIO pins. On tbeam boards it is recommended to use: 2. Set the pins (`serial.rxd` / `serial.txd`) for your preferred RX and TX GPIO pins. On tbeam boards it is recommended to use:
- RXD 35 - RXD 35
- TXD 15 - TXD 15
3. Set `serial.timeout` to the amount of time to wait before we consider your packet as "done". 3. Set `serial.timeout` to the amount of time to wait before we consider your packet as "done".
4. (Optional) In serial_module.h set the port to `PortNum_TEXT_MESSAGE_APP`if you want to send messages to/from the general text message channel. 4. (Optional) set serial.mode to TESTMSG 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`. 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. 6. Send a packet up to 237 bytes in length. This will get relayed over the mesh network.
7. (Optional) Set `serial.echo` to `1` and any message you send out will be echoed back to your device. 7. (Optional) Set `serial.echo` to `1` and any message you send out will be echoed back to your device.