2026.6.4
Home ▸ Actions

Set install mode

Use this action to put an XML-RPC interface into installation mode so you can pair, or learn, a new device.

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 install 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 Homematic: Set install mode.
  6. Enter the Interface and, optionally, a Mode, Time, and Address.
  7. Select Save.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label. Only users with administrator rights can run this action.

Options in the UI

Interface (Required)

The interface to set into install mode.
Mode

The install mode: 1 for normal mode, or 2 to remove existing old links.
Time

How long to stay in install mode, in seconds.
Address

The address of the Homematic device, or BidCoS-RF, to learn.

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 homematic.set_install_mode:

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: homematic.set_install_mode
data:
  interface: wireless
  time: 120

Options in YAML

interface string Required

The interface to set into install mode.

mode integer

The install mode: 1 for normal mode, or 2 to remove existing old links.

time integer

How long to stay in install mode, in seconds.

address string

The address of the Homematic device, or BidCoS-RF, to learn.

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.

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:

  • Virtual key: Simulates a keypress on a Homematic device or virtual remote.

  • Set device value: Controls a Homematic device manually using its setValue method.

  • Set variable value: Sets the value of a Homematic system variable.

  • Put paramset: Manually changes a Homematic device’s paramset using its putParamset method.

  • Reconnect: Reconnects to all Homematic hubs.