conson-xp 1.18.0__py3-none-any.whl

xp/cli/commands/__init__.py

@@ -0,0 +1,153 @@
+"""Command modules for XP CLI."""
+
+# Main command groups
+
+# Import conbus command groups (but not 'conbus' itself to avoid module shadowing in Python 3.10)
+from xp.cli.commands.conbus.conbus import (
+    conbus_actiontable,
+    conbus_autoreport,
+    conbus_blink,
+    conbus_datapoint,
+    conbus_lightlevel,
+    conbus_linknumber,
+    conbus_modulenumber,
+    conbus_msactiontable,
+    conbus_output,
+)
+from xp.cli.commands.conbus.conbus_actiontable_commands import (
+    conbus_download_actiontable,
+)
+
+# Individual command functions that attach to groups
+from xp.cli.commands.conbus.conbus_autoreport_commands import (
+    get_autoreport_command,
+    set_autoreport_command,
+)
+from xp.cli.commands.conbus.conbus_blink_commands import (
+    blink_all_off,
+    blink_all_on,
+    conbus_blink_all,
+    send_blink_off_telegram,
+    send_blink_on_telegram,
+)
+from xp.cli.commands.conbus.conbus_config_commands import show_config
+from xp.cli.commands.conbus.conbus_custom_commands import send_custom_telegram
+from xp.cli.commands.conbus.conbus_datapoint_commands import (
+    query_all_datapoints,
+    query_datapoint,
+)
+from xp.cli.commands.conbus.conbus_discover_commands import send_discover_telegram
+from xp.cli.commands.conbus.conbus_event_commands import conbus_event, send_event_raw
+from xp.cli.commands.conbus.conbus_lightlevel_commands import (
+    xp_lightlevel_get,
+    xp_lightlevel_off,
+    xp_lightlevel_on,
+    xp_lightlevel_set,
+)
+from xp.cli.commands.conbus.conbus_linknumber_commands import (
+    get_linknumber_command,
+    set_linknumber_command,
+)
+from xp.cli.commands.conbus.conbus_modulenumber_commands import (
+    get_modulenumber_command,
+    set_modulenumber_command,
+)
+from xp.cli.commands.conbus.conbus_msactiontable_commands import (
+    conbus_download_msactiontable,
+)
+from xp.cli.commands.conbus.conbus_output_commands import (
+    xp_module_state,
+    xp_output_off,
+    xp_output_on,
+    xp_output_status,
+)
+from xp.cli.commands.conbus.conbus_raw_commands import send_raw_telegrams
+from xp.cli.commands.conbus.conbus_receive_commands import receive_telegrams
+from xp.cli.commands.conbus.conbus_scan_commands import scan_module
+from xp.cli.commands.file_commands import file
+from xp.cli.commands.homekit.homekit import homekit
+from xp.cli.commands.homekit.homekit_start_commands import homekit_start
+from xp.cli.commands.module_commands import module
+from xp.cli.commands.reverse_proxy_commands import reverse_proxy
+from xp.cli.commands.server.server_commands import server
+from xp.cli.commands.telegram.telegram import blink, checksum, linknumber, telegram
+from xp.cli.commands.telegram.telegram_blink_commands import blink_off, blink_on
+from xp.cli.commands.telegram.telegram_checksum_commands import (
+    calculate_checksum,
+    validate_checksum,
+)
+from xp.cli.commands.telegram.telegram_discover_commands import generate_discover
+from xp.cli.commands.telegram.telegram_linknumber_commands import (
+    generate_read_link_number,
+    generate_set_link_number,
+)
+from xp.cli.commands.telegram.telegram_parse_commands import (
+    parse_any_telegram,
+    validate_telegram,
+)
+from xp.cli.commands.telegram.telegram_version_commands import generate_version_request
+
+__all__ = [
+    # Main command groups (conbus excluded to avoid module shadowing)
+    "conbus_blink",
+    "conbus_output",
+    "conbus_datapoint",
+    "conbus_linknumber",
+    "conbus_modulenumber",
+    "conbus_autoreport",
+    "conbus_lightlevel",
+    "conbus_msactiontable",
+    "conbus_actiontable",
+    "conbus_event",
+    "file",
+    "module",
+    "reverse_proxy",
+    "server",
+    "telegram",
+    "linknumber",
+    "blink",
+    "checksum",
+    "homekit",
+    "homekit_start",
+    # Individual command functions
+    "conbus_download_msactiontable",
+    "conbus_download_actiontable",
+    "send_blink_on_telegram",
+    "send_blink_off_telegram",
+    "conbus_blink_all",
+    "blink_all_off",
+    "blink_all_on",
+    "show_config",
+    "send_custom_telegram",
+    "send_discover_telegram",
+    "send_event_raw",
+    "xp_output_on",
+    "xp_output_off",
+    "xp_output_status",
+    "xp_module_state",
+    "scan_module",
+    "query_datapoint",
+    "query_all_datapoints",
+    "send_raw_telegrams",
+    "receive_telegrams",
+    "set_linknumber_command",
+    "get_linknumber_command",
+    "set_modulenumber_command",
+    "get_modulenumber_command",
+    "get_autoreport_command",
+    "set_autoreport_command",
+    "xp_lightlevel_set",
+    "xp_lightlevel_off",
+    "xp_lightlevel_on",
+    "xp_lightlevel_get",
+    "blink_on",
+    "blink_off",
+    "parse_any_telegram",
+    "validate_telegram",
+    "generate_discover",
+    "generate_set_link_number",
+    "generate_read_link_number",
+    "generate_version_request",
+    "calculate_checksum",
+    "validate_checksum",
+]

