Changes from MetOffice moving to config_flow (#13220)

This commit is contained in:
Ian Harcombe 2020-06-19 19:37:46 +01:00 committed by GitHub
parent aec676013c
commit 408ebf2052
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 123 deletions

View File

@ -5,6 +5,8 @@ ha_category:
- Weather
ha_release: 0.42
ha_iot_class: Cloud Polling
ha_codeowners:
- '@MrHarcombe'
ha_domain: metoffice
---
@ -12,38 +14,24 @@ The `metoffice` weather platform uses the Met Office's [DataPoint API](https://w
## Configuration
To add the Met Office weather platform 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:
To add the Met Office weather platform to your installation, you'll need to register for a free API key at the link above and then go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Met Office**. Multiple entries can be configured, but a unique set of latitude and longitude must be supplied for each.
```yaml
# Example configuration.yaml entry
weather:
- platform: metoffice
api_key: YOUR_API_KEY
```
A number of weather entities are created for each entry created in the configuration by location: one weather entity with a summary of the 3-hourly forecasts and twelve sensor entities for individual reporting on each of the individual measurements. The time supplied for each forecast is the start time for the forecast.
{% configuration %}
api_key:
description: "Your personal API key from the [Datapoint website](https://www.metoffice.gov.uk/datapoint)."
required: true
type: string
name:
description: Additional name for the weather integration in Home Assistant.
required: false
type: string
default: Met Office
latitude:
description: "Latitude coordinate to monitor weather of (required if **longitude** is specified), defaults to coordinates defined in your `configuration.yaml`."
required: inclusive
type: float
longitude:
description: "Longitude coordinate to monitor weather of (required if **latitude** is specified), defaults to coordinates defined in your `configuration.yaml`."
required: inclusive
type: float
{% endconfiguration %}
|Entity|Description|Enabled by default|
|------|-----------|------------------|
|weather.met_office_**site name**|Weather entity with state of the current weather condition and attributes of temperature, humidity, wind speed and visibility.|Yes.|
|sensor.**site name**_feels_like_temperature|Sensor entity giving the current forecast 'feels like' temperature.|No.|
|sensor.**site name**_humidity|Sensor entity giving the current forecast humidity.|No.|
|sensor.**site name**_probability_of_precipitation|Sensor entity giving the current forecast chance of rain.|Yes.|
|sensor.**site name**_station_name|Sensor entity giving the current forecast time interval since midnight UTC.|No.|
|sensor.**site name**_temperature|Sensor entity giving the current forecast temperature.|Yes.|
|sensor.**site name**_uv_index|Sensor entity giving the current forecast UV index.|No.|
|sensor.**site name**_visibility|Sensor entity giving the current forecast visibility classification.|No.|
|sensor.**site name**_visibility_distance|Sensor entity giving the current forecast visibility distance (as a range).|No.|
|sensor.**site name**_weather|Sensor entity giving the current forecast weather conditions.|Yes.|
|sensor.**site name**_wind_direction|Sensor entity giving the current forecast wind direction.|No.|
|sensor.**site name**_wind_gust|Sensor entity giving the current forecast maximum wind gust.|No.|
|sensor.**site name**_speed|Sensor entity giving the current forecast wind speed.|Yes.|
<div class='note'>
This platform is an alternative to the [`metoffice`](/integrations/sensor.metoffice/) sensor.
The weather platform is easier to configure but less customizable.
</div>
Details about the API are available in the [DataPoint API documentation](https://www.metoffice.gov.uk/services/data/datapoint/api-reference). The [DataPoint](https://github.com/EJEP/datapoint-python) library is used to retrieve data.

View File

@ -1,91 +0,0 @@
---
title: "Met Office Sensor"
description: "Instructions on how to integrate Met Office weather conditions into Home Assistant."
ha_category:
- Weather
ha_release: 0.42
ha_iot_class: Cloud Polling
ha_domain: metoffice
---
The `metoffice` sensor platform uses the Met Office's [DataPoint API](https://www.metoffice.gov.uk/datapoint) for weather data.
- 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:
```yaml
# Example configuration.yaml entry
sensor:
- platform: metoffice
api_key: YOUR_API_KEY
monitored_conditions:
- weather
- temperature
- feels_like_temperature
- wind_speed
- wind_direction
- wind_gust
- visibility
- visibility_distance
- uv
- precipitation
- humidity
```
Your location will be detected from your home `latitude` and `longitude` settings.
{% configuration %}
api_key:
description: "Your personal API key from the [Datapoint website](https://www.metoffice.gov.uk/datapoint)."
required: true
type: string
name:
description: Additional name for the sensors.
required: false
defaults: Met Office
type: string
latitude:
description: "Latitude coordinate to monitor weather of (required if **longitude** is specified), defaults to coordinates defined in your `configuration.yaml`."
required: inclusive
type: float
longitude:
description: "Longitude coordinate to monitor weather of (required if **latitude** is specified), defaults to coordinates defined in your `configuration.yaml`."
required: inclusive
type: float
monitored_conditions:
description: Conditions to display in the frontend.
required: true
type: list
keys:
weather:
description: A human-readable text summary of the current conditions.
temperature:
description: The current temperature.
feels_like_temperature:
description: A numerical value representing the apparent (or "feels like") temperature.
wind_speed:
description: The wind speed.
wind_direction:
description: Where the wind is coming from.
wind_gust:
description: If there are wind gusts.
visibility:
description: The average visibility.
visibility_distance:
description: The visibility distance.
uv:
description: The UV index.
precipitation:
description: The average expected intensity of precipitation occurring.
humidity:
description: The relative humidity.
{% endconfiguration %}
<div class='note'>
This sensor is an alternative to the [`metoffice`](/integrations/metoffice/) weather platform.
The weather platform is easier to configure but less customizable.
</div>