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

xp/models/conbus/conbus_event_raw.py

@@ -7,7 +7,8 @@ from typing import Any, Dict, Optional
 
 @dataclass
 class ConbusEventRawResponse:
-    """Represents a response from Conbus event raw operation.
+    """
+    Represents a response from Conbus event raw operation.
 
     Attributes:
         success: Whether the operation was successful.
@@ -33,7 +34,8 @@ class ConbusEventRawResponse:
             self.received_telegrams = []
 
     def to_dict(self) -> Dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the response.

xp/models/conbus/conbus_export.py

@@ -8,7 +8,8 @@ from xp.models.config.conson_module_config import ConsonModuleListConfig
 
 @dataclass
 class ConbusExportResponse:
-    """Response from Conbus export operation.
+    """
+    Response from Conbus export operation.
 
     Attributes:
         success: Whether the operation was successful.

xp/models/conbus/conbus_lightlevel.py

@@ -7,7 +7,8 @@ from typing import Any, Dict, Optional
 
 @dataclass
 class ConbusLightlevelResponse:
-    """Represents a response from Conbus lightlevel operation.
+    """
+    Represents a response from Conbus lightlevel operation.
 
     Attributes:
         success: Whether the operation was successful.
@@ -35,7 +36,8 @@ class ConbusLightlevelResponse:
             self.received_telegrams = []
 
     def to_dict(self) -> Dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the response.

xp/models/conbus/conbus_linknumber.py

@@ -7,7 +7,8 @@ from typing import Any, Dict, Optional
 
 @dataclass
 class ConbusLinknumberResponse:
-    """Represents a response from Conbus link number operations (set/get).
+    """
+    Represents a response from Conbus link number operations (set/get).
 
     Attributes:
         success: Whether the operation was successful.
@@ -37,7 +38,8 @@ class ConbusLinknumberResponse:
             self.received_telegrams = []
 
     def to_dict(self) -> Dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the response.

xp/models/conbus/conbus_logger_config.py

@@ -9,7 +9,8 @@ from pydantic import BaseModel, Field, field_validator
 
 
 class LoggingConfig(BaseModel):
-    """Logging configuration.
+    """
+    Logging configuration.
 
     Attributes:
         path: log folder.
@@ -38,7 +39,8 @@ class LoggingConfig(BaseModel):
     @field_validator("levels", mode="before")
     @classmethod
     def convert_level_names(cls, v: Dict[str, Union[str, int]]) -> Dict[str, int]:
-        """Convert string level names to numeric values.
+        """
+        Convert string level names to numeric values.
 
         Args:
             v: Dictionary with string or int log levels.
@@ -73,7 +75,8 @@ class LoggingConfig(BaseModel):
 
 
 class ConbusLoggerConfig(BaseModel):
-    """Logging configuration.
+    """
+    Logging configuration.
 
     Attributes:
         log: LoggingConfig instance for logging settings.
@@ -83,7 +86,8 @@ class ConbusLoggerConfig(BaseModel):
 
     @classmethod
     def from_yaml(cls, file_path: str) -> "ConbusLoggerConfig":
-        """Load configuration from YAML file.
+        """
+        Load configuration from YAML file.
 
         Args:
             file_path: Path to the YAML configuration file.

xp/models/conbus/conbus_output.py

@@ -11,7 +11,8 @@ from xp.models.telegram.reply_telegram import ReplyTelegram
 
 @dataclass
 class ConbusOutputResponse:
-    """Represents a response from Conbus send operation.
+    """
+    Represents a response from Conbus send operation.
 
     Attributes:
         success: Whether the operation was successful.
@@ -43,7 +44,8 @@ class ConbusOutputResponse:
             self.received_telegrams = []
 
     def to_dict(self) -> Dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the response.

xp/models/conbus/conbus_raw.py

@@ -7,7 +7,8 @@ from typing import Any, Dict, List, Optional
 
 @dataclass
 class ConbusRawResponse:
-    """Represents a response from Conbus raw telegram send operation.
+    """
+    Represents a response from Conbus raw telegram send operation.
 
     Attributes:
         success: Whether the operation was successful.
@@ -31,7 +32,8 @@ class ConbusRawResponse:
             self.received_telegrams = []
 
     def to_dict(self) -> Dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the response.

xp/models/conbus/conbus_receive.py

@@ -7,7 +7,8 @@ from typing import Any, Dict, List, Optional
 
 @dataclass
 class ConbusReceiveResponse:
-    """Represents a response from Conbus receive operation.
+    """
+    Represents a response from Conbus receive operation.
 
     Attributes:
         success: Whether the operation was successful.
@@ -29,7 +30,8 @@ class ConbusReceiveResponse:
             self.received_telegrams = []
 
     def to_dict(self) -> Dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the response.

xp/models/conbus/conbus_writeconfig.py

@@ -10,7 +10,8 @@ from xp.models.telegram.system_function import SystemFunction
 
 @dataclass
 class ConbusWriteConfigResponse:
-    """Represents a response from Conbus write config operations (set/get).
+    """
+    Represents a response from Conbus write config operations (set/get).
 
     Attributes:
         success: Whether the operation was successful.
@@ -42,7 +43,8 @@ class ConbusWriteConfigResponse:
             self.received_telegrams = []
 
     def to_dict(self) -> Dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the response.

xp/models/config/conson_module_config.py

@@ -8,7 +8,8 @@ from pydantic import BaseModel, IPvAnyAddress
 
 
 class ConsonModuleConfig(BaseModel):
-    """Configuration for a Conson module.
+    """
+    Configuration for a Conson module.
 
     Attributes:
         name: Name of the module.
@@ -48,7 +49,8 @@ class ConsonModuleConfig(BaseModel):
 
 
 class ConsonModuleListConfig(BaseModel):
-    """Configuration list for Conson modules.
+    """
+    Configuration list for Conson modules.
 
     Attributes:
         root: List of Conson module configurations.
@@ -58,7 +60,8 @@ class ConsonModuleListConfig(BaseModel):
 
     @classmethod
     def from_yaml(cls, file_path: str) -> "ConsonModuleListConfig":
-        """Load configuration from YAML file.
+        """
+        Load configuration from YAML file.
 
         Args:
             file_path: Path to the YAML configuration file.
@@ -78,7 +81,8 @@ class ConsonModuleListConfig(BaseModel):
         return cls(root=data)
 
     def find_module(self, serial_number: str) -> Optional[ConsonModuleConfig]:
-        """Find a module by serial number.
+        """
+        Find a module by serial number.
 
         Args:
             serial_number: Module serial number to search for.

xp/models/homekit/homekit_accessory.py

@@ -8,7 +8,8 @@ from pyhap.const import CATEGORY_SENSOR
 
 
 class TemperatureSensor(Accessory):
-    """Fake Temperature sensor, measuring every 3 seconds.
+    """
+    Fake Temperature sensor, measuring every 3 seconds.
 
     Attributes:
         category: HomeKit category for sensor.
@@ -18,7 +19,8 @@ class TemperatureSensor(Accessory):
     category = CATEGORY_SENSOR
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:
-        """Initialize temperature sensor accessory.
+        """
+        Initialize temperature sensor accessory.
 
         Args:
             args: Positional arguments passed to parent Accessory.

xp/models/homekit/homekit_config.py

@@ -10,7 +10,8 @@ from pydantic import BaseModel, Field, IPvAnyAddress
 
 
 class NetworkConfig(BaseModel):
-    """Network configuration settings.
+    """
+    Network configuration settings.
 
     Attributes:
         ip: IP address for the network connection.
@@ -22,7 +23,8 @@ class NetworkConfig(BaseModel):
 
 
 class RoomConfig(BaseModel):
-    """Room configuration settings.
+    """
+    Room configuration settings.
 
     Attributes:
         name: Name of the room.
