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

{mmcb_rs232 → mmcbrs232}/psuset.py

@@ -11,6 +11,7 @@ the return value can be used by the shell, e.g.
 """
 
 import argparse
+import fcntl
 import logging
 import math
 import sys
@@ -21,9 +22,9 @@ import types
 import serial
 import numpy as np
 
-from mmcb_rs232 import common
-from mmcb_rs232 import lexicon
-from mmcb_rs232 import sequence
+from mmcbrs232 import common
+from mmcbrs232 import lexicon
+from mmcbrs232 import sequence
 
 
 ##############################################################################
@@ -70,7 +71,7 @@ def check_settlingtime(val):
     return val
 
 
-def check_arguments(settings):
+def check_arguments(settings, command=None):
     """
     handle command line options
 
@@ -78,6 +79,7 @@ def check_arguments(settings):
     args
         settings : dictionary
             contains core information about the test environment
+        command : str
     --------------------------------------------------------------------------
     returns : none
     --------------------------------------------------------------------------
@@ -201,7 +203,12 @@ def check_arguments(settings):
         action='store_true',
         help='Minimal text output during normal operation')
 
-    args = parser.parse_args()
+    if command is None:
+        args = parser.parse_args()
+    else:
+        args = parser.parse_args(
+            command.strip().partition(' ')[-1].split(' ')
+        )
 
     settings['verbose'] = args.verbose
     settings['quiet'] = args.quiet
@@ -364,7 +371,7 @@ def check_measured_voltage(settings, pipeline, ser, dev, set_voltage):
     return success
 
 
-def current_limit(settings, pipeline, ser, dev):
+def current_limit(settings, pipeline, ser, dev, slow=True):
     """
     Set and check current limit on Hameg HMP4040, Keithley 2614b and 2410.
 
@@ -387,6 +394,8 @@ def current_limit(settings, pipeline, ser, dev):
             reference for serial port
         dev : instance of class Channel
             contains details of a device and its serial port
+        slow : bool
+            enable checking of set values
     --------------------------------------------------------------------------
     returns : none
     --------------------------------------------------------------------------
@@ -405,6 +414,9 @@ def current_limit(settings, pipeline, ser, dev):
                                    compliance, channel=dev.channel)
     common.send_command(pipeline, ser, dev, command_string)
 
+    if not slow:
+        return
+
     # read back current limit from PSU
     command_string = lexicon.power(dev.model, 'get current limit', channel=dev.channel)
     response = common.atomic_send_command_read_response(pipeline, ser, dev, command_string)
@@ -456,7 +468,7 @@ def hmp4040_constant_current(ser, pipeline, dev):
     return retval
 
 
-def configure_lvpsu(settings, pipeline, ser, dev):
+def configure_lvpsu(settings, pipeline, ser, dev, slow=True):
     """
     Set the power supply voltage and read back the value to confirm it has
     been correctly set.
@@ -478,6 +490,8 @@ def configure_lvpsu(settings, pipeline, ser, dev):
             reference for serial port
         dev : instance of class Channel
             contains details of a device and its serial port
+        slow : bool
+            enable checking of set values
     --------------------------------------------------------------------------
     returns
         success : bool
@@ -500,7 +514,7 @@ def configure_lvpsu(settings, pipeline, ser, dev):
 
     # set and verify current limit
     if settings['current_limit'] is not None:
-        current_limit(settings, pipeline, ser, dev)
+        current_limit(settings, pipeline, ser, dev, slow)
 
     # change output on/off if requested, otherwise do not change it
     if settings['on'] is not None:
@@ -531,29 +545,34 @@ def configure_lvpsu(settings, pipeline, ser, dev):
     else:
         common.set_psu_voltage(settings, pipeline, voltage, ser, dev)
 
-    # Agilent E3647A seems to require a minimum of half a second to apply
-    # the setting before any further RS232 interaction is reliable
-    time.sleep(0.5)
+    if slow:
+        # Agilent E3647A seems to require a minimum of half a second to apply
+        # the setting before any further RS232 interaction is reliable
+        time.sleep(0.5)
 
-    # Arguably the voltage set for the channel should be read back too, so
-    # for the case where the channel output is off, some confirmation that
-    # the value has been set correctly can be given to the user.
-    #
-    # check measured voltage (can only be read back if output is on)
-    if not common.report_output_status(ser, pipeline, dev):
-        # allow a little time for the voltage to settle before reading
-        time.sleep(settings['settlingtime'])
+        # Arguably the voltage set for the channel should be read back too, so
+        # for the case where the channel output is off, some confirmation that
+        # the value has been set correctly can be given to the user.
+        #
+        # check measured voltage (can only be read back if output is on)
 
