API reference

The full C++ API of the HAL, from the Doxygen comments in lib/api and lib/managers.

Open the API reference

Start here

Page	What it is
Flux	The board facade: GetInstance(), EnsureInitialized(), the manager members, system diagnostics
ValveManager	Solenoid and proportional valve channels
AdcManager	ESP32 ADC and ADS7952 channels by name
CommChannelsManager	SPI buses, CAN, UARTs and USB Serial/JTAG
GpioManager	GPIO pins of the pin map by name

Build it locally

Run Doxygen from the repository root and open the index.html it writes:

mkdir -p build/doxygen && doxygen Doxyfile
open build/doxygen/html/index.html    # xdg-open on Linux

The published reference uses the HardFOC stylesheet, which the docs workflow adds; a local build uses Doxygen's default look.