@@ -34,7 +36,8 @@ class RoomConfig(BaseModel):
 
 
 class BridgeConfig(BaseModel):
-    """HomeKit bridge settings.
+    """
+    HomeKit bridge settings.
 
     Attributes:
         name: Name of the HomeKit bridge.
@@ -46,7 +49,8 @@ class BridgeConfig(BaseModel):
 
 
 class HomekitAccessoryConfig(BaseModel):
-    """HomeKit accessory configuration.
+    """
+    HomeKit accessory configuration.
 
     Attributes:
         name: Name of the accessory.
@@ -72,7 +76,8 @@ class HomekitAccessoryConfig(BaseModel):
 
 
 class HomekitConfig(BaseModel):
-    """HomeKit bridge configuration.
+    """
+    HomeKit bridge configuration.
 
     Attributes:
         homekit: Network configuration for HomeKit.
@@ -88,7 +93,8 @@ class HomekitConfig(BaseModel):
 
     @classmethod
     def from_yaml(cls, file_path: str) -> "HomekitConfig":
-        """Load configuration from YAML file.
+        """
+        Load configuration from YAML file.
 
         Args:
             file_path: Path to the YAML configuration file.

xp/models/log_entry.py

@@ -11,7 +11,8 @@ from xp.models.telegram.system_telegram import SystemTelegram
 
 @dataclass
 class LogEntry:
-    """Represents a single entry in a console bus log file.
+    """
+    Represents a single entry in a console bus log file.
 
     Format: HH:MM:SS,mmm [TX/RX] <telegram>
     Examples: 22:44:20,352 [TX] <S0012345008F27D00AAFN>
@@ -41,7 +42,8 @@ class LogEntry:
 
     @property
     def is_transmitted(self) -> bool:
-        """True if this is a transmitted telegram.
+        """
+        True if this is a transmitted telegram.
 
         Returns:
             True if direction is TX, False otherwise.
@@ -50,7 +52,8 @@ class LogEntry:
 
     @property
     def is_received(self) -> bool:
-        """True if this is a received telegram.
+        """
+        True if this is a received telegram.
 
         Returns:
             True if direction is RX, False otherwise.
@@ -59,7 +62,8 @@ class LogEntry:
 
     @property
     def telegram_type(self) -> str:
-        """Get the telegram type (event, system, reply, unknown).
+        """
+        Get the telegram type (event, system, reply, unknown).
 
         Returns:
             Telegram type string.
@@ -71,7 +75,8 @@ class LogEntry:
 
     @property
     def is_valid_parse(self) -> bool:
-        """True if the telegram was successfully parsed.
+        """
+        True if the telegram was successfully parsed.
 
         Returns:
             True if parsed without errors, False otherwise.
@@ -80,7 +85,8 @@ class LogEntry:
 
     @property
     def checksum_validated(self) -> Optional[bool]:
-        """Get checksum validation status if available.
+        """
+        Get checksum validation status if available.
 
         Returns:
             Checksum validation status or None if not available.
@@ -90,7 +96,8 @@ class LogEntry:
         return None
 
     def to_dict(self) -> dict[str, Any]:
-        """Convert to dictionary for JSON serialization.
+        """
+        Convert to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the log entry.
@@ -115,7 +122,8 @@ class LogEntry:
         return result
 
     def __str__(self) -> str:
-        """Human-readable string representation.
+        """
+        Human-readable string representation.
 
         Returns:
             Formatted string representation of the log entry.

xp/models/protocol/conbus_protocol.py

@@ -18,7 +18,8 @@ if TYPE_CHECKING:
 
 
 class ConnectionMadeEvent(BaseEvent):
-    """Event dispatched when TCP connection is established.
+    """
+    Event dispatched when TCP connection is established.
 
     Attributes:
         protocol: Reference to the TelegramProtocol instance.
