ThermostatTrait.GetWeeklyScheduleCommand.Response

class ThermostatTrait.GetWeeklyScheduleCommand.Response : ClusterStruct


The weekly schedule, with the same payload as setWeeklySchedule.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors

Response(
    numberOfTransitionsForSequence: UByte,
    dayOfWeekForSequence: ThermostatTrait.ScheduleDayOfWeekBitmap,
    modeForSequence: ThermostatTrait.ScheduleModeBitmap,
    transitions: List<ThermostatTrait.WeeklyScheduleTransitionStruct>
)

Creates a response payload from the GetWeeklySchedule 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 coolSetpoint and heatSetpoint fields of each transition.

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

Response

Response(
    numberOfTransitionsForSequence: UByte,
    dayOfWeekForSequence: ThermostatTrait.ScheduleDayOfWeekBitmap = ScheduleDayOfWeekBitmap(),
    modeForSequence: ThermostatTrait.ScheduleModeBitmap = ScheduleModeBitmap(),
    transitions: List<ThermostatTrait.WeeklyScheduleTransitionStruct> = emptyList()
)

Creates a response payload from 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

dayOfWeekForSequence

val dayOfWeekForSequenceThermostatTrait.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 modeForSequenceThermostatTrait.ScheduleModeBitmap

How the app decodes the coolSetpoint and heatSetpoint fields of each transition. The bitmap values confirm to those defined in ScheduleModeBitmap.

numberOfTransitionsForSequence

val numberOfTransitionsForSequenceUByte

The number of individual transitions to expect for this sequence of commands.

transitions

val transitionsList<ThermostatTrait.WeeklyScheduleTransitionStruct>

The list of setpoint transitions used to update the specified daily schedules. Each setpoint transition is represented by a WeeklyScheduleTransitionStruct.