mirror of
https://github.com/jpawlowski/hass.tibber_prices.git
synced 2026-03-30 05:13:40 +00:00
docs(coordinator): enhance package docstring with detailed overview and components
This commit is contained in:
parent
5ab7703d90
commit
b5a0854cee
1 changed files with 17 additions and 1 deletions
|
|
@ -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 (
|
||||
MINUTE_UPDATE_ENTITY_KEYS,
|
||||
|
|
|
|||
Loading…
Reference in a new issue