{"id":37741867,"url":"https://github.com/numat/alicat","last_synced_at":"2026-01-16T14:11:02.346Z","repository":{"id":28533470,"uuid":"32050426","full_name":"numat/alicat","owner":"numat","description":"Python driver and command line tool for Alicat mass flow controllers.","archived":false,"fork":false,"pushed_at":"2026-01-01T09:04:56.000Z","size":183,"stargazers_count":26,"open_issues_count":10,"forks_count":37,"subscribers_count":9,"default_branch":"master","last_synced_at":"2026-01-06T05:27:36.453Z","etag":null,"topics":["flow-control","flow-controller","python"],"latest_commit_sha":null,"homepage":"","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2015-03-12T01:26:57.000Z","updated_at":"2026-01-01T09:04:50.000Z","dependencies_parsed_at":"2023-10-19T19:09:03.183Z","dependency_job_id":"e272fb93-4f0a-4f00-a3a4-471171f6a289","html_url":"https://github.com/numat/alicat","commit_stats":{"total_commits":199,"total_committers":12,"mean_commits":"16.583333333333332","dds":0.6381909547738693,"last_synced_commit":"6899906166e6acdc5621e9be412993c525aa11c2"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/numat/alicat","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numat%2Falicat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numat%2Falicat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numat%2Falicat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numat%2Falicat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/numat","download_url":"https://codeload.github.com/numat/alicat/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numat%2Falicat/sbom","scorecard":{"id":698519,"data":{"date":"2025-08-11","repo":{"name":"github.com/numat/alicat","commit":"6d7ddc248adbd567eea622ee774d3bdb6d7bfd1a"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":2,"reason":"dependency not pinned by hash detected -- score normalized to 2","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-package.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/numat/alicat/python-package.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/python-package.yml:32","Warn: pipCommand not pinned by hash: .github/workflows/python-package.yml:33","Info:   1 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Maintained","score":5,"reason":"5 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/python-package.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-22T04:28:08.787Z","repository_id":28533470,"created_at":"2025-08-22T04:28:08.788Z","updated_at":"2025-08-22T04:28:08.788Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28479171,"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":["flow-control","flow-controller","python"],"created_at":"2026-01-16T14:11:01.733Z","updated_at":"2026-01-16T14:11:02.338Z","avatar_url":"https://github.com/numat.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"alicat\n======\n\nTCP/Serial driver and command line tool for\n[Alicat mass flow controllers](http://www.alicat.com/products/mass-flow-meters-and-controllers/mass-flow-controllers/).\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"http://www.alicat.com/wpinstall/wp-content/uploads/2012/01/gas-mass-flow-controller1.jpg\" height=\"400\" /\u003e\n\u003c/p\u003e\n\n*If you are using Analyt-MTC flow controllers, go to [this repository](https://github.com/schlenzmeister/AnalytMTC/wiki) for more info.*\n\nExample Connections\n===================\n\n| Type | Usage |\n| --- | --- |\n| The standard [DB9 cable](http://www.alicat.com/wpinstall/wp-content/uploads/2013/07/MD8DB9.jpg) connected directly to a computer (unix: `/dev/ttyS0`, windows: `COM1`). | Good with older computers that still have the connector. |\n| The cable connected to a computer through a [USB converter](https://www.amazon.com/gp/product/B0007T27H8) (unix: `/dev/ttyUSB0`, windows: `COM1`). | Good for newer computers and maker boards such as Raspberry Pis. |\n| Multiple cables connected to one port via a [splitter](https://www.amazon.com/gp/product/B007F2E188) and Alicat's addressing (`A`-`Z`). | Good when number of ports is limited. |\n| Cables routed through a [TCP device server](https://www.usconverters.com/serial-rs232-ethernet-converter) (`192.168.1.100:23`).\n\nInstallation\n============\n\n```\npip install alicat\n```\n\nUsage\n=====\n\n## Command Line\n\nFor basic tasks, this driver includes a command-line interface. Read the help\nfor more.\n\n```\nalicat --help\n```\n\n## Python\nThis uses Python ≥3.5's async/await syntax to asynchronously communicate with an Alicat. For example:\n\n```python\nimport asyncio\nfrom alicat import FlowController\n\nasync def get():\n    async with FlowController('ip-address:port') as flow_controller:\n        print(await flow_controller.get())\n\nasyncio.run(get())\n```\n\nIf the flow controller is communicating on the specified port, this should\nreturn a dictionary of the form:\n\n```python\n{\n  'setpoint': 0.0,         # Setpoint, either mass flow rate or pressure\n  'control_point': 'flow', # Either 'flow' or 'pressure'\n  'gas': 'Air',            # Can be any option in `flow_controller.gases`\n  'mass_flow': 0.0,        # Mass flow (in units specified at time of purchase)\n  'pressure': 25.46,       # Pressure (normally in psia)\n  'temperature': 23.62,    # Temperature (normally in C)\n  'total_flow': 0.0,       # Optional. If totalizer function purchased, will be included\n  'volumetric_flow': 0.0   # Volumetric flow (in units specified at time of purchase)\n}\n```\n\nOn flow controllers, you can set the flow or pressure setpoints.\n\n```python\nawait flow_controller.set_flow_rate(1.0)\nawait flow_controller.set_pressure(20)\n```\n\n### Gas Type\n\nYou can set the gas type by name or by index. For more on setting by index, see the gas table in your Alicat's manual.\n\n```python\nawait flow_controller.set_gas('N2')\nawait flow_controller.set_gas(8)\n```\n\nFor firmware 5v and greater, you can create and set gas mixes. Mixes can contain up to five gases and are stored in gas indices 236-255.\n\n```python\nawait flow_controller.create_mix(mix_no=236, name=\"Mix1\", gases={'N2': 50, 'O2': 30, 'CO2': 20})\nawait flow_controller.set_gas(236)\nawait flow_controller.delete_mix(236)\n```\n\n### PID Parameters\n\nFor flow controllers, read and write PID loop settings for device tuning.\n\n```python\nawait flow_controller.set_pid(p=4000, i=4000, d=10, loop_type='PD2I')\nprint(await flow_controller.get_pid())\n{\n    'loop_type': 'PD2I',\n    'P': '4000',\n    'I': '4000',\n    'D': '10',\n}\n```\n\n### Other Features\n\nAdditional features include override commands to increase device functionality.\n\n```python\nawait flow_controller.lock()            # Lock the front display.\nawait flow_controller.unlock()          # Unlock the front display.\nawait flow_controller.hold()            # Hold the valve in its current position.\nawait flow_controller.cancel_hold()     # Cancel the valve hold.\nawait flow_controller.tare_volumetric() # Tare volumetric flow.\nawait flow_controller.tare_pressure()   # Tare pressure.\nawait flow_controller.reset_totalizer() # Reset totalizer, if totalizer functionality included.\n```\n\n### Addressing\n\nYou can have multiple controllers on the same port by using Alicat's `A`-`Z` addresses\nand an [RS-232 splitter](https://www.amazon.com/gp/product/B007F2E188).\n\n```python\nflow_controller_1 = FlowController(address='A')\nflow_controller_2 = FlowController(address='B')\n\nawait flow_controller_1.set_flow_rate(1.0)\nawait flow_controller_2.set_flow_rate(0.5)\n\nawait flow_controller_1.close() # /dev/ttyUSB0 is still open!\nawait flow_controller_2.close()\n```\n\n### Breaking changes\n\n`0.5.0`\n- Support only `asyncio`.  The last version with synchronous code was `0.4.1`.\n- Rename `address`/`-a` to `unit`/`-u` to match Alicat's documentation\n- Rename `-u` to `-ul` (for `--unlock`)\n\n`0.4.1`\nRemove TCP support.  Use `pip install alicat==0.3.1` if needed\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnumat%2Falicat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnumat%2Falicat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnumat%2Falicat/lists"}