conson-xp 1.18.0__py3-none-any.whl

xp/models/telegram/event_telegram.py

@@ -0,0 +1,140 @@
+"""Event telegram model for console bus communication."""
+
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any, Optional
+
+from xp.models.telegram.event_type import EventType
+from xp.models.telegram.input_type import InputType
+from xp.models.telegram.module_type import ModuleType
+from xp.models.telegram.telegram import Telegram
+from xp.models.telegram.telegram_type import TelegramType
+
+
+@dataclass
+class EventTelegram(Telegram):
+    r"""Represent a parsed event telegram from the console bus.
+
+    Format: <[EO]{module_type}L{link_number}I{input_number}{event_type}{checksum}>
+
+    Examples:
+        <E14L00I02MAK>
+
+    Attributes:
+        event_telegram_type: Event telegram type (E or O).
+        module_type: Module type code.
+        link_number: Link number.
+        input_number: Input number.
+        event_type: Type of event (press or release).
+        module_info: Module type information if found.
+        input_type: Input type based on input number.
+        is_button_press: True if this is a button press event.
+        is_button_release: True if this is a button release event.
+    """
+
+    event_telegram_type: str = "E"  # E or O
+    module_type: int = 0
+    link_number: int = 0
+    input_number: int = 0
+    event_type: Optional[EventType] = None
+
+    def __post_init__(self) -> None:
+        """Initialize timestamp and telegram type."""
+        if self.timestamp is None:
+            self.timestamp = datetime.now()
+        self.telegram_type = TelegramType.EVENT
+
+    @property
+    def module_info(self) -> Optional[ModuleType]:
+        """Get module type information for this telegram.
+
+        Returns:
+            ModuleType instance if found, None otherwise.
+        """
+        return ModuleType.from_code(self.module_type)
+
+    @property
+    def input_type(self) -> InputType:
+        """Determines the input type based on input number.
+
+        Returns:
+            InputType enum value.
+        """
+        if 0 <= self.input_number <= 9:
+            return InputType.PUSH_BUTTON
+        elif 10 <= self.input_number <= 89:
+            return InputType.IR_REMOTE
+        elif self.input_number == 90:
+            return InputType.PROXIMITY_SENSOR
+        else:
+            raise ValueError(f"Invalid input number: {self.input_number}")
+
+    @property
+    def is_button_press(self) -> bool:
+        """True if this is a button press event.
+
+        Returns:
+            True if event is a button press, False otherwise.
+        """
+        return self.event_type == EventType.BUTTON_PRESS
+
+    @property
+    def is_button_release(self) -> bool:
+        """True if this is a button release event.
+
+        Returns:
+            True if event is a button release, False otherwise.
+        """
+        return self.event_type == EventType.BUTTON_RELEASE
+
+    def to_dict(self) -> dict[str, Any]:
+        """Convert to dictionary for JSON serialization.
+
+        Returns:
+            Dictionary representation of the event telegram.
+        """
+        result: dict[str, Any] = {
+            "module_type": self.module_type,
+            "link_number": self.link_number,
+            "output_number": self.input_number,
+            "event_type": self.event_type.value if self.event_type else None,
+            "event_type_name": (
+                "button_press" if self.is_button_press else "button_release"
+            ),
+            "input_type": self.input_type.value,
+            "checksum": self.checksum,
+            "checksum_validated": self.checksum_validated,
+            "raw_telegram": self.raw_telegram,
+            "timestamp": self.timestamp.isoformat() if self.timestamp else None,
+            "telegram_type": self.telegram_type.value,
+        }
+
+        # Add module information if available
+        if self.module_info:
+            result["module_info"] = {
+                "name": self.module_info.name,
+                "description": self.module_info.description,
+                "category": self.module_info.category,
+            }
+        else:
+            result["module_info"] = None
+
+        return result
+
+    def __str__(self) -> str:
+        """Human-readable string representation.
+
+        Returns:
+            Formatted string representation.
+        """
+        event_desc = "pressed" if self.is_button_press else "released"
+
+        # Include module name if available
+        module_desc = f"Module {self.module_type}"
+        if self.module_info:
+            module_desc = f"{self.module_info.name} (Type {self.module_type})"
+
+        return (
+            f"{module_desc} Link {self.link_number:02d} "
+            f"Input {self.input_number:02d} ({self.input_type.value}) {event_desc}"
+        )

xp/models/telegram/event_type.py

@@ -0,0 +1,15 @@
+"""Event type enumeration for telegram events."""
+
+from enum import Enum
+
+
+class EventType(Enum):
+    """Event types for telegraph events.
+
+    Attributes:
+        BUTTON_PRESS: Button make (press) event.
+        BUTTON_RELEASE: Button break (release) event.
+    """
+
+    BUTTON_PRESS = "M"  # Make
+    BUTTON_RELEASE = "B"  # Break

xp/models/telegram/input_action_type.py

@@ -0,0 +1,69 @@
+"""Input action types for XP24 module based on Feature-Action-Table.md."""
+
+from enum import Enum
+
+
+class InputActionType(Enum):
+    """Input action types for XP24 module (based on Feature-Action-Table.md).
+
+    Attributes:
+        VOID: No action.
+        ON: Turn on action.
+        OFF: Turn off action.
+        TOGGLE: Toggle action.
+        BLOCK: Block action.
+        AUXRELAY: Auxiliary relay action.
+        MUTUALEX: Mutual exclusion action.
+        LEVELUP: Level up action.
+        LEVELDOWN: Level down action.
+        LEVELINC: Level increment action.
+        LEVELDEC: Level decrement action.
+        LEVELSET: Level set action.
+        FADETIME: Fade time action.
+        SCENESET: Scene set action.
+        SCENENEXT: Scene next action.
+        SCENEPREV: Scene previous action.
+        CTRLMETHOD: Control method action.
+        RETURNDATA: Return data action.
+        DELAYEDON: Delayed on action.
+        EVENTTIMER1: Event timer 1 action.
+        EVENTTIMER2: Event timer 2 action.
+        EVENTTIMER3: Event timer 3 action.
+        EVENTTIMER4: Event timer 4 action.
+        STEPCTRL: Step control action.
+        STEPCTRLUP: Step control up action.
+        STEPCTRLDOWN: Step control down action.
+        LEVELSETINTERN: Level set internal action.
+        FADE: Fade action.
+        LEARN: Learn action.
+    """
+
+    VOID = 0
+    ON = 1
+    OFF = 2
+    TOGGLE = 3
+    BLOCK = 4
+    AUXRELAY = 5
+    MUTUALEX = 6
+    LEVELUP = 7
+    LEVELDOWN = 8
+    LEVELINC = 9
+    LEVELDEC = 10
+    LEVELSET = 11
+    FADETIME = 12
+    SCENESET = 13
+    SCENENEXT = 14
+    SCENEPREV = 15
+    CTRLMETHOD = 16
+    RETURNDATA = 17
+    DELAYEDON = 18
+    EVENTTIMER1 = 19
+    EVENTTIMER2 = 20
+    EVENTTIMER3 = 21
+    EVENTTIMER4 = 22
+    STEPCTRL = 23
+    STEPCTRLUP = 24
+    STEPCTRLDOWN = 25
+    LEVELSETINTERN = 29
+    FADE = 30
+    LEARN = 31

xp/models/telegram/input_type.py

@@ -0,0 +1,17 @@
+"""Input type enumeration based on input number ranges."""
+
+from enum import Enum
+
+
+class InputType(Enum):
+    """Input types based on input number ranges.
+
+    Attributes:
+        PUSH_BUTTON: Push button input (range 00-09).
+        IR_REMOTE: IR remote input (range 10-89).
+        PROXIMITY_SENSOR: Proximity sensor input (input 90).
+    """
+
+    PUSH_BUTTON = "push_button"  # Input 00-09
+    IR_REMOTE = "ir_remote"  # Input 10-89
+    PROXIMITY_SENSOR = "proximity_sensor"  # Input 90

xp/models/telegram/module_type.py

