Added GSI Online DNA tests

Author: MrClock8163

src/instrumentman/__init__.py

@@ -9,7 +9,7 @@
 from . import terminal
 from . import setup
 from . import setmeasurement
-from . import geocomtest
+from . import protocoltest
 from . import inclination
 
 
@@ -57,7 +57,8 @@ def cli_test() -> None:
 cli_measure.add_command(inclination.cli_measure)
 cli_calc.add_command(setmeasurement.cli_calc)
 cli_calc.add_command(inclination.cli_calc)
-cli_test.add_command(geocomtest.cli)
+cli_test.add_command(protocoltest.cli_geocom)
+cli_test.add_command(protocoltest.cli_gsidna)
 cli_merge.add_command(setmeasurement.cli_merge)
 cli_merge.add_command(inclination.cli_merge)
 cli_validate.add_command(setmeasurement.cli_validate)

src/instrumentman/geocomtest/__init__.py

@@ -0,0 +1,40 @@
+from typing import Any
+
+from click_extra import extra_command
+
+from ..utils import (
+    com_option_group,
+    com_port_argument
+)
+
+
+@extra_command(
+    "geocom",
+    params=None,
+    context_settings={"auto_envvar_prefix": None}
+)  # type: ignore[misc]
+@com_port_argument()
+@com_option_group()
+def cli_geocom(**kwargs: Any) -> None:
+    """Test the availability of various GeoCom protocol functions on an
+    instrument."""
+    from .app import main
+
+    kwargs["protocol"] = "geocom"
+    main(**kwargs)
+
+
+@extra_command(
+    "gsidna",
+    params=None,
+    context_settings={"auto_envvar_prefix": None}
+)  # type: ignore[misc]
+@com_port_argument()
+@com_option_group()
+def cli_gsidna(**kwargs: Any) -> None:
+    """Test the availability of various GSI Online DNA functions on an
+    instrument."""
+    from .app import main
+
+    kwargs["protocol"] = "gsidna"
+    main(**kwargs)

src/instrumentman/protocoltest/__init__.py

@@ -6,6 +6,7 @@
 from geocompy.data import Angle
 from geocompy.geo import GeoCom
 from geocompy.geo.gctypes import GeoComCode
+from geocompy.gsi.dna import GsiOnlineDNA
 from geocompy.communication import open_serial
 
 from ..utils import (
@@ -15,7 +16,7 @@
 )
 
 
-def tests(tps: GeoCom) -> None:
+def tests_geocom(tps: GeoCom) -> None:
     echo("GeoCom connection successful")
     echo(
         "Various GeoCom functions will be tested. Certain settings will be "
@@ -55,8 +56,44 @@ def tests(tps: GeoCom) -> None:
         echo_yellow(f"Mororization unavailable ({resp_changeface.response})")
 
 
+def tests_gsidna(dna: GsiOnlineDNA) -> None:
+    echo("GSI Online connection successful")
+    echo(
+        "Various GSI Online DNA functions will be tested. Certain settings "
+        "might be changed on the instrument (staff mode, point number, etc.)."
+    )
+    pause("Press any key when ready to proceed...")
+
+    echo("Testing settings...")
+    staff_get = dna.settings.get_staff_mode()
+    if staff_get.value is None:
+        echo_red("Settings queries unavailable")
+    else:
+        echo_green("Settings queries available")
+
+    staff_set = dna.settings.set_staff_mode(False)
+    if not staff_set.value:
+        echo_red("Settings commands unavailable")
+    else:
+        echo_green("Settings commands available")
+
+    echo("Testing measurements...")
+    point_get = dna.measurements.get_point_id()
+    if point_get is None:
+        echo_red("Measurement/database queries unavailable")
+    else:
+        echo_green("Measurement/database queries available")
+
+    point_set = dna.measurements.set_point_id("TEST")
+    if not point_set.value:
+        echo_red("Measurement/database commands unavailable")
+    else:
+        echo_green("Measurement/database commands available")
+
+
 def main(
     port: str,
+    protocol: str,
     baud: int = 9600,
     timeout: int = 15,
     retry: int = 1,
@@ -70,7 +107,11 @@ def main(
             retry=retry,
             sync_after_timeout=sync_after_timeout
         ) as com:
-            tps = GeoCom(com)
-            tests(tps)
+            if protocol == "geocom":
+                tps = GeoCom(com)
+                tests_geocom(tps)
+            elif protocol == "gsidna":
+                dna = GsiOnlineDNA(com)
+                tests_gsidna(dna)
     except (SerialException, ConnectionError) as e:
-        echo_red(f"GeoCom connection was not successful ({e})")
+        echo_red(f"Connection was not successful ({e})")