xp/cli/commands/conbus/__init__.py

@@ -0,0 +1,25 @@
+"""Conbus CLI commands package."""
+
+from xp.cli.commands.conbus.conbus import (
+    conbus,
+    conbus_actiontable,
+    conbus_autoreport,
+    conbus_blink,
+    conbus_datapoint,
+    conbus_lightlevel,
+    conbus_linknumber,
+    conbus_msactiontable,
+    conbus_output,
+)
+
+__all__ = [
+    "conbus",
+    "conbus_blink",
+    "conbus_output",
+    "conbus_datapoint",
+    "conbus_linknumber",
+    "conbus_autoreport",
+    "conbus_lightlevel",
+    "conbus_msactiontable",
+    "conbus_actiontable",
+]

xp/cli/commands/conbus/conbus.py

@@ -0,0 +1,128 @@
+"""Shared conbus CLI group definition."""
+
+import click
+from click_help_colors import HelpColorsGroup
+
+
+@click.group(
+    cls=HelpColorsGroup, help_headers_color="yellow", help_options_color="green"
+)
+def conbus() -> None:
+    """Perform Conbus client operations for sending telegrams to remote servers."""
+    pass
+
+
+@click.group(
+    name="blink",
+    cls=HelpColorsGroup,
+    help_headers_color="yellow",
+    help_options_color="green",
+)
+def conbus_blink() -> None:
+    """Perform Conbus client operations for sending blink telegrams to remote servers."""
+    pass
+
+
+@click.group(
+    name="output",
+    cls=HelpColorsGroup,
+    help_headers_color="yellow",
+    help_options_color="green",
+)
+def conbus_output() -> None:
+    """Perform Conbus input operations to remote servers."""
+    pass
+
+
+@click.group(
+    name="datapoint",
+    cls=HelpColorsGroup,
+    help_headers_color="yellow",
+    help_options_color="green",
+)
+def conbus_datapoint() -> None:
+    """Perform Conbus datapoint operations for querying module datapoints."""
+    pass
+
+
+@click.group(
+    "linknumber",
+    cls=HelpColorsGroup,
+    help_headers_color="yellow",
+    help_options_color="green",
+    short_help="Link number operations",
+)
+def conbus_linknumber() -> None:
+    """Set or get the link number for specific modules."""
+    pass
+
+
+@click.group(
+    "modulenumber",
+    cls=HelpColorsGroup,
+    help_headers_color="yellow",
+    help_options_color="green",
+    short_help="Module number operations",
+)
+def conbus_modulenumber() -> None:
+    """Set or get the module number for specific modules."""
+    pass
+
+
+@click.group(
+    "autoreport",
+    cls=HelpColorsGroup,
+    help_headers_color="yellow",
+    help_options_color="green",
+    short_help="Auto report status operations",
+)
+def conbus_autoreport() -> None:
+    """Get or set the auto report status for specific modules."""
+    pass
+
+
+@click.group(
+    "lightlevel",
+    cls=HelpColorsGroup,
+    help_headers_color="yellow",
+    help_options_color="green",
+    short_help="Light level operations",
+)
+def conbus_lightlevel() -> None:
+    """Control light level (dimming) of outputs on Conbus modules."""
+    pass
+
+
+@click.group(
+    "msactiontable",
+    cls=HelpColorsGroup,
+    help_headers_color="yellow",
+    help_options_color="green",
+    short_help="MSActionTable operations",
+)
+def conbus_msactiontable() -> None:
+    """Download msactiontable on Conbus modules."""
+    pass
+
+
+@click.group(
+    "actiontable",
+    cls=HelpColorsGroup,
+    help_headers_color="yellow",
+    help_options_color="green",
+    short_help="ActionTable operations",
+)
+def conbus_actiontable() -> None:
+    """Download ActionTable from Conbus modules."""
+    pass
+
+
+conbus.add_command(conbus_blink)
+conbus.add_command(conbus_output)
+conbus.add_command(conbus_datapoint)
+conbus.add_command(conbus_linknumber)
+conbus.add_command(conbus_modulenumber)
+conbus.add_command(conbus_autoreport)
+conbus.add_command(conbus_lightlevel)
+conbus.add_command(conbus_msactiontable)
+conbus.add_command(conbus_actiontable)

