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

{mmcb_rs232 → mmcbrs232}/ult80.py

@@ -10,8 +10,11 @@ If this turns out not to be the case, we can read the list of available FTDI
 serial port devices, then exclude any serial ports found in cache.json, then
 leave the user to choose which of the remaining serial ports to use.
 
-Refer to the following for RS232 command sequences:
-https://www.atecorp.com/atecorp/media/pdfs/data-sheets/neslab-ult-80-95_manual.pdf
+Refer to the following for RS232 command sequences (pp.25-28):
+https://www.atecorp.com/getmedia/038930d4-42ed-4f12-bfda-a37e08d48bac/
+        neslab-ult-80-95_manual_1.pdf
+https://gitlab.ph.liv.ac.uk/avt/atlas-itk-pmmcb/-/blob/main/reference/
+        thermoneslab/neslab-ult-80-95_manual.pdf
 
 Also see 'setup loop' starting on page 10 to enable RS232.
 
@@ -62,24 +65,27 @@ Stor (store changes)
 """
 
 import argparse
-import sys
+import fcntl
+import threading
+import weakref
 
 import serial
-import serial.tools.list_ports as stlp
 
-from mmcb_rs232 import common
+from mmcbrs232 import common
 
 
 ##############################################################################
 # command line option handler
 ##############################################################################
 
-def check_arguments():
+
+def check_arguments(command=None):
     """
     Handle command line options.
 
     --------------------------------------------------------------------------
-    args : none
+    args
+        command : str
     --------------------------------------------------------------------------
     returns : class argparse.ArgumentParser
     --------------------------------------------------------------------------
@@ -102,50 +108,47 @@ def check_arguments():
         help='Set Setpoint (control point).',
         default=None)
 
-    return parser.parse_args()
+    parser.add_argument(
+        '-q', '--quiet',
+        action='store_true',
+        help='Only output the requested raw value, and no other text.')
+
+    if command is None:
+        args = parser.parse_args()
+    else:
+        args = parser.parse_args(
+            command.strip().partition(' ')[-1].split(' ')
+        )
+
+
+    return args
 
 
 ##############################################################################
-# detect ult80 serial port and basic operation
+# data structures
 ##############################################################################
 
-def find_ult80(port, config):
-    """
-    Return serial port configuration if the serial port was successfully
-    opened.
 
-    --------------------------------------------------------------------------
-    args
-        port : string
-            port name
-        config : dict
-            serial port configuration
-    --------------------------------------------------------------------------
-    returns
-        retval :
-            settings : dict (if port could be opened) or None otherwise
-                Note that the dictionary does not contain the serial port
-                identifier.
-    --------------------------------------------------------------------------
+class Production:
+    """
+    Locks to support threaded operation in the underlying library code (1 lock
+    per serial port).
     """
-    ser = serial.Serial()
-    ser.apply_settings(config)
-    ser.port = port
-
-    try:
-        ser.open()
-    except (OSError, serial.SerialException):
-        sys.exit(f'could not open port {port}, exiting.')
-    else:
-        settings = ser.get_settings()
-        ser.close()
-
-    return settings
 
+    def __init__(self, instrument_channels):
+        """
+        -----------------------------------------------------------------------
+        args
+            instrument_channels : list of <class 'mmcbrs232.common.Channel'>
+        -----------------------------------------------------------------------
+        returns : none
+        -----------------------------------------------------------------------
+        """
+        self.portaccess = {
+            port: threading.Lock()
+            for port in {channel.port for channel in instrument_channels}
+        }
 
-##############################################################################
-# data structures
-##############################################################################
 
 class Ult80:
     """
@@ -155,8 +158,62 @@ class Ult80:
     _address = 0x0001
     _nbits = 16
 
