Unified configuration page

[sle118]

I think it's time to align the GPIO config page to make it match with how the system has evolved. I'll build a backend endpoint to retrieve/update them in a central place. @daduke could then update the front-end if he has bandwidth.

[sle118]

@daduke , speaking with Philippe, I think it will be better if we had a general config page with a section for each important section of configuration. Basically, a tab that takes various key nvs parameters and expose them in a simple way. Some of the key elements to include

• device name is a text box used to change the device name. Upon changing the field value, the following nvs config elements should be sent
  • bt_name
  • a2dp_dev_name
  • airplay_name
  • ap_ssid
  • host_name
  • the "-n " name parameter in the squeezelite autoexec command line.
• DAC configuration : dac_config bck=,ws=,do=[,mute=[:0|1][,model=TAS57xx|TAS5713|AC101|I2S][,sda=,scl=gpio[,i2c=]]
  • model is one of "I2S", "TAS57xx", "TAS5713", "AC101"
  • bck is i2s clock GPIO
  • ws is word select GPIO
  • do is Data Out GPIO
  • mute is the GPIO connected to the amp's mute input (if any), followed by an optional value ":0" or ":1" to set the active mute GPIO level
• SPDIF Configuration : spdif_config [bck=,ws=,do=]
  • SPDIF and I2S are mutually exclusive, and bck as well as ws aren't used by SPDIF, so these 2 fields can be defaulted with the DAC configuration values and be hidden for simplicity.
  • do is SPDIF data GPIO
• SPI Configuration spi_config = data=,clk=[,dc=][,host=1|2]
  • data is SPI data GPIO
  • clk is SPI clock GPIO
  • dc is SPI data control GPIO (needed for display)
  • host is the ESP32 SPI host to use
• I2C : i2c_config sda=,scl=[,port=0|1][,speed=]
  • scl is i2c clock GPIO
  • sda is i2c data GPIO
  • speed is i2c clock speed
  • port is the i2c port to use (0 or 1). Note that the status json will now contain a new field: is_i2c_locked. When true, this only i2c port 1 can be selected because port 0 is reserved for internal DAC use.
• Display : display_config = [INTERFACE_TYPE,driver=ILI9341,width=240,height=320,cs=19,speed=16000000,reset=21,HFlip,VFlip]
  • INTERFACE_TYPE is I2C or SPI
  • driver is one of of "SH1106","SSD1306", "SSD1322","SSD1326","SSD1327","SSD1675","SSD1351","ST77xx","ILI9341"
  • width is screen width
  • height is screen height
  • back is backlight GPIO number
  • HFLip checkbox to activate Horizontal flip
  • VFlip checkbox to activate vertical flip
  • Rotate is a checkbox to rotate the picture. For non-square drivers, move to portrait mode. Note that width and height must be inverted
  • SPI Specific
    • cs is chip select
    • speed is SPI bus speed
  • I2C Specific
    • if I2C display is specified, then the system I2C GPIO configuration must be provided
    • address is the display driver chip address
• enable_bt_sink (0/1) is a checkbox to enable/disable the bluetooth sink service
• enable_airplay (0/1) is a checkbox to enable/disable the airplay service
• jack_mutes_amp (y/n) is a checkbox to mute the amp upon jack insertion. This works on SqueezeAmp. More detailed logic TBD to decide how to smartly enable/disable this checkbox
• Led brightness : led_brightness [green=50, red=50]
  • green controls the brightness of the green led, values are from 0 to 100
  • red controls the brightness of the red led, values are from 0 to 100

The GUI should do some basic checking (e.g. display needs the i2c config if I2C interface specified for display, SPI if SPI interface specified, etc). Then it should send only a subset of nvs values in a similar way to the nvs editor. There should be 2 buttons:

• Commit : just push the config values to the esp32
• Apply : confirm that user will reboot, push nvs values, and upon returning from the nvs call, call the reboot service

These 2 buttons should also ideally be there in the audio/squeezelite config tab.

[sle118]

Another nvs to add: set_GPIO

it's a mix bag that should probably blend in the respective "functional sections" of the config.

here's from the current readme

Set GPIO

The parameter "set_GPIO" is use to assign GPIO to various functions.

GPIO can be set to GND provide or Vcc at boot. This is convenient to power devices that consume less than 40mA from the side connector. Be careful because there is no conflict checks being made wrt which GPIO you're changing, so you might damage your board or create a conflict here.

The \<amp> parameter can use used to assign a GPIO that will be set to 1 when playback starts. It will be reset to 0 when squeezelite becomes idle. The idle timeout is set on the squeezelite command line through -C \<timeout>

If you have an audio jack that supports insertion (use :0 or :1 to set the level when inserted), you can specify which GPIO it's connected to. Using the parameter jack_mutes_amp allows to mute the amp when headset (e.g.) is inserted.

You can set the Green and Red status led as well with their respective active state (:0 or :1)

The \<ir> parameter set the GPIO associated to an IR receiver. No need to add pullup or capacitor

Syntax is:

<gpio>=Vcc|GND|amp|ir|jack[:0|1]|green[:0|1]|red[:0|1]|spkfault[:0|1][,<repeated sequence for next GPIO>]

You can define the defaults for jack, spkfault leds at compile time but nvs parameter takes precedence except for SqueezeAMP where these are forced at runtime.

[sle118]

I have started the implementation, leveraging the framework I had already implemented; the framework allows existing command lines to expose a UI transparently.

At this point, I am starting to learn towards defaulting all the SPI, I2C and I2S GPIO'S instead of providing an empty slate, which can be daunting for some users. The flexibility will remain, but things like display configuration would be simplified a lot of the only parameters to figure out are SPI vs I2C and driver name.

The UI could then be used to show how to plug these external devices (external DAC, screen, buttons, rotary...).

Comments are welcomed.

[sle118]

Some progress to report here

• A configuration back-end is now available to expose console commands as UI configuration elements
• Services implemented (Telnet, BT Sink, Airplay, etc)
• Centralized device name update implemented
• Display configuration implemented
• I2C bus configuration implemented
• SPI bus configuratio implemented

[sle118]

I'm going to go ahead and close this. Recent changes were made to address this and the UI, although far from ideal, it's now exposing more configuration options in a better way than the NVS