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-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs for OWM V3.0 (#32609)

Browse Source
This commit is contained in:
Evgeny 2024-05-25 11:03:30 +02:00 committed by GitHub
parent 21b264d55b
commit f5f1d5a344
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 28 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
source/_integrations/openweathermap.markdown
View File

@ -25,7 +25,22 @@ There is currently support for the following device types within Home Assistant:
- Sensor
- Weather
You need an API key, which is free, but requires a [registration](https://home.openweathermap.org/users/sign_up).
You need an API key, it requires a [subscription](https://openweathermap.org/api/one-call-3). 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.
## ⚠️ Important Deprecation Notice
### OpenWeatherMap API V2.5 Deprecation
OpenWeatherMap API V2.5 will be closed in June 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](https://home.openweathermap.org/subscriptions).
<div class='note'>
@ -38,17 +53,14 @@ not be activated yet. Recent policy changes limit the API access for new registe
{% 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 | Forecast mode, `hourly` for a three-hour forecast, `daily` for daily forecast using a paid API tier, `onecall_hourly` for an hourly forecast up to 2 days, or `onecall_daily` for a daily forecast up to 7 days (ideal for the free tier, default). |
| Mode | API version, `v2.5` (deprecated), `v3.0` new API version. |
| Language | Language for receiving data (only for `sensor`) |
The integration creates a weather entity as well as sensors for supported weather conditions.
Selecting a `onecall` forecast mode with the free tier leverages the One Call API, resulting in updates every 5 minutes and is recommended for both hourly and daily forecast.
A `sensor` entity will be created for each supported condition. Their ids will follow the format:
`sensor.<integration name>_<monitored condition>`
@ -66,7 +78,7 @@ The Weather entity provides data only in English. Home Assistant automatically t
### Current Weather Conditions
| Condition | Description |
| :----------------------- | :------------------------------------------------------------------------------------------------------------------------------ |
| :----------------------- | :-------------------------------------------------------------------------------------------------------------------------------- |
| `cloud_coverage` | Cloudiness, %. |
| `condition` | [Weather condition](https://developers.home-assistant.io/docs/core/entity/weather/#recommended-values-for-state-and-condition). |
| `dew_point` | Atmospheric temperature below which water droplets begin to condense and dew can form, ºC. |
@ -86,12 +98,6 @@ The Weather entity provides data only in English. Home Assistant automatically t
### Forecast Weather Conditions
<div class='note'>
The time period these sensors use depends on the forecast mode selected when configuring the integration: `hourly` or `onecall_hourly` will show conditions for the current hour of the day, while `daily` or `onecall_daily` will show conditions for the current day.
</div>
| Condition | Description |
| :----------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `forecast_cloud_coverage` | Cloudiness, %. |