FillTrait.FillCommand.Request

class FillTrait.FillCommand.Request : ClusterStruct

The request payload for the Fill command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors
Request(fill: Boolean, fillLevel: String, fillPercent: Float)

Creates a request payload for the Fill command.

Public functions
open StructDescriptor

Returns the descriptor for the struct.
open Any?

Returns the value of the field for the given tag ID.

Public properties
Boolean

Set to true to fill, false to drain.
String

The levelName from the availableFillLevels attribute to set.
Float

The requested level percentage.

Public constructors

Request

Request(fill: Boolean = false, fillLevel: String = "", fillPercent: Float = 0.0f)

Creates a request payload for the Fill command.

Public functions

getDescriptor

@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

fill

val fill: Boolean

Set to true to fill, false to drain.

fillLevel

val fillLevel: String

The levelName from the availableFillLevels attribute to set. If unspecified, fill to the default level.

fillPercent

val fillPercent: Float

The requested level percentage.