CookTrait.CookCommand.Request
class CookTrait.CookCommand.Request : ClusterStruct
The request payload for the Cook command.
Summary
Nested types |
|---|
|
Descriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the Cook command. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
@HomeExperimentalApiReturns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
CookTrait.CookingMode |
Cooking mode for the device, as indicated by the |
String |
The food preset requested by the user, as indicated by the |
Float |
Quantity of the food requested by the user. |
Boolean |
If set to |
CookTrait.Unit |
Unit associated with the quantity, as indicated by the |
Public constructors
Request
Request(
start: Boolean = false,
cookingMode: CookTrait.CookingMode = CookingMode.UnknownCookingMode,
foodPreset: String = "",
quantity: Float = 0.0f,
unit: CookTrait.Unit = Unit.UnknownUnits
)
Creates a request payload for the Cook 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
cookingMode
val cookingMode: CookTrait.CookingMode
Cooking mode for the device, as indicated by the currentCookingMode attribute.
foodPreset
val foodPreset: String
The food preset requested by the user, as indicated by the currentFoodPreset attribute.
unit
val unit: CookTrait.Unit
Unit associated with the quantity, as indicated by the currentFoodUnit attribute.