Powered by Redocly

/config/net/ptp

The Precision Time Protocol (PTP) configuration. NTP should normally be disabled when using this protocol. This can be achieved by deleting resource /config/net/ntp/server.

Only model EG4xxx or newer meters support this resource.

The following properties of the PTP service are currently fixed:

  • Update method: Two Step
  • Delay Mechanism: End to End
  • Domain Number: 0
  • Priority 1: 128
  • Priority 2: 128
  • Transmission Method: Multicast
  • Log Announce Interval: 1 (2 seconds)
  • Log Sync Interval: 0 (1 second)
  • Log Min Delay Request Interval: 0 (1 second)
  • Log Min PDelay Request Interval: 0 (1 second)
  • PTP Destination MAC: 01:1B:19:00:00:00
  • PTP Destination MAC: 01:80:C2:00:00:0E
  • Transport Specific Field: 0

Get /config/net/ptp

SecurityApiKey
Request
query Parameters
max-depth
integer >= 1

Limit output depth of the response. See Max-Depth.

Example: max-depth=2
filter
string

Response filter string. See Filter-Spec.

Example: filter={foo,bar}
Responses
200

Normal response.

401

Unauthorized response.

get/config/net/ptp
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}
Replace /config/net/ptp
SecurityApiKey 
Request 
Request Body schema: application/json
client_only
boolean (configNetPtpClientOnly) 
If true, the meter will only act as a client.  Otherwise, the
meter will also act as a server if the PTP algorithm selects it as
the best clock.


 
object (configNetPtpInterface) 
The network interface configurations for PTP. If empty, PTP is disabled.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/net/ptp
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/net/ptp
SecurityApiKey 
Request 
Request Body schema: application/json
client_only
boolean (configNetPtpClientOnly) 
If true, the meter will only act as a client.  Otherwise, the
meter will also act as a server if the PTP algorithm selects it as
the best clock.


 
object (configNetPtpInterface) 
The network interface configurations for PTP. If empty, PTP is disabled.


 
Responses 
200
Normal response.


401
Unauthorized response.


post/config/net/ptp
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/net/ptp
Reset to default. See the descriptions of the individual endpoints for their default values.  Commonly, arrays and strings are cleared to empty, numbers are cleared to 0, and booleans are cleared to false.  


SecurityApiKey 
Responses 
200
Normal response.


401
Unauthorized response.


delete/config/net/ptp
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/net/ptp/client_only