quarchpy 2.1.22__py2.py3-none-any.whl → 2.1.23__py2.py3-none-any.whl

quarchpy/connection_specific/connection_QIS.py

@@ -171,10 +171,6 @@ class QisInterface:
                 moduleStreaming= module.sendCommand("rec stream?").lower() #checking if module thinks its streaming.
                 moduleStreaming2= module.sendCommand("stream?").lower() #checking if the module has told qis it has stopped streaming.
 
-                #print("thread list = " + str(threadNameList))
-                #print("moduleStreaming rec stream? = " + str(moduleStreaming))
-                #print("moduleStreaming stream? = " + str(moduleStreaming2))
-
                 if (moduleName in threadNameList or "running" in moduleStreaming or "running" in moduleStreaming2):
                     time.sleep(0.1)
 
@@ -276,7 +272,6 @@ class QisInterface:
                     #now = time.time()
                     streamOverrun, removeChar, newStripes = self.streamGetStripesText(self.streamSock, module, numStripesPerRead)
                     newStripes = newStripes.replace(' ', separator)
-                    #print (time.time() - now)
                     if streamOverrun:
                         self.deviceDict[module][0:3] = [True, 'Stopped', 'Device buffer overrun']
                     # TODO: MD Why don't we return isEmpty in the tuple, instead of having this confusing test?
@@ -498,10 +493,7 @@ class QisInterface:
                     streamOverrun, removeChar, newStripes = self.streamGetStripesText(self.streamSock, module,
                                                                                       numStripesPerRead)
                     newStripes = newStripes.replace(' ',separator)
-                    # print(newStripes)
-                    # print(len(newStripes))
 
-                    # print (time.time() - now)
                     if streamOverrun:
                         self.deviceDict[module][0:3] = [True, 'Stopped', 'Device buffer overrun']
                     if (removeChar == -6 and len(newStripes) == 6):
@@ -1565,6 +1557,25 @@ class QisInterface:
             f.write("Saved: "+x+ "\n")
 
 
+    def sendCommand(self, cmd, device="", timeout=20,sock=None,readUntilCursor=True, betweenCommandDelay=0.0, expectedResponse=True):
+        '''Send command is used to send a command to QIS and as far as I can see it has no difference than sendAndReceiveCmd'''
+        if expectedResponse is True:
+            if sock == None:
+                sock = self.sock
+            if not (device == ''):
+                self.deviceDictSetup(device)
+            res = self.sendAndReceiveText(sock, cmd, device, readUntilCursor)
+            if (betweenCommandDelay > 0):
+                time.sleep(betweenCommandDelay)
+            # If ends with cursor get rid of it
+            if res[-1:] == '>':
+                res = res[:-3]  # remove last three chars - hopefully '\r\n>'
+            return res
+
+        else :
+            self.sendText(sock, cmd, device)
+            return
+
     # when sending commands to module (as opposed to back end)
     # If read until cursor is set to True (which is default) then keep reading response until a cursor is returned as the last character of result string
     # After command is sent wait for betweenCommandDelay which defaults to 0 but can be specified to add a delay between commands

quarchpy/connection_specific/connection_QPS.py

@@ -52,6 +52,31 @@ class QpsInterface:
         else:
             self.client.send( data )
 
+    def sendCommand(self, cmd, timeout=20, expectedResponse=True ):
+        cmd = cmd + "\r\n"
+        logging.debug("Sending cmd to QPS: " + str(cmd))
+        self.send(cmd)
+
+        start = time.time()
+        response = self.recv().strip()
+        while response.rfind('\r\n>') == -1:  # If true then the resposnse is large and multi packeted
+            time.sleep(0.1)
+            t_response = self.recv().strip()
+            # Add current response to new response
+            response += t_response
+            # Keep reading from the socket if there's stuff that was retreived
+            if len(str(t_response)) == 0:
+                if time.time() - start > timeout:
+                    logging.warning("Command : " + str(cmd) + " Hit timeout during QPS read. timeout = " + str(timeout))
+                    break
+
+        pos = response.rfind('\r\n>')
+        if pos == -1:
+            logging.warning("Did not retrieve trailing '\\r\\n>' from QPS read, returned full response so far")
+            logging.warning("command : " + cmd.replace('\r\n', '\\r\\n'))
+            logging.warning("returned : " + response.replace('\r\n', '\\r\\n'))
+            pos = len(str(response))
+        return response[:pos]
 
     def sendCmdVerbose(self, cmd, timeout=20):
         cmd = cmd + "\r\n"
