Interface OperationalCommandResponse

This command shall be supported by an implementation if any of the other commands defined by this cluster are supported (i.e. listed in the AcceptedCommandList global attribute). This command shall also be supported by an implementation of a derived cluster as a response to any commands that may be additionally defined therein.

This command shall be generated in response to any of the Start, Stop, Pause, or Resume commands.

See

MatterSpecification.v13.Cluster § 1.14.6.5

interface OperationalCommandResponse {
    commandResponseState: TypeFromFields<{
        errorStateDetails: OptionalFieldType<string>;
        errorStateId: FieldType<number>;
        errorStateLabel: OptionalFieldType<string>;
    }>;
}

Hierarchy (view full)

Properties

commandResponseState

Properties

commandResponseState

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

This shall indicate the success or otherwise of the attempted command invocation. On a successful invocation of the attempted command, the ErrorStateID shall be populated with NoError. Please see the individual command sections for additional specific requirements on population.

Type declaration

  • 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

See

MatterSpecification.v13.Cluster § 1.14.6.5.1

Settings

Member Visibility

On This Page

Properties