ArmDisarmTrait.Levels

class ArmDisarmTrait.Levels : ClusterStruct

Information about security-level names.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors
Levels(
    level: String,
    levelValues: List<ArmDisarmTrait.LevelValues>,
    levelCategory: ArmDisarmTrait.LevelCategory,
    exitAllowanceSeconds: UInt
)

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

Number of seconds before the currentArmLevel takes effect.
String

The internal name of the security level that is used in commands and states.
ArmDisarmTrait.LevelCategory

The security-level category.
List<ArmDisarmTrait.LevelValues>

Repeated sets of synonyms for a specific langauage.

Public constructors

Levels

Levels(
    level: String = "",
    levelValues: List<ArmDisarmTrait.LevelValues> = emptyList(),
    levelCategory: ArmDisarmTrait.LevelCategory = LevelCategory.Unknown,
    exitAllowanceSeconds: UInt
)

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

exitAllowanceSeconds

val exitAllowanceSeconds: UInt

Number of seconds before the currentArmLevel takes effect.

level

val level: String

The internal name of the security level that is used in commands and states. This name can be non user friendly and is shared across all languages.

levelCategory

val levelCategory: ArmDisarmTrait.LevelCategory

The security-level category.

levelValues

val levelValues: List<ArmDisarmTrait.LevelValues>

Repeated sets of synonyms for a specific langauage.