MicrowaveOvenControlTrait.SetCookingParametersCommand.Request

class MicrowaveOvenControlTrait.SetCookingParametersCommand.Request : ClusterStruct

The request payload for the SetCookingParameters command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors
Request(
    cookMode: OptionalValue<UByte>,
    cookTime: OptionalValue<UInt>,
    powerSetting: OptionalValue<UByte>,
    wattSettingIndex: OptionalValue<UByte>,
    startAfterSetting: OptionalValue<Boolean>
)

Creates a request payload for the SetCookingParameters 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
OptionalValue<UByte>

The value to which the currentMode attribute should be set.
OptionalValue<UInt>

The cook time associated with the operation of the device.
OptionalValue<UByte>

The power setting associated with the operation of the device.
OptionalValue<Boolean>

Indicates whether or not the oven should be started when the command is received.
OptionalValue<UByte>

The value to which the selectedWattIndex attribute is set.

Public constructors

Request

Request(
    cookMode: OptionalValue<UByte> = OptionalValue.absent(),
    cookTime: OptionalValue<UInt> = OptionalValue.absent(),
    powerSetting: OptionalValue<UByte> = OptionalValue.absent(),
    wattSettingIndex: OptionalValue<UByte> = OptionalValue.absent(),
    startAfterSetting: OptionalValue<Boolean> = OptionalValue.absent()
)

Creates a request payload for the SetCookingParameters command.

Public functions

getDescriptor

@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

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

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

Public properties

cookMode

val cookMode: OptionalValue<UByte>

The value to which the currentMode attribute should be set.

cookTime

val cookTime: OptionalValue<UInt>

The cook time associated with the operation of the device.

powerSetting

val powerSetting: OptionalValue<UByte>

The power setting associated with the operation of the device.

startAfterSetting

val startAfterSetting: OptionalValue<Boolean>

Indicates whether or not the oven should be started when the command is received.

wattSettingIndex

val wattSettingIndex: OptionalValue<UByte>

The value to which the selectedWattIndex attribute is set.