Add setup section (#6014)

This commit is contained in:
Fabian Affolter 2018-08-14 09:16:42 +02:00 committed by Franck Nijhof
parent dcd0b59626
commit cc7714c74a

View File

@ -14,6 +14,12 @@ ha_release: 0.52
The `worldtidesinfo` sensor platform uses details from [World Tides](https://www.worldtides.info/) to provide information about the prediction for the tides for any location in the world.
## {% linkable_title Setup %}
Get your API key from your account at [https://www.worldtides.info/](https://www.worldtides.info/).
## {% linkable_title Configuration %}
To use this sensor, add the following to your `configuration.yaml` file:
```yaml
@ -23,10 +29,25 @@ sensor:
api_key: YOUR_API_KEY
```
Configuration variables:
- **api_key** (*Required*): Your API key for https://www.worldtides.info/.
- **name** (*Optional*): Name to use in the frontend.
- **latitude** (*Optional*): Latitude of the location to display the tides. Defaults to the latitude in your `configuration.yaml` file.
- **longitude** (*Optional*): Longitude of the location to display the tides. Defaults to the longitude in your `configuration.yaml` file.
{% configuration %}
api_key:
description: Your API key.
required: true
type: string
name:
description: Name to use in the frontend.
required: false
type: string
default: WorldTidesInfo
latitude:
description: Latitude of the location to display the tides.
required: false
type: float
default: "The latitude in your `configuration.yaml` file."
longitude:
description: Longitude of the location to display the tides.
required: false
type: float
default: "The longitude in your `configuration.yaml` file."
{% endconfiguration %}