add config to control led behavior during preparation

Author: AndreWohnsland

docs/setup.md

@@ -65,19 +65,20 @@ 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_PINS`             | List of pins connected to LEDs for preparation                                           |
-    | `LED_BRIGHTNESS`       | Brightness for the WS281x LED (1-255)                                                    |
-    | `LED_COUNT`            | Number of LEDs on the WS281x                                                             |
-    | `LED_NUMBER_RINGS`     | Number of IDENTICAL daisy chained WS281x LED rings                                       |
-    | `LED_DEFAULT_ON`       | Always turn on to a white LED by default                                                 |
-    | `LED_IS_WS`            | Is the led a controllable WS281x LED, [see also](troubleshooting.md#get-the-led-working) |
-    | `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                                                                              |
+    | :---------------------- | :--------------------------------------------------------------------------------------- |
+    | `PUMP_CONFIG`           | List with config for each pump: pin, volume flow, tube volume to pump up                 |
+    | `LED_PINS`              | List of pins connected to LEDs for preparation                                           |
+    | `LED_BRIGHTNESS`        | Brightness for the WS281x LED (1-255)                                                    |
+    | `LED_COUNT`             | Number of LEDs on the WS281x                                                             |
+    | `LED_NUMBER_RINGS`      | Number of IDENTICAL daisy chained WS281x LED rings                                       |
+    | `LED_DEFAULT_ON`        | Always turn on to a white LED by default                                                 |
+    | `LED_PREPARATION_STATE` | Set LED state/effect during preparation (e.g. color effects, on, off)                    |
+    | `LED_IS_WS`             | Is the led a controllable WS281x LED, [see also](troubleshooting.md#get-the-led-working) |
+    | `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                      |
 
 ??? info "List Software Config Values"
     Software config values are used to configure additional connected software and its behavior.

src/__init__.py

@@ -6,5 +6,6 @@
 SupportedLanguagesType = Literal["en", "de"]
 SupportedThemesType = Literal["default", "bavaria", "alien", "berry", "tropical", "purple", "custom"]
 SupportedRfidType = Literal["No", "MFRC522", "PiicoDev"]
+SupportedLedStatesType = Literal["Off", "On", "Effect"]
 NEEDED_PYTHON_VERSION = (3, 9)
 FUTURE_PYTHON_VERSION = (3, 11)

src/config/config_manager.py

@@ -14,6 +14,7 @@
     MAX_SUPPORTED_BOTTLES,
     PROJECT_NAME,
     SupportedLanguagesType,
+    SupportedLedStatesType,
     SupportedRfidType,
     SupportedThemesType,
     __version__,
@@ -120,6 +121,8 @@ class ConfigManager:
     LED_NUMBER_RINGS: int = 1
     # Turns the led always on to a white when not doing anything else
     LED_DEFAULT_ON: bool = False
+    # LED does things during Preparation (e.g. on or color effects)
+    LED_PREPARATION_STATE: SupportedLedStatesType = "Effect"
     # If the led is as ws-x series (and controllable)
     LED_IS_WS: bool = True
     # if a RFID reader exists
@@ -195,6 +198,7 @@ def __init__(self) -> None:
             "LED_COUNT": IntType([build_number_limiter(1, 500)]),
             "LED_NUMBER_RINGS": IntType([build_number_limiter(1, 10)]),
             "LED_DEFAULT_ON": BoolType(check_name="Default On"),
+            "LED_PREPARATION_STATE": ChooseOptions.leds,
             "LED_IS_WS": BoolType(check_name="WS281x"),
             "RFID_READER": ChooseOptions.rfid,
             "MICROSERVICE_ACTIVE": BoolType(check_name="Microservice Active"),

src/config/config_types.py

@@ -10,12 +10,13 @@
 from dataclasses import dataclass, field
 from typing import Any, Callable, Generic, Protocol, TypeVar, get_args
 
-from src import SupportedLanguagesType, SupportedRfidType, SupportedThemesType
+from src import SupportedLanguagesType, SupportedLedStatesType, SupportedRfidType, SupportedThemesType
 from src.config.errors import ConfigError
 
 SUPPORTED_LANGUAGES = list(get_args(SupportedLanguagesType))
 SUPPORTED_THEMES = list(get_args(SupportedThemesType))
 SUPPORTED_RFID = list(get_args(SupportedRfidType))
+SUPPORTED_LED_STATES = list(get_args(SupportedLedStatesType))
 
 
 class ConfigInterface(Protocol):
@@ -66,6 +67,7 @@ class ChooseOptions:
     language = ChooseType(allowed=SUPPORTED_LANGUAGES)
     rfid = ChooseType(allowed=SUPPORTED_RFID)
     theme = ChooseType(allowed=SUPPORTED_THEMES)
+    leds = ChooseType(allowed=SUPPORTED_LED_STATES)
 
 
 @dataclass

src/language.yaml

@@ -670,6 +670,9 @@ ui:
     LED_DEFAULT_ON:
       en: 'LED is on by default, use white LED color. Still use colors during preparation.'
       de: 'LED ist standardmäßig an, verwendet weiße LED Farbe. Verwendet immer noch Farben-Zyklus während der Zubereitung.'
+    LED_PREPARATION_STATE:
+      en: 'LED state during preparation, on/off/effects.'
+      de: 'LED Zustand während der Zubereitung, an/aus/Effekte.'
     LED_IS_WS:
       en: 'Is the LED a controllable (WS281x) LED'
       de: 'Ist der LED ein ansteuerbarer (WS281x) LED'

src/machine/leds.py

@@ -101,14 +101,22 @@ def turn_off(self) -> None:
 
     def preparation_start(self) -> None:
         """Turn the LED on during preparation."""
-        self.turn_on()
+        if cfg.LED_PREPARATION_STATE in ("On", "Effect"):
+            self.turn_on()
+        else:
+            self.turn_off()
 
     def preparation_end(self, duration: int = 5) -> None:
         """Blink for some time after preparation."""
-        self.turn_off()
-        blinker = Thread(target=self._blink_for, kwargs={"duration": duration})
-        blinker.daemon = True
-        blinker.start()
+        if cfg.LED_PREPARATION_STATE == "Effect":
+            self.turn_off()
+            blinker = Thread(target=self._blink_for, kwargs={"duration": duration})
+            blinker.daemon = True
+            blinker.start()
+        elif cfg.LED_DEFAULT_ON:
+            self.turn_on()
+        else:
+            self.turn_off()
 
     def _blink_for(self, duration: int = 5, interval: float = 0.2) -> None:
         current_time = 0.0
@@ -223,14 +231,24 @@ def _end_thread(self, duration: int = 5) -> None:
 
     def preparation_start(self) -> None:
         """Effect during preparation."""
-        self.is_preparing = True
-        cycler = Thread(target=self._preparation_thread)
-        cycler.daemon = True
-        cycler.start()
+        if cfg.LED_PREPARATION_STATE == "Effect":
+            self.is_preparing = True
+            cycler = Thread(target=self._preparation_thread)
+            cycler.daemon = True
+            cycler.start()
+        elif cfg.LED_PREPARATION_STATE == "On":
+            self.turn_on()
+        else:
+            self.turn_off()
 
     def preparation_end(self, duration: int = 5) -> None:
         """Plays an effect after the preparation for x seconds."""
-        self.is_preparing = False
-        rainbow = Thread(target=self._end_thread, kwargs={"duration": duration})
-        rainbow.daemon = True
-        rainbow.start()
+        if cfg.LED_PREPARATION_STATE == "Effect":
+            self.is_preparing = False
+            rainbow = Thread(target=self._end_thread, kwargs={"duration": duration})
+            rainbow.daemon = True
+            rainbow.start()
+        elif cfg.LED_DEFAULT_ON:
+            self.turn_on()
+        else:
+            self.turn_off()