Interface State

interface State {
    granularity: TimeSynchronization.Granularity;
    timeSource?: TimeSynchronization.TimeSource;
    utcTime: null | number | bigint;
}

Hierarchy

  • StateType
    • State

Properties

granularity timeSource? utcTime

Properties

Readonlygranularity

granularity: TimeSynchronization.Granularity

The granularity of the error that the node is willing to guarantee on the time synchronization. It is of type GranularityEnum.

This value shall be set to NoTimeGranularity if UTCTime is null and shall NOT be set to NoTimeGranularity if UTCTime is non-null.

See

MatterSpecification.v13.Core § 11.17.8.2

Optional ReadonlytimeSource

timeSource?: TimeSynchronization.TimeSource

The node’s time source. This attribute indicates what method the node is using to sync, whether the source uses NTS or not and whether the source is internal or external to the Matter network. This attribute may be used by a client to determine its level of trust in the UTCTime. It is of type TimeSourceEnum.

If a node is unsure if the selected NTP server is within the Matter network, it SHOULD select one of the NonMatter* values.

This value shall be set to None if UTCTime is null and shall NOT be set to None if UTCTime is non-null.

See

MatterSpecification.v13.Core § 11.17.8.3

ReadonlyutcTime

utcTime: null | number | bigint

If the node has achieved time synchronization, this shall indicate the current time as a UTC epoch-us (Epoch Time in Microseconds).

If the node has not achieved time synchronization, this shall be null. This attribute may be set when a SetUTCTime is received.

See

MatterSpecification.v13.Core § 11.17.8.1

Settings

Member Visibility

On This Page

Properties