Automation API trait support on iOS

Stay organized with collections Save and categorize content based on your preferences.

The Automation API supports most traits, but support for some attributes, events, and commands in a trait may be limited.

To verify that the Automation API supports your use case, search in the table below.

In general:

• Any traits and types that you intend to use in your app with the Automation API must be registered at initialization. See Home configuration.
• Any attribute may be used in starters or conditions.
• Cloud-to-cloud devices that don't report their state cannot be used as triggers in automations, created either manually or through discovery.

• Even if a device supports supports the traits listed here, a device may be blocked from use as a starter or action in the Automation API due to Report State quality thresholds:

  • Devices with a Report State success rate lower than 90% are blocked from use as starters.
  • Devices with a command execution success rate lower than 95% are blocked from use as actions.

  Refer to this list of device models and the specific starters and actions that they support for the Automations API.

• Commands can only be used as actions.

• Some traits have prerequisites:

  • In order to use TimeTrait.ScheduledEvent, the structure in which the automation runs must have a street address that was set up in the Google Home app (GHA). Change Google home address explains how a user can enter the structure address. If the address is not set up in the GHA, the automation fails to create, and an error is thrown.

Simplified versions of some traits are also available for use in automations. For more information, see Simplified traits on iOS.

A block indicates that the command is not supported in automations for one or more device types. For more information, refer to Blocked actions in automations on iOS.