Manual Override for Switch Group¶
This API allows users to manually override the fixture profile settings associated with a Switch and dim the fixtures for a period of time on the floor.
Request¶
POST https://{em_ip_address_or_hostname}/ems/api/org/switch/v1/op/dimGroup/{floor_id}/{switch_name}/{dimLevel}?time=60
Parameters¶
| Name | Description |
|---|---|
| Request | |
| em_ip_address_or_hostname | Manage’s IP address or hostname |
| floor_id | Floor identifier. Use the 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 the Get Switch Groups API. However, note that all switches on the floor are returned. |
| The recommended path to determine a specific switch name in Manage is select Facility > Floor in the left panel, click Floor Plan tab, and hover the cursor over the switch icon to see the switch name. | |
| dimLevel | Specifies the dim level to which the fixtures in the group should be set to (0-100%, must be a whole number). |
| time | The manual override duration time (must be a whole number). The default time is set to 60 minutes. |
| Response | |
| status | 0 – Override success; |
| 1 – Override failed. |
Sample Request¶
Manually override fixture profile settings on floor 1 associated with switch ‘SwitchGrp1’ (returned in the Get Switch Groups API) to dim the fixtures for 60 minutes using the Manage server IP address. In the example below, all fixtures controlled by the 'SwitchGrp1' switch on Floor 1 will be dimmed for 60 minutes.
POST https://192.80.3.2/ems/api/org/switch/v1/op/dimGroup/1/SwitchGrp1/50?time=60
Sample Response¶
{
"status": "0"
}