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

ramses_rf/discovery.py

@@ -1,398 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-#
-"""RAMSES RF - discovery scripts."""
-from __future__ import annotations
-
-import asyncio
-import json
-import logging
-import re
-
-from .const import SZ_SCHEDULE, SZ_ZONE_IDX, __dev_mode__
-from .protocol import CODES_SCHEMA, Command, ExpiredCallbackError, Priority
-from .protocol.command import _mk_cmd
-from .protocol.const import SZ_DISABLE_BACKOFF, SZ_PRIORITY, SZ_RETRIES
-from .protocol.opentherm import OTB_MSG_IDS
-
-# Beware, none of this is reliable - it is all subject to random change
-# However, these serve as examples how to us eteh other modules
-
-
-# skipcq: PY-W2000
-from .protocol import (  # noqa: F401, isort: skip, pylint: disable=unused-import
-    I_,
-    RP,
-    RQ,
-    W_,
-    Code,
-)
-
-
-EXEC_CMD = "exec_cmd"
-GET_FAULTS = "get_faults"
-GET_SCHED = "get_schedule"
-SET_SCHED = "set_schedule"
-
-EXEC_SCR = "exec_scr"
-SCAN_DISC = "scan_disc"
-SCAN_FULL = "scan_full"
-SCAN_HARD = "scan_hard"
-SCAN_XXXX = "scan_xxxx"
-
-# DEVICE_ID_REGEX = re.compile(DEVICE_ID_REGEX.ANY)
-
-QOS_SCAN = {SZ_PRIORITY: Priority.LOW, SZ_RETRIES: 0}
-QOS_HIGH = {SZ_PRIORITY: Priority.HIGH, SZ_RETRIES: 3}
-
-DEV_MODE = __dev_mode__ and False
-
-_LOGGER = logging.getLogger(__name__)
-if DEV_MODE:
-    _LOGGER.setLevel(logging.DEBUG)
-
-
-def script_decorator(fnc):
-    def wrapper(gwy, *args, **kwargs):
-
-        highest = {
-            SZ_PRIORITY: Priority.HIGHEST,
-            SZ_RETRIES: 3,
-            SZ_DISABLE_BACKOFF: True,
-        }
-        gwy.send_cmd(Command._puzzle(message="Script begins:", qos=highest))
-
-        result = fnc(gwy, *args, **kwargs)
-
-        lowest = {SZ_PRIORITY: Priority.LOWEST, SZ_RETRIES: 3, SZ_DISABLE_BACKOFF: True}
-        gwy.send_cmd(Command._puzzle(message="Script done.", qos=lowest))
-
-        return result
-
-    return wrapper
-
-
-async def periodic(gwy, cmd, count=1, interval=None):
-    async def _periodic():
-        await asyncio.sleep(interval)
-        gwy.send_cmd(cmd)
-
-    if interval is None:
-        interval = 0 if count == 1 else 60
-
-    if count <= 0:
-        while True:
-            await _periodic()
-    else:
-        for _ in range(count):
-            await _periodic()
-
-
-def spawn_scripts(gwy, **kwargs) -> list[asyncio.Task]:
-
-    tasks = []
-
-    if kwargs.get(EXEC_CMD):
-        tasks += [gwy._loop.create_task(exec_cmd(gwy, **kwargs))]
-
-    if kwargs.get(GET_FAULTS):
-        tasks += [gwy._loop.create_task(get_faults(gwy, kwargs[GET_FAULTS]))]
-
-    elif kwargs.get(GET_SCHED) and kwargs[GET_SCHED][0]:
-        tasks += [gwy._loop.create_task(get_schedule(gwy, *kwargs[GET_SCHED]))]
-
-    elif kwargs.get(SET_SCHED) and kwargs[SET_SCHED][0]:
-        tasks += [gwy._loop.create_task(set_schedule(gwy, *kwargs[SET_SCHED]))]
-
-    elif kwargs.get(EXEC_SCR):
-        script = SCRIPTS.get(f"{kwargs[EXEC_SCR][0]}")
-        if script is None:
-            _LOGGER.warning(f"Script: {kwargs[EXEC_SCR][0]}() - unknown script")
-        else:
-            _LOGGER.info(f"Script: {kwargs[EXEC_SCR][0]}().- starts...")
-            tasks += [gwy._loop.create_task(script(gwy, kwargs[EXEC_SCR][1]))]
-
-    gwy._tasks.extend(tasks)
-    return tasks
-
-
-async def exec_cmd(gwy, **kwargs):
-
-    await gwy.async_send_cmd(Command.from_cli(kwargs[EXEC_CMD], qos=QOS_HIGH))
-
-
-# @script_decorator
-# async def script_scan_001(gwy, dev_id: str):
-#     _LOGGER.warning("scan_001() invoked - expect a lot of nonsense")
-#     qos = {SZ_PRIORITY: Priority.LOW, SZ_RETRIES: 3}
-#     for idx in range(0x10):
-#         gwy.send_cmd(_mk_cmd(W_, Code._000E, f"{idx:02X}0050", dev_id, qos=qos))
-#         gwy.send_cmd(_mk_cmd(RQ, Code._000E, f"{idx:02X}00C8", dev_id, qos=qos))
-
-# @script_decorator
-# async def script_scan_004(gwy, dev_id: str):
-#     _LOGGER.warning("scan_004() invoked - expect a lot of nonsense")
-#     cmd = Command.get_dhw_mode(dev_id, **QOS_SCAN)
-#     return gwy._loop.create_task(periodic(gwy, cmd, count=0, interval=5))
-
-
-async def get_faults(gwy, ctl_id: str, start=0, limit=0x3F):
-    ctl = gwy.get_device(ctl_id)
-
-    try:
-        await ctl.tcs.get_faultlog(start=start, limit=limit)  # 0418
-    except ExpiredCallbackError as exc:
-        _LOGGER.error("get_faults(): Function timed out: %s", exc)
-
-
-async def get_schedule(gwy, ctl_id: str, zone_idx: str) -> None:
-    zone = gwy.get_device(ctl_id).tcs.get_htg_zone(zone_idx)
-
-    try:
-        await zone.get_schedule()
-    except ExpiredCallbackError as exc:
-        _LOGGER.error("get_schedule(): Function timed out: %s", exc)
-
-
-async def set_schedule(gwy, ctl_id, schedule) -> None:
-    schedule = json.load(schedule)
-    zone_idx = schedule[SZ_ZONE_IDX]
-
-    zone = gwy.get_device(ctl_id).tcs.get_htg_zone(zone_idx)
-
-    try:
-        await zone.set_schedule(schedule[SZ_SCHEDULE])  # 0404
-    except ExpiredCallbackError as exc:
-        _LOGGER.error("set_schedule(): Function timed out: %s", exc)
-
-
-async def script_bind_req(gwy, dev_id: str):
-    gwy.get_device(dev_id)._make_fake(bind=True)
-
-
-async def script_bind_wait(gwy, dev_id: str, code=Code._2309, idx="00"):
-    gwy.get_device(dev_id)._make_fake(bind=True, code=code, idx=idx)
-
-
-def script_poll_device(gwy, dev_id) -> list:
-    _LOGGER.warning("poll_device() invoked...")
-
-    tasks = []
-
-    for code in (Code._0016, Code._1FC9):
-        cmd = _mk_cmd(RQ, code, "00", dev_id, qos=QOS_SCAN)
-        tasks.append(gwy._loop.create_task(periodic(gwy, cmd, count=0)))
-
-    gwy._tasks.extend(tasks)
-    return tasks
-
-
-@script_decorator
-async def script_scan_disc(gwy, dev_id: str):
-    _LOGGER.warning("scan_disc() invoked...")
-
-    await gwy.get_device(dev_id).discover()  # discover_flag=Discover.DEFAULT)
-
-
-@script_decorator
-async def script_scan_full(gwy, dev_id: str):
-    _LOGGER.warning("scan_full() invoked - expect a lot of Warnings")
-
-    qos = {SZ_PRIORITY: Priority.DEFAULT, SZ_RETRIES: 5}
-    gwy.send_cmd(_mk_cmd(RQ, Code._0016, "0000", dev_id, qos=qos))
-
-    qos = {SZ_PRIORITY: Priority.DEFAULT, SZ_RETRIES: 1}
-    for code in sorted(CODES_SCHEMA):
-        if code == Code._0005:
-            for zone_type in range(20):  # known up to 18
-                gwy.send_cmd(_mk_cmd(RQ, code, f"00{zone_type:02X}", dev_id, qos=qos))
-
-        elif code == Code._000C:
-            for zone_idx in range(16):  # also: FA-FF?
-                gwy.send_cmd(_mk_cmd(RQ, code, f"{zone_idx:02X}00", dev_id, qos=qos))
-
-        elif code == Code._0016:
-            continue
-
-        elif code in (Code._01D0, Code._01E9):
-            for zone_idx in ("00", "01", "FC"):  # type: ignore[assignment]
-                gwy.send_cmd(_mk_cmd(W_, code, f"{zone_idx}00", dev_id, qos=qos))
-                gwy.send_cmd(_mk_cmd(W_, code, f"{zone_idx}03", dev_id, qos=qos))
-
-        elif code == Code._0404:  # FIXME
-            gwy.send_cmd(Command.get_schedule_fragment(dev_id, "HW", 1, 0, qos=qos))
-            gwy.send_cmd(Command.get_schedule_fragment(dev_id, "00", 1, 0, qos=qos))
-
-        elif code == Code._0418:
-            for log_idx in range(2):
-                gwy.send_cmd(Command.get_system_log_entry(dev_id, log_idx, qos=qos))
-
-        elif code == Code._1100:
-            gwy.send_cmd(Command.get_tpi_params(dev_id, qos=qos))
-
-        elif code == Code._2E04:
-            gwy.send_cmd(Command.get_system_mode(dev_id, qos=qos))
-
-        elif code == Code._3220:
-            for data_id in (0, 3):  # these are mandatory READ_DATA data_ids
-                gwy.send_cmd(Command.get_opentherm_data(dev_id, data_id, qos=qos))
-
-        elif code == Code._PUZZ:
-            continue
-
-        elif (
-            code in CODES_SCHEMA
-            and RQ in CODES_SCHEMA[code]
-            and re.match(CODES_SCHEMA[code][RQ], "00")
-        ):
-            gwy.send_cmd(_mk_cmd(RQ, code, "00", dev_id, qos=qos))
-
-        else:
-            gwy.send_cmd(_mk_cmd(RQ, code, "0000", dev_id, qos=qos))
-
-    # these are possible/difficult codes
-    qos = {SZ_PRIORITY: Priority.DEFAULT, SZ_RETRIES: 2}
-    for code in (Code._0150, Code._2389):
-        gwy.send_cmd(_mk_cmd(RQ, code, "0000", dev_id, qos=qos))
-
-
-@script_decorator
-async def script_scan_hard(gwy, dev_id: str, *, start_code: int = None):
-    _LOGGER.warning("scan_hard() invoked - expect some Warnings")
-
-    start_code = start_code or 0
-
-    for code in range(start_code, 0x5000):
-        gwy.send_cmd(_mk_cmd(RQ, f"{code:04X}", "0000", dev_id, qos=QOS_SCAN))
-        await asyncio.sleep(0.2)
-
-
-@script_decorator
-async def script_scan_fan(gwy, dev_id: str):
-    _LOGGER.warning("scan_fan() invoked - expect a lot of nonsense")
-    qos = {SZ_PRIORITY: Priority.LOW, SZ_RETRIES: 3}
-
-    from ramses_rf.protocol.ramses import _DEV_KLASSES_HVAC
-
-    OUT_CODES = (
-        Code._0016,
-        Code._1470,
-    )
-
-    OLD_CODES = dict.fromkeys(
-        c for k in _DEV_KLASSES_HVAC.values() for c in k if c not in OUT_CODES
-    )
-    for code in OLD_CODES:
-        gwy.send_cmd(_mk_cmd(RQ, code, "00", dev_id, qos=qos))
-
-    NEW_CODES = (
-        Code._0150,
-        Code._042F,
-        Code._1030,
-        Code._10D0,
-        Code._10E1,
-        Code._2210,
-        Code._22B0,
-        Code._22E0,
-        Code._22E5,
-        Code._22E9,
-        Code._22F1,
-        Code._22F2,
-        Code._22F3,
-        Code._22F4,
-        Code._22F7,
-        Code._22F8,
-        Code._2400,
-        Code._2410,
-        Code._2420,
-        Code._313E,
-        Code._3221,
-        Code._3222,
-    )
-
-    for code in NEW_CODES:
-        if code not in OLD_CODES and code not in OUT_CODES:
-            gwy.send_cmd(_mk_cmd(RQ, code, "00", dev_id, qos=qos))
-
-
-@script_decorator
-async def script_scan_otb(gwy, dev_id: str):
-    _LOGGER.warning("script_scan_otb_full invoked - expect a lot of nonsense")
-
-    qos = {SZ_PRIORITY: Priority.LOW, SZ_RETRIES: 1}
-    for msg_id in OTB_MSG_IDS:
-        gwy.send_cmd(Command.get_opentherm_data(dev_id, msg_id, qos=qos))
-
-
-@script_decorator
-async def script_scan_otb_hard(gwy, dev_id: str):
-    _LOGGER.warning("script_scan_otb_hard invoked - expect a lot of nonsense")
-
-    for msg_id in range(0x80):
-        gwy.send_cmd(Command.get_opentherm_data(dev_id, msg_id, qos=QOS_SCAN))
-
-
-@script_decorator
-async def script_scan_otb_map(gwy, dev_id: str):  # Tested only upon a R8820A
-    _LOGGER.warning("script_scan_otb_map invoked - expect a lot of nonsense")
-
-    RAMSES_TO_OPENTHERM = {
-        Code._22D9: "01",  # boiler setpoint        / ControlSetpoint
-        Code._3EF1: "11",  # rel. modulation level  / RelativeModulationLevel
-        Code._1300: "12",  # cv water pressure      / CHWaterPressure
-        Code._12F0: "13",  # dhw_flow_rate          / DHWFlowRate
-        Code._3200: "19",  # boiler output temp     / BoilerWaterTemperature
-        Code._1260: "1A",  # dhw temp               / DHWTemperature
-        Code._1290: "1B",  # outdoor temp           / OutsideTemperature
-        Code._3210: "1C",  # boiler return temp     / ReturnWaterTemperature
-        Code._10A0: "38",  # dhw params[SZ_SETPOINT] / DHWSetpoint
-        Code._1081: "39",  # max ch setpoint        / MaxCHWaterSetpoint
-    }
-
-    for code, msg_id in RAMSES_TO_OPENTHERM.items():
-        gwy.send_cmd(_mk_cmd(RQ, code, "00", dev_id, qos=QOS_SCAN))
-        gwy.send_cmd(Command.get_opentherm_data(dev_id, msg_id, qos=QOS_SCAN))
-
-
-@script_decorator
-async def script_scan_otb_ramses(gwy, dev_id: str):  # Tested only upon a R8820A
-    _LOGGER.warning("script_scan_otb_ramses invoked - expect a lot of nonsense")
-
-    CODES = (
-        Code._042F,
-        Code._10E0,  # device_info
-        Code._10E1,  # device_id
-        Code._1FD0,
-        Code._2400,
-        Code._2401,
-        Code._2410,
-        Code._2420,
-        Code._1300,  # cv water pressure      / CHWaterPressure
-        Code._1081,  # max ch setpoint        / MaxCHWaterSetpoint
-        Code._10A0,  # dhw params[SZ_SETPOINT] / DHWSetpoint
-        Code._22D9,  # boiler setpoint        / ControlSetpoint
-        Code._1260,  # dhw temp               / DHWTemperature
-        Code._1290,  # outdoor temp           / OutsideTemperature
-        Code._3200,  # boiler output temp     / BoilerWaterTemperature
-        Code._3210,  # boiler return temp     / ReturnWaterTemperature
-        Code._0150,
-        Code._12F0,  # dhw flow rate          / DHWFlowRate
-        Code._1098,
-        Code._10B0,
-        Code._3221,
-        Code._3223,
-        Code._3EF0,  # rel. modulation level  / RelativeModulationLevel (also, below)
-        Code._3EF1,  # rel. modulation level  / RelativeModulationLevel
-    )  # excl. 3220
-
-    # 3EF0 also includes:
-    #  - boiler status        /
-    #  - ch setpoint          /
-    #  - max. rel. modulation /
-
-    [gwy.send_cmd(_mk_cmd(RQ, c, "00", dev_id, qos=QOS_SCAN)) for c in CODES]
-
-
-SCRIPTS = {
-    k[7:]: v for k, v in locals().items() if callable(v) and k.startswith("script_")
-}