@@ -30,7 +31,8 @@ class ConnectionMadeEvent(BaseEvent):
 
 
 class ConnectionFailedEvent(BaseEvent):
-    """Event dispatched when TCP connection fails.
+    """
+    Event dispatched when TCP connection fails.
 
     Attributes:
         reason: Failure reason.
@@ -40,7 +42,8 @@ class ConnectionFailedEvent(BaseEvent):
 
 
 class SendWriteConfigEvent(BaseEvent):
-    """Event for sending write config commands.
+    """
+    Event for sending write config commands.
 
     Attributes:
         serial_number: Serial number.
@@ -56,7 +59,8 @@ class SendWriteConfigEvent(BaseEvent):
 
 
 class SendActionEvent(BaseEvent):
-    """Event for sending action commands.
+    """
+    Event for sending action commands.
 
     Attributes:
         serial_number: Serial number of the light bulb set.
@@ -74,7 +78,8 @@ class SendActionEvent(BaseEvent):
 
 
 class DatapointEvent(BaseEvent):
-    """Base event for datapoint operations.
+    """
+    Base event for datapoint operations.
 
     Attributes:
         serial_number: Serial number of the light bulb set.
@@ -86,7 +91,8 @@ class DatapointEvent(BaseEvent):
 
 
 class OutputStateReceivedEvent(DatapointEvent):
-    """Event when output state is received.
+    """
+    Event when output state is received.
 
     Attributes:
         data_value: Data value.
@@ -96,7 +102,8 @@ class OutputStateReceivedEvent(DatapointEvent):
 
 
 class LightLevelReceivedEvent(DatapointEvent):
-    """Event when light level is received.
+    """
+    Event when light level is received.
 
     Attributes:
         data_value: Data value.
@@ -106,7 +113,8 @@ class LightLevelReceivedEvent(DatapointEvent):
 
 
 class ReadDatapointEvent(DatapointEvent):
-    """Event to read datapoint.
+    """
+    Event to read datapoint.
 
     Attributes:
         refresh_cache: If True, force cache invalidation and fresh protocol query.
@@ -125,7 +133,8 @@ class ReadDatapointFromProtocolEvent(DatapointEvent):
 
 
 class ModuleEvent(BaseEvent):
-    """Event dispatched when light bulb set is on.
+    """
+    Event dispatched when light bulb set is on.
 
     Attributes:
         serial_number: Serial number of the light bulb set.
@@ -145,7 +154,8 @@ class ModuleEvent(BaseEvent):
 
 
 class LightBulbSetOnEvent(ModuleEvent):
-    """Event dispatched when light bulb set is on.
+    """
+    Event dispatched when light bulb set is on.
 
     Attributes:
         value: On or Off the light bulb set.
@@ -161,7 +171,8 @@ class LightBulbGetOnEvent(ModuleEvent, BaseEvent[bool]):
 
 
 class OutletSetOnEvent(ModuleEvent):
-    """Event dispatched when outlet set is on.
+    """
+    Event dispatched when outlet set is on.
 
     Attributes:
         value: On or Off the light bulb set.
@@ -183,7 +194,8 @@ class OutletGetInUseEvent(ModuleEvent):
 
 
 class OutletSetInUseEvent(ModuleEvent, BaseEvent[bool]):
-    """Event dispatched when outlet set is on.
+    """
+    Event dispatched when outlet set is on.
 
     Attributes:
         value: On or Off the light bulb set.
@@ -193,7 +205,8 @@ class OutletSetInUseEvent(ModuleEvent, BaseEvent[bool]):
 
 
 class DimmingLightSetOnEvent(ModuleEvent):
-    """Event dispatched when dimming light set is on.
+    """
+    Event dispatched when dimming light set is on.
 
     Attributes:
         value: On or Off the light bulb set.
@@ -211,7 +224,8 @@ class DimmingLightGetOnEvent(ModuleEvent):
 
 
 class DimmingLightSetBrightnessEvent(ModuleEvent):
