Merge pull request #712 from pdxlocations/audio-config

Audio config cli corrections
This commit is contained in:
charminULTRA 2023-07-06 16:44:53 -04:00 committed by GitHub
commit 1e0b9d7928
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -96,8 +96,8 @@ All audio module config options are available in the python CLI. Example command
::: :::
| Setting | Acceptable Values | Default | | Setting | Acceptable Values | Default |
| :-----------: | :-----------------------------------------------------------------------------------------------------------------------------: | :----------------------: | | :----------------: | :-----------------------------------------------------------------------------------------------------------------------------: | :----------------------: |
| audio.enabled | `true`, `false` | `false` | |audio.codec2_enabled| `true`, `false` | `false` |
| audio.ptt_pin | GPIO Pin Number 1-39 | Default of `39` is Unset | | audio.ptt_pin | GPIO Pin Number 1-39 | Default of `39` is Unset |
| audio.bitrate | `CODEC2_DEFAULT` `CODEC2_3200` `CODEC2_2400` `CODEC2_1600` `CODEC2_1400` `CODEC2_1300` `CODEC2_1200` `CODEC2_700B` `CODEC2_700` | `CODEC2_DEFAULT` | | audio.bitrate | `CODEC2_DEFAULT` `CODEC2_3200` `CODEC2_2400` `CODEC2_1600` `CODEC2_1400` `CODEC2_1300` `CODEC2_1200` `CODEC2_700B` `CODEC2_700` | `CODEC2_DEFAULT` |
| audio.i2s_ws | GPIO Pin Number 1-34 | no Default | | audio.i2s_ws | GPIO Pin Number 1-34 | no Default |
@ -110,14 +110,14 @@ All audio module config options are available in the python CLI. Example command
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. 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:" ```shell title="Example:"
meshtastic --set audio.enabled true --set audio.bitrate CODEC2_1400 meshtastic --set audio.codec2_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.codec2_enabled true
meshtastic --set audio.enabled false meshtastic --set audio.codec2_enabled false
``` ```
```shell title="Set WS to GPIO pin number 7" ```shell title="Set WS to GPIO pin number 7"