Variable NtpClientComponentConst

Type declaration

• Readonlyattributes: {
      defaultNtp: Attribute<null | string, any>;
      supportsDnsResolve: FixedAttribute<boolean, any>;
  }

  • ReadonlydefaultNtp: Attribute<null | string, any>

    The default NTP server that this Node may use if other time sources are unavailable. This attribute is settable by an Administrator using the SetDefaultNTP command. It SHOULD be set by the Commissioner during commissioning. If no default NTP server is available, the Commissioner may set this value to null. The default IANA assigned NTP port of 123 shall be used to access the NTP server.

    If set, the format of this attribute shall be a domain name or a static IPv6 address with no port, in text format, as specified in RFC 5952. The address format shall follow the recommendations in Section 4 and shall NOT contain a port number.

    See

    MatterSpecification.v13.Core § 11.17.8.5

  • ReadonlysupportsDnsResolve: FixedAttribute<boolean, any>

    This attribute is true if the node supports resolving a domain name. DefaultNTP Address values for these nodes may include domain names. If this is False, the Address for a DefaultNTP shall be an IPv6 address.

    See

    MatterSpecification.v13.Core § 11.17.8.13

• Readonlycommands: {
      setDefaultNtp: Command<TypeFromFields<{
          defaultNtp: FieldType<null | string>;
      }>, void, any>;
  }

  • ReadonlysetDefaultNtp: Command<TypeFromFields<{
        defaultNtp: FieldType<null | string>;
    }>, void, any>

    This command is used to set the DefaultNTP attribute. If the DefaultNTP Address field does not conform to the requirements in the DefaultNTP attribute description, the command shall fail with a status code of INVALID_COMMAND. If the node does not support DNS resolution (as specified in SupportsDNSResolve) and the provided Address is a domain name, the command shall fail with a status code of INVALID_COMMAND. Otherwise, the node shall set the DefaultNTP attribute to match the DefaultNTP provided in this command.

    See

    MatterSpecification.v13.Core § 11.17.9.6