mirror of
https://github.com/jpawlowski/hass.tibber_prices.git
synced 2026-03-29 21:03:40 +00:00
Added comprehensive user documentation for visual dashboard customization: - docs/user/icon-colors.md: New guide for using icon_color attribute * Explains CSS variable approach for theme compatibility * Shows when to use icon_color vs state interpretation * Examples for Custom Button Card, Entities Card, Mushroom, Glance * Custom color override options (theme-based and direct) * All state values use lowercase (HA convention) - docs/user/dynamic-icons.md: New guide for automatic icon changes * Explains state-based icon behavior without cataloging specifics * Dashboard examples with standard and custom cards * Icon override instructions for fixed icons * Binary sensor icon behavior details * Integration with dynamic colors - Updated cross-references in README.md, sensors.md, automation-examples.md to link both new guides Impact: Users can now create visually rich dashboards with color-coded and icon-changing sensors without writing complex conditional logic. Documentation focuses on principles and practical examples rather than exhaustive listings, making it easy to understand and maintain. |
||
|---|---|---|
| .. | ||
| automation-examples.md | ||
| configuration.md | ||
| dynamic-icons.md | ||
| icon-colors.md | ||
| installation.md | ||
| period-calculation.md | ||
| README.md | ||
| sensors.md | ||
| services.md | ||
| troubleshooting.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
- Installation - How to install via HACS and configure the integration
- Configuration - Setting up your Tibber API token and price thresholds
- Period Calculation - How Best/Peak Price periods are calculated and configured
- Sensors - Available sensors, their states, and attributes
- Dynamic Icons - State-based automatic icon changes
- Dynamic Icon Colors - Using icon_color attribute for color-coded dashboards
- Services - Custom services and how to use them
- Automation Examples - Ready-to-use automation recipes
- Troubleshooting - Common issues and solutions
🚀 Quick Start
- Install via HACS (add as custom repository)
- Add Integration in Home Assistant → Settings → Devices & Services
- Enter Tibber API Token (get yours at developer.tibber.com)
- Configure Price Thresholds (optional, defaults work for most users)
- 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?
- Check the Troubleshooting Guide
- Search existing issues
- Open a new issue if needed
Note: These guides are for end users. If you want to contribute to development, see the Developer Documentation.