Adjust documentation for config flow (#18728)

This commit is contained in:
Joakim Sørensen 2021-08-05 09:13:06 +02:00 committed by GitHub
parent b5bcd54a42
commit 0f581f678b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -12,26 +12,10 @@ ha_platforms:
- binary_sensor - binary_sensor
--- ---
The `uptimerobot` binary sensor platform allows you get the status for all of your monitors from your account on [Uptime Robot]( https://uptimerobot.com). The `uptimerobot` integration provides binary sensors to get the status for all of your monitors from your account on [Uptime Robot]( https://uptimerobot.com).
## Configuration {% include integrations/config_flow.md %}
To enable the sensor, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: uptimerobot
api_key: YOUR_API_KEY
```
{% configuration %}
api_key:
description: Your Uptime Robot API key.
required: true
type: string
{% endconfiguration %}
All the data will be fetched from [Uptime Robot](https://uptimerobot.com).
To get your API key, go to [My Settings](https://uptimerobot.com/dashboard#mySettings) on the Uptime Robot website, at the bottom you will find your "Read-Only API Key". To get your API key, go to [My Settings](https://uptimerobot.com/dashboard#mySettings) on the Uptime Robot website, at the bottom you will find your "Read-Only API Key".
All the data will be fetched from [Uptime Robot](https://uptimerobot.com).