Change Color¶
The API changes the color temperature of the Tunable White fixtures to a specified setting for the specified duration.
Request¶
POST https://{em_ip_address_or_hostname}/ems/api/org/sensor/tunable-white/change-color/value/{target_color_value}/{time}
<fixtures>
<fixture>
<id>63</id>
</fixture>
<fixture>
<id>145</id>
</fixture>
</fixtures>
Parameters¶
| Name | Description |
|---|---|
| Request | |
em_ip_address_or_hostname | Manage IP address or hostname |
target_color_value | Color Temperature in Kelvin degrees.The valid range depends on the Fixture Manufacturer Table (FMT) supplied by the manufacturer for the fixture. |
time | Duration in minutes |
| Response | |
status | If the request is successfully handled âChange color successâ message is displayed. When sensor details are missing or inaccurate in the Post command, âSensors list is empty while requesting APIâ message is displayed. |
Sample Request¶
Change the color temperature value to 3200 for 60 minutes using the Fixture ID. The response âChange color successâ indicates that the color change is successfully applied to the Tunable White fixtures. Note that the response is a group response for all fixtures. The response is reported as a success if the message is successfully sent to the sensors.
POST https://10.8.1.90/ems/api/org/sensor/tunable-white/change-color/value/3200/60
<fixtures>
<fixture>
<id>63</id>
</fixture>
<fixture>
<id>145</id>
</fixture>
</fixtures>
Sample Response¶
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
<status>0</status>
<msg>change color success</msg>
</response>