quarchpy 2.1.24.dev5__py2.py3-none-any.whl → 2.1.25__py2.py3-none-any.whl

quarchpy/_version.py

@@ -1 +1 @@
-__version__ = "2.1.24.dev5"
+__version__ = "2.1.25"

quarchpy/connection_specific/QPS/scriptCommands.txt

@@ -1,7 +1,7 @@
 QPS Command Summary
 Copyright (c) Quarch Ltd
-QPS v1.39
-Generated: 18-Mar-2024
+QPS v1.39.13
+Generated: 13-May-2024
 
 
 *** Commands ***
@@ -345,6 +345,19 @@ Default value: NONE
 Examples:
 $open recording qpsFile="C:\quarch\recordings\AC\AC_Gen_test\AC_Gen_Test.qps"
 
+Command: $progress check
+Description: Checks the progress of a specific QPS task
+Version: 2
+Arguments
+Argument: task
+Description: The task to be checked
+Index: 0
+Type: STRING
+Default value: NONE
+Acceptable values: [open recording]
+Examples:
+$progress check task="open recording"
+
 Command: $qis launch
 Description: Launches new QIS instance
 Version: 2
@@ -992,6 +1005,8 @@ $module scan ~ Scans for available devices
 
 $open recording ~ Opens a recording
 
+$progress check ~ Checks the progress of a specific QPS task
+
 $qis launch ~ Launches new QIS instance
 
 $qis shutdown ~ Shuts down current QIS instance

quarchpy/connection_specific/connection_QPS.py

@@ -140,6 +140,17 @@ class QpsInterface:
         time.sleep(
             sleep)  # Time must be allowed for QPS to Scan. If another scan request is sent it will time out and throw an error.
 
+    def get_list_details(self, sock=None):
+        if sock == None:
+            sock = self.sock
+        devString = self.sendCmdVerbose("$module list details")
+        #devString = self.sendAndReceiveText(sock, '$list details')
+        devString = devString.replace('>', '')
+        devString = devString.replace(r'\d+\) ', '')
+        devString = devString.split('\r\n')
+        devString = [x for x in devString if x]  # remove empty elements
+        return devString
+
     def getDeviceList(self, scan = True, ipAddress = None):
         deviceList = []
         scanWait = 2
@@ -182,4 +193,45 @@ class QpsInterface:
         #return list of devices
         return deviceList
 
+
+    def open_recording(self, file_path, cmdTimeout=5, pollInterval=3, startOpenTimout=5):
+        """
+
+        """
+        #print("Open recording at file : \""+str(file_path)+"\"")
+        self.sendCmdVerbose("$open recording qpsFile=\""+str(file_path)+"\"",timeout=cmdTimeout)
+        loadingStarted=False
+        message=""
+        startTime=time.time()
+        notLoadingMessageStartTime=None
+        while(1):
+            update=self.sendCmdVerbose("$progress check \"open recording\"",timeout=cmdTimeout)
+            #print(update)
+            m = re.search('\d+(\.\d+)?%', update)
+            if m: # A percentage was found
+                loadingStarted=True
+                found = float(m.group(0)[:-1])
+                user_interface.progressBar(found,100)
+                if found > 99.9: # This will catch the case we have 99.9999% or 100% loaded. recording with less that 1mill records auto return 100%
+                    message = "Passed, Recording opened, loading detected and complete."
+                    break
+            elif("Chart window is open but no loading is in progress." in update):
+                if loadingStarted ==True:
+                    # Loading started and has now ended, so we can exit the loop.
+                    message="Passed, Recording opened, loading detected and complete."
+                    break
+                else: # QPS has not started loading a recording.
+                    if notLoadingMessageStartTime == None:
+                        # Start a timer from now so that if loading doesn't take place between now and a timeout value,
+                        # we exit, stating that no loading started within the desired time.
+                        notLoadingMessageStartTime = time.time()
+                    elif time.time() - notLoadingMessageStartTime> startOpenTimout:
+                        message = "No detection that QPS started loading the recording within "+str(startOpenTimout)+"s."
+                        break
+
+            time.sleep(pollInterval) #Sleep pollInterval time, so we are not hammering QPS for updates while its busy loading.
+        time.sleep(1) #sleep outside the loop as there is a
+        return message
+
+
     