ramses_rf/protocol/__init__.py

@@ -1,59 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-#
-"""RAMSES RF - a RAMSES-II protocol decoder & analyser."""
-from __future__ import annotations
-
-from logging import Logger
-
-from .address import Address, is_valid_dev_id
-from .command import CODE_API_MAP, Command, FaultLog, Priority
-from .const import (
-    SZ_DEVICE_ROLE,
-    SZ_DOMAIN_ID,
-    SZ_ZONE_CLASS,
-    SZ_ZONE_IDX,
-    SZ_ZONE_MASK,
-    SZ_ZONE_TYPE,
-    __dev_mode__,
-)
-from .exceptions import (
-    CorruptStateError,
-    ExpiredCallbackError,
-    InvalidAddrSetError,
-    InvalidPacketError,
-)
-from .logger import set_logger_timesource, set_pkt_logging
-from .message import Message
-from .packet import _PKT_LOGGER, Packet
-from .protocol import create_msg_stack
-from .ramses import CODES_BY_DEV_SLUG, CODES_SCHEMA
-from .schemas import SZ_SERIAL_PORT
-from .transport import SZ_POLLER_TASK, create_pkt_stack
-
-# noqa: F401, pylint: disable=unused-import
-
-
-# skipcq: PY-W2000
-from .const import (  # noqa: F401, isort: skip, pylint: disable=unused-import
-    I_,
-    RP,
-    RQ,
-    W_,
-    F9,
-    FA,
-    FC,
-    FF,
-    DEV_ROLE,
-    DEV_ROLE_MAP,
-    DEV_TYPE,
-    DEV_TYPE_MAP,
-    ZON_ROLE,
-    ZON_ROLE_MAP,
-    Code,
-)
-
-
-def set_pkt_logging_config(**config) -> Logger:
-    set_pkt_logging(_PKT_LOGGER, **config)
-    return _PKT_LOGGER

