mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-27 03:07:14 +00:00
Documentation for the Météo-France weather platform (#7480)
* météo france weather platform documentation * Add infos about the content of forecast on card * Introducing Meteo-France component * Minor changes
This commit is contained in:
Victor Cerutti
Fabian Affolter
parent
a8040b018a
commit
cf2817c782
126
source/_components/meteo_france.markdown
Normal file
126
source/_components/meteo_france.markdown
Normal file
@ -0,0 +1,126 @@
|
|||||||
|
---
|
||||||
|
layout: page
|
||||||
|
title: "Météo-France"
|
||||||
|
description: "Instructions on how to integrate Météo-France within Home Assistant."
|
||||||
|
date: 2018-10-18 08:00
|
||||||
|
sidebar: true
|
||||||
|
comments: false
|
||||||
|
sharing: true
|
||||||
|
footer: true
|
||||||
|
logo: meteo-france.png
|
||||||
|
ha_category: Hub
|
||||||
|
ha_release: 0.88
|
||||||
|
ha_iot_class: "Cloud Polling"
|
||||||
|
ha_category:
|
||||||
|
- Sensor
|
||||||
|
- Weather
|
||||||
|
ha_iot_class: "Local Push"
|
||||||
|
redirect_from:
|
||||||
|
- /components/sensor.meteo_france/
|
||||||
|
- /components/weather.meteo_france/
|
||||||
|
---
|
||||||
|
|
||||||
|
The `meteo_france` component uses the [Météo-France](http://www.meteofrance.com/) web service as a source for meteorological data for your location. The location is based on the `city` configured in your `configuration.yaml` file.
|
||||||
|
|
||||||
|
It displays the current weather along with a 4 days forecast and can create sensors based on the `monitored_conditions` set in your `configuration.yaml` file.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
|
To add Météo-France to your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
meteo_france:
|
||||||
|
- city: '76000'
|
||||||
|
```
|
||||||
|
|
||||||
|
{% configuration %}
|
||||||
|
city:
|
||||||
|
description: Name of the city ([see below](#about-city-configuration)).
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
monitored_conditions:
|
||||||
|
description: The conditions types to monitor.
|
||||||
|
required: true
|
||||||
|
type: list
|
||||||
|
keys:
|
||||||
|
temperature:
|
||||||
|
description: The current temperature.
|
||||||
|
weather:
|
||||||
|
description: A human-readable text summary of the current conditions.
|
||||||
|
wind_speed:
|
||||||
|
description: The wind speed.
|
||||||
|
uv:
|
||||||
|
description: The current UV index.
|
||||||
|
next_rain:
|
||||||
|
description: Time to the next rain if happening for the next hour ([see note below](#about-next_rain-condition-sensor)).
|
||||||
|
freeze_chance:
|
||||||
|
description: Probability of temperature below 0°C for the day.
|
||||||
|
rain_chance:
|
||||||
|
description: Probability of rain for the day.
|
||||||
|
snow_chance:
|
||||||
|
description: Probability of snow for the day.
|
||||||
|
thunder_chance:
|
||||||
|
description: Probability of thunderstorm for the day.
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
|
||||||
|
### {% linkable_title About `city` configuration %}
|
||||||
|
|
||||||
|
This component use the Météo-France search API to get the first city from the results returned.
|
||||||
|
|
||||||
|
It works well with french postal code, city name, etc. In case your expected result doesn't come first, you can set a more specified query like `<city name>, <postal_code>`.
|
||||||
|
|
||||||
|
It also works with international city, with mixed results. You may have to find the correct city query.
|
||||||
|
For example `Montreal, Canada` will return a city in Ardèche, France, whereas `Montreal, america` works
|
||||||
|
|
||||||
|
[http://www.meteofrance.com/mf3-rpc-portlet/rest/lieu/facet/previsions/search/montreal,amerique](http://www.meteofrance.com/mf3-rpc-portlet/rest/lieu/facet/previsions/search/montreal,amerique)
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry for Montreal, Canada
|
||||||
|
meteo_france:
|
||||||
|
- city: 'montreal,amerique'
|
||||||
|
```
|
||||||
|
|
||||||
|
### {% linkable_title About `next_rain` condition sensor %}
|
||||||
|
|
||||||
|
<p class='note warning'>
|
||||||
|
The 1 hour rain forecast is supported for more than 75 % of metropolitan France.<br/>
|
||||||
|
You can check if your city is covered on the [Météo-France website](http://www.meteofrance.com/previsions-meteo-france/previsions-pluie).
|
||||||
|
</p>
|
||||||
|
|
||||||
|
The `next_rain` sensor value is the time to next rain, from 0 to 55 minutes.
|
||||||
|
If no rain is forecasted for the next hour, value will be "No rain".
|
||||||
|
|
||||||
|
Attributes also give the forecast for the next hour in 5 minutes intervals.
|
||||||
|
Possible value for each intervals attributes are:
|
||||||
|
|
||||||
|
- 1 No rain
|
||||||
|
- 2 Light rain
|
||||||
|
- 3 Moderate rain
|
||||||
|
- 4 Heavy rain
|
||||||
|
|
||||||
|
|
||||||
|
### {% linkable_title Complete example %}
|
||||||
|
|
||||||
|
This is an example for 3 cities forecast with different monitored conditions:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Complete example configuration.yaml entry
|
||||||
|
meteo_france:
|
||||||
|
- city: 'Rouen'
|
||||||
|
monitored_conditions:
|
||||||
|
- rain_chance
|
||||||
|
- freeze_chance
|
||||||
|
- thunder_chance
|
||||||
|
- snow_chance
|
||||||
|
- weather
|
||||||
|
- next_rain
|
||||||
|
- wind_speed
|
||||||
|
- temperature
|
||||||
|
- uv
|
||||||
|
- city: 'Oslo, norvege'
|
||||||
|
monitored_conditions:
|
||||||
|
- temperature
|
||||||
|
- city: '51100'
|
||||||
|
```
|
||||||
@ -1,85 +1,20 @@
|
|||||||
---
|
---
|
||||||
layout: page
|
layout: page
|
||||||
title: "Météo-France Sensor"
|
title: "Météo-France Sensor"
|
||||||
description: "Show 1hr rain forecast from Météo-France."
|
description: "Instructions on how to integrate Météo-France within Home Assistant."
|
||||||
date: 2018-10-18 08:00
|
date: 2018-10-18 08:00
|
||||||
sidebar: true
|
sidebar: true
|
||||||
comments: false
|
comments: false
|
||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
logo: meteo-france.png
|
logo: meteo-france.png
|
||||||
ha_category: Sensor
|
ha_category: Weather
|
||||||
ha_release: 0.82
|
ha_release: 0.82
|
||||||
ha_iot_class: "Cloud Polling"
|
ha_iot_class: "Cloud Polling"
|
||||||
---
|
---
|
||||||
|
|
||||||
The `meteo_france` platform uses the [Météo-France](http://www.meteofrance.com/) web service as a source for meteorological data for your location. The location is based on the `postal_code` configured in your `configuration.yaml` file.
|
The `meteo_france` platform uses the [Météo-France](http://www.meteofrance.com/) web service as a source for meteorological data for your location.
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To add Météo-France to your installation, add the following to your `configuration.yaml` file:
|
Please see the [component](/components/meteo_france/) documentation for details and configuration.
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
sensor:
|
|
||||||
- platform: meteo_france
|
|
||||||
postal_code: '76000'
|
|
||||||
monitored_conditions:
|
|
||||||
- temperature
|
|
||||||
- weather
|
|
||||||
- wind_speed
|
|
||||||
- uv
|
|
||||||
- next_rain
|
|
||||||
- freeze_chance
|
|
||||||
- rain_chance
|
|
||||||
- snow_chance
|
|
||||||
- thunder_chance
|
|
||||||
```
|
|
||||||
|
|
||||||
{% configuration %}
|
|
||||||
postal_code:
|
|
||||||
description: Postal code of the city.
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
monitored_conditions:
|
|
||||||
description: The conditions types to monitor.
|
|
||||||
required: true
|
|
||||||
type: list
|
|
||||||
keys:
|
|
||||||
temperature:
|
|
||||||
description: The current temperature.
|
|
||||||
weather:
|
|
||||||
description: A human-readable text summary of the current conditions.
|
|
||||||
wind_speed:
|
|
||||||
description: The wind speed.
|
|
||||||
uv:
|
|
||||||
description: The current UV index.
|
|
||||||
next_rain:
|
|
||||||
description: Time to the next rain if happening for the next hour. (see note below)
|
|
||||||
freeze_chance:
|
|
||||||
description: Probability of temperature below 0°C for the day.
|
|
||||||
rain_chance:
|
|
||||||
description: Probability of rain for the day.
|
|
||||||
snow_chance:
|
|
||||||
description: Probability of snow for the day.
|
|
||||||
thunder_chance:
|
|
||||||
description: Probability of thunderstorm for the day.
|
|
||||||
{% endconfiguration %}
|
|
||||||
|
|
||||||
|
|
||||||
### {% linkable_title About `next_rain` condition sensor %}
|
|
||||||
|
|
||||||
<p class='note warning'>
|
|
||||||
The 1 hour rain forecast is supported for more than 75% of metropolitan France.<br/>
|
|
||||||
You can check if your city is covered on the [Météo-France website](http://www.meteofrance.com/previsions-meteo-france/previsions-pluie)
|
|
||||||
</p>
|
|
||||||
|
|
||||||
The `next_rain` sensor value is the time to next rain, from 0 to 55min.
|
|
||||||
If no rain is forecasted for the next hour, value will be "No rain".
|
|
||||||
|
|
||||||
Attributes also give the forecast for the next hour in 5min intervals.
|
|
||||||
Possible value for each intervals attributes are :
|
|
||||||
- 1 No rain
|
|
||||||
- 2 Light rain
|
|
||||||
- 3 Moderate rain
|
|
||||||
- 4 Heavy rain
|
|
||||||
|
|||||||
20
source/_components/weather.meteo_france.markdown
Normal file
20
source/_components/weather.meteo_france.markdown
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
layout: page
|
||||||
|
title: "Météo-France Weather"
|
||||||
|
description: "Instructions on how to integrate Météo-France within Home Assistant."
|
||||||
|
date: 2018-10-18 08:00
|
||||||
|
sidebar: true
|
||||||
|
comments: false
|
||||||
|
sharing: true
|
||||||
|
footer: true
|
||||||
|
logo: meteo-france.png
|
||||||
|
ha_category: Weather
|
||||||
|
ha_release: 0.88
|
||||||
|
ha_iot_class: "Cloud Polling"
|
||||||
|
---
|
||||||
|
|
||||||
|
The `meteo_france` platform uses the [Météo-France](http://www.meteofrance.com/) web service as a source for meteorological data for your location.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
|
Please see the [component](/components/meteo_france/) documentation for details and configuration.
|
||||||
Loading…
x
Reference in New Issue
Block a user