From 44d937dfa2075538ded1a51f2902ae0861d4b78d Mon Sep 17 00:00:00 2001 From: Ben Meadors Date: Sun, 4 Dec 2022 19:34:44 -0600 Subject: [PATCH 1/2] A bit more details for text messaging --- docs/configuration/module-config/serial.mdx | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/configuration/module-config/serial.mdx b/docs/configuration/module-config/serial.mdx index 5cc46cef..b6abb039 100644 --- a/docs/configuration/module-config/serial.mdx +++ b/docs/configuration/module-config/serial.mdx @@ -12,6 +12,9 @@ The serial module config options are: Enabled, Echo, Mode, Receive GPIO, Transmi This is a simple interface to send messages over the mesh network by sending strings over a serial port. Anything you send the node will be turned into a message sent out over the mesh, and anything received from the mesh will be sent to the serial port. Note that this module does not (yet) allow arbitrary protobuf commands to be sent over the serial connection. +![image](https://user-images.githubusercontent.com/9000580/205529843-962c3187-8411-452c-b729-42c58b1571f5.png) + + ## Serial Module Config Values ### Enabled @@ -161,10 +164,12 @@ Default is to use RX GPIO 16 and TX GPIO 17. 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: - - RXD 35 - - TXD 15 + - RXD 13 + - TXD 14 3. Set `serial.timeout` to the amount of time to wait before we consider your packet as "done". 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`. -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. + + With [tio](https://github.com/tio/tio) – `tio -e -b 38400 -f none /dev/myserialport` +7. Send a packet up to 237 bytes in length. This will get relayed over the mesh network. +8. (Optional) Set `serial.echo` to `1` and any message you send out will be echoed back to your device. From 67607e06c02f2f04d17ab52299c3a188f6adfd3a Mon Sep 17 00:00:00 2001 From: Ben Meadors Date: Sun, 4 Dec 2022 19:38:22 -0600 Subject: [PATCH 2/2] Fix typo --- docs/configuration/module-config/serial.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/module-config/serial.mdx b/docs/configuration/module-config/serial.mdx index b6abb039..2fb1444b 100644 --- a/docs/configuration/module-config/serial.mdx +++ b/docs/configuration/module-config/serial.mdx @@ -167,7 +167,7 @@ Default is to use RX GPIO 16 and TX GPIO 17. - RXD 13 - TXD 14 3. Set `serial.timeout` to the amount of time to wait before we consider your packet as "done". -4. (Optional) set serial.mode to TESTMSG if you want to send messages to/from the general text message channel +4. (Optional) set serial.mode to TEXTMSG 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`. With [tio](https://github.com/tio/tio) – `tio -e -b 38400 -f none /dev/myserialport`