michele/DigiRadio
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document HTTP API and complete manual for slices 1–2

Browse Source 
Add ch-api.tex for REST endpoints and boot flow, update ch-firmware,
ch-build, and ch-intro. Extend CONTRIBUTING, instructions, and README
with manual sync checks and API reference.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
michele
2026-07-06 11:04:22 +02:00
co-authored by Cursor
parent ddbee70c23
commit 425b3f98cf
9 changed files with 238 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Software/README.md
+16
View File
@@ -31,6 +31,22 @@ doxygen Doxyfile
python3 tools/check-manual-sync.py
```
Manual PDF (design + HTTP API + class reference):
```bash
cd docs/manual && latexmk -lualatex manual.tex
```
## HTTP API (fw 0.2.0)
| Method | Path | Purpose |
|--------|------|---------|
| GET | `/api/health` | `{"status":"ok","fw":"0.2.0"}` |
| POST | `/api/wifi` | Provision STA credentials; reboot on success |
Full schemas, error tokens, and boot flow: [`docs/manual/ch-api.tex`](docs/manual/ch-api.tex).
C++ signatures: generate with `doxygen Doxyfile` → `docs/api/html/index.html`.
## Layout
See [`AGENTS.md`](AGENTS.md) §12 and [`instructions.md`](instructions.md) for