ThermostatTrait.PresetTypeStruct

class ThermostatTrait.PresetTypeStruct : ClusterStruct


A preset type.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

PresetTypeStruct(
    presetScenario: ThermostatTrait.PresetScenarioEnum,
    numberOfPresets: UByte,
    presetTypeFeatures: ThermostatTrait.PresetTypeFeaturesBitmap
)

Creates the PresetTypeStruct 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

UByte

The limit for the number of presets for this PresetScenarioEnum.

ThermostatTrait.PresetScenarioEnum

A PresetScenarioEnum supported by this thermostat.

ThermostatTrait.PresetTypeFeaturesBitmap

A bitmap of features for this preset.

Public constructors

PresetTypeStruct

PresetTypeStruct(
    presetScenario: ThermostatTrait.PresetScenarioEnum = PresetScenarioEnum.Occupied,
    numberOfPresets: UByte,
    presetTypeFeatures: ThermostatTrait.PresetTypeFeaturesBitmap = PresetTypeFeaturesBitmap()
)

Creates the PresetTypeStruct 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

numberOfPresets

val numberOfPresetsUByte

The limit for the number of presets for this PresetScenarioEnum.

presetScenario

val presetScenarioThermostatTrait.PresetScenarioEnum

A PresetScenarioEnum supported by this thermostat.

presetTypeFeatures

val presetTypeFeaturesThermostatTrait.PresetTypeFeaturesBitmap

A bitmap of features for this preset.