Skip to main content

Agent-driven IoT device design tool that produces ESPHome YAML.

Project description

wirestudio

Agent-driven IoT device design tool. Describe a goal (or pick parts); get ESPHome YAML, an ASCII wiring diagram, and a BOM that compile under upstream ESPHome.

Two LoRaWAN paths share the studio. The standalone target builds and flashes RadioLib + LoRaWAN_ESP32 firmware over WebSerial. The newer external-component path emits ESPHome YAML referencing lorawan-for-esphome, so the LoRaWAN device joins the same ESPHome / fleet-for-esphome build pipeline as every other device — provisioning, key handling, and join-status polling all from the web UI. Both paths target US915 radio boards (TTGO T-Beam / LoRa32, Heltec WiFi LoRa 32 V2 / V3) and provision against ChirpStack.

Produces ESPHome configs but is not affiliated with the ESPHome project — see weirded/fleet-for-esphome for the OTA-deploy companion this studio's Push to fleet flow talks to.

Documentation

Detailed docs live in docs/:

Status

v0.17.1 — on PyPI (pip install wirestudio). The studio has wide surface area (YAML, schematic, enclosure, agent, MCP server, fleet handoff, web UI, two LoRaWAN flash/provision paths — standalone Arduino and an external-component path that emits ESPHome YAML referencing lorawan-for-esphome) and a set of things actually verified against upstream tools. Three of the four priority tiers (YAML, wiring schema, enclosure) are now gated in CI, and every library component and board is exercised by a bundled example that passes those gates. This section is honest about which is which, ordered by how much it matters that it works.

Tiers, in priority order:

Tier Area What it does Verified by
Verified ESPHome YAML production render design.json → ESPHome YAML esphome config passes on every bundled example, every PR (gate); nightly esphome compile smoke against a representative example (compile)
Verified CSP pin solver + compat checker assign legal pins, surface boot-strap / ADC2-WiFi / voltage / locked-pin issues unit tests + property checks in tests/test_pin_solver.py + tests/test_compatibility.py
Verified Fleet handoff push YAML to fleet-for-esphome ha-addon, optional compile + log relay round-trip tests in tests/test_fleet.py
Verified KiCad schematic emit a SKiDL Python script the user runs locally to produce a .kicad_sch every bundled example builds a KiCad netlist against the pinned upstream symbol libraries, every PR (gate) — no unresolved symbols or pins. Parts KiCad ships no symbol for (sensor/module breakouts) render as labeled generic headers
Verified Parametric enclosure OpenSCAD .scad from board mount-hole metadata every enclosure-capable board renders through real OpenSCAD to a non-empty, manifold (closed, printable) solid, every PR (gate)
Works (hardware-validated) LoRaWAN target build RadioLib + LoRaWAN_ESP32 firmware for US915 radio boards, flash over WebSerial, provision against ChirpStack every radio board's firmware builds in CI (gate); validated end-to-end on a TTGO T-Beam against live ChirpStack 4.17 — no automated live-device gate
Works (lighter checks) MCP server drive the design tools from Claude Code / Desktop over the Model Context Protocol tool / auth / resource tests in tests/test_mcp_*.py; not exercised against a live MCP client in CI
Experimental Thingiverse search relay rank community models for a board smoke-tested; depends on a third-party search API that ranks unevenly
Experimental Agent (Claude tool-using) natural-language design driving works in practice; tool surface is small; no auto-eval against task list yet
Deferred KiCad PCB layout Freerouting + Gerber + JLCPCB CPL/BOM 1.0+, not started

The Verified tier is the bar the project is asking to be judged on. Everything else is offered with the caveat that's spelled out in the table.

See CONTRIBUTING.md for the bar a change has to clear before merging, CHANGELOG.md for per-release deltas, and START.md for the longer-form design notes.

Tested against ESPHome ==2025.12.7 (pinned in .github/workflows/esphome-config.yml + bumped deliberately). When that pin moves, this line moves with it.

Quickstart

Docker

docker run --rm -p 8765:8765 \
  -e ANTHROPIC_API_KEY=sk-ant-... \
  -v wirestudio-data:/data \
  ghcr.io/moellere/wirestudio:v0.17.1

Open http://localhost:8765. The image bundles the FastAPI server + the built web UI in one process. See Deployment for image tags, env vars, and the Kubernetes manifest.

CLI

pip install wirestudio                       # from PyPI
# ...or, for a dev checkout:  pip install -e .[dev]
python -m wirestudio.generate wirestudio/examples/garage-motion.json

Prints rendered YAML and the ASCII wiring block to stdout.

HTTP API

python -m wirestudio.api                    # localhost:8765
python -m wirestudio.api --reload           # dev mode (auto-reload on edits)

Browse the auto-generated OpenAPI docs at http://127.0.0.1:8765/docs. The agent, fleet handoff, and MCP surfaces are each gated by an env var — see Integrations.

Web UI (dev)

# In one terminal:
python -m wirestudio.api
# In another:
cd web && npm install && npm run dev

Open http://localhost:5173; Vite proxies /api/* to the studio API. The User guide walks the panes and header actions.

Tests

python -m pytest                          # ~680 cases
python -m ruff check .                    # lint
cd web && npx vitest run                  # vitest + jsdom
pip install 'esphome==2025.12.7'
python scripts/check_examples.py          # the YAML gate -- every example through `esphome config`

The esphome config gate is the headline test: it renders every bundled example through the studio and runs upstream ESPHome's own validator against the output. The GitHub Actions workflow runs the YAML gate + the full suite + multi-arch image build on every PR and merge to main. A nightly compile-smoke runs esphome compile against a representative example. To run the gate before every push:

pip install pre-commit
pre-commit install --hook-type pre-push

Contributing

CONTRIBUTING.md is the substantive bar — what "working" means for the artifacts the studio produces, including the esphome config gate every PR has to clear. CLAUDE.md covers the prose / commit / comment conventions (concise, no emojis, default-to-no-comments, boundary-only validation, no premature abstraction).

License

MIT. See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wirestudio-0.17.3.tar.gz (331.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wirestudio-0.17.3-py3-none-any.whl (364.2 kB view details)

Uploaded Python 3

File details

Details for the file wirestudio-0.17.3.tar.gz.

File metadata

  • Download URL: wirestudio-0.17.3.tar.gz
  • Upload date:
  • Size: 331.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for wirestudio-0.17.3.tar.gz
Algorithm Hash digest
SHA256 e00c8d747e90075a0b163de5cbc1ff0aa3f2ecf40f59993bcfb5fe85109ac031
MD5 a73e03d3516d110c648b812e399fd8cc
BLAKE2b-256 fd6a156c6563fd8ab05428a3adcf235efa3abca32027e73de7e396718506dda5

See more details on using hashes here.

Provenance

The following attestation bundles were made for wirestudio-0.17.3.tar.gz:

Publisher: release.yml on moellere/WireStudio

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file wirestudio-0.17.3-py3-none-any.whl.

File metadata

  • Download URL: wirestudio-0.17.3-py3-none-any.whl
  • Upload date:
  • Size: 364.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for wirestudio-0.17.3-py3-none-any.whl
Algorithm Hash digest
SHA256 688ac194d45eab7a2f9be8c84a529f03b367451809a47fca61df91ee460e6b38
MD5 77599733c561240adee88caaed4fd306
BLAKE2b-256 4f6b362e28edcc0fe431889951ccbd4ffbbdc598f1372d3e169828cee8b66f01

See more details on using hashes here.

Provenance

The following attestation bundles were made for wirestudio-0.17.3-py3-none-any.whl:

Publisher: release.yml on moellere/WireStudio

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page