jpawlowski/hass.tibber_prices
1
0
Fork 0
mirror of https://github.com/jpawlowski/hass.tibber_prices.git synced 2026-03-30 05:13:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
hass.tibber_prices/docs/user
History
Julian Pawlowski 53e73a7fda feat(period-calc): adaptive defaults + remove volatility filter 
Major improvements to period calculation with smarter defaults and
simplified configuration:

**Adaptive Defaults:**
- ENABLE_MIN_PERIODS: true (was false) - Always try to find periods
- MIN_PERIODS target: 2 periods/day (ensures coverage)
- BEST_PRICE_MAX_LEVEL: "cheap" (was "any") - Prefer genuinely cheap
- PEAK_PRICE_MIN_LEVEL: "expensive" (was "any") - Prefer genuinely expensive
- GAP_TOLERANCE: 1 (was 0) - Allow 1-level deviations in sequences
- MIN_DISTANCE_FROM_AVG: 5% (was 2%) - Ensure significance
- PEAK_PRICE_MIN_PERIOD_LENGTH: 30min (was 60min) - More responsive
- PEAK_PRICE_FLEX: -20% (was -15%) - Better peak detection

**Volatility Filter Removal:**
- Removed CONF_BEST_PRICE_MIN_VOLATILITY from const.py
- Removed CONF_PEAK_PRICE_MIN_VOLATILITY from const.py
- Removed volatility filter UI controls from config_flow.py
- Removed filter_periods_by_volatility() calls from coordinator.py
- Updated all 5 translations (de, en, nb, nl, sv)

**Period Calculation Logic:**
- Level filter now integrated into _build_periods() (applied during
  interval qualification, not as post-filter)
- Gap tolerance implemented via _check_level_with_gap_tolerance()
- Short periods (<1.5h) use strict filtering (no gap tolerance)
- Relaxation now passes level_filter + gap_count directly to
  PeriodConfig
- show_periods check skipped when relaxation enabled (relaxation
  tries "any" as fallback)

**Documentation:**
- Complete rewrite of docs/user/period-calculation.md:
  * Visual examples with timelines
  * Step-by-step explanation of 4-step process
  * Configuration scenarios (5 common use cases)
  * Troubleshooting section with specific fixes
  * Advanced topics (per-day independence, early stop, etc.)
- Updated README.md: "volatility" → "distance from average"

Impact: Periods now reliably appear on most days with meaningful
quality filters. Users get warned about expensive periods and notified
about cheap opportunities without manual tuning. Relaxation ensures
coverage while keeping filters as strict as possible.

Breaking change: Volatility filter removed (was never a critical
feature, often confused users). Existing configs continue to work
(removed keys are simply ignored).
2025-11-12 13:20:14 +00:00
..
automation-examples.md docs: restructure documentation and add AI development disclosure 2025-11-09 14:25:27 +00:00
configuration.md docs: restructure documentation and add AI development disclosure 2025-11-09 14:25:27 +00:00
installation.md docs: restructure documentation and add AI development disclosure 2025-11-09 14:25:27 +00:00
period-calculation.md feat(period-calc): adaptive defaults + remove volatility filter 2025-11-12 13:20:14 +00:00
README.md feat(docs): enhance period calculation documentation and add detailed guides for best/peak price periods 2025-11-10 11:54:06 +00:00
sensors.md feat(docs): enhance period calculation documentation and add detailed guides for best/peak price periods 2025-11-10 11:54:06 +00:00
services.md docs: restructure documentation and add AI development disclosure 2025-11-09 14:25:27 +00:00
troubleshooting.md docs: restructure documentation and add AI development disclosure 2025-11-09 14:25:27 +00:00

README.md

User Documentation

Welcome to Tibber Prices! This integration provides enhanced electricity price data from Tibber with quarter-hourly precision, statistical analysis, and intelligent ratings.

📚 Documentation

🚀 Quick Start

  1. Install via HACS (add as custom repository)
  2. Add Integration in Home Assistant → Settings → Devices & Services
  3. Enter Tibber API Token (get yours at developer.tibber.com)
  4. Configure Price Thresholds (optional, defaults work for most users)
  5. Start Using Sensors in automations, dashboards, and scripts!

✨ Key Features

  • Quarter-hourly precision - 15-minute intervals for accurate price tracking
  • Statistical analysis - Trailing/leading 24h averages for context
  • Price ratings - LOW/NORMAL/HIGH classification based on your thresholds
  • Best/Peak hour detection - Automatic detection of cheapest/peak periods with configurable filters (learn how)
  • ApexCharts integration - Custom services for beautiful price charts
  • Multi-currency support - EUR, NOK, SEK with proper minor units (ct, øre, öre)

🔗 Useful Links

🤝 Need Help?

Note: These guides are for end users. If you want to contribute to development, see the Developer Documentation.