halkit 0.1.0__tar.gz

halkit-0.1.0/.gitignore

@@ -0,0 +1,24 @@
+.venv/
+__pycache__/
+*.pyc
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+dist/
+build/
+node_modules/
+.DS_Store
+.hypothesis/
+dashboard/dist/
+website/dist/
+website/.astro/
+.claude/
+.cache/
+
+/docs/design-rounds/
+
+/qa/
+
+/video/

halkit-0.1.0/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+Every notable change to OpenHAL is listed here. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). The package version is MAJOR.MINOR.PATCH, and the specification and the hub protocol carry MAJOR.MINOR, as [ADR 0017](docs/adr/0017-version-numbers.md) sets out.
+
+## [Unreleased]
+
+## [0.1.0] - 2026-11-05
+
+The first release. Every driver is tested on a simulator, and none is tested on real hardware yet.
+
+### Added
+
+- Specification v0.1, with the device file format (`.hal.yaml`), the hub protocol over JSON-RPC, the error registry and a conformance suite for drivers.
+- The safety kernel. Every write and action goes through the kernel, which checks units, limits, rate of change, interlocks, watchdogs, scope and confirmation before a driver acts. A driver acts only on a single-use grant for that exact command.
+- Risk levels. Each channel and action is low, medium or high risk. Low and medium targets take commands within the device's own range, and a high risk target stays read-only until a person confirms its limits.
+- One stop puts every device in its safe state, and every decision goes into a hash-chained audit log.
+- Each change that runs records the first 12 hex digits of its grant and the commands the driver sent to the device in the audit log.
+- The hub, with a REST API, the hub protocol over WebSocket and over stdio with `openhal rpc`, and an MCP server with 36 tools through `openhal mcp`.
+- The `openhal` command line. `openhal init` sets up the config folder, tokens, devices, MCP clients and the background service, and `openhal start` runs the hub.
+- `openhal demo`, an agent babysitting a 3D print on a simulated Klipper printer and camera, with no hardware and no API key. `openhal demo --full` runs the whole system with a simulated plant waterer.
+- 36 hardware drivers, from serial, Firmata and the OpenHAL Arduino library to Klipper, OctoPrint, SCPI instruments, Home Assistant, ESPHome, MQTT, Modbus, ROS 2, OPC UA, research microscopes through Micro-Manager and Ocean spectrometers through python-seabreeze. Each driver passes the conformance suite against a simulator, and none is verified on real hardware yet.
+- A MuJoCo driver that runs any MuJoCo model as a simulated device.
+- The OpenHAL Arduino library, which describes a board to the hub and offers each free pin as a channel.
+- A device library of 35 device files. Every file is unverified until a person checks the file's limits.
+- The Inspector, a browser dashboard for devices, held requests, limits and the audit log.
+- The driver writer, which drafts a device file for an unknown device, and routines and runs for timed steps.
+- The Python client, `openhal.connect` and `openhal.aconnect`.
+- One-line installers for macOS, Linux and Windows, a Raspberry Pi install script, and a background service with launchd on macOS and systemd on Linux.
+- The `halkit` command, the same CLI as `openhal`, so `uvx halkit demo` and `pipx run halkit demo` run with no clone.
+- The `/openhal` command for Claude Code. `openhal init` saves the command when init adds OpenHAL to Claude Code, and the Claude Code plugin ships the same command. A bare `/openhal` checks the connection and shows what the agent may do on each device.
+
+[Unreleased]: https://github.com/sohan-bhat/OpenHAL/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/sohan-bhat/OpenHAL/releases/tag/v0.1.0

halkit-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

halkit-0.1.0/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.5
+Name: halkit
+Version: 0.1.0
+Summary: An open-source protocol for AI agents to control hardware.
+Author: OpenHAL contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: System :: Hardware
+Requires-Python: >=3.12
+Requires-Dist: fastapi>=0.115
+Requires-Dist: httpx>=0.28
+Requires-Dist: mcp>=2.3
+Requires-Dist: pint>=0.24
+Requires-Dist: portalocker>=3.1
+Requires-Dist: prompt-toolkit>=3.0.52
+Requires-Dist: pydantic>=2.9
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: questionary>=2.1.1
+Requires-Dist: regex>=2024.11
+Requires-Dist: rich>=13.9
+Requires-Dist: typer>=0.15
+Requires-Dist: uvicorn>=0.32
+Requires-Dist: websockets>=13
+Requires-Dist: zeroconf>=0.136
+Provides-Extra: alpaca
+Requires-Dist: httpx>=0.28.1; extra == 'alpaca'
+Provides-Extra: bambu
+Requires-Dist: paho-mqtt>=2.1.0; extra == 'bambu'
+Provides-Extra: ble
+Requires-Dist: bleak>=3.0.2; extra == 'ble'
+Provides-Extra: can
+Requires-Dist: python-can>=4.6.1; extra == 'can'
+Provides-Extra: esphome
+Requires-Dist: aioesphomeapi>=46; extra == 'esphome'
+Provides-Extra: firmata
+Requires-Dist: pyserial>=3.5; extra == 'firmata'
+Provides-Extra: grbl
+Requires-Dist: pyserial>=3.5; extra == 'grbl'
+Provides-Extra: hid
+Requires-Dist: hidapi>=0.15.0; extra == 'hid'
+Provides-Extra: homeassistant
+Requires-Dist: httpx>=0.28; extra == 'homeassistant'
+Requires-Dist: websockets>=13; extra == 'homeassistant'
+Provides-Extra: http
+Requires-Dist: httpx>=0.28.1; extra == 'http'
+Provides-Extra: hub
+Provides-Extra: knx
+Requires-Dist: xknx>=4.0.0; extra == 'knx'
+Provides-Extra: marlin
+Requires-Dist: pyserial>=3.5; extra == 'marlin'
+Provides-Extra: matter
+Requires-Dist: websockets>=13; extra == 'matter'
+Provides-Extra: micromanager
+Requires-Dist: pillow>=12.0; extra == 'micromanager'
+Requires-Dist: pymmcore-plus>=0.18.1; extra == 'micromanager'
+Provides-Extra: midi
+Requires-Dist: mido>=1.3.3; extra == 'midi'
+Requires-Dist: python-rtmidi>=1.5.8; extra == 'midi'
+Provides-Extra: modbus
+Requires-Dist: pymodbus[serial]>=3.16.1; extra == 'modbus'
+Provides-Extra: moonraker
+Requires-Dist: httpx>=0.28; extra == 'moonraker'
+Requires-Dist: websockets>=13; extra == 'moonraker'
+Provides-Extra: mqtt
+Requires-Dist: paho-mqtt>=2.1.0; extra == 'mqtt'
+Provides-Extra: mujoco
+Requires-Dist: mujoco<3.11,>=3.3; (sys_platform == 'darwin' and platform_machine == 'x86_64') and extra == 'mujoco'
+Requires-Dist: mujoco>=3.3; (sys_platform != 'darwin' or platform_machine != 'x86_64') and extra == 'mujoco'
+Provides-Extra: octoprint
+Requires-Dist: httpx>=0.28; extra == 'octoprint'
+Provides-Extra: onvif
+Requires-Dist: defusedxml>=0.7.1; extra == 'onvif'
+Requires-Dist: httpx>=0.28.1; extra == 'onvif'
+Provides-Extra: opcua
+Requires-Dist: asyncua>=2.1.0; extra == 'opcua'
+Provides-Extra: openhal-firmware
+Requires-Dist: pyserial>=3.5; extra == 'openhal-firmware'
+Provides-Extra: pi-i2c-spi
+Requires-Dist: smbus2>=0.6.1; extra == 'pi-i2c-spi'
+Requires-Dist: spidev>=3.8; (sys_platform == 'linux') and extra == 'pi-i2c-spi'
+Provides-Extra: pylabrobot
+Requires-Dist: pylabrobot>=0.2.2; extra == 'pylabrobot'
+Provides-Extra: ros2
+Requires-Dist: websockets>=13; extra == 'ros2'
+Provides-Extra: rpi-camera
+Provides-Extra: rpi-gpio
+Requires-Dist: gpiozero>=2.0.1; extra == 'rpi-gpio'
+Provides-Extra: scpi
+Requires-Dist: pyserial>=3.5; extra == 'scpi'
+Requires-Dist: pyusb>=1.3; extra == 'scpi'
+Requires-Dist: pyvisa-py>=0.8; extra == 'scpi'
+Requires-Dist: pyvisa>=1.16; extra == 'scpi'
+Provides-Extra: seabreeze
+Requires-Dist: pillow>=12.0; extra == 'seabreeze'
+Requires-Dist: seabreeze[pyseabreeze]>=2.11.0; extra == 'seabreeze'
+Provides-Extra: serial
+Requires-Dist: pyserial>=3.5; extra == 'serial'
+Provides-Extra: sila2
+Requires-Dist: sila2>=0.14.0; extra == 'sila2'
+Provides-Extra: upnp
+Requires-Dist: async-upnp-client>=0.49.0; extra == 'upnp'
+Provides-Extra: uvc
+Requires-Dist: opencv-python-headless>=5.0.0.93; extra == 'uvc'
+Provides-Extra: zigbee-zwave
+Requires-Dist: paho-mqtt>=2.1.0; extra == 'zigbee-zwave'
+Requires-Dist: websockets>=13; extra == 'zigbee-zwave'
+Description-Content-Type: text/markdown
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="docs/assets/wordmark-dark.svg">
+  <img alt="OpenHAL" src="docs/assets/wordmark-light.svg" height="44">
+</picture>
+
+An open-source protocol for AI agents to control hardware.
+
+[![License](https://img.shields.io/github/license/sohan-bhat/OpenHAL?color=555)](LICENSE) [![CI](https://img.shields.io/github/actions/workflow/status/sohan-bhat/OpenHAL/ci.yml?branch=main&label=CI)](https://github.com/sohan-bhat/OpenHAL/actions/workflows/ci.yml)
+
+<!-- demo-gif:start -->
+<!-- demo-gif:end -->
+
+<picture>
+  <source media="(max-width: 600px) and (prefers-color-scheme: dark)" srcset="docs/diagrams/flow-narrow-dark.svg">
+  <source media="(max-width: 600px)" srcset="docs/diagrams/flow-narrow-light.svg">
+  <source media="(prefers-color-scheme: dark)" srcset="docs/diagrams/flow-dark.svg">
+  <img src="docs/diagrams/flow-light.svg" width="900" alt="OpenHAL flow. An agent sends hal/write to the hub. The safety kernel checks the command against the device file's limits. An allowed command gets a grant and goes through the driver to the 3D printer, and the reading comes back to the agent. Because the nozzle limit is 260 °C, a request for a nozzle temperature of 300 °C is blocked with LIMIT_EXCEEDED.">
+</picture>
+
+## Install
+
+<!-- install:start -->
+On macOS and Linux, run this command in a terminal.
+
+```text
+curl -LsSf https://sohanbhat.me/OpenHAL/install.sh | sh
+```
+
+On Windows, run this command in PowerShell.
+
+```text
+irm https://sohanbhat.me/OpenHAL/install.ps1 | iex
+```
+<!-- install:end -->
+
+<!-- demo:start -->
+Then run the demo. The demo uses simulated devices, so nothing touches real hardware.
+
+```text
+openhal demo
+```
+<!-- demo:end -->
+
+<!-- outcome:start -->
+You'll see the agent raise the bed target from 60 °C to 70 °C, have a request for a nozzle temperature of 300 °C blocked at the nozzle limit of 260 °C and pause the print when the camera shows the print has come loose. The owner then approves the cancel, and the printer's state becomes cancelled.
+<!-- outcome:end -->
+
+OpenHAL runs on Python 3.12 or newer. [The install guide](docs/guide/install.md) covers uv, pipx, a clone, the background service and Raspberry Pi.
+
+## Why OpenHAL
+
+Agents usually reach each printer or lab instrument through a script or MCP server made for that one device, with the limits in that server's code. OpenHAL is a universal driver specification instead. Agents discover, integrate and control lab and manufacturing equipment through one standard set of commands such as `read` and `write`, and every command is checked against the device's limits.
+
+## How it works
+
+- A `.hal.yaml` device file lists a device's channels and actions, with units and limits.
+- The safety kernel checks range, rate, interlocks and confirmation before a driver acts. A command outside the limits is blocked with an error such as `LIMIT_EXCEEDED`.
+- One driver covers a device family, such as SCPI for bench instruments.
+- Agents connect over MCP, the CLI or the Python client, and the protocol is JSON-RPC 2.0 over WebSocket and stdio.
+
+## Safety model
+
+- Every channel and action has a risk level of low, medium or high. A device file's `hazard` sets the minimum level for every channel and action on the device.
+- High risk channels and actions stay read-only until a person confirms the limits. An agent's proposal never counts as a confirmation.
+- Low and medium channels and actions take commands within the device's own range. Only a person lowers a level, with `openhal risk set`.
+- Each hardware change needs a single-use grant for that exact command.
+- A stale or missing reading blocks the command.
+- One stop puts every device in a safe state until a person lifts the stop.
+- Every decision goes into a hash-chained audit log.
+
+[docs/SAFETY.md](docs/SAFETY.md) has the details.
+
+## Supported devices
+
+OpenHAL has 36 drivers. Every driver passes the conformance suite on a simulator, and none is verified on real hardware yet. No driver covers clinical or patient-connected medical devices. To test a device you own, follow [the hardware test plans](docs/hardware-tests/README.md). [The device library](library/README.md) lists the bundled device files.
+
+<details>
+<summary>All 36 drivers</summary>
+
+<!-- devices:start -->
+| Driver | Devices covered | Status | Usual hazard |
+|---|---|---|---|
+| `ble` | environmental sensors, battery powered sensors, BLE LED and relay boards | tested on simulator | low |
+| `esphome` | ESP32, ESP8266, RP2040 and BK72xx boards running ESPHome, sensors, switches, lights, fans, numbers, selects and buttons defined in ESPHome YAML | tested on simulator | low |
+| `firmata` | Arduino AVR boards, Arduino-compatible clones, Teensy | tested on simulator | low |
+| `hid` | macropads and button boxes, knobs and jog wheels, foot switches | tested on simulator | low |
+| `homeassistant` | lights, switches and smart plugs, fans | tested on simulator | low |
+| `http` | smart plugs and relays, networked sensors, lab and bench gadgets with REST APIs | tested on simulator | medium |
+| `marlin` | FDM 3D printers, pen plotters and other Marlin machines | tested on simulator | medium |
+| `midi` | pad and knob controllers, keyboards, synthesizers | tested on simulator | low |
+| `modbus` | energy and power meters, PLCs, variable frequency drives | tested on simulator | medium |
+| `moonraker` | Klipper 3D printers (Voron, RatRig, Creality K1 and Sonic Pad, Sovol SV08, Elegoo Neptune 4, Qidi) | tested on simulator | medium |
+| `mqtt` | Tasmota devices, Zigbee2MQTT bridged devices, ESPHome and Shelly devices with MQTT enabled | tested on simulator | medium |
+| `octoprint` | 3D printers connected to OctoPrint (Marlin, Prusa, RepRapFirmware and Klipper with the OctoPrint connector) | tested on simulator | medium |
+| `openhal-firmware` | Arduino boards, ESP32 boards, maker projects that run the OpenHAL library | tested on simulator | low |
+| `rpi-camera` | Raspberry Pi Camera Module 1, 2 and 3, Raspberry Pi High Quality and Global Shutter cameras, Raspberry Pi AI Camera | tested on simulator | low |
+| `rpi-gpio` | relays and relay boards, LEDs, buttons, reed switches and limit switches | tested on simulator | low |
+| `scpi` | bench power supplies, multimeters, oscilloscopes | tested on simulator | medium |
+| `serial` | Arduino and other microcontroller sketches, bench instruments with ASCII command sets, sensor modules with text output | tested on simulator | medium |
+| `uvc` | USB webcams, USB microscopes, HDMI to USB capture cards | tested on simulator | low |
+| `alpaca` | telescope mounts, focusers, cameras and power boxes, observatory domes | tested on simulator | medium |
+| `grbl` | desktop CNC routers, diode and CO2 laser engravers, pen plotters | tested on simulator | high |
+| `indi` | telescope mounts, focusers, astronomy cameras | tested on simulator | medium |
+| `lerobot` | SO-100 and SO-101 arms, Koch and OMX arms, other LeRobot arms with joint goals | tested on simulator | high |
+| `micromanager` | research microscopes from Nikon, Zeiss, Olympus and Leica, scientific cameras from Hamamatsu, Andor, Photometrics and PCO, stages, focus drives, filter wheels, shutters and light sources from ASI, Prior, Ludl, Sutter, Lumencor and CoolLED | tested on simulator | medium |
+| `onvif` | ONVIF IP cameras, ONVIF PTZ cameras, network video recorders with ONVIF | tested on simulator | low |
+| `opcua` | PLCs with an OPC UA server, LADS lab instruments, process equipment and gateways | tested on simulator | medium |
+| `pylabrobot` | Hamilton STAR and STARlet, Tecan Freedom EVO, Opentrons OT-2 | tested on simulator | high |
+| `ros2` | ROS 2 mobile robots, ROS 2 arms, any ROS 2 graph with rosbridge | tested on simulator | high |
+| `seabreeze` | Ocean Insight and Ocean Optics USB spectrometers (USB2000+, USB4000, Flame), Ocean HR, QE Pro and Maya spectrometers, Ocean STS and SPARK spectrometers | tested on simulator | low |
+| `sila2` | SiLA 2 lab devices, SiLA 2 gateways, custom SiLA 2 servers | tested on simulator | medium |
+| `bambu` | Bambu Lab X1 series, Bambu Lab P1 series, Bambu Lab A1 and A1 mini | tested on simulator | medium |
+| `can` | motor controllers (VESC, ODrive, CubeMars), battery management systems, CAN sensor and IO nodes | tested on simulator | medium |
+| `knx` | KNX switch and dimmer actuators, KNX blind actuators, KNX room thermostats | tested on simulator | low |
+| `matter` | Matter lights and plugs, Matter sensors, Matter thermostats and fans | tested on simulator | low |
+| `pi-i2c-spi` | I2C temperature and humidity sensors, SPI and I2C ADCs, SPI and I2C DACs | tested on simulator | low |
+| `upnp` | UPnP AV media renderers and speakers, smart TVs with DLNA rendering, internet gateways (IGD) | tested on simulator | low |
+| `zigbee-zwave` | Zigbee lights, plugs and sensors, Z-Wave switches, dimmers and plugs, Z-Wave multisensors | tested on simulator | low |
+<!-- devices:end -->
+
+</details>
+
+## Connect Claude or another MCP client
+
+`openhal init` sets up the hub, makes a token and offers to add OpenHAL to Claude Desktop, Claude Code and Cursor. The setup for every client is printed either way.
+
+```text
+openhal init
+openhal start
+```
+
+Any other MCP client runs `openhal mcp` over stdio with a separate agent token, as [the MCP guide](docs/interfaces/MCP.md) shows. [Connect Claude](docs/guide/tutorials/connect-claude.md) covers the manual setup.
+
+## Docs and specification
+
+- [Documentation](https://sohanbhat.me/OpenHAL/docs/)
+- [Specification](https://sohanbhat.me/OpenHAL/spec/), also in [spec/](spec/SPEC.md)
+- [The demo step by step](docs/QUICKSTART.md), with the simulated [printer and camera](examples/print-babysitter/)
+- [Mapping to Anthropic's MHS](spec/MHS-MAPPING.md). OpenHAL is not affiliated with Anthropic or the Model Hardware Standard.
+
+## Contributing
+
+Drivers, device files, hardware test reports and docs fixes are welcome. See [CONTRIBUTING.md](.github/CONTRIBUTING.md), [the driver guide](docs/drivers/WRITING-A-DRIVER.md) and issues labeled [good first issue](https://github.com/sohan-bhat/OpenHAL/labels/good%20first%20issue). Report security or safety problems privately through [SECURITY.md](.github/SECURITY.md).
+
+## License
+
+Apache-2.0, in [LICENSE](LICENSE). Device files in `library/` are CC0.