janis/aes67-daemon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added documentation for get PTP Status REST API

Browse Source
This commit is contained in:
Andrea Bondavalli 2020-02-12 19:47:19 +01:00
parent d9e167c5ab
commit b3c856e67e
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
daemon/README.md
View File

@ -54,6 +54,13 @@ In case of failure the server returns a **text/plain** content type with the cat
* **Body Type** application/json * **Body Type** application/json
* **Body** [PTP Config params](#ptp-config) * **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 ### ### Add RTP Source ###
* **Description** add or update the RTP source specified by the *id* * **Description** add or update the RTP source specified by the *id*
* **URL** /api/source/:id * **URL** /api/source/:id
@ -230,6 +237,27 @@ where:
> JSON number specifying the IP DSCP used in IPv4 header for PTP traffic. > JSON number specifying the IP DSCP used in IPv4 header for PTP traffic.
> Valid values are 48 (CS6) and 46 (EF). > 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> ### ### JSON RTP source<a name="rtp-source"></a> ###
Example: Example: