From 97a96ca71653572bbabe6948020135cb62b7b600 Mon Sep 17 00:00:00 2001 From: philippe44 Date: Wed, 5 Feb 2020 15:29:01 -0800 Subject: [PATCH] Update README.md --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fbabde67..a55b27b4 100644 --- a/README.md +++ b/README.md @@ -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=,scl=,port=0|1 +sda=,scl=,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=,ws=,do= ``` ## 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