conson-xp 1.1.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

xp/cli/commands/conbus/conbus.py

@@ -8,9 +8,7 @@ from click_help_colors import HelpColorsGroup
     cls=HelpColorsGroup, help_headers_color="yellow", help_options_color="green"
 )
 def conbus() -> None:
-    """
-    Conbus client operations for sending telegrams to remote servers
-    """
+    """Perform Conbus client operations for sending telegrams to remote servers."""
     pass
 
 
@@ -21,9 +19,7 @@ def conbus() -> None:
     help_options_color="green",
 )
 def conbus_blink() -> None:
-    """
-    Conbus client operations for sending blink telegrams to remote servers
-    """
+    """Perform Conbus client operations for sending blink telegrams to remote servers."""
     pass
 
 
@@ -34,9 +30,7 @@ def conbus_blink() -> None:
     help_options_color="green",
 )
 def conbus_output() -> None:
-    """
-    Conbus input operations to remote servers
-    """
+    """Perform Conbus input operations to remote servers."""
     pass
 
 
@@ -47,9 +41,7 @@ def conbus_output() -> None:
     help_options_color="green",
 )
 def conbus_datapoint() -> None:
-    """
-    Conbus datapoint operations for querying module datapoints
-    """
+    """Perform Conbus datapoint operations for querying module datapoints."""
     pass
 
 
@@ -61,11 +53,7 @@ def conbus_datapoint() -> None:
     short_help="Link number operations",
 )
 def conbus_linknumber() -> None:
-    """
-    Link number operations for modules.
-
-    Set or get the link number for specific modules.
-    """
+    """Set or get the link number for specific modules."""
     pass
 
 
@@ -77,11 +65,7 @@ def conbus_linknumber() -> None:
     short_help="Auto report status operations",
 )
 def conbus_autoreport() -> None:
-    """
-    Auto report status operations for modules.
-
-    Get or set the auto report status for specific modules.
-    """
+    """Get or set the auto report status for specific modules."""
     pass
 
 
@@ -93,11 +77,7 @@ def conbus_autoreport() -> None:
     short_help="Light level operations",
 )
 def conbus_lightlevel() -> None:
-    """
-    Light level operations for modules.
-
-    Control light level (dimming) of outputs on Conbus modules.
-    """
+    """Control light level (dimming) of outputs on Conbus modules."""
     pass
 
 
@@ -109,11 +89,7 @@ def conbus_lightlevel() -> None:
     short_help="MSActionTable operations",
 )
 def conbus_msactiontable() -> None:
-    """
-    msactiontable operations for modules.
-
-    Download msactiontable on Conbus modules.
-    """
+    """Download msactiontable on Conbus modules."""
     pass
 
 
@@ -125,11 +101,7 @@ def conbus_msactiontable() -> None:
     short_help="ActionTable operations",
 )
 def conbus_actiontable() -> None:
-    """
-    ActionTable operations for modules.
-
-    Download ActionTable from Conbus modules.
-    """
+    """Download ActionTable from Conbus modules."""
     pass
 
 

xp/cli/commands/conbus/conbus_actiontable_commands.py