-    def __init__(self, ser):
-        self.ser = ser
+    _cached_chillers = common.cache_read({'chiller'})
+
+    _channels = []
+    for port, details in _cached_chillers.items():
+        (
+            _config,
+            _device_type,
+            _serial_number,
+            _model,
+            _manufacturer,
+            _device_channels,
+            _release_delay,
+        ) = details
+
+        for device_channel in _device_channels:
+            _channels.append(
+                common.Channel(
+                    port,
+                    _config,
+                    _serial_number,
+                    _model,
+                    _manufacturer,
+                    device_channel,
+                    _device_type,
+                    _release_delay,
+                    None,
+                )
+            )
+
+    _pipeline = Production(_channels)
+
+    try:
+        _channel = _channels[0]
+    except IndexError:
+        pass
+
+    def __init__(self):
+        try:
+            self.ser = serial.Serial(port=self._channel.port)
+        except OSError:
+            self.init_failed = True
+        else:
+            self.init_failed = False
+            self._finalizer = weakref.finalize(self, self.ser.close)
+            self.ser.apply_settings(self._channel.config)
+            self.ser.reset_input_buffer()
+            self.ser.reset_output_buffer()
+
+    def remove(self):
+        """manual garbage collection: close serial port"""
+        self._finalizer()
+
+    @property
+    def removed(self):
+        """check (indirectly) if the serial port has been closed"""
+        return not self._finalizer.alive
 
     ##########################################################################
     # public functions
