Get forecast

The Get forecast action retrieves the Stookwijzer advice forecast and returns it as response data.

This is useful when you want an automation or a template to read upcoming Stookwijzer advice, for example to decide whether to light a wood fire later in the day.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label. Instead, you select which Stookwijzer instance to query through the Stookwijzer instance option.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To get the forecast from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. From the search box, search for and select Stookwijzer: Get forecast.
6. Choose the Stookwijzer instance to get the forecast from.
7. In the Response variable field, enter a name to store the forecast in, such as stookwijzer_forecast.
8. Select Save.

Options in the UI

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as stookwijzer.get_forecast. Because this action returns a response, use response_variable to capture the result. A basic example looks like this:

action: stookwijzer.get_forecast
data:
  config_entry_id: 1b4a46c6d0f3406c80d275f5b0c6483b
response_variable: stookwijzer_forecast

Options in YAML

Response data

The response contains a forecast field. forecast is a list of advice entries, each with the following fields:

• datetime: The time of the forecasted advice, for example 2025-02-12T17:00:00+01:00.
• advice: The forecasted advice code, for example code_yellow.
• final: Whether the advice is final or can still change, either true or false.

An example response looks like this:

forecast:
  - datetime: "2025-02-12T17:00:00+01:00"
    advice: code_yellow
    final: true
  - datetime: "2025-02-12T23:00:00+01:00"
    advice: code_yellow
    final: true
  - datetime: "2025-02-13T05:00:00+01:00"
    advice: code_orange
    final: false
  - datetime: "2025-02-13T11:00:00+01:00"
    advice: code_red
    final: false

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.