{"id":37741903,"url":"https://github.com/numat/brooks-mfc","last_synced_at":"2026-01-16T14:11:04.718Z","repository":{"id":62560449,"uuid":"254701477","full_name":"numat/brooks-mfc","owner":"numat","description":"Python driver for Brooks Instrument Mass Flow Controllers","archived":false,"fork":false,"pushed_at":"2025-03-14T18:00:35.000Z","size":39,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":7,"default_branch":"master","last_synced_at":"2026-01-04T04:26:14.149Z","etag":null,"topics":["brooks-controllers","mass-flow-controller","python-driver"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/numat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-10T18:00:07.000Z","updated_at":"2025-03-14T18:00:28.000Z","dependencies_parsed_at":"2022-11-03T14:30:28.744Z","dependency_job_id":null,"html_url":"https://github.com/numat/brooks-mfc","commit_stats":null,"previous_names":["numat/brooks_mfc"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/numat/brooks-mfc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numat%2Fbrooks-mfc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numat%2Fbrooks-mfc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numat%2Fbrooks-mfc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numat%2Fbrooks-mfc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/numat","download_url":"https://codeload.github.com/numat/brooks-mfc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numat%2Fbrooks-mfc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28479174,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["brooks-controllers","mass-flow-controller","python-driver"],"created_at":"2026-01-16T14:11:04.388Z","updated_at":"2026-01-16T14:11:04.706Z","avatar_url":"https://github.com/numat.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"brooks-mfc\n==========\n\nPython driver and command-line tool for [Brooks Instrument mass flow controllers](https://www.brooksinstrument.com/en/products/mass-flow-controllers).\n\n\u003cp align=\"center\"\u003e\n  \u003cimg height=\"250\" src=\"https://www.brooksinstrument.com/~/media/brooks/images/products/mass%20flow%20controllers/metal%20sealed/gf100/gf100-gf120-gf125-mass-flow-controller-3-491px.png\" /\u003e\n\u003c/p\u003e\n\nInstallation\n============\n\n```\npip install brooks-mfc\n```\n\nUsage\n=====\n\nThis driver uses an undocumented REST API in the devices's web interface for communication.\nThe compatibility and stability of this interface with all Brooks controllers is not guaranteed.\n\n### Command Line\n\nTo test your connection and stream real-time data, use the command-line\ninterface. You can read the flow rate with:\n\n```\n$ brooks-mfc 192.168.1.200\n{\n    \"Customer Flow Totalizer\": 0.0,\n    \"Flow\": -0.3,\n    \"Flow Hours\": 1.0,\n    \"Flow Totalizer\": 0.0,\n    \"Live Setpoint\": 0.0,\n    \"Operational Hours\": 50.0,\n    \"Setpoint\": 0.0,\n    \"Supply Voltage\": 22.93,\n    \"Temperature\": 27.11,\n    \"Valve Position\": 0.0\n}\n```\nNote the \"Live Setpoint\" is in the configured units (which could be percent of full scale or engineering units).  \"Setpoint\" is always in % of full scale.\n\nYou can optionally specify a setpoint flow with the set flag:\n`brooks-mfc 192.168.1.150 --set 7.5.` The units of the setpoint and return are\nspecified using the `--units` flag, or the currently configured units if no flag\nis passed. See `brooks-mfc --help` for more.\n\n### Python\n\nThis uses Python ≥3.5's async/await syntax to asynchronously communicate with\nthe mass flow controller. For example:\n\n```python\nimport asyncio\nfrom brooks_mfc import FlowController\n\nasync def get():\n    async with FlowController('the-mfc-ip-address') as fc:\n        print(await fc.get())\n\nasyncio.run(get())\n```\n\nThe API that matters is `get`, `set`. Optionally, units can be passed with\neither command. If no units are specified the existing units configured for\nthe device are used.\n\n```python\n\u003e\u003e\u003e await fc.get()\n\u003e\u003e\u003e await fc.get('%')\n{\n    \"Customer Flow Totalizer\": 0.0,\n    \"Flow\": -0.3,\n    \"Flow Hours\": 1.0,\n    \"Flow Totalizer\": 0.0,\n    \"Live Setpoint\": 0.0,\n    \"Operational Hours\": 50.0,\n    \"Setpoint\": 0.0,\n    \"Supply Voltage\": 22.93,\n    \"Temperature\": 27.11,\n    \"Valve Position\": 0.0\n}\n```\n```python\n\u003e\u003e\u003e await fc.set(10)\n\u003e\u003e\u003e await fc.set(10, 'SCCM')\n```\n\nThere's much more that could be set or returned from the flow controllers but\nI haven't had a reason to flesh all the the options out. Feel free to submit an\nissue with requests or a PR.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnumat%2Fbrooks-mfc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnumat%2Fbrooks-mfc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnumat%2Fbrooks-mfc/lists"}