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

xp/services/homekit/homekit_outlet_service.py

@@ -1,4 +1,5 @@
-"""HomeKit Outlet Service.
+"""
+HomeKit Outlet Service.
 
 This module provides service implementation for outlet accessories.
 """
@@ -18,7 +19,8 @@ from xp.models.telegram.datapoint_type import DataPointType
 
 
 class HomeKitOutletService:
-    """Outlet service for HomeKit.
+    """
+    Outlet service for HomeKit.
 
     Attributes:
         event_bus: Event bus for inter-service communication.
@@ -28,7 +30,8 @@ class HomeKitOutletService:
     event_bus: EventBus
 
     def __init__(self, event_bus: EventBus):
-        """Initialize the outlet service.
+        """
+        Initialize the outlet service.
 
         Args:
             event_bus: Event bus instance.
@@ -42,7 +45,8 @@ class HomeKitOutletService:
         self.event_bus.on(OutletGetInUseEvent, self.handle_outlet_get_in_use)
 
     def handle_outlet_get_on(self, event: OutletGetOnEvent) -> bool:
-        """Handle outlet get on event.
+        """
+        Handle outlet get on event.
 
         Args:
             event: Outlet get on event.
@@ -65,7 +69,8 @@ class HomeKitOutletService:
         return True
 
     def handle_outlet_set_on(self, event: OutletSetOnEvent) -> bool:
-        """Handle outlet set on event.
+        """
+        Handle outlet set on event.
 
         Args:
             event: Outlet set on event.
@@ -97,7 +102,8 @@ class HomeKitOutletService:
         return True
 
     def handle_outlet_get_in_use(self, event: OutletGetInUseEvent) -> bool:
-        """Handle outlet get in-use event.
+        """
+        Handle outlet get in-use event.
 
         Args:
             event: Outlet get in-use event.

xp/services/homekit/homekit_service.py

@@ -1,4 +1,5 @@
-"""HomeKit Service for Apple HomeKit integration.
+"""
+HomeKit Service for Apple HomeKit integration.
 
 This module provides the main service for HomeKit integration.
 """
@@ -34,7 +35,8 @@ from xp.services.protocol.protocol_factory import TelegramFactory
 
 
 class HomeKitService:
-    """Main HomeKit service for Apple HomeKit integration.
+    """
+    Main HomeKit service for Apple HomeKit integration.
 
     Attributes:
         cli_config: Conbus client configuration.
@@ -66,7 +68,8 @@ class HomeKitService:
         module_factory: HomekitHapService,
         telegram_service: TelegramService,
     ):
-        """Initialize the HomeKit service.
+        """
+        Initialize the HomeKit service.
 
         Args:
             cli_config: Conbus client configuration.
@@ -142,7 +145,8 @@ class HomeKitService:
         self.reactor.run()
 
     def _start_module_factory(self) -> None:
