ThermostatTrait.SetWeeklyScheduleCommand.Request
class ThermostatTrait.SetWeeklyScheduleCommand.Request : ClusterStruct
The request payload for the SetWeeklySchedule command.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the SetWeeklySchedule 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 |
|
|---|---|
ThermostatTrait.ScheduleDayOfWeekBitmap |
The day(s) of the week to which all the transitions within the payload of the command should be associated. |
ThermostatTrait.ScheduleModeBitmap |
How the app decodes the |
UByte |
The number of individual transitions to expect for this sequence of commands. |
List<ThermostatTrait.WeeklyScheduleTransitionStruct> |
The list of setpoint transitions used to update the specified daily schedules. |
Public constructors
Request
Request(
numberOfTransitionsForSequence: UByte,
dayOfWeekForSequence: ThermostatTrait.ScheduleDayOfWeekBitmap = ScheduleDayOfWeekBitmap(),
modeForSequence: ThermostatTrait.ScheduleModeBitmap = ScheduleModeBitmap(),
transitions: List<ThermostatTrait.WeeklyScheduleTransitionStruct> = emptyList()
)
Creates a request payload for the SetWeeklySchedule 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
dayOfWeekForSequence
val dayOfWeekForSequence: ThermostatTrait.ScheduleDayOfWeekBitmap
The day(s) of the week to which all the transitions within the payload of the command should be associated. The bitmap values conform to those defined in ScheduleDayOfWeekBitmap.
modeForSequence
val modeForSequence: ThermostatTrait.ScheduleModeBitmap
How the app decodes the coolSetpoint and heatSetpoint fields of each transition. The bitmap values confirm to those defined in ScheduleModeBitmap.
numberOfTransitionsForSequence
val numberOfTransitionsForSequence: UByte
The number of individual transitions to expect for this sequence of commands.
transitions
val transitions: List<ThermostatTrait.WeeklyScheduleTransitionStruct>
The list of setpoint transitions used to update the specified daily schedules. Each setpoint transition is represented by a WeeklyScheduleTransitionStruct.