-        if dev.manufacturer == 'hameg' and hmp4040_constant_current(ser, pipeline, dev):
-            # When configured as a constant current source, the measured
-            # voltage will not match the set voltage
-            success = True
+        if not common.report_output_status(ser, pipeline, dev):
+            # allow a little time for the voltage to settle before reading
+            time.sleep(settings['settlingtime'])
+
+            if dev.manufacturer == 'hameg' and hmp4040_constant_current(ser, pipeline, dev):
+                # When configured as a constant current source, the measured
+                # voltage will not match the set voltage
+                success = True
+            else:
+                success = check_measured_voltage(settings, pipeline, ser, dev, voltage)
         else:
-            success = check_measured_voltage(settings, pipeline, ser, dev, voltage)
+            message = 'with PSU output switched off, set voltage cannot be read back'
+            common.log_with_colour(logging.WARNING, message)
+            common.log_with_colour(logging.WARNING, 'assuming all is well')
+            success = True
     else:
-        message = 'with PSU output switched off, set voltage cannot be read back'
-        common.log_with_colour(logging.WARNING, message)
-        common.log_with_colour(logging.WARNING, 'assuming all is well')
+        # user elected to skip checks, assume successful outcome
         success = True
 
     return success
@@ -889,46 +908,59 @@ def main():
 
     pipeline = Production()
 
-    ##########################################################################
-    # Check status of outputs and interlock (inhibit) on all power supplies
-    ##########################################################################
+    with open(common.RS232_LOCK_GLOBAL, 'a') as lock_file:
 
-    common.initial_power_supply_check(settings, pipeline, psus, channels, psuset=True)
+        # acquire the RS232 global lock
+        fcntl.flock(lock_file.fileno(), fcntl.LOCK_EX)
 
-    ##########################################################################
-    # display details of selected power supply
-    ##########################################################################
+        # --------------------------------------------------------------------
 
-    try:
-        channel = channels[0]
-    except IndexError:
-        pass
-    else:
-        text = f'selected power supply: {channel.manufacturer} {channel.model}'
-        if channel.serial_number:
-            text += f' s.no. {channel.serial_number}'
-        if channel.channel:
-            text += f' channel {channel.channel}'
-        if settings['port'] is not None:
-            text += f' port {channel.port}'
-        common.log_with_colour(logging.INFO, text, quiet=settings['quiet'])
-
-        ##########################################################################
-        # set values on given power supply channel
-        ##########################################################################
-
-        setpsu = {'lvpsu': configure_lvpsu, 'hvpsu': configure_hvpsu}
-
-        with serial.Serial(port=channel.port) as ser:
-            ser.apply_settings(channel.config)
-            ser.reset_input_buffer()
-            ser.reset_output_buffer()
-            success = setpsu[channel.category](settings, pipeline, ser, channel)
-            if success:
-                common.log_with_colour(
-                    logging.INFO, 'operation successful',
-                    quiet=settings['quiet']
-                )
+        ######################################################################
+        # Check status of outputs and interlock (inhibit) on all power
+        # supplies
+        ######################################################################
+
+        common.initial_power_supply_check(settings, pipeline, psus, channels, psuset=True)
+
+        ######################################################################
+        # display details of selected power supply
+        ######################################################################
+
+        try:
+            channel = channels[0]
+        except IndexError:
+            pass
+        else:
+            text = f'selected power supply: {channel.manufacturer} {channel.model}'
+            if channel.serial_number:
+                text += f' s.no. {channel.serial_number}'
+            if channel.channel:
+                text += f' channel {channel.channel}'
+            if settings['port'] is not None:
+                text += f' port {channel.port}'
+            common.log_with_colour(logging.INFO, text, quiet=settings['quiet'])
+
+            ##################################################################
+            # set values on given power supply channel
+            ##################################################################
+
+            setpsu = {'lvpsu': configure_lvpsu, 'hvpsu': configure_hvpsu}
+
+            with serial.Serial(port=channel.port) as ser:
+                ser.apply_settings(channel.config)
+                ser.reset_input_buffer()
+                ser.reset_output_buffer()
+                success = setpsu[channel.category](settings, pipeline, ser, channel)
+                if success:
+                    common.log_with_colour(
+                        logging.INFO, 'operation successful',
+                        quiet=settings['quiet']
+                    )
+
+        # --------------------------------------------------------------------
+
+        # release the RS232 global lock
+        fcntl.flock(lock_file.fileno(), fcntl.LOCK_UN)
 
     return status.success if success else status.unreserved_error_code
 

{mmcb_rs232 → mmcbrs232}/psustat.py

@@ -9,24 +9,30 @@ All power supplies supported by detect.py are usable by this script.
 import argparse
 import collections
 import contextlib
+import fcntl
+import json
+import serial
 import sys
 import time
 import threading
 
-from mmcb_rs232 import common
-from mmcb_rs232 import lexicon
+from mmcbrs232 import common
+from mmcbrs232 import lexicon
 
 
 ##############################################################################
 # command line option handler
 ##############################################################################
 
-def check_arguments(settings):
+def check_arguments(settings, command=None):
     """
     handle command line options
 
     --------------------------------------------------------------------------
-    args : none
+    args
+        settings : dictionary
+            contains core information about the test environment
+        command : str
     --------------------------------------------------------------------------
     returns : none
     --------------------------------------------------------------------------
@@ -65,6 +71,14 @@ def check_arguments(settings):
         not provide a serial number over RS232. A part of the serial may be\
         supplied if it is unique amongst connected devices.',
         default=None)
+    parser.add_argument(
+        '-z', '--zserv', action='store_true',
+        help=(
+            'ZeroMQ serial port server DEBUG option. '
+            'Enables experimental code path for certain HMP4040 read '
+            '(--sv and --mi) operations.'
+        ),
+    )
 
     group1 = parser.add_mutually_exclusive_group()
     group1.add_argument(
@@ -86,7 +100,12 @@ def check_arguments(settings):
         help='Read measured current. Only valid if the user has specified a PSU channel.',
     )
 
-    args = parser.parse_args()
+    if command is None:
+        args = parser.parse_args()
+    else:
+        args = parser.parse_args(
+            command.strip().partition(' ')[-1].split(' ')
+        )
 
     if args.serial:
         settings['serial'] = args.serial[0]
@@ -122,6 +141,7 @@ def check_arguments(settings):
     settings['mv'] = args.mv
     settings['si'] = args.si
     settings['mi'] = args.mi
+    settings['zserv'] = args.zserv
 
 
 ##############################################################################
@@ -285,7 +305,7 @@ def simple_interlock_status(ser, pipeline, dev, tcolours):
     returns : string
     --------------------------------------------------------------------------
     """
