mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-11-09 23:24:10 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

added serial plugin details

Browse source
This commit is contained in:
Foster Irwin 2022-02-11 13:54:01 -07:00
parent 498ca24757
commit 845c9a2f44
1 changed files with 33 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
docs/software/settings/serial-plugin.md
View file

@ -22,9 +22,9 @@ Once plugin settings are changed, a **reset** is required for them to take effec
| serialplugin_enabled | `true`, `false` | `false` |
| serialplugin_echo | `true`, `false` | `false` |
| serialplugin_mode | `integer` | `0` |
| serialplugin_rxd | `integer` | `0` |
| serialplugin_rxd | `integer` (GPIO) | `0` |
| serialplugin_timeout | `integer` (seconds) | `0` |
| serialplugin_txd | `integer` | `0` |
| serialplugin_txd | `integer` (GPIO) | `0` |
### serialplugin_enabled
@ -41,9 +41,12 @@ Enables the plugin.
]}>
<TabItem value="cli">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
```bash title="Enable plugin"
meshtastic --set serialplugin_enabled true
```
```bash title="Disable plugin"
meshtastic --set serialplugin_enabled false
```
</TabItem>
<TabItem value="android">
@ -71,7 +74,7 @@ Configuring this setting is not yet available for the selected platform. If this
### serialplugin_echo
<!--- TODO --->
If set, any packets you send will be echoed back to your device.
<Tabs
groupId="settings"
@ -84,9 +87,12 @@ Configuring this setting is not yet available for the selected platform. If this
]}>
<TabItem value="cli">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
```bash title="Enable serialplugin_echo"
meshtastic --set serialplugin_echo true
```
```bash title="Disable serialplugin_echo"
meshtastic --set serialplugin_echo false
```
</TabItem>
<TabItem value="android">
@ -157,7 +163,7 @@ Configuring this setting is not yet available for the selected platform. If this
### serialplugin_rxd
<!--- TODO --->
Set the GPIO pin to the RXD pin you have set up.
<Tabs
groupId="settings"
@ -170,10 +176,14 @@ Configuring this setting is not yet available for the selected platform. If this
]}>
<TabItem value="cli">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::note
Replace `GPIO` in the below command with the GPIO number your circuit is attached to.
:::
```bash title="Set RXD to GPIO pin number"
meshtastic --set serialplugin_rxd GPIO
```
</TabItem>
<TabItem value="android">
@ -200,7 +210,7 @@ Configuring this setting is not yet available for the selected platform. If this
### serialplugin_timeout
<!--- TODO --->
The amount of time to wait before we consider your packet as "done".
<Tabs
groupId="settings"
@ -213,9 +223,9 @@ Configuring this setting is not yet available for the selected platform. If this
]}>
<TabItem value="cli">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
```bash title="Set serialplugin_timeout to 15 seconds"
meshtastic --set serialplugin_timeout 15
```
</TabItem>
<TabItem value="android">
@ -243,7 +253,7 @@ Configuring this setting is not yet available for the selected platform. If this
### serialplugin_txd
<!--- TODO --->
Set the GPIO pin to the TXD pin you have set up.
<Tabs
groupId="settings"
@ -256,10 +266,14 @@ Configuring this setting is not yet available for the selected platform. If this
]}>
<TabItem value="cli">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::note
Replace `GPIO` in the below command with the GPIO number your circuit is attached to.
:::
```bash title="Set TXD to GPIO pin number"
meshtastic --set serialplugin_txd GPIO
```
</TabItem>
<TabItem value="android">