@@ -0,0 +1,188 @@
+"""Module type models for the XP system."""
+
+from dataclasses import dataclass
+from typing import Dict, List, Optional
+
+from xp.models.telegram.module_type_code import MODULE_TYPE_REGISTRY
+
+
+@dataclass
+class ModuleType:
+    """Represents a module type in the XP system.
+
+    Contains the module code, name, and description.
+
+    Attributes:
+        code: Numeric module type code.
+        name: Module name.
+        description: Module description.
+        module_category: Module category.
+        is_reserved: True if module type is reserved.
+        is_push_button_panel: True if module is a push button panel.
+        is_ir_capable: True if module has IR capabilities.
+        category: Module category based on its type.
+    """
+
+    code: int
+    name: str
+    description: str
+    module_category: str = ""
+
+    @classmethod
+    def from_code(cls, code: int) -> Optional["ModuleType"]:
+        """Create ModuleType from a numeric code.
+
+        Args:
+            code: The numeric module type code.
+
+        Returns:
+            ModuleType instance or None if code is invalid.
+        """
+        module_info = MODULE_TYPE_REGISTRY.get(code)
+        if module_info:
+            return cls(code=code, **module_info)
+        return None
+
+    @classmethod
+    def from_name(cls, name: str) -> Optional["ModuleType"]:
+        """Create ModuleType from a module name.
+
+        Args:
+            name: The module name (case-insensitive).
+
+        Returns:
+            ModuleType instance or None if name is invalid.
+        """
+        name_upper = name.upper()
+        for code, info in MODULE_TYPE_REGISTRY.items():
+            if info["name"].upper() == name_upper:
+                return cls(code=code, **info)
+        return None
+
+    @property
+    def is_reserved(self) -> bool:
+        """Check if this module type is reserved.
+
+        Returns:
+            True if module type is reserved, False otherwise.
+        """
+        return self.name in ("XP26X1", "XP26X2")
+
+    @property
+    def is_push_button_panel(self) -> bool:
+        """Check if this module type is a push button panel.
+
+        Returns:
+            True if module is a push button panel, False otherwise.
+        """
+        return self.name in (
+            "XP2606",
+            "XP2606A",
+            "XP2606B",
+            "XP2506",
+            "XP2506A",
+            "XP2506B",
+            "XPX1_8",
+        )
+
+    @property
+    def is_ir_capable(self) -> bool:
+        """Check if this module type has IR capabilities.
+
+        Returns:
+            True if module has IR capabilities, False otherwise.
+        """
+        return any(ir_type in self.name for ir_type in ("38kHz", "B&O")) or any(
+            ir_code in self.name
+            for ir_code in (
+                "CP70A",
+                "CP70B",
+                "XP2606A",
+                "XP2606B",
+                "XP2506A",
+                "XP2506B",
+            )
+        )
+
+    @property
+    def category(self) -> str:
+        """Get the module category based on its type.
+
+        Returns:
+            Module category string.
+        """
+        if self.code <= 1:
+            return "System"
+        elif 2 <= self.code <= 6:
+            return "CP Link Modules"
+        elif 7 <= self.code <= 13:
+            return "XP Control Modules"
+        elif 14 <= self.code <= 24:
+            return "Interface Panels"
+        return "Unknown"
+
+    def to_dict(self) -> Dict:
+        """Convert to dictionary for JSON serialization.
+
+        Returns:
+            Dictionary representation of the module type.
+        """
+        return {
+            "code": self.code,
+            "name": self.name,
+            "description": self.description,
+            "category": self.category,
+            "is_reserved": self.is_reserved,
+            "is_push_button_panel": self.is_push_button_panel,
+            "is_ir_capable": self.is_ir_capable,
+        }
+
+    def __str__(self) -> str:
+        """Return human-readable string representation.
+
+        Returns:
+            Formatted string representation.
+        """
+        return f"{self.name} (Code {self.code}): {self.description}"
+
+
+def get_all_module_types() -> List[ModuleType]:
+    """Get all available module types.
+
+    Returns:
+        List of all ModuleType instances.
+    """
+    return [
+        module_type
+        for module_type in [
+            ModuleType.from_code(code) for code in sorted(MODULE_TYPE_REGISTRY.keys())
+        ]
+        if module_type is not None
+    ]
+
+
+def get_module_types_by_category() -> Dict[str, List[ModuleType]]:
+    """Get module types grouped by category.
+
+    Returns:
+        Dictionary mapping category names to lists of ModuleType instances.
+    """
+    categories: Dict[str, List[ModuleType]] = {}
+    for module_type in get_all_module_types():
+        category = module_type.category
+        if category not in categories:
+            categories[category] = []
+        categories[category].append(module_type)
+    return categories
+
+
+def is_valid_module_code(code: int) -> bool:
+    """Check if a module code is valid.
+
+    Args:
+        code: Module code to validate.
+
+    Returns:
+        True if code is valid, False otherwise.
+    """
+    return code in MODULE_TYPE_REGISTRY

xp/models/telegram/module_type_code.py

@@ -0,0 +1,205 @@
+"""Module type code enumeration for XP system modules."""
+
+from enum import Enum
+from typing import Dict
+
+
+class ModuleTypeCode(Enum):
+    """Enum representing all XP system module type codes.
+
+    Attributes:
+        NOMOD: No module (code 0).
+        ALLMOD: Matches every module type (code 1).
+        CP20: CP switch link module (code 2).
+        CP70A: CP 38kHz IR link module (code 3).
+        CP70B: CP B&O IR link module (code 4).
+        CP70C: CP UHF link module (code 5).
+        CP70D: CP timer link module (code 6).
+        XP24: XP relay module (code 7).
+        XP31UNI: XP universal load light dimmer (code 8).
+        XP31BCU: XP ballast controller 0-10V (code 9).
+        XP31DD: XP ballast controller DSI/DALI (code 10).
+        XP33: XP 3-channel light dimmer (code 11).
+        CP485: CP RS485 interface module (code 12).
+        XP130: Ethernet/TCP/IP interface module (code 13).
+        XP2606: 5-way push button panel with sesam (code 14).
+        XP2606A: 5-way push button with IR receiver (code 15).
+        XP2606B: 5-way push button with B&O IR (code 16).
+        XP26X1: Reserved (code 17).
+        XP26X2: Reserved (code 18).
+        XP2506: 5-way push button panel with sesam Conson design (code 19).
+        XP2506A: 5-way push button panel with sesam and 38kHz IR Conson design (code 20).
+        XP2506B: 5-way push button panel with sesam and B&O IR Conson design (code 21).
+        XPX1_8: 8-way push button panel interface (code 22).
+        XP134: Junctionbox interlink (code 23).
+        XP24P: XP24P module (code 24).
+        XP28A: XP28A module (code 25).
+        XP28B: XP28B module (code 26).
+        CONTOOL: CONTOOL module (code 27).
+        XP28: XP28 module (code 28).
+        XP31LR: XP 1-channel lightdimmer (code 29).
+        XP33LR: XP 33 3-channel lightdimmer (code 30).
+        XP31CR: XP 31 1-channel dimmer (code 31).
+        XP31BC: XP 31 1-channel dimmer (code 32).
+        XP20: XP switch link module (code 33).
+        XP230: Ethernet/TCPIP interface module (code 34).
+        XP33LED: XP 3-channel LED dimmer (code 35).
+        XP31LED: XP 1-channel LED dimmer (code 36).
+    """
+
+    NOMOD = 0  # No module
+    ALLMOD = 1  # Code matching every moduletype
+    CP20 = 2  # CP switch link module
+    CP70A = 3  # CP 38kHz IR link module
+    CP70B = 4  # CP B&O IR link module
+    CP70C = 5  # CP UHF link module
+    CP70D = 6  # CP timer link module
+    XP24 = 7  # XP relay module
+    XP31UNI = 8  # XP universal load light dimmer
+    XP31BCU = 9  # XP ballast controller, 0-10VActions
+    XP31DD = 10  # XP ballast controller DSI/DALI
+    XP33 = 11  # XP 33 3 channel lightdimmer
+    CP485 = 12  # CP RS485 interface module
+    XP130 = 13  # Ethernet/TCPIP interface module
+    XP2606 = 14  # 5 way push button panel with sesam, L-Team design
+    XP2606A = 15  # 5 way push button panel with sesam,
+    # L-Team design and 38kHz IR receiver
+    XP2606B = 16  # 5 way push button panel with sesam,
+    # L-Team design and B&O IR receiver
+    XP26X1 = 17  # Reserved
+    XP26X2 = 18  # Reserved
+    XP2506 = 19  # 5 way push button panel with sesam, Conson design
+    XP2506A = 20  # 5 way push button panel with sesam and 38kHz IR, Conson design
+    XP2506B = 21  # 5 way push button panel with sesam and B&O IR, Conson design
+    XPX1_8 = 22  # 8 way push button panel interface
+    XP134 = 23  # Junctionbox interlink
+    XP24P = 24  # XP24P module
+    XP28A = 25  #
+    XP28B = 26  #
+    CONTOOL = 27  #
+    XP28 = 28  #
+    XP31LR = 29  # XP 1 channel lightdimmer
+    XP33LR = 30  # XP 33 3 channel lightdimmer
+    XP31CR = 31  # XP 31 1 channel dimmer
+    XP31BC = 32  # XP 31 1 channel dimmer
+    XP20 = 33  # XP switch link module
+    XP230 = 34  # Ethernet/TCPIP interface module
+    XP33LED = 35  # XP 3 channel LED dimmer
+    XP31LED = 36  # XP 1 channel LED dimmer
+
+
+# Registry mapping module codes to their information
+MODULE_TYPE_REGISTRY: Dict[int, Dict[str, str]] = {
+    ModuleTypeCode.NOMOD.value: {"name": "NOMOD", "description": "No module"},
+    ModuleTypeCode.ALLMOD.value: {
+        "name": "ALLMOD",
+        "description": "Code matching every moduletype",
+    },
+    ModuleTypeCode.CP20.value: {"name": "CP20", "description": "CP switch link module"},
+    ModuleTypeCode.CP70A.value: {
+        "name": "CP70A",
+        "description": "CP 38kHz IR link module",
+    },
+    ModuleTypeCode.CP70B.value: {
+        "name": "CP70B",
+        "description": "CP B&O IR link module",
+    },
+    ModuleTypeCode.CP70C.value: {"name": "CP70C", "description": "CP UHF link module"},
+    ModuleTypeCode.CP70D.value: {
+        "name": "CP70D",
+        "description": "CP timer link module",
+    },
+    ModuleTypeCode.XP24.value: {"name": "XP24", "description": "XP relay module"},
+    ModuleTypeCode.XP31UNI.value: {
+        "name": "XP31UNI",
+        "description": "XP universal load light dimmer",
+    },
+    ModuleTypeCode.XP31BCU.value: {
+        "name": "XP31BC",
+        "description": "XP ballast controller, 0-10VActions",
+    },
+    ModuleTypeCode.XP31DD.value: {
+        "name": "XP31DD",
+        "description": "XP ballast controller DSI/DALI",
+    },
+    ModuleTypeCode.XP33.value: {
+        "name": "XP33",
+        "description": "XP 33 3 channel lightdimmer",
+    },
+    ModuleTypeCode.CP485.value: {
+        "name": "CP485",
+        "description": "CP RS485 interface module",
+    },
+    ModuleTypeCode.XP130.value: {
+        "name": "XP130",
+        "description": "Ethernet/TCPIP interface module",
+    },
+    ModuleTypeCode.XP2606.value: {
+        "name": "XP2606",
+        "description": "5 way push button panel with sesam, L-Team design",
+    },
+    ModuleTypeCode.XP2606A.value: {
+        "name": "XP2606A",
+        "description": "5 way push button panel with sesam, L-Team design and 38kHz IR receiver",
+    },
+    ModuleTypeCode.XP2606B.value: {
+        "name": "XP2606B",
+        "description": "5 way push button panel with sesam, L-Team design and B&O IR receiver",
+    },
+    ModuleTypeCode.XP26X1.value: {"name": "XP26X1", "description": "Reserved"},
+    ModuleTypeCode.XP26X2.value: {"name": "XP26X2", "description": "Reserved"},
+    ModuleTypeCode.XP2506.value: {
+        "name": "XP2506",
+        "description": "5 way push button panel with sesam, Conson design",
+    },
+    ModuleTypeCode.XP2506A.value: {
+        "name": "XP2506A",
+        "description": "5 way push button panel with sesam and 38kHz IR, Conson design",
+    },
+    ModuleTypeCode.XP2506B.value: {
+        "name": "XP2506B",
+        "description": "5 way push button panel with sesam and B&O IR, Conson design",
+    },
+    ModuleTypeCode.XPX1_8.value: {
+        "name": "XPX1_8",
+        "description": "8 way push button panel interface",
+    },
+    ModuleTypeCode.XP134.value: {
+        "name": "XP134",
+        "description": "Junctionbox interlink",
+    },
+    ModuleTypeCode.XP24P.value: {"name": "XP24P", "description": "XP24P module"},
+    ModuleTypeCode.XP28A.value: {"name": "XP28A", "description": "XP28A module"},
+    ModuleTypeCode.XP28B.value: {"name": "XP28B", "description": "XP28B module"},
+    ModuleTypeCode.CONTOOL.value: {"name": "CONTOOL", "description": "CONTOOL module"},
+    ModuleTypeCode.XP28.value: {"name": "XP28", "description": "XP28 module"},
+    ModuleTypeCode.XP31LR.value: {
+        "name": "XP31LR",
+        "description": "XP 1 channel lightdimmer",
+    },
+    ModuleTypeCode.XP33LR.value: {
+        "name": "XP33LR",
+        "description": "XP 33 3 channel lightdimmer",
+    },
+    ModuleTypeCode.XP31CR.value: {
+        "name": "XP31CR",
+        "description": "XP 31 1 channel dimmer",
+    },
+    ModuleTypeCode.XP31BC.value: {
+        "name": "XP31BC",
+        "description": "XP 31 1 channel dimmer",
+    },
+    ModuleTypeCode.XP20.value: {"name": "XP20", "description": "XP switch link module"},
+    ModuleTypeCode.XP230.value: {
+        "name": "XP230",
+        "description": "Ethernet/TCPIP interface module",
+    },
+    ModuleTypeCode.XP33LED.value: {
+        "name": "XP33LED",
+        "description": "XP 3 channel LED dimmer",
+    },
+    ModuleTypeCode.XP31LED.value: {
+        "name": "XP31LED",
+        "description": "XP 1 channel LED dimmer",
+    },
+}