quarchpy/connection_specific/mDNS.py

@@ -0,0 +1,126 @@
+import platform  # For getting the operating system name
+import subprocess  # For executing a shell command
+
+from zeroconf import Zeroconf
+
+
+def ping(host):
+    """
+    Returns True if host (str) responds to a ping request.
+    """
+    # Option for the number of packets as a function of
+    param = '-n' if platform.system().lower() == 'windows' else '-c'
+
+    # Building the command. Ex: "ping -c 1 google.com"
+    command = ['ping', param, '1', host]
+
+    # Execute the ping command and capture the output and return code
+    result = subprocess.run(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
+
+    # Check the return code and output to determine the result
+    if result.returncode == 0 and ("destination host unreachable" not in str(result.stdout).lower()):
+        return True  # Ping successful
+    else:
+        return False  # Ping failed
+
+
+class MyListener:
+    """
+    MyListener class to handle service updates, removals, and additions in Zeroconf
+    """
+
+    _instance = None
+
+    @classmethod
+    def get_instance(cls):
+        """
+        Get an instance of MyListener class. If none exists, create one.
+        """
+        if cls._instance is None:
+            cls._instance = MyListener()
+        return cls._instance
+
+    def __init__(self):
+        """
+        Initialize MyListener instance.
+        """
+        self.found_devices = {}
+        self.mdns_service_running = False
+        self.zeroconf = None
+        self.target_conn = None
+
+    def update_service(self, zc, type_, name):
+        """
+        Handle service update event.
+        """
+        info = zc.get_service_info(type_, name)
+        if "Quarch:" in str(info):
+            # decode the incoming properties from mdns
+            decoded_properties = {key.decode('utf-8'): value.decode('utf-8') for key, value in info.properties.items()}
+            decoded_ip = ".".join(str(byte) for byte in info.addresses[0])
+            self.get_instance().add_device(decoded_properties, decoded_ip)
+
+    def remove_service(self, zc, type_, name):
+        """
+        Handle service removal event.
+        """
+        return None
+
+    def add_service(self, zc, type_, name):
+        """
+        Handle service addition event.
+        """
+        info = zc.get_service_info(type_, name)
+        if "Quarch:" in str(info):
+            # decode the incoming properties from mdns
+            decoded_properties = {key.decode('utf-8'): value.decode('utf-8') for key, value in info.properties.items()}
+            decoded_ip = ".".join(str(byte) for byte in info.addresses[0])
+            self.get_instance().add_device(decoded_properties, decoded_ip)
+
+    def add_device(self, properties_dict, ip_address):
+        """
+        Add a device to the found devices dictionary.
+        """
+        qtl_num = "QTL" + properties_dict['86'] if '86' in properties_dict else None
+        # Check if module contains REST connection
+        if '84' in properties_dict:
+            # Check the user specified connection type
+            if self.get_instance().target_conn == "all" or self.get_instance().target_conn == "rest":
+                if properties_dict['84'] == '80':
+                    # print("Rest connection exists for device: " + qtl_num)
+                    # Updates the found devices dict
+                    self.get_instance().update_device_dict(device_dict={"REST:" + ip_address: qtl_num})
+        # Check if module contains TCP connection
+        if '85' in properties_dict:
+            # Check the user specified connection type
+            if self.get_instance().target_conn == "all" or self.get_instance().target_conn == "tcp":
+                if properties_dict['85'] == "9760":
+                    # print("TCP connection exists for device: " + qtl_num)
+                    # Updates the found devices dict
+                    self.get_instance().update_device_dict(device_dict={"TCP:" + ip_address: qtl_num})
+
+    def update_device_dict(self, device_dict):
+        """
+        Update the found devices dictionary.
+        """
+        self.get_instance().found_devices.update(device_dict)
+
+    def get_found_devices(self):
+        """
+        Get the found devices and perform ping check.
+        """
+        temp_dict = self.get_instance().found_devices
+        for key, value in list(temp_dict.items()):
+            result = ping(key[key.index(":") + 1:])
+            if not result or self.get_instance().target_conn not in key.lower():
+                del self.get_instance().found_devices[key]
+        print(str(self.get_instance().found_devices))
+        return self.get_instance().found_devices
+
+    def get_zeroconf(self):
+        """
+        Get the Zeroconf instance. If none exists, create one.
+        """
+        if self.get_instance().zeroconf is None:
+            self.get_instance().zeroconf = Zeroconf()
+        return self.get_instance().zeroconf

quarchpy/device/device.py

@@ -110,21 +110,16 @@ class quarchDevice:
         ## QIS
         # ConType may be QIS only or QIS:ip:port [:3] checks if the first 3 letters are QIS.
         elif self.ConType[:3].upper() == "QIS":
-            # If host and port are specified.
-            try:
-                # Extract QIS, host and port.
-                QIS, host, port = self.ConType.split(':')
-                # QIS port should be an int.
-                port = int(port)
-            # If host and port are not specified.
-            except:
+            try: # If host and port are specified.
+                QIS, host, port = self.ConType.split(':') # Extract QIS, host and port.
+                port = int(port) # QIS port should be an int.
+            except:  # If host and port are not specified.
                 host = '127.0.0.1'
                 port = 9722
 
             numb_colons = self.ConString.count(":")
             if numb_colons == 1:
                 self.ConString = self.ConString.replace(':', '::')
-
             # Creates the connection object.
             self.connectionObj = QISConnection(self.ConString, host, port)
 
@@ -132,9 +127,8 @@ class quarchDevice:
             list_str = "".join(list).lower()
 
             timeout = time.time() + int(timeout) # now + n seconds
-
             # check for device in list, has a timeout
-            while time.time() < timeout:
+            while time.time() < timeout: # look for the connection string in qis $list details
 
                 # Check if it's a module's QTL number
                 if "qtl" not in self.ConString.lower():
@@ -143,7 +137,6 @@ class quarchDevice:
                     ip_address = re.search(r"[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}", self.ConString)
                     if not ip_address:
                         raise ValueError("ConString " + self.ConString + " does not contain a valid QTL number or IP address")
-
                     # Attempt to get QTL number from qis "$list details"
                     temp_str = _check_ip_in_qis_list(ip_address.group(), self.connectionObj.qis.get_list_details())
                     if temp_str:
@@ -159,9 +152,8 @@ class quarchDevice:
                     if "located" in str(self.connectionObj.qis.scanIP(self.ConString)).lower():
                         # Note - Qis takes a moment or 2 to add this newly located device to the $list 21/03/23
                         timeout += 20   # Extend the timeout as the drive was located
-
                         while time.time() < timeout:
-                            # try find the new device again from ipaddress
+                            # try find the QTL from ipaddress
                             temp_str = _check_ip_in_qis_list(ip_address.group(), self.connectionObj.qis.get_list_details())
                             if temp_str:
                                 # If the item is found, break out of this loop
@@ -181,8 +173,7 @@ class quarchDevice:
                     time.sleep(1)
                     list = self.connectionObj.qis.getDeviceList()
                     list_str = "".join(list).lower()
-            else:
-                # If we didn't hit a 'break' condition in the above loop, then it timed out
+            else: # If we didn't hit a 'break' condition in the above loop, then it timed out
                 raise timeout_exception("Could not find module " + self.ConString + " from Qis within specified time")
 
             self.connectionObj.qis.sendAndReceiveCmd(cmd="$default " + self.ConString)
@@ -190,9 +181,9 @@ class quarchDevice:
         ## QPS
         elif self.ConType[:3].upper() == "QPS":
             try:
-                # Extract QIS, host and port.
-                QIS, host, port = self.ConType.split(':')
-                # QIS port should be an int.
+                # Extract QPS, host and port.
+                QPS, host, port = self.ConType.split(':')
+                # QPS port should be an int.
                 port = int(port)
             # If host and port are not specified.
             except:
@@ -204,6 +195,65 @@ class quarchDevice:
                 self.ConString = self.ConString.replace(':', '::')
 
             self.connectionObj = QPSConnection(host, port)
+            list = self.connectionObj.qps.sendCmdVerbose("$module list details").replace("\r\n","\n").split("\n")
+            list_str = "".join(list).lower()
+
+            timeout = time.time() + int(timeout) # now + n seconds
+            # check for device in list, has a timeout
+            while time.time() < timeout: # look for the connection string in QPS $list details
+
+                # Check if it's a module's QTL number
+                if "qtl" not in self.ConString.lower():
+
+                    # If not, check if it contains a valid IP address format
+                    ip_address = re.search(r"[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}", self.ConString)
+                    if not ip_address:
+                        raise ValueError("ConString " + self.ConString + " does not contain a valid QTL number or IP address")
+
+                    # Attempt to get QTL number from QPS "$list details"
+                    temp_str = _check_ip_in_qis_list(ip_address.group(), list)
+                    if temp_str:
+                        # If found
+                        self.ConString = temp_str
+                        break
+
+                    logging.debug("Did not find ip address in list details, attempt targetted QPS scan")
+
+                    # If it's not present in the list already, then try scanning for it via QPS
+                    # Scan is purposefully after initial check! 09/03/2023
+                    # Valid response example "Located device: 192.168.1.3"
+
+                    if "located" in str(self.connectionObj.qps.scanIP(self.ConString)).lower():
+                        # Note - QPS takes a moment or 2 to add this newly located device to the $list 21/03/23
+                        timeout += 20   # Extend the timeout as the drive was located
+                        while time.time() < timeout:
+                            # try find the QTL from ipaddress
+                            temp_str = _check_ip_in_qis_list(ip_address.group(), self.connectionObj.qps.get_list_details())
+                            if temp_str:
+                                # If the item is found, break out of this loop
+                                self.ConString = temp_str
+                                break
+                            time.sleep(1)   # Slow down the poll
+                        else:
+                            # if it's not found, continue and allow program to timeout
+                            continue
+                        # Break out of both loops
+                        break
+
+                elif str(self.ConString).lower() in str(list_str).lower():
+                    # If we have QTL device, and it's in list, nothing more needs done.
+                    break
+                else:
+                    time.sleep(1)
+                    list = self.connectionObj.qps.getDeviceList()
+                    list_str = "".join(list).lower()
+            else: # If we didn't hit a 'break' condition in the above loop, then it timed out
+                raise timeout_exception("Could not find module " + self.ConString + " from QPS within specified time")
+
+
+
+
+
 
             ## Neither PY or QIS, connection cannot be created.
         else:
@@ -238,7 +288,7 @@ class quarchDevice:
         # send command to log
         logging.debug(os.path.basename(__file__) + ": "+self.ConType[:3]+" sending command: " + CommandString)
 
-        if self.ConType[:3] == "QIS":
+        if self.ConType[:3].upper() == "QIS":
 
             numb_colons = self.ConString.count(":")
             if numb_colons == 1:
@@ -249,13 +299,13 @@ class quarchDevice:
             logging.debug(os.path.basename(__file__) + ": "+self.ConType[:3]+" received: " + response)
             return response
 
-        elif self.ConType == "PY":
+        elif self.ConType.upper() == "PY":
             response = self.connectionObj.connection.sendCommand(CommandString, expectedResponse=expectedResponse)
             # send response to log
             logging.debug(os.path.basename(__file__) + ": "+self.ConType[:3]+" received: " + response)
             return response
 
-        elif self.ConType[:3] == "QPS":
+        elif self.ConType[:3].upper() == "QPS":
             # If "$" CMD is for QPS, else its for the specific module. Since QPS can talk to many modules we must added the conString.
             if CommandString[0] != '$':
                 CommandString = self.ConString + " " + CommandString

quarchpy/device/scanDevices.py

@@ -20,8 +20,7 @@ from quarchpy.connection_specific.connection_Serial import serialList, serial
 from quarchpy.device.quarchArray import isThisAnArrayController
 from quarchpy.connection_specific.connection_USB import TQuarchUSB_IF
 from quarchpy.connection_specific import connection_ReST, connection_TCP
-from quarchpy.connection_specific.connection_mDNS import MyListener
-from quarchpy.utilities import TestCenter
+from quarchpy.connection_specific.mDNS import MyListener
 
 
 '''
@@ -475,11 +474,14 @@ def filter_module_type(module_type_filter, found_devices):
                 filtered_devices.update({key: value})
     return filtered_devices
 
-def scan_mDNS(mdnsListener):
+def scan_mDNS(mdnsListener, zeroconf=None):
     from zeroconf import ServiceBrowser, Zeroconf
-    zeroconf = Zeroconf()
+    if zeroconf is None:
+        zeroconf = Zeroconf()
     listener = mdnsListener
     browser = ServiceBrowser(zeroconf, "_http._tcp.local.", listener)
+    return browser
+
 
 
 '''
@@ -487,10 +489,23 @@ Scans for Quarch modules across the given interface(s). Returns a dictionary of
 '''
 def scanDevices(target_conn="all", lanTimeout=1, scanInArray=True, favouriteOnly=True,filterStr=None,
                 module_type_filter=None, ipAddressLookup=None):
+
     foundDevices = dict()
     scannedArrays = list()
-    mdnsListener = MyListener()
-    scan_mDNS(mdnsListener)
+
+    # Setup mdns with zeroconf
+    # Ensure listener/zeroconf instance stay persistent (ensures only one thread is used for each scan cycle)
+    mdns_listener = MyListener().get_instance()
+    zeroconf = mdns_listener.get_zeroconf()
+    # Setup new mdns discovery service for every scan cycle
+    browser = scan_mDNS(mdns_listener, zeroconf)
+    # Set target_conn
+    mdns_listener.target_conn = target_conn.lower()
+    # Setup mdns discovery that stays persistent in the background - (could be removed)
+    # if not mdns_listener.mdns_service_running:
+    #     from zeroconf import ServiceBrowser, Zeroconf
+    #     scan_mDNS(mdns_listener, None)
+    #     mdns_listener.mdns_service_running = True
 
     if target_conn.lower() == "all":
         foundDevices = list_USB()
@@ -498,10 +513,7 @@ def scanDevices(target_conn="all", lanTimeout=1, scanInArray=True, favouriteOnly
         try:
             #This will fail if the test machine is not connected to a network
             foundDevices = mergeDict(foundDevices, list_network("all", ipAddressLookup=ipAddressLookup, lanTimeout=lanTimeout))
-            try:
-                foundDevices = mergeDict(foundDevices, mdnsListener.found_devices)
-            except Exception as mdnsExcept:
-                logging.debug("An error occurred while trying to use the mdns listner to scan\n" +str(mdnsExcept))
+            foundDevices = mergeDict(foundDevices, mdns_listener.get_found_devices())
         except Exception as e:
             logging.error(e)
             logging.warning("Network scan failed, check network connection")
@@ -514,6 +526,8 @@ def scanDevices(target_conn="all", lanTimeout=1, scanInArray=True, favouriteOnly
 
     if target_conn.lower() == "tcp" or target_conn.lower() == "rest" or target_conn.lower() == "telnet":
         foundDevices = list_network(target_conn, ipAddressLookup=ipAddressLookup, lanTimeout=lanTimeout)
+        foundDevices = mergeDict(foundDevices, mdns_listener.get_found_devices())
+
 
     if (scanInArray):
         for k, v in foundDevices.items(): # k=Connection target, v=serial number
@@ -567,7 +581,8 @@ def scanDevices(target_conn="all", lanTimeout=1, scanInArray=True, favouriteOnly
     # used to filter module via type ( Power / Drive / ...)
     if module_type_filter:
         foundDevices = filter_module_type(module_type_filter, foundDevices)
-
+    # Cancels the mdns discovery service (required to close active thread)
+    browser.cancel()
     return foundDevices
 
 

quarchpy/docs/CHANGES.rst

@@ -13,6 +13,15 @@ Quarchpy
 Change Log
 ----------
 
+2.1.25
+------
+- New QPS 1.40 and Qis 1.43
+- mdns scanning added to quarchpy
+
+2.1.24
+------
+- Yanked
+
 2.1.23
 ------
 - QIS and QPS devices and interfaces can use sendCommand to send comannds to the modules and to the applications uniformly