TlvPayloadTestRequest: ObjectSchema<{
    count: FieldType<number>;
    enableKey: FieldType<Uint8Array>;
    value: FieldType<number>;
}> = ...

Input to the GeneralDiagnostics payloadTestRequest command

Type declaration

  • count: FieldType<number>

    This field shall indicate the number of times to repeat the Value in the PayloadTestResponse’s Payload field.

    Effect upon receipt

    This command shall respond with a response status of CONSTRAINT_ERROR if either:

    • The EnableKey field does not match the a-priori value configured on the device.

    • The TestEventTriggersEnabled field is currently false.

    Otherwise, the server shall respond with a PayloadTestResponse command with a Payload field value containing Count instances of the Value byte. If the response is too large to send, the server shall fail the command and respond with a response status of RESOURCE_EXHAUSTED.

    For example:

    • If Value is 0x55 and the Count is zero, then the PayloadTestResponse would have the Payload field set to an empty octet string.

    • If Value is 0xA5 and the Count is 10, the PayloadTestResponse would have the Payload field set to a content whose hexadecimal representation would be A5A5A5A5A5A5A5A5A5A5, and base64 representation would be paWlpaWlpaWlpQ==.

    MatterSpecification.v13.Core § 11.12.7.4.3

  • enableKey: FieldType<Uint8Array>

    This field shall have the same meaning and usage as the TestEventTrigger EnableKey field.

    MatterSpecification.v13.Core § 11.12.7.4.1

  • value: FieldType<number>

    This field shall indicate the value to use in every byte of the PayloadTestResponse’s Payload field.

    MatterSpecification.v13.Core § 11.12.7.4.2

MatterSpecification.v13.Core § 11.12.7.4