LevelControlTrait.StepCommand

object LevelControlTrait.StepCommand : CommandDescriptor

Move a device's level a specific amount over a period of time.

If the stepSize used results in a currentLevel that is greater than the maxLevel or less than the minLevel, then the command stops when the currentLevel reaches the maxLevel or minLevel, respectively.

The command may complete in a shorter time than specified for transitionTime if the maxLevel or minLevel is reached before the transition time is over.

See also
step

Use this command from the trait(LevelControl) method.

Summary

Nested types

The request payload for the Step command.

Descriptor enum for this command's request fields.

Public functions
open Field?

Public properties
open String

Unique id corresponding to the command.
open String

Human-friendly name of the command.

Public functions

getCommandRequestFieldByName

@HomeExperimentalGenericApi
open fun getCommandRequestFieldByName(name: String): Field?

Public properties

commandId

open val commandId: String

Unique id corresponding to the command.

commandName

open val commandName: String

Human-friendly name of the command.