# API reference

Generated from the docstrings. The firmware modules are copied flat onto the board, so each
one is a top-level module there.

## Entry points and hardware

These access `machine` and `network` directly and run on the board only.

```{toctree}
:maxdepth: 1

api/boot/index
api/main/index
api/battery_monitor/index
api/board/index
```

## Drivers

```{toctree}
:maxdepth: 1

api/epd4in2/index
api/max17048/index
```

## Logic

Pure modules without hardware access, tested on the host.

```{toctree}
:maxdepth: 1

api/alerts/index
api/awake/index
api/awake_stats/index
api/battery/index
api/statusscreen/index
api/clock/index
api/dashboard/index
api/header/index
api/layout/index
api/qr/index
api/schedule/index
api/text/index
api/tiles/index
api/trend/index
```

## Data sources and network

```{toctree}
:maxdepth: 1

api/datasource/index
api/homeassistant/index
api/httpclient/index
api/hamqtt/index
api/wifi/index
api/webapi/index
api/webui/index
api/ota/index
```

## Storage

```{toctree}
:maxdepth: 1

api/logfile/index
api/screen/index
api/state/index
```

## Settings

```{toctree}
:maxdepth: 1

api/defaults/index
api/config_example/index
```

## Tools

Scripts for the PC, run with `uv run tools/<name>.py`.

```{toctree}
:maxdepth: 1

api/battery_forecast/index
api/board_tiles/index
api/deploy_usb/index
api/deploy_wlan/index
api/firmware/index
api/make_font/index
api/make_icons/index
api/preview/index
api/qr_sticker/index
api/serve_ui/index
api/wake/index
api/watch_battery/index
```