Scene Control¶
A Switch Group controls the light and color intensity of the selected Tunable White fixtures. Each set of light and color intensity settings for fixtures is called a Scene.
Use this API to set the Scene's light and color intensity for the Switch Group fixtures to achieve the desired effect.
Retrieve the Scene ID and Switch ID returned by the Get Scene Light Levels for a Switch API, and use the Scene ID to set the light levels for each Scene associated with the Switch ID.
Request¶
https://{em_ip_address_or_hostname}/ems/api/org/switch/op/dim/switch/{switch_id}/scene/{scene_id}/{percentage}/{time}
Parameters¶
| Name | Description |
|---|---|
| Request | |
em_ip_address_or_hostname | Manage’s IP address or hostname |
switch_id | Switch Identifier. The Switch ID returned in the Get Scene Light Levels for a Switch for a Switch API. |
scene_id | Scene Identifier. The Scene ID returned Get Scene Light Levels for a Switch for a Switch API. |
percentage | Percentage of light level |
| 0% - Light levels set to off | |
| 100% - Light levels set to full-on. | |
| 101 - Auto: Sets the light level based on the lighting profile behavior | |
| 102 – Sets the scene light level configured for the fixtures when a switch is created on the floor plan in Manage. | |
time | Duration in minutes |
| Response | |
status | 0 - Success, 1 - Failure |
Sample Request¶
Retrieve the Scene ID and Switch ID returned by the Get Scene Light Levels.
Use the Scene ID number of the Scene to set the color intensity for the Scene belonging to a Switch. For example, set fixture lights to Full-on at 100% light levels for 10 minutes for Scene ID '157' belonging to Switch ID '1'.
The response ‘0’ indicates that the Scene is applied to the switch successfully.
POST https://10.8.1.90/ems/api/org/switch/op/dim/switch/1/scene/157/100/10
Sample Response¶
{
"status": "0"
}