conson-xp 1.46.0__py3-none-any.whl → 1.48.0__py3-none-any.whl

xp/models/telegram/event_telegram.py

@@ -13,7 +13,8 @@ from xp.models.telegram.telegram_type import TelegramType
 
 @dataclass
 class EventTelegram(Telegram):
-    r"""Represent a parsed event telegram from the console bus.
+    r"""
+    Represent a parsed event telegram from the console bus.
 
     Format: <[EO]{module_type}L{link_number}I{input_number}{event_type}{checksum}>
 
@@ -46,7 +47,8 @@ class EventTelegram(Telegram):
 
     @property
     def module_info(self) -> Optional[ModuleType]:
-        """Get module type information for this telegram.
+        """
+        Get module type information for this telegram.
 
         Returns:
             ModuleType instance if found, None otherwise.
@@ -55,7 +57,8 @@ class EventTelegram(Telegram):
 
     @property
     def input_type(self) -> InputType:
-        """Determines the input type based on input number.
+        """
+        Determines the input type based on input number.
 
         Returns:
             InputType enum value.
@@ -71,7 +74,8 @@ class EventTelegram(Telegram):
 
     @property
     def is_button_press(self) -> bool:
-        """True if this is a button press event.
+        """
+        True if this is a button press event.
 
         Returns:
             True if event is a button press, False otherwise.
@@ -80,7 +84,8 @@ class EventTelegram(Telegram):
 
     @property
     def is_button_release(self) -> bool:
-        """True if this is a button release event.
+        """
+        True if this is a button release event.
 
         Returns:
             True if event is a button release, False otherwise.
@@ -88,7 +93,8 @@ class EventTelegram(Telegram):
         return self.event_type == EventType.BUTTON_RELEASE
 
     def to_dict(self) -> dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the event telegram.
@@ -122,7 +128,8 @@ class EventTelegram(Telegram):
         return result
 
     def __str__(self) -> str:
-        """Human-readable string representation.
+        """
+        Human-readable string representation.
 
         Returns:
             Formatted string representation.

xp/models/telegram/event_type.py

@@ -4,7 +4,8 @@ from enum import Enum
 
 
 class EventType(Enum):
-    """Event types for telegraph events.
+    """
+    Event types for telegraph events.
 
     Attributes:
         BUTTON_PRESS: Button make (press) event.

xp/models/telegram/input_action_type.py

@@ -4,7 +4,8 @@ from enum import Enum
 
 
 class InputActionType(Enum):
-    """Input action types for XP24 module (based on Feature-Action-Table.md).
+    """
+    Input action types for XP24 module (based on Feature-Action-Table.md).
 
     Attributes:
         VOID: No action.

xp/models/telegram/input_type.py

@@ -4,7 +4,8 @@ from enum import Enum
 
 
 class InputType(Enum):
-    """Input types based on input number ranges.
+    """
+    Input types based on input number ranges.
 
     Attributes:
         PUSH_BUTTON: Push button input (range 00-09).

xp/models/telegram/module_type.py

@@ -8,7 +8,8 @@ from xp.models.telegram.module_type_code import MODULE_TYPE_REGISTRY
 
 @dataclass
 class ModuleType:
-    """Represents a module type in the XP system.
+    """
+    Represents a module type in the XP system.
 
     Contains the module code, name, and description.
 
@@ -30,7 +31,8 @@ class ModuleType:
 
     @classmethod
     def from_code(cls, code: int) -> Optional["ModuleType"]:
-        """Create ModuleType from a numeric code.
+        """
+        Create ModuleType from a numeric code.
 
         Args:
             code: The numeric module type code.
@@ -45,7 +47,8 @@ class ModuleType:
 
     @classmethod
     def from_name(cls, name: str) -> Optional["ModuleType"]:
-        """Create ModuleType from a module name.
+        """
+        Create ModuleType from a module name.
 
         Args:
             name: The module name (case-insensitive).
@@ -61,7 +64,8 @@ class ModuleType:
 
     @property
     def is_reserved(self) -> bool:
-        """Check if this module type is reserved.
+        """
+        Check if this module type is reserved.
 
         Returns:
             True if module type is reserved, False otherwise.
@@ -70,7 +74,8 @@ class ModuleType:
 
     @property
     def is_push_button_panel(self) -> bool:
-        """Check if this module type is a push button panel.
+        """
+        Check if this module type is a push button panel.
 
         Returns:
             True if module is a push button panel, False otherwise.
@@ -87,7 +92,8 @@ class ModuleType:
 
     @property
     def is_ir_capable(self) -> bool:
