Upgrading to 3.0
BenchPod 3.0 moves the wiring profiles onto the pod, wires nothing by default and gives every refusal a stable error code. Most benches need one step: save the bench's wiring on the pod once.
The releases
| Part | Version | How to update |
|---|---|---|
| Pod firmware | 3.10.8 | benchpod flash-self, or the firmware update in the web app |
Python SDK (embeddedci) | 3.0.0 | pip install -U "embeddedci[pytest]" |
MCP server (embeddedci-mcp) | 3.0.0 | uvx embeddedci-mcp picks it up; update the Claude or Codex plugin |
CLI (benchpod) | 0.9.0 | brew upgrade --cask benchpod |
OpenHTF plug (embeddedci-openhtf) | 2.4.0 | pip install -U embeddedci-openhtf |
Update the pod's firmware first (see Updating the firmware), then the tools. The 3.0 tools also work with older firmware: that firmware keeps no profiles on the pod, so they use the profile on embeddedci.com, as before.
What changed
- Wiring profiles live on the pod (firmware 3.10.8): up to 16 named profiles of at most 4096 bytes each, one of them the default. The SDK, the CLI, the MCP server and the web app see the same ones over the LAN, USB and the cloud, signed in or not. embeddedci.com only mirrors them and keeps their history.
- Every connection loads a profile: the one it names (
wiring_profile=,BENCHPOD_WIRING_PROFILE,--benchpod-wiring-profile, the CLI's--wiring-profile, the MCPconnect(wiring_profile=...)), else the pod's default. - Saving is always explicit:
bp.save_wiring(profile=None, name=None),benchpod wiring save, the MCPsave_wiring. Saving never changes the default (set_default_wiringdoes). The MCPset_wiringchanges only the connection unlesssave=trueor the server runs with--wiring-autosave, and its result lists theunsaved_changes. Autosave never stores a change of the I/O voltage, the rail or the SWD target. - Nothing is wired by default (schema version 2): a pin, I/O voltage or power rail that is not in the profile is undefined, and a call that needs it says which to pass. The old built-in values are the preset
Wiring.preset("embeddedci-reference"). Plain call defaults remain: UART at 115200 baud, no reset line, SWD targetauto. power_onapplies the profile first: its I/O voltage, then its rail, and the pod records which profile powered the board. The web app's power control shows that profile and lets you pick one. The I/O voltage is set at DUT power-on, never when the pod boots.- Error codes: refusals carry a stable code (
BP0001and up). See Error codes, or runbenchpod explain BP0009.
1. Save the bench's wiring once
A pod that is registered on embeddedci.com gets its profile from embeddedci.com copied onto the pod the first time it connects with firmware 3.10.8, as default (or from-cloud when the pod already has a profile of its own). Check with benchpod wiring list or the web app's Pins pane. A pod with no profile yet needs one saved. From Python:
from embeddedci.benchpod import BenchPod, Wiring
with BenchPod("192.168.1.213") as bp:
print(bp.wiring_profiles()) # what the pod has, and its default
# A bench wired like the EmbeddedCI reference bench (UART LA5/LA4, I2C LA1/LA2,
# SWD LA11/LA12, 3.3 V, Internal 5 V): store those values once.
bp.save_wiring(Wiring.preset(), name="default")Or with the CLI:
# A wiring file you already have (the Pins pane's Copy as JSON gives one):
benchpod wiring save wiring.json --name default
# The reference bench: a version 1 file fills in its values for what it leaves out.
echo '{"version": 1}' > reference.json
benchpod wiring save reference.json --name default
benchpod wiring list # * marks the defaultThe first profile saved on a pod becomes its default. For a second board on the same bench, save it under its own name (bp.save_wiring(name="k66")) and pick it per run with wiring_profile="k66", or make it the default with bp.set_default_wiring("k66").
2. Check your scripts and tests
- A script that relied on the default pins (for example
bp.flash()with noswclk/swdioon a pod with no profile) now raises and names the missing pin. Save the wiring (step 1), or pass the pins orwiring=. power_on()withoutefuseneeds a rail in the profile. So does thebenchpod_targetfixture without--benchpod-efuse, and an OpenHTF plug without a profile needsefuse=for its power calls.Wiring.la_voltage,.efuseand.i2c_addresscan beNone.- Match refusals on
exc.code, not on the message text. - A wiring file without a
version(or with version 1) still means what it did: what it leaves out takes the reference bench's values.benchpod wiring upgrade wiring.jsonrewrites it as version 2 with those values written out.Wiring.defaults()still returns the reference preset.
Before and after:
# 2.x: no profile anywhere, so the built-in pins and rail applied
bp.flash(file="app.elf", target="target/stm32f4x.cfg")
bp.power_on()
try:
uart = bp.open_uart()
except FirmwareError as exc:
if "pin conflict" in str(exc): # matched on the message text
...# 3.0: pass what the profile does not set (or save it in the profile once)
bp.flash(file="app.elf", target="target/stm32f4x.cfg", swclk=11, swdio=12)
bp.power_on(efuse=1) # or a profile with "efuse": 1
if bp.wiring.la_voltage is None: # la_voltage, efuse and i2c_address can be None
bp.set_la_voltage(3.3)
try:
bp.save_wiring()
except FirmwareError as exc:
if exc.code == "BP0009": # match on the stable code
bp.load_wiring()3. AI agents
With embeddedci-mcp 3.0 an agent's set_wiring changes only its own connection. Once the wiring works on the board, the agent asks you whether to save it, and under which name for another board. To keep the old behavior of saving every change, start the server with --wiring-autosave (or set BENCHPOD_WIRING_AUTOSAVE=1). See The wiring profile on the MCP page.