diff --git a/daemon/README.md b/daemon/README.md index e788ac9..56ef0d7 100644 --- a/daemon/README.md +++ b/daemon/README.md @@ -54,6 +54,13 @@ In case of failure the server returns a **text/plain** content type with the cat * **Body Type** application/json * **Body** [PTP Config params](#ptp-config) +### Get PTP Status ### +* **URL** /api/ptp/status +* **Method** GET +* **URL Params** none +* **Body Type** application/json +* **Body** [PTP Status params](#ptp-status) + ### Add RTP Source ### * **Description** add or update the RTP source specified by the *id* * **URL** /api/source/:id @@ -230,6 +237,27 @@ where: > JSON number specifying the IP DSCP used in IPv4 header for PTP traffic. > Valid values are 48 (CS6) and 46 (EF). +### JSON PTP Status ### + +Example + + { + "status": "unlocked", + "gmid": "00-00-00-FF-FE-00-00-00", + "jitter": 0 + } + +where: + +> **status** +> JSON string specifying the PTP slave status. This can be *unlocked*, *locking* or *locked*. + +> **gmid** +> JSON string specifying GrandMaster clock ID we are currently synchronized to. + +> **jitter** +> JSON number specifying the measured PTP packet delay jitter. + ### JSON RTP source ### Example: