Add handling of live override mode (#298)

Author: drinfernoo

src/wled/__init__.py

@@ -5,6 +5,7 @@
     Effect,
     Info,
     Leds,
+    Live,
     Nightlight,
     Palette,
     Segment,
@@ -24,6 +25,7 @@
     "Effect",
     "Info",
     "Leds",
+    "Live",
     "Nightlight",
     "Palette",
     "Segment",

src/wled/models.py

@@ -2,6 +2,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
+from enum import IntEnum
 from typing import Any
 
 from .exceptions import WLEDError
@@ -320,6 +321,7 @@ class State:
     segments: list[Segment]
     sync: Sync
     transition: int
+    lor: Live
 
     @property
     def playlist_active(self) -> bool:
@@ -355,6 +357,7 @@ def from_dict(
         """
         brightness = data.get("bri", 1)
         on = data.get("on", False)
+        lor = data.get("lor", 0)
 
         segments = [
             Segment.from_dict(
@@ -377,6 +380,7 @@ def from_dict(
             segments=segments,
             sync=Sync.from_dict(data),
             transition=data.get("transition", 0),
+            lor=Live(lor),
         )
 
 
@@ -439,3 +443,11 @@ def update_from_dict(self, data: dict) -> Device:
             self.state = State.from_dict(_state, self.effects, self.palettes)
 
         return self
+
+
+class Live(IntEnum):
+    """Enumeration representing live override mode from WLED."""
+
+    OFF = 0
+    ON = 1
+    OFF_UNTIL_REBOOT = 2

src/wled/wled.py

@@ -20,7 +20,7 @@
     WLEDEmptyResponseError,
     WLEDError,
 )
-from .models import Device
+from .models import Device, Live
 
 
 @dataclass
@@ -462,6 +462,14 @@ async def preset(self, preset: int) -> None:
         """
         await self.request("state", method="POST", data={"ps": preset})
 
+    async def live(self, live: Live) -> None:
+        """Set the live override mode on a WLED device.
+
+        Args:
+            live: The live override mode to set on this WLED device.
+        """
+        await self.request("state", method="POST", data={"lor": live.value})
+
     async def playlist(self, playlist: int) -> None:
         """Set a running playlist on a WLED device.
 

tests/test_wled.py

@@ -568,3 +568,75 @@ async def test_info_contains_no_wv(aresponses):
         wled = WLED("example.com", session=session)
         device = await wled.update()
         assert device.info.leds.wv
+
+
+@pytest.mark.asyncio
+async def test_live_override_state_off(aresponses):
+    """Test request of current WLED live override mode."""
+    aresponses.add(
+        "example.com",
+        "/json/",
+        "GET",
+        aresponses.Response(
+            status=200,
+            headers={"Content-Type": "application/json"},
+            text=(
+                '{"state": {"on": true, "lor": 0},'
+                '"effects": [], "palettes": [],'
+                '"info": {"ver": "0.10.0"}}'
+            ),
+        ),
+    )
+
+    async with aiohttp.ClientSession() as session:
+        wled = WLED("example.com", session=session)
+        device = await wled.update()
+        assert device.state.lor == 0
+
+
+@pytest.mark.asyncio
+async def test_live_override_state_on(aresponses):
+    """Test request of current WLED live override mode."""
+    aresponses.add(
+        "example.com",
+        "/json/",
+        "GET",
+        aresponses.Response(
+            status=200,
+            headers={"Content-Type": "application/json"},
+            text=(
+                '{"state": {"on": true, "lor": 1},'
+                '"effects": [], "palettes": [],'
+                '"info": {"ver": "0.10.0"}}'
+            ),
+        ),
+    )
+
+    async with aiohttp.ClientSession() as session:
+        wled = WLED("example.com", session=session)
+        device = await wled.update()
+        assert device.state.lor == 1
+
+
+@pytest.mark.asyncio
+async def test_live_override_state_off_until_reboot(aresponses):
+    """Test request of current WLED live override mode."""
+    aresponses.add(
+        "example.com",
+        "/json/",
+        "GET",
+        aresponses.Response(
+            status=200,
+            headers={"Content-Type": "application/json"},
+            text=(
+                '{"state": {"on": true, "lor": 2},'
+                '"effects": [], "palettes": [],'
+                '"info": {"ver": "0.10.0"}}'
+            ),
+        ),
+    )
+
+    async with aiohttp.ClientSession() as session:
+        wled = WLED("example.com", session=session)
+        device = await wled.update()
+        assert device.state.lor == 2