Get Switch Scenes¶
The API returns the Switch Group details and scene information. A Switch Group controls the light levels of selected fixtures. Each set of light level settings for fixtures is called a scene.
For example, in a conference room, typical scenes include
- using a projector when the lights should be off (all off), or
- during a meeting when the lights should be on (all on).
Request¶
GET https://{em_ip_address_or_hostname}/ems/api/org/switch/v1/getSwitchScenes/{floor_id}/{switch_name}
Parameters¶
Request¶
| Parameter | Description |
|---|---|
em_ip_address_or_hostname | Manage’s IP address or hostname |
floor_id | Floor identifier. Use th Get All Floors API, or in EM, select Facility > Floor > in the left panel, and click the Settings tab to obtain the Floor ID. |
switch_name | Switch name. Returned in Get Switch Groups API, or in EM, select Facility > Floor in the left panel, click Floor Plan tab, and hover the cursor over the switch icon to see the switch name. |
Response¶
| Parameter | Description |
|---|---|
id | Switch Identifier to which the scene belongs. |
name | Switch name |
scenes | List of scenes. A maximum of six scenes can be created for a switch. For each scene, the following parameters are displayed. |
- id - Scene identifier (used as the primary identifier in other API calls). | |
- switchid - Switch identifier to which the scene belongs. | |
- name - Scene name. | |
- sceneOrder - Order of scenes on the associated Enlighted Room Control (ERC) switch. |
Sample Request¶
Send a request to provide the scene details using the Switch Name (SwitchGrp2) returned in the Get Switch Groups and Floor ID returned in the Get All Floors API.
For example, if the SwitchGrp2 switch is configured for two scenes: All On and All Off, the following switch details are returned, as shown below.
GET https://192.80.3.2/ems/api/org/switch/v1/getSwitchScenes/1/SwitchGrp2
Sample Response¶
{
"id":"7",
"name":"SwitchGrp2",
"scenes":[
{
"id":"157",
"switchid":"7",
"name":"All On",
"sceneOrder":"1"
},
{
"id":"158",
"switchid":"7",
"name":"All Off",
"sceneOrder":"2"
}
]
}
Community
Connect and Collaborate with Industrial Professionals and Join the Community!