TIMESYNC — Time synchronization related messages

This message family allows clients to query whether the server clock is synchronized to the world clock, and to receive notifications when the server has updated information about that synchronization status.

TIMESYNC-STATUS — Retrieve or receive the time synchronization status of the server clock

A client sends this request to the server to obtain the current time synchronization status of the server clock.

A server may also send notifications of this type to connected clients to inform them about changes in the synchronization status of the server clock. Notifications MUST be sent for significant changes, i.e. when the synchronization state goes from synchronized to unsynchronized or back. Notifications MAY be sent for offset changes as well, but this is not mandatory.

Request fields

This request has no fields.

Response and notification fields

Name Required? Type Description

status

yes

TimeSyncSnapshot

Snapshot of the current time synchronization status of the server clock.

Example request

{
  "type": "TIMESYNC-STATUS"
}

Example response

{
  "type": "TIMESYNC-STATUS",
  "status": {
    "state": "sync",
    "offset": 0.012,
    "source": "ntp:time.google.com",
    "jitter": 0.004
  }
}

Example notification

{
  "type": "TIMESYNC-STATUS",
  "status": {
    "state": "unsync",
    "offset": -1.537,
    "source": "gnss:primary",
    "jitter": 0.081
  }
}