Merge pull request #498 from AndreWohnsland/dev

Add i2c support for PCA9535, MCP23017, PCF8574

Author: AndreWohnsland

AGENTS.md

@@ -0,0 +1,40 @@
+# Project Rules
+
+- use the defined toolkit (e.g. uv, ruff, ty, yarn, biome) for dependency management and code quality
+- Ensure tests are still succeeding after making a change, if a test exists
+- Do not implement unasked extra features or edge cases, if you think they are crucial, you need to ask for permission first
+- new dependencies need to work especially under unix (Raspberry Pi) systems
+
+## App Versions
+
+- **v1 (Qt)**: Desktop app using PyQt6, run via `runme.py` or `just qt`
+- **v2 (Web)**: React frontend + FastAPI backend, run via `just api` + `just web`
+
+## Project Structure
+
+- `src/` - Main Python source (shared between v1/v2)
+- `src/ui/` - Qt UI setup code (v1 only)
+- `src/api/` - FastAPI routers & endpoints (v2 backend)
+- `web_client/src/` - React components (v2 frontend)
+- `tests/` - Pytest tests
+- `dashboard/` - Separate analytics dashboard app
+
+## Shared vs Version-Specific Code
+
+Shared code (used by both v1 and v2):
+
+- `src/database_commander.py` - Database operations
+- `src/models.py` - Core data models
+- `src/machine/` - Hardware control
+- `src/config/` - Configuration handling
+
+Version-specific code:
+
+- `src/ui/` - Qt only (v1)
+- `src/api/` - FastAPI only (v2)
+
+## Configuration
+
+- `src/config/` - Configuration management module
+- `custom_config.yaml` - User customization file
+- `web_client/.env.*` - Web client environment settings

docs/payment.md

@@ -197,35 +197,35 @@ The recommended way for a "basic" hardware setup is:
 ### Installation Steps
 
 === "NFC Based"
-    **Linux Systems**
 
-    Linux is the most easy way, since most of the things can be done over a script.
-    Just run:
+    Follow the according steps for your OS to set up the payment service and GUI.
 
-    ```bash
-    wget -O - https://raw.githubusercontent.com/AndreWohnsland/CocktailBerry-Payment/main/scripts/unix_installer.sh | bash
-    ```
+    === "Linux Systems"
 
-    Then follow the services installation steps below.
+        Linux is the most easy way, since most of the things can be done over a script.
+        Just run:
 
-    **Windows Systems**
+        ```bash
+        wget -O - https://raw.githubusercontent.com/AndreWohnsland/CocktailBerry-Payment/main/scripts/unix_installer.sh | bash
+        ```
 
-    Windows can be quite restrictive when it comes to executing scripts and similar tasks.
-    Make sure the user is able to execute PowerShell as well as Python scripts and can install applications.
-    If you want to use docker on windows, make sure you [install it](https://docs.docker.com/desktop/setup/install/windows-install/) and set it to auto start with windows.
+    === "Windows Systems"
 
-    Then just open a PowerShell terminal as Administrator and run the following command to download and execute the installation script:
+        Windows can be quite restrictive when it comes to executing scripts and similar tasks.
+        Make sure the user is able to execute PowerShell as well as Python scripts and can install applications.
+        If you want to use docker on windows, make sure you [install it](https://docs.docker.com/desktop/setup/install/windows-install/) and set it to auto start with windows.
 
-    ```powershell
-    powershell -ExecutionPolicy ByPass -c "irm https://github.com/AndreWohnsland/CocktailBerry-Payment/blob/main/scripts/windows_installer.ps1 | iex"
-    ```
+        Then open a PowerShell terminal as Administrator and run the following command to download and execute the installation script:
+
+        ```powershell
+        powershell -ExecutionPolicy ByPass -c "irm https://github.com/AndreWohnsland/CocktailBerry-Payment/blob/main/scripts/windows_installer.ps1 | iex"
+        ```
 
-    <!-- TODO: LINK -->
-    <!-- Alternatively, there is also a pre-built executable available for the GUI, which you can download from the release page. -->
-    <!-- You might not be able to set all options tough when using this directly, so even when using this, going over this preparation and service installation steps is recommended. -->
+        <!-- TODO: LINK -->
+        <!-- Alternatively, there is also a pre-built executable available for the GUI, which you can download from the release page. -->
+        <!-- You might not be able to set all options tough when using this directly, so even when using this, going over this preparation and service installation steps is recommended. -->
 
-    If [uv](https://docs.astral.sh/uv/getting-started/installation) or [git](https://git-scm.com/install/windows) fails to install, you might need to install them manually first.
-    Then follow the services installation steps below.
+        If [uv](https://docs.astral.sh/uv/getting-started/installation) or [git](https://git-scm.com/install/windows) fails to install, you might need to install them manually first.
 
     **Service installation**
 

docs/setup.md

@@ -64,15 +64,15 @@ They can be used at own risk of CocktailBerry not working 100% properly.
 ??? info "List Hardware Config Values"
     Hardware config values are used to configure and enable the connected hardware.
 
-    | Value Name             | Description                                                                                     |
-    | :--------------------- | :---------------------------------------------------------------------------------------------- |
-    | `PUMP_CONFIG`          | List with config for each pump: pin, volume flow, tube volume to pump up                        |
-    | `LED_NORMAL`           | List of normal (non-addressable) LED configs: pin, default on, prep state                       |
-    | `LED_WSLED`            | List of WS281x (addressable) LED configs: pin, brightness, count, rings, default on, prep state |
-    | `RFID_READER`          | Enables connected RFID reader, [more info](troubleshooting.md#set-up-rfid-reader)               |
-    | `MAKER_PINS_INVERTED`  | [Inverts](faq.md#what-is-the-inverted-option) pin signal (on=low, off=high)                     |
-    | `MAKER_PUMP_REVERSION` | Enables reversion (direction) of pump                                                           |
-    | `MAKER_REVERSION_PIN`  | [Pin](#configuring-the-pins-or-used-board) which triggers reversion                             |
+    | Value Name                    | Description                                                                                     |
+    | :---------------------------- | :---------------------------------------------------------------------------------------------- |
+    | `MAKER_PINS_INVERTED`         | [Inverts](faq.md#what-is-the-inverted-option) pin signal (on=low, off=high)                     |
+    | `PUMP_CONFIG`                 | List with config for each pump: pin, volume flow, tube volume to pump up                        |
+    | `I2C_CONFIG`                  | Config for I2C GPIO expander (16 pins, 0-15)                                                    |
+    | `LED_NORMAL`                  | List of normal (non-addressable) LED configs: pin, default on, prep state                       |
+    | `LED_WSLED`                   | List of WS281x (addressable) LED configs: pin, brightness, count, rings, default on, prep state |
+    | `RFID_READER`                 | Enables connected RFID reader, [more info](troubleshooting.md#set-up-rfid-reader)               |
+    | `MAKER_PUMP_REVERSION_CONFIG` | Enables reversion (direction) of pump during cleaning                                           |
 
 ??? info "List Software Config Values"
     Software config values are used to configure additional connected software and its behavior.

pyproject.toml

@@ -22,11 +22,15 @@ dependencies = [
     "mfrc522>=0.0.7 ; sys_platform == 'linux'",
     "rpi-ws281x>=5.0.0 ; sys_platform == 'linux'",
     "gpiozero>=2.0.1 ; sys_platform == 'linux'",
+    "rpi-gpio>=0.7.1 ; sys_platform == 'linux'",
     "python-periphery>=2.4.1",
     "sqlalchemy>=2.0.40",
     "alembic>=1.14.1",
     "pulp>=3.2.2",
     "stamina>=25.2.0",
+    "adafruit-circuitpython-mcp230xx>=2.5.19",
+    "adafruit-circuitpython-pcf8574>=1.0.15",
+    "adafruit-circuitpython-busdevice>=5.2.15",
 ]
 
 [dependency-groups]

scripts/setup.sh

@@ -113,7 +113,9 @@ else
     uv pip install lgpio
   fi
   # on none RPi devices, we need to set control to the GPIOs, and set user to sudoers
-  if ! is_raspberry_pi; then
+  if is_raspberry_pi; then
+    sudo raspi-config nonint do_i2c 0
+  else
     bash scripts/setup_non_rpi.sh
   fi
 fi

src/__init__.py

@@ -8,5 +8,7 @@
 SupportedRfidType = Literal["No", "MFRC522", "USB"]
 SupportedPaymentOptions = Literal["Disabled", "CocktailBerry", "SumUp"]
 SupportedLedStatesType = Literal["Effect", "On", "Off"]
+I2CExpanderType = Literal["MCP23017", "PCF8574", "PCA9535"]
+SupportedPinControlType = Literal["GPIO", "MCP23017", "PCF8574", "PCA9535"]
 NEEDED_PYTHON_VERSION = (3, 11)
 FUTURE_PYTHON_VERSION = (3, 13)

src/api/routers/options.py

@@ -106,7 +106,7 @@ async def update_options(options: dict, background_tasks: BackgroundTasks) -> Ap
 async def clean_machine(background_tasks: BackgroundTasks) -> ApiMessage:
     raise_when_cocktail_is_in_progress()
     _logger.log_header("INFO", "Cleaning the Pumps")
-    revert_pumps = cfg.MAKER_PUMP_REVERSION
+    revert_pumps = cfg.MAKER_PUMP_REVERSION_CONFIG.use_reversion
     mc = MachineController()
     background_tasks.add_task(mc.clean_pumps, None, revert_pumps)
     return ApiMessage(message=DH.get_translation("cleaning_started"))

src/config/config_manager.py

@@ -27,15 +27,17 @@
     ConfigInterface,
     DictType,
     FloatType,
+    I2CExpanderConfig,
     IntType,
     ListType,
     NormalLedConfig,
     PumpConfig,
+    ReversionConfig,
     StringType,
     WS281xLedConfig,
 )
 from src.config.errors import ConfigError
-from src.config.validators import build_number_limiter, validate_max_length
+from src.config.validators import build_number_limiter, validate_max_length, valide_no_identical_active_i2c_devices
 from src.filepath import CUSTOM_CONFIG_FILE
 from src.logger_handler import LoggerHandler
 from src.models import CocktailStatus
@@ -81,8 +83,12 @@ class ConfigManager:
     UI_PICTURE_SIZE: int = 240
     UI_ONLY_MAKER_TAB: bool = False
     PUMP_CONFIG: ClassVar[list[PumpConfig]] = [
-        PumpConfig(pin, flow, 0) for pin, flow in zip(_default_pins, _default_volume_flow)
+        PumpConfig(pin, flow, 0, "GPIO") for pin, flow in zip(_default_pins, _default_volume_flow)
     ]
+    # Inverts the pin signal (on is low, off is high)
+    MAKER_PINS_INVERTED: bool = True
+    # MCP23017 I2C GPIO expander configuration (16 pins, address 0x20-0x27)
+    I2C_CONFIG: ClassVar[list[I2CExpanderConfig]] = []
     # Custom name of the Maker
     MAKER_NAME: str = f"CocktailBerry (#{random.randint(0, 1000000):07})"
     # Number of bottles possible at the machine
@@ -95,16 +101,12 @@ class ConfigManager:
     MAKER_CLEAN_TIME: int = 20
     # Base multiplier for alcohol in the recipe
     MAKER_ALCOHOL_FACTOR: int = 100
-    # Option to invert pump direction
-    MAKER_PUMP_REVERSION: bool = False
-    # Pin used for the pump direction
-    MAKER_REVERSION_PIN: int = 0
+    # Reversion for cleaning
+    MAKER_PUMP_REVERSION_CONFIG = ReversionConfig(use_reversion=False, pin=0, pin_type="GPIO", inverted=False)
     # If the maker should check automatically for updates
     MAKER_SEARCH_UPDATES: bool = True
     # If the maker should check if there is enough in the bottle before making a cocktail
     MAKER_CHECK_BOTTLE: bool = True
-    # Inverts the pin signal (on is low, off is high)
-    MAKER_PINS_INVERTED: bool = True
     # Theme Setting to load according qss file
     MAKER_THEME: SupportedThemesType = "default"
     # How many ingredients are allowed to be added by hand to be available cocktail
@@ -175,28 +177,49 @@ def __init__(self) -> None:
             "UI_HEIGHT": IntType([build_number_limiter(1, 3000)]),
             "UI_PICTURE_SIZE": IntType([build_number_limiter(100, 1000)]),
             "UI_ONLY_MAKER_TAB": BoolType(check_name="Only Maker Tab Accessible"),
+            "MAKER_PINS_INVERTED": BoolType(check_name="Inverted"),
             "PUMP_CONFIG": ListType(
                 DictType(
                     {
-                        "pin": IntType([build_number_limiter(0, 1000)], prefix="Pin:"),
+                        "pin_type": ChooseOptions.pin,
+                        "pin": IntType([build_number_limiter(0)], prefix="Pin:"),
                         "volume_flow": FloatType([build_number_limiter(0.1, 1000)], suffix="ml/s"),
                         "tube_volume": IntType([build_number_limiter(0, 100)], suffix="ml"),
                     },
                     PumpConfig,
                 ),
                 lambda: self.choose_bottle_number(ignore_limits=True),
             ),
+            "I2C_CONFIG": ListType(
+                DictType(
+                    {
+                        "device_type": ChooseOptions.i2c,
+                        "enabled": BoolType(check_name="Enabled", default=True),
+                        "address_int": IntType(prefix="0x", default=20),
+                        "inverted": BoolType(check_name="Inverted"),
+                    },
+                    I2CExpanderConfig,
+                ),
+                0,
+                [valide_no_identical_active_i2c_devices],
+            ),
             "MAKER_NAME": StringType([validate_max_length]),
             "MAKER_NUMBER_BOTTLES": IntType([build_number_limiter(1, 999)]),
             "MAKER_PREPARE_VOLUME": ListType(IntType([build_number_limiter(25, 1000)], suffix="ml", default=100), 1),
             "MAKER_SIMULTANEOUSLY_PUMPS": IntType([build_number_limiter(1, 999)]),
             "MAKER_CLEAN_TIME": IntType([build_number_limiter()], suffix="s"),
             "MAKER_ALCOHOL_FACTOR": IntType([build_number_limiter(10, 200)], suffix="%"),
-            "MAKER_PUMP_REVERSION": BoolType(check_name="Pump can be Reversed"),
-            "MAKER_REVERSION_PIN": IntType([build_number_limiter(0, 1000)]),
+            "MAKER_PUMP_REVERSION_CONFIG": DictType(
+                {
+                    "use_reversion": BoolType(check_name="active", default=False),
+                    "pin": IntType([build_number_limiter(0)], default=0, prefix="Pin:"),
+                    "pin_type": ChooseOptions.pin,
+                    "inverted": BoolType(check_name="Inverted", default=False),
+                },
+                ReversionConfig,
+            ),
             "MAKER_SEARCH_UPDATES": BoolType(check_name="Search for Updates"),
             "MAKER_CHECK_BOTTLE": BoolType(check_name="Check Bottle Volume"),
-            "MAKER_PINS_INVERTED": BoolType(check_name="Inverted"),
             "MAKER_THEME": ChooseOptions.theme,
             "MAKER_MAX_HAND_INGREDIENTS": IntType([build_number_limiter(0, 10)]),
             "MAKER_CHECK_INTERNET": BoolType(check_name="Check Internet"),
@@ -205,7 +228,8 @@ def __init__(self) -> None:
             "LED_NORMAL": ListType(
                 DictType(
                     {
-                        "pin": IntType([build_number_limiter(0, 200)], prefix="Pin:"),
+                        "pin_type": ChooseOptions.pin,
+                        "pin": IntType([build_number_limiter(0)], prefix="Pin:"),
                         "default_on": BoolType(check_name="Default On"),
                         "preparation_state": ChooseOptions.leds,
                     },
@@ -216,7 +240,7 @@ def __init__(self) -> None:
             "LED_WSLED": ListType(
                 DictType(
                     {
-                        "pin": IntType([build_number_limiter(0, 200)], prefix="Pin:"),
+                        "pin": IntType([build_number_limiter(0)], prefix="Pin:"),
                         "brightness": IntType([build_number_limiter(1, 100)], suffix="%", default=100),
                         "count": IntType([build_number_limiter(1, 500)], suffix="LEDs", default=24),
                         "number_rings": IntType([build_number_limiter(1, 10)], suffix="X", default=1),
@@ -341,6 +365,8 @@ def set_config(self, configuration: dict, validate: bool) -> None:
         self._set_config(no_list_or_dict, validate)
         list_or_dict = {k: value for k, value in configuration.items() if isinstance(value, list | dict)}
         self._set_config(list_or_dict, validate)
+        # Cross-config validation for dependencies between configs
+        self._validate_cross_config(validate)
 
     def _set_config(self, configuration: dict, validate: bool) -> None:
         for config_name, config_value in configuration.items():
@@ -358,13 +384,31 @@ def _set_config(self, configuration: dict, validate: bool) -> None:
                 if validate:
                     raise e
 
-    def _validate_config_type(self, configname: str, configvalue: Any) -> None:
-        """Validate the configvalue if its fit the type / conditions."""
-        config_setting = self.config_type.get(configname)
-        # old or user added configs will not be validated
-        if config_setting is None:
-            return
-        config_setting.validate(configname, configvalue)
+    def _validate_cross_config(self, validate: bool) -> None:
+        """Validate cross-config dependencies.
+
+        Currently implemented:
+        - Checks that I2C pin types used in PUMP_CONFIG have corresponding enabled devices in I2C_CONFIG.
+        """
+        # Collect all I2C pin types used in PUMP_CONFIG (excluding GPIO)
+        required_i2c_types: set[str] = set()
+        for pump in self.PUMP_CONFIG:
+            if pump.pin_type != "GPIO":
+                required_i2c_types.add(pump.pin_type)
+
+        # Get enabled I2C device types from I2C_CONFIG
+        enabled_i2c_types = {cfg.device_type for cfg in self.I2C_CONFIG if cfg.enabled}
+
+        # Check that all required I2C types have enabled devices
+        missing_types = required_i2c_types - enabled_i2c_types
+        if missing_types:
+            error_msg = (
+                f"PUMP_CONFIG uses I2C pin types {', '.join(missing_types)} but I2C_CONFIG "
+                "has no enabled devices of these types. Add enabled entries to I2C_CONFIG."
+            )
+            _logger.error(f"Config Error: {error_msg}")
+            if validate:
+                raise ConfigError(error_msg)
 
     def choose_bottle_number(self, get_all: bool = False, ignore_limits: bool = False) -> int:
         """Select the number of Bottles, limits by max supported count."""