Add missing configuration variables (#4310)

This commit is contained in:
Fabian Affolter 2018-01-06 22:56:57 +01:00 committed by GitHub
parent 4116766cb5
commit 5d8f0fc7c2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 9 deletions

View File

@ -15,8 +15,8 @@ ha_iot_class: "Cloud Polling"
The `metoffice` sensor platform uses the Met Office's [DataPoint API][datapoint] for weather data.
- Each sensor will be given the `device_id` of "Met Office [condition]"
- The sensor checks for new data every minute, starting 30 minutes after the timestamp of the most recent data as the data is updated every half-hour.
- Each sensor will be given the `device_id` of "Met Office [condition]" if `name:` is not set.
- The sensor checks for new data every minute, starting 30 minutes after the timestamp of the most recent data as the data is updated every half hour.
To add the Met Office weather to your installation you'll need to register for a free api key at the link above and then add the following to your `configuration.yaml` file:
@ -24,7 +24,7 @@ To add the Met Office weather to your installation you'll need to register for a
# Example configuration.yaml entry
sensor:
- platform: metoffice
api_key: "my-api-key"
api_key: YOUR_API_KEY
monitored_conditions:
- weather
- temperature
@ -43,12 +43,25 @@ Your location will be detected from your home `latitude` and `longitude` setting
Configuration variables:
- **api_key** (*Required*): Your personal API key from the [Datapoint website][datapoint].
- **name** (*Optional*): Name to use in the frontend, will be the prefix.
- **api_key** (*Required*): Your personal API key from the [Datapoint website](http://www.metoffice.gov.uk/datapoint).
- **name** (*Optional*): Additional name for the sensors. Default to platform name.
- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specified), defaults to coordinates defined in your `configuration.yaml`.
- **longitude** (*Optional*): Longitude coordinate to monitor weather of (required if **latitude** is specified), defaults to coordinates defined in your `configuration.yaml`.
- **monitored_conditions** array (*Required*): Conditions to display in the frontend.
- **weather**: A human-readable text summary of the current conditions.
- **temperature**: The current temperature.
- **feels_like_temperature**: A numerical value representing the apparent (or "feels like") temperature.
- **wind_speed**: The wind speed.
- **wind_direction**: Where the wind is coming from.
- **wind_gust**: If there are wind gusts.
- **visibility**: The average visibility.
- **visibility_distance**: The visibility distance.
- **uv**: The UV index.
- **precipitation**: The average expected intensity of precipitation occurring.
- **humidity**: The relative humidity.
<p class='note'>
This sensor is an alternative to the [`metoffice`](/components/weather.metoffice/) weather platform.
The weather platform is easier to configure but less customizable.
</p>
[datapoint]: http://www.metoffice.gov.uk/datapoint

View File

@ -20,16 +20,15 @@ To add the Met Office weather platform to your installation, you'll need to regi
```yaml
weather:
- platform: metoffice
api_key: "my-api-key"
api_key: YOUR_API_KEY
```
Configuration variables:
- **api_key** (*Required*): Your personal API key from the [Datapoint website][datapoint].
- **api_key** (*Required*): Your personal API key from the [Datapoint website](http://www.metoffice.gov.uk/datapoint).
<p class='note'>
This platform is an alternative to the [`metoffice`](/components/sensor.metoffice/) sensor.
The weather platform is easier to configure but less customizable.
</p>
[datapoint]: http://www.metoffice.gov.uk/datapoint