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

xp/services/server/xp230_server_service.py

@@ -1,7 +1,8 @@
-"""XP230 Server Service for device emulation.
+"""
+XP230 Server Service for device emulation.
 
-This service provides XP230-specific device emulation functionality,
-including response generation and device configuration handling.
+This service provides XP230-specific device emulation functionality, including response
+generation and device configuration handling.
 """
 
 from typing import Dict, Optional
@@ -21,8 +22,8 @@ class XP230ServerService(BaseServerService):
     """
     XP230 device emulation service.
 
-    Generates XP230-specific responses, handles XP230 device configuration,
-    and implements XP230 telegram format.
+    Generates XP230-specific responses, handles XP230 device configuration, and
+    implements XP230 telegram format.
     """
 
     def __init__(
@@ -31,7 +32,8 @@ class XP230ServerService(BaseServerService):
         _variant: str = "",
         _msactiontable_serializer: Optional[MsActionTableSerializer] = None,
     ):
-        """Initialize XP230 server service.
+        """
+        Initialize XP230 server service.
 
         Args:
             serial_number: The device serial number.
@@ -44,7 +46,8 @@ class XP230ServerService(BaseServerService):
         self.firmware_version = "XP230_V1.00.04"
 
     def get_device_info(self) -> Dict:
-        """Get XP230 device information.
+        """
+        Get XP230 device information.
 
         Returns:
             Dictionary containing device information.

xp/services/server/xp24_server_service.py

@@ -1,7 +1,8 @@
-"""XP24 Server Service for device emulation.
+"""
+XP24 Server Service for device emulation.
 
-This service provides XP24-specific device emulation functionality,
-including response generation and device configuration handling.
+This service provides XP24-specific device emulation functionality, including response
+generation and device configuration handling.
 """
 
 from typing import Dict, Optional
@@ -26,7 +27,8 @@ class XP24ServerError(Exception):
 
 
 class XP24Output:
-    """Represents an XP24 output state.
+    """
+    Represents an XP24 output state.
 
     Attributes:
         state: Current state of the output (True=on, False=off).
@@ -39,8 +41,8 @@ class XP24ServerService(BaseServerService):
     """
     XP24 device emulation service.
 
-    Generates XP24-specific responses, handles XP24 device configuration,
-    and implements XP24 telegram format.
+    Generates XP24-specific responses, handles XP24 device configuration, and implements
+    XP24 telegram format.
     """
 
     def __init__(
@@ -49,7 +51,8 @@ class XP24ServerService(BaseServerService):
         _variant: str = "",
         msactiontable_serializer: Optional[Xp24MsActionTableSerializer] = None,
     ):
-        """Initialize XP24 server service.
+        """
+        Initialize XP24 server service.
 
         Args:
             serial_number: The device serial number.
@@ -108,7 +111,8 @@ class XP24ServerService(BaseServerService):
         return telegrams
 
     def _build_ack_nak_response_telegram(self, ack_or_nak: bool) -> str:
-        """Build a complete ACK or NAK response telegram with checksum.
+        """
+        Build a complete ACK or NAK response telegram with checksum.
 
         Args:
             ack_or_nak: true: ACK telegram response, false: NAK telegram response.
@@ -125,7 +129,8 @@ class XP24ServerService(BaseServerService):
     def _build_make_break_response_telegram(
         self, make_or_break: bool, output_number: int
     ) -> str:
-        """Build a complete ACK or NAK response telegram with checksum.
+        """
+        Build a complete ACK or NAK response telegram with checksum.
 
         Args:
             make_or_break: true: MAKE event response, false: BREAK event response.
@@ -192,7 +197,8 @@ class XP24ServerService(BaseServerService):
         )
 
     def _get_msactiontable_serializer(self) -> Optional[Xp24MsActionTableSerializer]:
-        """Get the MsActionTable serializer for XP24.
+        """
+        Get the MsActionTable serializer for XP24.
 
         Returns:
             The XP24 MsActionTable serializer instance.
@@ -200,7 +206,8 @@ class XP24ServerService(BaseServerService):
         return self.msactiontable_serializer
 
     def _get_msactiontable(self) -> Optional[Xp24MsActionTable]:
-        """Get the MsActionTable for XP24.
+        """
+        Get the MsActionTable for XP24.
 
         Returns:
             The XP24 MsActionTable instance.
@@ -208,7 +215,8 @@ class XP24ServerService(BaseServerService):
         return self.msactiontable
 
     def _get_default_msactiontable(self) -> Xp24MsActionTable:
-        """Generate default MsActionTable configuration.
+        """
+        Generate default MsActionTable configuration.
 
         Returns:
             Default XP24 MsActionTable with all inputs set to VOID.
@@ -226,7 +234,8 @@ class XP24ServerService(BaseServerService):
         )
 
     def get_device_info(self) -> Dict:
-        """Get XP24 device information.
+        """
+        Get XP24 device information.
 
         Returns:
             Dictionary containing device information.

xp/services/server/xp33_server_service.py

@@ -1,8 +1,8 @@
-"""XP33 Server Service for device emulation.
+"""
+XP33 Server Service for device emulation.
 
-This service provides XP33-specific device emulation functionality,
-including response generation and device configuration handling for
-3-channel light dimmer modules.
+This service provides XP33-specific device emulation functionality, including response
+generation and device configuration handling for 3-channel light dimmer modules.
 """
 
 import socket
@@ -30,8 +30,8 @@ class XP33ServerService(BaseServerService):
     """
     XP33 device emulation service.
 
-    Generates XP33-specific responses, handles XP33 device configuration,
-    and implements XP33 telegram format for 3-channel dimmer modules.
+    Generates XP33-specific responses, handles XP33 device configuration, and implements
+    XP33 telegram format for 3-channel dimmer modules.
     """
 
     def __init__(
@@ -40,7 +40,8 @@ class XP33ServerService(BaseServerService):
         variant: str = "XP33LR",
         msactiontable_serializer: Optional[Xp33MsActionTableSerializer] = None,
     ):
-        """Initialize XP33 server service.
+        """
+        Initialize XP33 server service.
 
         Args:
             serial_number: The device serial number.
@@ -110,7 +111,8 @@ class XP33ServerService(BaseServerService):
         return telegrams
 
     def _handle_action_channel_dimming(self, data_value: str) -> str:
-        """Handle XP33-specific channel dimming action.
+        """
+        Handle XP33-specific channel dimming action.
 
         Args:
             data_value: Action data in format channel_number:dimming_level.
@@ -151,7 +153,8 @@ class XP33ServerService(BaseServerService):
         return telegrams
 
     def _build_ack_nak_response_telegram(self, ack_or_nak: bool) -> str:
-        """Build a complete ACK or NAK response telegram with checksum.
+        """
+        Build a complete ACK or NAK response telegram with checksum.
 
         Args:
             ack_or_nak: true: ACK telegram response, false: NAK telegram response.
@@ -168,7 +171,8 @@ class XP33ServerService(BaseServerService):
     def _build_dimming_event_telegram(
         self, dimming_level: int, channel_number: int
     ) -> str:
-        """Build a complete dimming event telegram with checksum.
+        """
+        Build a complete dimming event telegram with checksum.
 
         Args:
             dimming_level: Dimming level 0-100%.
@@ -239,7 +243,8 @@ class XP33ServerService(BaseServerService):
         return telegram
 
     def _handle_read_module_output_state(self) -> str:
-        """Handle XP33-specific module output state.
+        """
+        Handle XP33-specific module output state.
 
         Returns:
             String representation of the output state for 3 channels.
@@ -252,7 +257,8 @@ class XP33ServerService(BaseServerService):
         )
 
     def _handle_read_module_state(self) -> str:
-        """Handle XP33-specific module state.
+        """
+        Handle XP33-specific module state.
 
         Returns:
             'ON' if any channel is active, 'OFF' otherwise.
@@ -262,7 +268,8 @@ class XP33ServerService(BaseServerService):
         return "OFF"
 
     def _handle_read_module_operating_hours(self) -> str:
-        """Handle XP33-specific module operating hours.
+        """
+        Handle XP33-specific module operating hours.
 
         Returns:
             Operating hours for all 3 channels.
@@ -270,7 +277,8 @@ class XP33ServerService(BaseServerService):
         return "00:000[H],01:000[H],02:000[H]"
 
     def _handle_read_light_level(self) -> str:
-        """Handle XP33-specific light level reading.
+        """
+        Handle XP33-specific light level reading.
 
         Returns:
             Light levels for all channels in format "00:000[%],01:000[%],02:000[%]".
@@ -281,7 +289,8 @@ class XP33ServerService(BaseServerService):
         return ",".join(levels)
 
     def _trigger_storm_mode(self) -> Optional[str]:
-        """Trigger storm mode via D99 query.
+        """
+        Trigger storm mode via D99 query.
 
         Starts a background thread that sends 2 packets per second.
         If storm is already active, this is a no-op.
@@ -322,7 +331,8 @@ class XP33ServerService(BaseServerService):
         return None  # No response when entering storm mode
 
     def _exit_storm_mode(self) -> str:
-        """Exit storm mode and return error code FE.
+        """
+        Exit storm mode and return error code FE.
 
         Stops the background storm thread and returns error code.
 
@@ -350,7 +360,8 @@ class XP33ServerService(BaseServerService):
         return self._build_error_code_response("FE")
 
     def _storm_sender_thread(self) -> None:
-        """Background thread that sends storm telegrams continuously.
+        """
+        Background thread that sends storm telegrams continuously.
 
         Sends 2 packets per second (500ms delay) until:
         - 200 packets have been sent, or
@@ -412,7 +423,8 @@ class XP33ServerService(BaseServerService):
             self.storm_mode = False
 
     def _build_error_code_response(self, error_code: str) -> str:
-        """Build MODULE_ERROR_CODE response telegram.
+        """
+        Build MODULE_ERROR_CODE response telegram.
 
         Args:
             error_code: Error code (00 = normal, FE = buffer overflow).
@@ -432,7 +444,8 @@ class XP33ServerService(BaseServerService):
         return telegram
 
     def set_channel_dimming(self, channel: int, level: int) -> bool:
-        """Set individual channel dimming level.
+        """
+        Set individual channel dimming level.
 
         Args:
             channel: Channel number (1-3).
@@ -448,7 +461,8 @@ class XP33ServerService(BaseServerService):
         return False
 
     def activate_scene(self, scene: int) -> bool:
-        """Activate a pre-programmed scene.
+        """
+        Activate a pre-programmed scene.
 
         Args:
             scene: Scene number (1-4).
@@ -463,7 +477,8 @@ class XP33ServerService(BaseServerService):
         return False
 
     def _get_msactiontable_serializer(self) -> Optional[Xp33MsActionTableSerializer]:
-        """Get the MsActionTable serializer for XP33.
+        """
+        Get the MsActionTable serializer for XP33.
 
         Returns:
             The XP33 MsActionTable serializer instance.
@@ -471,7 +486,8 @@ class XP33ServerService(BaseServerService):
         return self.msactiontable_serializer
 
     def _get_msactiontable(self) -> Optional[Xp33MsActionTable]:
-        """Get the MsActionTable for XP33.
+        """
+        Get the MsActionTable for XP33.
 
         Returns:
             The XP33 MsActionTable instance.
@@ -479,7 +495,8 @@ class XP33ServerService(BaseServerService):
         return self.msactiontable
 
     def _get_default_msactiontable(self) -> Xp33MsActionTable:
-        """Generate default MsActionTable configuration.
+        """
+        Generate default MsActionTable configuration.
 
         Returns:
             Default XP33 MsActionTable with all outputs at 0-100% range, no scenes configured.
@@ -488,7 +505,8 @@ class XP33ServerService(BaseServerService):
         return Xp33MsActionTable()
 
     def get_device_info(self) -> Dict:
-        """Get XP33 device information.
+        """
+        Get XP33 device information.
 
         Returns:
             Dictionary containing device information.
@@ -508,7 +526,8 @@ class XP33ServerService(BaseServerService):
         }
 
     def get_technical_specs(self) -> Dict:
-        """Get technical specifications.
+        """
+        Get technical specifications.
 
         Returns:
             Dictionary containing technical specifications.

xp/services/telegram/telegram_blink_service.py

@@ -1,7 +1,8 @@
-"""Service for blink/unblink telegram operations.
+"""
+Service for blink/unblink telegram operations.
 
-This service handles generation and parsing of blink/unblink system telegrams
-used for controlling module LED status.
+This service handles generation and parsing of blink/unblink system telegrams used for
+controlling module LED status.
 """
 
 from xp.models.telegram.reply_telegram import ReplyTelegram
