Merge pull request #7 from JnyJny/features/phase1-foundation

Phase 1: Foundation improvements for busylight-core refactoring

Author: JnyJny

.gitignore

@@ -199,3 +199,4 @@ cython_debug/
 .claude/
 
 tst.py
+plan.md

src/busylight_core/__init__.py

@@ -36,13 +36,13 @@
     BlinkStickSquare,
     BlinkStickStrip,
 )
-from .vendors.compulab import Fit_StatUSB
-from .vendors.embrava import Blynclight, Blynclight_Mini, Blynclight_Plus
+from .vendors.compulab import FitStatUSB
+from .vendors.embrava import Blynclight, BlynclightMini, BlynclightPlus
 from .vendors.epos import Busylight
-from .vendors.kuando import Busylight_Alpha, Busylight_Omega
+from .vendors.kuando import BusylightAlpha, BusylightOmega
 from .vendors.luxafor import Bluetooth, BusyTag, Flag, Mute, Orb
-from .vendors.muteme import MuteMe, MuteMe_Mini, MuteSync
-from .vendors.plantronics import Status_Indicator
+from .vendors.muteme import MuteMe, MuteMeMini, MuteSync
+from .vendors.plantronics import StatusIndicator
 from .vendors.thingm import Blink1
 
 __all__ = [
@@ -55,13 +55,13 @@
     "BlinkStickStrip",
     "Bluetooth",
     "Blynclight",
-    "Blynclight_Mini",
-    "Blynclight_Plus",
+    "BlynclightMini",
+    "BlynclightPlus",
     "BusyTag",
     "Busylight",
-    "Busylight_Alpha",
-    "Busylight_Omega",
-    "Fit_StatUSB",
+    "BusylightAlpha",
+    "BusylightOmega",
+    "FitStatUSB",
     "Flag",
     "Hardware",
     "HardwareUnsupportedError",
@@ -70,11 +70,11 @@
     "LightUnavailableError",
     "Mute",
     "MuteMe",
-    "MuteMe_Mini",
+    "MuteMeMini",
     "MuteSync",
     "NoLightsFoundError",
     "Orb",
-    "Status_Indicator",
+    "StatusIndicator",
 ]
 
 logger.disable("busylight_core")

src/busylight_core/vendors/agile_innovative/agile_innovative_base.py

@@ -0,0 +1,16 @@
+"""Agile Innovative vendor base class."""
+
+from busylight_core.light import Light
+
+
+class AgileInnovativeBase(Light):
+    """Base class for Agile Innovative devices.
+    
+    Provides common functionality for all Agile Innovative devices,
+    primarily the BlinkStick product line.
+    """
+
+    @staticmethod
+    def vendor() -> str:
+        """Return the vendor name for Agile Innovative devices."""
+        return "Agile Innovative"

src/busylight_core/vendors/agile_innovative/blinkstick_base.py

@@ -1,11 +1,10 @@
 """Base BlinkStick Implementation"""
 
-from busylight_core import Light
-
 from ._blinkstick import State
+from .agile_innovative_base import AgileInnovativeBase
 
 
-class BlinkStickBase(Light):
+class BlinkStickBase(AgileInnovativeBase):
     """Base BlinkStick Implementation
 
     Subclasses should provide a claims classmethod and a state

src/busylight_core/vendors/compulab/__init__.py

@@ -1,5 +1,5 @@
 """CompuLab Fit-statUSB Support"""
 
-from .fit_statusb import Fit_StatUSB
+from .fit_statusb import FitStatUSB
 
-__all__ = ["Fit_StatUSB"]
+__all__ = ["FitStatUSB"]

src/busylight_core/vendors/compulab/compulab_base.py

@@ -0,0 +1,16 @@
+"""CompuLab vendor base class."""
+
+from busylight_core.light import Light
+
+
+class CompuLabBase(Light):
+    """Base class for CompuLab devices.
+    
+    Provides common functionality for all CompuLab devices,
+    primarily the fit-statUSB product line.
+    """
+
+    @staticmethod
+    def vendor() -> str:
+        """Return the vendor name for CompuLab devices."""
+        return "CompuLab"

src/busylight_core/vendors/compulab/fit_statusb.py

@@ -2,11 +2,12 @@
 
 from typing import ClassVar
 
-from busylight_core.light import Light
 from busylight_core.mixins import ColorableMixin
 
+from .compulab_base import CompuLabBase
 
-class Fit_StatUSB(ColorableMixin, Light):
+
+class FitStatUSB(ColorableMixin, CompuLabBase):
     """CompuLab fit-statUSB status light controller.
 
     The fit-statUSB is a USB-connected RGB LED device that communicates
@@ -17,10 +18,6 @@ class Fit_StatUSB(ColorableMixin, Light):
         (0x2047, 0x03DF): "fit-statUSB",
     }
 
