Skip to content

Latest commit

 

History

History
39 lines (32 loc) · 2.93 KB

File metadata and controls

39 lines (32 loc) · 2.93 KB

Docs index

Pick a path. Depth lives in the linked pages.

Building the robot

You want to… Start here
Build from scratch (canonical checklist) getting-started.md
Buy parts (main control board + cart) shopping.md
Bridge into hardware/electronics (software engineer background) hardware-for-software-engineers/README.md — optional parallel reading; safety card lives on the checklist
Assemble printed parts (mechanical procedure) 3d/assembly.md
Flash firmware Web flash (default) · flash.md (PlatformIO / mods / OTA)
Electronics (main control board) shopping.md → hardware/main-control-board.md → hardware/README.md
Extra modules (advanced breakouts) shopping.md → hardware/wiring.md → 3d/assembly-modular.md
Print / parts inventory ../3d_models/README.md
Order printed parts (no 3D printer) 3d/order-parts.md
Order main control board (PCB / PCBA) hardware/order-main-control-board.md
Adapt CAD to a different servo 3d/parametric-design.md
Add a new CAD / printable part 3d/adding-parts.md
Optional mods ../mods/README.md
Use with an agent (robot already on Wi-Fi) integration.md (tiny-engineer CLI or REST) · Cursor: hooks.md

Reference and contribute

You want to… Start here
Contribute a PCB (KiCad) pcb.md → hardware/
HTTP API / settings api.md; add a setting: settings.md
CLI setup / REST for any IDE integration.md
Publish npm CLI (tiny-engineer) cli-release.md
Firmware / package tests testing.md
AI coding agents (repo rules) AGENTS.md
Contribute / report a vuln CONTRIBUTING.md; SECURITY.md
Share a finished build Show and tell — how to post

Also: robot-movement.md (servo axes and safe ranges); optional macos-lock-unlock.md (sleep/wake on Mac screen lock).

Source of truth: pin constants in firmware (include/pins.h); electrical detail in docs/hardware/; HTTP shapes in api.md. Overall build order: getting-started.md.