Mirror/squeezelite-esp32
1
0
Fork 0
mirror of https://github.com/sle118/squeezelite-esp32.git synced 2025-12-08 20:47:08 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
philippe44
2020-02-05 15:29:01 -08:00
committed by GitHub
parent f3c41e2f6d
commit 97a96ca716
1 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -28,9 +28,20 @@ Use the `squeezelite-esp32-I2S-4MFlash-sdkconfig.defaults` configuration file.
To access NVS, in the webUI, go to credits and select "shows nvs editor". Go into the NVS editor tab to change NFS parameters. In syntax description below \<\> means a value while \[\] describe optional parameters.
### I2C
The NVS parameter "i2c_config" set the I2C's gpio needed to enable. Leave it blank to disable I2C usage. Note that on SqueezeAMP, port must be 1. Syntax is
The NVS parameter "i2c_config" set the i2c's gpio. Leave it blank to disable I2C usage. Note that on SqueezeAMP, port must be 1. Syntax is
```
sda=<gpio_num>,scl=<gpio_num>,port=0|1
sda=<gpio>,scl=<gpio>,port=0|1
```
### SPDIF
The NVS parameter "spdif_config" sets the i2s's gpio needed for SPDIF.
SPDIF is made available by re-using i2s interface in a non-standard way, so although only one pin (DO) is needed, the controller must be fully initialized, so the bit clock (bck) and word clock (ws) must be set as well. As i2s and SPDIF are mutually exclusive, you can reuse the same IO if your hardware allows so.
Note that on SqueezeAMP, these are automatically defined.
Leave it blank to disable SPDIF usage. Syntax is
```
bck=<gpio>,ws=<gpio>,do=<gpio>
```
## Display
The NVS parameter "display_config" sets the parameters for an optional display. Syntax is
@@ -154,7 +165,6 @@ Below is a difficult but functional 2-buttons interface for your decoding pleasu
"longshifted":{"pressed":"BCTRLS_LEFT"}}
]
```
## Setting up ESP-IDF
### Docker
You can use docker to build squeezelite-esp32