gammavac_controller

Low-level library for communicating with a Gamma Vacuum SPCe controller

Currently Supported Models

• SPCe - SPCe.py, SPCe.c, SPCe.h

Features

• Connect to Gamma Vacuum controllers over serial through a terminal server
• Query state and parameters
• Set individual parameters

Requirements

• Install base class from https://github.com/COO-Utilities/hardware_device_base

Installation

pip install .

Usage

import SPCe

controller = SPCe.SpceController(bus_address=5)
controller.connect(host='192.168.29.100', port=10015)

# Print pressure
print(controller.read_pressure())

# Print pump size
print(controller.get_pump_size())

# Get voltage
controller.read_voltage()

# Get Controller Version
controller.read_version()

# For a comprehensive list of classes and methods, use the help function
help(SPCe)

🧪 Testing

Unit tests are located in tests/ directory.

To run all tests from the project root:

pytest

Class Diagram

Below is a class diagram of the added methods and attributes for the Gamma Vac-Ion. See the README for the hardware_device_base module for the inherited methods and attributes.

classDiagram
    class SpceController {
        +Int bus_address
        +socket sock
        +Bool simulate
        _clear_socket()
        _send_request() Union[int, float, str]
        create_command() str
        validate_response() bool
        read_model() str
        read_version() str
        reset()
        set_arc_detect()
        get_arc_detect() str
        read_current() float
        read_pressure() float
        read_voltage() float
        set_units()
        get_pump_status() str
        get_pump_size() int
        set_pump_size()
        get_cal_factor() float
        set_cal_factor()
        set_auto_restart()
        get_auto_restart() str
        start_pump()
        stop_pump()
        lock_keypad()
        get_analog_mode() int
        set_analog_mode()
        high_voltage_on() str
        set_hv_autorecovery()
        get_hv_autorecovery() int
        set_comm_mode()
        get_comm_mode() int
        set_comm_interface()
    }

Loading