ExtendedThermostatTrait.Preset
class ExtendedThermostatTrait.Preset : ClusterStruct
Information about a preset.
Summary
Nested types |
|---|
|
Descriptor enum for this struct's fields. |
Public constructors |
|---|
Preset(Creates the Preset class. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
@HomeExperimentalApiReturns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
List<ExtendedThermostatTrait.PresetSynonyms> |
Synonyms for the preset in each supported language. |
String |
The internal handle of the temperature preset that is used in commands and states. |
Int |
The maximum number of seconds this preset can be held. |
ExtendedThermostatTrait.PresetScenario |
The type of this preset, which determines which icon will be used to represent this preset on touch surfaces. |
Public constructors
Preset
Preset(
presetHandle: String = "",
presetScenario: ExtendedThermostatTrait.PresetScenario = PresetScenario.Unspecified,
presetMaxHoldSeconds: Int = 0,
names: List<ExtendedThermostatTrait.PresetSynonyms> = emptyList()
)
Creates the Preset class.
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
names
val names: List<ExtendedThermostatTrait.PresetSynonyms>
Synonyms for the preset in each supported language.
presetHandle
val presetHandle: String
The internal handle of the temperature preset that is used in commands and states. This handle can be non-user-friendly, and it is shared across all languages.
presetMaxHoldSeconds
val presetMaxHoldSeconds: Int
The maximum number of seconds this preset can be held. A setting of -1 means there is is no limit on the hold duration. If unset, holding this preset is not supported.
presetScenario
val presetScenario: ExtendedThermostatTrait.PresetScenario
The type of this preset, which determines which icon will be used to represent this preset on touch surfaces.