2026.6.3
Home ▸ Actions

Set GPIO mode

The Set GPIO mode action changes the function of the GPIO pins on your OpenTherm Gateway. For an explanation of the available modes, see GPIO modes.

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 set a GPIO mode 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 OpenTherm Gateway: Set GPIO mode.
  6. Enter the Gateway ID, choose the GPIO ID, and set the Mode.
  7. Select Save.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label.

Options in the UI

Gateway ID (Required)

The ID of the OpenTherm Gateway, as specified during configuration.
ID (Required)

The ID of the GPIO pin. One of A or B.
Mode (Required)

The mode to set on the GPIO pin. Values 0 through 6 are accepted for both pins, and 7 is only accepted for GPIO B. See GPIO modes for an explanation of the values.

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 opentherm_gw.set_gpio_mode. A basic example looks like this:

ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more] 
action: opentherm_gw.set_gpio_mode
data:
  gateway_id: opentherm_gateway
  id: A
  mode: 5

This sets GPIO pin A to the home function on the selected gateway.

Options in YAML

gateway_id string Required

The ID of the OpenTherm Gateway, as specified during configuration.

id string Required

The ID of the GPIO pin. One of A or B.

mode integer Required

The mode to set on the GPIO pin. Values 0 through 6 are accepted for both pins, and 7 is only accepted for GPIO B. See GPIO modes for an explanation of the values.

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.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup.

Tip

You don’t need to edit YAML to use these examples. Copy a YAML snippet from this page, open the automation editor in Home Assistant, and press Ctrl+V (or Cmd+V on Mac). Home Assistant automatically converts the pasted YAML into the visual editor format, whether it’s a full automation, a single trigger, a condition, or an action.

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.

Tip

AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.

Related actions

These actions work well alongside this one: