From 31d373309bcb7aaa5e954a2a165633518e5cc573 Mon Sep 17 00:00:00 2001 From: stokesMIDE Date: Tue, 27 Jan 2026 17:04:07 -0500 Subject: [PATCH 1/2] Added basic `idesync` utility documentation --- docs/utilities.rst | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/docs/utilities.rst b/docs/utilities.rst index 94a976ea..4b131e1b 100644 --- a/docs/utilities.rst +++ b/docs/utilities.rst @@ -29,7 +29,8 @@ You can run the utilities by running Python with the ``-m`` argument, followed b submodule and any arguments, e.g.: * ``python -m idelib.tools.ideexport --help`` -* ``python -m idelib.tools.ideexport --help`` +* ``python -m idelib.tools.ideinfo --help`` +* ``python -m idelib.tools.idesync --help`` While verbose, this is the most reliable way to run the utilities. @@ -43,6 +44,7 @@ be in your 'path', so running it is done by typing its name, followed by any arg * ``ideexport --help`` * ``ideinfo --help`` +* ``idesync --help`` Unfortunately, there are many factors specific to your computer and Python setup that can interfere with this. Most commonly, the executables are somewhere outside of your 'path' and could not be found, @@ -55,12 +57,11 @@ the standard 'not found' error for your OS. ``ideexport`` converts one or more IDE files into text (CSV, etc.) or Matlab MAT v5 files. - .. code-block:: usage: ideexport.py [-h] [-o OUTPUT] [-t {csv,mat,txt}] [-c CHANNEL] [-m] [-u] [-n] [-r] [-d {comma,tab,pipe}] [-f] FILENAME.IDE [FILENAME.IDE ...] - Batch IDE Conversion Utility v3.4.0b1 - Copyright (c) 2025 Midé Technology + Batch IDE Conversion Utility v3.4.0 - Copyright (c) 2026 Midé Technology positional arguments: FILENAME.IDE The source .IDE file(s) to convert. Wildcards permitted. @@ -76,6 +77,7 @@ the standard 'not found' error for your OS. -m, --removemean Remove the mean from accelerometer data. -u, --utc Write timestamps as UTC 'Unix epoch' time. -n, --names Include channel names in exported filenames. + -s, --sync Apply recordings' sychronization data (if present in the file). Text Export Options (CSV, TXT, etc.): -r, --headers Write 'header' information (column names) as the first row of text-based export. @@ -83,6 +85,28 @@ the standard 'not found' error for your OS. The delimiting character, for exporting non-CSV text-based files. -f, --isoformat Write timestamps as ISO-formatted UTC. +``idesync`` +----------- + +``idesync`` generates synchronization metadata, synchronizing one or more files to a 'reference' +recording. This information can be applied when exporting with ``ideexport``. + +.. code-block:: + + usage: idesync.py [-h] [-g] [-i] FILENAME.IDE [FILENAME.IDE ...] + + Batch IDE Synchronization Utility v3.4.0b1 - Copyright (c) 2025 Midé Technology + + positional arguments: + FILENAME.IDE The recording to which to synchronize the others, and/or adjustits starting time if --gps is used. + FILENAME.IDE Recordings to sync to the reference. + + options: + -h, --help show this help message and exit + -g, --gps Update the reference recording's start time using its GPS/GNSS data. Cannot be used in conjunction wtih --inherit. + -i, --inherit If the reference recording has been synced to another, sync the other datasets to that (rather than the reference itself). Cannot be used in conjunction with --gps. + + ``ideinfo`` ----------- @@ -93,7 +117,7 @@ writes it to a file. usage: ideinfo.py [-h] [-o OUTPUT] FILENAME.IDE [FILENAME.IDE ...] - IDE Info Viewer v3.4.0b1 - Copyright (c) 2025 Midé Technology + IDE Info Viewer v3.4.0 - Copyright (c) 2026 Midé Technology positional arguments: FILENAME.IDE The source .IDE file(s) to convert. Wildcards permitted. From 59ec7c00a1d4740f66e9ec3d948ddf824bea4c00 Mon Sep 17 00:00:00 2001 From: stokesMIDE Date: Tue, 27 Jan 2026 17:36:55 -0500 Subject: [PATCH 2/2] Minor doc clarification --- docs/utilities.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/utilities.rst b/docs/utilities.rst index 4b131e1b..1f1a5e9f 100644 --- a/docs/utilities.rst +++ b/docs/utilities.rst @@ -89,7 +89,8 @@ the standard 'not found' error for your OS. ----------- ``idesync`` generates synchronization metadata, synchronizing one or more files to a 'reference' -recording. This information can be applied when exporting with ``ideexport``. +recording. This information, which is inserted into the recording, can be applied when exporting +with ``ideexport --sync``. .. code-block:: @@ -106,6 +107,9 @@ recording. This information can be applied when exporting with ``ideexport``. -g, --gps Update the reference recording's start time using its GPS/GNSS data. Cannot be used in conjunction wtih --inherit. -i, --inherit If the reference recording has been synced to another, sync the other datasets to that (rather than the reference itself). Cannot be used in conjunction with --gps. +Note: The applied synchronization is not currently displayed when viewing recordings in *enDAQ Lab* +(verion 3.1.1 or earlier). + ``ideinfo`` -----------