@@ -31,7 +32,8 @@ class TelegramBlinkService:
 
     @staticmethod
     def generate_blink_telegram(serial_number: str, on_or_off: str) -> str:
-        """Generate a telegram to start blinking a module's LED.
+        """
+        Generate a telegram to start blinking a module's LED.
 
         Args:
             serial_number: The 10-digit module serial number.
@@ -66,7 +68,8 @@ class TelegramBlinkService:
         return telegram
 
     def create_blink_telegram_object(self, serial_number: str) -> SystemTelegram:
-        """Create a SystemTelegram object for blinking LED.
+        """
+        Create a SystemTelegram object for blinking LED.
 
         Args:
             serial_number: The 10-digit module serial number.
@@ -90,7 +93,8 @@ class TelegramBlinkService:
         return telegram
 
     def create_unblink_telegram_object(self, serial_number: str) -> SystemTelegram:
-        """Create a SystemTelegram object for unblink LED.
+        """
+        Create a SystemTelegram object for unblink LED.
 
         Args:
             serial_number: The 10-digit module serial number.
@@ -115,7 +119,8 @@ class TelegramBlinkService:
 
     @staticmethod
     def is_ack_response(reply_telegram: ReplyTelegram) -> bool:
-        """Check if a reply telegram is an ACK response.
+        """
+        Check if a reply telegram is an ACK response.
 
         Args:
             reply_telegram: Reply telegram to check.
@@ -127,7 +132,8 @@ class TelegramBlinkService:
 
     @staticmethod
     def is_nak_response(reply_telegram: ReplyTelegram) -> bool:
-        """Check if a reply telegram is a NAK response.
+        """
+        Check if a reply telegram is a NAK response.
 
         Args:
             reply_telegram: Reply telegram to check.

xp/services/telegram/telegram_checksum_service.py

@@ -1,7 +1,8 @@
-"""Checksum service for telegram protocol validation and generation.
+"""
+Checksum service for telegram protocol validation and generation.
 
-This service provides business logic for checksum operations,
-following the layered architecture pattern.
+This service provides business logic for checksum operations, following the layered
+architecture pattern.
 """
 
 from typing import Union
@@ -19,7 +20,8 @@ class TelegramChecksumService:
 
     @staticmethod
     def calculate_simple_checksum(data: str) -> Response:
-        """Calculate simple XOR checksum for string data.
+        """
+        Calculate simple XOR checksum for string data.
 
         Args:
             data: String data to calculate checksum for.
@@ -42,7 +44,8 @@ class TelegramChecksumService:
 
     @staticmethod
     def calculate_crc32_checksum(data: Union[str, bytes]) -> Response:
-        """Calculate CRC32 checksum for data.
+        """
+        Calculate CRC32 checksum for data.
 
         Args:
             data: String or bytes data to calculate checksum for.
@@ -79,7 +82,8 @@ class TelegramChecksumService:
 
     @staticmethod
     def validate_checksum(data: str, expected_checksum: str) -> Response:
-        """Validate data against expected simple checksum.
+        """
+        Validate data against expected simple checksum.
 
         Args:
             data: Original data.
@@ -111,7 +115,8 @@ class TelegramChecksumService:
     def validate_crc32_checksum(
         data: Union[str, bytes], expected_checksum: str
     ) -> Response:
-        """Validate data against expected CRC32 checksum.
+        """
+        Validate data against expected CRC32 checksum.
 
         Args:
             data: Original data (string or bytes).

xp/services/telegram/telegram_datapoint_service.py

@@ -2,15 +2,16 @@
 
 
 class TelegramDatapointService:
-    """Service for processing Telegram protocol datapoint values.
+    """
+    Service for processing Telegram protocol datapoint values.
 
-    Provides methods to parse and extract values from different types of
-    Telegram datapoints including autoreport status, light level outputs,
-    and link number values.
+    Provides methods to parse and extract values from different types of Telegram
+    datapoints including autoreport status, light level outputs, and link number values.
     """
 
     def get_autoreport_status(self, data_value: str) -> bool:
-        """Get the autoreport status value.
+        """
+        Get the autoreport status value.
 
         Args:
             data_value: The raw autoreport status data value (PP or AA).
@@ -22,7 +23,8 @@ class TelegramDatapointService:
         return status_value
 
     def get_autoreport_status_data_value(self, status_value: bool) -> str:
-        """Get the autoreport status data_value.
+        """
+        Get the autoreport status data_value.
 
         Args:
             status_value: Enable (True) or disable (False).
@@ -34,7 +36,8 @@ class TelegramDatapointService:
         return data_value
 
     def get_lightlevel(self, data_value: str, output_number: int) -> int:
-        """Extract the light level for a specific output number.
+        """
+        Extract the light level for a specific output number.
 
         Parses comma-separated output data in the format "output:level[%]"
         and returns the level for the requested output number.
@@ -58,7 +61,8 @@ class TelegramDatapointService:
         return level
 
     def get_linknumber(self, data_value: str) -> int:
