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.

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.11.0 — on PyPI (pip install wirestudio). The studio has wide surface area (YAML, schematic, enclosure, agent, MCP server, fleet handoff, web UI) and a narrow set of things actually verified against upstream tools. 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
Works (lighter checks) KiCad schematic emit a SKiDL Python script the user runs locally unit tests assert the script is well-formed Python with expected nets; not verified by opening in KiCad
Works (lighter checks) Parametric enclosure OpenSCAD .scad from board mount-hole metadata unit tests + manual-print iteration; not verified by an OpenSCAD parser in CI
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.11.0

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                          # ~440 cases, ~20s
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.11.0.tar.gz (208.5 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.11.0-py3-none-any.whl (240.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for wirestudio-0.11.0.tar.gz
Algorithm Hash digest
SHA256 0215a40c89e0c3a3030fc43818eedad2a47f394286d02f1da570cb040ad9e431
MD5 7306eda9a960cb4f91df32aeaa0bd9f6
BLAKE2b-256 5386f5a997c4884c99128a72a9eaeaac5fb41ee7bf9e5c946f622706bdcf2400

See more details on using hashes here.

Provenance

The following attestation bundles were made for wirestudio-0.11.0.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.11.0-py3-none-any.whl.

File metadata

  • Download URL: wirestudio-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 240.0 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.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9ecb5255fc1cab232cd25aeea033a6342af8daa5b92a9fdbc009affc2131f45f
MD5 03eed011b02068250fefa177ab5a836e
BLAKE2b-256 1774d7346fed7283b5a492c76b4bbf506eb098cf36f6fe1f8063c8297495530f

See more details on using hashes here.

Provenance

The following attestation bundles were made for wirestudio-0.11.0-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