OccupancySensingTrait.HoldTimeLimitsStruct

class OccupancySensingTrait.HoldTimeLimitsStruct : ClusterStruct


Provides information on the server’s supported values for the holdTime attribute.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

HoldTimeLimitsStruct(
    holdTimeMin: UShort,
    holdTimeMax: UShort,
    holdTimeDefault: UShort
)

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

UShort

The default value for the holdTime attribute, in seconds.

UShort

The maximum supported value for the holdTime attribute, in seconds.

UShort

The minimum supported value for the holdTime attribute, in seconds.

Public constructors

HoldTimeLimitsStruct

HoldTimeLimitsStruct(
    holdTimeMin: UShort,
    holdTimeMax: UShort,
    holdTimeDefault: UShort
)

Creates the HoldTimeLimitsStruct class.

Public functions

getDescriptor

@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

holdTimeDefault

val holdTimeDefaultUShort

The default value for the holdTime attribute, in seconds.

holdTimeMax

val holdTimeMaxUShort

The maximum supported value for the holdTime attribute, in seconds.

holdTimeMin

val holdTimeMinUShort

The minimum supported value for the holdTime attribute, in seconds.