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

Update README.md

Browse Source
This commit is contained in:
philippe44
2020-02-08 15:13:25 -08:00
committed by GitHub
parent f2920675f8
commit 9b3d5dbfa7
1 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -32,12 +32,17 @@ To access NVS, in the webUI, go to credits and select "shows nvs editor". Go int
### I2C
The NVS parameter "i2c_config" set the i2c's gpio used for generic purpose (e.g. display). Leave it blank to disable I2C usage. Note that on SqueezeAMP, port must be 1. Syntax is
```
bck=<gpio>,ws=<gpio>,do=<gpio>
sda=<gpio>,scl=<gpio>,port=0|1
```
### SPI
The NVS parameter "spi_config" set the spi's gpio used for generic purpose (e.g. display). Leave it blank to disable SPI usage. The D/C parameter is needed for displays. Syntax is
```
data=<gpio>,clk=<gpio>[,d/c=<gpio>][,host=0|1|2]
```
### DAC/I2S
The NVS parameter "dac_config" set the gpio used for i2s communication with your DAC. You can also define these at compile time but nvs parameter takes precedence. Note that on SqueezeAMP and A1S, these are forced at runtime, so this parameter does not matter. If your DAC also requires i2c, then you must go the re-compile route. Syntax is
```
sda=<gpio>,scl=<gpio>,port=0|1
bck=<gpio>,ws=<gpio>,do=<gpio>
```
### SPDIF
The NVS parameter "spdif_config" sets the i2s's gpio needed for SPDIF.
@@ -53,7 +58,8 @@ bck=<gpio>,ws=<gpio>,do=<gpio>
## Display
The NVS parameter "display_config" sets the parameters for an optional display. Syntax is
```
I2C|SPI,width=<pixels>,height=<pixels>[,address=<i2c_address>][,HFlip][,VFlip]
I2C,width=<pixels>,height=<pixels>[address=<i2c_address>][,HFlip][,VFlip]
SPI,width=<pixels>,height=<pixels>,cs=<gpio>[,HFlip][,VFlip]
```
- VFlip and HFlip are optional can be used to change display orientation
@@ -79,8 +85,9 @@ Finally, if you have an audio jack that supports insertion (set to GND when inse
Syntax is:
```
<gpio_1>=Vcc|GND|amp|jack[,<gpio_n>=Vcc|GND|amp|jack]
<gpio_1>=Vcc|GND|amp|jack_h|jack_l[,<gpio_n>=Vcc|GND|amp|jack_h|jack_l]
```
NB: jack_h is for jack inserted sets GPIO to 1 and jack_l is for 0
### Rotary Encoder
One rotary encoder is supported, quadrature shift with press. Such encoders usually have 2 pins for encoders (A and B), and common C that must be set to ground and an optional SW pin for press. A, B and SW must be pulled up, so automatic pull-up is provided by ESP32, but you can add your own resistors. A bit of filtering on A and B (~470nF) helps for debouncing which is not made by software.