added serial plugin details

This commit is contained in:
Foster Irwin 2022-02-11 13:54:01 -07:00
parent 498ca24757
commit 845c9a2f44

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