Merge pull request #28 from MrClock8163/feature/setmeasurement-update

Set measurement updates

Author: MrClock8163

CHANGELOG.md

@@ -16,10 +16,14 @@ The project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
   orientation
 - Added logging options to `iman` root command
 - Added logging to instrument connected commands
+- Added aliases to multiple commands and command groups
+- Added `dateformat` option to set measurement
+- Added `timeformat` option to set measurement
 
 ### Changed
 
 - `geocompy` dependency minimum version was bumped to `v0.11.0`
+- Updated descriptions in command helps
 - Updated file listing to display results in a tree view
 - Reworked file listing to be able to run recursively to build full tree view
 - Protocol tests now display results in a table
@@ -30,6 +34,8 @@ The project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
   option, instead of a comma separated string list
 - `chunk` option of file download now expects size in bytes, instead of
   encoded hex characters
+- Second argument (`output`) of set measurement now expects a file path or file
+  path template instead of a directory
 
 ### Fixed
 
@@ -41,6 +47,7 @@ The project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 ### Removed
 
 - Removed logging options from set measurement
+- Removed `format` option from set measurement
 
 ## v0.3.0 (2025-08-01)
 

docs/commands/sets/measure.rst

@@ -53,20 +53,25 @@ Examples
 .. code-block:: shell
     :caption: Enabling connection retries and timeout recovery attempts (might be useful with bluetooth connections)
 
-    iman measure sets -r 3 --sync-after-timeout COM3 targets.json results
+    iman measure set -r 3 --sync-after-timeout COM3 targets.json set.json
 
 .. code-block:: shell
     :caption: Measuring to just a subset of the targets
 
-    iman measure sets -p P1 -p P2 -p P8 COM3 targets.json results
+    iman measure set -p P1 -p P2 -p P8 COM3 targets.json set.json
 
 .. code-block:: shell
     :caption: Measuring in face 1 only
 
-    iman measure sets -o ABCD COM3 targets.json results
+    iman measure set -o ABCD COM3 targets.json set.json
+
+.. code-block:: shell
+    :caption: Saving results with file name template (useful for scheduled measurements)
+
+    iman measure set COM3 targets.json "set_{date}_{time}.json"
 
 Usage
 -----
 
 .. click:: instrumentman.setmeasurement:cli_measure
-    :prog: iman measure sets
+    :prog: iman measure set

src/instrumentman/setmeasurement/__init__.py

@@ -7,8 +7,7 @@
     constraint,
     Choice,
     IntRange,
-    file_path,
-    dir_path
+    file_path
 )
 from cloup.constraints import all_or_none
 
@@ -22,7 +21,8 @@
 @extra_command(
     "sets",
     params=None,
-    context_settings={"auto_envvar_prefix": None}
+    context_settings={"auto_envvar_prefix": None},
+    aliases=["set"]
 )  # type: ignore[misc]
 @com_port_argument()
 @argument(
@@ -31,20 +31,25 @@
     help="JSON file containing target definitions"
 )
 @argument(
-    "directory",
-    type=dir_path(),
-    help="Directory to save measurement output to"
+    "output",
+    type=str,
+    help=(
+        "Output file path or path template with placeholders "
+        "('{date}', '{time}', '{order}', '{cycles}')"
+    )
 )
 @com_option_group()
 @option(
-    "-f",
-    "--format",
+    "--dateformat",
     type=str,
-    default="setmeasurement_{time}.json",
-    help=(
-        "Session output file name format with placeholders "
-        "(`{time}`: timestamp, `{order}`: order, `{cycle}`: cycles)"
-    )
+    default="%Y%m%d",
+    help="Date format as accepted by strftime"
+)
+@option(
+    "--timeformat",
+    type=str,
+    default="%H%M%S",
+    help="Time format as accepted by strftime"
 )
 @option(
     "-c",
@@ -99,7 +104,8 @@ def cli_measure(**kwargs: Any) -> None:
 @extra_command(
     "sets",
     params=None,
-    context_settings={"auto_envvar_prefix": None}
+    context_settings={"auto_envvar_prefix": None},
+    aliases=["set"]
 )  # type: ignore[misc]
 @argument(
     "output",
@@ -137,7 +143,8 @@ def cli_merge(**kwargs: Any) -> None:
 @extra_command(
     "sets",
     params=None,
-    context_settings={"auto_envvar_prefix": None}
+    context_settings={"auto_envvar_prefix": None},
+    aliases=["set"]
 )  # type: ignore[misc]
 @argument(
     "inputs",
@@ -172,7 +179,8 @@ def cli_validate(**kwargs: Any) -> None:
 @extra_command(
     "sets",
     params=None,
-    context_settings={"auto_envvar_prefix": None}
+    context_settings={"auto_envvar_prefix": None},
+    aliases=["set"]
 )  # type: ignore[misc]
 @argument(
     "input",

src/instrumentman/setmeasurement/measure.py

@@ -1,4 +1,3 @@
-import os
 from datetime import datetime
 from logging import Logger, getLogger
 from typing import Iterator, Literal
@@ -177,12 +176,13 @@ def measure_set(
 def main(
     port: str,
     targets: pathlib.Path,
-    directory: pathlib.Path,
+    output: str,
     baud: int = 9600,
     timeout: int = 15,
     retry: int = 1,
     sync_after_timeout: bool = False,
-    format: str = "setmeasurement_{time}.json",
+    dateformat: str = "%Y%m%d",
+    timeformat: str = "%H%M%S",
     cycles: int = 1,
     order: Literal['AaBb', 'AabB', 'ABab', 'ABba', 'ABCD'] = "ABba",
     sync_time: bool = True,
@@ -211,10 +211,14 @@ def main(
             points
         )
 
-    timestamp = session.cycles[0].time.strftime("%Y%m%d_%H%M%S")
-    filename = os.path.join(
-        directory,
-        format.format(time=timestamp, order=order, cycle=cycles)
+    epoch = session.cycles[0].time
+    date = epoch.strftime(dateformat)
+    time = epoch.strftime(timeformat)
+    filename = output.format(
+        date=date,
+        time=time,
+        order=order,
+        cycles=cycles
     )
     session.export_to_json(filename)
     logger.info(f"Saved measurement results to '{filename}'")