Interface State

interface State {
    defaultOtaProviders: TypeFromFields<{
        endpoint: FieldType<EndpointNumber>;
        fabricIndex: FieldType<FabricIndex>;
        providerNodeId: FieldType<NodeId>;
    }>[];
    updatePossible: boolean;
    updateState: OtaSoftwareUpdateRequestor.UpdateState;
    updateStateProgress: null | number;
}

Hierarchy

  • StateType
    • State

Properties

defaultOtaProviders updatePossible updateState updateStateProgress

Properties

ReadonlydefaultOtaProviders

defaultOtaProviders: TypeFromFields<{
    endpoint: FieldType<EndpointNumber>;
    fabricIndex: FieldType<FabricIndex>;
    providerNodeId: FieldType<NodeId>;
}>[]

This field is a list of ProviderLocation whose entries shall be set by Administrators, either during Commissioning or at a later time, to set the ProviderLocation for the default OTA Provider Node to use for software updates on a given Fabric.

There shall NOT be more than one entry per Fabric. On a list update that would introduce more than one entry per fabric, the write shall fail with CONSTRAINT_ERROR status code.

Provider Locations obtained using the AnnounceOTAProvider command shall NOT overwrite values set in the DefaultOTAProviders attribute.

See

MatterSpecification.v13.Core § 11.20.7.5.1

ReadonlyupdatePossible

updatePossible: boolean

This field shall be set to True if the OTA Requestor is currently able to be updated. Otherwise, it shall be set to False in case of any condition preventing update being possible, such as insufficient capacity of an internal battery. This field is merely informational for diagnostics purposes and shall NOT affect the responses provided by an OTA Provider to an OTA Requestor.

See

MatterSpecification.v13.Core § 11.20.7.5.2

ReadonlyupdateState

updateState: OtaSoftwareUpdateRequestor.UpdateState

This field shall reflect the current state of the OTA Requestor with regards to obtaining software updates. See Section 11.20.7.4.2, “UpdateStateEnum Type” for possible values.

This field SHOULD be updated in a timely manner whenever OTA Requestor internal state updates.

See

MatterSpecification.v13.Core § 11.20.7.5.3

ReadonlyupdateStateProgress

updateStateProgress: null | number

This field shall reflect the percentage value of progress, relative to the current UpdateState, if applicable to the state.

The value of this field shall be null if a progress indication does not apply to the current state.

A value of 0 shall indicate that the beginning has occurred. A value of 100 shall indicate completion.

This field may be updated infrequently. Some care SHOULD be taken by Nodes to avoid over- reporting progress when this attribute is part of a subscription.

See

MatterSpecification.v13.Core § 11.20.7.5.4

Settings

Member Visibility

On This Page

Properties