ThermostatTrait.ScheduleStruct
class ThermostatTrait.ScheduleStruct : ClusterStruct
A schedule.
Summary
Public constructors |
|---|
ScheduleStruct(Creates the ScheduleStruct class. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
getFieldValueById(tagId: UInt)Returns the value of the field for the given tag ID. |
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 functions
getFieldValueById
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
builtIn
val builtIn: Boolean?
Indicates whether or not the schedule is built-in, meaning that it can be modified but not deleted.
presetHandle
val presetHandle: OptionalValue<ByteArray>
The default preset handle for transitions in this schedule.
systemMode
val systemMode: ThermostatTrait.SystemModeEnum
The default thermostat system mode for transitions in this schedule.
transitions
val transitions: List<ThermostatTrait.ScheduleTransitionStruct>
A list of transitions for the schedule.