ThermostatTrait.GetWeeklyScheduleCommand.Request
class ThermostatTrait.GetWeeklyScheduleCommand.Request : ClusterStruct
The request payload for the GetWeeklySchedule command.
Summary
Nested types |
|---|
@HomeExperimentalApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the GetWeeklySchedule 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 |
|
|---|---|
ThermostatTrait.ScheduleDayOfWeekBitmap |
The number of days the client would like to return the set point values for. |
ThermostatTrait.ScheduleModeBitmap |
Indicates the mode the client would like to return the set point values for. |
Public constructors
Request
Request(
daysToReturn: ThermostatTrait.ScheduleDayOfWeekBitmap = ScheduleDayOfWeekBitmap(),
modeToReturn: ThermostatTrait.ScheduleModeBitmap = ScheduleModeBitmap()
)
Creates a request payload for the GetWeeklySchedule 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
daysToReturn
val daysToReturn: ThermostatTrait.ScheduleDayOfWeekBitmap
The number of days the client would like to return the set point values for. It can be any combination of single days or the entire week.
modeToReturn
val modeToReturn: ThermostatTrait.ScheduleModeBitmap
Indicates the mode the client would like to return the set point values for. It can be any combination of modes.