The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the EmbeddedCI BenchPod listing page.
Python packages for driving an EmbeddedCI BenchPod — a hardware-in-the-loop (HIL) tester that powers a target board, flashes it over SWD, talks to its UART, I2C and CAN, and drives and measures its analog and logic signals — from pytest, from an AI agent, or from OpenHTF.
| Package | Path | What it is |
|---|---|---|
embeddedci | packages/embeddedci/ | The BenchPod SDK and pytest plugin: from embeddedci.benchpod import BenchPod. Connects over the network, USB or the cloud (embeddedci:<device-name>, with an API key or GitHub Actions OIDC). |
embeddedci-mcp | packages/embeddedci-mcp/ | An MCP server exposing the SDK as typed tools, so AI agents can drive the bench. |
embeddedci-openhtf | packages/embeddedci-openhtf/ | An OpenHTF plug and phase helpers for driving a pod directly over TCP or serial. |
The dependency direction is strictly embeddedci-mcp → embeddedci and
embeddedci-openhtf → embeddedci. All three live here so an SDK change and the matching
wrapper land in one commit; each is published to PyPI on its own tag.
All three packages are on the 2.x line, the first with a stability promise:
embeddedci: everything in embeddedci.benchpod.__all__ follows semantic versioning. Units are
volts, seconds and hertz; invalid arguments raise ValueError; device state comes back typed.
tests/api_surface.json snapshots the public surface.embeddedci-mcp: tool names, input schemas and annotations are frozen for 2.x
(tests/tools_surface.json).embeddedci>=2.0,<3.The surface snapshot tests fail on any change. When a change is intended and compatible (an addition), refresh them deliberately:
Migration notes: embeddedci, embeddedci-mcp, embeddedci-openhtf.
Python 3.10+.
Hardware tests skip without a pod. To run them against one:
The board's I/O voltage (3.3 V) is set once in packages/embeddedci/tests/conftest.py; change it
there for a 1V8 board.
See packages/embeddedci-mcp/README.md for client
configuration and the tool list.
Each package publishes from its own tag (embeddedci-v*, embeddedci-mcp-v*,
embeddedci-openhtf-v*) via .github/workflows/publish.yml; the tag must match the version in
that package's pyproject.toml. Release embeddedci first — the other two depend on it from PyPI.
packages/embeddedci-py39-shim is published into the same PyPI project as embeddedci 0.2.4,
from the embeddedci-py39-shim-v* tag. It exists because 2.x requires Python 3.10+: on 3.9 pip
skips 2.x and would otherwise resolve to the last 3.9-compatible release (0.2.3), silently handing
the user a pre-2.0 API. Yanking the 0.x releases does not fix that — pip's install path passes
allow_yanked=True and only deprioritises yanked candidates, so when they are the only candidates
it installs one anyway. The placeholder pins requires-python = ">=3.9,<3.10", so on 3.9 it is the
newest installable version and its import fails with an actionable message, while 3.10+ resolution
is untouched.
It is excluded from the uv workspace ([tool.uv.workspace] exclude) because it declares the same
package name as packages/embeddedci, and its tag pattern deliberately does not start with
embeddedci-v so the main publish job cannot fire on it.