ZoneManagementTrait.ZoneTriggerControlStruct

class ZoneManagementTrait.ZoneTriggerControlStruct : ClusterStruct

Settings for controlling zone triggers.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors
ZoneTriggerControlStruct(
    zoneId: UShort,
    initialDuration: UInt,
    augmentationDuration: UInt,
    maxDuration: UInt,
    blindDuration: UInt,
    sensitivity: OptionalValue<UByte>
)

Creates the ZoneTriggerControlStruct 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
UInt

Indicates the duration in seconds that the TriggerDetectedDuration value is to be extended by if the triggering activity is still detected during this period.
UInt

Indicates the duration in seconds after a ZoneStopped event is generated that the Node shall not generate any ZoneTriggered events.
UInt

Indicates the initial duration in seconds after triggering activity is first detected before the Node could generate a ZoneStopped event.
UInt

Indicates the maximum duration in seconds after the initial triggering activity detection that additional triggering activity will be detected.
OptionalValue<UByte>

Indicates the per-zone sensitivity of the underlying zone triggering detection mechanism.
UShort

Unique ZoneID of the zone.

Public constructors

ZoneTriggerControlStruct

ZoneTriggerControlStruct(
    zoneId: UShort,
    initialDuration: UInt,
    augmentationDuration: UInt,
    maxDuration: UInt,
    blindDuration: UInt,
    sensitivity: OptionalValue<UByte> = OptionalValue.absent()
)

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

augmentationDuration

val augmentationDuration: UInt

Indicates the duration in seconds that the TriggerDetectedDuration value is to be extended by if the triggering activity is still detected during this period.

blindDuration

val blindDuration: UInt

Indicates the duration in seconds after a ZoneStopped event is generated that the Node shall not generate any ZoneTriggered events.

initialDuration

val initialDuration: UInt

Indicates the initial duration in seconds after triggering activity is first detected before the Node could generate a ZoneStopped event.

maxDuration

val maxDuration: UInt

Indicates the maximum duration in seconds after the initial triggering activity detection that additional triggering activity will be detected.

sensitivity

val sensitivity: OptionalValue<UByte>

Indicates the per-zone sensitivity of the underlying zone triggering detection mechanism. The higher the value, the more sensitive the detection.

zoneId

val zoneId: UShort

Unique ZoneID of the zone.