Set counter value

Use this action to set a counter to a specific value, instead of stepping it up or down. This is handy when you know the exact number you want, for example to restock a supplies counter after you buy a new pack.

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 counter to a specific value 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. Select what you want to control. Under By target (see Targets), select the counter you want to set.
6. From the actions shown for that target, select Set counter value.
7. Set the Value you want to apply.
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 counter.set_value. A basic example looks like this:

action: counter.set_value
target:
  entity_id: counter.paper_towels
data:
  value: 12

This sets counter.paper_towels to 12.

Options in YAML

Targets of the action

This action requires a target. The target is the object of the action. You can point the action at a single entityAn 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], a device, an area, a floor, or a label, and Home Assistant will run the action on every matching counter entity behind that target.

• Entity: one specific counter entity, such as counter.living_room.
• Device: every counter entity that belongs to a device.
• Area: every counter entity in a room or area.
• Floor: every counter entity on a floor.
• Label: every counter entity that shares a label.

You can also select different target types in one action. For example, you can add a specific entity and an area as targets in the same action to run the action on both of them at once.

Good to know

• The value must be 0 or a positive whole number.
• The value must be a multiple of the counter’s step size, and within the configured minimum and maximum. If it isn’t, the action fails.

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.

Automation: restock a supplies counter

Set a counter to a known amount when you restock, for example to reset a paper towel count after buying a new pack.

• Trigger: Restock button pressed
• Action: Set counter value
  • Target: Paper towels
  • Value: 12

- alias: "Restock the paper towel counter"
  triggers:
    - trigger: state
      entity_id: input_button.paper_towels_restocked
  actions:
    - action: counter.set_value
      target:
        entity_id: counter.paper_towels
      data:
        value: 12

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.

Related actions

These actions work well alongside this one:

• Increment counter: Increases a counter by its step size.

• Decrement counter: Decreases a counter by its step size.

• Reset counter: Resets a counter to its initial value.