SpecLog 0.0.3__tar.gz → 0.0.5__tar.gz

speclog-0.0.5/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yen-Chun Huang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

speclog-0.0.5/PKG-INFO

@@ -0,0 +1,178 @@
+Metadata-Version: 2.4
+Name: SpecLog
+Version: 0.0.5
+Summary: A Python Package for logging data from instrumentations
+Author-email: Yen-Chun Huang <yen-chun.huang@bruker.com>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib>=3.7.1
+Requires-Dist: numpy>=1.24.3
+Requires-Dist: PySide6>=6.9.0
+Requires-Dist: pyqtgraph>=0.13.3
+Requires-Dist: spinlab>=1.1.3
+Requires-Dist: pyserial>=3.5
+Dynamic: license-file
+
+# SpecLog
+
+SpecLog records data from connected spectrometer instruments and provides a
+desktop monitor for viewing live and historical measurements.
+
+## Quick start
+
+Start the logger:
+
+```text
+SpecLogger
+```
+
+Open the monitor:
+
+```text
+SpecMonitor
+```
+
+Keep the logger running while using the monitor. The logger collects and saves
+instrument data; the monitor reads and displays those saved measurements.
+
+## Configure SpecLog
+
+Open the configuration editor:
+
+```text
+SpecLogger --config
+```
+
+The shared configuration is saved at:
+
+```text
+C:\Users\Public\LOG_Config\config.cfg
+```
+
+Use the section list on the left to select global settings or a device.
+
+### Global settings
+
+The **SETTINGS** section contains options such as:
+
+- Logging interval
+- Log-folder location
+- Maximum log-file size
+
+### Device communication
+
+For each device, use the **Communication** tab to configure its connection:
+
+- Enable or disable the device
+- Protocol
+- Address or COM port
+- Baud rate
+- Termination
+- Other serial communication attributes
+
+### Device commands
+
+Use **Commands > Values** for ordinary measurements. Each command can contain:
+
+- Variable name
+- Instrument command
+- Display alias
+- Minimum and maximum limits
+- Expected static value
+
+Use **Commands > Status Indicators** for commands that return status bits.
+Click the indicators button to add, remove, reorder, or reverse individual
+indicators. The editor calculates `bits` and `bit_static` automatically.
+
+Click **Save** after making changes. The editor validates the configuration and
+keeps the previous file as `config.cfg.bak`. Restart the logger and monitor to
+apply the updated configuration.
+
+## Control the logger
+
+Start or stop the logger from a terminal:
+
+```text
+SpecLogger start
+SpecLogger stop
+```
+
+You can also use **Start** and **Stop** at the bottom of the configuration
+editor. Current status is shown as **Running**, **Stopped**, or **Status
+unavailable**. Operation results and errors appear in the **Messages** area.
+
+For troubleshooting, start the logger with a visible debug console:
+
+```text
+SpecLogger -debug True
+```
+
+## Start logging automatically without login
+
+Open a terminal as Administrator and enable system startup:
+
+```text
+SpecLogger -startup True
+```
+
+The logger will start automatically after the next computer boot. A 30-second
+delay allows USB and serial drivers to initialize first.
+
+To run it immediately without rebooting:
+
+```text
+SpecLogger start
+```
+
+Disable automatic startup from an Administrator terminal:
+
+```text
+SpecLogger -startup False
+```
+
+The configuration editor also provides **Enable** and **Disable** startup
+buttons. Administrator permission is normally required to use them.
+
+If the startup task was created by another administrator, a standard account
+may show startup as **Unavailable**. If new log data is still being written, the
+logger status displays **Running (log activity)**. Start and Stop remain disabled
+until the editor is opened with sufficient permission.
+
+## Use the monitor
+
+Open the monitor normally:
+
+```text
+SpecMonitor
+```
+
+Use the monitoring-item controls to select which measurements are plotted. Use
+the data-selection controls to choose a start time and duration.
+
+To load all available history, leave the date fields at their defaults and click
+**Ok**. The first import may take longer; later queries load only new or changed
+files.
+
+Start the monitor with a visible debug console when troubleshooting:
+
+```text
+SpecMonitor -debug True
+```
+
+## Common status messages
+
+- **Running**: The logger is active and directly detectable.
+- **Running (log activity)**: New data confirms that the logger is active, but
+  the current Windows account cannot query the system startup task.
+- **Stopped**: The logger is not running.
+- **Status unavailable**: The current account cannot verify the logger state and
+  no recent log activity was detected.
+- **Startup Enabled**: Automatic logging is configured for system boot.
+- **Startup Disabled**: The startup task exists but automatic boot startup is
+  disabled.
+- **Startup Unavailable**: Open the configuration editor as Administrator to
+  inspect or control a task created by another administrator.

speclog-0.0.5/README.md

@@ -0,0 +1,159 @@
+# SpecLog
+
+SpecLog records data from connected spectrometer instruments and provides a
+desktop monitor for viewing live and historical measurements.
+
+## Quick start
+
+Start the logger:
+
+```text
+SpecLogger
+```
+
+Open the monitor:
+
+```text
+SpecMonitor
+```
+
+Keep the logger running while using the monitor. The logger collects and saves
+instrument data; the monitor reads and displays those saved measurements.
+
+## Configure SpecLog
+
+Open the configuration editor:
+
+```text
+SpecLogger --config
+```
+
+The shared configuration is saved at:
+
+```text
+C:\Users\Public\LOG_Config\config.cfg
+```
+
+Use the section list on the left to select global settings or a device.
+
+### Global settings
+
+The **SETTINGS** section contains options such as:
+
+- Logging interval
+- Log-folder location
+- Maximum log-file size
+
+### Device communication
+
+For each device, use the **Communication** tab to configure its connection:
+
+- Enable or disable the device
+- Protocol
+- Address or COM port
+- Baud rate
+- Termination
+- Other serial communication attributes
+
+### Device commands
+
+Use **Commands > Values** for ordinary measurements. Each command can contain:
+
+- Variable name
+- Instrument command
+- Display alias
+- Minimum and maximum limits
+- Expected static value
+
+Use **Commands > Status Indicators** for commands that return status bits.
+Click the indicators button to add, remove, reorder, or reverse individual
+indicators. The editor calculates `bits` and `bit_static` automatically.
+
+Click **Save** after making changes. The editor validates the configuration and
+keeps the previous file as `config.cfg.bak`. Restart the logger and monitor to
+apply the updated configuration.
+
+## Control the logger
+
+Start or stop the logger from a terminal:
+
+```text
+SpecLogger start
+SpecLogger stop
+```
+
+You can also use **Start** and **Stop** at the bottom of the configuration
+editor. Current status is shown as **Running**, **Stopped**, or **Status
+unavailable**. Operation results and errors appear in the **Messages** area.
+
+For troubleshooting, start the logger with a visible debug console:
+
+```text
+SpecLogger -debug True
+```
+
+## Start logging automatically without login
+
+Open a terminal as Administrator and enable system startup:
+
+```text
+SpecLogger -startup True
+```
+
+The logger will start automatically after the next computer boot. A 30-second
+delay allows USB and serial drivers to initialize first.
+
+To run it immediately without rebooting:
+
+```text
+SpecLogger start
+```
+
+Disable automatic startup from an Administrator terminal:
+
+```text
+SpecLogger -startup False
+```
+
+The configuration editor also provides **Enable** and **Disable** startup
+buttons. Administrator permission is normally required to use them.
+
+If the startup task was created by another administrator, a standard account
+may show startup as **Unavailable**. If new log data is still being written, the
+logger status displays **Running (log activity)**. Start and Stop remain disabled
+until the editor is opened with sufficient permission.
+
+## Use the monitor
+
+Open the monitor normally:
+
+```text
+SpecMonitor
+```
+
+Use the monitoring-item controls to select which measurements are plotted. Use
+the data-selection controls to choose a start time and duration.
+
+To load all available history, leave the date fields at their defaults and click
+**Ok**. The first import may take longer; later queries load only new or changed
+files.
+
+Start the monitor with a visible debug console when troubleshooting:
+
+```text
+SpecMonitor -debug True
+```
+
+## Common status messages
+
+- **Running**: The logger is active and directly detectable.
+- **Running (log activity)**: New data confirms that the logger is active, but
+  the current Windows account cannot query the system startup task.
+- **Stopped**: The logger is not running.
+- **Status unavailable**: The current account cannot verify the logger state and
+  no recent log activity was detected.
+- **Startup Enabled**: Automatic logging is configured for system boot.
+- **Startup Disabled**: The startup task exists but automatic boot startup is
+  disabled.
+- **Startup Unavailable**: Open the configuration editor as Administrator to
+  inspect or control a task created by another administrator.

{speclog-0.0.3 → speclog-0.0.5}/SpecLog/SpecLog.py

@@ -17,7 +17,7 @@ from .debugLog import *
 
 
 class SpecLog:
-    def __init__(self, config_file: str = None):
+    def __init__(self, config_file: str = None, protocols=None):
         self.config = loggerConfig(config_file)
         self.debugLogger = debugLog(config_file).logger
         self.settings = self.config.settings
@@ -25,6 +25,7 @@ class SpecLog:
             self.config.commands
         )  # dictionary {model: {variable: {command, alias, min, max, static}}}
         self.device_config = self.config.devices
+        self.protocols = protocols
 
         self.log_dir = self.settings["log_folder_location"] + "/LOG/"
         self._checkDirectory()
@@ -60,14 +61,12 @@ class SpecLog:
         if not self.last_query_time or now - self.last_query_time > self.delay:
             warning_level = 0
             self._setTimeInDataDictByVariable()  # update time
-            devices_info = (
-                self.devices.devices_info
+            device_info = (
+                self.devices.device_info
             )  # dictionary: {model: {status, config_status, device, id_command}}
             for name, info in self.commands.items():
                 delimiter = self.device_config[name]["delimiter"]
                 index = self.device_config[name]["index"]
-                device = devices_info[name]["device"]
-                termination = self.device_config[name]["termination"]
                 for variable in info.keys():
                     info[variable]['min'], info[variable]['max'], info[variable]['static']
                     if self.devices.checkDeviceStatus(
@@ -75,13 +74,12 @@ class SpecLog:
                     ):  # check the connection of a device
                         try:
                             command = info[variable]["command"]
-                            device.write((command+termination).encode())  # send command to device
-                            data_string = device.read_until(termination.encode()).decode()
+                            data_string = self.devices.query(name, command)
                             data = self._returnStringConverter(
                                 data_string, delimiter, index
                             )
                         except Exception as err:
-                            self.devices.device_info["status"] = False
+                            self.debugLogger.error(err)
                             data = "nan"
                    
                     else:
@@ -92,22 +90,25 @@ class SpecLog:
                     if data == "nan":
                         warning_level = 2
 
-                    elif info[variable]['static'] and float(data) != info[variable]['static']:
+                    elif (
+                        info[variable]['static'] is not None
+                        and float(data) != info[variable]['static']
+                    ):
                         warning_level = 2
                     
                     else:
-                        if info[variable]['min']:
-                            if float(data) <= info[variable]['min'] * 1.05:
-                                warning_level = max(warning_level, 1)
-                            elif float(data) < info[variable]['min']:
+                        if info[variable]['min'] is not None:
+                            if float(data) < info[variable]['min']:
                                 warning_level = 2
+                            elif float(data) <= info[variable]['min'] * 1.05:
+                                warning_level = max(warning_level, 1)
                                 
 
-                        if info[variable]['max']:
-                            if float(data) >= info[variable]['max'] * 0.95:
-                                warning_level = max(warning_level, 1)
-                            elif float(data) > info[variable]['max']:
+                        if info[variable]['max'] is not None:
+                            if float(data) > info[variable]['max']:
                                 warning_level = 2
+                            elif float(data) >= info[variable]['max'] * 0.95:
+                                warning_level = max(warning_level, 1)
                     self.warning = warning_level
 
             self.last_query_time = now
@@ -122,37 +123,18 @@ class SpecLog:
         """
         Call DEVICE
         """
-        self.devices = DEVICE(self.config, self.debugLogger)  # establish communication
+        self.devices = DEVICE(
+            self.config, self.debugLogger, protocols=self.protocols
+        )  # establish communication
         self.devices._getPorts()
         self.available_addresses = self.devices.deviceAddresses
         return True
 
     def reconnectDevices(self):
-        restart_DEVICE = False
-        self.devices._getPorts()
-        for name in self.device_config.keys():
-            address = self.device_config[name]["address"]
-
-            if (
-                address not in self.devices.deviceAddresses
-                and address in self.available_addresses
-            ):  # when a connection is loss
-                # This step is to prevent the moment when the device is shown in the resource manager but connection fails
-                self.available_addresses.remove(address)
-
-            if (
-                address in self.devices.deviceAddresses
-                and address not in self.available_addresses
-                and not self.devices.devices_info[name]["status"]
-            ):
-                restart_DEVICE = True
-
-        if restart_DEVICE:
-            del self.devices  # delete the DEVICE class
-            return self.connectDevices()
-
-        else:
-            return False
+        return self.devices.reconnectDevices()
+
+    def close(self):
+        self.devices.close()
 
     def _checkDirectory(self):
         if not os.path.exists(self.log_dir):
@@ -249,6 +231,7 @@ class SpecLog:
         Returns:
             data (string): return data in str
         """
+        data = "nan"
         try:
             if delimiter:
                 data = string.split(delimiter)[index]
@@ -259,7 +242,7 @@ class SpecLog:
             data = data.replace("\t", "") 
             data = data.replace("\r", "") 
             data = data.strip()
-        except:
+        except (IndexError, AttributeError):
             self.debugLogger.error("String Convert Fail: recived: %s, delimiter: %s, index: %s" %(string, delimiter, index))
         return data
 

speclog-0.0.5/SpecLog/SpecLogger.py

@@ -0,0 +1,199 @@
+"""
+This is the python program to control SpecLog
+"""
+
+import os
+import sys
+import argparse
+import shutil
+import subprocess
+from .SpecLog import *
+from .logger_status import is_logger_running
+from .startup_task import (
+    TASK_SCHEDULER,
+    control_arguments,
+    create_arguments,
+    disable_arguments,
+    query_arguments,
+)
+
+# System-start task and desktop shortcuts (public)
+desktop_folder = os.path.join(os.environ["USERPROFILE"], "Desktop")
+
+source_running_logger = os.path.join(
+    os.path.dirname(sys.executable), "scripts", "SpecLogger_running.exe"
+)
+
+source_monitor = os.path.join(
+    os.path.dirname(sys.executable), "scripts", "SpecMonitor_running.exe"
+)
+
+
+def _run_task_scheduler(arguments, runner=None):
+    runner = runner or subprocess.run
+    return runner(
+        [TASK_SCHEDULER, *arguments],
+        capture_output=True,
+        text=True,
+        creationflags=getattr(subprocess, "CREATE_NO_WINDOW", 0),
+    )
+
+
+def configure_startup(enabled, executable=None, runner=None):
+    """Create/enable or disable the no-login SpecLogger startup task."""
+    executable = os.path.abspath(executable or source_running_logger)
+    if enabled:
+        if not os.path.isfile(executable):
+            raise RuntimeError(f"SpecLogger runner was not found: {executable}")
+        result = _run_task_scheduler(
+            create_arguments(executable),
+            runner,
+        )
+        success_message = "SpecLogger will run at system startup without login."
+    else:
+        query = _run_task_scheduler(
+            query_arguments(), runner
+        )
+        if query.returncode:
+            return "SpecLogger startup task is not installed."
+        result = _run_task_scheduler(
+            disable_arguments(), runner
+        )
+        success_message = "SpecLogger startup task is disabled."
+
+    if result.returncode:
+        details = (result.stderr or result.stdout).strip()
+        raise RuntimeError(
+            details
+            or "Windows Task Scheduler rejected the request. Run as administrator."
+        )
+    return success_message
+
+
+def control_scheduled_logger(action, runner=None):
+    """Start/stop the startup task, or return None when it is not installed."""
+    query = _run_task_scheduler(
+        query_arguments(), runner
+    )
+    if query.returncode:
+        return None
+    result = _run_task_scheduler(
+        control_arguments(action), runner
+    )
+    if result.returncode:
+        details = (result.stderr or result.stdout).strip()
+        raise RuntimeError(
+            details
+            or "Windows Task Scheduler rejected the request. Run as administrator."
+        )
+    return (
+        "SpecLogger scheduled task start requested."
+        if action == "start"
+        else "SpecLogger scheduled task stopped."
+    )
+
+def _build_parser():
+    parser = argparse.ArgumentParser(prog="SpecLogger")
+    parser.add_argument(
+        "status",
+        type=str,
+        nargs="?",
+        default=None,
+        choices=["start", "stop"],
+        help="To start/stop SpecLogger. If no argument, the SpecLogger will start by default",
+    )
+    parser.add_argument(
+        "-desktop",
+        type=str,
+        default=False,
+        choices=["True", "False"],
+        help="To create desktop icons",
+    )
+    parser.add_argument(
+        "-startup",
+        type=str,
+        default=None,
+        choices=["True", "False"],
+        help="To enable/disable SpecLogger at startup without login.",
+    )
+    parser.add_argument(
+        "-debug",
+        type=str,
+        default="False",
+        choices=["True", "False"],
+        help="To start debug console SpecLogger.",
+    )
+    parser.add_argument(
+        "--config",
+        action="store_true",
+        help="Open the public SpecLog configuration editor.",
+    )
+    return parser
+
+
+def main_func(argv=None):
+    args = _build_parser().parse_args(argv)
+
+    if args.config:
+        from .config_editor import main_func as open_config_editor
+
+        return open_config_editor()
+
+    if args.startup is not None:
+        try:
+            print(configure_startup(args.startup == "True"))
+        except RuntimeError as error:
+            print(f"Could not configure SpecLogger startup: {error}", file=sys.stderr)
+            return 1
+
+    if args.desktop == "True":
+        target_logger = os.path.join(desktop_folder, "SpecLogger_running.exe")
+        target_monitor = os.path.join(desktop_folder, "SpecMonitor.exe")
+
+        if not os.path.exists(target_logger):
+            shutil.copy(source_running_logger, target_logger)
+            print("Create SpecLogger_running.exe on the desktop.")
+        else:
+            print("SpecLogger_running.exe is on desktop already.")
+
+        if not os.path.exists(target_monitor):
+            shutil.copy(source_monitor, target_monitor)
+            print("Create SpecMonitor.exe on the desktop.")
+        else:
+            print("SpecMonitor.exe is on desktop already.")
+
+    if not args.startup and not args.desktop and not args.status:  # not arguments
+        args.status = "start"
+
+    if args.status in {"start", "stop"}:
+        try:
+            task_message = control_scheduled_logger(args.status)
+        except RuntimeError as error:
+            print(f"Could not control SpecLogger scheduled task: {error}", file=sys.stderr)
+            return 1
+        if task_message is not None:
+            print(task_message)
+            return 0
+
+    if args.status == "start":
+        if is_logger_running():
+            print("SpecLogger has started already.")
+            return
+        if args.debug == "False":
+            subprocess.Popen(
+                "SpecLogger_running.exe", creationflags=subprocess.CREATE_NO_WINDOW
+            )
+            print("SpecLogger started")
+        elif args.debug == "True":
+            os.startfile("SpecLogger_running.exe")
+            print("SpecLogger debug mode started")
+
+    elif args.status == "stop":
+        os.system("taskkill /im SpecLogger_running.exe /F /t")
+        print("SpecLogger stopped")
+    else:  # ignore
+        return
+
+
+if __name__ == "__main__":
+    main_func()