mirror of
https://github.com/jpawlowski/hass.tibber_prices.git
synced 2026-03-30 13:23:41 +00:00
59 lines
3.3 KiB
Markdown
59 lines
3.3 KiB
Markdown
---
|
|
comments: false
|
|
---
|
|
|
|
# User Documentation
|
|
|
|
Welcome to the **Tibber Prices custom integration for Home Assistant**! This community-developed integration enhances your Home Assistant installation with detailed electricity price data from Tibber, featuring quarter-hourly precision, statistical analysis, and intelligent ratings.
|
|
|
|
:::info Not affiliated with Tibber
|
|
This is an independent, community-maintained custom integration. It is **not** an official Tibber product and is **not** affiliated with or endorsed by Tibber AS.
|
|
:::
|
|
|
|
## 📚 Documentation
|
|
|
|
- **[Installation](installation.md)** - How to install via HACS and configure the integration
|
|
- **[Configuration](configuration.md)** - Setting up your Tibber API token and price thresholds
|
|
- **[Period Calculation](period-calculation.md)** - How Best/Peak Price periods are calculated and configured
|
|
- **[Sensors](sensors.md)** - Available sensors, their states, and attributes
|
|
- **[Dynamic Icons](dynamic-icons.md)** - State-based automatic icon changes
|
|
- **[Dynamic Icon Colors](icon-colors.md)** - Using icon_color attribute for color-coded dashboards
|
|
- **[Actions](actions.md)** - Custom actions (service endpoints) and how to use them
|
|
- **[Chart Examples](chart-examples.md)** - ✨ ApexCharts visualizations with screenshots
|
|
- **[Automation Examples](automation-examples.md)** - Ready-to-use automation recipes
|
|
- **[Troubleshooting](troubleshooting.md)** - Common issues and solutions
|
|
|
|
## 🚀 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](https://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](period-calculation.md))
|
|
- **Beautiful ApexCharts** - Auto-generated chart configurations with dynamic Y-axis scaling ([see examples](chart-examples.md))
|
|
- **Chart metadata sensor** - Dynamic chart configuration for optimal visualization
|
|
- **Flexible currency display** - Choose base currency (€, kr) or subunit (ct, øre) with smart defaults per currency
|
|
|
|
## 🔗 Useful Links
|
|
|
|
- [GitHub Repository](https://github.com/jpawlowski/hass.tibber_prices)
|
|
- [Issue Tracker](https://github.com/jpawlowski/hass.tibber_prices/issues)
|
|
- [Release Notes](https://github.com/jpawlowski/hass.tibber_prices/releases)
|
|
- [Home Assistant Community](https://community.home-assistant.io/)
|
|
|
|
## 🤝 Need Help?
|
|
|
|
- Check the [Troubleshooting Guide](troubleshooting.md)
|
|
- Search [existing issues](https://github.com/jpawlowski/hass.tibber_prices/issues)
|
|
- Open a [new issue](https://github.com/jpawlowski/hass.tibber_prices/issues/new) if needed
|
|
|
|
---
|
|
|
|
**Note:** These guides are for end users. If you want to contribute to development, see the [Developer Documentation](https://jpawlowski.github.io/hass.tibber_prices/developer/).
|