quarchpy 2.2.7.dev1__py2.py3-none-any.whl → 2.2.8__py2.py3-none-any.whl

quarchpy/connection_specific/QPS/win-amd64/scriptCommands.txt

@@ -1,7 +1,7 @@
 QPS Command Summary
 Copyright (c) Quarch Ltd
-QPS v1.44.2
-Generated: 14 Jan 2025
+QPS v1.46
+Generated: 10 Apr 2025
 
 
 *** Commands ***
@@ -390,7 +390,7 @@ Version: 2
 See also: $qps hide
 
 Command: $read
-Description: Reads data between from a given start time and either end time or number of records
+Description: Reads data between a given start time and either end time or number of records
 Version: 1
 See also: $stream read
 Arguments
@@ -1084,7 +1084,7 @@ $qps hide ~ Hides the QPS application
 
 $qps show ~ Shows the QPS application
 
-$read ~ Reads data between from a given start time and either end time or number of records
+$read ~ Reads data between a given start time and either end time or number of records
 
 $save csv ~ Saves to CSV format
 

quarchpy/connection_specific/QPS/win-amd64/whats-new.txt

@@ -1,31 +1,39 @@
 *** What's New In Quarch Power Studio ***
 
-14th January 2025
+31st March 2025
 
-QPS version 1.45
-QIS version 1.47
+QPS version 1.46
+QIS version 1.48
 
 
 
 *** New Features ***
 
-Improved help menu links and additional documentation
+Import of custom channel data for CSV via the GUI
 
-Data valid synthetic channel for AC compliance testing
+Direct access to QIS terminal, recording folder and documentation
 
-Improved import speed for custom user data
+Auto check and download of USB driver on windows
 
-Reduced time from start stream, until data is first displayed
+Optional warning when QPS recordings exceed a set level
 
-Added notification for locked devices that are open in other applications
+Java memory heap size can be set in preferences
 
-Improved checking of analysis files when loading
+Chart read optimisation speeds up performance when channels are not visible
+
+Added synthetic AC channel option to show when data is invalid (outside SPEC calibration)
+
+Added notification on connection screen if a device is locked by another process
+
+Recordings are validated on load, clear warning given if anything is wrong
 
 
 *** Major Fixes ***
 
-Fixed issues with window resizing on multiple monitors
+Fixed issue with QPS files not deleting
+
+Fixed bug where channel ordering was not consistent
 
-Improved thread cycling which reduced performance
+Fixed issue with synthetic channels enables not working
 
-Fixed duplicate logging lines
+Fixed issue with timeline corruption when expanded over multiple screens

quarchpy/connection_specific/connection_QIS.py

@@ -1682,6 +1682,7 @@ class QisInterface:
 
         except Exception as e:
             #something went wrong during send qis cmd
+            logging.error("Error! Unable to retrieve response from QIS. Command: " + sentText)
             logging.error(e)
             raise e
         finally:

quarchpy/debug/SystemTest.py

@@ -1,5 +1,6 @@
 from quarchpy import *
 from quarchpy.device import *
+from quarchpy.connection_specific.jdk_j21_jres.fix_permissions import main as fix_permissions, find_java_permissions
 try:
     from importlib.metadata import distribution
 except:
@@ -48,6 +49,11 @@ def test_system_info():
         print(str(bytes(subprocess.check_output(['cat', '/etc/os-release'], stderr=subprocess.STDOUT)).decode()))
     print("Platform Release:  " + platform.release())
 
+    print("\nPYTHON\n------")
+    try:
+        print("Python Version: " + sys.version)
+    except:
+        print("Unable to detect Python version")
     try:
         print("Quarchpy Version: " + get_quarchpy_version())
     except:
@@ -57,14 +63,8 @@ def test_system_info():
     except Exception as e:
         print(e)
         print("Unable to detect Quarchpy location")
-    try:
-        print("Python Version: " + sys.version)
-    except:
-        print("Unable to detect Python version")
-    try:
-        print("QIS version number: " + get_QIS_version())
-    except:
-        print("Unable to detect QIS version")
+
+    print("\nJAVA\n----")
     try:
         javaVersion = bytes(subprocess.check_output(['java', '-version'], stderr=subprocess.STDOUT)).decode()
         print("Java Version: " + str(javaVersion))
