A light

Any device that either is, or controls, an output generally used for lighting. This could be an LED bulb or a lamp module connected to a table lamp. This device could also represent a relay module, which can technically be connected to a non-lighting device.

Properties

Name Description Type/Values Optional Setter Action Monitored/Stream
activateSceneButtonId Single Tap button ID to trigger a scene number
activePower The active power (in Watts) that the device is currently using. number
currentLevel The current level of the output in the range 0% to 100%. number
defaultMoveRate The rate at which the load on the device transitions between one level and another. number
doubleTapButtonId Double Tap button ID to perform an action number
fadeRate The rate at which the device transitions between On and Off in "% per second" number
hue The current color hue number
isDimmable Removes dimming and allows the control of non-dimmable loads radio
  • True
  • False
keypadMode Removes the ability for the device to control the load attached radio
  • On
  • Off
ledBrightnessLevelOff The brightness level the LEDs on the device when the load is off. number
ledBrightnessLevelOn The brightness level the LEDs on the device when the load is on. number
ledDayModeBrightnessLevelOff The brightness level the LEDs on the device when in day mode and the load is off. number
ledDayModeBrightnessOn The daytime brightness level the LEDs on the device when the load is off. number
ledMode The mode (Day/Night/None) of the device that controls the brightness level of the LEDs on the device. radio
  • None
  • Day
  • Night
ledNightModeBrightnessLevelOff The brightness level the LEDs on the device when in night mode and the load is off. number
ledNightModeBrightnessOn The nighttime brightness level the LEDs on the device when the load is off. number
minimumAllowedLevel The minimum level the load will dim down to. number
onOff The state of the light (on or off) string
presetLevel The level (1% to 100%) that the device will go to when an 'On' action is issued. Setting this value to 0% will disable this feature number
safePlugPower Power reported from a SafePlug device number
safePlugTagId The tag id connected to the SafePlug number
saturation The current color saturation number
softOff The rate at which the device transitions from On to Off in "% per second" (overrides fadeRate). number
softOn The rate at which the device transitions from Off to On in "% per second" (overrides fadeRate). number

Actions

Name Description Parameters
ChangeColor set the current hue/saturation value
hue (number)
The desired hue (0 to 360)
saturation (number)
The desired saturation (0% to 100%)
transitionTime (number)
How long the device should take to transition from its color value to the provided color value in seconds (0 for instant)
ChangeLevel Change the currentLevel of the device
level (number)
The desired level (0% to 100%)
transitionTime (number)
How long the device should take to transition from its currentLevel value to the provided 'level' value in seconds (0 for instant)
FadeDown Decrease the currentLevel over time
rate (number)
The rate of change in "% per second" or 0 for instant.
FadeUp Increase the currentLevel over time
rate (number)
The rate of change in "% per second" or 0 for instant.
Off Change the onOff state on 'off'
On Change the onOff state to 'on'
SetDefaultMoveRate Set the property defaultMoveRate
defaultMoveRate (number)
The rate at which the load on the device transitions between one level and another.
SetFadeRate Set the property fadeRate
fadeRate (number)
The rate at which the device transitions between On and Off in "% per second"
SetIsDimmable Set the property isDimmable
isDimmable (True,False)
Removes dimming and allows the control of non-dimmable loads
SetKeypadMode Set the property keypadMode
keypadMode (On,Off)
Removes the ability for the device to control the load attached
SetLedBrightnessLevelOff Set the property ledBrightnessLevelOff
ledBrightnessLevelOff (number)
The brightness level the LEDs on the device when the load is off.
SetLedBrightnessLevelOn Set the property ledBrightnessLevelOn
ledBrightnessLevelOn (number)
The brightness level the LEDs on the device when the load is on.
SetLedDayModeBrightnessLevelOff Set the property ledDayModeBrightnessLevelOff
ledDayModeBrightnessLevelOff (number)
The brightness level the LEDs on the device when in day mode and the load is off.
SetLedDayModeBrightnessOn Set the property ledDayModeBrightnessOn
ledDayModeBrightnessOn (number)
The daytime brightness level the LEDs on the device when the load is off.
SetLedMode Set the property ledMode
ledMode (None,Day,Night)
The mode (Day/Night/None) of the device that controls the brightness level of the LEDs on the device.
SetLedNightModeBrightnessLevelOff Set the property ledNightModeBrightnessLevelOff
ledNightModeBrightnessLevelOff (number)
The brightness level the LEDs on the device when in night mode and the load is off.
SetLedNightModeBrightnessOn Set the property ledNightModeBrightnessOn
ledNightModeBrightnessOn (number)
The nighttime brightness level the LEDs on the device when the load is off.
SetLedState Set the desired LED to the desired state
ledId (Top,Middle,Bottom)
The desired LED to change
ledState (On,Off)
The desired state to change the LED to.
SetMinimumAllowedLevel Set the property minimumAllowedLevel
minimumAllowedLevel (number)
The minimum level the load will dim down to.
SetPresetLevel Set the property presetLevel
presetLevel (number)
The level (1% to 100%) that the device will go to when an 'On' action is issued. Setting this value to 0% will disable this feature
SetSoftOff Set the property softOff
softOff (number)
The rate at which the device transitions from On to Off in "% per second" (overrides fadeRate).
SetSoftOn Set the property softOn
softOn (number)
The rate at which the device transitions from Off to On in "% per second" (overrides fadeRate).
StepDown Decrease the currentLevel by a set amount over time
amount (number)
The amount to change currentLevel in "%".
transitionTime (number)
How long the device should take to transition from its currentLevel value to the provided 'level' value in seconds (0 for instant)
StepUp Increase the currentLevel by a set amount over time
amount (number)
The amount to change currentLevel in "%".
transitionTime (number)
How long the device should take to transition from its currentLevel value to the provided 'level' value in seconds (0 for instant)
Stop If the device is transitioning (Fade, Step, SetLevel, etc) then stop
Toggle Change the onOff state from 'off => on' or 'on => off'