README.md

HVPS

What is this? 🤔

This is a Python package for controlling high voltage power supplies (HVPS) over serial port. The aim is to provide a unified pythonic interface for different HVPS models.

Along with the Python package, a minimal set of bindings for Node.js is also provided. A nodered node is also available. They both rely on the Python package to be installed in order to work.

Currently only CAEN and iseg brands are supported.

Installation ⚙️

Installation via pip is supported. To install the latest published version, run:

pip install hvps

To install the package from source, including development dependencies, clone the repository and run:

pip install .[dev]

Usage 👨‍💻

There is a hierarchy of objects that represent the HVPS and its components:

• HVPS: represents the HVPS itself and handles the connection to the serial port. The classes Caen and Iseg are available for the respective brands.
• Module: represents a module of the HVPS. Some HVPS support multiple modules over the same connection
• Channel: represents a channel of the HVPS

Connection

from hvps import Caen, Iseg
import logging

# connection interface is common to all HVPS
# if no serial port is specified, the first available port will be used
# if no baudrate is specified, the default baudrate will be used
# if logging_level is specified, the logger will be configured accordingly
with Caen(port="/dev/ttyUSB0", baudrate=115200, logging_level=logging.DEBUG) as hvps:
    # using context manager (with) is recommended, but not required.
    # If not used, the connection must be opened and closed manually (hvps.open() and hvps.close())
    # connection settings can be accessed
    print(f"port: {hvps.port}")
    print(f"baudrate: {hvps.baudrate}")

Module

from hvps import Caen

# default connection settings
with Caen() as caen:
    module = caen.module()  # get the first module (module 0)
    # if multiple modules are present, they can be accessed by index e.g. caen.module(1)

    # get the module's name
    print(f"module name: {module.name}")

Channel

from hvps import Caen

with Caen() as caen:
    module = caen.module(0)

    print(f"number of channels: {module.number_of_channels}")

    channel = module.channel(2)  # get channel number 2

    # get monitoring parameters
    print(f"vmon: {channel.vmon}")
    print(f"vset: {channel.vset}")

    # set values (remote mode must be enabled)
    # turn on channel
    channel.turn_on()

    channel.vset = 300.0  # 300 V

CLI 🖥️

A CLI is provided to interact with the HVPS from the command line.

TODO @AlonsoDRDLV

Show available serial ports

python -m hvps --ports

Output: command output

Disclaimer ⚠️

The development of this package is mostly based on documentation with access to only a few models of HVPS.

If you use this package, it is very possible you find a bug or some oversight. You are encouraged to make a pull request or to create an issue to report a bug, to request additional features or to suggest improvements.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Luis Antonio Obis Aparicio 💻

AlonsoDRDLV 💻

jherkenhoff 💻

This project follows the all-contributors specification. Contributions of any kind welcome!