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

ramses_rf/protocol/const.py

@@ -1,697 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-#
-"""RAMSES RF - a RAMSES-II protocol decoder & analyser."""
-from __future__ import annotations
-
-import re
-from types import SimpleNamespace
-
-from .backports import StrEnum
-
-__dev_mode__ = False
-DEV_MODE = __dev_mode__
-
-# used by tansport QoS...
-SZ_BACKOFF = "backoff"
-SZ_DISABLE_BACKOFF = "disable_backoff"
-SZ_PRIORITY = "priority"
-SZ_QOS = "qos"
-SZ_RETRIES = "retries"
-SZ_TIMEOUT = "timeout"
-
-SZ_CALLBACK = "callback"
-SZ_DAEMON = "daemon"
-SZ_EXPIRED = "expired"
-SZ_EXPIRES = "expires"
-SZ_FUNC = "func"
-SZ_ARGS = "args"
-
-# used by schedule.py...
-SZ_FRAGMENT = "fragment"
-SZ_FRAG_NUMBER = "frag_number"
-SZ_FRAG_LENGTH = "frag_length"
-SZ_TOTAL_FRAGS = "total_frags"
-
-SZ_SCHEDULE = "schedule"
-SZ_CHANGE_COUNTER = "change_counter"
-
-Priority = SimpleNamespace(LOWEST=4, LOW=2, DEFAULT=0, HIGH=-2, HIGHEST=-4)
-
-
-# used by 31DA
-SZ_AIR_QUALITY = "air_quality"
-SZ_AIR_QUALITY_BASE = "air_quality_base"
-SZ_BOOST_TIMER = "boost_timer"
-SZ_BYPASS_POSITION = "bypass_position"
-SZ_CO2_LEVEL = "co2_level"
-SZ_EXHAUST_FAN_SPEED = "exhaust_fan_speed"
-SZ_EXHAUST_FLOW = "exhaust_flow"
-SZ_EXHAUST_TEMPERATURE = "exhaust_temperature"
-SZ_FAN_INFO = "fan_info"
-SZ_FAN_MODE = "fan_mode"
-SZ_FAN_RATE = "fan_rate"
-SZ_INDOOR_HUMIDITY = "indoor_humidity"
-SZ_INDOOR_TEMPERATURE = "indoor_temperature"
-SZ_OUTDOOR_HUMIDITY = "outdoor_humidity"
-SZ_OUTDOOR_TEMPERATURE = "outdoor_temperature"
-SZ_POST_HEAT = "post_heat"
-SZ_PRE_HEAT = "pre_heat"
-SZ_REMAINING_TIME = "remaining_time"
-SZ_SUPPLY_FAN_SPEED = "supply_fan_speed"
-SZ_SUPPLY_FLOW = "supply_flow"
-SZ_SUPPLY_TEMPERATURE = "supply_temperature"
-SZ_SPEED_CAP = "speed_cap"
-
-SZ_PRESENCE_DETECTED = "presence_detected"
-
-
-def slug(string: str) -> str:
-    """Convert a string to snake_case."""
-    return re.sub(r"[\W_]+", "_", string.lower())
-
-
-def _alt_slugify_string(key: str) -> str:
-    """Convert a string to snake_case."""
-    string = re.sub(r"[\-\.\s]", "_", str(key))
-    return (string[0]).lower() + re.sub(
-        r"[A-Z]", lambda matched: f"_{matched.group(0).lower()}", string[1:]  # type: ignore[str-bytes-safe]
-    )
-
-
-class AttrDict(dict):
-    _SZ_AKA_SLUG = "_root_slug"
-    _SZ_DEFAULT = "_default"
-    _SZ_SLUGS = "SLUGS"
-
-    @classmethod
-    def __readonly(cls, *args, **kwargs):
-        raise TypeError(f"'{cls.__class__.__name__}' object is read only")
-
-    __delitem__ = __readonly
-    __setitem__ = __readonly
-    clear = __readonly
-    pop = __readonly  # type:ignore[assignment]
-    popitem = __readonly  # type:ignore[assignment]
-    setdefault = __readonly  # type:ignore[assignment]
-    update = __readonly  # type:ignore[assignment]
-
-    del __readonly
-
-    def __init__(self, main_table, attr_table=None):
-        self._main_table: dict = main_table
-        self._attr_table: dict = attr_table
-        self._attr_table[self._SZ_SLUGS] = tuple(sorted(main_table.keys()))
-
-        self._slug_lookup: dict = {
-            None: slug
-            for slug, table in main_table.items()
-            for k in table.values()
-            if isinstance(k, str) and table.get(self._SZ_DEFAULT)
-        }  # i.e. {None: 'HEA'}
-        self._slug_lookup.update(
-            {
-                k: table.get(self._SZ_AKA_SLUG, slug)
-                for slug, table in main_table.items()
-                for k in table.keys()
-                if isinstance(k, str) and len(k) == 2
-            }  # e.g. {'00': 'TRV', '01': 'CTL', '04': 'TRV', ...}
-        )
-        self._slug_lookup.update(
-            {
-                k: slug
-                for slug, table in main_table.items()
-                for k in table.values()
-                if isinstance(k, str) and table.get(self._SZ_AKA_SLUG) is None
-            }  # e.g. {'heat_device':'HEA', 'dhw_sensor':'DHW', ...}
-        )
-
-        self._forward = {
-            k: v
-            for table in main_table.values()
-            for k, v in table.items()
-            if isinstance(k, str) and k[:1] != "_"
-        }  # e.g. {'00': 'radiator_valve', '01': 'controller', ...}
-        self._reverse = {
-            v: k
-            for table in main_table.values()
-            for k, v in table.items()
-            if isinstance(k, str) and k[:1] != "_" and self._SZ_AKA_SLUG not in table
-        }  # e.g. {'radiator_valve': '00', 'controller': '01', ...}
-        self._forward = dict(sorted(self._forward.items(), key=lambda item: item[0]))
-
-        super().__init__(self._forward)
-
-    def __getitem__(self, key):
-        if key in self._main_table:  # map[ZON_ROLE.DHW] -> "dhw_sensor"
-            return list(self._main_table[key].values())[0]
-        # if key in self._forward:  # map["0D"] -> "dhw_sensor"
-        #     return self._forward.__getitem__(key)
-        if key in self._reverse:  # map["dhw_sensor"] -> "0D"
-            return self._reverse.__getitem__(key)
-        return super().__getitem__(key)
-
-    def __getattr__(self, name):
-        if name in self._main_table:  # map.DHW -> "0D" (using slug)
-            if (result := list(self._main_table[name].keys())[0]) is not None:
-                return result
-        elif name in self._attr_table:  # bespoke attrs
-            return self._attr_table[name]
-        elif len(name) and name[1:] in self._forward:  # map._0D -> "dhw_sensor"
-            return self._forward[name[1:]]
-        elif name.isupper() and name.lower() in self._reverse:  # map.DHW_SENSOR -> "0D"
-            return self[name.lower()]
-        return self.__getattribute__(name)
-
-    def _hex(self, key) -> str:
-        """Return the key/ID (2-byte hex string) of the two-way dict (e.g. '04')."""
-        if key in self._main_table:
-            return list(self._main_table[key].keys())[0]
-        if key in self._reverse:
-            return self._reverse[key]
-        raise KeyError(key)
-
-    def _str(self, key) -> str:
-        """Return the value (string) of the two-way dict (e.g. 'radiator_valve')."""
-        if key in self._main_table:
-            return list(self._main_table[key].values())[0]
-        if key in self:
-            return self[key]
-        raise KeyError(key)
-
-    # def values(self):
-    #     return {k: k for k in super().values()}.values()
-
-    def slug(self, key) -> str:
-        """WIP: Return master slug for a hex key/ID (e.g. 00 -> 'TRV', not 'TR0')."""
-        slug_ = self._slug_lookup[key]
-        # if slug_ in self._attr_table["_TRANSFORMS"]:
-        #     return self._attr_table["_TRANSFORMS"][slug_]
-        return slug_
-
-    def slugs(self) -> tuple:
-        """Return the slugs from the main table."""
-        return self._attr_table[self._SZ_SLUGS]
-
-
-def attr_dict_factory(main_table, attr_table=None) -> AttrDict:  # is: SlottedAttrDict
-    if attr_table is None:
-        attr_table = {}
-
-    class SlottedAttrDict(AttrDict):
-        pass  # TODO: low priority
-        # __slots__ = (
-        #     list(main_table.keys())
-        #     + [
-        #         f"_{k}"
-        #         for t in main_table.values()
-        #         for k in t.keys()
-        #         if isinstance(k, str) and len(k) == 2
-        #     ]
-        #     + [v for t in main_table.values() for v in t.values()]
-        #         + list(attr_table.keys())
-        #         + [AttrDict._SZ_AKA_SLUG, AttrDict._SZ_SLUGS]
-        # )
-
-    return SlottedAttrDict(main_table, attr_table=attr_table)
-
-
-# slugs for device/zone entity klasses, used by 0005/000C
-DEV_ROLE = SimpleNamespace(
-    #
-    # Generic device/zone classes
-    ACT="ACT",  # Generic heating zone actuator group
-    SEN="SEN",  # Generic heating zone sensor group
-    #
-    # Standard device/zone classes
-    ELE="ELE",  # BDRs (no heat demand)
-    MIX="MIX",  # HM8s
-    RAD="RAD",  # TRVs
-    UFH="UFH",  # UFC (circuits)
-    VAL="VAL",  # BDRs
-    #
-    # DHW device/zone classes
-    DHW="DHW",  # DHW sensor (a zone, but not a heating zone)
-    HTG="HTG",  # BDR (DHW relay, HTG relay)
-    HT1="HT1",  # BDR (HTG relay)
-    #
-    # Other device/zone classes
-    OUT="OUT",  # OUT (external weather sensor)
-    RFG="RFG",  # RFG
-    APP="APP",  # BDR/OTB (appliance relay)
-)
-DEV_ROLE_MAP = attr_dict_factory(
-    {
-        DEV_ROLE.ACT: {"00": "zone_actuator"},
-        DEV_ROLE.SEN: {"04": "zone_sensor"},
-        DEV_ROLE.RAD: {"08": "rad_actuator"},
-        DEV_ROLE.UFH: {"09": "ufh_actuator"},
-        DEV_ROLE.VAL: {"0A": "val_actuator"},
-        DEV_ROLE.MIX: {"0B": "mix_actuator"},
-        DEV_ROLE.OUT: {"0C": "out_sensor"},
-        DEV_ROLE.DHW: {"0D": "dhw_sensor"},
-        DEV_ROLE.HTG: {"0E": "hotwater_valve"},  # payload[:4] == 000E
-        DEV_ROLE.HT1: {None: "heating_valve"},  # payload[:4] == 010E
-        DEV_ROLE.APP: {"0F": "appliance_control"},  # the heat/cool source
-        DEV_ROLE.RFG: {"10": "remote_gateway"},
-        DEV_ROLE.ELE: {"11": "ele_actuator"},  # ELE(VAL) - no RP from older evos
-    },  # 03, 05, 06, 07: & >11 - no response from an 01:
-    {
-        "HEAT_DEVICES": ("00", "04", "08", "09", "0A", "0B", "11"),
-        "DHW_DEVICES": ("0D", "0E"),
-        "SENSORS": ("04", "0C", "0D"),
-    },
-)
-
-
-# slugs for device entity types, used in device_ids
-DEV_TYPE = SimpleNamespace(
-    #
-    # Promotable/Generic devices
-    DEV="DEV",  # xx: Promotable device
-    HEA="HEA",  # xx: Promotable Heat device, aka CH/DHW device
-    HVC="HVC",  # xx: Promotable HVAC device
-    THM="THM",  # xx: Generic thermostat
-    #
-    # Heat (CH/DHW) devices
-    BDR="BDR",  # 13: Electrical relay
-    CTL="CTL",  # 01: Controller (zoned)
-    DHW="DHW",  # 07: DHW sensor
-    DTS="DTS",  # 12: Thermostat, DTS92(E)
-    DT2="DT2",  # 22: Thermostat, DTS92(E)
-    HCW="HCW",  # 03: Thermostat - don't use STA
-    HGI="HGI",  # 18: Gateway interface (RF to USB), HGI80
-    # 8="HM8",  # xx: HM80 mixer valve (Rx-only, does not Tx)
-    OTB="OTB",  # 10: OpenTherm bridge
-    OUT="OUT",  # 17: External weather sensor
-    PRG="PRG",  # 23: Programmer
-    RFG="RFG",  # 30: RF gateway (RF to ethernet), RFG100
-    RND="RND",  # 34: Thermostat, TR87RF
-    TRV="TRV",  # 04: Thermostatic radiator valve
-    TR0="TR0",  # 00: Thermostatic radiator valve
-    UFC="UFC",  # 02: UFH controller
-    #
-    # Honeywell Jasper, other Heat devices
-    JIM="JIM",  # 08: Jasper Interface Module (EIM?)
-    JST="JST",  # 31: Jasper Stat
-    #
-    # HVAC devices, these are more like classes (i.e. no reliable device type)
-    RFS="RFS",  # ??: HVAC spIDer gateway
-    FAN="FAN",  # ??: HVAC fan, 31D[9A]: 20|29|30|37 (some, e.g. 29: only 31D9)
-    CO2="CO2",  # ??: HVAC CO2 sensor
-    HUM="HUM",  # ??: HVAC humidity sensor, 1260: 32
-    PIR="PIR",  # ??: HVAC pesence sensor, 2E10
-    REM="REM",  # ??: HVAC switch, 22F[13]: 02|06|20|32|39|42|49|59 (no 20: are both)
-    SW2="SW2",  # ??: HVAC switch, Orcon variant
-    DIS="DIS",  # ??: HVAC switch with display
-)
-DEV_TYPE_MAP = attr_dict_factory(
-    {
-        # Generic devices (would be promoted)
-        DEV_TYPE.DEV: {None: "generic_device"},  # , AttrDict._SZ_DEFAULT: True},
-        DEV_TYPE.HEA: {None: "heat_device"},
-        DEV_TYPE.HVC: {None: "hvac_device"},
-        # HGI80
-        DEV_TYPE.HGI: {"18": "gateway_interface"},  # HGI80
-        # Heat (CH/DHW) devices
-        DEV_TYPE.TR0: {"00": "radiator_valve", AttrDict._SZ_AKA_SLUG: DEV_TYPE.TRV},
-        DEV_TYPE.CTL: {"01": "controller"},
-        DEV_TYPE.UFC: {"02": "ufh_controller"},
-        DEV_TYPE.HCW: {"03": "analog_thermostat"},
-        DEV_TYPE.THM: {None: "thermostat"},
-        DEV_TYPE.TRV: {"04": "radiator_valve"},
-        DEV_TYPE.DHW: {"07": "dhw_sensor"},
-        DEV_TYPE.OTB: {"10": "opentherm_bridge"},
-        DEV_TYPE.DTS: {"12": "digital_thermostat"},
-        DEV_TYPE.BDR: {"13": "electrical_relay"},
-        DEV_TYPE.OUT: {"17": "outdoor_sensor"},
-        DEV_TYPE.DT2: {"22": "digital_thermostat", AttrDict._SZ_AKA_SLUG: DEV_TYPE.DTS},
-        DEV_TYPE.PRG: {"23": "programmer"},
-        DEV_TYPE.RFG: {"30": "rf_gateway"},  # RFG100
-        DEV_TYPE.RND: {"34": "round_thermostat"},
-        # Other (jasper) devices
-        DEV_TYPE.JIM: {"08": "jasper_interface"},
-        DEV_TYPE.JST: {"31": "jasper_thermostat"},
-        # Ventilation devices
-        DEV_TYPE.CO2: {None: "co2_sensor"},
-        DEV_TYPE.DIS: {None: "switch_display"},
-        DEV_TYPE.FAN: {None: "ventilator"},  # Both Fans and HRUs
-        DEV_TYPE.HUM: {None: "rh_sensor"},
-        DEV_TYPE.PIR: {None: "presence_sensor"},
-        DEV_TYPE.RFS: {None: "hvac_gateway"},  # Spider
-        DEV_TYPE.REM: {None: "switch"},
-        DEV_TYPE.SW2: {None: "switch_variant"},
-    },
-    {
-        "HEAT_DEVICES": (
-            "00",
-            "01",
-            "02",
-            "03",
-            "04",
-            "07",
-            "10",
-            "12",
-            "13",
-            "17",
-            "22",
-            "30",
-            "34",
-        ),  # CH/DHW devices instead of HVAC/other
-        "HEAT_ZONE_SENSORS": ("00", "01", "03", "04", "12", "22", "34"),
-        "HEAT_ZONE_ACTUATORS": ("00", "02", "04", "13"),
-        "THM_DEVICES": ("03", "12", "22", "34"),
-        "TRV_DEVICES": ("00", "04"),
-        "CONTROLLERS": ("01", "12", "22", "23", "34"),  # potentially controllers
-        "PROMOTABLE_SLUGS": (DEV_TYPE.DEV, DEV_TYPE.HEA, DEV_TYPE.HVC),
-        "HVAC_SLUGS": {
-            DEV_TYPE.CO2: "co2_sensor",
-            DEV_TYPE.FAN: "ventilator",  # Both Fans and HRUs
-            DEV_TYPE.HUM: "rh_sensor",
-            DEV_TYPE.RFS: "hvac_gateway",  # Spider
-            DEV_TYPE.REM: "switch",
-        },
-    },
-)
-
-# slugs for zone entity klasses, used by 0005/000C
-ZON_ROLE = SimpleNamespace(
-    #
-    # Generic device/zone classes
-    ACT="ACT",  # Generic heating zone actuator group
-    SEN="SEN",  # Generic heating zone sensor group
-    #
-    # Standard device/zone classes
-    ELE="ELE",  # heating zone with BDRs (no heat demand)
-    MIX="MIX",  # heating zone with HM8s
-    RAD="RAD",  # heating zone with TRVs
-    UFH="UFH",  # heating zone with UFC circuits
-    VAL="VAL",  # zheating one with BDRs
-    # Standard device/zone classes *not a heating zone)
-    DHW="DHW",  # DHW zone with BDRs
-)
-ZON_ROLE_MAP = attr_dict_factory(
-    {
-        ZON_ROLE.ACT: {"00": "heating_zone"},  # any actuator
-        ZON_ROLE.SEN: {"04": "heating_zone"},  # any sensor
-        ZON_ROLE.RAD: {"08": "radiator_valve"},  # TRVs
-        ZON_ROLE.UFH: {"09": "underfloor_heating"},  # UFCs
-        ZON_ROLE.VAL: {"0A": "zone_valve"},  # BDRs
-        ZON_ROLE.MIX: {"0B": "mixing_valve"},  # HM8s
-        ZON_ROLE.DHW: {"0D": "stored_hotwater"},  # DHWs
-        # N_CLASS.HTG: {"0E": "stored_hotwater", AttrDict._SZ_AKA_SLUG: ZON_ROLE.DHW},
-        ZON_ROLE.ELE: {"11": "electric_heat"},  # BDRs
-    },
-    {
-        "HEAT_ZONES": ("08", "09", "0A", "0B", "11"),
-    },
-)
-
-# Zone modes
-ZON_MODE_MAP = attr_dict_factory(
-    {
-        "FOLLOW": {"00": "follow_schedule"},
-        "ADVANCED": {"01": "advanced_override"},  # . until the next scheduled setpoint
-        "PERMANENT": {"02": "permanent_override"},  # indefinitely, until auto_reset
-        "COUNTDOWN": {"03": "countdown_override"},  # for x mins (duration, max 1,215?)
-        "TEMPORARY": {"04": "temporary_override"},  # until a given date/time (until)
-    }
-)
-
-# System modes
-SYS_MODE_MAP = attr_dict_factory(
-    {
-        "au_00": {"00": "auto"},  # .          indef (only)
-        "ho_01": {"01": "heat_off"},  # .      indef (only)
-        "eb_02": {"02": "eco_boost"},  # .     indef/<=24h: is either Eco, *or* Boost
-        "aw_03": {"03": "away"},  # .          indef/<=99d (0d = end of today, 00:00)
-        "do_04": {"04": "day_off"},  # .       indef/<=99d: rounded down to 00:00 by CTL
-        "de_05": {"05": "day_off_eco"},  # .   indef/<=99d: set to Eco when DayOff ends
-        "ar_06": {"06": "auto_with_reset"},  # indef (only)
-        "cu_07": {"07": "custom"},  # .        indef/<=99d
-    }
-)
-
-
-SZ_ACTUATOR = "actuator"
-SZ_ACTUATORS = "actuators"
-SZ_BINDINGS = "bindings"
-SZ_DATETIME = "datetime"
-SZ_DEVICE_CLASS = "device_class"  # used in 0418 only?
-SZ_DEVICE_ID = "device_id"
-SZ_DEVICE_ROLE = "device_role"
-SZ_DEVICES = "devices"
-SZ_DHW_IDX = "dhw_idx"
-SZ_DOMAIN_ID = "domain_id"
-SZ_DURATION = "duration"
-SZ_HEAT_DEMAND = "heat_demand"
-SZ_IS_DST = "is_dst"
-SZ_LANGUAGE = "language"
-SZ_LOG_IDX = "log_idx"
-SZ_MODE = "mode"
-SZ_NAME = "name"
-SZ_PAYLOAD = "payload"
-SZ_PRESSURE = "pressure"
-SZ_RELAY_DEMAND = "relay_demand"
-SZ_RELAY_FAILSAFE = "relay_failsafe"
-SZ_SENSOR = "sensor"
-SZ_SETPOINT = "setpoint"
-SZ_SLUG = "_SLUG"
-SZ_SYSTEM_MODE = "system_mode"
-SZ_TEMPERATURE = "temperature"
-SZ_UFH_IDX = "ufh_idx"
-SZ_UNKNOWN = "unknown"
-SZ_UNTIL = "until"
-SZ_VALUE = "value"
-SZ_WINDOW_OPEN = "window_open"
-SZ_ZONE_CLASS = "zone_class"
-SZ_ZONE_IDX = "zone_idx"
-SZ_ZONE_MASK = "zone_mask"
-SZ_ZONE_TYPE = "zone_type"
-SZ_ZONES = "zones"
-
-
-DEFAULT_MAX_ZONES = 16 if DEV_MODE else 12
-# Evohome: 12 (0-11), older/initial version was 8
-# Hometronics: 16 (0-15), or more?
-# Sundial RF2: 2 (0-1), usually only one, but ST9520C can do two zones
-
-
-DEVICE_ID_REGEX = SimpleNamespace(
-    ANY=re.compile(r"^[0-9]{2}:[0-9]{6}$"),
-    BDR=re.compile(r"^13:[0-9]{6}$"),
-    CTL=re.compile(r"^(01|23):[0-9]{6}$"),
-    DHW=re.compile(r"^07:[0-9]{6}$"),
-    HGI=re.compile(r"^18:[0-9]{6}$"),
-    APP=re.compile(r"^(10|13):[0-9]{6}$"),
-    UFC=re.compile(r"^02:[0-9]{6}$"),
-    SEN=re.compile(r"^(01|03|04|12|22|34):[0-9]{6}$"),
-)
-
-# Domains
-F6, F7, F8, F9, FA, FB, FC, FD, FE, FF = (f"{x:02X}" for x in range(0xF6, 0x100))
-
-DOMAIN_TYPE_MAP = {
-    F6: "cooling_valve",  # cooling
-    F7: "domain_f7",
-    F8: "domain_f8",
-    F9: DEV_ROLE_MAP[DEV_ROLE.HT1],  # Heating Valve
-    FA: DEV_ROLE_MAP[DEV_ROLE.HTG],  # HW Valve (or UFH loop if src.type == UFC?)
-    FB: "domain_fb",  # also: cooling valve?
-    FC: DEV_ROLE_MAP[DEV_ROLE.APP],  # appliance_control
-    FD: "domain_fd",  # seen with hometronics
-    # "FE": ???
-    # FF: "system",  # TODO: remove this, is not a domain
-}  # "21": "Ventilation", "88": ???
-DOMAIN_TYPE_LOOKUP = {v: k for k, v in DOMAIN_TYPE_MAP.items() if k != FF}
-
-DHW_STATE_MAP = {"00": "off", "01": "on"}
-DHW_STATE_LOOKUP = {v: k for k, v in DHW_STATE_MAP.items()}
-
-DTM_LONG_REGEX = re.compile(
-    r"\d{4}-[01]\d-[0-3]\d(T| )[0-2]\d:[0-5]\d:[0-5]\d\.\d{6} ?"
-)  # 2020-11-30T13:15:00.123456
-DTM_TIME_REGEX = re.compile(r"[0-2]\d:[0-5]\d:[0-5]\d\.\d{3} ?")  # 13:15:00.123
-
-# Used by packet structure validators
-r = r"(-{3}|\d{3}|\.{3})"  # RSSI, '...' was used by an older version of evofw3
-v = r"( I|RP|RQ| W)"  # verb
-d = r"(-{2}:-{6}|\d{2}:\d{6})"  # device ID
-c = r"[0-9A-F]{4}"  # code
-l = r"\d{3}"  # length # noqa: E741
-p = r"([0-9A-F]{2}){1,48}"  # payload
-
-# DEVICE_ID_REGEX = re.compile(f"^{d}$")
-COMMAND_REGEX = re.compile(f"^{v} {r} {d} {d} {d} {c} {l} {p}$")
-MESSAGE_REGEX = re.compile(f"^{r} {v} {r} {d} {d} {d} {c} {l} {p}$")
-
-
-# Used by 0418/system_fault parser
-FAULT_DEVICE_CLASS = {
-    "00": "controller",
-    "01": "sensor",
-    "02": "setpoint",
-    "04": "actuator",  # if domain is FC, then "boiler_relay"
-    "05": "dhw_sensor",
-    "06": "rf_gateway",
-}
-FAULT_STATE = {
-    "00": "fault",
-    "40": "restore",
-    "C0": "unknown_c0",  # C0s do not appear in the evohome UI
-}
-FAULT_TYPE = {
-    "01": "system_fault",
-    "03": "mains_low",
-    "04": "battery_low",
-    "05": "battery_error",  # actually: 'evotouch_battery_error'
-    "06": "comms_fault",
-    "07": "sensor_fault",  # seen with zone sensor
-    "0A": "sensor_error",
-    "??": "bad_value",
-}
-
-SystemType = SimpleNamespace(
-    CHRONOTHERM="chronotherm",
-    EVOHOME="evohome",
-    HOMETRONICS="hometronics",
-    PROGRAMMER="programmer",
-    SUNDIAL="sundial",
-    GENERIC="generic",
-)
-
-
-# used by 22Fx parser, and FanSwitch devices
-# SZ_BOOST_TIMER = "boost_timer"  # minutes, e.g. 10, 20, 30 minutes
-HEATER_MODE = "heater_mode"  # e.g. auto, off
-FAN_MODE = "fan_mode"  # e.g. low. high
-FAN_RATE = "fan_rate"  # percentage, 0.0 - 1.0
-
-
-# RP --- 01:054173 18:006402 --:------ 0005 004 00100000  # before adding RFG100
-# .I --- 01:054173 --:------ 01:054173 1FC9 012 0010E004D39D001FC904D39D
-# .W --- 30:248208 01:054173 --:------ 1FC9 012 0010E07BC9900012907BC990
-# .I --- 01:054173 30:248208 --:------ 1FC9 006 00FFFF04D39D
-
-# RP --- 01:054173 18:006402 --:------ 0005 004 00100100  # after adding RFG100
-# RP --- 01:054173 18:006402 --:------ 000C 006 0010007BC990  # 30:082155
-# RP --- 01:054173 18:006402 --:------ 0005 004 00100100  # before deleting RFG from CTL
-# .I --- 01:054173 --:------ 01:054173 0005 004 00100000  # when the RFG was deleted
-# RP --- 01:054173 18:006402 --:------ 0005 004 00100000  # after deleting the RFG
-
-# RP|zone_devices | 000E0... || {'domain_id': 'FA', 'device_role': 'dhw_valve', 'devices': ['13:081807']}  # noqa: E501
-# RP|zone_devices | 010E0... || {'domain_id': 'FA', 'device_role': 'htg_valve', 'devices': ['13:106039']}  # noqa: E501
-
-# Example of:
-#  - Sundial RF2 Pack 3: 23:(ST9420C), 07:(CS92), and 22:(DTS92(E))
-
-# HCW80 has option of being wired (normally wireless)
-# ST9420C has battery back-up (as does evohome)
-
-
-I_ = " I"
-RQ = "RQ"
-RP = "RP"
-W_ = " W"
-
-
-class Code(StrEnum):
-    _0001 = "0001"
-    _0002 = "0002"
-    _0004 = "0004"
-    _0005 = "0005"
-    _0006 = "0006"
-    _0008 = "0008"
-    _0009 = "0009"
-    _000A = "000A"
-    _000C = "000C"
-    _000E = "000E"
-    _0016 = "0016"
-    _0100 = "0100"
-    _0150 = "0150"
-    _01D0 = "01D0"
-    _01E9 = "01E9"
-    _0404 = "0404"
-    _0418 = "0418"
-    _042F = "042F"
-    _0B04 = "0B04"
-    _1030 = "1030"
-    _1060 = "1060"
-    _1081 = "1081"
-    _1090 = "1090"
-    _1098 = "1098"
-    _10A0 = "10A0"
-    _10B0 = "10B0"
-    _10D0 = "10D0"  # Orcon
-    _10E0 = "10E0"
-    _10E1 = "10E1"
-    _10E2 = "10E2"
-    _1100 = "1100"
-    _11F0 = "11F0"
-    _1260 = "1260"
-    _1280 = "1280"
-    _1290 = "1290"
-    _1298 = "1298"
-    _12A0 = "12A0"
-    _12B0 = "12B0"
-    _12C0 = "12C0"
-    _12C8 = "12C8"
-    _12F0 = "12F0"
-    _1300 = "1300"
-    _1470 = "1470"  # Orcon
-    _1F09 = "1F09"
-    _1F41 = "1F41"
-    _1F70 = "1F70"
-    _1FC9 = "1FC9"
-    _1FCA = "1FCA"
-    _1FD0 = "1FD0"
-    _1FD4 = "1FD4"
-    _2210 = "2210"  # Orcon
-    _2249 = "2249"
-    _22C9 = "22C9"
-    _22D0 = "22D0"
-    _22D9 = "22D9"
-    _22E0 = "22E0"  # Orcon
-    _22E5 = "22E5"  # Orcon
-    _22E9 = "22E9"  # Orcon
-    _22F1 = "22F1"
-    _22F2 = "22F2"  # Orcon
-    _22F3 = "22F3"
-    _22F4 = "22F4"  # Orcon
-    _22F7 = "22F7"  # Orcon
-    _22F8 = "22F8"  # Orcon
-    _22B0 = "22B0"
-    _2309 = "2309"
-    _2349 = "2349"
-    _2389 = "2389"
-    _2400 = "2400"
-    _2401 = "2401"
-    _2410 = "2410"
-    _2411 = "2411"
-    _2420 = "2420"
-    _2D49 = "2D49"
-    _2E04 = "2E04"
-    _2E10 = "2E10"
-    _30C9 = "30C9"
-    _3110 = "3110"
-    _3120 = "3120"
-    _313E = "313E"  # Orcon
-    _313F = "313F"
-    _3150 = "3150"
-    _31D9 = "31D9"
-    _31DA = "31DA"
-    _31E0 = "31E0"
-    _3200 = "3200"
-    _3210 = "3210"
-    _3220 = "3220"
-    _3221 = "3221"
-    _3222 = "3222"  # Orcon
-    _3223 = "3223"
-    _3B00 = "3B00"
-    _3EF0 = "3EF0"
-    _3EF1 = "3EF1"
-    _4401 = "4401"
-    _4E01 = "4E01"
-    _4E02 = "4E02"
-    _4E04 = "4E04"
-    _PUZZ = "7FFF"