Add documentation for Flick Electric sensor (#11716)

This commit is contained in:
Brynley McDonald 2020-05-11 07:29:53 +12:00 committed by GitHub
parent 31c70f8786
commit 16b440cd7c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -0,0 +1,30 @@
---
title: Flick Electric
description: Instructions on how to set up the Flick Electric Pricing sensor in Home Assistant.
ha_category:
- Energy
ha_release: '0.110'
ha_iot_class: Cloud Polling
ha_codeowners:
- '@ZephireNZ'
ha_domain: flick_electric
---
[Flick Electric Co](https://www.flickelectric.co.nz/) is a power company in New Zealand, based around a transparent pricing model where each component of pricing is provided. This integration uses the mobile app's API from Flick Electric Co to get the current power price as well as each of the components price.
## Configuration
This integration can be configured via the Home Assistant frontend.
- Go to **Configuration** -> **Integrations**.
- Click on the `+` in the bottom right corner to add a new integration.
- Search and select the **Flick Electric** integration form the list.
- Follow the instruction on screen to add the sensor.
<div class='note'>
The configuration uses the client ID and secret used by the app at the time of release. If this stops working, you can find the new ones by using a MITM proxy with the mobile app. The app will call `https://api.flick.energy/identity/oauth/token` with the `client_id` and `client_secret`.
You can then use these values during the configuration.
</div>