43 lines
2.5 KiB
Markdown
43 lines
2.5 KiB
Markdown
# Savearth Hardware Repository
|
|
|
|
## WHY
|
|
|
|
This repository is the canonical hardware design home for the Savearth smart-shower flow-meter device. It holds every PCB revision from early prototypes through the current production design and the next mitigation spin. Keeping hardware sources, manufacturing outputs, and analysis docs in one place lets firmware, manufacturing, and field-support teams work from the same truth.
|
|
|
|
## HOW
|
|
|
|
The repository is organised by hardware version under `hardware/`. Each version contains its native EDA project, extracted BOM, parsed schematic data, and manufacturing outputs. Shared component libraries and Python automation scripts live in `hardware/common/`. Design decisions and post-mortems live in `docs/`.
|
|
|
|
Supported PCB versions: **v2.3, v2.4, v2.5, v2.6, v2.7, v2.8, v2.9**.
|
|
|
|
## WHAT
|
|
|
|
### Key documents
|
|
|
|
| Document | Purpose |
|
|
|---|---|
|
|
| [PCB v2.8 Hardware Analysis & Fixes](docs/v2.8_hardware_analysis_and_fixes.md) | Brick/recovery root causes and the GPIO0 bodge-wire fix |
|
|
| [PCB v2.9 Mitigation Plan](docs/v2.9_mitigation_plan.md) | Architectural changes for the next spin |
|
|
| [Hardware Meeting Agenda — v2.8/v2.9](docs/hw_meeting_v28_v29_agenda.md) | Discussion points and decision checklist |
|
|
| [EasyEDA Pro → KiCad Guide](docs/EASYEDA_PRO_TO_KICAD_GUIDE.md) | Migration procedure |
|
|
| [Supply-Chain Risk Mitigation](docs/reports/supply_chain_risk_mitigation_v2_8.md) | v2.8 component risks and replacements |
|
|
| [Hardware Automation Scripts](hardware/common/scripts/README.md) | `extract_bom.py`, `generate_jlcpcb_bom.py`, `convert_to_kicad.py`, `extract_easyeda_db.py` |
|
|
|
|
### Related repositories
|
|
|
|
| Repository | Role |
|
|
|---|---|
|
|
| [`aws-iot-core-poc`](../aws-iot-core-poc) | ESP32-S3 firmware, BSP, drivers, and test firmware |
|
|
| `savearth-iot-infrastructure` | AWS IoT rules, Lambdas, DynamoDB, InfluxDB |
|
|
| `hardware-devicesFirmwareTest` | Assembly-house test station and pre-built binaries |
|
|
|
|
### Aurelio workspace
|
|
|
|
This repository includes a local `.aurelio/` workspace for the `flow-meter-pcb` realm. It connects the hardware repo to `savearth-mcp`, `savearth-workspace`, and the electrical MCP servers. See [`.aurelio/README.md`](.aurelio/README.md) for setup, sync commands, and tracked files.
|
|
|
|
### Quick start
|
|
|
|
1. Open the active design: `hardware/v2.8/easyeda/Savearth GBT.eprj` (EasyEDA Pro).
|
|
2. Read the v2.8 analysis if you are debugging brick/recovery issues.
|
|
3. Read the v2.9 mitigation plan before starting the next schematic spin.
|
|
4. Use the scripts in `hardware/common/scripts/` to regenerate BOMs or convert libraries.
|