quarchpy 2.1.24.dev3__py2.py3-none-any.whl → 2.1.24.dev4__py2.py3-none-any.whl

quarchpy/.idea/workspace.xml

@@ -57,8 +57,8 @@
       <recent name="P:\Software\Python\QuarchPy\Trunk\quarchpy" />
     </key>
   </component>
-  <component name="RunManager" selected="Python.simple_terminal">
-    <configuration name="HammerRegRead" type="PythonConfigurationType" factoryName="Python" temporary="true" nameIsGenerated="true">
+  <component name="RunManager" selected="Python.simple_terminal (1)">
+    <configuration name="SystemTest" type="PythonConfigurationType" factoryName="Python" temporary="true" nameIsGenerated="true">
       <module name="quarchpy" />
       <option name="INTERPRETER_OPTIONS" value="" />
       <option name="PARENT_ENVS" value="true" />
@@ -66,11 +66,11 @@
         <env name="PYTHONUNBUFFERED" value="1" />
       </envs>
       <option name="SDK_HOME" value="" />
-      <option name="WORKING_DIRECTORY" value="$USER_HOME$/Desktop" />
-      <option name="IS_MODULE_SDK" value="false" />
+      <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/debug" />
+      <option name="IS_MODULE_SDK" value="true" />
       <option name="ADD_CONTENT_ROOTS" value="true" />
       <option name="ADD_SOURCE_ROOTS" value="true" />
-      <option name="SCRIPT_NAME" value="$USER_HOME$/Desktop/HammerRegRead.py" />
+      <option name="SCRIPT_NAME" value="$PROJECT_DIR$/debug/SystemTest.py" />
       <option name="PARAMETERS" value="" />
       <option name="SHOW_COMMAND_LINE" value="false" />
       <option name="EMULATE_TERMINAL" value="false" />
@@ -79,19 +79,19 @@
       <option name="INPUT_FILE" value="" />
       <method v="2" />
     </configuration>
-    <configuration name="SystemTest" type="PythonConfigurationType" factoryName="Python" temporary="true" nameIsGenerated="true">
-      <module name="quarchpy" />
+    <configuration name="TestMultiNWA" type="PythonConfigurationType" factoryName="Python" temporary="true" nameIsGenerated="true">
+      <module name="Application Notes" />
       <option name="INTERPRETER_OPTIONS" value="" />
       <option name="PARENT_ENVS" value="true" />
       <envs>
         <env name="PYTHONUNBUFFERED" value="1" />
       </envs>
       <option name="SDK_HOME" value="" />
-      <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/debug" />
+      <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/../../../../Application Notes" />
       <option name="IS_MODULE_SDK" value="true" />
       <option name="ADD_CONTENT_ROOTS" value="true" />
       <option name="ADD_SOURCE_ROOTS" value="true" />
-      <option name="SCRIPT_NAME" value="$PROJECT_DIR$/debug/SystemTest.py" />
+      <option name="SCRIPT_NAME" value="$PROJECT_DIR$/../../../../Application Notes/TestMultiNWA.py" />
       <option name="PARAMETERS" value="" />
       <option name="SHOW_COMMAND_LINE" value="false" />
       <option name="EMULATE_TERMINAL" value="false" />
@@ -100,19 +100,19 @@
       <option name="INPUT_FILE" value="" />
       <method v="2" />
     </configuration>
-    <configuration name="TestPYQPSQISConnectionsSameModule" type="PythonConfigurationType" factoryName="Python" temporary="true" nameIsGenerated="true">
-      <module name="Application Notes" />
+    <configuration name="scanDevices" type="PythonConfigurationType" factoryName="Python" temporary="true" nameIsGenerated="true">
+      <module name="QuarchCalibration" />
       <option name="INTERPRETER_OPTIONS" value="" />
       <option name="PARENT_ENVS" value="true" />
       <envs>
         <env name="PYTHONUNBUFFERED" value="1" />
       </envs>
       <option name="SDK_HOME" value="" />
-      <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/../../../../Application Notes/AN-006 - Python Control of Quarch Modules/Trunk" />
+      <option name="WORKING_DIRECTORY" value="C:/Python311/Lib/site-packages/quarchpy/device" />
       <option name="IS_MODULE_SDK" value="true" />
       <option name="ADD_CONTENT_ROOTS" value="true" />
       <option name="ADD_SOURCE_ROOTS" value="true" />
-      <option name="SCRIPT_NAME" value="$PROJECT_DIR$/../../../../Application Notes/AN-006 - Python Control of Quarch Modules/Trunk/TestPYQPSQISConnectionsSameModule.py" />
+      <option name="SCRIPT_NAME" value="C:/Python311/Lib/site-packages/quarchpy/device/scanDevices.py" />
       <option name="PARAMETERS" value="" />
       <option name="SHOW_COMMAND_LINE" value="false" />
       <option name="EMULATE_TERMINAL" value="false" />
@@ -121,19 +121,19 @@
       <option name="INPUT_FILE" value="" />
       <method v="2" />
     </configuration>
-    <configuration name="scanDevices" type="PythonConfigurationType" factoryName="Python" temporary="true" nameIsGenerated="true">
-      <module name="QuarchCalibration" />
+    <configuration name="simple_terminal (1)" type="PythonConfigurationType" factoryName="Python" temporary="true" nameIsGenerated="true">
+      <module name="quarchpy" />
       <option name="INTERPRETER_OPTIONS" value="" />
       <option name="PARENT_ENVS" value="true" />
       <envs>
         <env name="PYTHONUNBUFFERED" value="1" />
       </envs>
       <option name="SDK_HOME" value="" />
-      <option name="WORKING_DIRECTORY" value="C:/Python311/Lib/site-packages/quarchpy/device" />
-      <option name="IS_MODULE_SDK" value="true" />
+      <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/.." />
+      <option name="IS_MODULE_SDK" value="false" />
       <option name="ADD_CONTENT_ROOTS" value="true" />
       <option name="ADD_SOURCE_ROOTS" value="true" />
-      <option name="SCRIPT_NAME" value="C:/Python311/Lib/site-packages/quarchpy/device/scanDevices.py" />
+      <option name="SCRIPT_NAME" value="$PROJECT_DIR$/../simple_terminal.py" />
       <option name="PARAMETERS" value="" />
       <option name="SHOW_COMMAND_LINE" value="false" />
       <option name="EMULATE_TERMINAL" value="false" />
@@ -165,11 +165,11 @@
     </configuration>
     <recent_temporary>
       <list>
+        <item itemvalue="Python.simple_terminal (1)" />
+        <item itemvalue="Python.TestMultiNWA" />
         <item itemvalue="Python.simple_terminal" />
         <item itemvalue="Python.scanDevices" />
         <item itemvalue="Python.SystemTest" />
-        <item itemvalue="Python.HammerRegRead" />
-        <item itemvalue="Python.TestPYQPSQISConnectionsSameModule" />
       </list>
     </recent_temporary>
   </component>
@@ -314,17 +314,12 @@
         </line-breakpoint>
         <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
           <url>file://C:/Python311/Lib/site-packages/quarchpy/device/scanDevices.py</url>
-          <line>350</line>
-          <option name="timeStamp" value="109" />
-        </line-breakpoint>
-        <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
-          <url>file://C:/Python311/Lib/site-packages/quarchpy/device/scanDevices.py</url>
-          <line>341</line>
+          <line>343</line>
           <option name="timeStamp" value="110" />
         </line-breakpoint>
         <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
           <url>file://C:/Python311/Lib/site-packages/quarchpy/device/scanDevices.py</url>
-          <line>326</line>
+          <line>328</line>
           <option name="timeStamp" value="112" />
         </line-breakpoint>
         <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
@@ -332,6 +327,26 @@
           <line>186</line>
           <option name="timeStamp" value="113" />
         </line-breakpoint>
+        <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
+          <url>file://$PROJECT_DIR$/../simple_terminal.py</url>
+          <line>21</line>
+          <option name="timeStamp" value="114" />
+        </line-breakpoint>
+        <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
+          <url>file://$PROJECT_DIR$/../simple_terminal.py</url>
+          <line>13</line>
+          <option name="timeStamp" value="115" />
+        </line-breakpoint>
+        <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
+          <url>file://C:/Projects/Software/Python/QuarchPy/Trunk/quarchpy/device/scanDevices.py</url>
+          <line>272</line>
+          <option name="timeStamp" value="116" />
+        </line-breakpoint>
+        <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
+          <url>file://$PROJECT_DIR$/../../../../Application Notes/TestMultiNWA.py</url>
+          <line>30</line>
+          <option name="timeStamp" value="117" />
+        </line-breakpoint>
       </breakpoints>
       <default-breakpoints>
         <breakpoint type="python-exception">

quarchpy/_version.py

@@ -1 +1 @@
-__version__ = "2.1.24.dev3"
+__version__ = "2.1.24.dev4"

quarchpy/_version.py.bak

@@ -0,0 +1 @@
+__version__ = "2.1.24.dev3"

quarchpy/device/scanDevices.py

