Implement shared settings menu

software/CONFIGURATION.md

@@ -27,10 +27,12 @@ default configuration:
 }
 ```
 
-CPU & Pico options:
+System options:
 - `EUROPI_MODEL` specifies the type of EuroPi module. Currently only `"europi"` is supported. Default: `"europi"`
 - `PICO_MODEL` must be one of `"pico"` or `"pico w"`. Default: `"pico"`
 - `CPU_FREQ` must be one of `250000000` or `125000000`. Default: `"250000000"`
+- `MENU_AFTER_POWER_ON` is a boolean indicating whether or not the module should always return to the main menu when
+  it powers on.  By default the EuroPi will re-launch the last-used program instead of returning to the main menu. Default: `false`
 
 Display options:
 - `ROTATE_DISPLAY` must be one of `false` or `true`. Default: `false`
@@ -45,19 +47,18 @@ External I²C options:
 - `EXTERNAL_I2C_SCL` is the I²C SCL pin used for the external I²C interface. Only SCL capable pins can be selected. Default: `3`
 - `EXTERNAL_I2C_CHANNEL` is the I²C channel used for the external I²C interface, either 0 or 1. Default: `1`
 - `EXTERNAL_I2C_FREQUENCY` is the I²C frequency used for the external I²C interface. Default: `100000`
-- `EXTERNAL_I2C_TIMEOUT` is the I²C timeout in microseconds for the external I²C interface. Default: `50000`
+- `EXTERNAL_I2C_TIMEOUT` is the I²C timeout in milliseconds for the external I²C interface. Default: `1000`
 
 I/O voltage options:
-- `MAX_OUTPUT_VOLTAGE` is an integer in the range `[0, 10]` indicating the maximum voltage CV output can generate. Default: `10`
+- `MAX_OUTPUT_VOLTAGE` is a float in the range `[0.0, 10.0]` indicating the maximum voltage CV output can generate. Default: `10.0`
   The hardware is capable of 10V maximum
-- `MAX_INPUT_VOLTAGE` is an integer in the range `[0, 12]` indicating the maximum allowed voltage into the `ain` jack.
-  The hardware is capable of 12V maximum. Default: `10`
-- `GATE_VOLTAGE` is an integer in the range `[0, 10]` indicating the voltage that an output will produce when `cvx.on()`
-  is called. This value must not be higher than `MAX_OUTPUT_VOLTAGE`. Default: `5`
+- `MAX_INPUT_VOLTAGE` is a float in the range `[0.0, 12.0]` indicating the maximum allowed voltage into the `ain` jack.
+  The hardware is capable of 12V maximum. Default: `10.0`
+- `GATE_VOLTAGE` is a float in the range `[0.0, 10.0]` indicating the voltage that an output will produce when `cvx.on()`
+  is called. This value must not be higher than `MAX_OUTPUT_VOLTAGE`. Default: `5.0`
 
-Power options:
-- `MENU_AFTER_POWER_ON` is a boolean indicating whether or not the module should always return to the main menu when
-  it powers on.  By default the EuroPi will re-launch the last-used program instead of returning to the main menu. Default: `false`
+I/O voltage options should specify no more than 1 decimal point. i.e. `2.5` is acceptable, but `1.234` is not.  These
+limits are intended for broad compatibility configuration, not for precise tuning.
 
 
 # Experimental configuration

software/contrib/euclid.md

@@ -6,16 +6,23 @@ of each pattern can be independently adjusted.
 
 ## I/O Assignments
 
-- `ain`: not used
+- `ain`: external CV control (if configured)
 - `din`: external clock input
-- `b1`: Open the settings menu for the selected CV channel, or apply the current
-  option if we're already in the settings menu
-- `b2`: Toggle between the CV channel select menu & settings menu for that channel
-- `k1`: Scroll between the CV channels in the main menu, or the available settings
-  for that channel in the settings menu
-- `k2`: Scroll through the options for the current setting in the settings menu
+- `b1`: manual clock input
+- `b2`: Menu navigation
+- `k1`: manual CV control (if configured)
+- `k2`: Channel select, menu navigation
 - `cv1` to `cv6`: euclidean rhythm outputs
 
+Long-pressing B2 will switch between the visualization and menu mode.  While in menu mode, K2 will
+scroll through the available menu options. Short-press B2 to edit a setting, rotate K2 to choose the
+desired value, then press B2 again to apply it.
+
+All settings can be assigned either `Knob` or `AIN` as their value. When so-assigned, rotating K1
+or applying voltage to AIN will automatically select a valid option from the setting. e.g. setting
+CV1's `Pulses` setting to `AIN` will allow voltage sent to `AIN` to choose the number of pulses
+generated by CV1.
+
 ## Settings
 
 - Steps: the number of steps in the pattern (1-32)
@@ -41,4 +48,4 @@ re-applied automatically when the script restarts.
 ## Screensaver
 
 After 20 minutes the screen will automatically go blank.  Pressing either button
-will wake the screen up and return to the channel menu.
+or rotating either knob will wake the screen up and return to the channel menu.