meshtastic/website/docs/software/settings/serial-plugin.md

71 lines
1.1 KiB
Markdown
Raw Normal View History

2021-04-27 14:07:02 -07:00
---
id: serial-plugin
title: Serial Plugin Settings
sidebar_label: Serial Plugin
---
2021-05-05 09:18:44 -07:00
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
2021-04-27 14:07:02 -07:00
## Overview
2021-05-03 13:17:02 -07:00
This is a simple interface to send messages over the mesh network by sending strings over a serial port.
2021-04-27 14:07:02 -07:00
## Settings
2021-05-03 13:17:02 -07:00
| Setting | Acceptable Values | Default |
| :-----: | :---------------: | :-----: |
| serialplugin_enabled | `true`, `false` | `false` |
| serialplugin_echo | `true`, `false` | `false` |
| serialplugin_mode | `integer` | `0` |
| serialplugin_rxd | `integer` | `0` |
| serialplugin_timeout | `integer` (seconds) | `0` |
| serialplugin_txd | `integer` | `0` |
### serialplugin_enabled
Enables the plugin.
### serialplugin_echo
<!--- TODO --->
### serialplugin_mode
<!--- TODO --->
### serialplugin_rxd
<!--- TODO --->
### serialplugin_timeout
<!--- TODO --->
### serialplugin_txd
<!--- TODO --->
2021-04-27 14:07:02 -07:00
## Details
2021-05-03 15:25:24 -07:00
2021-05-05 09:18:44 -07:00
## Examples
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
]}>
<TabItem value="cli">
TODO
</TabItem>
<TabItem value="android">
TODO
</TabItem>
</Tabs>