[ctrl] added shutdown and startup geocom commands

Author: MrClock8163

src/instrumentman/__init__.py

@@ -26,6 +26,7 @@
 from . import jobs
 from . import datatransfer
 from . import settings
+from . import control
 
 
 @extra_group(
@@ -151,6 +152,22 @@ def cli_upload() -> None:
     """Upload data to the instrument."""
 
 
+@cli.group(
+    "shutdown",
+    aliases=["sh", "exit", "deactivate", "turnoff", "switchoff"]
+)  # type: ignore[misc]
+def cli_shutdown() -> None:
+    """Deactivate various instrument functions."""
+
+
+@cli.group(
+    "startup",
+    aliases=["st", "enter", "activate", "turnon", "switchon"]
+)  # type: ignore[misc]
+def cli_startup() -> None:
+    """Activate various instrument functions."""
+
+
 cli.add_command(morse.cli)
 cli.add_command(terminal.cli)
 cli_measure.add_command(setmeasurement.cli_measure)
@@ -178,3 +195,5 @@ def cli_upload() -> None:
 cli_convert.add_command(setup.cli_convert_gsi_to_targets)
 cli_convert.add_command(setup.cli_convert_targets_to_gsi)
 cli_convert.add_command(setmeasurement.cli_convert_set_to_gsi)
+cli_shutdown.add_command(control.cli_shutdown_geocom)
+cli_startup.add_command(control.cli_startup_geocom)

src/instrumentman/control/__init__.py

@@ -0,0 +1,67 @@
+from typing import Any
+
+from click_extra import (
+    extra_command,
+    argument,
+    Choice
+)
+
+from ..utils import (
+    com_port_argument,
+    com_option_group
+)
+
+
+@extra_command(
+    "geocom",
+    params=None,
+    context_settings={"auto_envvar_prefix": None}
+)  # type: ignore[misc]
+@argument(
+    "component",
+    help="Instrument component to shut down",
+    type=Choice(
+        (
+            "protocol",
+            "instrument",
+            "edm",
+            "pointer",
+            "telescopic-camera",
+            "overview-camera"
+        ),
+        case_sensitive=False
+    )
+)
+@com_port_argument()
+@com_option_group()
+def cli_shutdown_geocom(**kwargs: Any) -> None:
+    from .app import main_shutdown_geocom
+
+    main_shutdown_geocom(**kwargs)
+
+
+@extra_command(
+    "geocom",
+    params=None,
+    context_settings={"auto_envvar_prefix": None}
+)  # type: ignore[misc]
+@argument(
+    "component",
+    help="Instrument component to start up",
+    type=Choice(
+        (
+            "instrument",
+            "edm",
+            "pointer",
+            "telescopic-camera",
+            "overview-camera"
+        ),
+        case_sensitive=False
+    )
+)
+@com_port_argument()
+@com_option_group()
+def cli_startup_geocom(**kwargs: Any) -> None:
+    from .app import main_startup_geocom
+
+    main_startup_geocom(**kwargs)

src/instrumentman/control/app.py

@@ -0,0 +1,93 @@
+from logging import getLogger
+
+from geocompy.communication import open_serial
+from geocompy.geo import GeoCom
+from geocompy.geo.gctypes import GeoComCode
+
+from ..utils import print_error
+
+
+def main_shutdown_geocom(
+    component: str,
+    port: str,
+    timeout: int = 15,
+    retry: int = 1,
+    baud: int = 9600,
+    sync_after_timeout: bool = False
+) -> None:
+    logger = getLogger("iman.files.list")
+    with open_serial(
+        port,
+        speed=baud,
+        timeout=timeout,
+        retry=retry,
+        sync_after_timeout=sync_after_timeout,
+        logger=logger.getChild("com")
+    ) as com:
+        instrument = GeoCom(com, logger.getChild("instrument"))
+
+        match component:
+            case "protocol":
+                resp = instrument.com.switch_to_local()
+            case "edm":
+                resp = instrument.edm.switch_edm(False)
+            case "pointer":
+                resp = instrument.edm.switch_laserpointer(False)
+            case "telescopic-camera":
+                resp = instrument.cam.switch_camera_power(False, "TELESCOPIC")
+            case "overview-camera":
+                resp = instrument.cam.switch_camera_power(False, "OVERVIEW")
+            case "instrument":
+                resp = instrument.com.switch_off()
+            case _:
+                raise ValueError(
+                    f"Unknown component '{component}'"
+                )
+
+        if resp.error != GeoComCode.OK:
+            print_error(
+                f"Could not deactivate '{component}' ({resp.error.name})"
+            )
+            exit(1)
+
+
+def main_startup_geocom(
+    component: str,
+    port: str,
+    timeout: int = 15,
+    retry: int = 1,
+    baud: int = 9600,
+    sync_after_timeout: bool = False
+) -> None:
+    logger = getLogger("iman.files.list")
+    with open_serial(
+        port,
+        speed=baud,
+        timeout=timeout,
+        retry=retry,
+        sync_after_timeout=sync_after_timeout,
+        logger=logger.getChild("com")
+    ) as com:
+        instrument = GeoCom(com, logger.getChild("instrument"))
+
+        match component:
+            case "instrument":
+                resp = instrument.com.switch_on()
+            case "edm":
+                resp = instrument.edm.switch_edm(True)
+            case "pointer":
+                resp = instrument.edm.switch_laserpointer(True)
+            case "telescopic-camera":
+                resp = instrument.cam.switch_camera_power(True, "TELESCOPIC")
+            case "overview-camera":
+                resp = instrument.cam.switch_camera_power(True, "OVERVIEW")
+            case _:
+                raise ValueError(
+                    f"Unknown component '{component}'"
+                )
+
+        if resp.error != GeoComCode.OK:
+            print_error(
+                f"Could not activate '{component}'  ({resp.error.name})"
+            )
+            exit(1)