@@ -183,7 +183,7 @@ def list_network(target_conn="all", debugPring=False, lanTimeout=1, ipAddressLoo
     # Broadcast the message.
     logging.debug("Broadcast LAN discovery message for UDP scan to all network interfaces")
     ipList = socket.gethostbyname_ex(socket.gethostname())
-    temp1= socket.gethostname()
+    ipList[2].append("")
     logging.debug(os.path.basename(__file__) + ": Discovered the following interfaces: " + str(ipList))
 
 

quarchpy/device/scanDevices.py.bak

@@ -0,0 +1,655 @@
+import time
+import socket
+import sys
+import operator
+import logging
+import os
+
+from sys import platform
+
+from quarchpy.config_files.quarch_config_parser import return_module_type_list
+from quarchpy.user_interface import*
+from quarchpy.user_interface import User_interface
+try:
+    from quarchpy.connection_specific.connection_USB import importUSB  # , USBConn
+except:
+    printText("System Compatibility issue - Is your Python architecture consistent with the Operating System?")
+    pass
+from quarchpy.device import quarchDevice, quarchArray
+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
+
+
+'''
+Merge two dictionaries and return the result
+'''
+def mergeDict(x, y):
+    if (y is None):
+        return x
+    else:
+        merged = x.copy()
+        merged.update(y)
+        return merged
+
+
+'''
+Scan for Quarch modules across all available COM ports
+'''
+def list_serial(debuPrint=False):
+    serial_ports = serialList.comports()
+    serial_modules = dict()
+
+    for i in serial_ports:
+        logging.debug("Scanning for Quarch devices on: " + str(i))
+        try:
+            ser = serial.Serial(i[0], 19200, timeout=0.5, write_timeout=0.5)
+            ser.write(b'*serial?\r\n')
+            s = ser.read(size=64)
+            serial_module = s.splitlines()[1]
+
+            serial_module = str(serial_module).replace("'", "").replace("b", "")
+
+            if "QTL" not in serial_module:
+                serial_module = "QTL" + serial_module
+
+            module = str(i[0]), str(serial_module)
+
+            if serial_module[7] == "-" and serial_module[10] == "-":
+                serial_modules["SERIAL:" + str(i[0])] = serial_module
+                logging.debug("Located quarch module: " + serial_module)
+
+            ser.close()
+            logging.debug("Finished scanning for Quarch devices on: " + str(i))
+        except Exception as err:
+            logging.debug("Exception during serial scan: " + str(err))
+            pass
+    return serial_modules
+
+
+'''
+Scan for all Quarch devices available over USB
+'''
+def list_USB(debuPrint=False):
+    QUARCH_VENDOR_ID = 0x16d0
+    QUARCH_PRODUCT_ID1 = 0x0449
+
+    usb1 = importUSB()
+
+    context = usb1.USBContext()
+    usb_list = context.getDeviceList()
+
+    if (debuPrint): printText(usb_list)
+
+    usb_modules = dict()
+    hdList = []
+
+    usb_permission_error = False
+
+    for i in usb_list:
+        if hex(i.device_descriptor.idVendor) == hex(QUARCH_VENDOR_ID) and hex(i.device_descriptor.idProduct) == hex(
+                QUARCH_PRODUCT_ID1):
+            try:
+                logging.debug("Opening USB handle to quarch module: " + str(i))
+                i_handle = i.open()
+            except Exception as err:
+                logging.debug("USB port open exception: " + str(err))
+                if "LIBUSB_ERROR_ACCESS [-3]" in str(err):
+                    logging.debug("Unable to communicate with Quarch module over USB, device may be in use already.")
+                    if not platform == "win32":
+                        if not os.path.isfile("/etc/udev/rules.d/20-quarchmodules.rules"):
+                            usb_permission_error = True
+                usb_modules["USB:???"] = "LOCKED MODULE"
+
+
+            try:
+                module_sn = i_handle.getASCIIStringDescriptor(3)
+                if "1944" in module_sn or "2098" in module_sn :  #use enclosure number instead of serial number
+                    hdList.append(i)
+            except Exception as err:
+                logging.debug("USB exception on reading serial number: " + str(err))
+                usb_modules["USB:???"] = "LOCKED MODULE"
+                continue
+
+            try:
+                if (debuPrint): printText(i_handle.getASCIIStringDescriptor(3) + " " + i_handle.getASCIIStringDescriptor(
+                    2) + " " + i_handle.getASCIIStringDescriptor(1))
+            except Exception as err:
+                logging.error("USB exception on reading descriptor strings: " + str(err))
+                usb_modules["USB:???"] = "LOCKED MODULE"
+                continue
+
+            if "QTL" not in module_sn:
+                module_sn = "QTL" + module_sn.strip()
+            else:
+                module_sn = module_sn.strip()
+
+            if (debuPrint): printText(module_sn)
+
+            usb_modules["USB:" + module_sn] = module_sn
+            logging.debug("Located USB module: " + module_sn)
+
+            try:
+                logging.debug("Closing USB handle to quarch module: " + str(i))
+                i_handle.close()
+            except Exception as err:
+                logging.error("Exception on closing USB port: " + str(err))
+                continue
+
+    # before returning the list of usb modules scan through the list for a 1944 create a quarch device and use sendCommand("*enclosure?")
+
+    for module in hdList:
+
+        QquarchDevice = None
+        quarchDevice = None
+        quarchDevice = module
+        QquarchDevice = TQuarchUSB_IF(context)
+        QquarchDevice.connection = quarchDevice
+        QquarchDevice.OpenPort()
+        time.sleep(0.02)  # sleep sometimes needed before sending comand directly after opening device
+        QquarchDevice.SetTimeout(2000)
+        serialNo = (QquarchDevice.RunCommand("*serial?")).replace("\r\n", "")
+        enclNo = (QquarchDevice.RunCommand("*enclosure?")).replace("\r\n", "")
+
+        keyToFind = "USB:QTL" + serialNo
+
+        if keyToFind in usb_modules:
+            del usb_modules[keyToFind]
+            usb_modules["USB:QTL" + enclNo] = "QTL" + enclNo
+            logging.debug("Located USB module: QTL" + enclNo)
+
+        QquarchDevice.ClosePort()
+        QquarchDevice.deviceHandle = None
+
+
+    if usb_permission_error:
+        logging.warning("Potential permission error accessing Quarch module(s) via USB.")
+        logging.warning("If unknown, run the command 'sudo python3 -m quarchpy.run debug --fixusb' to add a new usb rule.")
+
+    return usb_modules
+
+
+'''
+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())
+    temp1= 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))
+        except Exception as err:
+            logging.debug("Error while trying to bind to network interfaces: "+" Error: "+str(err))
+
+        if ipAddressLookup is not None:
+            # Attempts to find the device through UDP then REST
+            specifiedDevice = lookupDevice(str(ipAddressLookup).strip(), mySocket, lan_modules)
+
+
+        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 = {}
+            counter += 1
+            # Receive raw message until timeout, then break.
+            try:
+                msg_received = mySocket.recvfrom(256)
+            except Exception as e:
+                # 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
+
+            # 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()
+            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
+
+
+
+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.
+    if "134" in network_modules.keys():
+        module_name = network_modules.get("134").strip()                    # enclosure number only
+        for module in list_of_multi_module_units:
+            if module in module_name:
+                module_name += "-" + network_modules.get("135").strip()     # enclosure number with port
+                break
+    elif "\\x86" in network_modules.keys():
+        module_name = network_modules.get("\\x86").strip()  # enclosure number only
+        for module in list_of_multi_module_units:
+            if module in module_name:
+                module_name += "-" + network_modules.get("\\x87").strip()     # enclosure number with port
+                break
+    else:
+        if "131" in network_modules.keys():
+            module_name = module_name = network_modules.get("131").strip()      # serial number
+        elif "\\x83" in network_modules.keys():
+            module_name = module_name = network_modules.get("\\x83").strip()  # serial number
+
+    return module_name
+
+
+''''''
+def lookupDevice(ipAddressLookup, mySocket, lan_modules):
+    try:
+        specifiedDevice =None
+        # For future reference, 0 is the C terminator for a string
+        timeout = mySocket.gettimeout()
+        # mySocket.settimeout(20)
+        # timeout2 = mySocket.gettimeout()
+        logging.debug("Ipaddress lookup =" + ipAddressLookup+ "  timeout = "+ str(timeout))
+
+        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
+        return specifiedDevice
+    except Exception as e:
+        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 # Commented out, attempt a REST connection with IP. This is what other quarch applications do.
+    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")
+        try:
+            # from threading import Thread
+            # t = Thread(target=connection_TCP.TCPConn, args=(str(ipAddressLookup).replace("\r\n", ""),))
+            # t.daemon = True
+            # t.start()
+            # t.join(50)
+            # if t.is_alive():
+            #     raise TimeoutError("Timeout during TCP Connection attempt.")
+
+            tcpCon= connection_TCP.TCPConn(str(ipAddressLookup).replace("\r\n", ""))
+            tcpDevice = tcpCon.sendCommand("*enclosure?") #Try use enclosure for PPMs
+            if "fail" in tcpDevice.lower(): # This will fail nicely for other modules
+                tcpDevice = tcpCon.sendCommand("*serial?") # and serial number will be used in place.
+            if not str(tcpDevice).startswith("QTL"):
+                tcpDevice = "QTL" + tcpDevice
+            # Exit as device was found correctly
+            # Add the item to list
+            lan_modules["TCP:" + str(ipAddressLookup).replace("\r\n", "")] = tcpDevice
+            specifiedDevice=None # Don't return tcp connection, to bypass tcp parsing.
+        except Exception as e:
+            logging.warning("Error During TCP 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
+
+
+
+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:
+            return v
+    return None
+
+
+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"]
+    module_string.replace("::", ":") #QIS/QPS format to QuarchPy format
+    delimeter_pos = module_string.find(":")
+    if delimeter_pos == -1:
+        con_type = None
+        serial_number = module_string.lower()
+    else:
+        con_type = module_string[:delimeter_pos]
+        serial_number = module_string[delimeter_pos + 1:].lower()
+    if serial_number.find("qtl") !=-1:
+        serial_number=serial_number.replace("qtl","")
+    if scan_dictionary is None:
+        logging.debug("Scanning for devices...")
+        scan_dictionary = scanDevices(favouriteOnly=False,filterStr=[serial_number])
+
+    ret_val="Fail Module Not Found"
+
+    if con_type is None:
+        connection_found = False
+        for con_type in connection_preference:
+            if connection_found is False:
+                for k, v in scan_dictionary.items():
+                    if k.__contains__(con_type):
+                        ret_val = k
+                        connection_found = True
+    else:
+        for k, v in scan_dictionary.items():
+            if k.lower().__contains__(con_type.lower()):
+                ret_val=k
+
+    if not include_conn_type and not ret_val.__contains__("Fail"):
+        delimeter_pos = ret_val.find(":")
+        ret_val = ret_val[delimeter_pos + 1:]
+
+    return ret_val
+
+
+'''
+Scans for Quarch modules across the given interface(s). Returns a dictionary of module addresses and serial numbers
+'''
+def filter_module_type(module_type_filter, found_devices):
+    """
+    Used in scandevices to filter modules by their type.
+    Uses config files.
+
+    :param module_type_filter: Acceptable values are 'Cable', 'Card', 'Drive', 'Power', 'Switch'
+    :param found_devices: List of found devices passed from scan_devices
+    :return: Returns all devices in found devices that are of 'module filter type'
+    """
+    accepted_qtl_numbers = return_module_type_list(module_type_filter)
+    accepted_qtl_numbers = [x.lower() for x in accepted_qtl_numbers]
+    filtered_devices = {}
+    if not accepted_qtl_numbers:
+        return {}
+    for key, value in found_devices.items():
+        if "qtl" in str(value).lower():
+            qtl_num = str(value[str(value.lower()).index("qtl"):str(value).index("-")]).lower()
+            if any(qtl_num in x for x in accepted_qtl_numbers):
+                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
+'''
+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)
+
+    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:
+                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")
+
+    if target_conn.lower() == "serial":
+        foundDevices = list_serial()
+
+    if target_conn.lower() == "usb":
+        foundDevices = list_USB()
+
+    if target_conn.lower() == "tcp" or target_conn.lower() == "rest" or target_conn.lower() == "telnet":
+        foundDevices = list_network(target_conn, ipAddressLookup=ipAddressLookup, lanTimeout=lanTimeout)
+
+    if (scanInArray):
+        for k, v in foundDevices.items(): # k=Connection target, v=serial number
+            if (k not in scannedArrays):
+                scannedArrays.append(k)
+                if (isThisAnArrayController(v)):
+                    try:
+                        myQuarchDevice = quarchDevice(k)
+                        myArrayControler = quarchArray(myQuarchDevice)
+                        scanDevices = myArrayControler.scanSubModules()
+                        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.")
+                        foundDevices[k] = "DEVICE IN USE"
+
+    if (favouriteOnly):
+
+        # Sort list in order of connection type preference. Can be changed by changing position in conPref list. This must be done so that it is in the correct format for picking the favourite connections.
+        index = 0
+        sortedFoundDevices = {}
+        conPref = ["USB", "TCP", "SERIAL", "REST", "TELNET"]
+        while len(sortedFoundDevices) != len(foundDevices):
+            for k, v in foundDevices.items():
+                if conPref[index] in k:
+                    sortedFoundDevices[k] = v
+            index += 1
+        foundDevices = sortedFoundDevices
+
+        # new dictionary only containing one favourite connection to each device.
+        favConFoundDevices = {}
+        index = 0
+        for k, v in sortedFoundDevices.items():
+            if (favConFoundDevices == {} or not v in favConFoundDevices.values()):
+                favConFoundDevices[k] = v
+        foundDevices = favConFoundDevices
+
+    # Sort by alphabetic order of key
+    sortedFoundDevices = {}
+    sortedFoundDevices = sorted(foundDevices.items(), key=operator.itemgetter(1))
+    foundDevices = dict(sortedFoundDevices)
+    if filterStr != None:
+        filteredDevices = {}
+        for k, v in foundDevices.items():
+            for j in filterStr:
+                if (j in v or "LOCKED MODULE" in v): #show locked modules too incase the module you are looking for is on the system but is locked
+                    filteredDevices[k] = v
+        foundDevices = filteredDevices
+
+    # used to filter module via type ( Power / Drive / ...)
+    if module_type_filter:
+        foundDevices = filter_module_type(module_type_filter, foundDevices)
+
+    return foundDevices
+
+
+'''
+Prints out a list of Quarch devices nicely onto the terminal, numbering each unit
+'''
+def listDevices(scanDictionary):
+    if not scanDictionary:
+        printText("No quarch devices found to display")
+    else:
+        x = 1
+        for k, v in scanDictionary.items():
+            printText('{0:>3}'.format(str(x)) + " - " + '{0:<18}'.format(
+                v) + "\t" + k)  # add padding to keep responses in line
+            x += 1
+
+
+'''
+Requests the user to select one of the devices in the given list
+'''
+def userSelectDevice(scanDictionary=None, scanFilterStr=None,favouriteOnly=True, message=None, title=None, nice=False, additionalOptions = None, target_conn="all"):
+    if User_interface.instance != None and User_interface.instance.selectedInterface == "testcenter":
+        nice = False
+    if message is None: message = "Please select a quarch device"
+    if title is None: title = "Select a Device"
+    ip_address = None
+    while (True):
+        # Scan first, if no list is supplied
+        if (scanDictionary is None):
+            printText("Scanning for devices...")
+            if ip_address == None:
+                scanDictionary = scanDevices(filterStr=scanFilterStr, favouriteOnly=favouriteOnly, target_conn=target_conn)
+            else:
+                scanDictionary = scanDevices(filterStr=scanFilterStr, favouriteOnly=favouriteOnly, target_conn=target_conn, ipAddressLookup=ip_address)
+
+        if len(scanDictionary)<1:
+            scanDictionary["***No Devices Found***"]="***No Devices Found***"
+
+
+        if nice: #Prepair the data for niceListSelection using displayTable().
+            if additionalOptions is None: additionalOptions = ["Specify IP Address","Rescan","Quit"]
+            tempList = []
+            tempEl = []
+            for k, v in scanDictionary.items():
+                tempEl = []
+                tempEl.append(v)
+                charPos = k.find(":")
+                tempEl.append(k)
+                tempList.append(tempEl)
+            adOp =[]
+            for option in additionalOptions:
+                adOp.append([option]*2) # Put option in all columns
+                #adOp.append([option,"-"])
+            userStr = listSelection(title, message, tempList, additionalOptions=adOp, indexReq=True, nice=nice, tableHeaders=["Selection", "Description"])
+            userStr = userStr[2] #With the data formatted in this way the ConnTarget will always be in userStr[2]
+
+        else: # Prepare data for old style selection or testCenter
+            devicesString = []
+            for k, v in scanDictionary.items():
+                charPos = k.find(":")
+                devicesString.append(k + '=' + v + ": " + k[:charPos])
+            devicesString = ','.join(devicesString)
+            if additionalOptions is None :
+                additionalOptions = "Specify IP Address=IP Scan,Rescan=Rescan,Quit=Quit"
+            userStr = listSelection(title=title,message=message,selectionList=devicesString, additionalOptions=additionalOptions)
+
+        # Process the user response
+        if (userStr.lower() in 'quit'):
+            return "quit"
+        elif (userStr.lower() in 'rescan'):
+            ip_address = None
+            scanDictionary = None
+            favouriteOnly = True
+        elif (userStr.lower() in 'all conn types'):
+            ip_address = None
+            scanDictionary = None
+            favouriteOnly = False
+        elif(userStr.lower() in 'specify ip address'):
+            ip_address = requestDialog("Please input IP Address of the module you would like to connect to: ")
+            scanDictionary = None
+            favouriteOnly = False
+        else:
+            # Return the address string of the selected module
+            return userStr
+

{quarchpy-2.1.24.dev3.dist-info → quarchpy-2.1.24.dev4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: quarchpy
-Version: 2.1.24.dev3
+Version: 2.1.24.dev4
 Summary: This packpage offers Python support for Quarch Technology modules.
 Author: Quarch Technology ltd
 Author-email: support@quarch.com

{quarchpy-2.1.24.dev3.dist-info → quarchpy-2.1.24.dev4.dist-info}/RECORD

@@ -2,7 +2,8 @@ quarchpy/LICENSE.rst,sha256=SmYK6o5Xs2xRaUwYT-HqNDRu9eygu6y9QwweXNttiRc,3690
 quarchpy/QuarchPy Function Listing.xlsx,sha256=NE68cZPn7b9P3wcnCsnQr3H6yBkt6D5S6dH6457X520,31245
 quarchpy/README.txt,sha256=-LbrJ5rCPGSxoBmvr9CxJVokQUDwZSjoHa43eN8bWck,980
 quarchpy/__init__.py,sha256=0aEaJ1Aduzm1g_1OvibCDm5j2PcZAh-OPdVWiXZwF_E,3090
-quarchpy/_version.py,sha256=LwRNPO0mit7fBI4ePuiG42FK_PW44fibu4bi3333LWA,27
+quarchpy/_version.py,sha256=7JXuR6Iu5TL3ORCOcm0I8fTXgxeTSfK1wjhRA_papEQ,27
+quarchpy/_version.py.bak,sha256=LwRNPO0mit7fBI4ePuiG42FK_PW44fibu4bi3333LWA,27
 quarchpy/connection.py,sha256=9lPIUP4LCWkFAedc8CWorDY-3ujdAA-cyeNkSBdIv9E,2226
 quarchpy/launchQPSJ21.bat,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 quarchpy/run.py,sha256=mRp9IGPs-wdGisKK1FG_9DciFx_V0LePH5mfkTPhsd4,9681
@@ -11,10 +12,10 @@ quarchpy/.idea/.name,sha256=Z0w79DYY3o5FZDJpHMs2Rb_ooPlznKnemSWw-jFRCXk,14
 quarchpy/.idea/misc.xml,sha256=njbmweQkO94aRIK_Z8dZDifybOXO9VrC_K3UDiYEiTE,189
 quarchpy/.idea/modules.xml,sha256=pIQEC9RvqPyHKJcSkJ4i1fHWx6zcC-D8tNGREb6Au1Y,649
 quarchpy/.idea/quarchpy.iml,sha256=YYqwuBAzDwOyZwSwAQ8jDY5X-cmbNp-VAITW-h1uLdQ,688
-quarchpy/.idea/workspace.xml,sha256=WX97vV-5Nfi5qYRDNytuxhxaYCPTEJmNtZ4nEDrn1M8,18098
+quarchpy/.idea/workspace.xml,sha256=GS0y52z-EHiEpNwssZ47qFW6zbQWFcH0X2h56wpO3X0,18734
 quarchpy/.idea/inspectionProfiles/profiles_settings.xml,sha256=YXLFmX7rPNGcnKK1uX1uKYPN0fpgskYNe7t0BV7cqkY,174
 quarchpy/__pycache__/__init__.cpython-311.pyc,sha256=hCNane24BOaTOLH7AuH65LSZYyBQqhMG_LRK5tVjq8g,5074
-quarchpy/__pycache__/_version.cpython-311.pyc,sha256=xwdjvq5dEkLncIXkXOitJ-Nel71slzb7YwTp4aKRW_I,228
+quarchpy/__pycache__/_version.cpython-311.pyc,sha256=HfUbx31bSFgB-wNMFpVZiMmA3VtV_MV6nlmjfe4DhhE,198
 quarchpy/__pycache__/connection.cpython-311.pyc,sha256=ho3AhQMhS0nSVxbVoYgFpfEKXD4NYmQ65K5hUbnlvAA,3677
 quarchpy/config_files/__init__.py,sha256=bP9FM5hjP0r7s8qmWqcsVjAfHM0B4XY7cz5sTpe2HDA,290
 quarchpy/config_files/quarch_config_parser.py,sha256=mjP-uO58hVlHm25ZAFjX9Zwhn8z0np4vveLNHtx8Bt4,28891
@@ -1249,13 +1250,14 @@ quarchpy/device/device.py,sha256=5H3lBjrwckYuew1x6JXsiXTqGTWg0fGBaYzdTD3fXRM,222
 quarchpy/device/quarchArray.py,sha256=_8z6P1wCtIs2kkkAzNRc1YrT-NmGRvzd3btqa-Yl3Hc,2816
 quarchpy/device/quarchPPM.py,sha256=DnqkdxDjyu533RL2ZL0ISpe2nSXTkm4O6jFqAnZZf6g,3271
 quarchpy/device/quarchQPS.py,sha256=D6v0l-MwoABP3Lz5l3bnLJMfIpghAZZ319j4m5RRKvw,18780
-quarchpy/device/scanDevices.py,sha256=2qq9vpaATCd9tH5P4ZIHsQ1prkR8DsW0TiDHVR244Aw,28878
+quarchpy/device/scanDevices.py,sha256=cXBnBb6_QIaIxS1qhWiMPkbYLqu34LB1v_q-c-fYROE,28871
+quarchpy/device/scanDevices.py.bak,sha256=2qq9vpaATCd9tH5P4ZIHsQ1prkR8DsW0TiDHVR244Aw,28878
 quarchpy/device/__pycache__/__init__.cpython-311.pyc,sha256=3RVGRWzAz2ikB9pqThm8OPiqpY1zsXx46t25s0eAyPY,830
 quarchpy/device/__pycache__/device.cpython-311.pyc,sha256=KoOysrTzD37BddEY6vBriQQx-YQQQD0M5RD_FI2SscQ,23708
 quarchpy/device/__pycache__/quarchArray.cpython-311.pyc,sha256=fXYuoZoVIVcq4tGEb-GXxTn79cJQ_IyfgLXlI20ZLgs,3877
 quarchpy/device/__pycache__/quarchPPM.cpython-311.pyc,sha256=NwuFww49zzwIkmFwy5sWK_FvMK7Lgwbw02L6a2aO46A,4866
 quarchpy/device/__pycache__/quarchQPS.cpython-311.pyc,sha256=oSBP_1HVZ6IFCYGvAbwDWSU2BvW6Emr1NKyKYtE9odw,23330
-quarchpy/device/__pycache__/scanDevices.cpython-311.pyc,sha256=kTTN1mhhhYh0IZCN8AlrYSPtlva7djbzr1KUhmioFRw,33002
+quarchpy/device/__pycache__/scanDevices.cpython-311.pyc,sha256=CMQ5x6AJNw_Df2fQUUiwm3XR6OByOGMA5qn_52yBuuQ,32970
 quarchpy/disk_test/AbsDiskFinder.py,sha256=QhtekaSSKubikGM7aqZ916u7Cc22FLEB7CqGiEvdByc,377
 quarchpy/disk_test/DiskTargetSelection.py,sha256=BY3zc7mg7FPxEp9OB2yRkyYIHRwrAB6U0XrsSWZrKU4,925
 quarchpy/disk_test/__init__.py,sha256=3-LXyQMX5macnPaHc8J3mcJQ7faTInycD8-skQYyFbE,59
@@ -1408,7 +1410,7 @@ quarchpy/utilities/__pycache__/TestCenter.cpython-311.pyc,sha256=80Rr4SEmFdyqNwX
 quarchpy/utilities/__pycache__/TimeValue.cpython-311.pyc,sha256=GWzrEu1fzX7JULgrzVuFl8aVNaMUKXURUY2yAwbhXRo,2668
 quarchpy/utilities/__pycache__/Version.cpython-311.pyc,sha256=C5tM-1GBjmxJS8nlY5AjCMdPxW-oX1NmlJAGi3RRSxQ,2697
 quarchpy/utilities/__pycache__/__init__.cpython-311.pyc,sha256=UVS7BpP9Dg3A0PT2JmHeY988_h_o9XZjaCoJjOnP398,212
-quarchpy-2.1.24.dev3.dist-info/METADATA,sha256=3u8CoY7XES69rgxYwrBX7KoB3h-5wIZyzeUwzrLYyZo,9777
-quarchpy-2.1.24.dev3.dist-info/WHEEL,sha256=a-zpFRIJzOq5QfuhBzbhiA1eHTzNCJn8OdRvhdNX0Rk,110
-quarchpy-2.1.24.dev3.dist-info/top_level.txt,sha256=Vc7qsvkVax7oeBaBy_e7kvJvqb_VAAJcW_MuDMmi5W8,9
-quarchpy-2.1.24.dev3.dist-info/RECORD,,
+quarchpy-2.1.24.dev4.dist-info/METADATA,sha256=1kmkdQwfHPHMm-HKFguSik1YPniQYSo-ttLtrATKZ4s,9777
+quarchpy-2.1.24.dev4.dist-info/WHEEL,sha256=a-zpFRIJzOq5QfuhBzbhiA1eHTzNCJn8OdRvhdNX0Rk,110
+quarchpy-2.1.24.dev4.dist-info/top_level.txt,sha256=Vc7qsvkVax7oeBaBy_e7kvJvqb_VAAJcW_MuDMmi5W8,9
+quarchpy-2.1.24.dev4.dist-info/RECORD,,