Interface ApplyUpdateRequest

Input to the OtaSoftwareUpdateProvider applyUpdateRequest command

See

MatterSpecification.v13.Core § 11.20.6.5.3

interface ApplyUpdateRequest {
    newVersion: number;
    updateToken: Uint8Array;
}

Hierarchy (view full)

Properties

newVersion updateToken

Properties

newVersion

newVersion: number

The NewVersion field included in the request payload shall provide the SoftwareVersion value of the new Software Image which the OTA Requestor is ready to start applying. The OTA Provider may use this new version to track or record Software Image application by OTA Requestors.

When Generated

The ApplyUpdateRequest Command shall be invoked by an OTA Requestor once it is ready to apply a previously downloaded Software Image.

Effect on Receipt

Upon receipt of this command the OTA Provider shall respond with an Action field consistent with the next action the OTA Requestor should take, including any possible time delay.

The OTA Provider shall NOT refer to previously stored state about any download progress to reply. If any state keeping is done by the OTA Provider, it shall only relate to the UpdateToken and the history of prior ApplyUpdateRequest commands.

See Section 11.20.3.6, “Applying a software update” for a description of the flow in response to an OTA Provider receiving an invocation of this command.

Handling Error Cases

See Section 11.20.3.6, “Applying a software update” for all error-handling information.

See

MatterSpecification.v13.Core § 11.20.6.5.3.2

updateToken

updateToken: Uint8Array

This field shall contain the UpdateToken as specified in Section 11.20.3.6.1, “UpdateToken usage”. This field may be used by the OTA Provider to track minimal lifecycle state to allow finer-grained scheduling of the application of Software Images by OTA Requestors.

See

MatterSpecification.v13.Core § 11.20.6.5.3.1

Settings

Member Visibility

On This Page

Properties