ThermostatTrait.ScheduleTransitionStruct

class ThermostatTrait.ScheduleTransitionStruct : ClusterStruct


A schedule transition.

Summary

Public constructors

ScheduleTransitionStruct(
    dayOfWeek: ThermostatTrait.ScheduleDayOfWeekBitmap,
    transitionTime: UShort,
    presetHandle: OptionalValue<ByteArray>,
    systemMode: OptionalValue<ThermostatTrait.SystemModeEnum>,
    coolingSetpoint: OptionalValue<Short>,
    heatingSetpoint: OptionalValue<Short>
)

Creates the ScheduleTransitionStruct class.

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<Short>

The cooling setpoint for the transition.

ThermostatTrait.ScheduleDayOfWeekBitmap

A bitmask of days of the week that the transition applies to.

OptionalValue<Short>

The cooling setpoint for the transition.

OptionalValue<ByteArray>

The preset used at the transition time.

OptionalValue<ThermostatTrait.SystemModeEnum>

The default mode to which the thermostat will switch for this transition, overriding the default for the schedule.

UShort

The time of day at which the transition becomes active, in terms of minutes within the day.

Public constructors

ScheduleTransitionStruct

ScheduleTransitionStruct(
    dayOfWeek: ThermostatTrait.ScheduleDayOfWeekBitmap = ScheduleDayOfWeekBitmap(),
    transitionTime: UShort,
    presetHandle: OptionalValue<ByteArray> = OptionalValue.absent(),
    systemMode: OptionalValue<ThermostatTrait.SystemModeEnum> = OptionalValue.absent(),
    coolingSetpoint: OptionalValue<Short> = OptionalValue.absent(),
    heatingSetpoint: OptionalValue<Short> = OptionalValue.absent()
)

Creates the ScheduleTransitionStruct class.

Public functions

getDescriptor

open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

open fun getFieldValueById(tagId: UInt): Any?

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

Public properties

coolingSetpoint

val coolingSetpointOptionalValue<Short>

The cooling setpoint for the transition.

dayOfWeek

val dayOfWeekThermostatTrait.ScheduleDayOfWeekBitmap

A bitmask of days of the week that the transition applies to.

heatingSetpoint

val heatingSetpointOptionalValue<Short>

The cooling setpoint for the transition.

presetHandle

val presetHandleOptionalValue<ByteArray>

The preset used at the transition time.

systemMode

val systemModeOptionalValue<ThermostatTrait.SystemModeEnum>

The default mode to which the thermostat will switch for this transition, overriding the default for the schedule.

transitionTime

val transitionTimeUShort

The time of day at which the transition becomes active, in terms of minutes within the day.