Scene Control API

When a switch group is created in Manage, a virtual switch is added to the floor which controls the light and color intensity of the selected fixtures. Each set of light and color intensity settings for fixtures is called a scene.

Using this API, set the light and color intensity of the scene for the fixtures in the switch group to achieve the desired effect. Use the Scene ID and Switch ID returned by the Get Scene Light Levels for a Switch API call to set the light levels for each scene.  

Request

POST https://{em_ip_address_or_hostname}/ems/api/org/switch/op/dim/switch/switchid/scene/sceneid/percentage/time

Parameters

Request
em_ip_address or hostname The Manage IP address or hostname
switchid Switch Identifier. The Switch ID returned in the Get Scene Light Levels for a Switch API
sceneid Scene Identifier. The Scene ID returned in the Get Scene Light Levels 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 Code 

Using the Scene ID and Switch ID returned by the Get Scene Light Levels for a Switch API, set the color intensity for the Scene with ID ‘157’  belonging to the switch with ID ‘1’ to 100% Full on for 10 mins. 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
 {
  "status": "0"
}

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.