conson-xp 1.18.0__py3-none-any.whl

xp/cli/commands/conbus/conbus_lightlevel_commands.py

@@ -0,0 +1,207 @@
+"""Conbus lightlevel operations CLI commands."""
+
+import json
+
+import click
+
+from xp.cli.commands.conbus.conbus import conbus_lightlevel
+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_lightlevel.command("set")
+@click.argument("serial_number", type=SERIAL)
+@click.argument("output_number", type=click.IntRange(0, 8))
+@click.argument("level", type=click.IntRange(0, 100))
+@click.pass_context
+@connection_command()
+def xp_lightlevel_set(
+    ctx: click.Context, serial_number: str, output_number: int, level: int
+) -> None:
+    r"""Set 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).
+        level: Light level (0-100).
+
+    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 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)
+    )
+
+    data_value = f"{output_number:02d}:{level:03d}"
+
+    with service:
+        service.write_config(
+            serial_number=serial_number,
+            datapoint_type=DataPointType.MODULE_LIGHT_LEVEL,
+            data_value=data_value,
+            finish_callback=on_finish,
+            timeout_seconds=0.5,
+        )
+
+
+@conbus_lightlevel.command("off")
+@click.argument("serial_number", type=SERIAL)
+@click.argument("output_number", type=click.IntRange(0, 8))
+@click.pass_context
+@connection_command()
+def xp_lightlevel_off(
+    ctx: click.Context, serial_number: str, output_number: int
+) -> None:
+    r"""Turn off light for output_number on XP module serial_number (set level to 0).
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        output_number: Output number (0-8).
+
+    Examples:
+        \b
+        xp conbus lightlevel off 0123450001 2   # Turn off output 2
+        xp conbus lightlevel off 0011223344 0   # Turn off output 0
+    """
+
+    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)
+    )
+
+    level = 0
+    data_value = f"{output_number:02d}:{level:03d}"
+
+    with service:
+        service.write_config(
+            serial_number=serial_number,
+            datapoint_type=DataPointType.MODULE_LIGHT_LEVEL,
+            data_value=data_value,
+            finish_callback=on_finish,
+            timeout_seconds=0.5,
+        )
+
+
+@conbus_lightlevel.command("on")
+@click.argument("serial_number", type=SERIAL)
+@click.argument("output_number", type=click.IntRange(0, 8))
+@click.pass_context
+@connection_command()
+def xp_lightlevel_on(
+    ctx: click.Context, serial_number: str, output_number: int
+) -> None:
+    r"""Turn on light for output_number on XP module serial_number (set level to 80%).
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        output_number: Output number (0-8).
+
+    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 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)
+    )
+
+    level = 60
+    data_value = f"{output_number:02d}:{level:03d}"
+
+    with service:
+        service.write_config(
+            serial_number=serial_number,
+            datapoint_type=DataPointType.MODULE_LIGHT_LEVEL,
+            data_value=data_value,
+            finish_callback=on_finish,
+            timeout_seconds=0.5,
+        )
+
+
+@conbus_lightlevel.command("get")
+@click.argument("serial_number", type=SERIAL)
+@click.argument("output_number", type=click.IntRange(0, 8))
+@click.pass_context
+@connection_command()
+def xp_lightlevel_get(
+    ctx: click.Context, serial_number: str, output_number: int
+) -> None:
+    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
+        xp conbus lightlevel get 0123450001 2   # Get light level for output 2
+        xp conbus lightlevel get 0011223344 0   # Get light level for output 0
+    """
+    # 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 light level get command.
+
+        Args:
+            service_response: Light level response object.
+        """
+        lightlevel_level = telegram_service.get_lightlevel(
+            service_response.data_value, output_number
+        )
+        result = service_response.to_dict()
+        result["output_number"] = output_number
+        result["lightlevel_level"] = lightlevel_level
+        click.echo(json.dumps(result, indent=2))
+
+    with service:
+        service.query_datapoint(
+            serial_number=serial_number,
+            datapoint_type=DataPointType.MODULE_LIGHT_LEVEL,
+            finish_callback=on_finish,
+            timeout_seconds=0.5,
+        )

