Smart Home LightEffects Trait Schema

action.devices.traits.LightEffects - This trait belongs to devices that can support complex lighting commands to change state, such as looping through various colors.

Device ATTRIBUTES

Devices with this trait may report the following attributes as part of the SYNC operation. To learn more about handling SYNC intents, see Intent fulfillment.

Examples

Device supporting color loop effect.

{
  "supportedEffects": [
    "colorLoop"
  ]
}

Device supporting sleep/wake effects.

{
  "defaultSleepDuration": 300,
  "defaultWakeDuration": 600,
  "supportedEffects": [
    "sleep",
    "wake"
  ]
}

Device STATES

Entities with this trait may report the following states as part of the QUERY operation. To learn more about handling QUERY intents, see Intent fulfillment.

Examples

What is the current effect on my device?

{
  "activeLightEffect": "colorLoop"
}

What is the current effect on my device?

{
  "activeLightEffect": "sleep",
  "lightEffectEndUnixTimestampSec": 1595286869
}

No light effect currently active.

{}

Device COMMANDS

Devices with this trait may respond to the following commands as part of the EXECUTE operation. To learn more about handling EXECUTE intents, see Intent fulfillment.

action.devices.commands.ColorLoop

Request the device to cycle through a set of colors.

{
  "supportedEffects": [
    "colorLoop"
  ]
}

Parameters

Examples

Colorloop my lights for 60 minutes.

{
  "command": "action.devices.commands.ColorLoop",
  "params": {
    "duration": 3600
  }
}

action.devices.commands.Sleep

Gradually lower the device's brightness and, optionally, adjusts the color temperature over a duration of time.

{
  "supportedEffects": [
    "sleep"
  ]
}

Parameters

Examples

Make my lights sleep for 60 minutes.

{
  "command": "action.devices.commands.Sleep",
  "params": {
    "duration": 3600
  }
}

action.devices.commands.StopEffect

Stop the current light effect.

Parameters

Examples

Stop the effect on my light.

{
  "command": "action.devices.commands.StopEffect",
  "params": {}
}

action.devices.commands.Wake

Gradually increase the device's brightness and, optionally, adjusts the color temperature over a duration of time.

{
  "supportedEffects": [
    "wake"
  ]
}

Parameters

Examples

Make my lights wake for 60 minutes.

{
  "command": "action.devices.commands.Wake",
  "params": {
    "duration": 3600
  }
}

Light effects emulation

If your device implements the Brightness trait but not the LightEffects trait, the platform supports emulated "sleep" and "wake" effects, without the need for additional code. The platform emulates the effects by sending a series of EXECUTE intents.

Sample utterances

Device ERRORS