-        """Start module factory after reactor starts.
+        """
+        Start module factory after reactor starts.
 
         Creates and schedules an async task to start the HAP service.
         """
@@ -181,7 +185,8 @@ class HomeKitService:
         event.protocol.sendFrame(b"S0000000000F01D00")
 
     def handle_connection_failed(self, event: ConnectionFailedEvent) -> None:
-        """Handle connection failed.
+        """
+        Handle connection failed.
 
         Args:
             event: Connection failed event.
@@ -189,7 +194,8 @@ class HomeKitService:
         self.logger.error(f"Connection failed: {event.reason}")
 
     def handle_connection_lost(self, event: ConnectionLostEvent) -> None:
-        """Handle connection lost.
+        """
+        Handle connection lost.
 
         Args:
             event: Connection lost event.
@@ -199,7 +205,8 @@ class HomeKitService:
         )
 
     def handle_telegram_received(self, event: TelegramReceivedEvent) -> str:
-        """Handle received telegram events.
+        """
+        Handle received telegram events.
 
         Args:
             event: Telegram received event.
@@ -236,7 +243,8 @@ class HomeKitService:
         return event.frame
 
     def dispatch_light_level_event(self, event: TelegramReceivedEvent) -> None:
-        """Dispatch light level received event.
+        """
+        Dispatch light level received event.
 
         Args:
             event: Telegram received event.
@@ -260,7 +268,8 @@ class HomeKitService:
         self.logger.debug("LightLevelReceivedEvent dispatched successfully")
 
     def dispatch_output_state_event(self, event: TelegramReceivedEvent) -> None:
-        """Dispatch output state received event.
+        """
+        Dispatch output state received event.
 
         Args:
             event: Telegram received event.
@@ -286,7 +295,8 @@ class HomeKitService:
     def dispatch_event_telegram_received_event(
         self, event: TelegramReceivedEvent
     ) -> None:
-        """Dispatch event telegram received event.
+        """
+        Dispatch event telegram received event.
 
         Args:
             event: Telegram received event.
@@ -319,7 +329,8 @@ class HomeKitService:
         self.logger.debug("ModuleStateChangedEvent dispatched successfully")
 
     def dispatch_module_discovered_event(self, event: TelegramReceivedEvent) -> None:
-        """Dispatch module discovered event.
+        """
+        Dispatch module discovered event.
 
         Args:
             event: Telegram received event.
@@ -339,7 +350,8 @@ class HomeKitService:
         self.logger.debug("ModuleDiscoveredEvent dispatched successfully")
 
     def handle_module_discovered(self, event: ModuleDiscoveredEvent) -> str:
-        """Handle module discovered event.
+        """
+        Handle module discovered event.
 
         Args:
             event: Module discovered event.

xp/services/log_file_service.py

@@ -38,7 +38,8 @@ class LogFileService:
     )
 
     def __init__(self, telegram_service: TelegramService):
-        """Initialize the log file service.
+        """
+        Initialize the log file service.
 
         Args:
             telegram_service: Telegram service for parsing telegrams.
@@ -48,7 +49,8 @@ class LogFileService:
     def parse_log_file(
         self, file_path: str, base_date: Optional[datetime] = None
     ) -> List[LogEntry]:
-        """Parse a console bus log file into LogEntry objects.
+        """
+        Parse a console bus log file into LogEntry objects.
 
         Args:
             file_path: Path to the log file.
@@ -79,7 +81,8 @@ class LogFileService:
     def parse_log_lines(
         self, lines: List[str], base_date: Optional[datetime] = None
     ) -> List[LogEntry]:
-        """Parse log lines into LogEntry objects.
+        """
+        Parse log lines into LogEntry objects.
 
         Args:
             lines: List of log lines to parse.
@@ -115,7 +118,8 @@ class LogFileService:
     def _parse_log_line(
         self, line: str, line_number: int, base_date: Optional[datetime] = None
     ) -> Optional[LogEntry]:
-        """Parse a single log line into a LogEntry.
+        """
+        Parse a single log line into a LogEntry.
 
         Args:
             line: Log line to parse.
@@ -157,7 +161,8 @@ class LogFileService:
         return entry
 
     def validate_log_format(self, file_path: str) -> bool:
-        """Validate that a file follows the expected log format.
+        """
+        Validate that a file follows the expected log format.
 
         Args:
             file_path: Path to the log file.
@@ -174,7 +179,8 @@ class LogFileService:
             return False
 
     def extract_telegrams(self, file_path: str) -> List[str]:
-        """Extract all telegram strings from a log file.
+        """
+        Extract all telegram strings from a log file.
 
         Args:
             file_path: Path to the log file.
@@ -187,7 +193,8 @@ class LogFileService:
 
     @staticmethod
     def get_file_statistics(entries: List[LogEntry]) -> Dict[str, Any]:
-        """Generate statistics for a list of log entries.
+        """
+        Generate statistics for a list of log entries.
 
         Args:
             entries: List of LogEntry objects.
@@ -280,7 +287,8 @@ class LogFileService:
         start_time: Optional[datetime] = None,
         end_time: Optional[datetime] = None,
     ) -> List[LogEntry]:
-        """Filter log entries based on criteria.
+        """
+        Filter log entries based on criteria.
 
         Args:
             entries: List of LogEntry objects to filter.

xp/services/module_type_service.py

@@ -1,6 +1,8 @@
-"""Module Type Service for XP module management.
+"""
+Module Type Service for XP module management.
 
-This module provides lookup, validation, and search functionality for XP system module types.
+This module provides lookup, validation, and search functionality for XP system module
+types.
 """
 
 from typing import Dict, List, Optional, Union
@@ -199,7 +201,8 @@ class ModuleTypeService:
 
     @staticmethod
     def _format_module_summary(module_type: ModuleType) -> str:
-        """Format a single module type for display.
+        """
+        Format a single module type for display.
 
         Args:
             module_type: The module type to format.
