Get Scene Light Levels for a Switch

July 12, 2022 18:38 Updated

When a switch is created, a virtual switch is added to the floor plan, which controls the light levels of the selected fixtures. Each set of light level settings for fixtures is called a scene. A maximum of six scenes can be created. Each fixture in a scene can have different light levels to achieve the desired effect.

The API returns the scene light levels for the group of fixtures controlled by the scene.

Request

GET https://{em_ip_address_or_hostname}/ems/api/org/scene/v1/list/getSceneLevels/{sceneid}

Parameters

Request
em_ip_address or hostname	The Enlighted Manage (EM) IP address or hostname.
sceneid	Scene identifier. Returned in Get Switch Scenes API.
Response
id	For internal use.
switchid	Switch identifier.
sceneid	Scene identifier. Up to a maximum of six scenes can be defined.
fixtureid	Fixture identifier of the fixture for which the scene applies.
lightlevel	Returns the light level (0-100%) for each fixture for the scene. 0% - Light level is set to off. 100% - Light level is set to full-on.
scenecolor	Current color temperature value in Kelvin degrees

Sample Code

Using the Scene ID '157' returned by the Get Switch Scenes API, request the scene light levels for the fixtures. The API returns the light levels for the scene controlled by the scene with ID ‘157’.

Get https://192.80.3.2/ems/api/org/scene/v1/list/getSceneLevels/157

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json
Content-Length: 7582
Date: Sat, 21 Jul 2015 17:06:51 GMT

{
  "sceneLevel": [
  {
    "id": "6",                   **scene level identifier**
    "switchid": "7",             **switch identifier**
    "sceneid": "157",            **scene identifier**
    "fixtureid": "885",          **fixture identifier**
    "lightlevel": "100"          **light level**
    "sceneColor": "3200"         **color temp value**
  },
  {
    "id": "9",                  **scene level identifier**
    "switchid": "7",            **switch identifier**
    "sceneid": "157",           **scene identifier**
    "fixtureid": "886",         **fixture identifier**
    "lightlevel": "60"          **light level**  
    "sceneColor": "3600"        **color temp value**
  }
 ]
}

Articles in this section

Request

Parameters

Sample Code

Related articles

Comments