Change setting

Use this action to change a setting on a Home Connect appliance, for example to turn on the child lock or switch the appliance into a different mode. You pick the appliance, the setting you want to change, and the value to set.

Settings are identified by their Home Connect key, such as BSH.Common.Setting.ChildLock. The value can be text, an integer, or a toggle, depending on what the setting expects.

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 change a setting 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 list of actions, search for and select Change setting.
  6. Select the appliance you want to change.
  7. Enter the key of the setting and the value to set.
  8. Select Save.

Options in the UI

Device

The Home Connect appliance you want to change.

Key

The key of the setting to change, such as BSH.Common.Setting.ChildLock.

Value

The value to set for the setting. The accepted value depends on the setting.

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 home_connect.change_setting. A basic example that turns on the child lock 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: home_connect.change_setting
data:
  device_id: a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6
  key: "BSH.Common.Setting.ChildLock"
  value: true

Options in YAML

device_id string Required

The device ID of the Home Connect appliance you want to change.

key string Required

The key of the setting to change, such as BSH.Common.Setting.ChildLock.

value string Required

The value to set for the setting. The accepted value depends on the setting and can be text, a number, or a toggle (true or false).

Good to know

  • Which settings you can change depends on your appliance. The Home Connect API does not always match the Home Connect app, so some settings available in the app may not work through Home Assistant.
  • The value must match the type the setting expects. A toggle uses true or false, while other settings expect text or an integer.

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.

Automation: lock the appliance controls when you leave home

Turn on the child lock on your oven when everyone leaves, so the controls can’t be changed while you’re away.

  • Trigger: Everyone leaves home
  • Action: Change setting
    • Key: BSH.Common.Setting.ChildLock
    • Value: true
Show example YAML
AutomationAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more]
alias: "Lock the oven controls when away"
triggers:
  - trigger: state
    entity_id: zone.home
    to: "0"
actions:
  - action: home_connect.change_setting
    data:
      device_id: a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6
      key: "BSH.Common.Setting.ChildLock"
      value: true

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:

  • Set program and options: Starts or selects a program on a Home Connect appliance, or sets the options for the active or selected program.

  • Start selected program: Starts the program that is already selected on a Home Connect appliance.