@@ -226,7 +229,8 @@ class ModuleTypeService:
 
     @staticmethod
     def _format_all_modules() -> str:
-        """Format all modules in a simple list.
+        """
+        Format all modules in a simple list.
 
         Returns:
             Formatted string with all modules.
@@ -241,7 +245,8 @@ class ModuleTypeService:
 
     @staticmethod
     def _format_modules_by_category() -> str:
-        """Format modules grouped by category.
+        """
+        Format modules grouped by category.
 
         Returns:
             Formatted string with modules grouped by category.

xp/services/protocol/conbus_event_protocol.py

@@ -1,4 +1,5 @@
-"""Conbus Event Protocol for XP telegram communication.
+"""
+Conbus Event Protocol for XP telegram communication.
 
 This module implements the Twisted protocol for Conbus communication.
 """
@@ -34,7 +35,8 @@ CHUNK_HEADER_LENGTH = 2  # data_value format: 2-char counter + actiontable chunk
 
 
 class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
-    """Twisted protocol for XP telegram communication.
+    """
+    Twisted protocol for XP telegram communication.
 
     Attributes:
         buffer: Buffer for incoming telegram data.
@@ -95,7 +97,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
         reactor: PosixReactorBase,
         telegram_service: TelegramService,
     ) -> None:
-        """Initialize ConbusProtocol.
+        """
+        Initialize ConbusProtocol.
 
         Args:
             cli_config: Configuration for Conbus client connection.
@@ -111,10 +114,11 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
         self.telegram_service = telegram_service
 
     def connectionMade(self) -> None:
-        """Handle connection established event.
+        """
+        Handle connection established event.
 
-        Called when TCP connection is successfully established.
-        Starts inactivity timeout monitoring.
+        Called when TCP connection is successfully established. Starts inactivity
+        timeout monitoring.
         """
         self.logger.debug("connectionMade")
         self.on_connection_made.emit()
@@ -123,7 +127,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
         self._reset_timeout()
 
     def wait(self, wait_timeout: Optional[float] = None) -> None:
-        """Wait for incoming telegrams with optional timeout override.
+        """
+        Wait for incoming telegrams with optional timeout override.
 
         Args:
             wait_timeout: Optional timeout in seconds to override default.
@@ -133,7 +138,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
         self._reset_timeout()
 
     def dataReceived(self, data: bytes) -> None:
-        """Handle received data from TCP connection.
+        """
+        Handle received data from TCP connection.
 
         Parses incoming telegram frames and dispatches events.
 
@@ -193,7 +199,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
             self.emit_telegram_received(telegram_received)
 
     def emit_telegram_received(self, telegram_received: TelegramReceivedEvent) -> None:
-        """Handle telegram received event.
+        """
+        Handle telegram received event.
 
         Args:
             telegram_received: The telegram received event.
@@ -232,7 +239,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
             return
 
     def sendFrame(self, data: bytes) -> None:
-        """Send telegram frame.
+        """
+        Send telegram frame.
 
         Args:
             data: Raw telegram payload (without checksum/framing).
@@ -261,7 +269,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
         system_function: SystemFunction,
         data_value: str,
     ) -> None:
-        """Send telegram with specified parameters.
+        """
+        Send telegram with specified parameters.
 
         Args:
             telegram_type: Type of telegram to send.
@@ -280,7 +289,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
     def send_event_telegram(
         self, module_type_code: ModuleTypeCode, link_number: int, input_number: int
     ) -> None:
-        """Send telegram with specified parameters.
+        """
+        Send telegram with specified parameters.
 
         Args:
             module_type_code: Type code of module.
@@ -293,7 +303,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
         self.send_raw_telegram(payload)
 
     def send_raw_telegram(self, payload: str) -> None:
-        """Send telegram with specified parameters.
+        """
+        Send telegram with specified parameters.
 
         Args:
             payload: Telegram to send.
@@ -302,7 +313,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
         self.call_later(0.0, self.start_queue_manager)
 
     def send_error_status_query(self, serial_number: str) -> None:
-        """Send error status query telegram.
+        """
+        Send error status query telegram.
 
         Args:
             serial_number: Device serial number.
@@ -314,21 +326,26 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
             data_value=DataPointType.MODULE_ERROR_CODE.value,
         )
 
-    def send_download_request(self, serial_number: str) -> None:
-        """Send download request telegram.
+    def send_download_request(
+        self, serial_number: str, actiontable_type: SystemFunction
+    ) -> None:
+        """
+        Send download request telegram.
 
         Args:
             serial_number: Device serial number.
+            actiontable_type: DOWNLOAD_ACTIONTABLE or DOWNLOAD_MSACTIONTABLE.
         """
         self.send_telegram(
             telegram_type=TelegramType.SYSTEM,
             serial_number=serial_number,
-            system_function=SystemFunction.DOWNLOAD_ACTIONTABLE,
+            system_function=actiontable_type,
             data_value=NO_ERROR_CODE,
         )
 
     def send_ack(self, serial_number: str) -> None:
-        """Send ACK telegram.
+        """
+        Send ACK telegram.
 
         Args:
             serial_number: Device serial number.
@@ -347,7 +364,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
         *args: object,
         **kw: object,
     ) -> DelayedCall:
-        """Schedule a callable to be called later.
+        """
+        Schedule a callable to be called later.
 
         Args:
             delay: Delay in seconds before calling.
@@ -361,7 +379,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
         return self._reactor.callLater(delay, callable_action, *args, **kw)
 
     def buildProtocol(self, addr: IAddress) -> protocol.Protocol:
-        """Build protocol instance for connection.
+        """
+        Build protocol instance for connection.
 
         Args:
             addr: Address of the connection.
@@ -373,7 +392,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
         return self
 
     def clientConnectionFailed(self, connector: IConnector, reason: Failure) -> None:
-        """Handle client connection failure.
+        """
+        Handle client connection failure.
 
         Args:
             connector: Connection connector instance.
@@ -385,7 +405,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
         self._cancel_timeout()
 
     def clientConnectionLost(self, connector: IConnector, reason: Failure) -> None:
-        """Handle client connection lost event.
+        """
+        Handle client connection lost event.
 
         Args:
             connector: Connection connector instance.
@@ -401,7 +422,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
         self.on_timeout.emit()
 
     def connection_failed(self, reason: Failure) -> None:
-        """Handle connection failure.
+        """
+        Handle connection failure.
 
         Args:
             reason: Failure reason details.
@@ -436,7 +458,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
             self.logger.debug(f"Reactor stop failed (likely already stopped): {e}")
 
     def connect(self) -> None:
-        """Connect to TCP server.
+        """
+        Connect to TCP server.
 
         Automatically detects and integrates with running asyncio event loop if present.
         """
@@ -494,7 +517,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
         self.call_later(later, self.process_telegram_queue)
 
     def set_event_loop(self, event_loop: asyncio.AbstractEventLoop) -> None:
-        """Change the event loop.
+        """
+        Change the event loop.
 
         Args:
             event_loop: the event loop instance.
@@ -511,7 +535,8 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
             self.logger.info("Set reactor to running state")
 
     def __enter__(self) -> "ConbusEventProtocol":
-        """Enter context manager.
+        """
+        Enter context manager.
 
         Returns:
             Self for context management.

xp/services/protocol/conbus_protocol.py

@@ -1,4 +1,5 @@
-"""Conbus Protocol for XP telegram communication.
+"""
+Conbus Protocol for XP telegram communication.
 
 This module implements the Twisted protocol for Conbus communication.
 """
@@ -22,7 +23,8 @@ from xp.utils import calculate_checksum
 
 
 class ConbusProtocol(protocol.Protocol, protocol.ClientFactory):
-    """Twisted protocol for XP telegram communication.
+    """
+    Twisted protocol for XP telegram communication.
 
     Attributes:
         buffer: Buffer for incoming telegram data.
@@ -40,7 +42,8 @@ class ConbusProtocol(protocol.Protocol, protocol.ClientFactory):
         cli_config: ConbusClientConfig,
         reactor: PosixReactorBase,
     ) -> None:
-        """Initialize ConbusProtocol.
+        """
+        Initialize ConbusProtocol.
 
         Args:
             cli_config: Configuration for Conbus client connection.
@@ -54,10 +57,11 @@ class ConbusProtocol(protocol.Protocol, protocol.ClientFactory):
         self.timeout_call: Optional[DelayedCall] = None
 
     def connectionMade(self) -> None:
-        """Handle connection established event.
+        """
+        Handle connection established event.
 
-        Called when TCP connection is successfully established.
-        Starts inactivity timeout monitoring.
+        Called when TCP connection is successfully established. Starts inactivity
+        timeout monitoring.
         """
         self.logger.debug("connectionMade")
         self.connection_established()
