Set air cleaner mode

Use this action to set the air cleaner mode on a Nexia, American Standard, or Trane thermostat. This setting affects all zones on the same thermostat.

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 air cleaner 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. Select what you want to control. Under By target (see Targets), select the thermostat you want to control.
6. From the actions shown for that target, select Nexia: Set air cleaner mode.
7. Set the Air cleaner mode.
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 nexia.set_aircleaner_mode. A basic example looks like this:

action: nexia.set_aircleaner_mode
target:
  entity_id: climate.downstairs
data:
  aircleaner_mode: allergy

This sets the air cleaner mode of climate.downstairs to allergy.

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

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

Good to know

• This setting affects all zones on the same thermostat.

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.

Related actions

These actions work well alongside this one:

• Set humidify setpoint: Sets the humidify setpoint on a Nexia thermostat.

• Set dehumidify setpoint: Sets the dehumidify setpoint on a Nexia thermostat.

• Set HVAC run mode: Sets the run mode and HVAC mode on a Nexia thermostat.