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

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,19 @@ Quarchpy
 Change Log
 ----------
 
+2.1.26
+------
+- minor bugfix
+
+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