@@ -65,7 +69,8 @@ class ConbusProtocol(protocol.Protocol, protocol.ClientFactory):
         self._reset_timeout()
 
     def dataReceived(self, data: bytes) -> None:
-        """Handle received data from TCP connection.
+        """
+        Handle received data from TCP connection.
 
         Parses incoming telegram frames and dispatches events.
 
@@ -124,7 +129,8 @@ class ConbusProtocol(protocol.Protocol, protocol.ClientFactory):
             self.telegram_received(telegram_received)
 
     def sendFrame(self, data: bytes) -> None:
-        """Send telegram frame.
+        """
+        Send telegram frame.
 
         Args:
             data: Raw telegram payload (without checksum/framing).
@@ -153,7 +159,8 @@ class ConbusProtocol(protocol.Protocol, protocol.ClientFactory):
         system_function: SystemFunction,
         data_value: str,
     ) -> None:
-        """Send telegram with specified parameters.
+        """
+        Send telegram with specified parameters.
 
         Args:
             telegram_type: Type of telegram to send.
@@ -170,7 +177,8 @@ class ConbusProtocol(protocol.Protocol, protocol.ClientFactory):
         self.sendFrame(payload.encode())
 
     def buildProtocol(self, addr: IAddress) -> protocol.Protocol:
-        """Build protocol instance for connection.
+        """
+        Build protocol instance for connection.
 
         Args:
             addr: Address of the connection.
@@ -182,7 +190,8 @@ class ConbusProtocol(protocol.Protocol, protocol.ClientFactory):
         return self
 
     def clientConnectionFailed(self, connector: IConnector, reason: Failure) -> None:
-        """Handle client connection failure.
+        """
+        Handle client connection failure.
 
         Args:
             connector: Connection connector instance.
@@ -194,7 +203,8 @@ class ConbusProtocol(protocol.Protocol, protocol.ClientFactory):
         self._stop_reactor()
 
     def clientConnectionLost(self, connector: IConnector, reason: Failure) -> None:
-        """Handle client connection lost event.
+        """
+        Handle client connection lost event.
 
         Args:
             connector: Connection connector instance.
@@ -206,7 +216,8 @@ class ConbusProtocol(protocol.Protocol, protocol.ClientFactory):
         self._stop_reactor()
 
     def timeout(self) -> bool:
-        """Handle timeout event.
+        """
+        Handle timeout event.
 
         Returns:
             True to continue waiting for next timeout, False to stop.
@@ -216,7 +227,8 @@ class ConbusProtocol(protocol.Protocol, protocol.ClientFactory):
         return False
 
     def connection_failed(self, reason: Failure) -> None:
-        """Handle connection failure.
+        """
+        Handle connection failure.
 
         Args:
             reason: Failure reason details.
@@ -262,7 +274,8 @@ class ConbusProtocol(protocol.Protocol, protocol.ClientFactory):
         self.reactor.run()
 
     def __enter__(self) -> "ConbusProtocol":
-        """Enter context manager.
+        """
+        Enter context manager.
 
         Returns:
             Self for context management.
@@ -282,7 +295,8 @@ class ConbusProtocol(protocol.Protocol, protocol.ClientFactory):
     """Override methods."""
 
     def telegram_sent(self, telegram_sent: str) -> None:
-        """Override callback when telegram has been sent.
+        """
+        Override callback when telegram has been sent.
 
         Args:
             telegram_sent: The telegram that was sent.
@@ -290,7 +304,8 @@ class ConbusProtocol(protocol.Protocol, protocol.ClientFactory):
         pass
 
     def telegram_received(self, telegram_received: TelegramReceivedEvent) -> None:
-        """Override callback when telegram is received.
+        """
+        Override callback when telegram is received.
 
         Args:
             telegram_received: Event containing received telegram details.
@@ -302,7 +317,8 @@ class ConbusProtocol(protocol.Protocol, protocol.ClientFactory):
         pass
 
     def connection_lost(self, reason: Failure) -> None:
-        """Override callback when connection is lost.
+        """
+        Override callback when connection is lost.
 
         Args:
             reason: Reason for connection loss.
@@ -310,7 +326,8 @@ class ConbusProtocol(protocol.Protocol, protocol.ClientFactory):
         pass
 
     def failed(self, message: str) -> None:
-        """Override callback when connection failed.
+        """
+        Override callback when connection failed.
 
         Args:
             message: Error message describing the failure.