Input to the OtaSoftwareUpdateProvider notifyUpdateApplied command

MatterSpecification.v13.Core § 11.20.6.5.5

interface NotifyUpdateAppliedRequest {
    softwareVersion: number;
    updateToken: Uint8Array;
}

Hierarchy (view full)

Properties

softwareVersion: number

The SoftwareVersion included in the request payload shall provide the same value as the SoftwareVersion attribute in the invoking OTA Requestor’s Basic Information Cluster, and SHOULD be consistent with the value representing a new version running on the Node invoking the command.

When Generated

The NotifyUpdateApplied command SHOULD be invoked in the following two circumstances:

  1. An OTA Requestor has just successfully applied a Software Image it had obtained from a previous QueryImage response.

  2. An OTA Requestor has just successfully applied a Software Image it had obtained through means different than those of this Cluster.

An OTA Provider may use the state of invocation of this command to help track the progress of update for OTA Requestors it knows require a new OTA Software Image. However, due to the possibility that an OTA Requestor may never come back (e.g. device removed from Fabric altogether, or a critical malfunction), an OTA Provider shall NOT expect every OTA Requestor to invoke this command for correct operation of the OTA Provider.

This command shall be considered optional and shall not result in reduced availability of the OTA Provider functionality if OTA Requestors never invoke this command.

Effect on Receipt

An OTA Provider receiving an invocation of this command may log it internally.

On receiving this command, an OTA Provider may use the information to update its bookkeeping of cached Software Images, or use it for other similar administrative purposes.

MatterSpecification.v13.Core § 11.20.6.5.5.2

updateToken: Uint8Array

This field shall contain the UpdateToken as specified in Section 11.20.3.6.1, “UpdateToken usage”.

MatterSpecification.v13.Core § 11.20.6.5.5.1