@@ -22,13 +22,28 @@ from xp.services.conbus.actiontable.actiontable_service import (
 @click.pass_context
 @connection_command()
 def conbus_download_actiontable(ctx: Context, serial_number: str) -> None:
-    """Download action table from XP module"""
+    """Download action table from XP module.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+    """
     service = ctx.obj.get("container").get_container().resolve(ActionTableService)
 
     def progress_callback(progress: str) -> None:
+        """Handle progress updates during action table download.
+
+        Args:
+            progress: Progress message string.
+        """
         click.echo(progress)
 
     def finish_callback(actiontable: ActionTable) -> None:
+        """Handle successful completion of action table download.
+
+        Args:
+            actiontable: Downloaded action table object.
+        """
         output = {
             "serial_number": serial_number,
             "actiontable": asdict(actiontable),
@@ -36,6 +51,11 @@ def conbus_download_actiontable(ctx: Context, serial_number: str) -> None:
         click.echo(json.dumps(output, indent=2, default=str))
 
     def error_callback(error: str) -> None:
+        """Handle errors during action table download.
+
+        Args:
+            error: Error message string.
+        """
         click.echo(error)
 
     with service:

xp/cli/commands/conbus/conbus_autoreport_commands.py

@@ -22,14 +22,14 @@ from xp.services.conbus.conbus_autoreport_set_service import ConbusAutoreportSet
 @connection_command()
 @click.pass_context
 def get_autoreport_command(ctx: Context, serial_number: str) -> None:
-    """
-    Get the current auto report status for a specific module.
+    r"""Get the current auto report status for a specific module.
 
-    SERIAL_NUMBER: 10-digit module serial number
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
 
     Examples:
-
-    \b
+        \b
         xp conbus autoreport get 0123450001
     """
     # Get service from container
@@ -38,6 +38,11 @@ def get_autoreport_command(ctx: Context, serial_number: str) -> None:
     )
 
     def on_finish(service_response: ConbusAutoreportResponse) -> None:
+        """Handle successful completion of auto report status retrieval.
+
+        Args:
+            service_response: Auto report response object.
+        """
         click.echo(json.dumps(service_response.to_dict(), indent=2))
 
     with service:
@@ -53,15 +58,15 @@ def get_autoreport_command(ctx: Context, serial_number: str) -> None:
 @connection_command()
 @click.pass_context
 def set_autoreport_command(ctx: Context, serial_number: str, status: str) -> None:
-    """
-    Set the auto report status for a specific module.
+    r"""Set the auto report status for a specific module.
 
-    SERIAL_NUMBER: 10-digit module serial number
-    STATUS: Auto report status - either 'on' or 'off'
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        status: Auto report status - either 'on' or 'off'.
 
     Examples:
-
-    \b
+        \b
         xp conbus autoreport set 0123450001 on
         xp conbus autoreport set 0123450001 off
     """
@@ -72,6 +77,11 @@ def set_autoreport_command(ctx: Context, serial_number: str, status: str) -> Non
     status_bool = status.lower() == "on"
 
     def on_finish(service_response: ConbusAutoreportResponse) -> None:
+        """Handle successful completion of auto report status setting.
+
+        Args:
+            service_response: Auto report response object.
+        """
         click.echo(json.dumps(service_response.to_dict(), indent=2))
 
     with service:

xp/cli/commands/conbus/conbus_blink_commands.py

@@ -23,16 +23,23 @@ from xp.services.telegram.telegram_blink_service import BlinkError
 @connection_command()
 @handle_service_errors(BlinkError)
 def send_blink_on_telegram(ctx: Context, serial_number: str) -> None:
-    """
-    Send blink command to start blinking module LED.
+    r"""Send blink command to start blinking module LED.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
 
-    \b
+    Examples:
+        \b
         xp conbus blink on 0012345008
     """
 
     def finish(service_response: ConbusBlinkResponse) -> None:
+        """Handle successful completion of blink on command.
+
+        Args:
+            service_response: Blink response object.
+        """
         click.echo(json.dumps(service_response.to_dict(), indent=2))
 
     service: ConbusBlinkService = (
@@ -48,16 +55,23 @@ def send_blink_on_telegram(ctx: Context, serial_number: str) -> None:
 @connection_command()
 @handle_service_errors(BlinkError)
 def send_blink_off_telegram(ctx: Context, serial_number: str) -> None:
-    """
-    Send blink command to start blinking module LED.
+    r"""Send blink command to stop blinking module LED.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
 
-    \b
+    Examples:
+        \b
         xp conbus blink off 0012345008
     """
 
     def finish(service_response: ConbusBlinkResponse) -> None:
+        """Handle successful completion of blink off command.
+
+        Args:
+            service_response: Blink response object.
+        """
         click.echo(json.dumps(service_response.to_dict(), indent=2))
 
     service: ConbusBlinkService = (
@@ -69,9 +83,7 @@ def send_blink_off_telegram(ctx: Context, serial_number: str) -> None:
 
 @conbus_blink.group("all", short_help="Control blink state for all devices")
 def conbus_blink_all() -> None:
-    """
-    Control blink state for all discovered devices.
-    """
+    """Control blink state for all discovered devices."""
     pass
 
 
@@ -80,21 +92,31 @@ def conbus_blink_all() -> None:
 @connection_command()
 @handle_service_errors(BlinkError)
 def blink_all_off(ctx: Context) -> None:
-    """
-    Turn off blinking for all discovered devices.
+    r"""Turn off blinking for all discovered devices.
 
-    Examples:
+    Args:
+        ctx: Click context object.
 
-    \b
+    Examples:
+        \b
         xp conbus blink all off
     """
 
     def finish(discovered_devices: ConbusBlinkResponse) -> None:
+        """Handle successful completion of blink all off command.
+
+        Args:
+            discovered_devices: Blink response with all devices.
+        """
         click.echo(json.dumps(discovered_devices.to_dict(), indent=2))
 
     def progress(message: str) -> None:
+        """Handle progress updates during blink all off operation.
+
+        Args:
+            message: Progress message string.
+        """
         click.echo(message)
-        pass
 
     service: ConbusBlinkAllService = (
         ctx.obj.get("container").get_container().resolve(ConbusBlinkAllService)
@@ -108,21 +130,31 @@ def blink_all_off(ctx: Context) -> None:
 @connection_command()
 @handle_service_errors(BlinkError)
 def blink_all_on(ctx: Context) -> None:
-    """
-    Turn on blinking for all discovered devices.
+    r"""Turn on blinking for all discovered devices.
 
-    Examples:
+    Args:
+        ctx: Click context object.
 
-    \b
+    Examples:
+        \b
         xp conbus blink all on
     """
 
     def finish(discovered_devices: ConbusBlinkResponse) -> None:
+        """Handle successful completion of blink all on command.
+
+        Args:
+            discovered_devices: Blink response with all devices.
+        """
         click.echo(json.dumps(discovered_devices.to_dict(), indent=2))
 
     def progress(message: str) -> None:
+        """Handle progress updates during blink all on operation.
+
+        Args:
+            message: Progress message string.
+        """
         click.echo(message)
-        pass
 
     service: ConbusBlinkAllService = (
         ctx.obj.get("container").get_container().resolve(ConbusBlinkAllService)

xp/cli/commands/conbus/conbus_config_commands.py

@@ -1,3 +1,5 @@
+"""Conbus configuration CLI commands."""
+
 import json
 
 import click
@@ -12,12 +14,13 @@ from xp.models import ConbusClientConfig
 @click.pass_context
 @handle_service_errors(Exception)
 def show_config(ctx: Context) -> None:
-    """
-    Display current Conbus client configuration.
+    r"""Display current Conbus client configuration.
 
-    Examples:
+    Args:
+        ctx: Click context object.
 
-    \b
+    Examples:
+        \b
         xp conbus config
     """
     config = ctx.obj.get("container").get_container().resolve(ConbusClientConfig)

xp/cli/commands/conbus/conbus_custom_commands.py

@@ -23,18 +23,27 @@ from xp.services.conbus.conbus_custom_service import ConbusCustomService
 def send_custom_telegram(
     ctx: Context, serial_number: str, function_code: str, datapoint_code: str
 ) -> None:
-    """
-    Send custom telegram with specified function and data point codes.
+    r"""Send custom telegram with specified function and data point codes.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        function_code: Function code.
+        datapoint_code: Data point code.
 
-    \b
+    Examples:
+        \b
         xp conbus custom 0012345011 02 E2
         xp conbus custom 0012345011 17 AA
     """
     service = ctx.obj.get("container").get_container().resolve(ConbusCustomService)
 
     def on_finish(service_response: "ConbusCustomResponse") -> None:
+        """Handle successful completion of custom telegram.
+
+        Args:
+            service_response: Custom response object.
+        """
         click.echo(json.dumps(service_response.to_dict(), indent=2))
 
     with service:

xp/cli/commands/conbus/conbus_datapoint_commands.py

@@ -30,12 +30,15 @@ from xp.services.conbus.conbus_datapoint_service import (
 @click.pass_context
 @connection_command()
 def query_datapoint(ctx: Context, serial_number: str, datapoint: DataPointType) -> None:
-    """
-    Query a specific datapoint from Conbus server.
+    r"""Query a specific datapoint from Conbus server.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        datapoint: Datapoint type to query.
 
-    \b
+    Examples:
+        \b
         xp conbus datapoint query version 0012345011
         xp conbus datapoint query voltage 0012345011
         xp conbus datapoint query temperature 0012345011
@@ -45,6 +48,11 @@ def query_datapoint(ctx: Context, serial_number: str, datapoint: DataPointType)
     service = ctx.obj.get("container").get_container().resolve(ConbusDatapointService)
 
     def on_finish(service_response: ConbusDatapointResponse) -> None:
+        """Handle successful completion of datapoint query.
+
+        Args:
+            service_response: Datapoint response object.
+        """
         click.echo(json.dumps(service_response.to_dict(), indent=2))
 
     # Send telegram
@@ -65,12 +73,14 @@ conbus_datapoint.add_command(query_datapoint)
 @click.pass_context
 @connection_command()
 def query_all_datapoints(ctx: Context, serial_number: str) -> None:
-    """
-    Query all datapoints from a specific module.
+    r"""Query all datapoints from a specific module.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
 
-    \b
+    Examples:
+        \b
         xp conbus datapoint all 0123450001
     """
     service = (
@@ -78,9 +88,19 @@ def query_all_datapoints(ctx: Context, serial_number: str) -> None:
     )
 
     def on_finish(service_response: ConbusDatapointResponse) -> None:
+        """Handle successful completion of all datapoints query.
+
+        Args:
+            service_response: Datapoint response object with all datapoints.
+        """
         click.echo(json.dumps(service_response.to_dict(), indent=2))
 
     def on_progress(reply_telegram: ReplyTelegram) -> None:
+        """Handle progress updates during all datapoints query.
+
+        Args:
+            reply_telegram: Reply telegram object with progress data.
+        """
         click.echo(json.dumps(reply_telegram.to_dict(), indent=2))
 
     with service:

xp/cli/commands/conbus/conbus_discover_commands.py

@@ -18,19 +18,30 @@ from xp.services.conbus.conbus_discover_service import (
 @click.pass_context
 @connection_command()
 def send_discover_telegram(ctx: click.Context) -> None:
-    """
-    Send discover telegram to Conbus server.
+    r"""Send discover telegram to Conbus server.
 
-    Examples:
+    Args:
+        ctx: Click context object.
 
-    \b
+    Examples:
+        \b
         xp conbus discover
     """
 
     def finish(discovered_devices: ConbusDiscoverResponse) -> None:
+        """Handle successful completion of device discovery.
+
+        Args:
+            discovered_devices: Discover response with all found devices.
+        """
         click.echo(json.dumps(discovered_devices.to_dict(), indent=2))
 
     def progress(_serial_number: str) -> None:
+        """Handle progress updates during device discovery.
+
+        Args:
+            _serial_number: Serial number of discovered device (unused).
+        """
         # click.echo(f"Discovered : {serial_number}")
         pass
 

xp/cli/commands/conbus/conbus_lightlevel_commands.py

@@ -27,16 +27,26 @@ from xp.services.conbus.conbus_lightlevel_set_service import (
 def xp_lightlevel_set(
     ctx: click.Context, serial_number: str, output_number: int, level: int
 ) -> None:
-    """Set light level for output_number on XP module serial_number
+    r"""Set light level for output_number on XP module serial_number.
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        output_number: Output number (0-8).
+        level: Light level (0-100).
 
-    \b
+    Examples:
+        \b
         xp conbus lightlevel set 0123450001 2 50   # Set output 2 to 50%
         xp conbus lightlevel set 0011223344 0 100  # Set output 0 to 100%
     """
 
     def finish(response: "ConbusLightlevelResponse") -> None:
+        """Handle successful completion of light level set command.
+
+        Args:
+            response: Light level response object.
+        """
         click.echo(json.dumps(response.to_dict(), indent=2))
 
     service = (
@@ -56,16 +66,25 @@ def xp_lightlevel_set(
 def xp_lightlevel_off(
     ctx: click.Context, serial_number: str, output_number: int
 ) -> None:
-    """Turn off light for output_number on XP module serial_number (set level to 0)
+    r"""Turn off light for output_number on XP module serial_number (set level to 0).
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        output_number: Output number (0-8).
 
-    \b
+    Examples:
+        \b
         xp conbus lightlevel off 0123450001 2   # Turn off output 2
         xp conbus lightlevel off 0011223344 0   # Turn off output 0
     """
 
     def finish(response: "ConbusLightlevelResponse") -> None:
+        """Handle successful completion of light level off command.
+
+        Args:
+            response: Light level response object.
+        """
         click.echo(json.dumps(response.to_dict(), indent=2))
 
     service = (
@@ -85,16 +104,25 @@ def xp_lightlevel_off(
 def xp_lightlevel_on(
     ctx: click.Context, serial_number: str, output_number: int
 ) -> None:
-    """Turn on light for output_number on XP module serial_number (set level to 80%)
+    r"""Turn on light for output_number on XP module serial_number (set level to 80%).
 
-    Examples:
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        output_number: Output number (0-8).
 
-    \b
+    Examples:
+        \b
         xp conbus lightlevel on 0123450001 2   # Turn on output 2 (80%)
         xp conbus lightlevel on 0011223344 0   # Turn on output 0 (80%)
     """
 
     def finish(response: "ConbusLightlevelResponse") -> None:
+        """Handle successful completion of light level on command.
+
+        Args:
+            response: Light level response object.
+        """
         click.echo(json.dumps(response.to_dict(), indent=2))
 
     service = (
@@ -114,14 +142,25 @@ def xp_lightlevel_on(
 def xp_lightlevel_get(
     ctx: click.Context, serial_number: str, output_number: int
 ) -> None:
-    """Get current light level for output_number on XP module serial_number
+    r"""Get current light level for output_number on XP module serial_number.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        output_number: Output number (0-8).
+
     Examples:
-    \b
+        \b
         xp conbus lightlevel get 0123450001 2   # Get light level for output 2
         xp conbus lightlevel get 0011223344 0   # Get light level for output 0
     """
 
     def finish(response: "ConbusLightlevelResponse") -> None:
+        """Handle successful completion of light level get command.
+
+        Args:
+            response: Light level response object.
+        """
         click.echo(json.dumps(response.to_dict(), indent=2))
 
     service = (