Use an enum for light_mode (#18)

Enum for light mode

Author: jpelgrom

letpot/converters.py

@@ -10,6 +10,7 @@
 from letpot.exceptions import LetPotException
 from letpot.models import (
     DeviceFeature,
+    LightMode,
     TemperatureUnit,
     LetPotDeviceErrors,
     LetPotDeviceStatus,
@@ -115,7 +116,7 @@ def get_update_status_message(self, status: LetPotDeviceStatus) -> list[int]:
             2,
             1 if status.system_on else 0,
             status.pump_mode,
-            status.light_mode,
+            status.light_mode.value,
             math.floor(status.plant_days / 256),
             status.plant_days % 256,
             status.light_schedule_start.hour,
@@ -143,7 +144,7 @@ def convert_hex_to_status(self, message: PayloadType) -> LetPotDeviceStatus | No
         return LetPotDeviceStatus(
             raw=data,
             light_brightness=256 * data[17] + data[18],
-            light_mode=data[10],
+            light_mode=LightMode(data[10]),
             light_schedule_end=time(hour=data[15], minute=data[16]),
             light_schedule_start=time(hour=data[13], minute=data[14]),
             online=data[6] == 0,
@@ -192,7 +193,7 @@ def get_update_status_message(self, status: LetPotDeviceStatus) -> list[int]:
             2,
             1 if status.system_on else 0,
             status.pump_mode,
-            status.light_mode,
+            status.light_mode.value,
             math.floor(status.plant_days / 256),
             status.plant_days % 256,
             status.light_schedule_start.hour,
@@ -216,7 +217,7 @@ def convert_hex_to_status(self, message: PayloadType) -> LetPotDeviceStatus | No
         return LetPotDeviceStatus(
             raw=data,
             light_brightness=None,
-            light_mode=data[10],
+            light_mode=LightMode(data[10]),
             light_schedule_end=time(hour=data[15], minute=data[16]),
             light_schedule_start=time(hour=data[13], minute=data[14]),
             online=data[6] == 0,
@@ -264,7 +265,7 @@ def get_update_status_message(self, status: LetPotDeviceStatus) -> list[int]:
             2,
             1 if status.system_on else 0,
             status.pump_mode,
-            status.light_mode,
+            status.light_mode.value,
             math.floor(status.plant_days / 256),
             status.plant_days % 256,
             status.light_schedule_start.hour,
@@ -290,7 +291,7 @@ def convert_hex_to_status(self, message: PayloadType) -> LetPotDeviceStatus | No
         return LetPotDeviceStatus(
             raw=data,
             light_brightness=256 * data[18] + data[19],
-            light_mode=data[10],
+            light_mode=LightMode(data[10]),
             light_schedule_end=time(hour=data[15], minute=data[16]),
             light_schedule_start=time(hour=data[13], minute=data[14]),
             online=data[6] == 0,
@@ -344,7 +345,7 @@ def get_update_status_message(self, status: LetPotDeviceStatus) -> list[int]:
             2,
             1 if status.system_on else 0,
             status.pump_mode,
-            status.light_mode,
+            0 if status.light_mode is LightMode.FLOWER else 1,
             math.floor(status.plant_days / 256),
             status.plant_days % 256,
             status.light_schedule_start.hour,
@@ -367,7 +368,7 @@ def convert_hex_to_status(self, message: PayloadType) -> LetPotDeviceStatus | No
         return LetPotDeviceStatus(
             raw=data,
             light_brightness=256 * data[18] + data[19],
-            light_mode=data[10],
+            light_mode=LightMode(data[10]),
             light_schedule_end=time(hour=data[15], minute=data[16]),
             light_schedule_start=time(hour=data[13], minute=data[14]),
             online=data[6] == 0,

letpot/deviceclient.py

@@ -20,6 +20,7 @@
 from letpot.models import (
     AuthenticationInfo,
     LetPotDeviceInfo,
+    LightMode,
     TemperatureUnit,
     LetPotDeviceStatus,
 )
@@ -362,7 +363,7 @@ async def set_light_brightness(self, serial: str, level: int) -> None:
         )
         await self._publish_status(serial, status)
 
-    async def set_light_mode(self, serial: str, mode: int) -> None:
+    async def set_light_mode(self, serial: str, mode: LightMode) -> None:
         """Set the light mode for this device (flower/vegetable)."""
         status = dataclasses.replace(self._get_publish_status(serial), light_mode=mode)
         await self._publish_status(serial, status)

letpot/models.py

@@ -19,6 +19,15 @@ class DeviceFeature(IntFlag):
     WATER_LEVEL = auto()
 
 
+class LightMode(IntEnum):
+    """Device light mode."""
+
+    FLOWER = 0
+    """Fruits/flowers light mode (red/white LEDs)."""
+    VEGETABLE = 1
+    """Vegetables/herbs light mode (red/blue/white LEDs)."""
+
+
 class TemperatureUnit(IntEnum):
     """Device temperate sensor/display unit."""
 
@@ -80,7 +89,7 @@ class LetPotDeviceStatus:
 
     errors: LetPotDeviceErrors
     light_brightness: int | None
-    light_mode: int
+    light_mode: LightMode
     light_schedule_end: time
     light_schedule_start: time
     online: bool

tests/test_converter.py

@@ -6,7 +6,7 @@
 
 from letpot.converters import CONVERTERS, LPHx1Converter, LetPotDeviceConverter
 from letpot.exceptions import LetPotException
-from letpot.models import LetPotDeviceErrors, LetPotDeviceStatus
+from letpot.models import LetPotDeviceErrors, LetPotDeviceStatus, LightMode
 
 
 SUPPORTED_DEVICE_TYPES = [
@@ -25,7 +25,7 @@
 DEVICE_STATUS = LetPotDeviceStatus(
     errors=LetPotDeviceErrors(low_water=True),
     light_brightness=500,
-    light_mode=1,
+    light_mode=LightMode.VEGETABLE,
     light_schedule_end=time(17, 0),
     light_schedule_start=time(7, 30),
     online=True,