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

mmcb_rs232_avt-1.1.37.dist-info/METADATA

@@ -0,0 +1,210 @@
+Metadata-Version: 2.4
+Name: mmcb-rs232-avt
+Version: 1.1.37
+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
+
+# Serial port handling for the ATLAS ITK pixels multi-module cycling box
+
+[![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*
+
+## Features
+
+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. Interactions with these instruments are performed via FTDI USB to RS232 adaptors.
+
+### Main commands
+
+|Command|Function|
+|:---:|:---:|
+|[dmm](packaging/src/mmcbrs232/dmm.py)|Reads voltage/current values from the Keithley DMM6500 6.5 digit multimeter.|
+|[iv](packaging/src/mmcbrs232/iv.py)|Configurable script to measure IV/IT curves using the Keithley 2410/2614b (RS232). It can operate multiple PSUs concurrently, embed environmental data into log files, and can be easily used in shell scripts to automate tasks such as HV-cycling.|
+|[psuset](packaging/src/mmcbrs232/psuset.py)|Sets current/voltage parameters for power supplies (RS232: Keithley 2410/2614b, Hameg HMP4040). Works in both constant voltage and constant current modes.|
+|[ult80](packaging/src/mmcbrs232/ult80.py)|Queries and/or sets parameters for the ULT80 chiller (RS232).|
+
+### Support commands
+
+|Command|Function|
+|:---:|:---:|
+|[detect](packaging/src/mmcbrs232/detect.py)|Detects equipment attached by RS232, writes a cache file containing identified equipment to `~/.cache.json`. Run *once* after the RS232 configuration has changed.|
+|[liveplot](packaging/src/mmcbrs232/liveplot.py)|Companion to `iv`. Displays IV plot in real-time in a graphical window.|
+|[psustat](packaging/src/mmcbrs232/psustat.py)|Provides a single-shot view of the status of all power supply channels (RS232: Keithley 2410/2614b, Hameg HMP4040).|
+|[rs232_zmq_server](packaging/src/mmcbrs232/broker_and_workers.py)|Provides shared, parallel access to RS232 instruments. Concurrent requests to the same serial port are serialised by order of arrival since interactions with a given serial port is managed by a single thread specific to that serial port.|
+|[zpsustat](packaging/src/mmcbrs232/zpsustat.py)|Version of `psustat` above that uses the ZeroMQ server rather than querying the device directly. Supports requests for information on specified, individual PSU channels only.|
+
+## History
+
+The files in this repository were originally part of the [atlas-mmcb-avt](https://gitlab.ph.liv.ac.uk/avt/atlas-itk-pmmcb/) repository, which used to handle monitoring and control of equipment attached via I2C, GPIO and serial port. To support the serial port interaction being run on a conventional Intel DAQ computer, these functions were split into two packages. All RS232 serial port interaction code is now contained in this package.
+
+The Raspberry Pi specific aspects (I2C environmenal monitoring and Peltier device polarity switching via GPIO) remain in the [atlas-mmcb-avt](https://gitlab.ph.liv.ac.uk/avt/atlas-itk-pmmcb/) repository, which no longer contains any serial port capability.
+
+## Documentation
+
+For project documentation, see the [wiki](https://gitlab.ph.liv.ac.uk/avt/atlas-itk-pmmcb/-/wikis/home), or each command's in-built help, e.g. `psustat --help`.
+
+
+## Installation
+
+This software is publically available and may be obtained from [The Python Package Index](https://pypi.org/project/mmcb-avt/).
+
+This repository provides also a wheel (`.whl`) file that is installable with [pip](https://packaging.python.org/en/latest/key_projects/#pip). See the [packaging](packaging) directory for installation instructions.
+
+
+## Support
+
+Support requests to [avt@hep.ph.liv.ac.uk](mailto:avt@hep.ph.liv.ac.uk) or via the [Issue Tracker](https://gitlab.ph.liv.ac.uk/avt/atlas-itk-pmmcb/-/issues).
+
+
+## Installation notes
+
+### Yoctopuce sensors
+
+In addition to the dependencies installed with pip, testing ATLAS sensors on the old probestation (for convenience) will also require the [Yoctopuce Command line API](https://www.yoctopuce.com/EN/libraries.php). Please install the correct version for your architecture - this will provide commands such as `YTemperature` and `YHumidity` to monitor the probestation interior state from the command line.
+
+Install the archive (e.g. `Cmdlines.linux_arm.70284.zip`) into `~/dev` and then set the path to include `~/dev/Cmdlines/Binaries/linux/aarch64`, e.g. `PATH=$PATH:~/dev/Cmdlines/Binaries/linux/aarch64`.
+
+## ZeroMQ serial port server
+
+This is based on the ZeroMQ Majordomo pattern, and has a separate thread managing each serial port.
+
+```console
+(base) [pixeldaq@atldaq1 ~]$ rs232_zmq_server -h
+usage: rs232_zmq_server [-h] [-v] [-n]
+
+ZeroMQ server (broker and workers) for the ATLAS Pixels multi-module cycling box serial port devices. This server manages
+concurrent access to serial port resources for all attached clients. Commands line scripts emulated are psuset, psustat
+and ult80. WARNING: ANY attached client has the authority to change ANY power supply or chiller parameter at ANY time.
+Clients (PID control loops) running concurrently must ensure that they only modify their own resources, and not those of
+other clients.
+
+options:
+  -h, --help     show this help message and exit
+  -v, --verbose  Enable logging.
+  -n, --nolock   Disable the use of the global rs232 lock. For safety this script will use the global rs232 lock by
+                 default. This lock is a coarse measure that should prevent concurrent serial port access, even to
+                 different ports, by this server and other command line scripts that may access serial port resources.
+                 When running multiple concurrent asynchronous PID control scripts, using -n allows optimal sharing of
+                 serial port resources between those scripts.
+```
+
+If you want the best performance from PID scripts, start the server with `-n`. If you need to use command line utilities (`psuset`, `psustat`, etc.) in parallel with PID scripts, then omit the `-n`.
+
+### Start
+
+```console
+(base) [pixeldaq@atldaq1 ~]$ nohup rs232_zmq_server </dev/null >/dev/null 2>&1 &
+(base) [pixeldaq@atldaq1 ~]$ disown
+```
+
+### Stop
+
+```console
+(base) [pixeldaq@atldaq1 ~]$ ps -ef | grep rs232_zmq_server
+pixeldaq 18079 17527  0 12:00 pts/16   00:00:12 /usr/local/bin/python3 /home/pixeldaq/.local/bin/rs232_zmq_server
+pixeldaq 26239 17527  0 12:51 pts/16   00:00:00 grep --color=auto rs232_zmq_server
+(base) [pixeldaq@atldaq1 ~]$ kill 18079
+```
+
+### Test
+
+```console
+(base) [pixeldaq@atldaq1 ~]$ pip show mmcb-rs232-avt
+WARNING: Ignoring invalid distribution ~ip (/home/pixeldaq/miniconda3/lib/python3.13/site-packages)
+Name: mmcb-rs232-avt
+Version: 1.1.28
+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
+License:
+Location: /home/pixeldaq/miniconda3/lib/python3.13/site-packages
+Requires: matplotlib, numpy, pandas, pyserial, tables, yoctopuce, zmq
+Required-by:
+
+(base) [pixeldaq@atldaq1 ~]$ python
+Python 3.13.2 | packaged by Anaconda, Inc. | (main, Feb  6 2025, 18:56:02) [GCC 11.2.0] on linux
+Type "help", "copyright", "credits" or "license" for more information.
+>>> from mmcbrs232 import mdclientlib
+>>> mdclientlib.__version__
+'1.1.28'
+>>> mdc = mdclientlib.Rs232()
+>>> mdc.
+mdc.channels           mdc.get_pt_i(          mdc.get_ult80_temps()  mdc.psu_set(           mdc.psus
+mdc.client             mdc.get_pt_v(          mdc.ports              mdc.psu_unset(         mdc.settings
+>>> mdc.get_ult80_temps()
+(23.0, 23.0)
+>>> mdc.get_pt_v(103877, 2)
+0.3
+```
+
+### Latency for common operations
+
+```python
+(base) [pixeldaq@atldaq1 ~]$ ipython
+Python 3.13.2 | packaged by Anaconda, Inc. | (main, Feb  6 2025, 18:56:02) [GCC 11.2.0]
+Type 'copyright', 'credits' or 'license' for more information
+IPython 9.6.0 -- An enhanced Interactive Python. Type '?' for help.
+Tip: You can use LaTeX or Unicode completion, `\alpha<tab>` will insert the α symbol.
+
+In [1]: from mmcbrs232 import mdclientlib
+
+In [2]: mdc = mdclientlib.Rs232()
+
+In [3]: %timeit mdc.get_ult80_temps()
+63.9 ms ± 26.4 μs per loop (mean ± std. dev. of 7 runs, 10 loops each)
+
+In [4]: %timeit mdc.get_pt_v(103877, 2)
+204 ms ± 8.58 ms per loop (mean ± std. dev. of 7 runs, 1 loop each)
+
+In [5]: %timeit mdc.psu_set(103877, 2, 0.3, 4.95)
+1.12 s ± 4.58 ms per loop (mean ± std. dev. of 7 runs, 1 loop each)
+
+In [6]: %timeit mdc.psu_unset(103877, 2, 0.3, 4.95)
+1.12 s ± 7.78 ms per loop (mean ± std. dev. of 7 runs, 1 loop each)
+```

mmcb_rs232_avt-1.1.37.dist-info/RECORD

@@ -0,0 +1,26 @@
+mmcbrs232/MDP.py,sha256=rw09OnzA2_W-k0etmjR_MgREEj1cO8V7mRmxvmy9m8E,1110
+mmcbrs232/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mmcbrs232/broker_and_workers.py,sha256=tpxzJgoBwjEflxatfpMeES19vfe3iqTMo_soEPXTAoA,19597
+mmcbrs232/common.py,sha256=i7mu_eLoCLdq8f0Fqdu66npOfWKKtZDgX4X2FRfwTQQ,100626
+mmcbrs232/detect.py,sha256=OPToFRTKa5ULBqdVGVD1olM-qq5PnG63633gjiMaxto,46161
+mmcbrs232/dmm.py,sha256=vhH7fLFf73UapKbdLovlRp6i2wecnudZjA2z89og4bk,6394
+mmcbrs232/dmm_interface.py,sha256=eUnLg6Mmb9zxxccjV793s1g3Yuwbu9SQ6j8EtJuFhEg,5411
+mmcbrs232/iv.py,sha256=3vRn84bQCdR4UbBZhjllyF9-bCT1aDFEtzXzH9vm_BY,116197
+mmcbrs232/lexicon.py,sha256=Cm_rbe3h4Yshw-f5SfYrPoz6HoSIsFXimY8u_sLokis,25537
+mmcbrs232/liveplot.py,sha256=ZSgHK9cozj6ERWh7OsVxseTqSe9jHs1mxQDTia-nfzs,12231
+mmcbrs232/mdbroker.py,sha256=adYBqYEVN1YgX5Tud-gNlV--8ZIoHqNBrRal8QIaaiw,10403
+mmcbrs232/mdcliapi.py,sha256=SJHTgX_xzv91S1JhVayFP1azBujaz6zxuNCIoMA4nBo,3311
+mmcbrs232/mdclientlib.py,sha256=dXLeLnQiXaVnymmahHWrST6b-U8-A7efqmLplX2drK8,8194
+mmcbrs232/mdwrkapi.py,sha256=0uGWTjwOjEtKaowuMiB-pxV_o5B6gAAoDvanYGNKQbM,5939
+mmcbrs232/psuset.py,sha256=xyMJuv3YjaxfigTE1zKYmgbxGdK1yyon771TQxPzfVo,38610
+mmcbrs232/psustat.py,sha256=Y04XeFLUrE3tyEpeVyxkdSmzfy5b6K1OHbqvTRpb0nc,32612
+mmcbrs232/psuwatch.py,sha256=4qPf12XcJmZ6Pry8Po-DLUB-4BpyVhjEwAdEzvCr-8g,21947
+mmcbrs232/sequence.py,sha256=9VUOgABjQHYVG-d53SvL7Qr-RuTstYN1kTia6c_04Pc,17683
+mmcbrs232/ult80.py,sha256=GVQnPiXjfobRHBt0NqAJhhBW_GP-YuFiUhe7GTy2gLc,18564
+mmcbrs232/zhelpers.py,sha256=aJkcSgI7PGmajA_OHlNpdonrPMG65u0hahykduG9N3M,1566
+mmcbrs232/zpsustat.py,sha256=FXNF8KklXW2pggS4QRu9K5tW2y_M9haJSjzTAjQBJ3o,1991
+mmcb_rs232_avt-1.1.37.dist-info/METADATA,sha256=zm-HkXYO9akIupcsGVqO7gkZqKWsXe5_bdeH6svdPcs,10398
+mmcb_rs232_avt-1.1.37.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+mmcb_rs232_avt-1.1.37.dist-info/entry_points.txt,sha256=ci8F-1C0MhgCIHGW9vcaf6hjMlRNKVtYynM0ZupyS1Y,381
+mmcb_rs232_avt-1.1.37.dist-info/top_level.txt,sha256=xLFfE3WF9YiVLK6xBmwyjvHlf_W66C16Ct0hhMt_b_k,10
+mmcb_rs232_avt-1.1.37.dist-info/RECORD,,

{mmcb_rs232_avt-1.0.19.dist-info → mmcb_rs232_avt-1.1.37.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

mmcb_rs232_avt-1.1.37.dist-info/entry_points.txt

@@ -0,0 +1,12 @@
+[console_scripts]
+detect = mmcbrs232.detect:main
+dmm = mmcbrs232.dmm:main
+iv = mmcbrs232.iv:main
+liveplot = mmcbrs232.liveplot:main
+log2dat = mmcbrs232.log2dat:main
+psuset = mmcbrs232.psuset:main
+psustat = mmcbrs232.psustat:main
+psuwatch = mmcbrs232.psuwatch:main
+rs232_zmq_server = mmcbrs232.broker_and_workers:main
+ult80 = mmcbrs232.ult80:main
+zpsustat = mmcbrs232.zpsustat:main

mmcb_rs232_avt-1.1.37.dist-info/top_level.txt

@@ -0,0 +1 @@
+mmcbrs232

mmcbrs232/MDP.py

@@ -0,0 +1,35 @@
+"""Majordomo Protocol definitions"""
+#  This is the version of MDP/Client we implement
+C_CLIENT = b"MDPC01"
+
+#  This is the version of MDP/Worker we implement
+W_WORKER = b"MDPW01"
+
+#  MDP/Server commands, as strings
+W_READY         =   b"\001"
+W_REQUEST       =   b"\002"
+W_REPLY         =   b"\003"
+W_HEARTBEAT     =   b"\004"
+W_DISCONNECT    =   b"\005"
+
+commands = [None, b"READY", b"REQUEST", b"REPLY", b"HEARTBEAT", b"DISCONNECT"]
+
+
+# Note, Python3 type "bytes" are essentially what Python2 "str" were,
+# but now we have to explicitly mark them as such.  Type "bytes" are
+# what PyZMQ expects by default.  Any user code that uses this and
+# related modules may need to be updated.  Here are some guidelines:
+#
+# String literals that make their way into messages or used as socket
+# identfiers need to become bytes:
+#
+#   'foo' -> b'foo'
+#
+# Multippart messages, originally formed as lists of strings (smsg)
+# need to be washed into strings of bytes (bmsg) like:
+#
+#   bmsg = [one.encode('utf-8') for one in smsg]
+#
+# A multipart message recived can be reversed
+#
+#   smsg = [one.decode() for one in bmsg]