Coldframe watches the soil in a garden and says when to water. Battery-powered Nodes measure soil moisture, a Hub relays their Readings over the home network, and a self-hosted Server evaluates them and notifies the people who share the garden on the web, iOS and Android.
The project is open source and built to be reproduced: firmware, Server, apps, hardware designs and deployment all live in this repository.
- Developer quickstart: run the local stack and every test suite.
- Build guide: build, flash and add your own Node and Hub.
- Deploy guide: run Coldframe on your home server, then build your own apps.
- Reproduce Coldframe: the end-to-end checklist for a second person rebuilding Coldframe from these docs, and how to report where they got stuck.
- Firmware reference: learn ESP-NOW, BLE provisioning, eFuse keys and deep sleep from the Node and Hub firmware.
- Hardware design: schematics, BOM, wiring, enclosure and probe sealing.
- Hub radio coexistence spike: what the Hub's radio can do at once.
| Folder | Holds |
|---|---|
apps/ |
Runtimes: Node and Hub firmware, the Server, the web app, the mobile shells |
packages/ |
Contracts, shared libraries and generated clients the runtimes reference |
tests/ |
All tests, split by language |
aspire/ |
The local development stack, which is also the integration-test host |
deploy/ |
Helm charts, Fleet bundles and a Compose reference example (deploy/compose); deploy at home with docs/deploy |
hardware/ |
The reference Node and Hub design: schematics, BOM, wiring, enclosure |
docs/ |
Guides and references |