Variable ClusterInstanceConst

Type declaration

• Readonlyattributes: {
      granularity: Attribute<TimeSynchronization.Granularity, any>;
      timeSource: OptionalAttribute<TimeSynchronization.TimeSource, any>;
      utcTime: Attribute<number | bigint | null, any>;
  }

  • Readonlygranularity: Attribute<TimeSynchronization.Granularity, any>

    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

  • ReadonlytimeSource: OptionalAttribute<TimeSynchronization.TimeSource, any>

    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: Attribute<number | bigint | null, any>

    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

• Readonlycommands: {
      setUtcTime: Command<TypeFromFields, void, any>;
  }

  • ReadonlysetUtcTime: Command<TypeFromFields, void, any>

    This command may be issued by Administrator to set the time. If the Commissioner does not have a valid time source, it may send a Granularity of NoTimeGranularity.

    Upon receipt of this command, the node may update its UTCTime attribute to match the time specified in the command, if the stated Granularity and TimeSource are acceptable. The node shall update its UTCTime attribute if its current Granularity is NoTimeGranularity.

    If the time is updated, the node shall also update its Granularity attribute based on the granularity specified in the command and the expected clock drift of the node. This SHOULD normally be one level lower than the stated command Granularity. It shall also update its TimeSource attribute to Admin. It shall also update its Last Known Good UTC Time as defined in Section 3.5.6.1, “Last Known Good UTC Time”.

    If the node updates its UTCTime attribute, it shall accept the command with a status code of SUCCESS. If it opts to not update its time, it shall fail the command with a cluster specific Status Code of TimeNotAccepted.

    See

    MatterSpecification.v13.Core § 11.17.9.1

• Readonlyevents: {
      timeFailure: Event<void, any>;
  }

  • ReadonlytimeFailure: Event<void, any>

    This event shall be generated if the node has not generated a TimeFailure event in the last hour, and the node is unable to get a time from any source. This event SHOULD NOT be generated more often than once per hour.

    See

    MatterSpecification.v13.Core § 11.17.10.4

• Readonlyextensions: readonly [{
      component: {
          attributes: {
              trustedTimeSource: Attribute<TypeFromFields | null, any>;
          };
          commands: {
              setTrustedTimeSource: Command<TypeFromFields, void, any>;
          };
          events: {
              missingTrustedTimeSource: Event<void, any>;
          };
      };
      flags: {
          timeSyncClient: true;
      };
  }, {
      component: {
          attributes: {
              defaultNtp: Attribute<string | null, any>;
              supportsDnsResolve: FixedAttribute<boolean, any>;
          };
          commands: {
              setDefaultNtp: Command<TypeFromFields, void, any>;
          };
      };
      flags: {
          ntpClient: true;
      };
  }, {
      component: {
          attributes: {
              dstOffset: Attribute<TypeFromFields[], any>;
              dstOffsetListMaxSize: FixedAttribute<number, any>;
              localTime: Attribute<number | bigint | null, any>;
              timeZone: Attribute<TypeFromFields[], any>;
              timeZoneDatabase: FixedAttribute<TimeSynchronization.TimeZoneDatabase, any>;
              timeZoneListMaxSize: FixedAttribute<number, any>;
          };
          commands: {
              setDstOffset: Command<TypeFromFields, void, any>;
              setTimeZone: Command<TypeFromFields, TypeFromFields, any>;
          };
          events: {
              dstStatus: Event<TypeFromFields, any>;
              dstTableEmpty: Event<void, any>;
              timeZoneStatus: Event<TypeFromFields, any>;
          };
      };
      flags: {
          timeZone: true;
      };
  }, {
      component: {
          attributes: {
              ntpServerAvailable: Attribute<boolean, any>;
          };
      };
      flags: {
          ntpServer: true;
      };
  }]

  This metadata controls which TimeSynchronizationCluster elements matter.js activates for specific feature combinations.

• Readonlyfeatures: {
      ntpClient: BitFlag;
      ntpServer: BitFlag;
      timeSyncClient: BitFlag;
      timeZone: BitFlag;
  }

  • ReadonlyntpClient: BitFlag

    NtpClient

    Allows a node to use NTP/SNTP for time synchronization.

    See

    MatterSpecification.v13.Core § 11.17.5.2

  • ReadonlyntpServer: BitFlag

    NtpServer

    Allows a Node to host an NTP server for the network so that other Nodes can achieve a high accuracy time synchronization within the network. See Section 11.17.15, “Acting as an NTP Server”.

    See

    MatterSpecification.v13.Core § 11.17.5.3

  • ReadonlytimeSyncClient: BitFlag

    TimeSyncClient

    This node also supports a time synchronization client and can connect to and read time from other nodes.

    See

    MatterSpecification.v13.Core § 11.17.5.4

  • ReadonlytimeZone: BitFlag

    TimeZone

    Allows a server to translate a UTC time to a local time using the time zone and daylight savings time (DST) offsets. If a server supports the TimeZone feature, it shall support the SetTimeZone and SetDSTOffset commands, and TimeZone and DSTOffset attributes, and shall expose the local time through the LocalTime attribute.

    See

    MatterSpecification.v13.Core § 11.17.5.1

• Readonlyid: 56

• Readonlyname: "TimeSynchronization"

• Readonlyrevision: 2