@@ -78,12 +78,17 @@ def test_system_info():
         print("Unable to detect java location"
               "If Java is not installed then QIS and QPS will NOT run")
     try:
-        find_java_permissions()
+        execute_permissions, message=find_java_permissions()
+        print("Execute Permissions: ",execute_permissions, "\n",message)
     except:
         print("Unable to get j21 java permissions")
+    try:
+        print("\nQIS version number: " + get_QIS_version())
+    except Exception as e:
+        print("\nUnable to detect QIS version. Exception:" +str(e))
 
-    # Scan for all quarch devices on the system
 
+# Scan for all quarch devices on the system
 def QuarchSimpleIdentify(device1):
     """
     Prints basic identification test data on the specified module, compatible with all Quarch devices
@@ -92,7 +97,7 @@ def QuarchSimpleIdentify(device1):
     ----------
     device1: quarchDevice
         Open connection to a quarch device
-        
+
     """
     # Print the module name
     print("MODULE IDENTIFY TEST")
@@ -105,6 +110,7 @@ def QuarchSimpleIdentify(device1):
     print("Module Identity Information: ")
     print(device1.sendCommand("*idn?"))
 
+
 def get_QIS_version():
     """
     Returns the version of QIS.  This is the version of QIS currenty running on the local system if one exists.
@@ -114,15 +120,20 @@ def get_QIS_version():
     -------
     version: str
         String representation of the QIS version number
-        
+
     """
 
     qis_version = ""
     my_close_qis = False
-    if isQisRunning() == False:
+    try:
+        qisRunning=isQisRunning()
+    except Exception as e:
+        print("Exception occurred while checking if qis was already running. Error:\n"+str(e))
+
+    if qisRunning == False:
         my_close_qis = True
         startLocalQis(headless=True)
-        
+
     myQis = qisInterface()
     qis_version = myQis.sendAndReceiveCmd(cmd="$version")
     if "No Target Device Specified" in qis_version:
@@ -131,6 +142,7 @@ def get_QIS_version():
         myQis.sendAndReceiveCmd(cmd = "$shutdown")
     return qis_version
 
