1. Enlighted Inc
  2. APIs
  3. Tunable White APIs

Articles in this section

Change Color API

Updated
Print Follow

Changes the color temperature of the 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 colorvalue/time  

 <fixtures>
  <fixture>
   <id>63</id>
  </fixture>
  <fixture>
    <id>145</id>
  </fixture>
</fixtures> 

Parameters

Request
em_ip_address or hostname The Manage IP address or hostname
targetcolorvalue Color Temperature value indicating the requested 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 Code 

Change the color temperature value to 3200 for 60 minutes for fixtures with ID ‘63’ and ‘145’. The response ‘Change color success’ indicates that the color change is applied to the Tunable White fixtures successfully. 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> 

Response Success:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <response>
              <status>0</status>
              <msg>change color success</msg>
   </response>
Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

Related articles

Comments

Article is closed for comments.