API Reference¶

This page provides comprehensive API documentation for all pybragerone modules.

Core Components¶

`pybragerone.gateway`	Gateway: WS connect → modules.connect → listen → prime.
`pybragerone.cli`	Diagnostic CLI for BragerOne (REST + WS).
`pybragerone.utils`	Library utilities.

API Client¶

`pybragerone.api.client`	HTTP API client for BragerOne.
`pybragerone.api.ws`	WebSocket (Socket.IO) client for BragerOne realtime events.
`pybragerone.api.endpoints`	API endpoint URL builders for BragerOne REST client.
`pybragerone.api.constants`	Constants for pybragerone api.

Data Models¶

`pybragerone.models.param`	Runtime-light parameter store.
`pybragerone.models.events`	Event bus and event classes for pybragerone.
`pybragerone.models.catalog`	Implementation of live asset catalog parsing from BragerOne web app.
`pybragerone.models.menu`	Menu models with validation and automatic prefix cleanup.
`pybragerone.models.menu_manager`	Refactored menu system with clear separation of concerns.
`pybragerone.models.token`	Token storage implementations for pybragerone.

API Models¶

`pybragerone.models.api.auth`	Authentication models for the BragerOne API.
`pybragerone.models.api.common`	Common models shared across API modules.
`pybragerone.models.api.modules`	Module-related models for BragerOne API.
`pybragerone.models.api.objects`	Object-related models for BragerOne API.
`pybragerone.models.api.system`	System-related models for BragerOne API.
`pybragerone.models.api.user`	User-related models for BragerOne API.