xp/cli/commands/conbus/conbus_linknumber_commands.py

@@ -0,0 +1,102 @@
+"""Conbus link number CLI commands."""
+
+import json
+
+import click
+
+from xp.cli.commands.conbus.conbus import conbus_linknumber
+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_linknumber.command("set", short_help="Set link number for a module")
+@click.argument("serial_number", type=SERIAL)
+@click.argument("link_number", type=click.IntRange(0, 99))
+@click.pass_context
+@connection_command()
+def set_linknumber_command(
+    ctx: click.Context, serial_number: str, link_number: int
+) -> None:
+    r"""Set the link number for a specific module.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        link_number: Link number to set (0-99).
+
+    Examples:
+        \b
+        xp conbus linknumber set 0123450001 25
+    """
+
+    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)
+    )
+
+    data_value = f"{link_number:02d}"
+    with service:
+        service.write_config(
+            serial_number=serial_number,
+            datapoint_type=DataPointType.LINK_NUMBER,
+            data_value=data_value,
+            finish_callback=on_finish,
+            timeout_seconds=0.5,
+        )
+
+
+@conbus_linknumber.command("get", short_help="Get link number for a module")
+@click.argument("serial_number", type=SERIAL)
+@click.pass_context
+@connection_command()
+def get_linknumber_command(ctx: click.Context, serial_number: str) -> None:
+    r"""Get the current link number for a specific module.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+
+    Examples:
+        \b
+        xp conbus linknumber get 0123450001
+    """
+    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 link number get command.
+
+        Args:
+            service_response: Link number response object.
+        """
+        linknumber_value = telegram_service.get_linknumber(service_response.data_value)
+        result = service_response.to_dict()
+        result["linknumber_value"] = linknumber_value
+        click.echo(json.dumps(result, indent=2))
+
+    with service:
+        service.query_datapoint(
+            serial_number=serial_number,
+            datapoint_type=DataPointType.LINK_NUMBER,
+            finish_callback=on_finish,
+            timeout_seconds=0.5,
+        )

xp/cli/commands/conbus/conbus_modulenumber_commands.py

@@ -0,0 +1,104 @@
+"""Conbus module number CLI commands."""
+
+import json
+
+import click
+
+from xp.cli.commands.conbus.conbus import conbus_modulenumber
+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_modulenumber.command("set", short_help="Set module number for a module")
+@click.argument("serial_number", type=SERIAL)
+@click.argument("module_number", type=click.IntRange(0, 99))
+@click.pass_context
+@connection_command()
+def set_modulenumber_command(
+    ctx: click.Context, serial_number: str, module_number: int
+) -> None:
+    r"""Set the module number for a specific module.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        module_number: Module number to set (0-99).
+
+    Examples:
+        \b
+        xp conbus modulenumber set 0123450001 25
+    """
+
+    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)
+    )
+
+    data_value = f"{module_number:02d}"
+    with service:
+        service.write_config(
+            serial_number=serial_number,
+            datapoint_type=DataPointType.MODULE_NUMBER,
+            data_value=data_value,
+            finish_callback=on_finish,
+            timeout_seconds=0.5,
+        )
+
+
+@conbus_modulenumber.command("get", short_help="Get module number for a module")
+@click.argument("serial_number", type=SERIAL)
+@click.pass_context
+@connection_command()
+def get_modulenumber_command(ctx: click.Context, serial_number: str) -> None:
+    r"""Get the current module number for a specific module.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+
+    Examples:
+        \b
+        xp conbus modulenumber get 0123450001
+    """
+    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 module number get command.
+
+        Args:
+            service_response: Module number response object.
+        """
+        modulenumber_value = telegram_service.get_modulenumber(
+            service_response.data_value
+        )
+        result = service_response.to_dict()
+        result["modulenumber_value"] = modulenumber_value
+        click.echo(json.dumps(result, indent=2))
+
+    with service:
+        service.query_datapoint(
+            serial_number=serial_number,
+            datapoint_type=DataPointType.MODULE_NUMBER,
+            finish_callback=on_finish,
+            timeout_seconds=0.5,
+        )

xp/cli/commands/conbus/conbus_msactiontable_commands.py

@@ -0,0 +1,94 @@
+"""XP24 Action Table CLI commands."""
+
+import json
+from dataclasses import asdict
+from typing import Union
+
+import click
+from click import Context
+
+from xp.cli.commands.conbus.conbus import conbus_msactiontable
+from xp.cli.utils.decorators import (
+    connection_command,
+)
+from xp.cli.utils.serial_number_type import SERIAL
+from xp.cli.utils.xp_module_type import XP_MODULE_TYPE
+from xp.models.actiontable.msactiontable_xp20 import Xp20MsActionTable
+from xp.models.actiontable.msactiontable_xp24 import Xp24MsActionTable
+from xp.models.actiontable.msactiontable_xp33 import Xp33MsActionTable
+from xp.services.conbus.actiontable.msactiontable_service import (
+    MsActionTableService,
+)
+
+
+@conbus_msactiontable.command("download", short_help="Download MSActionTable")
+@click.argument("serial_number", type=SERIAL)
+@click.argument("xpmoduletype", type=XP_MODULE_TYPE)
+@click.pass_context
+@connection_command()
+def conbus_download_msactiontable(
+    ctx: Context, serial_number: str, xpmoduletype: str
+) -> None:
+    """Download MS action table from XP24 module.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        xpmoduletype: XP module type.
+    """
+    service: MsActionTableService = (
+        ctx.obj.get("container").get_container().resolve(MsActionTableService)
+    )
+
+    def progress_callback(progress: str) -> None:
+        """Handle progress updates during MS action table download.
+
+        Args:
+            progress: Progress message string.
+        """
+        click.echo(progress, nl=False)
+
+    def on_finish(
+        action_table: Union[
+            Xp20MsActionTable, Xp24MsActionTable, Xp33MsActionTable, None
+        ],
+    ) -> None:
+        """Handle successful completion of MS action table download.
+
+        Args:
+            action_table: Downloaded MS action table object or None if failed.
+
+        Raises:
+            Abort: If action table download failed.
+        """
+        if action_table is None:
+            click.echo("Error: Failed to download MS action table")
+            raise click.Abort()
+
+        output = {
+            "serial_number": serial_number,
+            "xpmoduletype": xpmoduletype,
+            "action_table": asdict(action_table),
+        }
+        click.echo(json.dumps(output, indent=2, default=str))
+
+    def error_callback(error: str) -> None:
+        """Handle errors during MS action table download.
+
+        Args:
+            error: Error message string.
+
+        Raises:
+            Abort: Always raised to abort the command on error.
+        """
+        click.echo(f"Error: {error}")
+        raise click.Abort()
+
+    with service:
+        service.start(
+            serial_number=serial_number,
+            xpmoduletype=xpmoduletype,
+            progress_callback=progress_callback,
+            finish_callback=on_finish,
+            error_callback=error_callback,
+        )

xp/cli/commands/conbus/conbus_output_commands.py

