8000 Improve MetOffice documentation by avee87 · Pull Request #39591 · home-assistant/home-assistant.io · GitHub
[go: up one dir, main page]
Skip to content

Improve MetOffice documentation #39591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: current
Choose a base branch
from
Draft

Improve MetOffice documentation #39591

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b889b9a
Improved MetOffice documentation
avee87 Jun 17, 2025
7f3c920
better
avee87 Jun 17, 2025
c7d5e4a
formatting
avee87 Jun 17, 2025
3657f99
improvements
avee87 Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 38 additions & 16 deletions source/_integrations/metoffice.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,31 +18,53 @@ ha_integration_type: integration

The **Met Office** weather {% term integration %} uses the Met Office's [DataHub API](https://www.metoffice.gov.uk/services/data/met-office-weather-datahub) for weather data.

Details about the API are available in the [DataHub API documentation](https://datahub.metoffice.gov.uk/docs/f/category/site-specific/overview). The [datapoint-python](https://github.com/EJEP/datapoint-python) library is used to retrieve data.

## Prerequisites

1. Register for a [Met Office DataHub](https://datahub.metoffice.gov.uk/) account.
2. After registration, [subscribe](https://datahub.metoffice.gov.uk/profile/subscriptions) to [Site Specific Global Spot](https://datahub.metoffice.gov.uk/pricing/site-specific) dataset to obtain your API key. Free tier subscription gives 360 calls per day, which is enough for using this integration
2. After registration, [subscribe](https://datahub.metoffice.gov.uk/profile/subscriptions) to [Site Specific Global Spot](https://datahub.metoffice.gov.uk/pricing/site-specific) dataset to obtain your API key. Free tier subscription gives 360 calls per day, which is enough to use this integration for one weather site.

{% include integrations/config_flow.md %}

| Option | Description |
| :-------- | :--------------------------------------------------------- |
| API Key | API Key for MetOffice DataHub |
| Latitude | Latitude of the location, defaults to your home latitude |
| Longitude | Longitude of the location, defaults to your home longitude |

## Entities

This integration creates a number of weather entities for each entry created in the configuration by location: one weather entity with a summary and a forecast (daily, hourly, and twice-daily), and sensor entities for individual reporting on each of the individual measurements. Note that only some of the sensor entities flagged below are enabled by default, so your system isn't overrun on initial configuration.
### Weather

The available sensor entities:
| Entity ID | Description |
| :------------------------ | :------------------------------------------------------------------------------------------------ |
| `weather.<location name>` | Main weather entity for the given location. Daily, hourly and twice-daily forecasts are available |

- "feels like" temperature
- humidity
- probability of precipitation
- station name
- temperature
- UV index
- visibility
- weather
- wind direction
- wind gust
- wind speed
### Sensor

Only probability of precipitation, temperature, weather and wind speed are enabled by default.
Separate sensors are created for each of the following weather conditions:

Details about the API are available in the [DataHub API documentation](https://datahub.metoffice.gov.uk/docs/f/category/site-specific/overview). The [datapoint-python](https://github.com/EJEP/datapoint-python) library is used to retrieve data.
| Condition | Description | Enabled by default |
| :----------------------- | :------------------------------------------------------------------------------------------------------------------------------ | ------------------ |
| `weather` | [Weather condition](https://developers.home-assistant.io/docs/core/entity/weather/#recommended-values-for-state-and-condition). | Yes |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • avoid tables and use lists instead.
  • Please use the sensor name as it is displayed in the UI, not in YAML

| `temperature` | Temperature, ºC. | Yes |
| `feels_like_temperature` | Temperature accounting for the human perception of weather, ºC. | No |
| `humidity` | Relative humidity, %. | No |
| `wind_speed` | Wind speed, m/s. | Yes |
| `wind_gust` | Wind gust speed, m/s. | No |
| `wind_direction` | Wind direction, degrees. | No |
| `visibility` | Visibility distance in meters. | No |
| `uv` | UV index. | No |
| `precipitation` | Probability of precipitation, %. | Yes |
| `name` | Name of the weather station. | No |

Entity IDs follow the format:

`sensor.<location name>_<condition>`

## Removing the integration

This integration follows standard integration removal.

{% include integrations/remove_device_service.md %}
0