docs(coordinator): enhance package docstring with detailed overview and components

This commit is contained in:
Julian Pawlowski 2025-11-18 20:08:09 +00:00
parent 5ab7703d90
commit b5a0854cee

View file

@ -1,4 +1,20 @@
"""Coordinator package for Tibber Prices integration.""" """
Data update coordination package.
This package orchestrates data fetching, caching, and entity updates:
- API polling at 15-minute intervals
- Persistent storage via HA Store
- Quarter-hour entity refresh scheduling
- Price data enrichment pipeline
- Period calculation (best/peak price periods)
Main components:
- core.py: TibberPricesDataUpdateCoordinator (main coordinator class)
- cache.py: Persistent storage management
- data_transformation.py: Raw data enriched data pipeline
- listeners.py: Entity refresh scheduling
- period_handlers/: Period calculation sub-package
"""
from .constants import ( from .constants import (
MINUTE_UPDATE_ENTITY_KEYS, MINUTE_UPDATE_ENTITY_KEYS,