@@ -437,62 +494,49 @@ def main():
     """
     args = check_arguments()
 
-    # obtain available ports
-    all_ports = {com.device for com in stlp.comports() if common.rs232_port_is_valid(com)}
-    if not all_ports:
-        sys.exit('No usable serial ports found')
-
-    # find ports already allocated to other devices
-    cache = common.cache_read()
-
-    # If a port has None in its settings field, then it was not identified by
-    # detect.py, and can therefore still be considered for use by this
-    # script.
-    identified_ports_in_cache = {k for k, v in cache.items() if v[0] is not None}
-
-    # usable ports for this script
-    available_ports = all_ports - identified_ports_in_cache
+    with open(common.RS232_LOCK_GLOBAL, 'a') as lock_file:
 
-    if len(available_ports) > 1:
-        sys.exit(f'Too many ports to choose from: {available_ports}')
-    elif not available_ports:
-        sys.exit('No usable serial ports available')
+        # acquire the RS232 global lock
+        fcntl.flock(lock_file.fileno(), fcntl.LOCK_EX)
 
-    port = available_ports.pop()
-    print(f'using port {port}')
-    config = {'baudrate': 9600, 'bytesize': 8, 'parity': 'N', 'stopbits': 1,
-              'xonxoff': False, 'dsrdtr': False, 'rtscts': False, 'timeout': 1,
-              'write_timeout': 1, 'inter_byte_timeout': None}
+        # --------------------------------------------------------------------
 
-    settings = find_ult80(port, config)
-    if settings is None:
-        sys.exit('Serial port could not be opened')
-
-    with serial.Serial(port=port) as ser:
-        ser.apply_settings(settings)
-
-        ult80 = Ult80(ser)
+        ult80 = Ult80()
 
         if args.read_internal_temperature:
             rval = ult80.read_internal_temperature()
             if rval is None:
                 print('no response from device')
             else:
-                print(f'read_internal_temperature, returned value {rval}°C')
+                if args.quiet:
+                    print(rval)
+                else:
+                    print(f'read_internal_temperature, returned value {rval}°C')
 
         if args.read_setpoint:
             rval = ult80.read_setpoint_control_point()
             if rval is None:
                 print('no response from device')
             else:
-                print(f'read_setpoint_control_point, returned value {rval}°C')
+                if args.quiet:
+                    print(rval)
+                else:
+                    print(f'read_setpoint_control_point, returned value {rval}°C')
 
         if args.set_setpoint:
             rval = ult80.set_setpoint_control_point(float(args.set_setpoint[0]))
             if rval is None:
                 print('no response from device')
             else:
-                print(f'set_setpoint_control_point, returned value {rval}°C')
+                if args.quiet:
+                    print(rval)
+                else:
+                    print(f'set_setpoint_control_point, returned value {rval}°C')
+
+        # --------------------------------------------------------------------
+
+        # release the RS232 global lock
+        fcntl.flock(lock_file.fileno(), fcntl.LOCK_UN)
 
 
 ##############################################################################

mmcbrs232/zhelpers.py

@@ -0,0 +1,58 @@
+# encoding: utf-8
+"""
+Helper module for example applications. Mimics ZeroMQ Guide's zhelpers.h.
+"""
+from __future__ import print_function
+
+import binascii
+import os
+from random import randint
+
+import zmq
+
+def socket_set_hwm(socket, hwm=-1):
+    """libzmq 2/3/4 compatible sethwm"""
+    try:
+        socket.sndhwm = socket.rcvhwm = hwm
+    except AttributeError:
+        socket.hwm = hwm
+
+
+def dump(msg_or_socket):
+    """Receives all message parts from socket, printing each frame neatly"""
+    if isinstance(msg_or_socket, zmq.Socket):
+        # it's a socket, call on current message
+        msg = msg_or_socket.recv_multipart()
+    else:
+        msg = msg_or_socket
+    print("----------------------------------------")
+    for part in msg:
+        print("[%03d]" % len(part), end=' ')
+        is_text = True
+        try:
+            print(part.decode('ascii'))
+        except UnicodeDecodeError:
+            print(r"0x%s" % (binascii.hexlify(part).decode('ascii')))
+
+
+def set_id(zsocket):
+    """Set simple random printable identity on socket"""
+    identity = u"%04x-%04x" % (randint(0, 0x10000), randint(0, 0x10000))
+    zsocket.setsockopt_string(zmq.IDENTITY, identity)
+
+
+def zpipe(ctx):
+    """build inproc pipe for talking to threads
+
+    mimic pipe used in czmq zthread_fork.
+
+    Returns a pair of PAIRs connected via inproc
+    """
+    a = ctx.socket(zmq.PAIR)
+    b = ctx.socket(zmq.PAIR)
+    a.linger = b.linger = 0
+    a.hwm = b.hwm = 1
+    iface = "inproc://%s" % binascii.hexlify(os.urandom(8))
+    a.bind(iface)
+    b.connect(iface)
+    return a,b

mmcbrs232/zpsustat.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python3
+"""
+Instantaneous snapshot of a single power supply channel from a device
+connected by a FTDI USB to RS232 adaptors. The value is obtained from the
+ZeroMQ serial port server running on atldaq1.
+
+E.g.
+
+zpsustat --serial 103877 --channel 3 --sv
+
+Use "zpsustat -h" for help
+
+All power supplies supported by detect.py are usable by this script.
+"""
+
+import itertools
+import sys
+import types
+
+from mmcbrs232 import mdclientlib
+from mmcbrs232.psustat import check_arguments
+
+
+##############################################################################
+# main
+##############################################################################
+
+def main():
+    """
+    Instantaneous snapshot of a single power supply channel from a device
+    connected by a FTDI USB to RS232 adaptors. The value is obtained from the
+    ZeroMQ serial port server running on atldaq1.
+    """
+    status = types.SimpleNamespace(success=0, unreserved_error_code=3)
+
+    settings = {
+        'alias': None,
+        'channel': None,
+        'manufacturer': None,
+        'model': None,
+        'port': None,
+        'serial': None,
+        'time': None,
+        }
+    check_arguments(settings)
+
+    # handle ./ prefix, though this should not be present when this script is packaged
+    options = sys.argv[1:]
+    if not options:
+        print('please specify options sufficient to identify a single channel')
+        return status.unreserved_error_code
+
+    command = ' '.join(itertools.chain(['psustat'], options))
+
+    mdc = mdclientlib.Rs232()
+    try:
+        response = mdc._reply_value(mdc._issue_serial_command(command))
+    except TypeError:
+        print('No response')
+        return status.unreserved_error_code
+
+    if response is None:
+        print('No response')
+        return status.unreserved_error_code
+
+    print(response)
+    return status.success
+
+
+##############################################################################
+if __name__ == '__main__':
+    sys.exit(main())

mmcb_rs232/dmm.py

@@ -1,126 +0,0 @@
-#!/usr/bin/env python3
-"""
-Read values from the Keithley DMM6500.
-"""
-
-import argparse
-import itertools
-import sys
-import time
-
-from mmcb_rs232 import common
-from mmcb_rs232 import dmm_interface
-
-
-##############################################################################
-# command line option handler
-##############################################################################
-
-
-def check_arguments():
-    """
-    handle command line options
-
-    --------------------------------------------------------------------------
-    args : none
-    --------------------------------------------------------------------------
-    returns
-        args : <class 'argparse.Namespace'>
-    --------------------------------------------------------------------------
-    """
-    parser = argparse.ArgumentParser(
-        description='Reads voltage or current from the Keithley DMM6500.'
-    )
-    parser.add_argument(
-        '-p', '--plain',
-        action='store_true',
-        help='print the requested figure only')
-    parser.add_argument(
-        '-c', '--capacitance',
-        action='store_true',
-        help='Read capacitance (F)')
-    parser.add_argument(
-        '--currentac',
-        action='store_true',
-        help='Read AC current (A)')
-    parser.add_argument(
-        '-i', '--currentdc',
-        action='store_true',
-        help='Read DC current (A)')
-    parser.add_argument(
-        '-r', '--resistance',
-        action='store_true',
-        help='Read two-wire resistance (\u03a9)')
-    parser.add_argument(
-        '-t', '--temperature',
-        action='store_true',
-        help='Read temperature (\u00b0C)')
-    parser.add_argument(
-        '--voltageac',
-        action='store_true',
-        help='Read AC voltage (V)')
-    parser.add_argument(
-        '-v', '--voltagedc',
-        action='store_true',
-        help='Read DC voltage (V)')
-
-    args = parser.parse_args()
-
-    return args
-
-
-##############################################################################
-# main
-##############################################################################
-
-
-def main():
-    """ Read values from the Keithley DMM6500 """
-
-    args = check_arguments()
-
-    dmm = dmm_interface.Dmm6500()
-    if dmm.init_failed:
-        print('could not initialise serial port')
-        return 3
-
-    configure = {
-            'capacitance': dmm.configure_read_capacitance,
-            'currentac': dmm.configure_read_ac_current,
-            'currentdc': dmm.configure_read_dc_current,
-            'resistance': dmm.configure_read_resistance,
-            'temperature': dmm.configure_read_temperature,
-            'voltagedc': dmm.configure_read_dc_voltage,
-            'voltageac': dmm.configure_read_ac_voltage,
-    }
-
-    # AC quantities sometimes return None on the first attempt
-    retries = 3
-
-    success = []
-    params = []
-    for function, required in vars(args).items():
-        if not required or function=='plain':
-            continue
-
-        configure[function]()
-
-        value = None
-        for _ in itertools.repeat(None, retries):
-            value = dmm.read_value()
-            if value is not None:
-                success.append(True)
-                break
-            time.sleep(0.1)
-
-        if args.plain:
-            print(value)
-        else:
-            print(f'{function}, {common.si_prefix(value)}, {value}')
-
-    return 0 if any(success) else 3
-
-
-##############################################################################
-if __name__ == '__main__':
-    sys.exit(main())

mmcb_rs232_avt-1.0.20.dist-info/METADATA

@@ -1,62 +0,0 @@
-Metadata-Version: 2.4
-Name: mmcb_rs232-avt
-Version: 1.0.20
-Summary: ATLAS ITK Pixels Multi-Module Cycling Box environmental monitoring/control (RS232)
-Home-page: https://gitlab.ph.liv.ac.uk/avt/atlas-itk-pmmcb-rs232
-Author: Alan Taylor
-Author-email: avt@hep.ph.liv.ac.uk
-Maintainer: Alan Taylor
-Maintainer-email: avt@hep.ph.liv.ac.uk
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Science/Research
-Classifier: Topic :: Scientific/Engineering :: Physics
-Classifier: Environment :: Console
-Classifier: Environment :: X11 Applications
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Natural Language :: English
-Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-Requires-Dist: numpy
-Requires-Dist: pandas
-Requires-Dist: matplotlib
-Requires-Dist: zmq
-Requires-Dist: pyserial==3.4.*
-Requires-Dist: tables
-Requires-Dist: yoctopuce
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: maintainer
-Dynamic: maintainer-email
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# Software support for the ATLAS ITK pixels multi-module cycling box (RS232 only)
-
-[![PyPI version](https://badge.fury.io/py/mmcb-rs232-avt.svg)](https://badge.fury.io/py/mmcb-rs232-avt)
-
-![image](https://hep.ph.liv.ac.uk/~avt/pypi/logo.png)
-
-*Particle Physics, University of Liverpool, UK*
-
-----
-
-This repository provides command line tools to monitor and control equipment in the *ATLAS ITK pixels multi-module cycling box* test setup. It is used in the test setups for a number of other projects.
-
-This repository mirrors a subset of files contained in the original [atlas-mmcb-avt](https://gitlab.ph.liv.ac.uk/avt/atlas-itk-pmmcb/) repository, the later remains the reference. This package contains only the RS232 laboratory control command line scripts, and excludes the Raspberry Pi specific I2C environmenal monitoring parts.

mmcb_rs232_avt-1.0.20.dist-info/RECORD

@@ -1,17 +0,0 @@
-mmcb_rs232/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mmcb_rs232/common.py,sha256=xI3Iqh_Y0iEvLLc-9bSQSHuTKBhSrY4AAMyV-X_dfvQ,99594
-mmcb_rs232/detect.py,sha256=NnJHsfcPl6Lk3dw1xKp3bVgIV5ug4atx-or95rKncLg,34888
-mmcb_rs232/dmm.py,sha256=6SUkm3Nf_oGC0LgtiSE8czFGwDw1Bjg6f2O95Ed7GGM,3511
-mmcb_rs232/dmm_interface.py,sha256=XrNVEsq6H9SXBx1RhQ_pVcR1m2CItco7vZDAe_P8Bm0,4700
-mmcb_rs232/iv.py,sha256=Mb6nXEyczX20PMLjG1ej9OpHXa1FEmVqwP4r2V4ICgk,115342
-mmcb_rs232/lexicon.py,sha256=x30iZ6pMZjdpdmwmZfhhX5MfMCZu4GH6gaPJyXIG_y0,24903
-mmcb_rs232/psuset.py,sha256=7kMg7q8DWaeESEMCHbq7WEFfbTh-FMUvKdP9pBBKLLQ,37513
-mmcb_rs232/psustat.py,sha256=5qK_51jnmT_DKeLZlerUULIUy2AJJKIkb4BlFCD7BLM,26668
-mmcb_rs232/psuwatch.py,sha256=tI_CK6XuxFA_aoAeeDA_b9pM9Ra30B2dh5-fCK8YlAM,21662
-mmcb_rs232/sequence.py,sha256=mZhVwqkzWVwIz7BKH3a7dUgYeUcJdzQKXIvxucsKCtk,17711
-mmcb_rs232/ult80.py,sha256=VYVKjGSJLKgSr4F4QABGyWnpZUmTvFmybohyP5Kq9BU,17665
-mmcb_rs232_avt-1.0.20.dist-info/METADATA,sha256=B-wM8R9dRDsKNUKY1TbfjYCU5WOSt8g_zpVMIO4HgLU,2590
-mmcb_rs232_avt-1.0.20.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-mmcb_rs232_avt-1.0.20.dist-info/entry_points.txt,sha256=QkJcHeTjO0v5yfgbY814Lm2NedyZ81A55nYqtDz1l8s,302
-mmcb_rs232_avt-1.0.20.dist-info/top_level.txt,sha256=R7MQdVXJyyGxoZ1lBG0-7RGElplTd0tsPKJzVjMqYVc,11
-mmcb_rs232_avt-1.0.20.dist-info/RECORD,,

mmcb_rs232_avt-1.0.20.dist-info/entry_points.txt

@@ -1,10 +0,0 @@
-[console_scripts]
-detect = mmcb_rs232.detect:main
-dmm = mmcb_rs232.dmm:main
-iv = mmcb_rs232.iv:main
-liveplot = mmcb_rs232.liveplot:main
-log2dat = mmcb_rs232.log2dat:main
-psuset = mmcb_rs232.psuset:main
-psustat = mmcb_rs232.psustat:main
-psuwatch = mmcb_rs232.psuwatch:main
-ult80 = mmcb_rs232.ult80:main

mmcb_rs232_avt-1.0.20.dist-info/top_level.txt

@@ -1 +0,0 @@
-mmcb_rs232