Set color mode

The Set color mode action changes the color mode for every color-capable light attached to your ScreenLogic gateway, such as IntelliBrite lights. You can switch the lights to a fixed color, a dynamic show like party or romance, or a control mode such as saving and recalling colors.

This is handy for setting the mood automatically, for example switching to a calm color in the evening or a festive show when guests arrive.

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 the light color mode 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: Set color mode.
  6. Choose the Config entry for your gateway and the Color mode to set.
  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 set the color mode on.

Color mode (Required)

The color mode to set. See the list of color modes below.

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.set_color_mode. 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.set_color_mode
data:
  config_entry: YOUR_CONFIG_ENTRY_ID
  color_mode: romance

This sets all color-capable lights to the romance color mode.

Options in YAML

config_entry string Required

The ScreenLogic gateway to set the color mode on.

color_mode string Required

The color mode to set. See the list of color modes below.

Color modes

The color_mode value accepts one of the following:

  • all_off: Turns all light circuits off.
  • all_on: Turns all light circuits on to their last mode.
  • color_set: Sets light circuits to their preset colors as configured in the pool controller.
  • color_sync: Synchronizes all IntelliBrite, SAm, SAL, or FIBERworks color-changing lights and matches their colors.
  • color_swim: Cycles through white, magenta, blue, and green colors (emulates a Pentair SAm color-changing light).
  • party: Rapid color changing that builds energy and excitement.
  • romance: Slow color transitions for a calming effect.
  • caribbean: Transitions between a variety of blues and greens.
  • american: Patriotic red, white, and blue transitions.
  • sunset: Dramatic transitions of orange, red, and magenta tones.
  • royal: Richer, deeper color tones.
  • save: Saves the exact colors currently being displayed.
  • recall: Recalls the saved colors.
  • blue: Fixed color blue.
  • green: Fixed color green.
  • red: Fixed color red.
  • white: Fixed color white.
  • magenta: Fixed color magenta.
  • thumper: Toggles the solenoid thumper on MagicStream laminars.
  • next_mode: Cycles to the next color mode.
  • reset: Resets the light modes.
  • hold: Holds the light transitions.

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.

Automation: switch to a calm color in the evening

When the evening starts, set the pool lights to a slow, calming color show.

  • Trigger: Sun, after sunset
  • Action: Pentair ScreenLogic: Set color mode
YAML example for an evening color mode
AutomationAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more]
alias: "Evening pool lights"
triggers:
  - trigger: sun
    event: sunset
actions:
  - action: screenlogic.set_color_mode
    data:
      config_entry: YOUR_CONFIG_ENTRY_ID
      color_mode: romance

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: