2026.6.3
Home ▸ Actions

Clear cache

Use this action to clear the Velbus cache and start a new scan. Run it when you make changes to your configuration with the VelbusLink software. You can clear the cache for a single module or for all modules.

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 clear the cache 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. Search for and select Velbus: Clear cache.
  6. Select the Config entry. Optionally, enter a module Address to clear only that module.
  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

Config entry (Required)

The Velbus connection to send the command to.
Address (Optional)

The module address in decimal format. When provided, only this module is cleared. When left empty, the whole cache is cleared. The decimal addresses are shown in front of the modules listed on the integration page.

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 velbus.clear_cache:

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: velbus.clear_cache
data:
  config_entry: "01JGE8XB3MNPZFA836TTZ3KZ46"
  address: 65

This clears the cache for the module with address 65 and then starts a new scan.

Options in YAML

config_entry string Required

The Velbus connection to send the command to.

address integer

The module address in decimal format. When provided, only this module is cleared. When left empty, the whole cache is cleared. The decimal addresses are shown in front of the modules listed on the integration page.

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:

  • Sync clock: Synchronizes the clock of the Velbus modules to the Home Assistant clock.

  • Scan: Scans the Velbus modules on the bus.

  • Set memo text: Shows memo text on the display of Velbus modules.