mirror of
https://github.com/meshtastic/meshtastic.git
synced 2025-02-02 08:42:11 -08:00
add command chaining tip to each config, fix frmat
This commit is contained in:
parent
09ae562fe9
commit
acfcc50214
|
@ -65,7 +65,6 @@ values={[
|
||||||
{label: 'Android', value: 'android'},
|
{label: 'Android', value: 'android'},
|
||||||
{label: 'Apple', value: 'apple'},
|
{label: 'Apple', value: 'apple'},
|
||||||
{label: 'CLI', value: 'cli'},
|
{label: 'CLI', value: 'cli'},
|
||||||
{label: 'Flasher', value: 'flasher'},
|
|
||||||
{label: 'Web', value: 'web'},
|
{label: 'Web', value: 'web'},
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="android">
|
<TabItem value="android">
|
||||||
|
@ -89,8 +88,12 @@ Audio module config is not available on iOS, iPadOS and macOS.
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
All audio module config options are available in the python CLI. Example commands are below:
|
All audio module config options are available in the python CLI. Example commands are below:
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
| Setting | Acceptable Values | Default |
|
| Setting | Acceptable Values | Default |
|
||||||
| :-------------------: | :-----------------: | :-----: |
|
| :-------------------: | :-----------------: | :-----: |
|
||||||
| audio.enabled | `true`, `false` | `false` |
|
| audio.enabled | `true`, `false` | `false` |
|
||||||
|
@ -101,6 +104,15 @@ All audio module config options are available in the python CLI. Example command
|
||||||
| audio.i2s_din | GPIO Pin Number 1-34 | no Default |
|
| audio.i2s_din | GPIO Pin Number 1-34 | no Default |
|
||||||
| audio.i2s_sck | GPIO Pin Number 1-34 | no Default |
|
| audio.i2s_sck | GPIO Pin Number 1-34 | no Default |
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
|
||||||
|
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
|
||||||
|
|
||||||
|
```shell title="Example:"
|
||||||
|
meshtastic --set audio.enabled true --set audio.bitrate CODEC2_1400
|
||||||
|
```
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
```shell title="Enable / Disable Module"
|
```shell title="Enable / Disable Module"
|
||||||
meshtastic --set audio.enabled true
|
meshtastic --set audio.enabled true
|
||||||
|
@ -125,14 +137,7 @@ meshtastic --set audio.bitrate CODEC2_1400
|
||||||
```
|
```
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="flasher">
|
<TabItem value="web">
|
||||||
|
|
||||||
:::info
|
|
||||||
No audio module config options are available in the Flasher.
|
|
||||||
:::
|
|
||||||
|
|
||||||
</TabItem>
|
|
||||||
<TabItem value="web">
|
|
||||||
|
|
||||||
:::info
|
:::info
|
||||||
All audio module config options are available in the Web UI.
|
All audio module config options are available in the Web UI.
|
||||||
|
@ -142,7 +147,9 @@ All audio module config options are available in the Web UI.
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
:::warning
|
:::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.
|
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.
|
||||||
|
|
||||||
This module requires attaching a peripheral accessory to your device. It will not work without one.
|
This module requires attaching a peripheral accessory to your device. It will not work without one.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
|
@ -81,7 +81,6 @@ values={[
|
||||||
{label: 'Android', value: 'android'},
|
{label: 'Android', value: 'android'},
|
||||||
{label: 'Apple', value: 'apple'},
|
{label: 'Apple', value: 'apple'},
|
||||||
{label: 'CLI', value: 'cli'},
|
{label: 'CLI', value: 'cli'},
|
||||||
{label: 'Flasher', value: 'flasher'},
|
|
||||||
{label: 'Web', value: 'web'},
|
{label: 'Web', value: 'web'},
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="android">
|
<TabItem value="android">
|
||||||
|
@ -106,7 +105,9 @@ All canned message module config options are available on iOS, iPadOS and macOS
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
:::info
|
:::info
|
||||||
|
|
||||||
All canned message module config options are available in the python CLI.
|
All canned message module config options are available in the python CLI.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
Example commands are below:
|
Example commands are below:
|
||||||
|
@ -125,6 +126,16 @@ Example commands are below:
|
||||||
| canned_message.inputbroker_pin_b | `integer` | (not defined) |
|
| canned_message.inputbroker_pin_b | `integer` | (not defined) |
|
||||||
| canned_message.inputbroker_pin_press | `integer` | (not defined) |
|
| canned_message.inputbroker_pin_press | `integer` | (not defined) |
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
|
||||||
|
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
|
||||||
|
|
||||||
|
```shell title="Example:"
|
||||||
|
meshtastic --set canned_message.enabled true --set canned_message.send_bell true
|
||||||
|
```
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
```shell title="Enable/Disable the Canned Message Module"
|
```shell title="Enable/Disable the Canned Message Module"
|
||||||
meshtastic --set canned_message.enabled true
|
meshtastic --set canned_message.enabled true
|
||||||
meshtastic --set canned_message.enabled false
|
meshtastic --set canned_message.enabled false
|
||||||
|
@ -178,14 +189,7 @@ meshtastic --set canned_message.inputbroker_event_press KEY_SELECT
|
||||||
meshtastic --set canned_message.inputbroker_event_press ""
|
meshtastic --set canned_message.inputbroker_event_press ""
|
||||||
```
|
```
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="flasher">
|
<TabItem value="web">
|
||||||
|
|
||||||
:::info
|
|
||||||
No canned message test module config options are available in the Flasher.
|
|
||||||
:::
|
|
||||||
|
|
||||||
</TabItem>
|
|
||||||
<TabItem value="web">
|
|
||||||
|
|
||||||
:::info
|
:::info
|
||||||
All canned message module config options are available in the Web UI.
|
All canned message module config options are available in the Web UI.
|
||||||
|
|
|
@ -51,7 +51,6 @@ values={[
|
||||||
{label: 'Android', value: 'android'},
|
{label: 'Android', value: 'android'},
|
||||||
{label: 'Apple', value: 'apple'},
|
{label: 'Apple', value: 'apple'},
|
||||||
{label: 'CLI', value: 'cli'},
|
{label: 'CLI', value: 'cli'},
|
||||||
{label: 'Flasher', value: 'flasher'},
|
|
||||||
{label: 'Web', value: 'web'},
|
{label: 'Web', value: 'web'},
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="android">
|
<TabItem value="android">
|
||||||
|
@ -75,8 +74,12 @@ All external notification module config options are available on iOS, iPadOS and
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
All external notification module config options are available in the python CLI. Example commands are below:
|
All external notification module config options are available in the python CLI. Example commands are below:
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
| Setting | Acceptable Values | Default |
|
| Setting | Acceptable Values | Default |
|
||||||
| :----------------------------: | :----------------------: | :-----: |
|
| :----------------------------: | :----------------------: | :-----: |
|
||||||
| external_notification.enabled | `true`, `false` | `false` |
|
| external_notification.enabled | `true`, `false` | `false` |
|
||||||
|
@ -86,6 +89,16 @@ All external notification module config options are available in the python CLI.
|
||||||
| external_notification.output | `integer` | `0` |
|
| external_notification.output | `integer` | `0` |
|
||||||
| external_notification.output_ms | `integer` (milliseconds) | `0` |
|
| external_notification.output_ms | `integer` (milliseconds) | `0` |
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
|
||||||
|
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
|
||||||
|
|
||||||
|
```shell title="Example:"
|
||||||
|
meshtastic --set external_notification.enabled true --set external_notification.alert_bell true
|
||||||
|
```
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
```shell title="Enable/Disable External Notification Module"
|
```shell title="Enable/Disable External Notification Module"
|
||||||
meshtastic --set external_notification.enabled true
|
meshtastic --set external_notification.enabled true
|
||||||
meshtastic --set external_notification.enabled false
|
meshtastic --set external_notification.enabled false
|
||||||
|
@ -115,20 +128,13 @@ meshtastic --set external_notification.output_ms 0
|
||||||
meshtastic --set external_notification.output_ms 1500
|
meshtastic --set external_notification.output_ms 1500
|
||||||
```
|
```
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="flasher">
|
<TabItem value="web">
|
||||||
|
|
||||||
:::info
|
|
||||||
External Notification module config is not available in the Flasher.
|
|
||||||
:::
|
|
||||||
|
|
||||||
</TabItem>
|
|
||||||
<TabItem value="web">
|
|
||||||
|
|
||||||
:::info
|
:::info
|
||||||
All External Notification module config is available for the Web UI.
|
All External Notification module config is available for the Web UI.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
:::warning
|
:::warning
|
||||||
|
|
|
@ -49,7 +49,6 @@ values={[
|
||||||
{label: 'Android', value: 'android'},
|
{label: 'Android', value: 'android'},
|
||||||
{label: 'Apple', value: 'apple'},
|
{label: 'Apple', value: 'apple'},
|
||||||
{label: 'CLI', value: 'cli'},
|
{label: 'CLI', value: 'cli'},
|
||||||
{label: 'Flasher', value: 'flasher'},
|
|
||||||
{label: 'Web', value: 'web'},
|
{label: 'Web', value: 'web'},
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="android">
|
<TabItem value="android">
|
||||||
|
@ -73,8 +72,12 @@ MQTT module config is not available for Apple.
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
All MQTT module config options are available in the python CLI. Example commands are below:
|
All MQTT module config options are available in the python CLI. Example commands are below:
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
| Setting | Acceptable Values | Default |
|
| Setting | Acceptable Values | Default |
|
||||||
| :--------------------------: | :----------------------: | :-----: |
|
| :--------------------------: | :----------------------: | :-----: |
|
||||||
| mqtt.enabled | `true`, `false` | `false` |
|
| mqtt.enabled | `true`, `false` | `false` |
|
||||||
|
@ -84,9 +87,24 @@ All MQTT module config options are available in the python CLI. Example commands
|
||||||
| mqtt.encryption_enabled | `string` | |
|
| mqtt.encryption_enabled | `string` | |
|
||||||
| mqtt.json_enabled | `true`, `false` | `false` |
|
| mqtt.json_enabled | `true`, `false` | `false` |
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
|
||||||
|
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
|
||||||
|
|
||||||
|
```shell title="Example:"
|
||||||
|
meshtastic --set mqtt.enabled true --set mqtt.json_enabled true
|
||||||
|
```
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
```shell title="Enable/Disable MQTT Module"
|
```shell title="Enable/Disable MQTT Module"
|
||||||
meshtastic --set mqtt.enabled true
|
meshtastic --set mqtt.enabled true
|
||||||
meshtastic --set mqtt.enabled false
|
meshtastic --set mqtt.enabled false
|
||||||
|
```
|
||||||
|
|
||||||
|
```shell title="Enable/Disable MQTT JSON"
|
||||||
|
meshtastic --set mqtt.json_enabled true
|
||||||
|
meshtastic --set mqtt.json_enabled false
|
||||||
```
|
```
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
|
|
|
@ -37,7 +37,6 @@ values={[
|
||||||
{label: 'Android', value: 'android'},
|
{label: 'Android', value: 'android'},
|
||||||
{label: 'Apple', value: 'apple'},
|
{label: 'Apple', value: 'apple'},
|
||||||
{label: 'CLI', value: 'cli'},
|
{label: 'CLI', value: 'cli'},
|
||||||
{label: 'Flasher', value: 'flasher'},
|
|
||||||
{label: 'Web', value: 'web'},
|
{label: 'Web', value: 'web'},
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="android">
|
<TabItem value="android">
|
||||||
|
@ -61,14 +60,28 @@ All range test module config options are available on iOS, iPadOS and macOS at S
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
Range Test module config options are available in the python CLI. Example commands are below:
|
Range Test module config options are available in the python CLI. Example commands are below:
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
| Setting | Acceptable Values | Default |
|
| Setting | Acceptable Values | Default |
|
||||||
| :-----------------------: | :-----------------: | :-----: |
|
| :-----------------------: | :-----------------: | :-----: |
|
||||||
| range_test.enabled | `true`, `false` | `false` |
|
| range_test.enabled | `true`, `false` | `false` |
|
||||||
| range_test.save | `true`, `false` | `false` |
|
| range_test.save | `true`, `false` | `false` |
|
||||||
| range_test.sender | `integer` (Seconds) | `0` |
|
| range_test.sender | `integer` (Seconds) | `0` |
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
|
||||||
|
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
|
||||||
|
|
||||||
|
```shell title="Example:"
|
||||||
|
meshtastic --set range_test.enabled true --set range_test.save false
|
||||||
|
```
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
```shell title="Enable / Disable the range test"
|
```shell title="Enable / Disable the range test"
|
||||||
meshtastic --set range_test.enabled true
|
meshtastic --set range_test.enabled true
|
||||||
meshtastic --set range_test.enabled false
|
meshtastic --set range_test.enabled false
|
||||||
|
@ -88,20 +101,15 @@ meshtastic --set range_test.sender 0
|
||||||
```
|
```
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="flasher">
|
<TabItem value="web">
|
||||||
|
|
||||||
:::info
|
:::info
|
||||||
No range test module config options are available in the Flasher.
|
|
||||||
:::
|
|
||||||
|
|
||||||
</TabItem>
|
|
||||||
<TabItem value="web">
|
|
||||||
|
|
||||||
:::info
|
|
||||||
No range test module config options are available in the Web UI.
|
No range test module config options are available in the Web UI.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
|
@ -70,7 +70,6 @@ values={[
|
||||||
{label: 'Android', value: 'android'},
|
{label: 'Android', value: 'android'},
|
||||||
{label: 'Apple', value: 'apple'},
|
{label: 'Apple', value: 'apple'},
|
||||||
{label: 'CLI', value: 'cli'},
|
{label: 'CLI', value: 'cli'},
|
||||||
{label: 'Flasher', value: 'flasher'},
|
|
||||||
{label: 'Web', value: 'web'},
|
{label: 'Web', value: 'web'},
|
||||||
]}>
|
]}>
|
||||||
<TabItem value="android">
|
<TabItem value="android">
|
||||||
|
@ -94,8 +93,12 @@ All serial module config options are available on iOS, iPadOS and macOS at Setti
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="cli">
|
<TabItem value="cli">
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
All serial module config options are available in the python CLI. Example commands are below:
|
All serial module config options are available in the python CLI. Example commands are below:
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
| Setting | Acceptable Values | Default |
|
| Setting | Acceptable Values | Default |
|
||||||
| :-------------------: | :-----------------: | :-----: |
|
| :-------------------: | :-----------------: | :-----: |
|
||||||
| serial.enabled | `true`, `false` | `false` |
|
| serial.enabled | `true`, `false` | `false` |
|
||||||
|
@ -106,6 +109,15 @@ All serial module config options are available in the python CLI. Example comman
|
||||||
| serial.baud | `BAUD_DEFAULT` `BAUD_110` `BAUD_300` `BAUD_600` `BAUD_1200` `BAUD_2400` `BAUD_4800` `BAUD_9600` `BAUD_19200` `BAUD_38400` `BAUD_57600` `BAUD_115200` `BAUD_230400` `BAUD_460800` `BAUD_576000` `BAUD_921600` | `BAUD_DEFAULT` |
|
| serial.baud | `BAUD_DEFAULT` `BAUD_110` `BAUD_300` `BAUD_600` `BAUD_1200` `BAUD_2400` `BAUD_4800` `BAUD_9600` `BAUD_19200` `BAUD_38400` `BAUD_57600` `BAUD_115200` `BAUD_230400` `BAUD_460800` `BAUD_576000` `BAUD_921600` | `BAUD_DEFAULT` |
|
||||||
| serial.timeout | `integer` (seconds) | `0` |
|
| serial.timeout | `integer` (seconds) | `0` |
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
|
||||||
|
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
|
||||||
|
|
||||||
|
```shell title="Example:"
|
||||||
|
meshtastic --set serial.enabled true --set serial.echo true
|
||||||
|
```
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
```shell title="Enable / Disable Module"
|
```shell title="Enable / Disable Module"
|
||||||
meshtastic --set serial.enabled true
|
meshtastic --set serial.enabled true
|
||||||
|
@ -140,20 +152,13 @@ meshtastic --set serial.timeout 15
|
||||||
```
|
```
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="flasher">
|
<TabItem value="web">
|
||||||
|
|
||||||
:::info
|
|
||||||
No serial module config options are available in the Flasher.
|
|
||||||
:::
|
|
||||||
|
|
||||||
</TabItem>
|
|
||||||
<TabItem value="web">
|
|
||||||
|
|
||||||
:::info
|
:::info
|
||||||
All serial module config options are available in the Web UI.
|
All serial module config options are available in the Web UI.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
:::warning
|
:::warning
|
||||||
|
|
|
@ -151,7 +151,7 @@ All telemetry module config options are available in the Web UI.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
Loading…
Reference in a new issue