quarchpy 2.1.11.dev8__py3-none-any.whl → 2.2.17.dev1__py3-none-any.whl

quarchpy/connection_specific/serial/urlhandler/protocol_loop.py

@@ -14,6 +14,7 @@
 # options:
 # - "debug" print diagnostic messages
 import logging
+logger = logging.getLogger(__name__)
 import numbers
 import time
 try:
@@ -108,7 +109,6 @@ class Serial(SerialBase):
             # process options now, directly altering self
             for option, values in urlparse.parse_qs(parts.query, True).items():
                 if option == 'logging':
-                    logging.basicConfig()   # XXX is that good to call it here?
                     self.logger = logging.getLogger('pySerial.loop')
                     self.logger.setLevel(LOGGER_LEVELS[values[0]])
                     self.logger.debug('enabled logging')

quarchpy/connection_specific/serial/urlhandler/protocol_socket.py

@@ -18,6 +18,7 @@
 
 import errno
 import logging
+logger = logging.getLogger(__name__)
 import select
 import socket
 import time
@@ -113,7 +114,6 @@ class Serial(SerialBase):
             # process options now, directly altering self
             for option, values in urlparse.parse_qs(parts.query, True).items():
                 if option == 'logging':
-                    logging.basicConfig()   # XXX is that good to call it here?
                     self.logger = logging.getLogger('pySerial.socket')
                     self.logger.setLevel(LOGGER_LEVELS[values[0]])
                     self.logger.debug('enabled logging')

quarchpy/connection_specific/serial/urlhandler/protocol_spy.py

@@ -279,8 +279,3 @@ class Serial(serial.Serial):
         self.formatter.control('CD', 'active' if level else 'inactive')
         return level
 
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-if __name__ == '__main__':
-    ser = Serial(None)
-    ser.port = 'spy:///dev/ttyS0'
-    print(ser)

quarchpy/connection_specific/usb_libs/usb1.py

@@ -757,7 +757,7 @@ class USBTransferHelper(object):
         they raise AttributeError).
         """
         if transfer is not None:
-            # Deprecated: to drop
+            # DEPRECATED - to drop
             self.__transfer = transfer
             transfer.setCallback(self)
         self.__event_callback_dict = {}
@@ -768,7 +768,7 @@ class USBTransferHelper(object):
         Submit the asynchronous read request.
         Deprecated. Use submit on transfer.
         """
-        # Deprecated: to drop
+        # DEPRECATED - to drop
         self.__transfer.submit()
 
     def cancel(self):
@@ -776,7 +776,7 @@ class USBTransferHelper(object):
         Cancel a pending read request.
         Deprecated. Use cancel on transfer.
         """
-        # Deprecated: to drop
+        # DEPRECATED - to drop
         self.__transfer.cancel()
 
     def setEventCallback(self, event, callback):
@@ -825,7 +825,7 @@ class USBTransferHelper(object):
         Returns whether this reader is currently waiting for an event.
         Deprecatd. Use isSubmitted on transfer.
         """
-        # Deprecated: to drop
+        # DEPRECATED - to drop
         return self.__transfer.isSubmitted()
 
 class USBPollerThread(threading.Thread):

quarchpy/debug/SystemTest.py

@@ -1,16 +1,29 @@
-from quarchpy import *
-from quarchpy.device import *
-import pkg_resources
-from pkg_resources import parse_version, get_distribution
 import os
 import platform
-import time
-import sys
 import subprocess
+from typing import List
+from typing_extensions import Literal
+
+from quarchpy import *
+
+try:
+    from importlib.metadata import distribution
+except:
+    try:
+        from importlib_metadata import distribution
+    except Exception as e:
+        print("Failed to import distribution from importlib_metadata")
+
+from quarchpy.device import *
+from quarchpy.connection_specific.jdk_jres.fix_permissions import find_java_permissions
+from quarchpy.qis.qisFuncs import isQisRunning, startLocalQis
+from quarchpy.connection_specific.connection_QIS import QisInterface
 from quarchpy._version import __version__
-# TODO: Move this code to a seperate system_test function so it can be called from other places.  Only argument handling should be done in main
 
-def test_communication():
+# Define the allowed values
+AppType = Literal["QuarchPy", "QPS", "QIS"]
+
+def _test_communication():
     print("")
     print("DEVICE COMMUNICATION TEST")
     print("-------------------------")
@@ -24,36 +37,72 @@ def test_communication():
         return 0
     print("Selected module is: " + moduleStr)
     # Create a device using the module connection string
-    myDevice = getQuarchDevice(moduleStr)
+    myDevice = get_quarch_device(moduleStr)
     QuarchSimpleIdentify(myDevice)
     # Close the module before exiting the script
-    myDevice.closeConnection()
+    myDevice.close_connection()
 
-def test_system_info():
+
+def _test_system_info():
     print("")
     print("SYSTEM INFORMATION")
     print("------------------")
     print("OS Name: " + os.name)
     print("Platform System: " + platform.system())
     print("Platform: " + platform.platform())
-    if "nt" in os.name: print("Platform Architecture: " + platform.architecture()[0])
+
+    if "nt" in os.name:
+        print("Platform Architecture: " + platform.architecture()[0])
+    else:
+        print(str(bytes(subprocess.check_output(['cat', '/etc/os-release'], stderr=subprocess.STDOUT)).decode()))
     print("Platform Release:  " + platform.release())
+
+    print("\nPYTHON\n------")
+    try:
+        print("Python Version: " + sys.version)
+    except:
+        print("Unable to detect Python version")
     try:
         print("Quarchpy Version: " + get_quarchpy_version())
     except:
         print("Unable to detect Quarchpy version")
     try:
-        print("Quarchpy Location: " + pkg_resources.get_distribution("quarchpy").location)
-    except:
+        print("Quarchpy info Location: " + str(distribution("quarchpy")._path))
+    except Exception as e:
+        print(e)
         print("Unable to detect Quarchpy location")
+
+    print("python:  ")
     try:
-        print("Python Version: " + sys.version)
-    except:
-        print("Unable to detect Python version")
-    try:
-        print("QIS version number: " + get_QIS_version())
+        temp1 = bytes(subprocess.check_output(['python', '-m', 'pip', 'show', 'quarchpy'], stderr=subprocess.STDOUT)).decode()
+        print(temp1)
     except:
-        print("Unable to detect QIS version")
+        print("Unable to detect Quarchpy at this location")
+
+    if "nt" not in os.name:
+        print("sudo python:  ")
+        try:
+            temp2 = bytes(subprocess.check_output(['sudo', 'python', '-m', 'pip', 'show', 'quarchpy'], stderr=subprocess.STDOUT)).decode()
+            print(temp2)
+        except:
+            print("Unable to detect Quarchpy at this location")
+
+        print("python3:  ")
+        try:
+            temp3 = bytes(subprocess.check_output(['python3', '-m', 'pip', 'show', 'quarchpy'], stderr=subprocess.STDOUT)).decode()
+            print(temp3)
+        except:
+            print("Unable to detect Quarchpy at this location")
+
+        print("sudo python3:  ")
+        try:
+            temp4 = bytes(subprocess.check_output(['sudo', 'python3', '-m', 'pip', 'show', 'quarchpy'], stderr=subprocess.STDOUT)).decode()
+            print(temp4)
+        except:
+            print("Unable to detect Quarchpy at this location")
+
+
+    print("\nJAVA\n----")
     try:
         javaVersion = bytes(subprocess.check_output(['java', '-version'], stderr=subprocess.STDOUT)).decode()
         print("Java Version: " + str(javaVersion))
@@ -66,9 +115,28 @@ def test_system_info():
     except:
         print("Unable to detect java location"
               "If Java is not installed then QIS and QPS will NOT run")
+    try:
+        execute_permissions, message=find_java_permissions()
+        print("Execute Permissions: ",execute_permissions, "\n",message)
+    except:
+        print("Unable to get j21 java permissions")
+    try:
+        print("\nQIS version number: " + get_QIS_version())
+    except Exception as e:
+        print("\nUnable to detect QIS version. Exception:" +str(e))
+    try:
+        qis_log_dir = _get_logging_directory(app_type="QIS")
+        print("QIS Log Directory: " + qis_log_dir)
+    except:
+        print("Unable to detect QIS log directory")
+    try:
+        qps_log_dir = _get_logging_directory(app_type="QPS")
+        print("QPS Log Directory: " + qps_log_dir)
+    except:
+        print("Unable to detect QPS log directory")
 
