Set primary filtration

Use this action to update the primary filtration cycle settings on your hot tub. You can set how long the cycle runs and when it starts.

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 update the primary filtration settings 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 SmartTub: Update primary filtration settings.
6. Select what you want to control. Under By target (see Targets), select your hot tub’s primary filtration cycle sensor.
7. Optionally, set a Duration and a Start hour.
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 smarttub.set_primary_filtration. A basic example looks like this:

action: smarttub.set_primary_filtration
target:
  entity_id: sensor.jacuzzi_j_335_primary_filtration_cycle
data:
  duration: 4
  start_hour: 2

This sets the primary filtration cycle to run for four hours, starting at 02:00.

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 sensor entity behind that target.

• Entity: one specific sensor entity, such as sensor.living_room.
• Device: every sensor entity that belongs to a device.
• Area: every sensor entity in a room or area.
• Floor: every sensor entity on a floor.
• Label: every sensor 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.

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.

Script: schedule filtration for off-peak hours

Run this script to set the primary filtration cycle to run overnight, when electricity is often cheaper.

sequence:
  - action: smarttub.set_primary_filtration
    target:
      entity_id: sensor.jacuzzi_j_335_primary_filtration_cycle
    data:
      duration: 6
      start_hour: 1

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.