mmcb-rs232-avt 1.0.20__py3-none-any.whl → 1.1.38__py3-none-any.whl

{mmcb_rs232 → mmcbrs232}/common.py

@@ -47,6 +47,25 @@ data structures:
     DEVICE_CACHE
     Packet
     UNIT
+
+General note on RS232 port locking:
+
+To make the existing code work with the expanded test setup, two types of
+per-port locks are employed here.
+
+(1) A piece of equipment connected to a single serial port may have more
+than one channel, and the data structures in this library represent
+equipment in terms of their individual channels. Exclusive multiprocessing
+locks are used to prevent concurrent access to the same RS232 port by
+different threads within a given script. This protection principally
+applies to iv.py when using a multi-channel power supply such as the
+Keithley 2614b.
+
+(2) In practical scenarios, it is possible for multiple monitoring scripts
+to be running on a machine that may require access to the same RS232 ports,
+e.g. a PID loop is running, and a user wishes to check PSU status with
+psustat.py. This is managed with a coarse exclusive file-lock based on
+fcntl system calls.
 """
 
 import argparse
@@ -75,7 +94,7 @@ import matplotlib.pyplot as plt
 import numpy as np
 import serial
 
-from mmcb_rs232 import lexicon
+from mmcbrs232 import lexicon
 
 
 ##############################################################################
@@ -83,6 +102,7 @@ from mmcb_rs232 import lexicon
 ##############################################################################
 
 
+RS232_LOCK_GLOBAL = os.path.expanduser('~/.mmcb_rs232_lock_global')
 DEVICE_CACHE = os.path.expanduser('~/.cache.json')
 
 
@@ -1330,7 +1350,7 @@ def check_file_exists(filename):
     returns : string
     --------------------------------------------------------------------------
     """
-    if not os.path.exists(filename):
+    if not os.path.isfile(filename):
         raise argparse.ArgumentTypeError(f'{filename}: file does not exist')
 
     return filename
@@ -1610,21 +1630,17 @@ def rs232_port_is_valid(com):
     if com.hwid == 'USB VID:PID=0403:6010 SER=210274552605B':
         return False
 
-    success = False
-    test_strings = ('FTDI', 'FT232R', 'FT232R')
-    test_variables = (com.manufacturer, com.product, com.description)
-
-    for tstr, tvar in zip(test_strings, test_variables):
-        try:
-            test = tstr in tvar
-        except TypeError:
-            pass
-        else:
-            success = success or test
-            if test:
-                break
+    # Define the attributes to check and the keywords to look for.
+    checks = [
+        (com.manufacturer, 'FTDI'),
+        (com.product, 'FT232R'),
+        (com.description, 'FT232R'),
+    ]
 
-    return success
+    return any(
+        attribute and keyword in attribute
+        for attribute, keyword in checks
+    )
 
 
 def atomic_send_command_read_response(pipeline, ser, dev, command):
@@ -1899,7 +1915,7 @@ def _channel_mismatch(cache, user):
     return cache != user
 
 
-def initial_power_supply_check(settings, pipeline, psus, channels, psuset=False):
+def initial_power_supply_check(settings, pipeline, psus, channels, psuset=False, clear=True):
     """
     Establishes RS232 communications with power supplies (as required).
     Checks status of channel outputs and interlocks (inhibits).
@@ -1919,6 +1935,7 @@ def initial_power_supply_check(settings, pipeline, psus, channels, psuset=False)
             power supply channel
         psuset : bool
             selects the error message depending on the caller
+        clear : bool
     --------------------------------------------------------------------------
     returns
         channels : list
@@ -1979,25 +1996,26 @@ def initial_power_supply_check(settings, pipeline, psus, channels, psuset=False)
 
             port_used[dev.port] += 1
 
-        if any(outstat):
-            message = 'all power supply outputs must be on to proceed'
-            log_with_colour(logging.ERROR, message)
-            channels.clear()
-
-        if any(intstat):
-            message = 'all power supply interlocks must be inactive to proceed'
-            log_with_colour(logging.ERROR, message)
-            channels.clear()
-
-        if any(polstat):
-            if psuset:
-                message = 'set voltage should agree with polarity switch to proceed'
+        if clear:
+            if any(outstat):
+                message = 'all power supply outputs must be on to proceed'
                 log_with_colour(logging.ERROR, message)
-            else:
-                message = 'all polarity switches must agree with --forwardbias to proceed'
+                channels.clear()
+
+            if any(intstat):
+                message = 'all power supply interlocks must be inactive to proceed'
                 log_with_colour(logging.ERROR, message)
+                channels.clear()
+
+            if any(polstat):
+                if psuset:
+                    message = 'set voltage should agree with polarity switch to proceed'
+                    log_with_colour(logging.ERROR, message)
+                else:
+                    message = 'all polarity switches must agree with --forwardbias to proceed'
+                    log_with_colour(logging.ERROR, message)
 
-            channels.clear()
+                channels.clear()
     else:
         message = '--debug: any connected power supplies will be ignored'
         log_with_colour(logging.WARNING, message)
@@ -2111,7 +2129,7 @@ def _report_interlock_status(ser, pipeline, dev):
     returns : none
     --------------------------------------------------------------------------
     """
-    assert dev.manufacturer not in {'agilent', 'hameg'},\
+    assert dev.manufacturer not in {'agilent', 'hameg'}, \
         'function not callable for Agilent or Hameg PSU'
 
     fail = False
@@ -2477,7 +2495,11 @@ def unique(settings, psus, channels):
     for channel in copy.deepcopy(channels):
         cache = (channel.manufacturer, channel.model, channel.serial_number,
                  channel.port, channel.channel)
-        if any(t(c, u) for c, u, t in zip(cache, user, test) if u is not None):
+        if any(
+            t(c, u)
+            for c, u, t in zip(cache, user, test)
+            if u is not None
+        ):
             channels.remove(channel)
 
     single = len(channels) == 1