ramses_rf/protocol/backports.py

@@ -1,42 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-#
-"""RAMSES RF - a RAMSES-II protocol decoder & analyser.
-
-Enum backports from standard lib. Taken (with thanks) from
-https://github.com/home-assistant/core/homeassistant/backports
-"""
-from __future__ import annotations
-
-from enum import Enum
-from typing import Any, TypeVar
-
-_StrEnumT = TypeVar("_StrEnumT", bound="StrEnum")
-
-
-class StrEnum(str, Enum):
-    """Partial backport of Python 3.11's StrEnum for our basic use cases."""
-
-    def __new__(
-        cls: type[_StrEnumT], value: str, *args: Any, **kwargs: Any
-    ) -> _StrEnumT:
-        """Create a new StrEnum instance."""
-        if not isinstance(value, str):
-            raise TypeError(f"{value!r} is not a string")
-        return super().__new__(cls, value, *args, **kwargs)
-
-    def __str__(self) -> str:
-        """Return self.value."""
-        return str(self.value)
-
-    @staticmethod
-    def _generate_next_value_(
-        name: str, start: int, count: int, last_values: list[Any]
-    ) -> Any:
-        """
-        Make `auto()` explicitly unsupported.
-
-        We may revisit this when it's very clear that Python 3.11's
-        `StrEnum.auto()` behavior will no longer change.
-        """
-        raise TypeError("auto() is not supported by this implementation")