conson-xp 1.1.0__tar.gz → 1.3.0__tar.gz

{conson_xp-1.1.0 → conson_xp-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: conson-xp
-Version: 1.1.0
+Version: 1.3.0
 Summary: XP Protocol Communication Tools
 Author-Email: ldvchosal <ldvchosal@github.com>
 License: MIT License
@@ -272,10 +272,6 @@ src/xp/
 
 xp
 
-xp api
-xp api start
-
-
 xp conbus
 
 xp conbus actiontable

{conson_xp-1.1.0 → conson_xp-1.3.0}/README.md

@@ -221,10 +221,6 @@ src/xp/
 
 xp
 
-xp api
-xp api start
-
-
 xp conbus
 
 xp conbus actiontable

{conson_xp-1.1.0 → conson_xp-1.3.0}/pyproject.toml

@@ -20,7 +20,7 @@ dependencies = [
 ]
 requires-python = ">=3.11"
 readme = "README.md"
-version = "1.1.0"
+version = "1.3.0"
 
 [project.license]
 file = "LICENSE"
@@ -41,6 +41,9 @@ dev = [
     "pytest-cov>=7.0",
     "black>=25.9",
     "flake8>=7.3",
+    "flake8-docstrings>=1.7.0",
+    "flake8-docstrings-complete>=1.3.0",
+    "interrogate>=1.7.0",
     "mypy>=1.18",
     "ruff>=0.13.0",
     "vulture>=2.14",
@@ -165,6 +168,8 @@ test-cov = "env PYTHONPATH=src python -m pytest tests/ --quiet --cov=src/xp --co
 lint = "ruff check --fix src/ tests/"
 format = "black src/ tests/"
 typecheck = "mypy src/ tests/"
+flake8 = "flake8 src/ tests/"
+interrogate = "interrogate -vv src/"
 vulture = "vulture src/ tests/"
 refurb = "refurb src/ tests/"
 isort = "isort src/ tests/"
@@ -189,6 +194,8 @@ composite = [
     "lint",
     "format",
     "typecheck",
+    "flake8",
+    "interrogate",
     "vulture",
     "refurb",
     "isort",
@@ -222,6 +229,23 @@ version-files = [
     "src/xp/__init__.py:__version__",
 ]
 
+[tool.interrogate]
+ignore-init-method = true
+ignore-init-module = false
+fail-under = 95
+exclude = [
+    "tests",
+    "docs",
+    "build",
+    "dist",
+]
+verbose = 1
+quiet = false
+whitelist-regex = []
+color = true
+generate-badge = "."
+badge-format = "svg"
+
 [build-system]
 requires = [
     "pdm-backend",

conson_xp-1.3.0/src/xp/__init__.py

@@ -0,0 +1,9 @@
+"""XP CLI tool for remote console bus operations.
+
+conson-xp package.
+"""
+
+__version__ = "1.3.0"
+__manufacturer__ = "salchichon"
+__model__ = "xp.cli"
+__serial__ = "2025.09.23.000"

{conson_xp-1.1.0 → conson_xp-1.3.0}/src/xp/cli/__init__.py

@@ -1,4 +1,4 @@
-"""CLI interface for XP tool"""
+"""CLI interface for XP tool."""
 
 from xp.cli.main import cli
 

{conson_xp-1.1.0 → conson_xp-1.3.0}/src/xp/cli/commands/__init__.py

@@ -1,7 +1,6 @@
 """Command modules for XP CLI."""
 
 # Main command groups
-from xp.cli.commands.api_start_commands import start_api_server
 
 # Import conbus command groups (but not 'conbus' itself to avoid module shadowing in Python 3.10)
 from xp.cli.commands.conbus.conbus import (
@@ -38,6 +37,7 @@ from xp.cli.commands.conbus.conbus_datapoint_commands import (
 )
 from xp.cli.commands.conbus.conbus_discover_commands import send_discover_telegram
 from xp.cli.commands.conbus.conbus_lightlevel_commands import (
+    xp_lightlevel_get,
     xp_lightlevel_off,
     xp_lightlevel_on,
     xp_lightlevel_set,
@@ -99,7 +99,6 @@ __all__ = [
     "linknumber",
     "blink",
     "checksum",
-    "start_api_server",
     "homekit",
     "homekit_start",
     # Individual command functions

{conson_xp-1.1.0 → conson_xp-1.3.0}/src/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
 
 

{conson_xp-1.1.0 → conson_xp-1.3.0}/src/xp/cli/commands/conbus/conbus_actiontable_commands.py

@@ -22,13 +22,30 @@ 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"""
-    service = ctx.obj.get("container").get_container().resolve(ActionTableService)
+    """Download action table from XP module.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+    """
+    service: ActionTableService = (
+        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:
+    def on_finish(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,12 +53,17 @@ 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:
         service.start(
             serial_number=serial_number,
             progress_callback=progress_callback,
-            finish_callback=finish_callback,
+            finish_callback=on_finish,
             error_callback=error_callback,
         )

conson_xp-1.3.0/src/xp/cli/commands/conbus/conbus_autoreport_commands.py

@@ -0,0 +1,108 @@
+"""Conbus auto report CLI commands."""
+
+import json
+
+import click
+from click import Context
+
+from xp.cli.commands.conbus.conbus import conbus_autoreport
+from xp.cli.utils.decorators import (
+    connection_command,
+)
+from xp.cli.utils.serial_number_type import SERIAL
+from xp.models import ConbusDatapointResponse
+from xp.models.conbus.conbus_writeconfig import ConbusWriteConfigResponse
+from xp.models.telegram.datapoint_type import DataPointType
+from xp.services.conbus.conbus_datapoint_service import ConbusDatapointService
+from xp.services.conbus.write_config_service import WriteConfigService
+from xp.services.telegram.telegram_datapoint_service import TelegramDatapointService
+
+
+@conbus_autoreport.command("get", short_help="Get auto report status for a module")
+@click.argument("serial_number", type=SERIAL)
+@connection_command()
+@click.pass_context
+def get_autoreport_command(ctx: Context, serial_number: str) -> None:
+    r"""Get the current auto report status for a specific module.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+
+    Examples:
+        \b
+        xp conbus autoreport get 0123450001
+    """
+    # Get service from container
+    service: ConbusDatapointService = (
+        ctx.obj.get("container").get_container().resolve(ConbusDatapointService)
+    )
+    telegram_service: TelegramDatapointService = (
+        ctx.obj.get("container").get_container().resolve(TelegramDatapointService)
+    )
+
+    def on_finish(service_response: ConbusDatapointResponse) -> None:
+        """Handle successful completion of auto report status retrieval.
+
+        Args:
+            service_response: Auto report response object.
+        """
+        auto_report_status = telegram_service.get_autoreport_status(
+            service_response.data_value
+        )
+        result = service_response.to_dict()
+        result["auto_report_status"] = auto_report_status
+        click.echo(json.dumps(result, indent=2))
+
+    with service:
+        service.query_datapoint(
+            serial_number=serial_number,
+            datapoint_type=DataPointType.AUTO_REPORT_STATUS,
+            finish_callback=on_finish,
+        )
+
+
+@conbus_autoreport.command("set", short_help="Set auto report status for a module")
+@click.argument("serial_number", type=SERIAL)
+@click.argument("status", type=click.Choice(["on", "off"], case_sensitive=False))
+@connection_command()
+@click.pass_context
+def set_autoreport_command(ctx: Context, serial_number: str, status: str) -> None:
+    r"""Set the auto report status for a specific module.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        status: Auto report status - either 'on' or 'off'.
+
+    Examples:
+        \b
+        xp conbus autoreport set 0123450001 on
+        xp conbus autoreport set 0123450001 off
+    """
+
+    def on_finish(response: "ConbusWriteConfigResponse") -> 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: WriteConfigService = (
+        ctx.obj.get("container").get_container().resolve(WriteConfigService)
+    )
+    telegram_service: TelegramDatapointService = (
+        ctx.obj.get("container").get_container().resolve(TelegramDatapointService)
+    )
+    status_value = True if status == "on" else False
+    data_value = telegram_service.get_autoreport_status_data_value(status_value)
+
+    with service:
+        service.write_config(
+            serial_number=serial_number,
+            datapoint_type=DataPointType.AUTO_REPORT_STATUS,
+            data_value=data_value,
+            finish_callback=on_finish,
+            timeout_seconds=0.5,
+        )

{conson_xp-1.1.0 → conson_xp-1.3.0}/src/xp/cli/commands/conbus/conbus_blink_commands.py

@@ -23,23 +23,30 @@ 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:
+    def on_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 = (
         ctx.obj.get("container").get_container().resolve(ConbusBlinkService)
     )
     with service:
-        service.send_blink_telegram(serial_number, "on", finish, 0.5)
+        service.send_blink_telegram(serial_number, "on", on_finish, 0.5)
 
 
 @conbus_blink.command("off")
@@ -48,30 +55,35 @@ 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:
+    def on_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 = (
         ctx.obj.get("container").get_container().resolve(ConbusBlinkService)
     )
     with service:
-        service.send_blink_telegram(serial_number, "off", finish, 0.5)
+        service.send_blink_telegram(serial_number, "off", on_finish, 0.5)
 
 
 @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,27 +92,37 @@ 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:
+    def on_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)
     )
     with service:
-        service.send_blink_all_telegram("off", progress, finish, 0.5)
+        service.send_blink_all_telegram("off", progress, on_finish, 0.5)
 
 
 @conbus_blink_all.command("on", short_help="Turn on blinking for all devices")
@@ -108,24 +130,34 @@ 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:
+    def on_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)
     )
     with service:
-        service.send_blink_all_telegram("on", progress, finish, 0.5)
+        service.send_blink_all_telegram("on", progress, on_finish, 0.5)

{conson_xp-1.1.0 → conson_xp-1.3.0}/src/xp/cli/commands/conbus/conbus_config_commands.py

@@ -1,3 +1,5 @@
+"""Conbus configuration CLI commands."""
+
 import json
 
 import click
@@ -12,13 +14,16 @@ 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)
+    config: ConbusClientConfig = (
+        ctx.obj.get("container").get_container().resolve(ConbusClientConfig)
+    )
     click.echo(json.dumps(config.conbus.model_dump(mode="json"), indent=2))

{conson_xp-1.1.0 → conson_xp-1.3.0}/src/xp/cli/commands/conbus/conbus_custom_commands.py

@@ -23,18 +23,29 @@ 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)
+    service: ConbusCustomService = (
+        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: