---
icon: material/book-open-variant
---

# Reference

Technical reference for the cosalette API and configuration.

<div class="grid cards" markdown>

-   **API Reference**

    ---

    All public classes, functions, and protocols.

    [:octicons-arrow-right-24: API Reference](api.md)

-   **Testing Utilities**

    ---

    Test doubles, factories, and pytest fixtures.

    [:octicons-arrow-right-24: Testing Utilities](testing.md)

-   **Settings**

    ---

    Configuration fields, environment variables, and defaults.

    [:octicons-arrow-right-24: Settings Reference](settings.md)

-   **MQTT Topics**

    ---

    Complete topic schema with examples.

    [:octicons-arrow-right-24: MQTT Topics](mqtt-topics.md)

-   **CLI Options**

    ---

    Command-line flags and their defaults.

    [:octicons-arrow-right-24: CLI Options](cli.md)

-   **Payload Schemas**

    ---

    JSON schemas for error and heartbeat payloads.

    [:octicons-arrow-right-24: Payload Schemas](payloads.md)

</div>
