home-assistant.io/openweathermap.markdown at ddade43c3f2f3433f8d0ecb8229b39c90c75206d

mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-04-25 22:07:35 +00:00

Adding OpenWeatherMap Minute forecast action documentation (#35338 )

* Adding OpenWeatherMap Minutely forecast action documentation

* CodeRabbit feedback

2025-02-25 20:53:14 +01:00

12 KiB

Raw Blame History

title

description

ha_release

ha_category

ha_iot_class

ha_config_flow

ha_codeowners

ha_domain

ha_platforms

ha_integration_type

OpenWeatherMap

Instructions on how to integrate OpenWeatherMap within Home Assistant.

0.32

Sensor

Weather

Cloud Polling

true

@fabaff

@freekode

@nzapponi

openweathermap

sensor

weather

integration

docs	title
/common-tasks/general/#defining-a-custom-polling-interval	Defining a custom polling interval

The OpenWeatherMap weather integration uses OpenWeatherMap as a source for current meteorological data for your location.

There is currently support for the following device types within Home Assistant:

Sensor
Weather

You need an API key, it requires a subscription. The subscription has a free tier with 1000 calls/day. Consider setting the limit on the OpenWeatherMap website to stay under the threshold where API usage incurs a cost. This is done in the Billing plans page, under "Calls per day".

⚠️ Important Deprecation Notice

OpenWeatherMap API V2.5 Deprecation

OpenWeatherMap API V2.5 will be closed on October 7th 2024. After this date, you will need to use API V3.0.

To continue using the service:

Visit the OpenWeatherMap website and activate the One Call subscription.
During activation, you will be prompted for a credit card, but you will not be charged unless you exceed the free tier limits.
Configure your OWM integration to select mode v3.0.
Note: Subscription activation may take up to 2 hours.

For more details, set limits on your usage to avoid charges at OpenWeatherMap Subscriptions.

{% important %} If you register an new API key with OpenWeatherMap, it will be activated automatically, this typically takes between 10 minutes and 2 hours after your successful registration. Keep in mind when configuring this integration, that you new API key might not be activated yet. Recent policy changes limit the API access for new registered users with a free plan, they should select the hourly mode. The other modes require a paid subscription plan. Invalid API-key errors might occur if your API key is used with the other modes. {% endimportant %}

{% include integrations/config_flow.md %}

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	`v3.0` (new API version) with daily forecast for 8 days, and 1-hour steps for 48 hours `v2.5` (deprecated One Call API version), same forcasts as `v3.0` `current` (current weather data only, no forecast) `forecast` (forecast only, in 3-hour steps for 5 days, no current weather data)
Language	Language for receiving data (only for `sensor`)

A sensor entity will be created for each supported condition. Their IDs will follow the format:

sensor.<integration name>_<monitored condition>

Sensors provide data in the language that was selected when configuring the integration.

{% note %} The Weather entity provides data only in English. Home Assistant automatically translates it to the language configured for the frontend. {% endnote %}

Supported Weather Conditions

Current Weather Conditions

Condition	Description
`cloud_coverage`	Cloudiness, %.
`condition`	Weather condition.
`dew_point`	Atmospheric temperature below which water droplets begin to condense and dew can form, ºC.
`feels_like_temperature`	Temperature accounting for the human perception of weather, ºC.
`humidity`	Humidity, %.
`precipitation_kind`	The kind of precipitation (Rain, Snow, Snow and Rain, None) for the last hour.
`pressure`	Atmospheric pressure at sea level, hPa.
`rain`	Rain precipitation, mm/h.
`snow`	Snow precipitation, mm/h.
`temperature`	Temperature, ºC.
`uv_index`	UV Index.
`visibility`	Average visibility, m.
`weather`	A human-readable description of the weather condition.
`weather_code`	ID of the weather condition.
`wind_bearing`	Wind direction, degrees (meteorological).
`wind_speed`	Wind speed, meter/sec.

Details about the API are available in the OpenWeatherMap documentation.

Action `openweathermap.get_minute_forecast`

This action populates response data with a mapping of minute-by-minute precipitation forecasts (rain or snow) for the next hour.

Note: Minute forecast is available only when the OWM integration mode is set to v3.0. The action will fail if the mode is set to current, forecast, or v2.5.

action: openweathermap.get_minute_forecast
target:
  entity_id:
    - weather.openweathermap
response_variable: weather_forecast

The response data field is a mapping of forecast fields. forecast is a list of 60 forecasted precipitation levels; one for each minute of the next hour:

Response data	Description	Example
`datetime`	The time of the forecasted conditions.	2024-10-19T18:59:00+00:00
`precipitation`	The precipitation amount in mm/h.	1.25

Examples

{% details "Example action response" %}

weather.openweathermap:
  forecast:
    - datetime: "2024-10-19T18:59:00+00:00"
      precipitation: 5.46
    - datetime: "2024-10-19T19:00:00+00:00"
      precipitation: 5.62
    - datetime: "2024-10-19T19:01:00+00:00"
      precipitation: 5.62
    - datetime: "2024-10-19T19:02:00+00:00"
      precipitation: 5.62
    - datetime: "2024-10-19T19:03:00+00:00"
      precipitation: 5.62
    - datetime: "2024-10-19T19:04:00+00:00"
      precipitation: 5.62
    - datetime: "2024-10-19T19:05:00+00:00"
      precipitation: 5.62
    - datetime: "2024-10-19T19:06:00+00:00"
      precipitation: 5.62
    - datetime: "2024-10-19T19:07:00+00:00"
      precipitation: 5.62
    - datetime: "2024-10-19T19:08:00+00:00"
      precipitation: 5.62
    - datetime: "2024-10-19T19:09:00+00:00"
      precipitation: 5.62
    - datetime: "2024-10-19T19:10:00+00:00"
      precipitation: 5.62
    - datetime: "2024-10-19T19:11:00+00:00"
      precipitation: 5.62
    - datetime: "2024-10-19T19:12:00+00:00"
      precipitation: 5.62
    - datetime: "2024-10-19T19:13:00+00:00"
      precipitation: 5.62
    - datetime: "2024-10-19T19:14:00+00:00"
      precipitation: 5.62
    - datetime: "2024-10-19T19:15:00+00:00"
      precipitation: 5.62
    - datetime: "2024-10-19T19:16:00+00:00"
      precipitation: 5.79
    - datetime: "2024-10-19T19:17:00+00:00"
      precipitation: 5.96
    - datetime: "2024-10-19T19:18:00+00:00"
      precipitation: 6.14
    - datetime: "2024-10-19T19:19:00+00:00"
      precipitation: 6.31
    - datetime: "2024-10-19T19:20:00+00:00"
      precipitation: 6.48
    - datetime: "2024-10-19T19:21:00+00:00"
      precipitation: 6.68
    - datetime: "2024-10-19T19:22:00+00:00"
      precipitation: 6.89
    - datetime: "2024-10-19T19:23:00+00:00"
      precipitation: 7.09
    - datetime: "2024-10-19T19:24:00+00:00"
      precipitation: 7.29
    - datetime: "2024-10-19T19:25:00+00:00"
      precipitation: 7.49
    - datetime: "2024-10-19T19:26:00+00:00"
      precipitation: 7.72
    - datetime: "2024-10-19T19:27:00+00:00"
      precipitation: 7.95
    - datetime: "2024-10-19T19:28:00+00:00"
      precipitation: 8.18
    - datetime: "2024-10-19T19:29:00+00:00"
      precipitation: 8.42
    - datetime: "2024-10-19T19:30:00+00:00"
      precipitation: 8.65
    - datetime: "2024-10-19T19:31:00+00:00"
      precipitation: 8.65
    - datetime: "2024-10-19T19:32:00+00:00"
      precipitation: 8.65
    - datetime: "2024-10-19T19:33:00+00:00"
      precipitation: 8.65
    - datetime: "2024-10-19T19:34:00+00:00"
      precipitation: 8.65
    - datetime: "2024-10-19T19:35:00+00:00"
      precipitation: 8.65
    - datetime: "2024-10-19T19:36:00+00:00"
      precipitation: 8.91
    - datetime: "2024-10-19T19:37:00+00:00"
      precipitation: 9.18
    - datetime: "2024-10-19T19:38:00+00:00"
      precipitation: 9.45
    - datetime: "2024-10-19T19:39:00+00:00"
      precipitation: 9.72
    - datetime: "2024-10-19T19:40:00+00:00"
      precipitation: 9.98
    - datetime: "2024-10-19T19:41:00+00:00"
      precipitation: 10.29
    - datetime: "2024-10-19T19:42:00+00:00"
      precipitation: 10.6
    - datetime: "2024-10-19T19:43:00+00:00"
      precipitation: 10.91
    - datetime: "2024-10-19T19:44:00+00:00"
      precipitation: 11.22
    - datetime: "2024-10-19T19:45:00+00:00"
      precipitation: 11.53
    - datetime: "2024-10-19T19:46:00+00:00"
      precipitation: 11.89
    - datetime: "2024-10-19T19:47:00+00:00"
      precipitation: 12.24
    - datetime: "2024-10-19T19:48:00+00:00"
      precipitation: 12.6
    - datetime: "2024-10-19T19:49:00+00:00"
      precipitation: 12.96
    - datetime: "2024-10-19T19:50:00+00:00"
      precipitation: 13.31
    - datetime: "2024-10-19T19:51:00+00:00"
      precipitation: 13.31
    - datetime: "2024-10-19T19:52:00+00:00"
      precipitation: 13.31
    - datetime: "2024-10-19T19:53:00+00:00"
      precipitation: 13.31
    - datetime: "2024-10-19T19:54:00+00:00"
      precipitation: 13.31
    - datetime: "2024-10-19T19:55:00+00:00"
      precipitation: 13.31
    - datetime: "2024-10-19T19:56:00+00:00"
      precipitation: 13.73
    - datetime: "2024-10-19T19:57:00+00:00"
      precipitation: 14.14
    - datetime: "2024-10-19T19:58:00+00:00"
      precipitation: 14.55

{% enddetails %}

12 KiB Raw Blame History