3.6 KiB
title, description, ha_category, ha_release, ha_iot_class, ha_codeowners, ha_domain
| title | description | ha_category | ha_release | ha_iot_class | ha_codeowners | ha_domain | |||
|---|---|---|---|---|---|---|---|---|---|
| Openweathermap | Instructions on how to integrate OpenWeatherMap within Home Assistant. |
|
0.32 | Cloud Polling |
|
openweathermap |
The openweathermap weather platform uses OpenWeatherMap as a source for current meteorological data for your location.
There is currently support for the following device types within Home Assistant:
You need an API key, which is free, but requires a registration.
Weather
To add OpenWeatherMap to your installation, add the following to your configuration.yaml file:
# Example configuration.yaml entry
weather:
- platform: openweathermap
api_key: YOUR_API_KEY
{% configuration %}
api_key:
description: Your API key for OpenWeatherMap.
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 %}
This platform is an alternative to the openweathermap sensor.
Sensor
The openweathermap platform uses OpenWeatherMap 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:
# 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.