-    # Scan for all quarch devices on the system
 
+# Scan for all quarch devices on the system
 def QuarchSimpleIdentify(device1):
     """
     Prints basic identification test data on the specified module, compatible with all Quarch devices
@@ -77,18 +145,25 @@ def QuarchSimpleIdentify(device1):
     ----------
     device1: quarchDevice
         Open connection to a quarch device
-        
+
     """
     # Print the module name
     print("MODULE IDENTIFY TEST")
     print("--------------------")
     print("")
     print("Module Name: "),
-    print(device1.sendCommand("hello?"))
+    print(device1.send_command("hello?"))
     print("")
     # Print the module identify and version information
     print("Module Identity Information: ")
-    print(device1.sendCommand("*idn?"))
+    idn_info = device1.send_command("*idn?")
+    print(idn_info)
+    if "fixture" in idn_info.lower():
+        print("\nFixture Identity Information: ")
+
+        fixture_info = device1.send_command("fix idn?")
+        print(fixture_info)
+
 
 def get_QIS_version():
     """
@@ -99,16 +174,20 @@ def get_QIS_version():
     -------
     version: str
         String representation of the QIS version number
-        
     """
 
-    qis_version = ""
-    my_close_qis = False
-    if isQisRunning() == False:
+    qis_version = "" # stub
+    my_close_qis = False # Only close QIS if we opened it.
+    try:
+        qisRunning=isQisRunning()
+    except Exception as e:
+        print("Exception occurred while checking if qis was already running. Error:\n"+str(e))
+
+    if qisRunning == False:
         my_close_qis = True
         startLocalQis(headless=True)
-        
-    myQis = qisInterface()
+
+    myQis = QisInterface()
     qis_version = myQis.sendAndReceiveCmd(cmd="$version")
     if "No Target Device Specified" in qis_version:
         qis_version = myQis.sendAndReceiveCmd(cmd="$help").split("\r\n")[0]
@@ -116,6 +195,7 @@ def get_QIS_version():
         myQis.sendAndReceiveCmd(cmd = "$shutdown")
     return qis_version
 
+
 def get_java_location():
     """
     Returns the location of java.
@@ -133,14 +213,31 @@ def get_java_location():
         location = "Unable to detect OS to check java version."
     return location
 
+
 def get_quarchpy_version():
     try:
        return __version__
     except:
         return "Unknown"
 
+def _get_logging_directory(app_type: AppType = "QuarchPy") -> str:
+    """
+    Returns the default logging directory for quarchpy/qps/qis logs.
+
+    Returns
+    -------
+    log_dir: str
+        String representation of the logging directory.
+    """
+    if "windows" in platform.platform().lower():
+        log_dir = os.path.join(os.getenv('APPDATA'), 'Local', 'Quarch', f'{app_type}', 'Logs')
+    else:
+        log_dir = os.path.join(os.path.expanduser('~'), '.quarch', f'{app_type}', 'Logs')
+
+    return log_dir
+
 def fix_usb():
-    content_to_write = "SUBSYSTEM==\"usb\", ATTRS{idVendor}==\"16d0\", MODE=\"0666\"" \
+    content_to_write = "SUBSYSTEM==\"usb\", ATTRS{idVendor}==\"16d0\", MODE=\"0666\"\n" \
                        "SUBSYSTEM==\"usb_device\", ATTRS{idVendor}==\"16d0\", MODE=\"0666\""
 
     if "centos" in str(platform.platform()).lower():
@@ -158,33 +255,47 @@ def fix_usb():
 
     print("USB rule added to file : /etc/udev/rules.d/20-quarchmodules.rules")
 
+def _check_fw():
+    print("")
+    print("FIRMWARE CHECK")
+    print("--------------")
+    print("")
+    discovered_devices: List[DiscoveredDevice] = []
+    scanDevices(discovered_devices=discovered_devices)
+    for module in discovered_devices:
+        module.is_update_available()
 
-def main (args=None):
+def main(args=None):
     """
     Main function to allow the system test to be called direct from the command line
     """
     bool_test_system_info = True
     bool_test_communication = True
-    bool_fixusb=False
+    bool_fix_usb = False
+    bool_check_fw = False
     if args is not None and len(args)>0:
         for arg in args:
             if "--fixusb" in str(arg).lower():
-                bool_fixusb=True
-                # todo: Should we still be running the debug info stuff after this?
+                bool_fix_usb = True
             if "--skipsysteminfo" in str(arg).lower():
-                bool_test_system_info=False
+                bool_test_system_info = False
             if "--skipcommstest" in str(arg).lower():
-                bool_test_communication=False
+                bool_test_communication = False
+            if "--checkfw" in str(arg).lower():
+                bool_check_fw = True
 
-    if bool_fixusb:
+    if bool_fix_usb:
         fix_usb()
     if bool_test_system_info:
-        test_system_info()
+        _test_system_info()
     if bool_test_communication:
-        test_communication()
+        _test_communication()
+    if bool_check_fw:
+        _check_fw()
 
 
 if __name__ == "__main__":
     main([])
+    #find_java_permissions()
     #main(["--skipSystemInfo","--skipCommsTest"])
-    #main(["--fixusb"])
+    #main(["--fixusb"])

quarchpy/debug/module_debug.py

@@ -18,6 +18,7 @@ Connect any Quarch breaker/hot-plug module and run the script
 ####################################
 '''
 import logging
+logger = logging.getLogger(__name__)
 
 from quarchpy.config_files import *
 from quarchpy.device import *
@@ -65,7 +66,7 @@ def main(filepath=None):
 
     # Create a device using the module connection string
     logText("\n\nConnecting to the selected device")
-    my_device = getQuarchDevice(moduleStr)
+    my_device = get_quarch_device(moduleStr)
 
     file = None
     try:
@@ -73,16 +74,16 @@ def main(filepath=None):
         # We're passing the module connection here, the idn_string can be supplied instead if the module is not currently attached (simulation/demo mode)
         file = get_config_path_for_module(module_connection=my_device)
     except FileNotFoundError as err:
-        logging.error(f"Config file not found for module : {moduleStr}\nExiting Script")
-        my_device.closeConnection()
+        logger.error(f"Config file not found for module : {moduleStr}\nExiting Script")
+        my_device.close_connection()
         return
 
     # Parse the file to get the device capabilities
     dev_caps = parse_config_file(file)
 
     if not dev_caps:
-        logging.error(f"Could not parse config file for {moduleStr}\nExiting Script")
-        my_device.closeConnection()
+        logger.error(f"Could not parse config file for {moduleStr}\nExiting Script")
+        my_device.close_connection()
         return
     logText("\nCONFIG FILE LOCATED:")
     logText(file)
@@ -93,34 +94,34 @@ def main(filepath=None):
 
     # Print the module identify and version information
     logText("\nModule Identity Information:\n")
-    logText(my_device.sendCommand("*IDN?"))
+    logText(my_device.send_command("*IDN?"))
     logText("\n")
 
     # Print the test state of the module
     logText("\nModule Self Test:")
-    logText(my_device.sendCommand("*TST?"))
+    logText(my_device.send_command("*TST?"))
     logText("\n")
 
     # Print the power state of the module
     logText("Power State of Module:")
-    logText(my_device.sendCommand("RUN:POWER?"))
+    logText(my_device.send_command("RUN:POWER?"))
     logText("\n")
 
     for key, value in dev_caps.get_general_capabilities().items():
         if key == "GlitchState_Read_Present" and value == "true":
             # Print glitch status of the module
             logText("Glitch Status:")
-            logText(my_device.sendCommand("run:glitch?"))
+            logText(my_device.send_command("run:glitch?"))
             logText("\n")
 
             # Print additional glitch information
             logText("\nGlitch Engine\n===================\n")
             logText("Glitch Length: ", "end")
-            logText(my_device.sendCommand("glitch:length?"))
+            logText(my_device.send_command("glitch:length?"))
             logText("\nGlitch Cycle Length: ", "end")
-            logText(my_device.sendCommand("glitch:cycle:length?"))
+            logText(my_device.send_command("glitch:cycle:length?"))
             logText("\nPRBS Ratio: ", "end")
-            logText(my_device.sendCommand("glitch:prbs?"))
+            logText(my_device.send_command("glitch:prbs?"))
             logText("\n")
         if key == "SignalMonitor_Present" and value == "true":
             logText("\nSignal Monitoring\n===================\n")
@@ -128,9 +129,9 @@ def main(filepath=None):
                 for key, value in sig.parameters.items():
                     if key == "SignalMonitor_Present" and value == "true":
                         logText(sig.name, "end")
-                        logText(", Host Monitor: " + my_device.sendCommand("sig:{}:stat:host?".format(sig.name)), "end")
-                        logText(", Device Monitor: " + my_device.sendCommand("sig:{}:stat:dev?".format(sig.name)), "end")
-                    logText("\n")
+                        logText(", Host Monitor: " + my_device.send_command("sig:{}:stat:host?".format(sig.name)), "end")
+                        logText(", Device Monitor: " + my_device.send_command("sig:{}:stat:dev?".format(sig.name)), "end")
+                        logText("\n")
 
     # Print the list of signals on the module, and the capability flags for each signal
     # This can be used to iterate a test over every signal in a module
@@ -138,21 +139,21 @@ def main(filepath=None):
     for sig in dev_caps.get_signals():
         logText(sig.name, "end")
         for key, value in sig.parameters.items():
-            logText(", Source:" + my_device.sendCommand("sig:{}:sour?".format(sig.name)), "end")
+            logText(", Source:" + my_device.send_command("sig:{}:sour?".format(sig.name)), "end")
             if key == "GlitchEnable_Present" and value == "true":
-                logText(", Glitch Enable: " + my_device.sendCommand("sig:{}:glit:ena?".format(sig.name)), "end")
+                logText(", Glitch Enable: " + my_device.send_command("sig:{}:glit:ena?".format(sig.name)), "end")
             if key == "SignalDrive_Present" and value == "true":
-                logText(", Drive Open:" + my_device.sendCommand("sig:{}:dri:ope?".format(sig.name)), "end")
-                logText(", Drive Closed:" + my_device.sendCommand("sig:{}:dri:clo?".format(sig.name)), "end")
+                logText(", Drive Open:" + my_device.send_command("sig:{}:dri:ope?".format(sig.name)), "end")
+                logText(", Drive Closed:" + my_device.send_command("sig:{}:dri:clo?".format(sig.name)), "end")
         logText("\n")
     logText("\n")
 
     logText("\nVoltage Measurements\n===================\n")
     for volt in dev_caps.get_voltage_measurements():
         if volt.type == "Voltage":
-            logText(volt.name + ": " + my_device.sendCommand("meas:volt {}".format(volt.name + "?")), "end")
+            logText(volt.name + ": " + my_device.send_command("meas:volt {}".format(volt.name + "?")), "end")
         else:
-            logText(volt.name + " Self Test: " + my_device.sendCommand("meas:volt:self {}".format(volt.name + "?")), "end")
+            logText(volt.name + " Self Test: " + my_device.send_command("meas:volt:self {}".format(volt.name + "?")), "end")
         logText("\n")
     logText("\n")
 
@@ -161,21 +162,21 @@ def main(filepath=None):
         logText(source.name, "end")
         for key, value in source.parameters.items():
             sourcename = source.name[7:]
-            if key == "Type" and value == "Timed":
-                logText(", Delay: " + my_device.sendCommand("sour:" + sourcename + ":delay?"), "end")
+            if key == "Type" and value == "TIMED":
+                logText(", Delay: " + my_device.send_command("sour:" + sourcename + ":delay?"), "end")
             if key == "SourceEnable_Present" and value == "true":
-                logText(", Source: " + my_device.sendCommand("sour:" + sourcename + ":state?"), "end")
+                logText(", Source: " + my_device.send_command("sour:" + sourcename + ":state?"), "end")
             if key == "SourceBounce_Present" and value == "true":
-                logText(", Bounce: " + my_device.sendCommand("sour:" + sourcename + ":boun:mode?"), "end")
-                logText(", Bounce-Length: " + my_device.sendCommand("sour:" + sourcename + ":boun:len?"), "end")
-                logText(", Bounce-Period: " + my_device.sendCommand("sour:" + sourcename + ":boun:per?"), "end")
-                logText(", Bounce-Duty: " + my_device.sendCommand("sour:" + sourcename + ":boun:duty?"), "end")
+                logText(", Bounce: " + my_device.send_command("sour:" + sourcename + ":boun:mode?"), "end")
+                logText(", Bounce-Length: " + my_device.send_command("sour:" + sourcename + ":boun:len?"), "end")
+                logText(", Bounce-Period: " + my_device.send_command("sour:" + sourcename + ":boun:per?"), "end")
+                logText(", Bounce-Duty: " + my_device.send_command("sour:" + sourcename + ":boun:duty?"), "end")
         logText("\n")
 
     logText("Finished script. \nClosing module connection.")
     if fp != "":
         f.close()
-    my_device.closeConnection()
+    my_device.close_connection()
 
 """
     Logs text to terminal and file (if specified)

quarchpy/debug/simple_terminal.py

@@ -4,45 +4,54 @@ Feel free to expand and add your own features to this.
 
 ########### VERSION HISTORY ###########
 
-26/11/2020 - Stuart Boon     - First Version
+26/11/2020 - Stuart Boon  - First Version
 
 ########### INSTRUCTIONS ###########
 Select the module you would like to talk to.
 Type desired command
 Read response
 """
+from typing import Optional
+
 from quarchpy import *
 from quarchpy.device import *
-from quarchpy.user_interface import*
+from quarchpy.user_interface import *
 from quarchpy._version import __version__ as quarchpyVersion
+from typing import Union
+
+
 def main():
-    print(quarchpyVersion)
-    moduleStr = userSelectDevice(nice=True, additionalOptions=["rescan","all conn types", "quit"])
-    #moduleStr = "TCP:1999-05-005"
-    if moduleStr == "quit":
-        return 0
-    print("Selected module is: " + moduleStr)
-    # Create a device using the module connection string
-    #moduleStr = "REST:1995-05-005"
-    myDevice = getQuarchDevice(moduleStr)
-
-    while True:
-        user_input = requestDialog("","Send command to " + str(moduleStr) + " :")
-        #Dollar commands are to be handled by the terminal
-        if user_input.startswith("$"):
-            if "$shutdown" in user_input.lower().replace(" ",""):
-                print("Have a nice day!")
-                break
-            elif "$close connection" in user_input.lower():
-                myDevice.closeConnection()
-                return 0
-            pass
-        #All other commands are passed to the module
-        else:
-            print(myDevice.sendCommand(user_input))
+    printText("Quarchpy v" + str(quarchpyVersion))
+    myDevice: Union[quarchDevice, subDevice, str] = ""
+    while myDevice != "shutdown":  #Main loop
+        moduleStr = userSelectDevice(nice=True, additionalOptions=["Rescan", "All Conn Types", "Specify IP Address", "Quit"])
+        #moduleStr = "TCP:1999-05-005"
+        if moduleStr == "quit":
+            return 0
+        printText("Selected module is: " + moduleStr)
+        # Create a device using the module connection string
+        # moduleStr = "REST:1995-05-005"
+        myDevice = get_quarch_device(moduleStr)
+
+        while myDevice is not None and myDevice != "shutdown":  # CMD parsing loop
+            user_input = requestDialog("", "Send command to " + str(moduleStr) + " :")
+            # Dollar commands are to be handled by the terminal
+            if user_input.startswith("$"):
+                if "$shutdown" == user_input.lower().replace(" ", "").strip():
+                    printText("Have a nice day!")
+                    myDevice = "shutdown"
+                elif "$close connection" == user_input.lower().strip():
+                    myDevice.close_connection()
+                    myDevice = ""
+                elif "$rst module" == user_input.lower().strip():
+                    printText("Reset successful :" + str(myDevice.reset_device()))
+                pass
 
+            #All other commands are passed to the module
+            else:
+                printText(myDevice.send_command(user_input))
+    return None
 
 
 if __name__ == "__main__":
-    while True:
-        main()
+    main()