+
 def get_java_location():
     """
     Returns the location of java.
@@ -148,14 +160,16 @@ def get_java_location():
         location = "Unable to detect OS to check java version."
     return location
 
+
 def get_quarchpy_version():
     try:
        return __version__
     except:
         return "Unknown"
 
+
 def fix_usb():
-    content_to_write = "SUBSYSTEM==\"usb\", ATTRS{idVendor}==\"16d0\", MODE=\"0666\"" \
+    content_to_write = "SUBSYSTEM==\"usb\", ATTRS{idVendor}==\"16d0\", MODE=\"0666\"\n" \
                        "SUBSYSTEM==\"usb_device\", ATTRS{idVendor}==\"16d0\", MODE=\"0666\""
 
     if "centos" in str(platform.platform()).lower():
@@ -199,6 +213,7 @@ def main (args=None):
         test_communication()
 
 
+
 if __name__ == "__main__":
     main([])
     #find_java_permissions()

quarchpy/device/quarchQPS.py

@@ -1,6 +1,8 @@
 from quarchpy.device import quarchDevice
 from quarchpy.utilities.Version import Version
 from quarchpy.user_interface.user_interface import requestDialog
+from quarchpy.utilities.utils import check_stream_stopped_status, check_export_status
+
 import os, time, datetime, sys, logging
 
 if sys.version_info[0] < 3:
@@ -29,24 +31,24 @@ class quarchQPS(quarchDevice):
         self.IP_address = quarchDevice.connectionObj.qps.host
         self.port_number = quarchDevice.connectionObj.qps.port
 
-    def startStream(self, directory, unserInput=True):
+    def startStream(self, directory, unserInput=True, streamDuration=""):
         """
         directory - str - desired stream dir
         unserInput=True - if a failure occurs userInput=True allows user to rectify problem with user input. set to False if user interaction is not available (automating).
         """
         #time.sleep(1)  # TODO remove this sleep once script->QPS timeing issue resolved. This works fine in the meantime
-        return quarchStream(self.quarchDevice, directory, unserInput)
+        return quarchStream(self.quarchDevice, directory, unserInput, streamDuration)
 
 
 class quarchStream:
-    def __init__(self, quarchQPS, directory, unserInput=True):
+    def __init__(self, quarchQPS, directory, unserInput=True, streamDuration=""):
         self.connectionObj = quarchQPS.connectionObj
         self.IP_address = quarchQPS.connectionObj.qps.host
         self.port_number = quarchQPS.connectionObj.qps.port
         self.ConString = quarchQPS.ConString
         self.ConType = quarchQPS.ConType
-        time.sleep(1)
-        response = self.startQPSStream(directory)
+        # time.sleep(1) # TODO Nabil - Is this required?
+        response = self.startQPSStream(directory, streamDuration)
         if not "fail:" in response.lower():
             return
         else:
@@ -55,18 +57,19 @@ class quarchStream:
             else:
                 self.failCheck(response)
 
-    def startQPSStream(self, newDirectory):
-        '''STARTS the stream '''
-        response = self.connectionObj.qps.sendCmdVerbose("$start stream \"" + str(newDirectory) + "\"")
+    def startQPSStream(self, newDirectory, streamDuration=""):
+        '''STARTS the QPS stream '''
+        # Set the stream duration if required.
+        response = self.connectionObj.qps.sendCmdVerbose("$start stream \"" + str(newDirectory) + "\" " + str(streamDuration))
         if "Error" in response:
-            response = self.connectionObj.qps.sendCmdVerbose("$start stream " + str(newDirectory))
+            response = self.connectionObj.qps.sendCmdVerbose("$start stream " + str(newDirectory) + " " + streamDuration)
         return response
 
     def failCheck(self, response):
         ''' handles failed starting of stream that requires input from user to fix.'''
         while "fail:" in response.lower():
             if "Fail: Directory already exists" in response:
-                newDir = requestDialog(message=response+"  Please enter a new file name:")
+                newDir = requestDialog(message=response + "  Please enter a new file name:")
                 response = self.startQPSStream(newDir)
             else:  # If its a failure we don't know how to handle.
                 raise Exception(response)
@@ -112,7 +115,7 @@ class quarchStream:
 
         return retVal
 
-    def stats_to_CSV(self, file_name=""):
+    def stats_to_CSV(self, file_name="", poll_till_complete=False, check_interval=0.5):
         """
         Saves the statistics grid to a csv file
 
@@ -130,43 +133,50 @@ class quarchStream:
         command_response = self.connectionObj.qps.sendCmdVerbose("$stats to csv \"" + file_name + "\"", timeout=60)
         if command_response.startswith("Fail"):
             raise Exception(command_response)
+
+        if poll_till_complete:
+            is_exporting = check_export_status(self.get_stats_export_status())
+            while is_exporting:
+                is_exporting = check_export_status(self.get_stats_export_status())
+                time.sleep(check_interval)
         return command_response
 
     def get_custom_stats_range(self, start_time, end_time):
         """
-                      Returns the QPS statistics information over a specific time ignoring any set annotations.
-
-                                Parameters
-                                ----------
-                                start_time = : str
-                                    The time in seconds you would like the stats to start this can be in integer or string format.
-                                    or using the following format to specify daysDhours:minutes:seconds.milliseconds
-                                    xxxDxx:xx:xx.xxxx
-                                end_time = : str
-                                    The time in seconds you would like the stats to stop this can be in integer or string format
-                                    or using the following format to specify daysDhours:minutes:seconds.milliseconds
-                                    xxxDxx:xx:xx.xxxx
-                                Returns
-                                -------
-                                df = : dataframe
-                                    The response text from QPS. If successful "ok. Saving stats to : file_name" otherwise returns the exception thrown
+          Returns the QPS statistics information over a specific time ignoring any set annotations.
+
+                    Parameters
+                    ----------
+                    start_time = : str
+                        The time in seconds you would like the stats to start this can be in integer or string format.
+                        or using the following format to specify daysDhours:minutes:seconds.milliseconds
+                        xxxDxx:xx:xx.xxxx
+                    end_time = : str
+                        The time in seconds you would like the stats to stop this can be in integer or string format
+                        or using the following format to specify daysDhours:minutes:seconds.milliseconds
+                        xxxDxx:xx:xx.xxxx
+                    Returns
+                    -------
+                    df = : dataframe
+                        The response text from QPS. If successful "ok. Saving stats to : file_name" otherwise returns the exception thrown
         """
         try:
             import warnings
             import pandas as pd
             warnings.simplefilter(action='ignore', category=FutureWarning)
-        except:
+        except ImportError:
             logging.warning("pandas not imported correctly")
+
         command_response = self.connectionObj.qps.sendCmdVerbose(
             "$get custom stats range " + str(start_time) + " " + str(end_time), timeout=60)
+
         if command_response.startswith("Fail"):
             raise Exception(command_response)
         test_data = StringIO(command_response)
+
         try:
             pd.set_option('display.max_columns', None)
             pd.set_option('display.width', 1024)
-            # df = pd.read_csv(test_data, sep=",", header=[0,1])
-            # pandas.read_csv() replaced error_bad_lines with on_bad_lines from v1.3.0
             if Version.is_v1_ge_v2(pd.__version__, "1.3.0"):
                 df = pd.read_csv(test_data, sep=",", header=[0, 1], on_bad_lines="skip")
             else:
@@ -187,9 +197,9 @@ class quarchStream:
 
     def getStreamState(self):
         """
-                      Askes QPS for the stream status.
+                      Asks QPS for the stream status.
                       QPS stream state != Module stream state.
-                      This is different from "rec stream?" cmd to the module as it will return "streaming" when the module is nolonger streaming but QPS is still receiveing stream data from the module.
+                      This is different from "rec stream?" cmd to the module as it will return "streaming" when the module is no longer streaming but QPS is still receiveing stream data from the module.
                       ei the module has stopped streaming but is emptying the stream buffer.
         """
         command_response = self.connectionObj.qps.sendCmdVerbose("$stream state")
@@ -197,9 +207,8 @@ class quarchStream:
             raise Exception(command_response)
         return (command_response)
 
-
     def addAnnotation(self, title, annotationTime=0, extraText="", yPos="", titleColor="", annotationColor="",
-                      annotationType="", timeFormat="unix"):
+                      annotationType="", annotationGroup="", timeFormat="unix"):
         """
                     Adds a custom annotation to stream with given parameters.
 
@@ -230,14 +239,15 @@ class quarchStream:
         annotationType = annotationType.lower()
         annotationTime = str(annotationTime)
 
-        if (annotationTime[0].isalpha() or annotationTime[-1].isalpha()):
-            timeFormat="elapsed"
-            if annotationTime.startswith("e"): #Old format allowed e to be used to pass elapsed time in seconds "e2" -> 2s + elapsed
-                annotationTime=annotationTime[1:]+"s"
+        if annotationTime[0].isalpha() or annotationTime[-1].isalpha():
+            timeFormat = "elapsed"
+            if annotationTime.startswith(
+                    "e"):  #Old format allowed e to be used to pass elapsed time in seconds "e2" -> 2s + elapsed
+                annotationTime = annotationTime[1:] + "s"
 
-        elif annotationTime=="0":
-            annotationTime=current_milli_time()
-            timeFormat="unix"
+        elif annotationTime == "0":
+            annotationTime = current_milli_time()
+            timeFormat = "unix"
 
         if annotationType == "" or annotationType == "annotation":
             annotationType = "annotate"
@@ -249,24 +259,23 @@ class quarchStream:
         #     return retString
 
         title = title.replace("\n", "\\n")
-        cmd="$stream annotation add "+" time="+str(annotationTime)+ " text=\""+title+"\""
-        if extraText!="":
+        cmd = "$stream annotation add " + " time=" + str(annotationTime) + " text=\"" + title + "\""
+        if extraText != "":
             extraText = extraText.replace("\n", "\\n")
-            cmd+=" extraText=\"" +str(extraText)+"\""
-        if yPos!= "":
-            cmd+=" yPos="+str(yPos)
-        if type!="":
-            cmd+=" type="+ str(annotationType)
-        if annotationColor!="":
-            cmd+=" colour="+str(annotationColor)
-        if titleColor!="":
-            cmd+=" textColour="+str(titleColor)
-        if timeFormat!="":
-            cmd+=" timeFormat="+str(timeFormat)
+            cmd += " extraText=\"" + str(extraText) + "\""
+        if yPos != "":
+            cmd += " yPos=" + str(yPos)
+        if type != "":
+            cmd += " type=" + str(annotationType)
+        if annotationColor != "":
+            cmd += " colour=" + str(annotationColor)
+        if titleColor != "":
+            cmd += " textColour=" + str(titleColor)
+        if timeFormat != "":
+            cmd += " timeFormat=" + str(timeFormat)
 
         return self.connectionObj.qps.sendCmdVerbose(cmd)
 
-
     def addComment(self, title, commentTime=0, extraText="", yPos="", titleColor="", commentColor="", annotationType="",
                    annotationGroup="", timeFormat="unix"):
         # Comments are just annotations that do not affect the statistics grid.
@@ -277,7 +286,8 @@ class quarchStream:
                                   titleColor=titleColor, annotationColor=commentColor, annotationType=annotationType,
                                   annotationGroup=annotationGroup, timeFormat=timeFormat)
 
-    def saveCSV(self, filePath, linesPerFile=None, cr=None, delimiter=None, timeout=60):
+    def saveCSV(self, filePath, linesPerFile=None, cr=None, delimiter=None, timeout=60, pollTillComplete=False,
+                checkInterval=0.5):
         """
             Saves the stream to csv file at specified location
 
@@ -311,6 +321,12 @@ class quarchStream:
         if delimiter != None:
             args += " -s" + delimiter
 
+        if pollTillComplete:
+            is_exporting = check_export_status(self.get_stream_export_status())
+            while is_exporting:
+                is_exporting = check_export_status(self.get_stream_export_status())
+                time.sleep(checkInterval)
+
         # , filePath, linesPerFile, cr, delimiter
         return self.connectionObj.qps.sendCmdVerbose("$save csv \"" + filePath + "\" " + args, timeout=timeout)
 
@@ -336,17 +352,22 @@ class quarchStream:
     def channels(self):
         return self.connectionObj.qps.sendCmdVerbose("$channels").splitlines()
 
-    def stopStream(self):
-        return self.connectionObj.qps.sendCmdVerbose("$stop stream")
-
-    def stopStreamAndAllowBufferToEmpty(self, checkInterval=0.5):
-        self.stopStream()
-        streamState = self.getStreamState().lower()
-        while "running" in streamState:
-            logging.debug("Stream buffer still emptying: " + streamState)
-            time.sleep(checkInterval)
+    def stopStream(self, pollTillComplete=False, checkInterval=0.5):
+        # Stop the stream
+        response = self.connectionObj.qps.sendCmdVerbose("$stop stream")
+        # Poll till stream has completed if required
+        if pollTillComplete:
+            # Get the current stream status
             streamState = self.getStreamState().lower()
-        logging.debug("QPS no longer Streaming: " + streamState)
+            # Verify the stream stopped correctly
+            response = check_stream_stopped_status(streamState)
+            while "running" in streamState:
+                logging.debug("Stream buffer still emptying: " + streamState)
+                streamState = self.getStreamState().lower()
+                response = check_stream_stopped_status(streamState)
+                time.sleep(checkInterval)
+
+        return response
 
     def hideAllDefaultChannels(self):
 
@@ -386,8 +407,12 @@ class quarchStream:
             dataPointTime = qpsNowStr()
         else:
             dataPointTime = int(dataPointTime)
-        logging.warning("$stream data add " + channelName + " " + groupName + " " + str(dataPointTime) + " " + str(
-                dataValue) + " " + timeFormat)
         self.connectionObj.qps.sendCmdVerbose(
             "$stream data add " + channelName + " " + groupName + " " + str(dataPointTime) + " " + str(
                 dataValue) + " " + timeFormat)
+
+    def get_stream_export_status(self):
+        return self.connectionObj.qps.sendCmdVerbose("$stream export status")
+
+    def get_stats_export_status(self):
+        return self.connectionObj.qps.sendCmdVerbose("$stream stats export status")

quarchpy/docs/CHANGES.rst

@@ -14,6 +14,14 @@ Change Log
 ----------
 
 
+2.2.8
+-----
+- New QPS 1.46 and QIS 1.48
+
+2.2.7
+-----
+- Bug fix for QIS 1.47 missing lib for linux only 
+
 2.2.6
 -----
 - New QPS 1.45 and QIS 1.47