Start super chlorination

The Start super chlorination action begins a super chlorination cycle on your ScreenLogic gateway, raising the chlorine level to shock the pool. You can set how long it runs, or leave it at the default of 24 hours.

This is handy for scheduling a shock treatment automatically, for example after a busy weekend or a spell of hot weather.

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 start super chlorination 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 Pentair ScreenLogic: Start super chlorination.
  6. Choose the Config entry for your gateway and, optionally, set the Run time.
  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 ScreenLogic gateway to start super chlorination on.

Run time (Optional)

The number of hours for super chlorination to run, from 0 to 72. Defaults to 24 hours.

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 screenlogic.start_super_chlorination. 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: screenlogic.start_super_chlorination
data:
  config_entry: YOUR_CONFIG_ENTRY_ID
  runtime: 12

This starts super chlorination for 12 hours.

Options in YAML

config_entry string Required

The ScreenLogic gateway to start super chlorination on.

runtime integer

The number of hours for super chlorination to run, from 0 to 72.

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: