2026.6.4
Home ▸ Actions

Upgrade firmware

The Upgrade firmware action upgrades the firmware on a Guardian valve controller.

By default, the valve controller upgrades to the latest firmware published by Guardian. If you need to install a specific firmware image, you can point the action at a custom URL, port, and filename.

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 upgrade the firmware 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 Guardian: Upgrade firmware.
  6. Select the Valve controller to upgrade. Optionally, enter a custom URL, Port, and Filename.
  7. Select Save. This action does not support targets. In the UI, you are not prompted to choose an area, entity, or label. You select the valve controller through the Valve controller option instead.

Options in the UI

Valve controller (Required)

The valve controller to upgrade.
URL (Optional)

The URL of the server hosting the firmware image. If not provided, the latest firmware from Guardian is used.
Port (Optional)

The port on the server hosting the firmware image.
Filename (Optional)

The filename of the firmware image on the server.

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 guardian.upgrade_firmware. 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: guardian.upgrade_firmware
data:
  device_id: 1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d

This upgrades the selected valve controller to the latest firmware from Guardian.

Options in YAML

device_id string Required

The ID of the valve controller device to upgrade.

url string

The URL of the server hosting the firmware image. If not provided, the latest firmware from Guardian is used.

port integer

The port on the server hosting the firmware image.

filename string

The filename of the firmware image on the server.

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:

  • Pair sensor: Adds a new paired sensor to the valve controller.

  • Unpair sensor: Removes a paired sensor from the valve controller.