Skip to main content

Python driver for Brooks Instrument mass flow controllers

Project description

brooks-mfc

Python driver and command-line tool for Brooks Instrument mass flow controllers.

Installation

pip install brooks-mfc

Usage

This driver uses an undocumented REST API in the devices's web interface for communication. The compatibility and stability of this interface with all Brooks controllers is not guaranteed.

Command Line

To test your connection and stream real-time data, use the command-line interface. You can read the flow rate with:

$ brooks-mfc 192.168.1.200
{
    "Customer Flow Totalizer": 0.0,
    "Flow": -0.3,
    "Flow Hours": 1.0,
    "Flow Totalizer": 0.0,
    "Live Setpoint": 0.0,
    "Operational Hours": 50.0,
    "Setpoint": 0.0,
    "Supply Voltage": 22.93,
    "Temperature": 27.11,
    "Valve Position": 0.0
}

You can optionally specify a setpoint flow with the set flag: brooks-mfc 192.168.1.150 --set 7.5. The units of the setpoint and return are specified using the --units flag. See mfc --help for more.

Python

This uses Python ≥3.5's async/await syntax to asynchronously communicate with the mass flow controller. For example:

import asyncio
from brooks_mfc import FlowController

async def get():
    async with FlowController('the-mfc-ip-address') as fc:
        print(await fc.get())

asyncio.run(get())

The API that matters is get, set. Optionally, units can be passed with either command. If no units are specified the existing units configured for the device are used.

>>> await fc.get()
>>> await fc.get('%')
{
    "Customer Flow Totalizer": 0.0,
    "Flow": -0.3,
    "Flow Hours": 1.0,
    "Flow Totalizer": 0.0,
    "Live Setpoint": 0.0,
    "Operational Hours": 50.0,
    "Setpoint": 0.0,
    "Supply Voltage": 22.93,
    "Temperature": 27.11,
    "Valve Position": 0.0
}
>>> await fc.set(10)
>>> await fc.set(10, 'SCCM')

There's much more that could be set or returned from the flow controllers but I haven't had a reason to flesh all the the options out. Feel free to submit an issue with requests or a PR.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

brooks_mfc-0.1.4.tar.gz (12.9 kB view details)

Uploaded Source

Built Distribution

brooks_mfc-0.1.4-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

Details for the file brooks_mfc-0.1.4.tar.gz.

File metadata

  • Download URL: brooks_mfc-0.1.4.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.7.7 Darwin/19.6.0

File hashes

Hashes for brooks_mfc-0.1.4.tar.gz
Algorithm Hash digest
SHA256 21407557d1d186baedb038a0b6476032d5a7f04d5b98442afb88e90c8ca7cdda
MD5 15654afeddc00f6f8483b2d3b4a3dedc
BLAKE2b-256 79325c24607919c5692b3bdcf2204c28ccccdaa56d0d41e5b1a32af2bea5e7dc

See more details on using hashes here.

File details

Details for the file brooks_mfc-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: brooks_mfc-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 14.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.7.7 Darwin/19.6.0

File hashes

Hashes for brooks_mfc-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 65b7199bab7ebd910ef75a35e8493624d706408159cf82003ecff3b7644552c4
MD5 a379c497610f93d8ad043fd8b0eb5918
BLAKE2b-256 9a29034418fd4996c38fa593f19dfddce6c40bf4ad5079bb6e36b32b34d4196e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page