Stookwijzer smart home integration, free and open source
RIVM wood-burning advice (yellow, orange, red) for your house in the Netherlands.
Published by guim31
- Devices
- Version 1.0.0
- Requires Gladys >=5.1.0
- ★ 0
The Stookwijzer of the RIVM (the Dutch National Institute for Public Health and the Environment) tells, for each 4-digit postcode area of the Netherlands, whether lighting a wood stove, a fireplace, a patio heater or a fire pit now bothers the neighbourhood. This integration brings that advice into Gladys for each of your houses: a device with the current advice and the next blocks, the wind and the air quality index, a dashboard widget and scene triggers.
The Stookwijzer only covers the Netherlands. Outside, the integration has nothing to show and says so. It is not affiliated with the RIVM.
What you get
- One Stookwijzer device per house of Gladys located in the Netherlands.
- The advice in three codes, as the RIVM gives them:
- Yellow: "Caution: burning wood causes nuisance and air pollution" (wind force 3 or more and LKI 3 or less);
- Orange: "Better not to burn wood now" (wind force 3 or more and LKI 4, 5 or 6);
- Red: "Do not burn wood" (wind force 2 or less, or LKI 7 or more).
- The advice of the next three 6-hour blocks (04:00-10:00, 10:00-16:00, 16:00-22:00 and 22:00-04:00, Dutch time).
- The wind speed (m/s), the wind force (Beaufort) and the air quality index (LKI, 1 to 11) the advice is based on.
- A dashboard widget and three scene triggers.
There is no code green: not burning wood is always the best advice for a healthy environment, so the RIVM deliberately left it out.
Requirements
- Gladys Assistant 5.1 or later.
- A house with a location in Gladys (Settings, Houses, the map of the house), in the Netherlands. The integration asks for access to the location of your houses when you install it: it is only used to find the postcode area, and only the converted point is sent to the RIVM.
- Internet access from Gladys to
data.rivm.nl. No account, no key.
Configuration
- Install the integration and accept the access to the location of your houses.
- In Configuration, pick the language of the feature names, of the advice text and of the scene variables (French by default). The feature names are set when the device is created: choose the language first.
- Open the Discover tab: one "Stookwijzer house" device appears for each house located in the Netherlands. Add it to Gladys.
A location added or changed later in Gladys is read again at the next hourly reading, or right away with the Scan button of the Discover tab.
Devices
Each "Stookwijzer house" device has eight features, all read-only:
| Feature | Type | Values |
|---|---|---|
| Current advice | Risk level | 1 yellow, 2 orange, 3 red |
| Advice | Text | "Orange — Better not..." |
| Next block advice | Risk level | 1 yellow, 2 orange, 3 red |
| Advice in 2 blocks | Risk level | 1 yellow, 2 orange, 3 red |
| Advice in 3 blocks | Risk level | 1 yellow, 2 orange, 3 red |
| Wind speed | Speed (m/s) | 0 to 60 |
| Wind force (Beaufort) | Speed | 0 to 12 |
| Air quality index (LKI) | Air quality index | 1 to 11 |
Gladys labels the risk levels "Low", "Medium" and "High": they stand for yellow, orange and red. "No risk" (0) is never used. The advice of the current block and of the next one is final; the two after are provisional and may still change until 6 hours before they start.
The values are read once an hour. Only the values that changed are sent to Gladys, plus all of them every 12 hours so that the dashboard never shows "no recent value".
Dashboard widget
Add the Stookwijzer widget to a dashboard. It shows the advice of the current block in words, the wind force and the LKI as live tiles, a list of the current and next three blocks with their colour (the provisional ones are marked), the postcode area, and a button to the official Stookwijzer page. In its settings, pick the house; left empty, the first Stookwijzer device is shown.
Scene triggers
In the scene editor, under the integration:
- Stookwijzer: code red (do not burn wood): the current advice of the house turns red.
- Stookwijzer: code red is over: the current advice is yellow or orange again. You can keep only one of the two with the "New advice" filter.
- Stookwijzer: code red announced for the next block: the next block is red for certain (final advice) while it is not red now. Fired once per block, about 6 hours ahead.
Each trigger can be limited to one house. The following actions can use
{{triggerEvent.data.advice_text}}, starts_at and ends_at (the hours of
the block, in the time zone of Gladys), postcode, wind_force and lki.
A trigger never fires on the very first reading of a house, nor again after a restart of the integration for the same advice. A device must be added to Gladys for its triggers to fire.
Scene examples
- Warn before lighting the stove: trigger "code red announced for the next block", action "Send a message": "Code red from {{triggerEvent.data.starts_at}}: do not burn wood."
- Stove reminder in the evening: at 18:00, if "Current advice" of the house is 3 (High), send "Stookwijzer: do not light the stove tonight."
- Back to normal: trigger "code red is over", filter "Yellow", turn off the red light strip that showed the alert.
Data sources and quotas
The advice comes from the open geo service of the RIVM (data.rivm.nl/geo/alo,
layer stookwijzer_v2), the same data as the Stookwijzer page of the Atlas
Leefomgeving. The integration asks once an hour per house, which is what the
Stookwijzer needs: the advice changes per 6-hour block. The wind and the LKI
are model calculations (KNMI, RIVM) averaged per block: they may differ from
the measurements and the wind at your house.
Troubleshooting
- No device in Discover: give your house a location in Gladys, in the Netherlands, then press Scan. The status of the Configuration screen says why: no located house, or houses outside the Netherlands.
- "The RIVM geo service does not answer": the last advice stays shown; the integration tries again every 10 minutes.
- The feature names are in the wrong language: they are set when the device is created. Change the language, delete the device and add it again (its history is lost).
- For the details, set
LOG_LEVEL=debugand read the logs of the integration.
Limits
- Netherlands only; the advice is that of the 4-digit postcode area of the house.
- Developed and tested with the real RIVM data, but without an orange or red advice on the day of development: those cases are tested on modified recordings. Feedback welcome.
- The Stookwijzer is an advice. Some municipalities forbid burning wood under code orange or red: check your local rules.
- Not affiliated with the RIVM.
Configuration settings
These are the settings Stookwijzer asks for in its configuration screen in Gladys.
| Setting | Type | Required | Description |
|---|---|---|---|
| Wood-burning advice for your house | section | No | The Stookwijzer of the RIVM says, per postcode area, whether lighting a stove or fireplace now bothers the neighbours: yellow, orange or red. Give your house a location in Gladys, then add its device in the Discover tab. |
| Sources and limits | section | No | Data: RIVM open geo service (Stookwijzer layer), read hourly without an account. Netherlands only. The advice comes from model calculations and may differ from local conditions. Not affiliated with the RIVM. |
| Language of the names and texts | select | No | Feature names (set when the device is created), advice text and scene variables. |
How to install Stookwijzer in Gladys
- In Gladys, open Integrations: Stookwijzer appears in the catalog, next to the native integrations, with a community badge.
- Click Install. Gladys pulls the Docker image (
ghcr.io/guim31/gladys-stookwijzer:1.0.0), starts it in a sandbox isolated from the core, and generates the integration's interface (devices, discovery and configuration). - Open the Configuration screen of the integration, fill in the settings, and save.
- You can also install it directly from its repository URL: https://github.com/guim31/gladys-stookwijzer.
Stookwijzer requires Gladys >=5.1.0. The catalog inside Gladys refreshes every hour, so a new version becomes available at most one hour after its release.
Not running Gladys yet? It is free and open source: follow the installation guide to get started.
About external integrations
Stookwijzer is an external integration: a community integration packaged as a Docker container and published on GitHub, that Gladys installs in one click and runs in a sandbox isolated from its core. It is published and maintained by guim31, not by the Gladys core team.
- Browse all integrations, native and community
- Build and publish your own external integration
- Source code on GitHub — source of this documentation