@@ -0,0 +1,163 @@
+"""Conbus client operations CLI commands."""
+
+import json
+
+import click
+
+from xp.cli.commands.conbus.conbus import conbus_output
+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_output import ConbusOutputResponse
+from xp.models.telegram.action_type import ActionType
+from xp.models.telegram.datapoint_type import DataPointType
+from xp.services.conbus.conbus_datapoint_service import ConbusDatapointService
+from xp.services.conbus.conbus_output_service import ConbusOutputService
+
+
+@conbus_output.command("on")
+@click.argument("serial_number", type=SERIAL)
+@click.argument("output_number", type=int)
+@click.pass_context
+@connection_command()
+def xp_output_on(ctx: click.Context, serial_number: str, output_number: int) -> None:
+    r"""Send ON command for output_number XP module serial_number.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        output_number: Output number.
+
+    Examples:
+        \b
+        xp conbus output on 0011223344 0  # Turn on output 0
+    """
+    service: ConbusOutputService = (
+        ctx.obj.get("container").get_container().resolve(ConbusOutputService)
+    )
+
+    def on_finish(response: ConbusOutputResponse) -> None:
+        """Handle successful completion of output on command.
+
+        Args:
+            response: Output response object.
+        """
+        click.echo(json.dumps(response.to_dict(), indent=2))
+
+    with service:
+        service.send_action(
+            serial_number=serial_number,
+            output_number=output_number,
+            action_type=ActionType.ON_RELEASE,
+            finish_callback=on_finish,
+        )
+
+
+@conbus_output.command("off")
+@click.argument("serial_number", type=SERIAL)
+@click.argument("output_number", type=int)
+@click.pass_context
+@connection_command()
+def xp_output_off(ctx: click.Context, serial_number: str, output_number: int) -> None:
+    r"""Send OFF command for output_number XP module serial_number.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+        output_number: Output number.
+
+    Examples:
+        \b
+        xp conbus output off 0011223344 1    # Turn off output 1
+    """
+    service: ConbusOutputService = (
+        ctx.obj.get("container").get_container().resolve(ConbusOutputService)
+    )
+
+    def on_finish(response: ConbusOutputResponse) -> None:
+        """Handle successful completion of output off command.
+
+        Args:
+            response: Output response object.
+        """
+        click.echo(json.dumps(response.to_dict(), indent=2))
+
+    with service:
+        service.send_action(
+            serial_number=serial_number,
+            output_number=output_number,
+            action_type=ActionType.OFF_PRESS,
+            finish_callback=on_finish,
+        )
+
+
+@conbus_output.command("status")
+@click.argument("serial_number", type=SERIAL)
+@click.pass_context
+@connection_command()
+def xp_output_status(ctx: click.Context, serial_number: str) -> None:
+    r"""Query output state command to XP module serial_number.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+
+    Examples:
+        \b
+        xp conbus output status 0011223344    # Query output status
+    """
+    service: ConbusDatapointService = (
+        ctx.obj.get("container").get_container().resolve(ConbusDatapointService)
+    )
+
+    def on_finish(response: ConbusDatapointResponse) -> None:
+        """Handle successful completion of output status query.
+
+        Args:
+            response: Datapoint response object.
+        """
+        click.echo(json.dumps(response.to_dict(), indent=2))
+
+    with service:
+        service.query_datapoint(
+            serial_number=serial_number,
+            datapoint_type=DataPointType.MODULE_OUTPUT_STATE,
+            finish_callback=on_finish,
+        )
+
+
+@conbus_output.command("state")
+@click.argument("serial_number", type=SERIAL)
+@click.pass_context
+@connection_command()
+def xp_module_state(ctx: click.Context, serial_number: str) -> None:
+    r"""Query module state of the XP module serial_number.
+
+    Args:
+        ctx: Click context object.
+        serial_number: 10-digit module serial number.
+
+    Examples:
+        \b
+        xp conbus output state 0011223344    # Query module state
+    """
+    service: ConbusDatapointService = (
+        ctx.obj.get("container").get_container().resolve(ConbusDatapointService)
+    )
+
+    def on_finish(response: ConbusDatapointResponse) -> None:
+        """Handle successful completion of module state query.
+
+        Args:
+            response: Datapoint response object.
+        """
+        click.echo(json.dumps(response.to_dict(), indent=2))
+
+    with service:
+        service.query_datapoint(
+            serial_number=serial_number,
+            datapoint_type=DataPointType.MODULE_STATE,
+            finish_callback=on_finish,
+        )