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/docs/manual/ch-intro.tex
+6 -5
View File
@@ -28,11 +28,12 @@ USB-C, configured through an elegant web interface.
This manual documents the system for someone building, flashing, or
extending DigiRadio: the hardware at a block level
(Chapter~\ref{ch:hardware}), the firmware architecture
(Chapter~\ref{ch:firmware}), the per-class reference that grows with the
code (Chapter~\ref{ch:classes}), and how to build and flash
(Chapter~\ref{ch:build}). The exact register-level programming of each
chip lives in the source code and its generated API documentation; this
manual explains the design and the reasoning behind it.
(Chapter~\ref{ch:firmware}), the HTTP JSON API exposed by the web UI
(Chapter~\ref{ch:api}), the per-class design reference that grows with
the code (Chapter~\ref{ch:classes}), and how to build and flash
(Chapter~\ref{ch:build}). Exact C++ signatures are generated by Doxygen
from the source; this manual explains design, behaviour, and the
reasoning behind it.
\section{Licensing summary}