-    @staticmethod
-    def vendor() -> str:
-        """Return the vendor name for this device."""
-        return "CompuLab"
 
     def __bytes__(self) -> bytes:
         buf = f"B#{self.red:02x}{self.green:02x}{self.blue:02x}\n"

src/busylight_core/vendors/embrava/__init__.py

@@ -1,11 +1,11 @@
 """Embrava Blynclight Support"""
 
 from .blynclight import Blynclight
-from .blynclight_mini import Blynclight_Mini
-from .blynclight_plus import Blynclight_Plus
+from .blynclight_mini import BlynclightMini
+from .blynclight_plus import BlynclightPlus
 
 __all__ = [
     "Blynclight",
-    "Blynclight_Mini",
-    "Blynclight_Plus",
+    "BlynclightMini",
+    "BlynclightPlus",
 ]

src/busylight_core/vendors/embrava/blynclight.py

@@ -1,14 +1,11 @@
 """Embrava Blynclight Support"""
 
-from functools import cached_property
 from typing import ClassVar
 
-from busylight_core.light import Light
+from .embrava_base import EmbravaBase
 
-from ._blynclight import FlashSpeed, State
 
-
-class Blynclight(Light):
+class Blynclight(EmbravaBase):
     """Embrava Blynclight status light controller.
 
     The Blynclight is a USB-connected RGB LED device with additional features
@@ -19,102 +16,4 @@ class Blynclight(Light):
         (0x2C0D, 0x0001): "Blynclight",
         (0x2C0D, 0x000C): "Blynclight",
         (0x0E53, 0x2516): "Blynclight",
-    }
-
-    @cached_property
-    def state(self) -> State:
-        """The device state manager."""
-        return State()
-
-    def __bytes__(self) -> bytes:
-        if not self.is_lit:
-            self.state.off = True
-            self.state.flash = False
-            self.state.dim = False
-
-        return bytes([0, *bytes(self.state), 0xFF, 0x22])
-
-    def on(self, color: tuple[int, int, int], led: int = 0) -> None:
-        """Turn on the Blynclight with the specified color.
-
-        :param value: RGB color tuple (red, green, blue)
-        """
-        with self.batch_update():
-            self.color = color
-
-    @property
-    def color(self) -> tuple[int, int, int]:
-        """Tuple of RGB color values."""
-        return (self.state.red, self.state.green, self.state.blue)
-
-    @color.setter
-    def color(self, value: tuple[int, int, int]) -> None:
-        self.state.red, self.state.green, self.state.blue = value
-
-    def dim(self) -> None:
-        """Set the light to dim mode (reduced brightness)."""
-        with self.batch_update():
-            self.state.dim = True
-
-    def bright(self) -> None:
-        """Set the light to bright mode (full brightness)."""
-        with self.batch_update():
-            self.state.dim = False
-
-    def play_sound(
-        self,
-        music: int = 0,
-        volume: int = 1,
-        repeat: bool = False,
-    ) -> None:
-        """Play a sound on the Blynclight device.
-
-        :param music: Music track number to play (0-7)
-        :param volume: Volume level (0-3)
-        :param repeat: Whether the music repeats
-        """
-        with self.batch_update():
-            self.state.repeat = repeat
-            self.state.play = True
-            self.state.music = music
-            self.state.mute = False
-            self.state.volume = volume
-
-    def stop_sound(self) -> None:
-        """Stop playing any currently playing sound."""
-        with self.batch_update():
-            self.state.play = False
-
-    def mute(self) -> None:
-        """Mute the device sound output."""
-        with self.batch_update():
-            self.state.mute = True
-
-    def unmute(self) -> None:
-        """Unmute the device sound output."""
-        with self.batch_update():
-            self.state.mute = False
-
-    def flash(self, color: tuple[int, int, int], speed: FlashSpeed = None) -> None:
-        """Flash the light with the specified color and speed.
-
-        :param color: RGB color tuple to flash
-        :param speed: Flashing speed (default is slow)
-
-        """
-        speed = speed or FlashSpeed.slow
-
-        with self.batch_update():
-            self.color = color
-            self.state.flash = True
-            self.state.speed = speed.value
-
-    def stop_flashing(self) -> None:
-        """Stop the flashing pattern and return to solid color."""
-        with self.batch_update():
-            self.state.flash = False
-
-    def reset(self) -> None:
-        """Reset the device to its default state (off, no sound)."""
-        self.state.reset()
-        self.update()
+    }

src/busylight_core/vendors/embrava/blynclight_mini.py

@@ -2,10 +2,10 @@
 
 from typing import ClassVar
 
-from .blynclight import Blynclight
+from .embrava_base import EmbravaBase
 
 
-class Blynclight_Mini(Blynclight):
+class BlynclightMini(EmbravaBase):
     """Embrava Blynclight Mini status light controller.
 
     A smaller version of the Blynclight with the same functionality