Interface OperationalErrorEvent

Body of the OperationalState operationalError event

MatterSpecification.v13.Cluster § 1.14.7.1

interface OperationalErrorEvent {
    errorState: TypeFromFields<{
        errorStateDetails: OptionalFieldType<string>;
        errorStateId: FieldType<number>;
        errorStateLabel: OptionalFieldType<string>;
    }>;
}

Properties

errorState: TypeFromFields<{
    errorStateDetails: OptionalFieldType<string>;
    errorStateId: FieldType<number>;
    errorStateLabel: OptionalFieldType<string>;
}>

errorStateDetails: OptionalFieldType<string>
This shall be a human-readable string that provides details about the error condition. As an example, if the ErrorStateID indicates that the device is a Robotic Vacuum that is stuck, the ErrorStateDetails contains "left wheel blocked".

See
MatterSpecification.v13.Cluster § 1.14.4.4.3
errorStateId: FieldType<number>
This shall be populated with a value from the ErrorStateEnum.

See
MatterSpecification.v13.Cluster § 1.14.4.4.1
errorStateLabel: OptionalFieldType<string>
This field shall be present if the ErrorStateID is from the set reserved for Manufacturer Specific Errors, otherwise it shall NOT be present. If present, this shall contain a human-readable description of the ErrorStateID; e.g. for a manufacturer specific ErrorStateID of "0x80" the ErrorStateLabel may contain "My special error".

See
MatterSpecification.v13.Cluster § 1.14.4.4.2