ThermostatTrait.ScheduleStruct

class ThermostatTrait.ScheduleStruct


A schedule.

Summary

Public constructors

ScheduleStruct(
    scheduleHandle: ByteArray?,
    systemMode: ThermostatTrait.SystemModeEnum,
    name: OptionalValue<String>,
    presetHandle: OptionalValue<ByteArray>,
    transitions: List<ThermostatTrait.ScheduleTransitionStruct>,
    builtIn: Boolean?
)

Creates the ScheduleStruct class.

Public properties

Boolean?

Indicates whether or not the schedule is built-in, meaning that it can be modified but not deleted.

OptionalValue<String>

The name for the schedule.

OptionalValue<ByteArray>

The default preset handle for transitions in this schedule.

ByteArray?

A device generated identifier for this schedule.

ThermostatTrait.SystemModeEnum

The default thermostat system mode for transitions in this schedule.

List<ThermostatTrait.ScheduleTransitionStruct>

A list of transitions for the schedule.

Public constructors

ScheduleStruct

ScheduleStruct(
    scheduleHandle: ByteArray? = null,
    systemMode: ThermostatTrait.SystemModeEnum = SystemModeEnum.Off,
    name: OptionalValue<String> = OptionalValue.absent(),
    presetHandle: OptionalValue<ByteArray> = OptionalValue.absent(),
    transitions: List<ThermostatTrait.ScheduleTransitionStruct> = emptyList(),
    builtIn: Boolean? = null
)

Creates the ScheduleStruct class.

Public properties

builtIn

val builtInBoolean?

Indicates whether or not the schedule is built-in, meaning that it can be modified but not deleted.

name

val nameOptionalValue<String>

The name for the schedule.

presetHandle

val presetHandleOptionalValue<ByteArray>

The default preset handle for transitions in this schedule.

scheduleHandle

val scheduleHandleByteArray?

A device generated identifier for this schedule.

systemMode

val systemModeThermostatTrait.SystemModeEnum

The default thermostat system mode for transitions in this schedule.

transitions

val transitionsList<ThermostatTrait.ScheduleTransitionStruct>

A list of transitions for the schedule.