Users Manual

• default (type not defined) - the parameter’s default value
• description (string) - description of the parameter
• max (type not defined) - maximum value this parameter can be assigned to
• min (type not defined) - minimum value this parameter can be assigned to
• name (string) - name of the parameter
• type (string) - the parameter’s primitive type represented as string (one of bool, int8, uint8, int16,
uint16, int32, uint32, int64, uint64, float32, float64, string)
• value (type not defined) - the parameter’s current value
Template object
{
"default": {},
"description": "string",
"max": {},
"min": {},
"name": "string",
"type": "string",
"value": {}
}
Parameter objects are used in the following requests:
• GET /nodes/{node}/parameters
• PUT /nodes/{node}/parameters
• GET /nodes/{node}/parameters/{param}
• PUT /nodes/{node}/parameters/{param}
PtpStatus: Status of the IEEE1588 (PTP) time sync.
An object of type PtpStatus has the following properties:
• master_ip (string) - IP of the master clock
• offset (float) - time offset in seconds to the master
• offset_dev (float) - standard deviation of time offset in seconds to the master
• offset_mean (float) - mean time offset in seconds to the master
• state (string) - state of PTP (one of off, unknown, INITIALIZING, FAULTY, DISABLED, LISTENING,
PASSIVE, UNCALIBRATED, SLAVE)
Template object
{
"master
_
ip": "string",
"offset": 0,
"offset
_
dev": 0,
"offset
_
mean": 0,
"state": "string"
}
PtpStatus objects are nested in SysInfo.
Service: Representation of a service that a node offers.
An object of type Service has the following properties:
• args (ServiceArgs) - see description of ServiceArgs
• description (string) - short description of this service
8.2. REST-API interface 154