@@ -83,7 +108,6 @@ class QpsInterface:
     def connect(self, targetDevice):
         cmd="$connect " + targetDevice
         retVal = self.sendCmdVerbose(cmd)
-        #print(cmd+" : "+retVal)
         time.sleep(0.3)
         return retVal
 

quarchpy/connection_specific/connection_ReST.py

@@ -15,9 +15,9 @@ class ReSTConn:
     def close(self):
         return True
 
-    def sendCommand(self, Command, expectedResponse = True, max_retries=1):
+    def sendCommand(self, Command, expectedResponse = True, max_retries=2):
         Command = "/" + Command.replace(" ", "%20")
-        for attempt in range(1, max_retries + 1):
+        for attempt in range(0, max_retries ):
             try:
                 self.Connection.request("GET", Command)
                 if expectedResponse == True:
@@ -37,6 +37,7 @@ class ReSTConn:
             except socket.timeout as e:
                 if attempt < max_retries:
                     logging.warning("Socket timed out, retrying command...")
+                    time.sleep(0.1)
                 else:
                     logging.error("Maximum number of retries reached on module at: "+self.ConnTarget+". Exiting.")
                     raise e

quarchpy/debug/upgrade_quarchpy.py

@@ -1,7 +1,7 @@
 """
 Functions to allow automatic update and checking of the quarchpy package.
 """
-from quarchpy import isQisRunning, closeQIS, isQpsRunning, closeQPS
+from quarchpy import isQisRunning, isQpsRunning, closeQps, closeQis
 import subprocess, sys
 from quarchpy.user_interface import *
 
@@ -89,11 +89,11 @@ def check_if_update(auto_update):
         if update_desired:
             if isQpsRunning() == True:
                  usr_input = requestDialog(title="", message="QPS must be closed to update. Close QPS Y/N?")
-                 if auto_update or usr_input == "Y" or usr_input == "y": closeQPS()
+                 if auto_update or usr_input == "Y" or usr_input == "y": closeQps()
                  else: return False
             if isQisRunning() == True:
                  usr_input = requestDialog(title="", message="QIS must be closed to update. Close QIS Y/N?")
-                 if auto_update or usr_input == "Y" or usr_input == "y": closeQIS()
+                 if auto_update or usr_input == "Y" or usr_input == "y": closeQis()
                  else: return False
         else:
             return False

quarchpy/device/device.py

@@ -214,7 +214,6 @@ class quarchDevice:
 
     # def setCanStream(self):
     # ask module name if = name in list
-    # TODO: expectedResponse does nothing can it be removed
     # TODO: The connectionObj should be an instance of a common base class such that the IF block here is not needed
     def sendCommand(self, CommandString, expectedResponse = True):
         """
@@ -245,33 +244,35 @@ class quarchDevice:
             if numb_colons == 1:
                 self.ConString = self.ConString.replace(':', '::')
 
-            response = self.connectionObj.qis.sendCmd(self.ConString, CommandString)
+            response = self.connectionObj.qis.sendCommand(CommandString, device=self.ConString, expectedResponse=expectedResponse)
             # send response to log
             logging.debug(os.path.basename(__file__) + ": "+self.ConType[:3]+" received: " + response)
             return response
 
         elif self.ConType == "PY":
-            response = self.connectionObj.connection.sendCommand(CommandString)
+            response = self.connectionObj.connection.sendCommand(CommandString, expectedResponse=expectedResponse)
             # send response to log
             logging.debug(os.path.basename(__file__) + ": "+self.ConType[:3]+" received: " + response)
             return response
 
         elif self.ConType[:3] == "QPS":
-            # checking if the command string passed has a $ as first char
+            # If "$" CMD is for QPS, else its for the specific module. Since QPS can talk to many modules we must added the conString.
             if CommandString[0] != '$':
                 CommandString = self.ConString + " " + CommandString
 
-            response = self.connectionObj.qps.sendCmdVerbose(CommandString)
+            response = self.connectionObj.qps.sendCommand(CommandString, expectedResponse)
             # send response to log
             logging.debug(os.path.basename(__file__) + ": "+self.ConType[:3]+" received: " + response)
             return response
 
+
     # Only works for usb
     # TODO: Can this be marked '_' for private use only
     def sendBinaryCommand(self, cmd):
         self.connectionObj.connection.Connection.SendCommand(cmd)
         return self.connectionObj.connection.Connection.BulkRead()
 
+
     # TODO: Not using class hierarchy based connectionObj, recreation of PYConnection may not release the previous handle in time.
     # QPS and QIS actions are different despite the underlying connection being the same!
     def openConnection(self):
@@ -297,6 +298,7 @@ class quarchDevice:
         else:
             raise Exception("Connection type not recognised")
 
+
     # TODO: Not using class hierarchy based connectionObj. QPS and QIS actions are different despite the underlying connection being the same!
     def closeConnection(self):
         """
@@ -317,7 +319,7 @@ class quarchDevice:
 
         return "OK"
 
-    
+
     # TODO: Not using class hierarchy based connectionObj.
     def resetDevice(self, timeout=10):
         """
@@ -427,6 +429,7 @@ class quarchDevice:
         else:
             return True
 
+
     def getRuntime(self, command="conf:runtimes?"):
         '''
 
@@ -468,6 +471,7 @@ def _check_ip_in_qis_list(ip_address, detailed_device_list):
     # If the ip address wasn't found, then return none
     return None
 
+
 # TODO: Can we make this an '_' internal function?
 def checkModuleFormat(ConString):
     ConnectionTypes = ["USB", "SERIAL", "TELNET", "REST", "TCP"]  # acceptable conTypes

quarchpy/device/quarchQPS.py

@@ -393,9 +393,6 @@ class quarchStream:
         else:
             dataPointTime = toQpsTimeStamp(dataPointTime)
 
-        # print ("printing command:  $log " + channelName + " " + groupName + " " + str(dataPointTime) + " " + str(dataValue))
-        # self.connectionObj.qps.sendCmdVerbose("$log " + channelName + " " + groupName + " " + str(dataPointTime) + " " + str(dataValue))
-
         self.connectionObj.qps.sendCmdVerbose(
             "$stream data add " + channelName + " " + groupName + " " + str(dataPointTime) + " " + str(
                 dataValue) + " " + timeFormat)

quarchpy/device/scanDevices.py

@@ -220,7 +220,6 @@ def list_network(target_conn="all", debugPring=False, lanTimeout=1, ipAddressLoo
                     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")
@@ -480,7 +479,6 @@ def scanDevices(target_conn="all", lanTimeout=1, scanInArray=True, favouriteOnly
         except Exception as e:
             logging.error(e)
             logging.warning("Network scan failed, check network connection")
-        # print(foundDevices)
 
     if target_conn.lower() == "serial":
         foundDevices = list_serial()

quarchpy/docs/CHANGES.rst

@@ -13,9 +13,15 @@ Quarchpy
 Change Log
 ----------
 
-2.1.21
+2.1.23
+------
+- QIS and QPS devices and interfaces can use sendCommand to send comannds to the modules and to the applications uniformly
+- Tidy up of print statments and comments.
+
+2.1.22
 ------
-- Bug fix QPS v1.39 QIS v1.42 reverting mDNS scanning change. 
+- QIS and QPS patch containing mDNS removal
+
 
 2.1.21
 ------
@@ -24,7 +30,7 @@ Change Log
 
 2.1.20
 ------
-- Improved direct IP scanning for quarch modules.
+- Improved direct IP scanning for quarch modules
 - New QPS v1.37 and QIS v1.40
 
 2.1.19
@@ -53,19 +59,19 @@ Change Log
 
 2.1.14
 ------
-- minor bug fixes and logging improvements.
+- minor bug fixes and logging improvements
 
 2.1.13
 ------
 - New QPS v1.36
 - New QIS v1.39
-- minor bug fixes and logging improvements.
+- minor bug fixes and logging improvements
 
 2.1.12
 ------
 - New QPS v1.35
 - New QIS v1.38
-- minor bug fixes and removal of depracated code.
+- minor bug fixes and removal of depracated code
 
 2.1.11
 ------
@@ -104,7 +110,7 @@ Change Log
 2.1.3
 -----
 - New QPS v1.22
-- modules on the network can now be connected to using conType:QTLNumber eg. TCP:QTL1999-02-001. 
+- modules on the network can now be connected to using conType:QTLNumber eg. TCP:QTL1999-02-001
 - fixed QIS not closing with QPS when launch with by QPS
 - closeConnection added to QIS api
 - display table formats multiline items and handles empty cells