Update documentation for the OpenWeatherMap integration (#17060)

This commit is contained in:
Hans Kröner 2021-03-19 19:53:44 +01:00 committed by GitHub
parent f00dd8f833
commit 74c5623323
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -37,35 +37,61 @@ You need an API key, which is free, but requires a [registration](https://home.o
| 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). |
| Language | Language for receiving data (only for `sensor`) |
The integration creates weather entity and also sensors for all available conditions.
Selecting a `onecall` 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.
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.
For each condition `sensor` entity will be created with id:
A `sensor` entity will be created for each supported condition. Their ids will follow the format:
`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. |
Sensors provide data in the language that was selected when configuring the integration.
<div class='note'>
Weather entity always will have English language. Home Assistant translate it to user language automatically.
The Weather entity provides data only in English. Home Assistant automatically translates it to the language configured for the frontend.
</div>
## Supported Weather Conditions
### 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. |
| `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 volume for the last hour, mm. |
| `snow` | Snow volume for the last hour, mm. |
| `temperature` | Temperature, ºC. |
| `uv_index` | UV Index. |
| `weather` | A human-readable description of the [weather condition](https://openweathermap.org/weather-conditions#Weather-Condition-Codes-2). |
| `weather_code` | ID of the [weather condition](https://openweathermap.org/weather-conditions#Weather-Condition-Codes-2). |
| `wind_bearing` | Wind direction, degrees (meteorological). |
| `wind_speed` | Wind speed, metre/sec. |
### 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_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_probability` | Probability of precipitation for the forecast's time period. |
| `forecast_pressure` | Atmospheric pressure at sea level for the forecast's time period, hPa. |
| `forecast_temperature` | Maximum temperature for the day. |
| `forecast_temperature_low` | Minimum temperature for the day. |
| `forecast_time` | Time of the forecasted data. |
| `forecast_wind_bearing` | Wind direction for the forecast's time period, degrees (meteorological). |
| `forecast_wind_speed` | Wind speed for the forecast's time period, metre/sec. |
Details about the API are available in the [OpenWeatherMap documentation](https://openweathermap.org/api).