ExtendedThermostatTrait.Preset

class ExtendedThermostatTrait.Preset


Information about a preset.

Summary

Public constructors

Preset(
    presetHandle: String,
    presetScenario: ExtendedThermostatTrait.PresetScenario,
    presetMaxHoldSeconds: Int,
    names: List<ExtendedThermostatTrait.PresetSynonyms>
)

Creates the Preset class.

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 properties

names

val namesList<ExtendedThermostatTrait.PresetSynonyms>

Synonyms for the preset in each supported language.

presetHandle

val presetHandleString

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 presetMaxHoldSecondsInt

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 presetScenarioExtendedThermostatTrait.PresetScenario

The type of this preset, which determines which icon will be used to represent this preset on touch surfaces.