Skip to main content

Serial Module Settings

warning

GPIO access is fundamentally dangerous because invalid options can physically damage or destroy your hardware. Ensure that you fully understand the schematic for your particular device before trying this as we do not offer a warranty. Use at your own risk.

important
The name of ths option changed between Meshtastic 1.2 and 1.3. This documentaton already reflects the 1.3 syntax. Please substitute 'serial_module' prefix with 'serial_plugin' to get the 1.2 compatible command name.
note

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. 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​

SettingAcceptable ValuesDefault
serial_module_enabledtrue, falsefalse
serial_module_echotrue, falsefalse
serial_module_modeinteger0
serial_module_rxdinteger (GPIO)0
serial_module_timeoutinteger (seconds)0
serial_module_txdinteger (GPIO)0

serial_module_enabled​

Enables the module.

Enable module
meshtastic --set serial_module_enabled true
Disable module
meshtastic --set serial_module_enabled false

serial_module_echo​

If set, any packets you send will be echoed back to your device.

Enable serial_module_echo
meshtastic --set serial_module_echo true
Disable serial_module_echo
meshtastic --set serial_module_echo false

serial_module_mode​

info

Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.

serial_module_rxd​

Set the GPIO pin to the RXD pin you have set up.

caution

To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value.

note

Replace GPIO in the below command with the GPIO number your circuit is attached to.

Set RXD to GPIO pin number
meshtastic --set serial_module_rxd GPIO

serial_module_timeout​

The amount of time to wait before we consider your packet as "done".

Set serial_module_timeout to 15 seconds
meshtastic --set serial_module_timeout 15

serial_module_txd​

Set the GPIO pin to the TXD pin you have set up.

caution

To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value.

note

Replace GPIO in the below command with the GPIO number your circuit is attached to.

Set TXD to GPIO pin number
meshtastic --set serial_module_txd GPIO