Skip to main content

Open-source Python SDK for Atech motherboards: catalog, codegen, build, flash, and runtime control.

Project description

atech

The open-source way to write firmware for Atech boards — designed for humans + coding agents working together.

You have an Atech motherboard and you want it to do something. With this SDK installed, you can ask Claude Code (or any coding agent that can run Python) — "make my board light up red when the button is pressed" — and the agent has everything it needs: a catalog of available modules, the public API of each driver, deterministic codegen, a real compiler, and an upload command. No cloud account, no AI prompts in the SDK, no proprietary glue.

What is atech?

A pip-installable kit that turns a plain-language idea into working firmware on an Atech ESP32-S3 board — no electronics knowledge, pin maps, or C++/PlatformIO setup required. The compiler is bundled, so one pip install both builds and flashes, fully offline.

The intended flowa person describes what they want; their coding agent writes a tiny spec plus a small behaviour snippet; the SDK deterministically compiles and flashes it. The split is deliberate:

  • The agent understands intent and writes the behaviour (a few lines of C++), using each module's published API — which it discovers, never guesses.
  • The SDK does everything mechanical: pin allocation, driver assembly, main.cpp generation, compiling, flashing — identical every time, no LLM in that path.
You: "make a lamp shine green on port 3"
 → agent: list-modules → reads neopixel API → writes project.yaml
 → atech validate → atech build → atech upload  →  green lamp 🟢

You can also drive it yourself: write the project.yaml (or the Python Project builder) and run the CLI.

What you can do with it

Discover hardware atech list-boards, atech list-modules, get_module(id).usage
Describe a project a small project.yaml (board + modules on ports + behaviour)
Validate / build / flash atech validateatech buildatech upload
Talk to the board atech monitor / board.events(), atech send / board.send()
Diagnose & recover atech check (why didn't it work?), atech free-port

In the catalog today: 2 boards (8port, 14port) and 9 modules — button, rotary_encoder, pir, aht20 (temp/humidity), neopixel, st7735_tft (colour display), speaker, dc_motor, stepper_motor. Run atech list-modules for the live list. How the board communicates is in COMMUNICATION.md.

Install

pip install atech
# or
uv add atech

PlatformIO is pulled in as a dep, so a single install builds and flashes.

What it gives a coding agent

A coding agent working in a user's repo gets four things:

  1. A discoverable catalog of bundled modules with rich metadata.

    atech list-modules
    atech list-modules --category sensor
    python -c "from atech import get_module; print(get_module('button').usage)"
    

    Each module's usage: field is a short C++ snippet showing the public API — no need for the agent to grep through driver headers.

  2. A small declarative project format (project.yaml) that the agent writes or edits directly:

    name: my_thing
    board: 8port
    modules:
      - {id: button,   instance: btn, port: 3}
      - {id: neopixel, instance: led, port: 4}
    code:
      loop: |
        if (btn.wasPressed()) { led.setAll(255, 0, 0); led.show(); }
    
  3. Mechanical, deterministic codegen. atech build turns the YAML into a vanilla PlatformIO project, compiles it, and produces a firmware.bin. No LLM in this path — the agent owns the behavior, the SDK owns the plumbing.

  4. An upload + monitor flow that doesn't require the user to know PlatformIO internals: atech upload / atech monitor.

60-second example

atech new thermo --board 8port
cd thermo
# Tell Claude (or write yourself):
#   "edit project.yaml to add a button on port 3 and a neopixel on port 4,
#    and in code.loop, cycle the neopixel through six colours on each press"
atech validate .
atech build .
atech upload .

Or, fully programmatic:

from atech import Project

(
    Project(board="8port", name="thermo")
        .add("button",   port=3, instance="btn")
        .add("neopixel", port=4, instance="led")
        .set_loop("""
            if (btn.wasPressed()) {
                static uint8_t hue = 0;
                hue += 60;
                led.setAll(hue, 0, 255 - hue);
                led.show();
            }
        """)
        .build()
        .upload()
)

Bringing your own module

If the bundled catalog doesn't cover what the user has, drop a folder next to project.yaml:

my_project/
├── project.yaml          # add `modules_path: ./my_modules`
└── my_modules/
    └── lidar_v2/
        ├── module.yaml   # id, templates, usage, lib_deps
        ├── lidar_v2.h
        └── lidar_v2.cpp

Same shape as the SDK's src/atech/catalog/data/modules/ tree. The SDK merges your modules with the bundled catalog at build time; you never have to fork.

The full Python API

import atech

# Discovery — what the agent should call first
atech.list_boards()
atech.list_modules(category="sensor")
atech.get_board("8port")
atech.get_module("button").usage     # C++ snippet showing the public API

# Project assembly
p = atech.Project(board="8port", name="weather")
p.add("button", port=3, instance="btn")
p.add("dc_motor", ports=(1, 2))            # double-width = adjacent pair
p.set_setup("Serial.println(\"booting\");")
p.set_loop("if (btn.wasPressed()) { Serial.println(\"hi\"); }")
p.use_modules_from("./my_modules")          # custom catalog directory
p.validate()                                # -> list[PlacementIssue]
p.describe()                                # human/agent summary + per-module usage
p.generate(out_dir="./build")               # -> Path to PlatformIO tree
p.build()                                   # -> BuildResult
p.upload(port="/dev/ttyACM0")               # -> UploadResult
p.to_yaml(); atech.Project.from_yaml(text); atech.Project.load(path)

# Runtime — after flashing
with atech.Board.connect() as board:
    for ev in board.events():
        print(ev.key, ev.value)
    board.send("led", {"r": 255, "g": 0, "b": 0})

How the board talks to your computer — the event/action model, the exact wire format, and the USB-Serial path — is in COMMUNICATION.md.

CLI

atech list-boards
atech list-modules [--category X]
atech new <name> --board <id>          # scaffolds project.yaml + README
atech validate [project-dir]
atech build    [project-dir]
atech upload   [project-dir] [--port X]

atech ports                            # candidate USB devices
atech monitor  [--port X] [--type T,T] [--key K,K] [--json]
atech send <key> <value> [--port X]

How a coding agent should drive it

CLAUDE.md — drop a copy into your project root and your coding agent will follow it. It covers: how to discover modules, how to write the code: block, what not to do (invent modules, skip validation, hand-edit generated files, use delay() in the loop).

Architecture (short version)

┌────────────────────────────────────────────────────────────────────┐
│ atech.Project          ← agent assembles a hardware spec           │
├────────────────────────────────────────────────────────────────────┤
│ atech.placement        ← validates adjacency / reserved / overlap  │
│ atech.catalog          ← bundled + user-authored modules           │
│ atech.codegen          ← deterministic template stitching          │
│ atech.build / upload   ← `pio run` wrappers                        │
├────────────────────────────────────────────────────────────────────┤
│ atech.runtime.Board    ← serial client for the flashed board       │
└────────────────────────────────────────────────────────────────────┘
            │                                       │
       PlatformIO                              pyserial
            │                                       │
        ESP32 flash                          ESP32 USB-CDC

The closed Atech hosted product imports this SDK and layers AI module selection, OTA, sharing, and signing on top. The open SDK is everything needed to build firmware locally; nothing in this package phones home.

Status

v1.0.0a1 — alpha. Two boards (8port, 14port) and nine bundled modules: button, rotary_encoder, pir (motion), aht20 (temp/humidity), neopixel, st7735_tft (colour display), speaker (I2S audio), dc_motor, and stepper_motor. More ship through the catalog as they're ported in — run atech list-modules for the live list. The runtime serial API is stable and preserves the v0.1.x surface under atech.runtime.

See PRD.md and IMPLEMENTATION_PLAN.md for the longer story.

License

MIT.

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

atech-1.0.0a4.tar.gz (66.2 kB view details)

Uploaded Source

Built Distribution

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

atech-1.0.0a4-py3-none-any.whl (90.7 kB view details)

Uploaded Python 3

File details

Details for the file atech-1.0.0a4.tar.gz.

File metadata

  • Download URL: atech-1.0.0a4.tar.gz
  • Upload date:
  • Size: 66.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.5

File hashes

Hashes for atech-1.0.0a4.tar.gz
Algorithm Hash digest
SHA256 123b7546312cd9ebf802a0bed0c19bfb1f04e0d26d0e1be69b08088a9b4c5cd8
MD5 fcc35dd95a7e7c555c10952b7b86fcb9
BLAKE2b-256 ac46420f8ee749a83ab750f2a05ff2fcbb370448d80e14a10a1b354c0d3969ea

See more details on using hashes here.

File details

Details for the file atech-1.0.0a4-py3-none-any.whl.

File metadata

  • Download URL: atech-1.0.0a4-py3-none-any.whl
  • Upload date:
  • Size: 90.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.5

File hashes

Hashes for atech-1.0.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 534f189f4f2daf22705c34b06fb27d30657e5bf3bed10bf3af41e3584b0583c9
MD5 ee48063fc15f3f466ba24906e121ff28
BLAKE2b-256 7ac57166bad3facce9c903b824ff017cce613640f33b488f2e01bffe9482b1cf

See more details on using hashes here.

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