quarchpy 2.1.20.dev1__py2.py3-none-any.whl → 2.1.20.dev3__py2.py3-none-any.whl

quarchpy/device/scanDevices.py

@@ -178,39 +178,32 @@ List all Quarch devices found over LAN, using a UDP broadcast scan
 def list_network(target_conn="all", debugPring=False, lanTimeout=1, ipAddressLookup=None):
 
     retVal={}
-
     lan_modules = dict()
-
     specifiedDevice = None
-
     # Broadcast the message.
     logging.debug("Broadcast LAN discovery message for UDP scan to all network interfaces")
     ipList = socket.gethostbyname_ex(socket.gethostname())
     logging.debug(os.path.basename(__file__) + ": Discovered the following interfaces: " + str(ipList))
 
+
+
     for ip in ipList[2]:
-        
         logging.debug(os.path.basename(__file__) + ": Broadcasting on : " + ip)
-        
         try:
-
             mySocket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
             mySocket.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
             mySocket.settimeout(lanTimeout)
             mySocket.bind((ip,56732))
-
-            if ipAddressLookup is not None:
-                # Attempts to find the device through UDP then REST
-                specifiedDevice = lookupDevice(str(ipAddressLookup).strip(), mySocket, lan_modules)
-
         except Exception as err:
-
             logging.debug("Error while trying to bind to network interfaces: "+" Error: "+str(err))
 
-        mySocket.sendto(b'Discovery: Who is out there?\0\n', ('255.255.255.255', 30303))
+        if ipAddressLookup is not None:
+            # Attempts to find the device through UDP then REST
+            specifiedDevice = lookupDevice(str(ipAddressLookup).strip(), mySocket, lan_modules)
 
-        counter = 0
 
+        mySocket.sendto(b'Discovery: Who is out there?\0\n', ('255.255.255.255', 30303))
+        counter = 0
         # Receive messages until timeout.
         while True:
             network_modules = {}
@@ -218,7 +211,7 @@ def list_network(target_conn="all", debugPring=False, lanTimeout=1, ipAddressLoo
             # Receive raw message until timeout, then break.
             try:
                 msg_received = mySocket.recvfrom(256)
-            except:
+            except Exception as e:
                 # check if any a device was targeted directly and allow parse
                 if specifiedDevice is not None:
                     msg_received = specifiedDevice
@@ -240,14 +233,10 @@ def list_network(target_conn="all", debugPring=False, lanTimeout=1, ipAddressLoo
                 else:
                     index = repr(lines[0]).replace("'", "")
                     data = repr(lines[1:]).replace("'", "").replace("b", "")
-
                 network_modules[index] = data
-
             module_name = get_user_level_serial_number(network_modules)
             logging.debug("Found UDP response: " + module_name)
-
             ip_module = msg_received[1][0].strip()
-
             try:
                 # Add a QTL before modules without it.
                 if "QTL" not in module_name.decode("utf-8"):
@@ -277,15 +266,20 @@ def list_network(target_conn="all", debugPring=False, lanTimeout=1, ipAddressLoo
                     # Append the information to the list.
                     lan_modules["TCP:" + ip_module] = module_name
                     logging.debug("Found TCP module: " + module_name)
-
         mySocket.close()
+
     logging.debug("Finished UDP scan")
     retVal.update(lan_modules)
     return retVal
 
 
-''''''
+
 def get_user_level_serial_number(network_modules):
+    '''
+
+    :param network_modules:
+    :return:
+    '''
     list_of_multi_module_units = ["1995"]  # List of modules that require enclosure number + Port to be displayed.
 
     # Filter the raw message to get the module and ip address.
@@ -313,54 +307,53 @@ def get_user_level_serial_number(network_modules):
 ''''''
 def lookupDevice(ipAddressLookup, mySocket, lan_modules):
     try:
-        printText("Ipaddress lookup " + ipAddressLookup)
+        logging.debug("Ipaddress lookup " + ipAddressLookup)
         # For future reference, 0 is the C terminator for a string
         mySocket.sendto(b'Discovery: Who is out there?\0\n', (str(ipAddressLookup).strip(), 30303))
         specifiedDevice = mySocket.recvfrom(256)
         # Check to see if the response contains the connection protocol
-        if ("\\x8a") or ("138") or ("\\x84") or ("132") or ("\\x85") or ("133") not in specifiedDevice:
-            # If not allow it to fall-back to REST
-            specifiedDevice = None
-        else:
-            # Exit as device was found correctly
-            return specifiedDevice
+        return specifiedDevice
     except Exception as e:
-        printText("Error during UDP lookup " + str(e))
-        printText("Is the IP address correct?\r\n")
-        # Return if there's an error
-        return None
+        logging.warning("Error during UDP lookup of IP address "+ str(ipAddressLookup) +"  Error: " + str(e))
+        logging.warning("No Quarch module found at this address. Please check the IP address and that you can ping it.\r\n")
+    return None
+    #
+    # if specifiedDevice is None: #Only True if TCP not found or errored
+    #     try:
+    #         restCon = connection_ReST.ReSTConn(str(ipAddressLookup).replace("\r\n", ""))
+    #         restDevice = restCon.sendCommand("*enclosure?") #Try use enclosure for PPMs
+    #         if "fail" in restDevice.lower(): # This will fail nicely for other modules
+    #             restDevice = restCon.sendCommand("*serial?") # and serial number will be used in place.
+    #         if not str(restDevice).startswith("QTL"):
+    #             restDevice = "QTL" + restDevice
+    #         # Exit as device was found correctly
+    #         # Add the item to list
+    #         lan_modules["REST:" + str(ipAddressLookup).replace("\r\n", "")] = restDevice
+    #         specifiedDevice=None # Don't return rest connection, to bypass tcp parsing.
+    #     except Exception as e:
+    #         logging.warning("Error During REST scan of IP address " + str(ipAddressLookup) + "  Error: " + str(e))
+    #         logging.warning("Please check the IP address and that you can ping it.\r\n")
+    #
+    #     # Needs to return None so previous method will not attempt another lookup.
+    #     return specifiedDevice
+
 
-    if specifiedDevice is None:
-        try:
-            restCon = connection_ReST.ReSTConn(str(ipAddressLookup).replace("\r\n", ""))
-            restDevice = restCon.sendCommand("*serial?")
-            if not str(restDevice).startswith("QTL"):
-                restDevice = "QTL" + restDevice
-            # Add the item to list
-            lan_modules["REST:" + str(ipAddressLookup).replace("\r\n", "")] = restDevice
 
-        except Exception as e:
-            printText("Error During REST scan " + str(e))
-
-        # Needs to return None so previous method will not attempt another lookup.
-        return None
-
-
-"""
-                    Takes in the connection target and returns the serial number of a module found on the standard scan.
-                    
-                    Parameters
-                    ----------
-                    connectionTarget= : str
-                        The connection target of the module you would like to know the serial number of.
-                        
-                    Returns
-                    -------
-                    ret_val : str
-                        The Serial number of the supplied device.
-
-"""
 def getSerialNumberFromConnectionTarget(connectionTarget):
+    """
+                        Takes in the connection target and returns the serial number of a module found on the standard scan.
+
+                        Parameters
+                        ----------
+                        connectionTarget= : str
+                            The connection target of the module you would like to know the serial number of.
+
+                        Returns
+                        -------
+                        ret_val : str
+                            The Serial number of the supplied device.
+
+    """
     myDict = scanDevices(favouriteOnly=False)
     for k,v in myDict.items():
         if k == connectionTarget:
@@ -368,32 +361,31 @@ def getSerialNumberFromConnectionTarget(connectionTarget):
     return None
 
 
-"""
-                    Takes in the connection type and serial number of a module and returns the connection target.
-                    
-                    Parameters
-                    ----------
-                    module_string= : str
-                        The connection type and serial number combination eg. TCP:QTL1999-05-005.
-                        
-                    scan_dictionary= :dict, optional
-                        A scan dictionary can be passed so that a scan does not need to take place on every call.
-                        This would be advised if calling this for every item in a list of serial numbers.
-                        
-                    connection_preference= : list str, optional
-                        The preference of which connection type to prioratise if none it given. 
-                        Defaults to "USB", "TCP", "SERIAL", "REST", "TELNET" in that order.
-                        
-                    include_conn_type = : boolean, optional
-                        Decided whether the connection type will appear in the return value eg. TCP:192.168.1.1 vs 192.168.1.1
-                    
-                    Returns
-                    -------
-                    ret_val : str
-                        The Connection target of the supplied device.
-
-"""
 def get_connection_target(module_string ,scan_dictionary=None, connection_preference= None, include_conn_type = True):
+    """
+                        Takes in the connection type and serial number of a module and returns the connection target.
+
+                        Parameters
+                        ----------
+                        module_string= : str
+                            The connection type and serial number combination eg. TCP:QTL1999-05-005.
+
+                        scan_dictionary= :dict, optional
+                            A scan dictionary can be passed so that a scan does not need to take place on every call.
+                            This would be advised if calling this for every item in a list of serial numbers.
+
+                        connection_preference= : list str, optional
+                            The preference of which connection type to prioratise if none it given.
+                            Defaults to "USB", "TCP", "SERIAL", "REST", "TELNET" in that order.
+
+                        include_conn_type = : boolean, optional
+                            Decided whether the connection type will appear in the return value eg. TCP:192.168.1.1 vs 192.168.1.1
+
+                        Returns
+                        -------
+                        ret_val : str
+                            The Connection target of the supplied device.
+    """
     logging.debug("Getting connection target for : "+ str(module_string))
     if connection_preference == None:
         connection_preference = ["USB", "TCP", "SERIAL", "REST", "TELNET"]

quarchpy/device/scanDevices.py.bak

@@ -20,7 +20,8 @@ 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
-from quarchpy.connection_specific.connection_mDNS import MyListener
+
+# TODO: bodge bodge bodge
 from quarchpy.utilities import TestCenter
 
 
@@ -175,9 +176,25 @@ def list_USB(debuPrint=False):
 '''
 List all Quarch devices found over LAN, using a UDP broadcast scan
 '''
+
+def get_interface_ips():
+    interfaces = socket.if_nameindex()
+    interface_ips = {}
+    for idx, interface in interfaces:
+        try:
+            addresses = socket.getaddrinfo(interface, None)
+            ip_addresses = [addr[4][0] for addr in addresses]
+            interface_ips[interface] = ip_addresses
+        except socket.gaierror:
+            logging.warning(f"Unable to get IP address for interface {interface}")
+    return interface_ips
 def list_network(target_conn="all", debugPring=False, lanTimeout=1, ipAddressLookup=None):
 
     retVal={}
+    # Create and configure the socket for broadcast.
+    mySocket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+    mySocket.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
+    mySocket.settimeout(lanTimeout)
 
     lan_modules = dict()
 
@@ -186,101 +203,96 @@ def list_network(target_conn="all", debugPring=False, lanTimeout=1, ipAddressLoo
     if ipAddressLookup is not None:
         # Attempts to find the device through UDP then REST
         specifiedDevice = lookupDevice(str(ipAddressLookup).strip(), mySocket, lan_modules )
+        mySocket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+        mySocket.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
+        mySocket.settimeout(lanTimeout)
+
+
 
     # Broadcast the message.
     logging.debug("Broadcast LAN discovery message for UDP scan to all network interfaces")
-    ipList = socket.gethostbyname_ex(socket.gethostname())
-    logging.debug(os.path.basename(__file__) + ": Discovered the following interfaces: " + str(ipList))
-
-    for ip in ipList[2]:
-        
-        logging.debug(os.path.basename(__file__) + ": Broadcasting on : " + ip)
-        
+    logging.debug("Available network interfaces before binding:")
+    interfaces = socket.if_nameindex()
+    for idx, interface in interfaces:
+        logging.debug(f"Interface {idx}: {interface}")
+    try:
+        # Bind to all network interfaces using '', same as '0.0.0.0'
+        mySocket.bind(('',56732))
+    except Exception as err:
+        logging.debug("Error while trying to bind to network interfaces: "+" Error: "+str(err))
+    mySocket.sendto(b'Discovery: Who is out there?\0\n', ('255.255.255.255', 30303))
+    #mySocket.sendto(b'Discovery: Who is out there?\0\n', ('255.255.255.255', 30303)) #56732
+
+    counter = 0
+
+    # Receive messages until timeout.
+    while True:
+        network_modules = {}
+        counter += 1
+        # Receive raw message until timeout, then break.
         try:
+            msg_received = mySocket.recvfrom(256)
+        except:
+            # check if any a device was targeted directly and allow parse
+            if specifiedDevice is not None:
+                msg_received = specifiedDevice
+                specifiedDevice = None
+            else:
+                break
+        cont = 0
+
+        # print(msg_received)
+        # Used split \r\n since values of 13 or 10 were looked at as /r and /n when using splitlines
+        # This fixes for all cases except if 13 is followed by 10.
+        splits = msg_received[0].split(b"\r\n")
+        del splits[-1]
+        for lines in splits:
+            if cont <= 1:
+                index = cont
+                data = repr(lines).replace("'", "").replace("b", "")
+                cont += 1
+            else:
+                index = repr(lines[0]).replace("'", "")
+                data = repr(lines[1:]).replace("'", "").replace("b", "")
 
-            mySocket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
-            mySocket.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
-            mySocket.settimeout(lanTimeout)
-            mySocket.bind((ip,56732))
-        
-        except Exception as err:
-
-            logging.debug("Error while trying to bind to network interfaces: "+" Error: "+str(err))
-
-
-
-        mySocket.sendto(b'Discovery: Who is out there?\0\n', ('255.255.255.255', 30303))
+            network_modules[index] = data
 
-        counter = 0
+        module_name = get_user_level_serial_number(network_modules)
+        logging.debug("Found UDP response: " + module_name)
 
-        # Receive messages until timeout.
-        while True:
-            network_modules = {}
-            counter += 1
-            # Receive raw message until timeout, then break.
-            try:
-                msg_received = mySocket.recvfrom(256)
-            except:
-                # check if any a device was targeted directly and allow parse
-                if specifiedDevice is not None:
-                    msg_received = specifiedDevice
-                    specifiedDevice = None
-                else:
-                    break
-            cont = 0
-
-            # print(msg_received)
-            # Used split \r\n since values of 13 or 10 were looked at as /r and /n when using splitlines
-            # This fixes for all cases except if 13 is followed by 10.
-            splits = msg_received[0].split(b"\r\n")
-            del splits[-1]
-            for lines in splits:
-                if cont <= 1:
-                    index = cont
-                    data = repr(lines).replace("'", "").replace("b", "")
-                    cont += 1
-                else:
-                    index = repr(lines[0]).replace("'", "")
-                    data = repr(lines[1:]).replace("'", "").replace("b", "")
-
-                network_modules[index] = data
-
-            module_name = get_user_level_serial_number(network_modules)
-            logging.debug("Found UDP response: " + module_name)
-
-            ip_module = msg_received[1][0].strip()
+        ip_module = msg_received[1][0].strip()
 
-            try:
-                # Add a QTL before modules without it.
-                if "QTL" not in module_name.decode("utf-8"):
-                    module_name = "QTL" + module_name.decode("utf-8")
-            except:
-                # Add a QTL before modules without it.
-                if "QTL" not in module_name:
-                    module_name = "QTL" + module_name
-
-            # Checks if there's a value in the TELNET key.
-            if (target_conn.lower() == "all" or target_conn.lower() == "telnet"):
-                if network_modules.get("\\x8a") or network_modules.get("138"):
-                    # Append the information to the list.
-                    lan_modules["TELNET:" + ip_module] = module_name
-                    logging.debug("Found Telnet module: " + module_name)
-
-            # Checks if there's a value in the REST key.
-            if (target_conn.lower() == "all" or target_conn.lower() == "rest"):
-                if network_modules.get("\\x84") or network_modules.get("132"):
-                    # Append the information to the list.
-                    lan_modules["REST:" + ip_module] = module_name
-                    logging.debug("Found REST module: " + module_name)
-
-            # Checks if there's a value in the TCP key.
-            if (target_conn.lower() == "all" or target_conn.lower() == "tcp"):
-                if network_modules.get("\\x85") or network_modules.get("133"):
-                    # Append the information to the list.
-                    lan_modules["TCP:" + ip_module] = module_name
-                    logging.debug("Found TCP module: " + module_name)
-
-        mySocket.close()
+        try:
+            # Add a QTL before modules without it.
+            if "QTL" not in module_name.decode("utf-8"):
+                module_name = "QTL" + module_name.decode("utf-8")
+        except:
+            # Add a QTL before modules without it.
+            if "QTL" not in module_name:
+                module_name = "QTL" + module_name
+
+        # Checks if there's a value in the TELNET key.
+        if (target_conn.lower() == "all" or target_conn.lower() == "telnet"):
+            if network_modules.get("\\x8a") or network_modules.get("138"):
+                # Append the information to the list.
+                lan_modules["TELNET:" + ip_module] = module_name
+                logging.debug("Found Telnet module: " + module_name)
+
+        # Checks if there's a value in the REST key.
+        if (target_conn.lower() == "all" or target_conn.lower() == "rest"):
+            if network_modules.get("\\x84") or network_modules.get("132"):
+                # Append the information to the list.
+                lan_modules["REST:" + ip_module] = module_name
+                logging.debug("Found REST module: " + module_name)
+
+        # Checks if there's a value in the TCP key.
+        if (target_conn.lower() == "all" or target_conn.lower() == "tcp"):
+            if network_modules.get("\\x85") or network_modules.get("133"):
+                # Append the information to the list.
+                lan_modules["TCP:" + ip_module] = module_name
+                logging.debug("Found TCP module: " + module_name)
+
+    mySocket.close()
     logging.debug("Finished UDP scan")
     retVal.update(lan_modules)
     return retVal
@@ -459,12 +471,6 @@ def filter_module_type(module_type_filter, found_devices):
                 filtered_devices.update({key: value})
     return filtered_devices
 
-def scan_mDNS(mdnsListener):
-    from zeroconf import ServiceBrowser, Zeroconf
-    zeroconf = Zeroconf()
-    listener = mdnsListener
-    browser = ServiceBrowser(zeroconf, "_http._tcp.local.", listener)
-
 
 '''
 Scans for Quarch modules across the given interface(s). Returns a dictionary of module addresses and serial numbers
@@ -474,19 +480,12 @@ def scanDevices(target_conn="all", lanTimeout=1, scanInArray=True, favouriteOnly
     foundDevices = dict()
     scannedArrays = list()
 
-
     if target_conn.lower() == "all":
         foundDevices = list_USB()
         foundDevices = mergeDict(foundDevices, list_serial())
         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:
-                mdnsListener = MyListener()
-                scan_mDNS(mdnsListener)
-                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))
         except Exception as e:
             logging.error(e)
             logging.warning("Network scan failed, check network connection")
@@ -513,8 +512,8 @@ def scanDevices(target_conn="all", lanTimeout=1, scanInArray=True, favouriteOnly
                         foundDevices = mergeDict(foundDevices, scanDevices)
                         myArrayControler.closeConnection()
                     except Exception as e:
-                        logging.debug(e, exc_info=True)
-                        logging.debug("Cannot get serial number. Quarch device may be in use by another program.")
+                        logging.error(e, exc_info=True)
+                        logging.warning("Cannot get serial number. Quarch device may be in use by another program.")
                         foundDevices[k] = "DEVICE IN USE"
 
     if (favouriteOnly):
@@ -594,7 +593,7 @@ def userSelectDevice(scanDictionary=None, scanFilterStr=None,favouriteOnly=True,
 
 
         if nice: #Prepair the data for niceListSelection using displayTable().
-            if additionalOptions is None: additionalOptions = ["Specify IP Address","Rescan","Quit"]
+            if additionalOptions is None: additionalOptions = ["IP Scan","Rescan","Quit"]
             tempList = []
             tempEl = []
             for k, v in scanDictionary.items():
@@ -617,7 +616,7 @@ def userSelectDevice(scanDictionary=None, scanFilterStr=None,favouriteOnly=True,
                 devicesString.append(k + '=' + v + ": " + k[:charPos])
             devicesString = ','.join(devicesString)
             if additionalOptions is None :
-                additionalOptions = "Specify IP Address=IP Scan,Rescan=Rescan,Quit=Quit"
+                additionalOptions = "IP Scan=IP Scan,Rescan=Rescan,Quit=Quit"
             userStr = listSelection(title=title,message=message,selectionList=devicesString, additionalOptions=additionalOptions)
 
         # Process the user response
@@ -631,7 +630,7 @@ def userSelectDevice(scanDictionary=None, scanFilterStr=None,favouriteOnly=True,
             ip_address = None
             scanDictionary = None
             favouriteOnly = False
-        elif(userStr.lower() in 'specify ip address'):
+        elif(userStr.lower() in 'ip scan'):
             ip_address = requestDialog("Please input IP Address of the module you would like to connect to: ")
             scanDictionary = None
             favouriteOnly = False
@@ -639,3 +638,24 @@ def userSelectDevice(scanDictionary=None, scanFilterStr=None,favouriteOnly=True,
             # Return the address string of the selected module
             return userStr
 
+
+#Not used but could come in usefull in near future.
+# def userSelectAndReturnDevice(scanDictionary=None, scanFilterStr=None,favouriteOnly=True, message=None, title=None, nice=True, additionalOptions =["rescan","all conn types", "quit"], target_conn="all"):
+#     scanDictionary = scanDevices()
+#     connectionTarget = userSelectDevice(scanDictionary, scanFilterStr, favouriteOnly, message, title, nice,
+#                      additionalOptions, target_conn)
+#     serialNumber = getSerialNumberFromConnectionTarget(connectionTarget)
+#
+#     if connectionTarget.__contains__("<") and connectionTarget.__contains__(">"):
+#         connectionTarget, portNumber = connectionTarget.split("<")
+#         portNumber = portNumber[:-1]
+#         myDevice = quarchDevice(connectionTarget)
+#         myArrayController = quarchArray(myDevice)
+#         mySubDevice = myArrayController.getSubDevice(portNumber)
+#         myDevice = mySubDevice
+#     elif(serialNumber.lower().__contains__("qtl1999") or serialNumber.lower().__contains__("qtl1995") or serialNumber.lower().__contains__("qtl2312")):
+#         myDevice = quarchPPM(quarchDevice(connectionTarget))
+#
+#     else:
+#         myDevice = quarchDevice(connectionTarget)
+#     return myDevice

quarchpy/docs/CHANGES.rst

@@ -13,6 +13,16 @@ Quarchpy
 Change Log
 ----------
 
+2.1.20
+------
+- Improved direct IP scanning for quarch modules.
+
+2.1.19
+------
+- Imporoved QIS streaming 
+- Bug fixes
+- Added zeroconf, numpy and pandas as requirements
+
 2.1.18
 ------
 - Minor bug fix