LevelControlTrait.StopCommand

object LevelControlTrait.StopCommand : CommandDescriptor


Terminate a Move, MoveToLevel, or Step command (including their OnOff variants) currently in progress, and sets the remainingTime attribute to 0.

This command and StopWithOnOff are identical.

See also
stop

Use this command from the trait(LevelControl) method.

Summary

Nested types

The request payload for the Stop command.

Descriptor enum for this command's request fields.

Public properties

open String

Unique id corresponding to the command.

Public functions

getCommandRequestFieldById

@HomeExperimentalApi
open fun getCommandRequestFieldById(tagId: UInt): Field?

getCommandRequestFieldByName

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

Public properties

commandId

open val commandIdString

Unique id corresponding to the command.