From b3c856e67e82c148f9b8b6ccd13b2b4cb39e0f12 Mon Sep 17 00:00:00 2001
From: Andrea Bondavalli <andrea.bondavalli74@gmail.com>
Date: Wed, 12 Feb 2020 19:47:19 +0100
Subject: [PATCH] Added documentation for get PTP Status REST API

---
 daemon/README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

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<a name="ptp-status"></a> ###
+
+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<a name="rtp-source"></a> ###
 
 Example: