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

Merge pull request #283 from raldi/patch-5

Browse source 
Mention that you can't send protobufs (yet) to the serial module
This commit is contained in:
Foster Irwin 2022-03-17 14:58:51 -06:00 committed by GitHub
parent cf50234458 5ba23c4f44
commit 8c8f71fc2c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/settings/serial-module.md
View file

@ -15,14 +15,19 @@ GPIO access is fundamentally dangerous because invalid options can physically da
This module requires attaching a peripheral accessory to your device. It will not work without one.
:::
## Overview
This is 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. 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.
:::tip
Once module settings are changed, a **reset** is required for them to take effect.
:::
:::tip
Connect the TX pin to the other device's RX pin, and vice versa. Connect their grounds to each other (not necessary if they're both plugged into the same USB power source.)
:::
## Settings
| Setting | Acceptable Values | Default |