Skip to content

PaulVanSchayck/ha-nl-weather

Repository files navigation

NL Weather

GitHub Release

NL Weather is a Home Assistant integration that provides weather forecasts, observations, precipitation (e.g. rain) radar and warnings in The Netherlands — using open data directly fetched from KNMI (the Royal Netherlands Meteorological Institute).

Screenshot of NL Weather

Using default cards and radar in bright color theme

Screenshot of NL Weather with dark mode radar

In this screenshot the custom card Weather Forecast Extended is used to display the forecast, warnings and observations. For the radar image the “Picture with entity” card is used.

Features

  • Integration as a Home Assistant weather entity provider
    • Observations and forecast separated into two weather entities
  • Can have multiple configurable locations (limited to the Netherlands) with
    • Current weather observations (temperature, humidity, wind, etc.)
    • Weather forecast (hourly/daily)
    • Weather alerts (issued by KNMI)
  • Precipitation / rain radar and forecast (rain intensity, movement, etc.)
    • Can mark home location on the radar image
    • Radar has a dark and light color theme
  • Weather observations can be fetched in two modes
    1. Manually select a weather station
    2. Automatically fetch the closest observations from one or more weather station
  • Data fetched directly from official KNMI APIs
    • Requires account at KNMI Data Platform
    • Uses KNMI's MQTT Notification Service to reduce polling

Installation

Via HACS (recommended)

  1. Ensure you have HACS installed in your Home Assistant.
  2. Search for NL Weather and install.
  3. Restart Home Assistant if required.

Manual Installation

If you prefer manual install (or HACS is not available):

  1. Download or clone this repository.
  2. Copy the folder custom_components/nl_weather to your Home Assistant custom_components/ directory.
  3. Restart Home Assistant.

Configuration

After adding the integration you'll first need to configure your API keys.

Step 1. Connect to KNMI Data Platform APIs

You can get API keys from https://developer.dataplatform.knmi.nl/. Register an account and request keys for:

  1. EDR API
  2. Web Map Service (WMS)
  3. Notification Service

You'll receive copies of all keys via e-mail as well.

Important

The API keys you receive look very similar for all services. This is correct. The end and beginning of the keys will be the same, but the middle does differ.

Step 2. Add the integration and enter your API keys

Add the integration via Settings → Devices & Services → Add Integration → NL Weather

Tip

If the integration does not show up after installing via HACS or copying manually — try clearing browser cache, restart Home Assistant again, and verify that the folder structure is correct (i.e. custom_components/nl_weather/…).

A form is shown where you can enter your API keys for:

  1. EDR API
  2. Web Map Service (WMS)
  3. Notification Service (MQTT)

Step 3. Configure a weather location

To start receiving weather observations and forecasts, add a location: Settings → Devices & services → NL Weather → Add location

Enter (or modify) the GPS coordinates of your location. The region you set will determine for which region you will receive weather alerts.

Entities created

The integration creates the following entities for each configured location:

Weather entities

  • weather.weer_{location}_observations for current weather observations
  • weather.weer_{location}_forecast for the weather forecast

Sensor entities

  • Weather alert text and alert level
  • Forecast temperature sensors for today's and tomorrow's highs and lows
  • Observations
    • Temperature (air at 1.5 m and 10 cm and soil at -10 cm)
    • Relative humidity
    • Dew point
    • Visibility
    • Air pressure at mean sea level
    • Wind speed
    • Wind gusts
    • Wind direction (in degrees and cardinal)
    • Cloud coverage
    • Cloud ceiling
    • Sunshine duration
    • Solar radiation
  • Observation time, station distance, and station name as diagnostic sensors

Available observation sensors depend on the selected weather station. Airport stations usually provide the most complete set of measurements. More information about observations can be found in KNMI documentation.

When using automatic station selection, observation values can come from multiple nearby stations (per parameter). In that case:

  • Station name shows all contributing stations, ordered by how often they were used
  • Station distance shows the distance that was used most often
  • Observation time shows the most frequent observation timestamp among contributing stations

This allows you to use the data in automations, dashboards, and scripts just like with any other weather integration.

Contributing

Contributions, bug reports, feature requests are welcome. Feel free to open an issue or submit a pull request.

License

Apache License, Version 2.0

Disclaimer / Notes

  • Forecast, weather observations, radar and weather warnings provided by Koninklijk Nederlands Meteorologisch Instituut (KNMI) licensed under CC-BY 4.0

Discussion

For further help or discussion you can use this Home Assistant Community Forum thread.


Thank you for using NL Weather! If you like it, please consider starring the repo ⭐

About

An HA integration providing weather forecast, observations, precipitation (e.g. rain) radar and warnings in The Netherlands using KNMI data

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages