mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Update docs for OWM V3.0 (#32609)
This commit is contained in:
Evgeny
GitHub
parent
21b264d55b
commit
f5f1d5a344
@ -25,7 +25,22 @@ There is currently support for the following device types within Home Assistant:
|
|||||||
- Sensor
|
- Sensor
|
||||||
- Weather
|
- 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'>
|
<div class='note'>
|
||||||
|
|
||||||
@ -37,19 +52,16 @@ not be activated yet. Recent policy changes limit the API access for new registe
|
|||||||
|
|
||||||
{% include integrations/config_flow.md %}
|
{% include integrations/config_flow.md %}
|
||||||
|
|
||||||
| Parameter | Value |
|
| Parameter | Value |
|
||||||
| :------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| :-------- | :-------------------------------------------------------- |
|
||||||
| API Key | API Key from the website |
|
| API Key | API Key from the website |
|
||||||
| Name | Name of the integration |
|
| Name | Name of the integration |
|
||||||
| Latitude | Latitude for weather forecast and sensor |
|
| Latitude | Latitude for weather forecast and sensor |
|
||||||
| Longitude | Longitude 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`) |
|
| Language | Language for receiving data (only for `sensor`) |
|
||||||
|
|
||||||
The integration creates a weather entity as well as sensors for supported weather conditions.
|
A `sensor` entity will be created for each supported condition. Their ids will follow the format:
|
||||||
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>`
|
`sensor.<integration name>_<monitored condition>`
|
||||||
|
|
||||||
@ -66,7 +78,7 @@ The Weather entity provides data only in English. Home Assistant automatically t
|
|||||||
### Current Weather Conditions
|
### Current Weather Conditions
|
||||||
|
|
||||||
| Condition | Description |
|
| Condition | Description |
|
||||||
| :----------------------- | :------------------------------------------------------------------------------------------------------------------------------ |
|
| :----------------------- | :-------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `cloud_coverage` | Cloudiness, %. |
|
| `cloud_coverage` | Cloudiness, %. |
|
||||||
| `condition` | [Weather condition](https://developers.home-assistant.io/docs/core/entity/weather/#recommended-values-for-state-and-condition). |
|
| `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. |
|
| `dew_point` | Atmospheric temperature below which water droplets begin to condense and dew can form, ºC. |
|
||||||
@ -86,15 +98,9 @@ The Weather entity provides data only in English. Home Assistant automatically t
|
|||||||
|
|
||||||
### Forecast Weather Conditions
|
### 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 |
|
| Condition | Description |
|
||||||
| :----------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| :----------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `forecast_cloud_coverage` | Cloudiness, %. |
|
| `forecast_cloud_coverage` | Cloudiness, %. |
|
||||||
| `forecast_condition` | [Weather condition](https://developers.home-assistant.io/docs/core/entity/weather/#recommended-values-for-state-and-condition) for the forecast's time period. |
|
| `forecast_condition` | [Weather condition](https://developers.home-assistant.io/docs/core/entity/weather/#recommended-values-for-state-and-condition) for the forecast's time period. |
|
||||||
| `forecast_precipitation` | Combined Rain and Snow volume for the forecast's time period, mm. |
|
| `forecast_precipitation` | Combined Rain and Snow volume for the forecast's time period, mm. |
|
||||||
| `forecast_precipitation_probability` | Probability of precipitation for the forecast's time period. |
|
| `forecast_precipitation_probability` | Probability of precipitation for the forecast's time period. |
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user