-        """Check if this module type has IR capabilities.
+        """
+        Check if this module type has IR capabilities.
 
         Returns:
             True if module has IR capabilities, False otherwise.
@@ -106,7 +112,8 @@ class ModuleType:
 
     @property
     def category(self) -> str:
-        """Get the module category based on its type.
+        """
+        Get the module category based on its type.
 
         Returns:
             Module category string.
@@ -122,7 +129,8 @@ class ModuleType:
         return "Unknown"
 
     def to_dict(self) -> Dict:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the module type.
@@ -138,7 +146,8 @@ class ModuleType:
         }
 
     def __str__(self) -> str:
-        """Return human-readable string representation.
+        """
+        Return human-readable string representation.
 
         Returns:
             Formatted string representation.
@@ -147,7 +156,8 @@ class ModuleType:
 
 
 def get_all_module_types() -> List[ModuleType]:
-    """Get all available module types.
+    """
+    Get all available module types.
 
     Returns:
         List of all ModuleType instances.
@@ -162,7 +172,8 @@ def get_all_module_types() -> List[ModuleType]:
 
 
 def get_module_types_by_category() -> Dict[str, List[ModuleType]]:
-    """Get module types grouped by category.
+    """
+    Get module types grouped by category.
 
     Returns:
         Dictionary mapping category names to lists of ModuleType instances.
@@ -177,7 +188,8 @@ def get_module_types_by_category() -> Dict[str, List[ModuleType]]:
 
 
 def is_valid_module_code(code: int) -> bool:
-    """Check if a module code is valid.
+    """
+    Check if a module code is valid.
 
     Args:
         code: Module code to validate.

xp/models/telegram/module_type_code.py

@@ -5,7 +5,8 @@ from typing import Dict
 
 
 class ModuleTypeCode(Enum):
-    """Enum representing all XP system module type codes.
+    """
+    Enum representing all XP system module type codes.
 
     Attributes:
         NOMOD: No module (code 0).

xp/models/telegram/output_telegram.py

@@ -1,9 +1,10 @@
-"""XP output telegram model for console bus communication.
+"""
+XP output telegram model for console bus communication.
 
-XP output telegrams are used for controlling relay inputs on XP modules.
-Each XP24 module has 4 inputs (0-3) that can be pressed or released.
-Each XP33 module has 3 inputs (0-2) that can be pressed or released.
-Each XP31 module has 1 inputs (0-0) that can be pressed or released.
+XP output telegrams are used for controlling relay inputs on XP modules. Each XP24
+module has 4 inputs (0-3) that can be pressed or released. Each XP33 module has 3 inputs
+(0-2) that can be pressed or released. Each XP31 module has 1 inputs (0-0) that can be
+pressed or released.
 """
 
 from dataclasses import dataclass
@@ -17,7 +18,8 @@ from xp.models.telegram.telegram import Telegram
 
 @dataclass
 class OutputTelegram(Telegram):
-    """Represent a parsed XP output telegram from the console bus.
+    """
+    Represent a parsed XP output telegram from the console bus.
 
     Format: <S{serial_number}F27D{input:02d}{action}{checksum}>
     Examples: <S0012345008F27D00AAFN>
@@ -45,7 +47,8 @@ class OutputTelegram(Telegram):
 
     @property
     def action_description(self) -> str:
-        """Get human-readable action description.
+        """
+        Get human-readable action description.
 
         Returns:
             Human-readable description of the action.
@@ -62,7 +65,8 @@ class OutputTelegram(Telegram):
 
     @property
     def input_description(self) -> str:
-        """Get human-readable input description.
+        """
+        Get human-readable input description.
 
         Returns:
             Description of the input/output number.
@@ -70,7 +74,8 @@ class OutputTelegram(Telegram):
         return f"Input {self.output_number}"
 
     def to_dict(self) -> dict:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the output telegram.
@@ -91,7 +96,8 @@ class OutputTelegram(Telegram):
         }
 
     def __str__(self) -> str:
-        """Return human-readable string representation.
+        """
+        Return human-readable string representation.
 
         Returns:
             Formatted string representation.

xp/models/telegram/reply_telegram.py

@@ -1,7 +1,8 @@
-"""Reply telegram model for console bus communication.
+"""
+Reply telegram model for console bus communication.
 
-Reply telegrams are responses to system telegrams, containing the requested data
-like temperature readings, status information, etc.
+Reply telegrams are responses to system telegrams, containing the requested data like
+temperature readings, status information, etc.
 """
 
 from dataclasses import dataclass
@@ -16,7 +17,8 @@ from xp.models.telegram.telegram_type import TelegramType
 
 @dataclass
 class ReplyTelegram(Telegram):
-    """Represents a parsed reply telegram from the console bus.
+    """
+    Represents a parsed reply telegram from the console bus.
 
     Format: <R{serial_number}F{function_code}D{data}{checksum}>
     Format: <R{serial_number}F{function_code}D{datapoint_type}{data_value}{checksum}>
@@ -54,7 +56,8 @@ class ReplyTelegram(Telegram):
 
     @property
     def parse_datapoint_value(self) -> dict[str, Any]:
-        """Parse the data value based on data point type.
+        """
+        Parse the data value based on data point type.
 
         Returns:
             Dictionary containing parsed value and metadata.
@@ -74,7 +77,8 @@ class ReplyTelegram(Telegram):
         return {"raw_value": self.data_value, "parsed": False}
 
     def _parse_temperature_value(self) -> dict:
-        """Parse temperature value like '+26,0§C'.
+        """
+        Parse temperature value like '+26,0§C'.
 
         Returns:
             Dictionary containing parsed temperature value and metadata.
@@ -101,7 +105,8 @@ class ReplyTelegram(Telegram):
             }
 
     def _parse_humidity_value(self) -> dict:
-        """Parse humidity value like '+65,5§H'.
+        """
+        Parse humidity value like '+65,5§H'.
 
         Returns:
             Dictionary containing parsed humidity value and metadata.
@@ -128,7 +133,8 @@ class ReplyTelegram(Telegram):
             }
 
     def _parse_voltage_value(self) -> dict:
-        """Parse voltage value like '+12,5§V'.
+        """
+        Parse voltage value like '+12,5§V'.
 
         Returns:
             Dictionary containing parsed voltage value and metadata.
@@ -155,7 +161,8 @@ class ReplyTelegram(Telegram):
             }
 
     def _parse_current_value(self) -> dict:
-        """Parse current value like '+0,25§A'.
+        """
+        Parse current value like '+0,25§A'.
 
         Returns:
             Dictionary containing parsed current value and metadata.
@@ -182,7 +189,8 @@ class ReplyTelegram(Telegram):
             }
 
     def _parse_module_type_value(self) -> dict:
-        """Parse status value.
+        """
+        Parse status value.
 
         Returns:
             Dictionary containing parsed module type value.
@@ -195,7 +203,8 @@ class ReplyTelegram(Telegram):
         }
 
     def _parse_sw_version_value(self) -> dict:
-        """Parse version value like 'XP230_V1.00.04'.
+        """
+        Parse version value like 'XP230_V1.00.04'.
 
         Returns:
             Dictionary containing parsed version information.
@@ -235,7 +244,8 @@ class ReplyTelegram(Telegram):
             }
 
     def to_dict(self) -> dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the reply telegram.
@@ -275,7 +285,8 @@ class ReplyTelegram(Telegram):
         }
 
     def __str__(self) -> str:
-        """Human-readable string representation.
+        """
+        Human-readable string representation.
 
         Returns:
             Formatted string representation.

xp/models/telegram/system_function.py

@@ -5,7 +5,8 @@ from typing import Optional
 
 
 class SystemFunction(str, Enum):
-    """System function codes for system telegrams.
+    """
+    System function codes for system telegrams.
 
     Attributes:
         NONE: Undefined function.
@@ -76,7 +77,8 @@ class SystemFunction(str, Enum):
     ACTION = "27"  # F27D Action function
 
     def get_description(self) -> str:
-        """Get the description of the SystemFunction.
+        """
+        Get the description of the SystemFunction.
 
         Returns:
             Human-readable description of the function.
@@ -102,7 +104,8 @@ class SystemFunction(str, Enum):
 
     @classmethod
     def from_code(cls, code: str) -> Optional["SystemFunction"]:
-        """Get SystemFunction from code string.
+        """
+        Get SystemFunction from code string.
 
         Args:
             code: Function code string.

xp/models/telegram/system_telegram.py

@@ -1,7 +1,8 @@
-"""System telegram model for console bus communication.
+"""
+System telegram model for console bus communication.
 
