[ctrl] added docs

Author: MrClock8163

docs/commands/control/index.rst

@@ -0,0 +1,13 @@
+:icon: material/toggle-switch
+
+Control
+=======
+
+The control commands are a set of simple utilities to activate or deactivate
+certain components of an instrument.
+
+.. toctree::
+    :maxdepth: 1
+
+    shutdown_geocom
+    startup_geocom

docs/commands/control/shutdown_geocom.rst

@@ -0,0 +1,29 @@
+Shutdown - GeoCom
+=================
+
+For power management reasons, it might be required to deactivate some aspects
+of an instrument to conserve power. 
+
+Requirements
+------------
+
+- GeoCom capable instrument
+
+Examples
+--------
+
+.. code-block:: shell
+    :caption: Shutting down the instrument
+
+    iman shutdown geocom instrument COM1
+
+.. code-block:: shell
+    :caption: Deactivating GeoCom online mode (only applicable before TPS1200)
+
+    iman shutdown geocom protocol COM1
+
+Usage
+-----
+
+.. click:: instrumentman.control:cli_shutdown_geocom
+    :prog: iman shutdown geocom

docs/commands/control/startup_geocom.rst

@@ -0,0 +1,24 @@
+Startup - GeoCom
+=================
+
+If an instrument system was deactivated, it might be necessary to reactivate it
+before using certain capabilities of the instrument.
+
+Requirements
+------------
+
+- GeoCom capable instrument
+
+Examples
+--------
+
+.. code-block:: shell
+    :caption: Activating laser pointer
+
+    iman startup geocom pointer COM1
+
+Usage
+-----
+
+.. click:: instrumentman.control:cli_startup_geocom
+    :prog: iman startup geocom

docs/index.rst

@@ -46,6 +46,7 @@ Content
     commands/data/index
     commands/jobs/index
     commands/settings/index
+    commands/control/index
     commands/station/index
 
 Indices

docs/latexindex.rst

@@ -31,4 +31,5 @@ Applications
     commands/data/index
     commands/jobs/index
     commands/settings/index
+    commands/control/index
     commands/station/index

src/instrumentman/control/__init__.py

@@ -35,6 +35,21 @@
 @com_port_argument()
 @com_option_group()
 def cli_shutdown_geocom(**kwargs: Any) -> None:
+    """
+    Deactivate components of a GeoCom capable instrument.
+
+    To reduce power consumption, in certain scenarios it can be beneficial to
+    power off some components of an instrument. Or shut down the entire machine
+    completely.
+
+    Instruments before the TPS1200 series cannot be remotely reactivated after
+    a complete shutdown (the GeoCom online mode has to be manually switched
+    on). Similarly, instruments that are not connected by physical cable (but
+    by Bluetooth for example) cannot be reactivated as the wireless connection
+    can only be esatblished with an active instrument. Only shut down these
+    instruments remotely if no further operation is needed until the next
+    manual access.
+    """
     from .app import main_shutdown_geocom
 
     main_shutdown_geocom(**kwargs)
@@ -62,6 +77,12 @@ def cli_shutdown_geocom(**kwargs: Any) -> None:
 @com_port_argument()
 @com_option_group()
 def cli_startup_geocom(**kwargs: Any) -> None:
+    """
+    Activate/reactivate components of a GeoCom capable instrument.
+
+    Instruments can be reactivated remotely after a complete shutdown only if
+    they are TPS1200 or newer series and connected by a physical cable.
+    """
     from .app import main_startup_geocom
 
     main_startup_geocom(**kwargs)

src/instrumentman/control/app.py

@@ -15,7 +15,7 @@ def main_shutdown_geocom(
     baud: int = 9600,
     sync_after_timeout: bool = False
 ) -> None:
-    logger = getLogger("iman.files.list")
+    logger = getLogger("iman.control.shutdown_geocom")
     with open_serial(
         port,
         speed=baud,
@@ -59,7 +59,7 @@ def main_startup_geocom(
     baud: int = 9600,
     sync_after_timeout: bool = False
 ) -> None:
-    logger = getLogger("iman.files.list")
+    logger = getLogger("iman.control.startup_geocom")
     with open_serial(
         port,
         speed=baud,