mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-03-05 21:00:08 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #712 from pdxlocations/audio-config

Browse source 
Audio config cli corrections
This commit is contained in:
charminULTRA 2023-07-06 16:44:53 -04:00 committed by GitHub
parent 947eb6e92d 716799761c
commit 1e0b9d7928
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
docs/configuration/module-config/audio.mdx
View file

@ -95,29 +95,29 @@ 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 |
| audio.i2s_sd | GPIO Pin Number 1-39 | no Default | | audio.i2s_sd | GPIO Pin Number 1-39 | no Default |
| 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 :::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. 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"