OperationalStateTrait.ErrorStateStruct
class OperationalStateTrait.ErrorStateStruct : ClusterStruct
Used to indicate the error state of the device when the operationalState attribute is Error.
Summary
Public constructors |
|---|
ErrorStateStruct(Creates the ErrorStateStruct class. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
getFieldValueById(tagId: UInt)Returns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
OptionalValue<String> |
Details about the error condition. |
UByte |
|
OptionalValue<String> |
Present only when |
Public constructors
ErrorStateStruct
ErrorStateStruct(
errorStateId: UByte,
errorStateLabel: OptionalValue<String> = OptionalValue.absent(),
errorStateDetails: OptionalValue<String> = OptionalValue.absent()
)
Creates the ErrorStateStruct class.
Public functions
getFieldValueById
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
errorStateLabel
val errorStateLabel: OptionalValue<String>
Present only when errorStateId is populated with a vendor-specific error ID.