Skip to content

Latest commit

 

History

History
128 lines (88 loc) · 3.06 KB

README.md

File metadata and controls

128 lines (88 loc) · 3.06 KB
Raw

BlueFTC

A simple Python interface for Bluefors cryostat temperature controllers.

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. License
  5. Contact

About The Project

The control software for Bluefors cryostat and their temperature controller does not come with a native Python interface. At the same time, Python is widely used as a measurement scripting language among users of Bluefors devices. This driver uses HTTP GET/POST commands to remotely read and write to a controller using the control Software's API.

(back to top)

Getting Started

The package is not yet uploaded on PyPi, but can be installed through pip. Only native Python libraries are used, there are no external dependencies.

Installation

To install the package, navigate to its root folder, i.e. where pyproject.toml is located, and install it using pip:

python -m pip install .

Basic Usage

Once installed, the package can be easily integrated into measurement scripts.

# import
from blueftc.BlueFTController import BlueforsController

# create controller object
# TODO: setup via config file
tcontrol = BlueFTController(ip="YOUR_IP_HERE")

# show basic information
tcontrol.show_overview()

# HEATER CONTROL
# set and get heater power in uW
tcontrol.set_mxc_heater_power(setpower=100)
power = tcontrol.get_mxc_heater_power()
print(power)

# turn heater on or off
tcontrol.toggle_mxc_heater(status='on')
tcontrol.toggle_mxc_heater(status='off')
#

# TEMPERATURE CHANNEL CONTROL
# get latest temperature in Kelvin
temp = tcontrol.get_mxc_temperature()
print(temp)

Usage in Matlab

The controller can also be used from matlab:

tcontrol = py.blueftc.BlueforsController(ip="YOUR_IP_HERE")

Roadmap

  • Write proper documentation
  • Update to latest version of Bluefors control software
  • Improve Error Handling
  • Upload to PyPi
  • Logging

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Elias Ankerhold - elias.ankerhold[at].aalto.fi Thomas Pfau - thomas.pfau[at].aalto.fi

(back to top)