python-rako-2025 0.0.1__tar.gz → 0.2.0__tar.gz

{python_rako_2025-0.0.1/python_rako_2025.egg-info → python_rako_2025-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-rako-2025
-Version: 0.0.1
+Version: 0.2.0
 Summary: Asynchronous Python client for Rako Controls Lighting
 Home-page: https://github.com/simonleigh/python-rako
 Author: Simon Leigh

{python_rako_2025-0.0.1 → python_rako_2025-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-rako-2025"
-version = "0.0.1"
+version = "0.2.0"
 description = "Asynchronous Python client for Rako Controls Lighting"
 readme = "README.md"
 keywords = ["rako", "controls", "api", "async", "client"]
@@ -81,6 +81,7 @@ warn_unused_ignores = true
 warn_return_any = true
 warn_unreachable = true
 strict_equality = true
+enable_error_code = ["ignore-without-code"]
 
 [tool.pytest.ini_options]
-asyncio_mode = "auto"
+asyncio_mode = "auto"

{python_rako_2025-0.0.1 → python_rako_2025-0.2.0}/python_rako/__init__.py

@@ -15,14 +15,17 @@ from python_rako.model import (  # noqa
     BridgeInfo,
     ChannelLight,
     ChannelStatusMessage,
+    ChannelVentilation,
     LevelCache,
     LevelCacheItem,
     Light,
     RoomChannel,
     RoomLight,
+    RoomVentilation,
     SceneCache,
     SceneStatusMessage,
     UnsupportedMessage,
+    Ventilation,
 )
 
 _LOGGER = logging.getLogger(__name__)

{python_rako_2025-0.0.1 → python_rako_2025-0.2.0}/python_rako/__version__.py

@@ -1,2 +1,3 @@
 """AUTOGENERATED ON RELEASE."""
-__version__ = "0.0.1"
+
+__version__ = "0.2.0"

{python_rako_2025-0.0.1 → python_rako_2025-0.2.0}/python_rako/bridge.py

@@ -2,7 +2,8 @@ from __future__ import annotations
 
 import asyncio
 import logging
-from typing import Any, AsyncGenerator, Generator, Tuple
+from collections.abc import AsyncGenerator, Generator
+from typing import Any
 
 import aiohttp
 import xmltodict
@@ -24,6 +25,7 @@ from python_rako.helpers import (
 from python_rako.model import (
     BridgeInfo,
     ChannelLight,
+    ChannelVentilation,
     CommandHTTP,
     CommandLevelHTTP,
     CommandSceneHTTP,
@@ -32,7 +34,9 @@ from python_rako.model import (
     LevelCache,
     Light,
     RoomLight,
+    RoomVentilation,
     SceneCache,
+    Ventilation,
 )
 
 _LOGGER = logging.getLogger(__name__)
@@ -158,11 +162,26 @@ class Bridge:
 
     async def discover_lights(
         self, session: aiohttp.ClientSession
-    ) -> AsyncGenerator[Light, None]:
+    ) -> AsyncGenerator[Light]:
         rako_xml = await self.get_rako_xml(session)
         for light in self.get_lights_from_discovery_xml(rako_xml):
             yield light
 
+    async def discover_ventilation(
+        self, session: aiohttp.ClientSession
+    ) -> AsyncGenerator[Ventilation]:
+        rako_xml = await self.get_rako_xml(session)
+        for device in self.get_devices_from_discovery_xml(rako_xml, "Ventilation"):
+            if isinstance(device, (RoomVentilation, ChannelVentilation)):
+                yield device
+
+    async def discover_all_devices(
+        self, session: aiohttp.ClientSession
+    ) -> AsyncGenerator[Light | Ventilation]:
+        rako_xml = await self.get_rako_xml(session)
+        for device in self.get_devices_from_discovery_xml(rako_xml):
+            yield device
+
     async def get_info(self, session: aiohttp.ClientSession) -> BridgeInfo:
         try:
             rako_xml = await self.get_rako_xml(session)
@@ -192,18 +211,43 @@ class Bridge:
         )
 
     @staticmethod
-    def get_lights_from_discovery_xml(xml: str) -> Generator[Light, None, None]:
-        xml_dict = xmltodict.parse(xml, force_list={'Room'})
+    def get_lights_from_discovery_xml(xml: str) -> Generator[Light]:
+        for device in Bridge.get_devices_from_discovery_xml(xml, "Lights"):
+            if isinstance(device, (RoomLight, ChannelLight)):
+                yield device
+
+    @staticmethod
+    def get_all_devices_from_discovery_xml(xml: str) -> Generator[Light | Ventilation]:
+        """Get all devices (lights and ventilation) from discovery XML."""
+        return Bridge.get_devices_from_discovery_xml(xml)
+
+    @staticmethod
+    def get_devices_from_discovery_xml(
+        xml: str, device_types: str | list[str] | None = None
+    ) -> Generator[Light | Ventilation]:
+        # Handle different input types for backward compatibility
+        if device_types is None or device_types == "All":
+            target_types = {"Lights", "Ventilation"}
+        elif isinstance(device_types, str):
+            target_types = {device_types}
+        else:
+            target_types = set(device_types)
+
+        xml_dict = xmltodict.parse(xml, force_list={"Room"})
         for room in xml_dict["rako"]["rooms"]["Room"]:
             room_id = int(room["@id"])
             room_type = room.get("Type", "Lights")
-            if room_type != "Lights":
-                _LOGGER.info(
-                    "Unsupported room type. room_id=%s room_type=%s", room_id, room_type
-                )
+            if room_type not in target_types:
                 continue
             room_title = room["Title"]
-            yield RoomLight(room_id, room_title)
+
+            # Yield room-level device
+            if room_type == "Lights":
+                yield RoomLight(room_id, room_title)
+            elif room_type == "Ventilation":
+                yield RoomVentilation(room_id, room_title)
+
+            # Yield channel-level devices
             channels_section = room.get("Channel", [])
             channels = (
                 channels_section
@@ -215,14 +259,25 @@ class Bridge:
                 channel_type = channel.get("type", "Default")
                 channel_name = channel["Name"]
                 channel_levels = channel["Levels"]
-                yield ChannelLight(
-                    room_id,
-                    room_title,
-                    channel_id,
-                    channel_type,
-                    channel_name,
-                    channel_levels,
-                )
+
+                if room_type == "Lights":
+                    yield ChannelLight(
+                        room_id,
+                        room_title,
+                        channel_id,
+                        channel_type,
+                        channel_name,
+                        channel_levels,
+                    )
+                elif room_type == "Ventilation":
+                    yield ChannelVentilation(
+                        room_id,
+                        room_title,
+                        channel_id,
+                        channel_type,
+                        channel_name,
+                        channel_levels,
+                    )
 
     async def next_pushed_message(self, dg_listener: DatagramServer) -> Any | None:
         resp = await dg_listener.recv()
@@ -241,7 +296,7 @@ class Bridge:
 
     async def get_cache_state(
         self, cache_type: RequestType = RequestType.SCENE_LEVEL_CACHE
-    ) -> Tuple[LevelCache, SceneCache]:
+    ) -> tuple[LevelCache, SceneCache]:
         scene_cache = SceneCache()
         level_cache = LevelCache()
         async with get_dg_commander(self.host, self.port) as dg_client:

{python_rako_2025-0.0.1 → python_rako_2025-0.2.0}/python_rako/helpers.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
 import logging
+from collections.abc import AsyncIterator
 from contextlib import asynccontextmanager
-from typing import AsyncIterator
 
 import asyncio_dgram
 from asyncio_dgram.aio import DatagramClient, DatagramServer

{python_rako_2025-0.0.1 → python_rako_2025-0.2.0}/python_rako/model.py

@@ -1,5 +1,5 @@
+from collections.abc import Iterable
 from dataclasses import dataclass
-from typing import Iterable
 
 from python_rako.const import CommandType, MessageType
 
@@ -33,6 +33,29 @@ class ChannelLight(Light):
     channel_levels: str
 
 
+@dataclass
+class Ventilation:
+    room_id: int
+    room_title: str
+    channel_id: int
+
+    @property
+    def room_channel(self) -> RoomChannel:
+        return RoomChannel(self.room_id, self.channel_id)
+
+
+@dataclass
+class RoomVentilation(Ventilation):
+    channel_id: int = 0
+
+
+@dataclass
+class ChannelVentilation(Ventilation):
+    channel_type: str
+    channel_name: str
+    channel_levels: str
+
+
 @dataclass(frozen=True)
 class BridgeInfo:
     version: str

{python_rako_2025-0.0.1 → python_rako_2025-0.2.0/python_rako_2025.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-rako-2025
-Version: 0.0.1
+Version: 0.2.0
 Summary: Asynchronous Python client for Rako Controls Lighting
 Home-page: https://github.com/simonleigh/python-rako
 Author: Simon Leigh

{python_rako_2025-0.0.1 → python_rako_2025-0.2.0}/setup.py

@@ -1,18 +1,21 @@
 import os
+
 from setuptools import find_packages, setup
 
+
 def read(*parts):
     """Read file."""
     filename = os.path.join(os.path.abspath(os.path.dirname(__file__)), *parts)
-    with open(filename, encoding="utf-8", mode="rt") as fp:
+    with open(filename, encoding="utf-8") as fp:
         return fp.read()
 
+
 with open("README.md") as readme_file:
     readme = readme_file.read()
 
 setup(
     name="python-rako-2025",
-    version="0.0.1",
+    version="0.2.0",
     license="MIT",
     url="https://github.com/simonleigh/python-rako",
     author="Simon Leigh",
@@ -49,4 +52,4 @@ setup(
         "Development Status :: 4 - Beta",
     ],
     python_requires=">=3.10",
-)
+)

python_rako_2025-0.2.0/tests/test_bridge.py

@@ -0,0 +1,225 @@
+from python_rako.bridge import Bridge
+from python_rako.model import (
+    BridgeInfo,
+    ChannelLight,
+    ChannelVentilation,
+    RoomLight,
+    RoomVentilation,
+)
+
+
+def test_get_lights_from_discovery_xml(rako_xml):
+    lights = Bridge.get_lights_from_discovery_xml(rako_xml)
+
+    expected_lights = [
+        RoomLight(room_id=5, room_title="Living Room", channel_id=0),
+        ChannelLight(
+            room_id=5,
+            room_title="Living Room",
+            channel_id=1,
+            channel_type="Default",
+            channel_name="Downlights",
+            channel_levels="FF347F3F000000000000000000000000",
+        ),
+        ChannelLight(
+            room_id=5,
+            room_title="Living Room",
+            channel_id=2,
+            channel_type="Default",
+            channel_name="Kitchen Downlights",
+            channel_levels="FF337F3F000000000000000000000000",
+        ),
+        RoomLight(room_id=9, room_title="Bedroom 1", channel_id=0),
+        ChannelLight(
+            room_id=9,
+            room_title="Bedroom 1",
+            channel_id=1,
+            channel_type="Default",
+            channel_name="Downlights",
+            channel_levels="FFBF7F25000000000000000000000000",
+        ),
+        ChannelLight(
+            room_id=9,
+            room_title="Bedroom 1",
+            channel_id=2,
+            channel_type="Default",
+            channel_name="LED",
+            channel_levels="FFBF7F00000000000000000000000000",
+        ),
+    ]
+    assert list(lights) == expected_lights
+
+
+def test_get_bridge_info_from_discovery_xml(rako_xml):
+    info = Bridge.get_bridge_info_from_discovery_xml(rako_xml)
+
+    expected_info = BridgeInfo(
+        version="2.4.0 RA",
+        buildDate="Nov 17 2017 10:01:01",
+        hostName="RAKOBRIDGE",
+        hostIP="someip",
+        hostMAC="somemac",
+        hwStatus="05",
+        dbVersion="-31",
+        requirepassword=None,
+        passhash="NAN",
+        charset="UTF-8",
+    )
+    assert info == expected_info
+
+
+def test_get_bridge_info_from_discovery_xml2(rako_xml2):
+    info = Bridge.get_bridge_info_from_discovery_xml(rako_xml2)
+
+    expected_info = BridgeInfo(
+        version=None,
+        buildDate=None,
+        hostName=None,
+        hostIP=None,
+        hostMAC=None,
+        hwStatus=None,
+        dbVersion=None,
+        requirepassword=None,
+        passhash="NAN",
+        charset=None,
+    )
+    assert info == expected_info
+
+
+def test_get_lights_from_discovery_xml2(rako_xml2):
+    lights = Bridge.get_lights_from_discovery_xml(rako_xml2)
+
+    expected_lights = [
+        RoomLight(room_id=112, room_title="Bedroom 1", channel_id=0),
+        ChannelLight(
+            room_id=112,
+            room_title="Bedroom 1",
+            channel_id=1,
+            channel_type="Default",
+            channel_name="Ceiling Light",
+            channel_levels="FFBF7F3F000000000000000000000000",
+        ),
+        RoomLight(room_id=108, room_title="Master Ensuite", channel_id=0),
+    ]
+
+    assert list(lights) == expected_lights
+
+
+def test_get_ventilation_from_discovery_xml(rako_xml3):
+    ventilation_devices = Bridge.get_devices_from_discovery_xml(
+        rako_xml3, "Ventilation"
+    )
+
+    expected_ventilation = [
+        RoomVentilation(room_id=161, room_title="Fans", channel_id=0),
+        ChannelVentilation(
+            room_id=161,
+            room_title="Fans",
+            channel_id=1,
+            channel_type="switch",
+            channel_name="Fans",
+            channel_levels="FFBF7F3F000000000000000000000000",
+        ),
+    ]
+
+    ventilation_list = [
+        dev
+        for dev in ventilation_devices
+        if isinstance(dev, (RoomVentilation, ChannelVentilation))
+    ]
+    assert ventilation_list == expected_ventilation
+
+
+def test_ventilation_command_compatibility():
+    """Test that ventilation can use the same commands as lighting"""
+    from python_rako.model import CommandLevelHTTP, CommandSceneHTTP
+
+    # Test that ventilation room can use lighting commands
+    room_scene_command = CommandSceneHTTP(room=161, channel=0, scene=1)
+    assert room_scene_command.as_params() == {"room": 161, "ch": 0, "sc": 1}
+
+    # Test that ventilation channel can use lighting level commands
+    channel_level_command = CommandLevelHTTP(room=161, channel=1, level=128)
+    assert channel_level_command.as_params() == {"room": 161, "ch": 1, "lev": 128}
+
+
+def test_get_all_devices_from_discovery_xml(rako_xml3):
+    """Test discovering all device types from XML"""
+    all_devices = list(Bridge.get_all_devices_from_discovery_xml(rako_xml3))
+
+    # Should contain both lights and ventilation
+    lights = [dev for dev in all_devices if isinstance(dev, (RoomLight, ChannelLight))]
+    ventilation = [
+        dev
+        for dev in all_devices
+        if isinstance(dev, (RoomVentilation, ChannelVentilation))
+    ]
+
+    # Should have many lights and 2 ventilation devices
+    assert len(lights) > 10  # rako3.xml has many light rooms
+    assert len(ventilation) == 2  # 1 RoomVentilation + 1 ChannelVentilation
+
+    # Check specific ventilation devices are included
+    ventilation_room = next(
+        (dev for dev in ventilation if isinstance(dev, RoomVentilation)), None
+    )
+    assert ventilation_room is not None
+    assert ventilation_room.room_id == 161
+    assert ventilation_room.room_title == "Fans"
+
+
+def test_get_devices_with_specific_types(rako_xml3):
+    """Test discovering specific device types using list parameter"""
+    # Test with list of device types
+    lights_only = list(Bridge.get_devices_from_discovery_xml(rako_xml3, ["Lights"]))
+    ventilation_only = list(
+        Bridge.get_devices_from_discovery_xml(rako_xml3, ["Ventilation"])
+    )
+    both_types = list(
+        Bridge.get_devices_from_discovery_xml(rako_xml3, ["Lights", "Ventilation"])
+    )
+
+    # Verify filtering works correctly
+    assert all(isinstance(dev, (RoomLight, ChannelLight)) for dev in lights_only)
+    assert all(
+        isinstance(dev, (RoomVentilation, ChannelVentilation))
+        for dev in ventilation_only
+    )
+    assert len(both_types) == len(lights_only) + len(ventilation_only)
+
+
+def test_get_devices_backward_compatibility(rako_xml3):
+    """Test that existing string parameter still works"""
+    # Test backward compatibility with string parameter
+    lights_str = list(Bridge.get_devices_from_discovery_xml(rako_xml3, "Lights"))
+    lights_list = list(Bridge.get_devices_from_discovery_xml(rako_xml3, ["Lights"]))
+
+    # Should return the same devices
+    assert lights_str == lights_list
+
+    # Test ventilation backward compatibility
+    ventilation_str = list(
+        Bridge.get_devices_from_discovery_xml(rako_xml3, "Ventilation")
+    )
+    ventilation_list = list(
+        Bridge.get_devices_from_discovery_xml(rako_xml3, ["Ventilation"])
+    )
+
+    assert ventilation_str == ventilation_list
+
+
+def test_get_devices_all_parameter_variants(rako_xml3):
+    """Test different ways to get all devices"""
+    all_devices_none = list(Bridge.get_devices_from_discovery_xml(rako_xml3, None))
+    all_devices_all = list(Bridge.get_devices_from_discovery_xml(rako_xml3, "All"))
+    all_devices_method = list(Bridge.get_all_devices_from_discovery_xml(rako_xml3))
+
+    # All should return the same devices
+    assert all_devices_none == all_devices_all == all_devices_method
+
+    # Should contain both lights and ventilation
+    assert any(isinstance(dev, (RoomLight, ChannelLight)) for dev in all_devices_none)
+    assert any(
+        isinstance(dev, (RoomVentilation, ChannelVentilation))
+        for dev in all_devices_none
+    )

python_rako_2025-0.0.1/tests/test_bridge.py

@@ -1,99 +0,0 @@
-from python_rako.bridge import Bridge
-from python_rako.model import BridgeInfo, ChannelLight, RoomLight
-
-
-def test_get_lights_from_discovery_xml(rako_xml):
-    lights = Bridge.get_lights_from_discovery_xml(rako_xml)
-
-    expected_lights = [
-        RoomLight(room_id=5, room_title="Living Room", channel_id=0),
-        ChannelLight(
-            room_id=5,
-            room_title="Living Room",
-            channel_id=1,
-            channel_type="Default",
-            channel_name="Downlights",
-            channel_levels="FF347F3F000000000000000000000000",
-        ),
-        ChannelLight(
-            room_id=5,
-            room_title="Living Room",
-            channel_id=2,
-            channel_type="Default",
-            channel_name="Kitchen Downlights",
-            channel_levels="FF337F3F000000000000000000000000",
-        ),
-        RoomLight(room_id=9, room_title="Bedroom 1", channel_id=0),
-        ChannelLight(
-            room_id=9,
-            room_title="Bedroom 1",
-            channel_id=1,
-            channel_type="Default",
-            channel_name="Downlights",
-            channel_levels="FFBF7F25000000000000000000000000",
-        ),
-        ChannelLight(
-            room_id=9,
-            room_title="Bedroom 1",
-            channel_id=2,
-            channel_type="Default",
-            channel_name="LED",
-            channel_levels="FFBF7F00000000000000000000000000",
-        ),
-    ]
-    assert list(lights) == expected_lights
-
-
-def test_get_bridge_info_from_discovery_xml(rako_xml):
-    info = Bridge.get_bridge_info_from_discovery_xml(rako_xml)
-
-    expected_info = BridgeInfo(
-        version="2.4.0 RA",
-        buildDate="Nov 17 2017 10:01:01",
-        hostName="RAKOBRIDGE",
-        hostIP="someip",
-        hostMAC="somemac",
-        hwStatus="05",
-        dbVersion="-31",
-        requirepassword=None,
-        passhash="NAN",
-        charset="UTF-8",
-    )
-    assert info == expected_info
-
-
-def test_get_bridge_info_from_discovery_xml2(rako_xml2):
-    info = Bridge.get_bridge_info_from_discovery_xml(rako_xml2)
-
-    expected_info = BridgeInfo(
-        version=None,
-        buildDate=None,
-        hostName=None,
-        hostIP=None,
-        hostMAC=None,
-        hwStatus=None,
-        dbVersion=None,
-        requirepassword=None,
-        passhash="NAN",
-        charset=None,
-    )
-    assert info == expected_info
-
-
-def test_get_lights_from_discovery_xml2(rako_xml2):
-    lights = Bridge.get_lights_from_discovery_xml(rako_xml2)
-
-    expected_lights = [
-        RoomLight(room_id=112, room_title="Bedroom 1", channel_id=0),
-        ChannelLight(
-            room_id=112,
-            room_title="Bedroom 1",
-            channel_id=1,
-            channel_type="Default",
-            channel_name="Ceiling Light",
-            channel_levels="FFBF7F3F000000000000000000000000",
-        ),
-        RoomLight(room_id=108, room_title="Master Ensuite", channel_id=0),
-    ]
-
-    assert list(lights) == expected_lights