OperationalStateTrait.OperationalError
interface OperationalStateTrait.OperationalError : ClusterStruct
This event is generated when a reportable error condition is detected.
Summary
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
@HomeExperimentalApiReturns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
OperationalStateTrait.ErrorStateStruct? |
Indicates the type of error, if any, that has occurred. |
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
errorState
val errorState: OperationalStateTrait.ErrorStateStruct?
Indicates the type of error, if any, that has occurred.