Recall Lighting Scene API

This API is supported for Manage 4.4 release and above and Sensor Firmware version 5.13.x and above.

Use this API to recall the lighting scene for fixtures before the lights were turned off.  When the API parameters are set to 'True' in the API call, the ERC switch activates the last dimmed light level for the fixtures when they are switched on.

For example, if the maximum light level is set at 60% in the conference room and during the presentation, it is reduced to 40% with the remote ERC switch scene button. If for any reason, the lights are turned off  and then turned on using the ERC, the lights will come back at 40% light level. The API will recall the last dimmed setting of the fixtures.

Request

POST https://{em_ip_address_or_hostname}/ems/api/org/switch/{switchId}/editAndApplyChanges

{
   "onOffStickyColor": true,
   "ovrStickyColor": true

}

Parameters

Request

em_ip_address or hostname

The Manage IP address or hostname

Switch ID

Switch Identifier. The Switch ID returned in the Get Switch Groups API

onOffStickyColor

Recall the preset Scene color. 
Set the value to True

ovrStickyColor

Recall the preset scene color after the Override light level duration 
Set the value to True

Response

onOffStickyColor

True – Success; the lights are recalled to the last scene color when they are turned on using the ERC switch.

False - Failure; the preset lighting scene is not recalled; the lights are turned to full maximum light level by default when the lights are turned on.

ovrStickyColor

True - Success; the lights are recalled to the last scene color when they are turned on using the ERC switch after the Override period.

False - Failure; the preset lighting scene is not recalled; the lights are turned to full maximum level by default when the lights are turned on.

Sample Code 

  • When the onOffStickyColor value is set to 'true,' the preset lighting scene is recalled when the ERC is used to turn the lights on. For example, if the maximum light level is set at 60% in the conference room and during the presentation, it is reduced to 40% using the remote ERC switch scene button. If, for any reason, the lights are turned off and then on using the ERC, the lights will come back at 40% light level.
  • When the ovrStickyColor value is set to 'true,' the preset lighting scene is recalled after the override period expires when the ERC is used to turn the lights on. For example, when lights are turned off, the lights return to the Override light level and then to the preset scene 40% after the Override expires. Refer to the Override Light Levels for a description of manual override.
POST https://10.8.1.90/ems/api/org/switch/2/editAndApplyChanges
{
   "onOffStickyColor": true,
   "ovrStickyColor": true

}

 {
      "id":   "3",
      "name":   "Sensor00c017",
      "floorid":   "2",
      "campusid":   "2",            
"xaxis":   "2895",

      "yaxis":   "2895",       
"modetype":   "0",

      "initialsceneactivetime":   "0",
      "extendsceneactivetime":   "0",
      "operationmode":   "0"
      "forceAutoMode":   "0"
      "onOffStickyColor": “true”,
      "ovrStickyColor": “true”
 },

Effect of Circadian Lighting when Enabled

When you use the Recall Preset Scene Lighting API for fixtures with the Circadian option, the Circadian option takes precedence. Therefore, it will indefinitely override the Recall Preset Scene lighting API for the fixtures.

 

Was this article helpful?
0 out of 1 found this helpful
Have more questions? Submit a request

Comments

Article is closed for comments.