-System telegrams are used for system-related information like updating firmware
-and reading temperature from modules.
+System telegrams are used for system-related information like updating firmware and
+reading temperature from modules.
 """
 
 from dataclasses import dataclass
@@ -16,7 +17,8 @@ from xp.models.telegram.telegram_type import TelegramType
 
 @dataclass
 class SystemTelegram(Telegram):
-    """Represents a parsed system telegram from the console bus.
+    """
+    Represents a parsed system telegram from the console bus.
 
     Format: <S{serial_number}F{function_code}D{datapoint_type}{checksum}>
     Examples: <S0020012521F02D18FN>
@@ -40,7 +42,8 @@ class SystemTelegram(Telegram):
         self.telegram_type = TelegramType.SYSTEM
 
     def to_dict(self) -> dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the system telegram.
@@ -77,7 +80,8 @@ class SystemTelegram(Telegram):
         }
 
     def __str__(self) -> str:
-        """Human-readable string representation.
+        """
+        Human-readable string representation.
 
         Returns:
             Formatted string representation.

xp/models/telegram/telegram.py

@@ -9,7 +9,8 @@ from xp.models.telegram.telegram_type import TelegramType
 
 @dataclass
 class Telegram:
-    """Represents an abstract telegram from the console bus.
+    """
+    Represents an abstract telegram from the console bus.
 
     Can be an EventTelegram, SystemTelegram or ReplyTelegram.
 

xp/models/telegram/telegram_type.py

@@ -4,7 +4,8 @@ from enum import Enum
 
 
 class TelegramType(str, Enum):
-    """Enumeration of telegram types in the console bus system.
+    """
+    Enumeration of telegram types in the console bus system.
 
     Attributes:
         EVENT: Event telegram (E).

xp/models/telegram/timeparam_type.py

@@ -4,7 +4,8 @@ from enum import IntEnum
 
 
 class TimeParam(IntEnum):
-    """Time parameter values for action timing.
+    """
+    Time parameter values for action timing.
 
     Attributes:
         NONE: No time parameter.

xp/models/term/connection_state.py

@@ -6,7 +6,8 @@ from xp.utils.state_machine import StateMachine
 
 
 class ConnectionState(str, Enum):
-    """Connection state enumeration.
+    """
+    Connection state enumeration.
 
     Attributes:
         DISCONNECTING: Disconnecting to server.
@@ -24,7 +25,8 @@ class ConnectionState(str, Enum):
 
     @staticmethod
     def create_state_machine() -> StateMachine:
-        """Create and configure state machine for connection management.
+        """
+        Create and configure state machine for connection management.
 
         Returns:
             Configured StateMachine with connection state transitions.

xp/models/term/module_state.py

@@ -7,7 +7,8 @@ from typing import Optional
 
 @dataclass
 class ModuleState:
-    """State of a Conson module for TUI display.
+    """
+    State of a Conson module for TUI display.
 
     Attributes:
         name: Module name/identifier (e.g., A01, A02).

xp/models/term/protocol_keys_config.py

@@ -8,7 +8,8 @@ from pydantic import BaseModel, Field
 
 
 class ProtocolKeyConfig(BaseModel):
-    """Configuration for a single protocol key.
+    """
+    Configuration for a single protocol key.
 
     Attributes:
         name: Human-readable command name.
@@ -20,7 +21,8 @@ class ProtocolKeyConfig(BaseModel):
 
 
 class ProtocolKeysConfig(BaseModel):
-    """Protocol keys configuration.
+    """
+    Protocol keys configuration.
 
     Attributes:
         protocol: Dictionary mapping key to protocol configuration.
@@ -32,7 +34,8 @@ class ProtocolKeysConfig(BaseModel):
 
     @classmethod
     def from_yaml(cls, config_path: Path) -> "ProtocolKeysConfig":
-        """Load protocol keys from YAML file.
+        """
+        Load protocol keys from YAML file.
 
         Args:
             config_path: Path to YAML configuration file.

xp/models/term/status_message.py

@@ -7,7 +7,8 @@ class StatusMessageChanged(Message):
     """Message posted when status message changes."""
 
     def __init__(self, message: str) -> None:
-        """Initialize the message.
+        """
+        Initialize the message.
 
         Args:
             message: The status message to display.

xp/models/term/telegram_display.py

@@ -6,7 +6,8 @@ from typing import Literal, Optional
 
 @dataclass
 class TelegramDisplayEvent:
-    """Event containing telegram data for display in TUI.
+    """
+    Event containing telegram data for display in TUI.
 
     Attributes:
         direction: Direction of telegram ("RX" for received, "TX" for transmitted).

xp/models/write_config_type.py

@@ -5,7 +5,8 @@ from typing import Optional
 
 
 class WriteConfigType(str, Enum):
-    """Write Config types for system telegrams.
+    """
+    Write Config types for system telegrams.
 
     Attributes:
         LINK_NUMBER: Link number configuration (code 04).
@@ -19,7 +20,8 @@ class WriteConfigType(str, Enum):
 
     @classmethod
     def from_code(cls, code: str) -> Optional["WriteConfigType"]:
-        """Get WriteConfigType from code string.
+        """
+        Get WriteConfigType from code string.
 
         Args:
             code: Configuration type code string.