buzz.getcoco.iot

Class CapabilityLevel.SetLevelOnOff

java.lang.Object

buzz.getcoco.iot.Command<CapabilityLevel.CommandId>

buzz.getcoco.iot.CapabilityLevel.LevelCommand

buzz.getcoco.iot.CapabilityLevel.SetLevelOnOff

Enclosing class:

CapabilityLevel

public static class CapabilityLevel.SetLevelOnOff
extends CapabilityLevel.LevelCommand

This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) to set level to desired value. It can also turn off the resource if CapabilityLevel.LevelCommand.levelPct is set to Zero. And turns on the resource if CapabilityLevel.LevelCommand.levelPct is greater than zero.

   
     SetLevelOnOff command = new SetLevelOnOff(true);
     command.levelPct = 0;

     capabilityOnOff
      .sendResourceCommand(
        command,
        (commandResponse, thr) -> {
         if (thr != null){
            // success case.
         }
     });
   
 

Let's assume that initially the bulb is at brightness level 70. After sending above command the bulb will be turned off as level is set to zero.

Nested Class Summary

Nested classes/interfaces inherited from class buzz.getcoco.iot.Command

Command.State

Field Summary

Fields

Modifier and Type	Field and Description
boolean	restoreLevel Flag indicating whether to set the resource back to its previous level.

Fields inherited from class buzz.getcoco.iot.CapabilityLevel.LevelCommand

levelPct, transitionTime, useDefaultTransitionTime

Constructor Summary

Constructors

Constructor and Description
SetLevelOnOff(boolean useDefaultTransitionTime) Constructor with a param.

Method Summary

Methods inherited from class buzz.getcoco.iot.Command

getCommandId, getTimeout, setCommandId, setTimeout, toJsonObject, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

restoreLevel

@SerializedName(value="restoreLevelFlag")
public boolean restoreLevel

Flag indicating whether to set the resource back to its previous level. CapabilityLevel.LevelCommand.levelPct is optional when this is specified

Constructor Detail

SetLevelOnOff

public SetLevelOnOff(boolean useDefaultTransitionTime)

Constructor with a param.

Parameters:

useDefaultTransitionTime - flag indicating if the transition has to take place. NOTE: The remaining arguments can be set after the object creation.