-    assert dev.manufacturer not in {'agilent', 'hameg'},\
+    assert dev.manufacturer not in {'agilent', 'hameg'}, \
         'function not callable for Agilent or Hameg PSU'
 
     status_categories = {
@@ -370,7 +390,121 @@ def simple_polarity_status(ser, pipeline, dev, tcolours):
     return status_categories[polarity_positive]
 
 
-def power_supply_channel_status(settings, pipeline, psus, channels, tcolours):
+###############################################################################
+# For ZeroMQ server use only
+###############################################################################
+
+
+def hmp4040_channel_cmp(id1, id2):
+    """
+    Compare channel names
+    """
+    id1 = f'{id1}'.lower()
+    id2 = f'{id2}'.lower()
+    lut = {
+        '1': ('1', 'a'),
+        'a': ('1', 'a'),
+        '2': ('2', 'b'),
+        'b': ('2', 'b'),
+        '3': ('3', 'c'),
+        'c': ('3', 'c'),
+        '4': ('4', 'd'),
+        'd': ('4', 'd'),
+    }
+    return id1 in lut[id2]
+
+
+def hmp4040_sv_fast(pipeline, channel):
+    """
+    Read measured current from an HMP4040 PSU.
+
+    This function must only be called from the ZeroMQ serial port server,
+    which will have already performed the necessary serial port checks and
+    configuration.
+
+    Simplified version of read_psu_set_voltage().
+
+    --------------------------------------------------------------------------
+    args
+        pipeline : instance of class Production
+            contains all the queues through which the production pipeline
+            processes communicate
+        channel : instance of class Channel
+            contains details of a device and its serial port
+    --------------------------------------------------------------------------
+    returns
+        set_volt : float or None
+    --------------------------------------------------------------------------
+    """
+    set_volt = None
+
+    with serial.Serial(port=channel.port) as ser:
+        ser.apply_settings(channel.config)
+        ser.reset_output_buffer()
+        ser.reset_input_buffer()
+
+        local_buffer = common.atomic_send_command_read_response(
+            pipeline, ser, channel,
+            lexicon.power(channel.model, 'read set voltage', channel=channel.channel)
+        )
+
+    with contextlib.suppress(ValueError):
+        set_volt = float(local_buffer)
+
+    return set_volt
+
+
+def hmp4040_mi_fast(pipeline, channel):
+    """
+    Read measured current from an HMP4040 PSU.
+
+    This function must only be called from the ZeroMQ serial port server,
+    which will have already performed the necessary serial port checks and
+    configuration.
+
+    --------------------------------------------------------------------------
+    args
+        pipeline : instance of class Production
+            contains all the queues through which the production pipeline
+            processes communicate
+        channel : instance of class Channel
+            contains details of a device and its serial port
+    --------------------------------------------------------------------------
+    returns
+        mcurr : float or None
+    --------------------------------------------------------------------------
+    """
+    with serial.Serial(port=channel.port) as ser:
+        ser.apply_settings(channel.config)
+        ser.reset_output_buffer()
+        ser.reset_input_buffer()
+
+        # ignore readings if output is off
+        output_status = common.atomic_send_command_read_response(
+            pipeline, ser, channel,
+            lexicon.power(channel.model, 'check output', channel=channel.channel)
+        )
+        if output_status == '0':
+            return None
+
+        measured_current = common.atomic_send_command_read_response(
+            pipeline, ser, channel,
+            lexicon.power(channel.model, 'read current', channel=channel.channel)
+        )
+
+    mcurr = None
+    try:
+        mcurr = float(measured_current)
+    except ValueError:
+        mcurr = None
+
+    return mcurr
+
+
+###############################################################################
+
+
+def power_supply_channel_status(settings, pipeline, psus, channels, tcolours, verbose=True):
     """
     Establishes RS232 communications with power supplies (as required).
     Checks status of channel outputs and interlocks (inhibits).
@@ -390,12 +524,36 @@ def power_supply_channel_status(settings, pipeline, psus, channels, tcolours):
             power supply channel
         tcolours : class
             contains ANSI colour escape sequences
+        verbose : bool
     --------------------------------------------------------------------------
     returns
         channels : list
             no explicit return, mutable type amended in place
     --------------------------------------------------------------------------
     """
+    # ------------------------------------------------------------------------
+    # shortcut for HMP4040 for ZeroMQ server (DEBUG)
+    #
+    # remember that the caller needs to set the model otherwise this will not
+    # work
+    # ------------------------------------------------------------------------
+
+    if settings['zserv'] and settings['model'] == 'hmp4040' and (settings['sv'] or settings['mi']):
+        # select PSU channel
+        channel = next(
+            c for c in channels
+            if hmp4040_channel_cmp(c.channel, settings['channel'])
+        )
+
+        if settings['sv']:
+            value = hmp4040_sv_fast(pipeline, channel)
+        elif settings['mi']:
+            value = hmp4040_mi_fast(pipeline, channel)
+
+        return value
+
+    # ------------------------------------------------------------------------
+
     port_used = collections.defaultdict(int)
 
     # this function call may change the value of variable channels
@@ -403,6 +561,8 @@ def power_supply_channel_status(settings, pipeline, psus, channels, tcolours):
     # which have been left open
     spd = common.check_ports_accessible(psus, channels, close_after_check=False)
 
+    results = {}
+
     for dev in channels:
         read_values = []
 
@@ -457,7 +617,9 @@ def power_supply_channel_status(settings, pipeline, psus, channels, tcolours):
 
         if settings['filter']:
             if settings['sv']:
-                print(set_volt)
+                if verbose:
+                    print(set_volt)
+                results['sv'] = set_volt
         else:
             print(f'output status: {out_stat}')
 
@@ -475,9 +637,10 @@ def power_supply_channel_status(settings, pipeline, psus, channels, tcolours):
         if current_limit is not None:
             if settings['filter']:
                 if settings['si']:
-                    print(
-                        simple_current_limit(ser, pipeline, dev, eng_format=False)
-                    )
+                    result = simple_current_limit(ser, pipeline, dev, eng_format=False)
+                    if verbose:
+                        print(result)
+                    results['si'] = result
             else:
                 print(f'current limit: {current_limit}')
 
@@ -494,9 +657,13 @@ def power_supply_channel_status(settings, pipeline, psus, channels, tcolours):
                     mvi_text = f'{common.si_prefix(mvolt)}V, {common.si_prefix(mcurr)}A'
                 else:
                     if settings['mi']:
-                        print(mcurr)
+                        if verbose:
+                            print(mcurr)
+                        results['mi'] = mcurr
                     elif settings['mv']:
-                        print(mvolt)
+                        if verbose:
+                            print(mvolt)
+                        results['mv'] = mvolt
 
             if not settings['filter']:
                 read_values.append(f'measured: {mvi_text}')
@@ -537,6 +704,8 @@ def power_supply_channel_status(settings, pipeline, psus, channels, tcolours):
     for serial_port in spd.values():
         serial_port.close()
 
+    return next(iter(results.values())) if len(results) == 1 else json.dumps(results)
+
 
 def read_psu_vi(pipeline, ser, dev):
     """
@@ -695,9 +864,21 @@ def main():
     # Check status of outputs and interlock (inhibit) on all power supplies
     ##########################################################################
 
-    power_supply_channel_status(
-        settings, pipeline, psus, channels, common.ANSIColours
-    )
+    with open(common.RS232_LOCK_GLOBAL, 'a') as lock_file:
+
+        # acquire the RS232 global lock
+        fcntl.flock(lock_file.fileno(), fcntl.LOCK_EX)
+
+        # --------------------------------------------------------------------
+
+        power_supply_channel_status(
+            settings, pipeline, psus, channels, common.ANSIColours
+        )
+
+        # --------------------------------------------------------------------
+
+        # release the RS232 global lock
+        fcntl.flock(lock_file.fileno(), fcntl.LOCK_UN)
 
 
 ##############################################################################

{mmcb_rs232 → mmcbrs232}/psuwatch.py

@@ -16,8 +16,8 @@ import time
 
 import serial
 
-from mmcb_rs232 import common
-from mmcb_rs232 import lexicon
+from mmcbrs232 import common
+from mmcbrs232 import lexicon
 
 
 ##############################################################################
@@ -156,6 +156,11 @@ def check_arguments(settings):
             specified with either scientific (10e-12) or engineering notation\
             (10p)',
         type=common.check_current, default=(None, None))
+    parser.add_argument(
+        '--block_rs232', required=True, action='store_true',
+        help='Use this option to acknowledge that running this monitoring\
+            script will block RS232 access for other scripts in this suite.',
+    )
 
     args = parser.parse_args()
 
@@ -350,9 +355,9 @@ def initial_power_supply_check(settings, pipeline, psus, channels, psuset=False)
             channels.clear()
     else:
         message = '--debug: any connected power supplies will be ignored'
-        log_with_colour(logging.WARNING, message)
+        common.log_with_colour(logging.WARNING, message)
         message = '--debug: IV data will generated internally'
-        log_with_colour(logging.WARNING, message)
+        common.log_with_colour(logging.WARNING, message)
 
 
 def report_output_status(ser, pipeline, dev):
@@ -398,7 +403,7 @@ def report_output_status(ser, pipeline, dev):
 
     if dev.manufacturer == 'iseg':
         if '=ON' not in output:
-            # log_with_colour(logging.WARNING, f'{dev.ident}, output off')
+            # common.log_with_colour(logging.WARNING, f'{dev.ident}, output off')
             fail = True
 
     elif dev.manufacturer in {'agilent', 'hameg', 'keithley'}:
@@ -406,17 +411,17 @@ def report_output_status(ser, pipeline, dev):
             outval = int(float(output))
         except ValueError:
             message = f'{dev.ident}, problem checking output'
-            log_with_colour(logging.ERROR, message)
+            common.log_with_colour(logging.ERROR, message)
             fail = True
         else:
             if outval in {0, 1}:
                 if outval == 0:
                     # message = f'{dev.ident}, output off'
-                    # log_with_colour(logging.WARNING, message)
+                    # common.log_with_colour(logging.WARNING, message)
                     fail = True
             else:
                 message = f'{dev.ident}, problem checking output'
-                log_with_colour(logging.ERROR, message)
+                common.log_with_colour(logging.ERROR, message)
                 fail = True
 
     return fail

{mmcb_rs232 → mmcbrs232}/sequence.py

@@ -14,7 +14,7 @@ import operator as op
 import os
 import sys
 
-from mmcb_rs232 import common
+from mmcbrs232 import common
 
 
 ##############################################################################
@@ -329,8 +329,7 @@ def _entire_sequence(maxval, maxstep, ranges):
         sys.exit()
 
     # deliver results
-    for voltage in seqc:
-        yield voltage
+    yield from seqc
 
 
 def _sequence_to_ranges(numseq):