-    """Event dispatched when dimming light set is on.
+    """
+    Event dispatched when dimming light set is on.
 
     Attributes:
         brightness: Level of brightness of the dimming light.
@@ -227,7 +241,8 @@ class DimmingLightGetBrightnessEvent(ModuleEvent):
 
 
 class ConnectionLostEvent(BaseEvent):
-    """Event dispatched when TCP connection is lost.
+    """
+    Event dispatched when TCP connection is lost.
 
     Attributes:
         reason: Disconnection reason.
@@ -237,7 +252,8 @@ class ConnectionLostEvent(BaseEvent):
 
 
 class TelegramEvent(BaseEvent):
-    """Event for telegram operations.
+    """
+    Event for telegram operations.
 
     Attributes:
         protocol: TelegramProtocol instance.
@@ -265,7 +281,8 @@ class TelegramEvent(BaseEvent):
 
 
 class ModuleStateChangedEvent(BaseEvent):
-    """Event dispatched when a module's state changes (from event telegram).
+    """
+    Event dispatched when a module's state changes (from event telegram).
 
     Attributes:
         module_type_code: Module type code from event telegram.
@@ -299,7 +316,8 @@ class TelegramReceivedEvent(TelegramEvent):
 
 
 class InvalidTelegramReceivedEvent(BaseEvent):
-    """Event dispatched when an invalid telegram frame is received.
+    """
+    Event dispatched when an invalid telegram frame is received.
 
     Attributes:
         protocol: TelegramProtocol instance.

xp/models/response.py

@@ -1,7 +1,8 @@
-"""Response model for structured service responses.
+"""
+Response model for structured service responses.
 
-This module provides the Response class used throughout the application
-for consistent service response formatting.
+This module provides the Response class used throughout the application for consistent
+service response formatting.
 """
 
 from datetime import datetime
@@ -9,14 +10,16 @@ from typing import Any, Optional
 
 
 class Response:
-    """Standard response model for service operations.
+    """
+    Standard response model for service operations.
 
-    Provides consistent structure for all service responses including
-    success status, data payload, error messages, and timestamp.
+    Provides consistent structure for all service responses including success status,
+    data payload, error messages, and timestamp.
     """
 
     def __init__(self, success: bool, data: Any, error: Optional[str] = None):
-        """Initialize response.
+        """
+        Initialize response.
 
         Args:
             success: Whether the operation was successful
@@ -29,7 +32,8 @@ class Response:
         self.timestamp = datetime.now()
 
     def to_dict(self) -> dict:
-        """Convert response to dictionary for JSON serialization.
+        """
+        Convert response to dictionary for JSON serialization.
 
         Returns:
             Dictionary representation of the response

xp/models/telegram/action_type.py

@@ -5,7 +5,8 @@ from typing import Optional
 
 
 class ActionType(Enum):
-    """Action types for XP24 telegrams.
+    """
+    Action types for XP24 telegrams.
 
     Attributes:
         OFF_PRESS: Make action (activate relay).
@@ -17,7 +18,8 @@ class ActionType(Enum):
 
     @classmethod
     def from_code(cls, code: str) -> Optional["ActionType"]:
-        """Get ActionType from code string.
+        """
+        Get ActionType from code string.
 
         Args:
             code: Action code string.

xp/models/telegram/datapoint_type.py

@@ -5,7 +5,8 @@ from typing import Optional
 
 
 class DataPointType(str, Enum):
-    """Data point types for system telegrams.
+    """
+    Data point types for system telegrams.
 
     Attributes:
         MODULE_TYPE: Module type (XP24, XP33, etc).
@@ -98,7 +99,8 @@ class DataPointType(str, Enum):
 
     @classmethod
     def from_code(cls, code: str) -> Optional["DataPointType"]:
-        """Get DataPointType from code string.
+        """
+        Get DataPointType from code string.
 
         Args:
             code: Datapoint type code string.