-        """Parse and return the link number value.
+        """
+        Parse and return the link number value.
 
         Args:
             data_value: The raw link number data value as a string.
@@ -70,7 +74,8 @@ class TelegramDatapointService:
         return link_number_value
 
     def get_modulenumber(self, data_value: str) -> int:
-        """Parse and return the module number value.
+        """
+        Parse and return the module number value.
 
         Args:
             data_value: The raw module number data value as a string.

xp/services/telegram/telegram_discover_service.py

@@ -1,7 +1,8 @@
-"""Service for device discover telegram operations.
+"""
+Service for device discover telegram operations.
 
-This service handles generation and parsing of device discover system telegrams
-used for enumerating all connected devices on the console bus.
+This service handles generation and parsing of device discover system telegrams used for
+enumerating all connected devices on the console bus.
 """
 
 from typing import List, Set
@@ -24,7 +25,8 @@ class DeviceInfo:
     def __init__(
         self, serial_number: str, checksum_valid: bool = True, raw_telegram: str = ""
     ):
-        """Initialize device info.
+        """
+        Initialize device info.
 
         Args:
             serial_number: 10-digit module serial number.
@@ -36,7 +38,8 @@ class DeviceInfo:
         self.raw_telegram = raw_telegram
 
     def __str__(self) -> str:
-        """Return string representation of device.
+        """
+        Return string representation of device.
 
         Returns:
             String with serial number and checksum status.
@@ -45,7 +48,8 @@ class DeviceInfo:
         return f"Device {self.serial_number} ({status})"
 
     def __repr__(self) -> str:
-        """Return repr representation of device.
+        """
+        Return repr representation of device.
 
         Returns:
             DeviceInfo constructor representation.
@@ -53,7 +57,8 @@ class DeviceInfo:
         return f"DeviceInfo(serial='{self.serial_number}', checksum_valid={self.checksum_valid})"
 
     def to_dict(self) -> dict:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary with device information.
@@ -99,7 +104,8 @@ class TelegramDiscoverService:
         return telegram
 
     def create_discover_telegram_object(self) -> SystemTelegram:
-        """Create a SystemTelegram object for discover broadcast.
+        """
+        Create a SystemTelegram object for discover broadcast.
 
         Returns:
             SystemTelegram object representing the discover command.
@@ -121,7 +127,8 @@ class TelegramDiscoverService:
 
     @staticmethod
     def is_discover_response(reply_telegram: ReplyTelegram) -> bool:
-        """Check if a reply telegram is a discover response.
+        """
+        Check if a reply telegram is a discover response.
 
         Args:
             reply_telegram: Reply telegram to check.
@@ -133,7 +140,8 @@ class TelegramDiscoverService:
 
     @staticmethod
     def _generate_discover_response(serial_number: str) -> str:
-        """Generate discover response telegram for a device.
+        """
+        Generate discover response telegram for a device.
 
         Args:
             serial_number: 10-digit module serial number.
@@ -149,7 +157,8 @@ class TelegramDiscoverService:
 
     @staticmethod
     def get_unique_devices(devices: List[DeviceInfo]) -> List[DeviceInfo]:
-        """Filter out duplicate devices based on serial number.
+        """
+        Filter out duplicate devices based on serial number.
 
         Args:
             devices: List of discovered devices.
@@ -169,7 +178,8 @@ class TelegramDiscoverService:
 
     @staticmethod
     def validate_discover_response_format(raw_telegram: str) -> bool:
-        """Validate if a raw telegram matches discover response format.
+        """
+        Validate if a raw telegram matches discover response format.
 
         Args:
             raw_telegram: Raw telegram string to validate.
@@ -187,7 +197,8 @@ class TelegramDiscoverService:
         return match is not None
 
     def generate_discover_summary(self, devices: List[DeviceInfo]) -> dict:
-        """Generate a summary of a discover results.
+        """
+        Generate a summary of a discover results.
 
         Args:
             devices: List of discovered devices.
@@ -223,7 +234,8 @@ class TelegramDiscoverService:
         }
 
     def format_discover_results(self, devices: List[DeviceInfo]) -> str:
-        """Format discover results for human-readable output.
+        """
+        Format discover results for human-readable output.
 
         Args:
             devices: List of discovered devices.
@@ -263,7 +275,8 @@ class TelegramDiscoverService:
 
     @staticmethod
     def is_discover_request(telegram: SystemTelegram) -> bool:
-        """Check if telegram is a discover request.
+        """
+        Check if telegram is a discover request.
 
         Args:
             telegram: System telegram to check.