mirror of
https://github.com/jpawlowski/hass.tibber_prices.git
synced 2026-03-29 21:03:40 +00:00
docs: update installation instructions and add configuration steps for HACS integration
This commit is contained in:
parent
850e985ef8
commit
45b26dbf8a
1 changed files with 37 additions and 16 deletions
53
README.md
53
README.md
|
|
@ -34,26 +34,47 @@ A Home Assistant integration that provides advanced price information and rating
|
||||||
|
|
||||||
## 🚀 Quick Start
|
## 🚀 Quick Start
|
||||||
|
|
||||||
### Installation
|
### Step 1: Install the Integration
|
||||||
|
|
||||||
1. **Install via HACS** (recommended)
|
**Prerequisites:** This integration requires [HACS](https://hacs.xyz/) (Home Assistant Community Store) to be installed.
|
||||||
- Add as custom repository: `https://github.com/jpawlowski/hass.tibber_prices`
|
|
||||||
- Search for "Tibber Price Information & Ratings"
|
|
||||||
- Click "Install"
|
|
||||||
|
|
||||||
2. **Add Integration**
|
Click the button below to open the integration directly in HACS:
|
||||||
- Go to Settings → Devices & Services
|
|
||||||
- Click "+ Add Integration"
|
|
||||||
- Search for "Tibber Price Information & Ratings"
|
|
||||||
|
|
||||||
3. **Configure**
|
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=jpawlowski&repository=hass.tibber_prices&category=integration)
|
||||||
- Enter your Tibber API token ([get one here](https://developer.tibber.com/settings/access-token))
|
|
||||||
- Select your Tibber home
|
|
||||||
- Configure price thresholds (optional)
|
|
||||||
|
|
||||||
4. **Start Using!**
|
Then:
|
||||||
- 30+ sensors available (key sensors enabled by default)
|
1. Click "Download" to install the integration
|
||||||
- Use in automations, dashboards, and scripts
|
2. **Restart Home Assistant** (required after installation)
|
||||||
|
|
||||||
|
> **Note:** The My Home Assistant redirect will first take you to a landing page. Click the button there to open your Home Assistant instance. If the repository is not yet in the HACS default store, HACS will ask if you want to add it as a custom repository.
|
||||||
|
|
||||||
|
### Step 2: Add and Configure the Integration
|
||||||
|
|
||||||
|
**Important:** You must have installed the integration first (see Step 1) and restarted Home Assistant!
|
||||||
|
|
||||||
|
#### Option 1: One-Click Setup (Quick)
|
||||||
|
|
||||||
|
Click the button below to open the configuration dialog:
|
||||||
|
|
||||||
|
[](https://my.home-assistant.io/redirect/config_flow_start/?domain=tibber_prices)
|
||||||
|
|
||||||
|
This will guide you through:
|
||||||
|
1. Enter your Tibber API token ([get one here](https://developer.tibber.com/settings/access-token))
|
||||||
|
2. Select your Tibber home
|
||||||
|
3. Configure price thresholds (optional)
|
||||||
|
|
||||||
|
#### Option 2: Manual Configuration
|
||||||
|
|
||||||
|
1. Go to **Settings** → **Devices & Services**
|
||||||
|
2. Click **"+ Add Integration"**
|
||||||
|
3. Search for "Tibber Price Information & Ratings"
|
||||||
|
4. Follow the configuration steps (same as Option 1)
|
||||||
|
|
||||||
|
### Step 3: Start Using!
|
||||||
|
|
||||||
|
- 30+ sensors are now available (key sensors enabled by default)
|
||||||
|
- Configure additional sensors in **Settings** → **Devices & Services** → **Tibber Price Information & Ratings** → **Entities**
|
||||||
|
- Use sensors in automations, dashboards, and scripts
|
||||||
|
|
||||||
📖 **[Full Installation Guide →](docs/user/installation.md)**
|
📖 **[Full Installation Guide →](docs/user/installation.md)**
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue