Update Ohmconnect sensor component configuration (#7071)

* Update Ohmconnect sensor component configuration

* Minor changes
This commit is contained in:
Klaas Schoute 2018-10-25 09:52:41 +02:00 committed by Fabian Affolter
parent 0ae7a6c438
commit 3f6c067117

View File

@ -13,22 +13,33 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.26
---
The `ohmconnect` sensor will show you the current [OhmConnect](https://www.ohmconnect.com/) status for the given OhmConnect ID.
> OhmConnect monitors real-time conditions on the electricity grid. When dirty and unsustainable power plants turn on, our users receive a notification to save energy. By saving energy at that time, California does not have to turn on additional power plants and California's energy authorities pay you for that.
OhmConnect monitors real-time conditions on the electricity grid. When dirty and unsustainable power plants turn on, our users receive a notification to save energy. By saving energy at that time, California does not have to turn on additional power plants and California's energy authorities pay you for that.
## {% linkable_title Configuration %}
You can find your OhmConnect ID under "Open Source Projects" on the [settings page](https://login.ohmconnect.com/settings). It's the string after the last `/` in the URL, i.e. for the URL `https://login.ohmconnect.com/verify-ohm-hour/AbCd1e` your ID is `AbCd1e`.
You can find your OhmConnect ID under "Open Source Projects" on the [settings page](https://login.ohmconnect.com/settings). It's the string after the last `/` in the URL, e.g., for the URL `https://login.ohmconnect.com/verify-ohm-hour/AbCd1e` your ID is `AbCd1e`.
## {% linkable_title Configuration %}
To enable the OhMConnect sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: ohmconnect
id: AbCd1e
id: YOUR_OHMCONNECT_ID
```
Configuration variables:
- **id** (*Required*): Your OhmConnect ID which can be found on the settings page.
- **name** (*Optional*): A name to display on the sensor. The default is "OhmConnect Status".
{% configuration %}
id:
description: Your OhmConnect ID.
required: true
type: string
name:
description: A name to display on the sensor.
required: false
default: OhmConnect Status
type: string
{% endconfiguration %}