ramses-rf 0.22.2__py3-none-any.whl → 0.51.1__py3-none-any.whl

ramses_rf/device/__init__.py

@@ -1,29 +1,17 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-#
-"""RAMSES RF - a RAMSES-II protocol decoder & analyser.
+"""RAMSES RF - Heating devices (e.g. CTL, OTB, BDR, TRV)."""
 
-Heating devices.
-"""
 from __future__ import annotations
 
 import logging
+from typing import TYPE_CHECKING, Any
 
-from ..const import DEV_TYPE_MAP, __dev_mode__
-from ..protocol import Address, Message
-from ..schemas import SZ_CLASS, SZ_FAKED
+from ramses_rf.const import DEV_TYPE_MAP
+from ramses_tx.const import DevType
+from ramses_tx.schemas import SZ_CLASS, SZ_FAKED
 
-# skipcq: PY-W2000
-from ..const import (  # noqa: F401, isort: skip, pylint: disable=unused-import
-    I_,
-    RP,
-    RQ,
-    W_,
-)
-
-# skipcq: PY-W2000
 from .base import (  # noqa: F401, isort: skip, pylint: disable=unused-import
-    BASE_CLASS_BY_SLUG,
+    BASE_CLASS_BY_SLUG as _BASE_CLASS_BY_SLUG,
     Device,
     Fakeable,
     DeviceHeat,
@@ -31,9 +19,9 @@ from .base import (  # noqa: F401, isort: skip, pylint: disable=unused-import
     DeviceHvac,
 )
 
-# skipcq: PY-W2000
+
 from .heat import (  # noqa: F401, isort: skip, pylint: disable=unused-import
-    HEAT_CLASS_BY_SLUG,
+    HEAT_CLASS_BY_SLUG as _HEAT_CLASS_BY_SLUG,
     BdrSwitch,
     Controller,
     DhwSensor,
@@ -47,9 +35,9 @@ from .heat import (  # noqa: F401, isort: skip, pylint: disable=unused-import
     class_dev_heat,
 )
 
-# skipcq: PY-W2000
+
 from .hvac import (  # noqa: F401, isort: skip, pylint: disable=unused-import
-    HVAC_CLASS_BY_SLUG,
+    HVAC_CLASS_BY_SLUG as _HVAC_CLASS_BY_SLUG,
     HvacCarbonDioxideSensor,
     HvacHumiditySensor,
     HvacRemote,
@@ -58,42 +46,82 @@ from .hvac import (  # noqa: F401, isort: skip, pylint: disable=unused-import
     class_dev_hvac,
 )
 
-DEV_MODE = __dev_mode__  # and False
+if TYPE_CHECKING:
+    from ramses_rf import Gateway
+    from ramses_tx import Address, Message
+
+
+__all__ = [
+    # .base
+    "Device",
+    "Fakeable",
+    "DeviceHeat",
+    "HgiGateway",
+    "DeviceHvac",
+    # .heat
+    "BdrSwitch",
+    "Controller",
+    "DhwSensor",
+    "OtbGateway",
+    "OutSensor",
+    "Temperature",
+    "Thermostat",
+    "TrvActuator",
+    "UfhCircuit",
+    "UfhController",
+    "class_dev_heat",
+    # .hvac
+    "HvacCarbonDioxideSensor",
+    "HvacHumiditySensor",
+    "HvacRemote",
+    "HvacVentilator",
+    "RfsGateway",
+    "class_dev_hvac",
+    #
+    "best_dev_role",
+    "device_factory",
+]
 
 _LOGGER = logging.getLogger(__name__)
-if DEV_MODE:
-    _LOGGER.setLevel(logging.DEBUG)
 
 
-_CLASS_BY_SLUG = BASE_CLASS_BY_SLUG | HEAT_CLASS_BY_SLUG | HVAC_CLASS_BY_SLUG
+_CLASS_BY_SLUG = _BASE_CLASS_BY_SLUG | _HEAT_CLASS_BY_SLUG | _HVAC_CLASS_BY_SLUG
+
+HEAT_DEV_CLASS_BY_SLUG = {
+    k: v for k, v in _HEAT_CLASS_BY_SLUG.items() if k is not DevType.HEA
+}
+HVAC_DEV_CLASS_BY_SLUG = {
+    k: v for k, v in _HVAC_CLASS_BY_SLUG.items() if k is not DevType.HVC
+}
 
 
 def best_dev_role(
     dev_addr: Address,
     *,
-    msg: Message = None,
+    msg: Message | None = None,
     eavesdrop: bool = False,
-    **schema,
+    **schema: Any,
 ) -> type[Device]:
     """Return the best device role (object class) for a given device id/msg/schema.
 
     Heat (CH/DHW) devices can reliably be determined by their address type (e.g. '04:').
     Any device without a known Heat type is considered a HVAC device.
 
-    HVAC devices must be explicity typed, or fingerprinted/eavesdropped.
+    HVAC devices must be explicitly typed, or fingerprinted/eavesdropped.
     The generic HVAC class can be promoted later on, when more information is available.
     """
 
-    cls: None | type[Device] = None
-    slug: None | str = None
+    cls: type[Device]
+    slug: str
 
     try:  # convert (say) 'dhw_sensor' to DHW
-        slug = DEV_TYPE_MAP.slug(schema.get(SZ_CLASS))
+        slug = DEV_TYPE_MAP.slug(schema.get(SZ_CLASS))  # type: ignore[arg-type]
     except KeyError:
         slug = schema.get(SZ_CLASS)
 
-    # a specified device class always takes precidence (even if it is wrong)...
-    if cls := _CLASS_BY_SLUG.get(slug):
+    # a specified device class always takes precedence (even if it is wrong)...
+    if slug in _CLASS_BY_SLUG:
+        cls = _CLASS_BY_SLUG[slug]
         _LOGGER.debug(
             f"Using an explicitly-defined class for: {dev_addr!r} ({cls._SLUG})"
         )
@@ -101,12 +129,12 @@ def best_dev_role(
 
     if dev_addr.type == DEV_TYPE_MAP.HGI:
         _LOGGER.debug(f"Using the default class for: {dev_addr!r} ({HgiGateway._SLUG})")
-        return HgiGateway  # type: ignore[return-value]
+        return HgiGateway
 
     try:  # or, is it a well-known CH/DHW class, derived from the device type...
         if cls := class_dev_heat(dev_addr, msg=msg, eavesdrop=eavesdrop):
             _LOGGER.debug(
-                f"Using the default Heat class for: {dev_addr!r} ({cls._SLUG})"  # type: ignore[attr-defined]
+                f"Using the default Heat class for: {dev_addr!r} ({cls._SLUG})"
             )
             return cls
     except TypeError:
@@ -115,7 +143,7 @@ def best_dev_role(
     try:  # or, a HVAC class, eavesdropped from the message code/payload...
         if cls := class_dev_hvac(dev_addr, msg=msg, eavesdrop=eavesdrop):
             _LOGGER.debug(
-                f"Using eavesdropped HVAC class for: {dev_addr!r} ({cls._SLUG})"  # type: ignore[attr-defined]
+                f"Using eavesdropped HVAC class for: {dev_addr!r} ({cls._SLUG})"
             )
             return cls  # includes DeviceHvac
     except TypeError:
@@ -125,10 +153,12 @@ def best_dev_role(
     _LOGGER.debug(
         f"Using a promotable HVAC class for: {dev_addr!r} ({DeviceHvac._SLUG})"
     )
-    return DeviceHvac  # type: ignore[return-value]
+    return DeviceHvac
 
 
-def device_factory(gwy, dev_addr: Address, *, msg: Message = None, **traits) -> Device:
+def device_factory(
+    gwy: Gateway, dev_addr: Address, *, msg: Message | None = None, **traits: Any
+) -> Device:
     """Return the initial device class for a given device id/msg/traits.
 
     Devices of certain classes are promotable to a compatible sub class.