Lock regulator

This action locks or unlocks a regulator setpoint on an LCN module. While a setpoint is locked, its value cannot be changed by the regulator.

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 lock or unlock a regulator setpoint 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 LCN: Lock regulator.
  6. Select the LCN module or group in the Device field, choose the Setpoint.
  7. Optional: In State, select the state of the lock.
  8. Select Save.

This action does not support targets. Instead, you select the LCN module or group through the Device field.

Options in the UI

Device (Required)

The LCN module or group to send the command to.

Setpoint (Required)

The setpoint name.

State (Optional)

Whether the setpoint should be locked. Defaults to off (unlocked).

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 lcn.lock_regulator. 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: lcn.lock_regulator
data:
  device_id: 91aa039a2fb6e0b9f9ec7eb219a6b7d2
  setpoint: r1varsetpoint
  state: true

This locks the first regulator setpoint of the selected module.

Options in YAML

device_id string Required

The device ID of the LCN module or group.

setpoint string Required

The setpoint name. See Variables and units.

state boolean

Whether the setpoint should be locked. If not provided, it is assumed to be 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.

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: