Skip to content

Scenes

Jump to bottom
Michelle Staley edited this page Jan 18, 2023 · 3 revisions

With Scenes you can simultaneously set a group of devices to a particular state.

Scenes are different from Automations. For example, an Automation can be configured to "Notify me if a door opens when I'm not home." This Automation, when activated, will wait for the door to open when you are not home to notify you.

On the other hand a Scene can be configured as "Turn on my living room light, turn off my bedroom light, turn on my kitchen light, and set the brightness level and pick this color," and this Scene will set these devices instantly as soon as the Scene is activated.

Scenes do not have triggers; Automations do. Moreover, a Scene can be used as a part of an Automation. Find out more about Scenes here.

Functions

Note: The list of functions can be found here.

  • list - Returns a list of scenes filtered by the specified options. If a location ID is included in the options or the client has been configured with a location ID, then only the scenes in that location are returned. If there is no locationId configured or specified, then the scenes in all locations accessible to the principal are returned. Optional options parameter for filtering the location Id.

  • get - Get a specific scene. Requires the UUID of the scene.

  • execute - Execute the actions specified in the a secene. Requires the Id for the scene to be executed.

Clone this wiki locally