jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-24 09:46:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

OpenWeatherMap config_flow documentation (#13318)

Browse Source
This commit is contained in:
Evgeny 2020-09-05 08:29:19 +02:00 committed by GitHub
parent 89557e224f
commit 8b9755c9fe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 39 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

139
source/_integrations/openweathermap.markdown
View File

@ -1,13 +1,15 @@
---
title: Openweathermap
description: Instructions on how to integrate OpenWeatherMap within Home Assistant.
ha_release: 0.32
ha_category:
- Weather
- Sensor
ha_release: 0.32
ha_iot_class: Cloud Polling
ha_config_flow: true
ha_codeowners:
- '@fabaff'
- '@freekode'
ha_domain: openweathermap
---
@ -15,115 +17,52 @@ The `openweathermap` weather platform uses [OpenWeatherMap](https://openweatherm
There is currently support for the following device types within Home Assistant:
- [Sensor](#sensor)
- [Weather](#weather)
- Sensor
- Weather
You need an API key, which is free, but requires a [registration](https://home.openweathermap.org/users/sign_up).
## Weather
## Configuration
To add OpenWeatherMap to your installation, add the following to your `configuration.yaml` file:
To add OpenWeatherMap integration go to **Configuration** >> **Integrations** and find the integration in the list.
```yaml
# Example configuration.yaml entry
weather:
- platform: openweathermap
api_key: YOUR_API_KEY
```
| Parameter | Value |
| :------------------- | :---------------------------------------------------------------------------------------------------------------------------------------- |
| API Key | API Key from the website |
| Name | Name of the integration |
| Latitude | Latitude for weather forecast and sensor |
| Longitude | Longitude for weather forecast and sensor |
| Mode | Forecast mode, `hourly` for a three-hour forecast, `daily` for daily forecast, or `freedaily` for a five-day forecast with the free tier. |
| Language | Language for receiving data (only for `sensor`) |
{% configuration %}
api_key:
description: Your API key for [OpenWeatherMap](https://openweathermap.org/).
required: true
type: string
name:
description: Name to use in the frontend.
required: false
type: string
default: OpenWeatherMap
mode:
description: "Can specify `hourly`, `daily`, or `freedaily`. Select `hourly` for a three-hour forecast, `daily` for daily forecast, or `freedaily` for a five-day forecast with the free tier."
required: false
type: string
default: "`hourly`"
latitude:
description: Latitude of the location to display the weather.
required: false
type: float
default: "The latitude in your `configuration.yaml` file."
longitude:
description: Longitude of the location to display the weather.
required: false
type: float
default: "The longitude in your `configuration.yaml` file."
{% endconfiguration %}
The integration creates weather entity and also sensors for all available conditions.
For each condition `sensor` entity will be created with id:
`sensor.<integration name>_<monitored condition>`
Sensor prints information in language which was selected for integration.
All conditions:
| Condition | Description |
| :----------- | :------------------------------------- |
| `weather` | A human-readable text summary. |
| `temperature` | Current temperature. |
| `wind_speed` | Wind speed. |
| `wind_bearing` | Wind bearing. |
| `humidity` | Relative humidity. |
| `pressure` | Sea-level air pressure in millibars. |
| `clouds` | Description of cloud coverage. |
| `rain` | Rain volume. |
| `snow` | Snow volume. |
| `condition` | Current weather condition code. |
| `weather_code` | Current weather code. |
<div class='note'>
This platform is an alternative to the [`openweathermap`](/integrations/openweathermap#sensor) sensor.
Weather entity always will have English language. Home Assistant translate it to user language automatically.
</div>
## Sensor
The `openweathermap` platform uses [OpenWeatherMap](https://openweathermap.org/) as a source for current meteorological data for your location. The `forecast` will show you the condition in 3h.
To include OpenWeatherMap sensor to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: openweathermap
api_key: YOUR_API_KEY
monitored_conditions:
- weather
```
{% configuration %}
api_key:
description: Your API key for OpenWeatherMap.
required: true
type: string
name:
description: Additional name for the sensors. Default to platform name.
required: false
default: OWM
type: string
forecast:
description: Enables the forecast. The default is to display the current conditions.
required: false
default: false
type: boolean
language:
description: The language in which you want text results to be returned. It's a two-characters string (e.g., `en`, `es`, `ru`, `it`, etc.).
required: false
default: en
type: string
monitored_conditions:
description: Conditions to display in the frontend.
required: true
type: list
keys:
weather:
description: A human-readable text summary.
temperature:
description: Current temperature.
wind_speed:
description: Wind speed.
wind_bearing:
description: Wind bearing.
humidity:
description: Relative humidity.
pressure:
description: Sea-level air pressure in millibars.
clouds:
description: Description of cloud coverage.
rain:
description: Rain volume.
snow:
description: Snow volume.
weather_code:
description: Current weather condition code.
{% endconfiguration %}
Details about the API are available in the [OpenWeatherMap documentation](https://openweathermap.org/api).