Refactor device classes for LCN (home-assistant#156791)

Author: alengwenus

homeassistant/components/lcn/entity.py

@@ -2,6 +2,8 @@
 
 from collections.abc import Callable
 
+from pypck.device import DeviceConnection
+
 from homeassistant.const import CONF_ADDRESS, CONF_DOMAIN, CONF_NAME
 from homeassistant.helpers.device_registry import DeviceInfo
 from homeassistant.helpers.entity import Entity
@@ -10,7 +12,6 @@
 from .const import CONF_DOMAIN_DATA, DOMAIN
 from .helpers import (
     AddressType,
-    DeviceConnectionType,
     InputType,
     LcnConfigEntry,
     generate_unique_id,
@@ -23,7 +24,7 @@ class LcnEntity(Entity):
     """Parent class for all entities associated with the LCN component."""
 
     _attr_has_entity_name = True
-    device_connection: DeviceConnectionType
+    device_connection: DeviceConnection
 
     def __init__(
         self,

homeassistant/components/lcn/helpers.py

@@ -11,6 +11,7 @@
 
 import pypck
 from pypck.connection import PchkConnectionManager
+from pypck.device import DeviceConnection
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import (
@@ -48,7 +49,7 @@ class LcnRuntimeData:
     connection: PchkConnectionManager
     """Connection to PCHK host."""
 
-    device_connections: dict[str, DeviceConnectionType]
+    device_connections: dict[str, DeviceConnection]
     """Logical addresses of devices connected to the host."""
 
     add_entities_callbacks: dict[str, Callable[[Iterable[ConfigType]], None]]
@@ -59,7 +60,6 @@ class LcnRuntimeData:
 type LcnConfigEntry = ConfigEntry[LcnRuntimeData]
 
 type AddressType = tuple[int, int, bool]
-type DeviceConnectionType = pypck.module.ModuleConnection | pypck.module.GroupConnection
 
 type InputType = type[pypck.inputs.Input]
 
@@ -82,11 +82,11 @@ class LcnRuntimeData:
 
 def get_device_connection(
     hass: HomeAssistant, address: AddressType, config_entry: LcnConfigEntry
-) -> DeviceConnectionType:
+) -> DeviceConnection:
     """Return a lcn device_connection."""
     host_connection = config_entry.runtime_data.connection
     addr = pypck.lcn_addr.LcnAddr(*address)
-    return host_connection.get_address_conn(addr)
+    return host_connection.get_device_connection(addr)
 
 
 def get_resource(domain_name: str, domain_data: ConfigType) -> str:
@@ -246,7 +246,7 @@ def register_lcn_address_devices(
 
 
 async def async_update_device_config(
-    device_connection: DeviceConnectionType, device_config: ConfigType
+    device_connection: DeviceConnection, device_config: ConfigType
 ) -> None:
     """Fill missing values in device_config with infos from LCN bus."""
     # fetch serial info if device is module

homeassistant/components/lcn/manifest.json

@@ -9,5 +9,5 @@
   "iot_class": "local_polling",
   "loggers": ["pypck"],
   "quality_scale": "bronze",
-  "requirements": ["pypck==0.9.2", "lcn-frontend==0.2.7"]
+  "requirements": ["pypck==0.9.3", "lcn-frontend==0.2.7"]
 }

homeassistant/components/lcn/services.py

@@ -3,6 +3,7 @@
 from enum import StrEnum, auto
 
 import pypck
+from pypck.device import DeviceConnection
 import voluptuous as vol
 
 from homeassistant.const import (
@@ -48,7 +49,7 @@
     VAR_UNITS,
     VARIABLES,
 )
-from .helpers import DeviceConnectionType, LcnConfigEntry, is_states_string
+from .helpers import LcnConfigEntry, is_states_string
 
 
 class LcnServiceCall:
@@ -65,7 +66,7 @@ def __init__(self, hass: HomeAssistant) -> None:
         """Initialize service call."""
         self.hass = hass
 
-    def get_device_connection(self, service: ServiceCall) -> DeviceConnectionType:
+    def get_device_connection(self, service: ServiceCall) -> DeviceConnection:
         """Get address connection object."""
         entries: list[LcnConfigEntry] = self.hass.config_entries.async_loaded_entries(
             DOMAIN

homeassistant/components/lcn/websocket.py

@@ -7,6 +7,7 @@
 from typing import Any, Final
 
 import lcn_frontend as lcn_panel
+from pypck.device import DeviceConnection
 import voluptuous as vol
 
 from homeassistant.components import panel_custom, websocket_api
@@ -37,7 +38,6 @@
     DOMAIN,
 )
 from .helpers import (
-    DeviceConnectionType,
     LcnConfigEntry,
     async_update_device_config,
     generate_unique_id,
@@ -182,7 +182,7 @@ async def websocket_scan_devices(
     host_connection = config_entry.runtime_data.connection
     await host_connection.scan_modules()
 
-    for device_connection in host_connection.address_conns.values():
+    for device_connection in host_connection.device_connections.values():
         if not device_connection.is_group:
             await async_create_or_update_device_in_config_entry(
                 hass, device_connection, config_entry
@@ -421,7 +421,7 @@ async def websocket_delete_entity(
 
 async def async_create_or_update_device_in_config_entry(
     hass: HomeAssistant,
-    device_connection: DeviceConnectionType,
+    device_connection: DeviceConnection,
     config_entry: LcnConfigEntry,
 ) -> None:
     """Create or update device in config_entry according to given device_connection."""

requirements_all.txt

@@ -6,7 +6,7 @@
 
 import pypck
 from pypck import lcn_defs
-from pypck.module import GroupConnection, ModuleConnection, Serials
+from pypck.device import DeviceConnection, Serials
 import pytest
 
 from homeassistant.components.lcn import PchkConnectionManager
@@ -22,7 +22,7 @@
 LATEST_CONFIG_ENTRY_VERSION = (LcnFlowHandler.VERSION, LcnFlowHandler.MINOR_VERSION)
 
 
-class MockModuleConnection(ModuleConnection):
+class MockDeviceConnection(DeviceConnection):
     """Fake a LCN module connection."""
 
     request_name = AsyncMock(return_value="TestModule")
@@ -49,12 +49,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         self._serials_known.set()
 
 
-class MockGroupConnection(GroupConnection):
-    """Fake a LCN group connection."""
-
-    send_command = AsyncMock(return_value=True)
-
-
 class MockPchkConnectionManager(PchkConnectionManager):
     """Fake connection handler."""
 
@@ -67,15 +61,10 @@ async def async_connect(self, timeout: int = 30) -> None:
     async def async_close(self) -> None:
         """Mock closing a connection to PCHK."""
 
-    @patch.object(pypck.connection, "ModuleConnection", MockModuleConnection)
-    def get_module_conn(self, addr):
-        """Get LCN module connection."""
-        return super().get_module_conn(addr)
-
-    @patch.object(pypck.connection, "GroupConnection", MockGroupConnection)
-    def get_group_conn(self, addr):
-        """Get LCN group connection."""
-        return super().get_group_conn(addr)
+    @patch.object(pypck.connection, "DeviceConnection", MockDeviceConnection)
+    def get_device_connection(self, addr):
+        """Get LCN device connection."""
+        return super().get_device_connection(addr)
 
     scan_modules = AsyncMock()
     send_command = AsyncMock()

requirements_test_all.txt

@@ -29,7 +29,7 @@
 from homeassistant.exceptions import ServiceValidationError
 from homeassistant.helpers import entity_registry as er
 
-from .conftest import MockConfigEntry, MockModuleConnection, init_integration
+from .conftest import MockConfigEntry, MockDeviceConnection, init_integration
 
 from tests.common import snapshot_platform
 
@@ -51,7 +51,7 @@ async def test_set_hvac_mode_heat(hass: HomeAssistant, entry: MockConfigEntry) -
     """Test the hvac mode is set to heat."""
     await init_integration(hass, entry)
 
-    with patch.object(MockModuleConnection, "lock_regulator") as lock_regulator:
+    with patch.object(MockDeviceConnection, "lock_regulator") as lock_regulator:
         await hass.services.async_call(
             DOMAIN_CLIMATE,
             SERVICE_SET_HVAC_MODE,
@@ -106,7 +106,7 @@ async def test_set_hvac_mode_off(hass: HomeAssistant, entry: MockConfigEntry) ->
     """Test the hvac mode is set off."""
     await init_integration(hass, entry)
 
-    with patch.object(MockModuleConnection, "lock_regulator") as lock_regulator:
+    with patch.object(MockDeviceConnection, "lock_regulator") as lock_regulator:
         state = hass.states.get("climate.testmodule_climate1")
         state.state = HVACMode.HEAT
 
@@ -154,7 +154,7 @@ async def test_set_temperature(hass: HomeAssistant, entry: MockConfigEntry) -> N
     """Test the temperature is set."""
     await init_integration(hass, entry)
 
-    with patch.object(MockModuleConnection, "var_abs") as var_abs:
+    with patch.object(MockDeviceConnection, "var_abs") as var_abs:
         state = hass.states.get("climate.testmodule_climate1")
         state.state = HVACMode.HEAT
 

tests/components/lcn/conftest.py

@@ -32,7 +32,7 @@
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers import entity_registry as er
 
-from .conftest import MockConfigEntry, MockModuleConnection, init_integration
+from .conftest import MockConfigEntry, MockDeviceConnection, init_integration
 
 from tests.common import snapshot_platform
 
@@ -60,7 +60,7 @@ async def test_outputs_open(hass: HomeAssistant, entry: MockConfigEntry) -> None
     await init_integration(hass, entry)
 
     with patch.object(
-        MockModuleConnection, "control_motor_outputs"
+        MockDeviceConnection, "control_motor_outputs"
     ) as control_motor_outputs:
         state = hass.states.get(COVER_OUTPUTS)
         assert state is not None
@@ -109,7 +109,7 @@ async def test_outputs_close(hass: HomeAssistant, entry: MockConfigEntry) -> Non
     await init_integration(hass, entry)
 
     with patch.object(
-        MockModuleConnection, "control_motor_outputs"
+        MockDeviceConnection, "control_motor_outputs"
     ) as control_motor_outputs:
         await hass.services.async_call(
             DOMAIN_COVER,
@@ -161,7 +161,7 @@ async def test_outputs_stop(hass: HomeAssistant, entry: MockConfigEntry) -> None
     await init_integration(hass, entry)
 
     with patch.object(
-        MockModuleConnection, "control_motor_outputs"
+        MockDeviceConnection, "control_motor_outputs"
     ) as control_motor_outputs:
         await hass.services.async_call(
             DOMAIN_COVER,
@@ -209,7 +209,7 @@ async def test_relays_open(hass: HomeAssistant, entry: MockConfigEntry) -> None:
     await init_integration(hass, entry)
 
     with patch.object(
-        MockModuleConnection, "control_motor_relays"
+        MockDeviceConnection, "control_motor_relays"
     ) as control_motor_relays:
         state = hass.states.get(COVER_RELAYS)
         assert state is not None
@@ -258,7 +258,7 @@ async def test_relays_close(hass: HomeAssistant, entry: MockConfigEntry) -> None
     await init_integration(hass, entry)
 
     with patch.object(
-        MockModuleConnection, "control_motor_relays"
+        MockDeviceConnection, "control_motor_relays"
     ) as control_motor_relays:
         await hass.services.async_call(
             DOMAIN_COVER,
@@ -310,7 +310,7 @@ async def test_relays_stop(hass: HomeAssistant, entry: MockConfigEntry) -> None:
     await init_integration(hass, entry)
 
     with patch.object(
-        MockModuleConnection, "control_motor_relays"
+        MockDeviceConnection, "control_motor_relays"
     ) as control_motor_relays:
         await hass.services.async_call(
             DOMAIN_COVER,
@@ -375,7 +375,7 @@ async def test_relays_set_position(
     await init_integration(hass, entry)
 
     with patch.object(
-        MockModuleConnection, "control_motor_relays_position"
+        MockDeviceConnection, "control_motor_relays_position"
     ) as control_motor_relays_position:
         state = hass.states.get(entity_id)
         assert state is not None