xp/cli/commands/conbus/conbus_actiontable_commands.py

@@ -0,0 +1,233 @@
+"""ActionTable CLI commands."""
+
+import json
+from contextlib import suppress
+from pathlib import Path
+from typing import Any
+
+import click
+from click import Context
+
+from xp.cli.commands.conbus.conbus import conbus_actiontable
+from xp.cli.utils.decorators import (
+    connection_command,
+)
+from xp.cli.utils.serial_number_type import SERIAL
+from xp.models.actiontable.actiontable import ActionTable
+from xp.models.homekit.homekit_conson_config import (
+    ConsonModuleConfig,
+    ConsonModuleListConfig,
+)
+from xp.services.conbus.actiontable.actiontable_download_service import (
+    ActionTableService,
+)
+from xp.services.conbus.actiontable.actiontable_list_service import (
+    ActionTableListService,
+)
+from xp.services.conbus.actiontable.actiontable_show_service import (
+    ActionTableShowService,
+)
+from xp.services.conbus.actiontable.actiontable_upload_service import (
+    ActionTableUploadService,
+)
+
+
+class ActionTableError(Exception):
+    """Raised when ActionTable operations fail."""
+
+    pass
+
+
+@conbus_actiontable.command("download", short_help="Download ActionTable")
+@click.argument("serial_number", type=SERIAL)
+@click.pass_context
+@connection_command()
+def conbus_download_actiontable(ctx: Context, serial_number: str) -> None:
+    """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 on_finish(
+        _actiontable: ActionTable,
+        actiontable_dict: dict[str, Any],
+        actiontable_short: list[str],
+    ) -> None:
+        """Handle successful completion of action table download.
+
+        Args:
+            _actiontable: Downloaded action table object.
+            actiontable_dict: Dictionary representation of action table.
+            actiontable_short: List of textual format strings.
+        """
+        output = {
+            "serial_number": serial_number,
+            "actiontable_short": actiontable_short,
+            "actiontable": actiontable_dict,
+        }
+        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=on_finish,
+            error_callback=error_callback,
+        )
+
+
+@conbus_actiontable.command("upload", short_help="Upload ActionTable")
+@click.argument("serial_number", type=SERIAL)
+@click.pass_context
+@connection_command()
+def conbus_upload_actiontable(ctx: Context, serial_number: str) -> None:
+    """Upload action table from conson.yml to XP module.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+    """
+    service: ActionTableUploadService = (
+        ctx.obj.get("container").get_container().resolve(ActionTableUploadService)
+    )
+
+    click.echo(f"Uploading action table to {serial_number}...")
+
+    # Track number of entries for success message
+    entries_count = 0
+
+    def progress_callback(progress: str) -> None:
+        """Handle progress updates during action table upload.
+
+        Args:
+            progress: Progress message string.
+        """
+        click.echo(progress, nl=False)
+
+    def success_callback() -> None:
+        """Handle successful completion of action table upload."""
+        click.echo("\nAction table uploaded successfully")
+        if entries_count > 0:
+            click.echo(f"{entries_count} entries written")
+
+    def error_callback(error: str) -> None:
+        """Handle errors during action table upload.
+
+        Args:
+            error: Error message string.
+
+        Raises:
+            ActionTableError: Always raised with upload failure message.
+        """
+        raise ActionTableError(f"Upload failed: {error}")
+
+    with service:
+        # Load config to get entry count for success message
+        config_path = Path.cwd() / "conson.yml"
+        if config_path.exists():
+            with suppress(Exception):
+                config = ConsonModuleListConfig.from_yaml(str(config_path))
+                module = config.find_module(serial_number)
+                if module and module.action_table:
+                    entries_count = len(module.action_table)
+
+        service.start(
+            serial_number=serial_number,
+            progress_callback=progress_callback,
+            success_callback=success_callback,
+            error_callback=error_callback,
+        )
+
+
+@conbus_actiontable.command("list", short_help="List modules with ActionTable")
+@click.pass_context
+def conbus_list_actiontable(ctx: Context) -> None:
+    """List all modules with action table configurations from conson.yml.
+
+    Args:
+        ctx: Click context object.
+    """
+    service: ActionTableListService = (
+        ctx.obj.get("container").get_container().resolve(ActionTableListService)
+    )
+
+    def on_finish(module_list: dict) -> None:
+        """Handle successful completion of action table list.
+
+        Args:
+            module_list: Dictionary containing modules and total count.
+        """
+        click.echo(json.dumps(module_list, indent=2, default=str))
+
+    def error_callback(error: str) -> None:
+        """Handle errors during action table list.
+
+        Args:
+            error: Error message string.
+        """
+        click.echo(error)
+
+    with service:
+        service.start(
+            finish_callback=on_finish,
+            error_callback=error_callback,
+        )
+
+
+@conbus_actiontable.command("show", short_help="Show ActionTable configuration")
+@click.argument("serial_number", type=SERIAL)
+@click.pass_context
+def conbus_show_actiontable(ctx: Context, serial_number: str) -> None:
+    """Show action table configuration for a specific module from conson.yml.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+    """
+    service: ActionTableShowService = (
+        ctx.obj.get("container").get_container().resolve(ActionTableShowService)
+    )
+
+    def on_finish(module: ConsonModuleConfig) -> None:
+        """Handle successful completion of action table show.
+
+        Args:
+            module: Dictionary containing module configuration.
+        """
+        click.echo(json.dumps(module.model_dump(), indent=2, default=str))
+
+    def error_callback(error: str) -> None:
+        """Handle errors during action table show.
+
+        Args:
+            error: Error message string.
+        """
+        click.echo(error)
+
+    with service:
+        service.start(
+            serial_number=serial_number,
+            finish_callback=on_finish,
+            error_callback=error_callback,
+        )

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,
+        )