ptpAnnounce
ptpAnnounce - configure PTP Announce message.
SYNOPSIS
ptpAnnounce sub-command options
DESCRIPTION
Announce messages are periodically sent by one port and delivered to all other ports of ordinary or boundary clocks within a communication path. The Announce message is used to establish the synchronization hierarchy. Announce messages provide status and characterization information of the transmitting node and its grandmaster. This information is used by the receiving node when executing the best master clock algorithm.
If the port is in the master state and the ordinary clock is the grandmaster clock of the domain, then the local clock is typically synchronized to an external source of time traceable to International Atomic Time (TAI) and UTC (Coordinated Universal Time) such as the GPS system.
STANDARD OPTIONS
clockAccuracy
Defines the accuracy of a clock. (default = ptpAccuracyUnknown)
Option |
Value |
Usage |
---|---|---|
ptpAccuracy25ns |
32 |
accuracy 25 nanoseconds |
ptpAccuracy100ns |
33 |
accuracy 100 ns |
ptpAccuracy250ns |
34 |
accuracy 250 ns |
ptpAccuracy1us |
35 |
accuracy 1 microsecond |
ptpAccuracy2p5us |
36 |
accuracy 2.5 microseconds |
ptpAccuracy10us |
37 |
accuracy 10 microseconds |
ptpAccuracy25us |
38 |
accuracy 25 microseconds |
ptpAccuracy100us |
39 |
accuracy 100 microseconds |
ptpAccuracy250us |
40 |
accuracy 250 microseconds |
ptpAccuracy1ms |
41 |
accuracy 1 millisecond |
ptpAccuracy2p5ms |
42 |
accuracy 2.5 milliseconds |
ptpAccuracy10ms |
43 |
accuracy 10 milliseconds |
ptpAccuracy25ms |
44 |
accuracy 25 milliseconds |
ptpAccuracy100ms |
45 |
accuracy 100 milliseconds |
ptpAccuracy250ms |
46 |
accuracy 250 milliseconds |
ptpAccuracy1s |
47 |
accuracy 1 second |
ptpAccuracy10s |
48 |
accuracy 10 seconds |
ptpAccuracyGreater10s |
49 |
accuracy greater than 10 seconds |
ptpAccuracyUnknown |
254 |
(default) accuracy unknown |
clockClass
Defines a clock's TAI traceability. The clockClass attribute of an ordinary or boundary clock denotes the traceability of the time or frequency distributed by the grandmaster clock. (default = 0)
clockLogVariance
Defines the stability of a clock. (default = 0)
currentUtcOffset
Current UTC offset. The UTC time differs from the TAI time by a constant offset. This is calculated as follows: TAI - UTC. (default = 0)
extensionId
Extension identifier. 5 byte hex list. (default = "00 00 00 00 00")
nanoseconds
The time interval, expressed in nanoseconds. (default = 0)
organizationUniqueId
Organization Unique Identifier (OUI): the value of the OUI assigned to the vendor or standards organization by the IEEE. The most significant 3 octets of the clockIdentity shall be an OUI.. (default = "00 00 00")
priority1
A user configurable designation that a clock belongs to an ordered set of clocks from which a master is selected. (default = 0)
priority2
A user configurable designation that provides finer grained ordering among otherwise equivalent clocks. (default = 0)
stepsRemoved
In addition to this precedence order, the distance measured by the number of boundary clocks between the local clock and the foreign master is used when two Announce messages reflect the same foreign master. (default = 0)
timeSource
Indicates the source of time used by the grandmaster clock.
(default = ptpTimeSourceOther)
Option |
Value |
Usage |
---|---|---|
ptpAtomicClock |
16 |
atomic clock |
ptpGPS |
32 |
GPS |
ptpTerrestrialRadio |
48 |
terrestrial radio |
ptpPTP |
64 |
PTP |
ptpNTP |
80 |
NTP |
ptpHandSet |
96 |
handset |
ptpTimeSourceOther |
144 |
(default) time source other |
ptpInternalOscillator |
160 |
internal oscillator |
ptpAltPtpProfile0 |
240 |
alt ptp profile 0 |
ptpAltPtpProfile1 |
241 |
alt ptp profile 1 |
ptpAltPtpProfile2 |
242 |
alt ptp profile 2 |
ptpAltPtpProfile3 |
243 |
alt ptp profile 3 |
ptpAltPtpProfile4 |
244 |
alt ptp profile 4 |
ptpAltPtpProfile5 |
245 |
alt ptp profile 5 |
ptpAltPtpProfile6 |
246 |
alt ptp profile 6 |
ptpAltPtpProfile7 |
247 |
alt ptp profile 7 |
ptpAltPtpProfile8 |
248 |
alt ptp profile 8 |
ptpAltPtpProfile9 |
249 |
alt ptp profile 9 |
ptpAltPtpProfile10 |
250 |
alt ptp profile 10 |
ptpAltPtpProfile11 |
251 |
alt ptp profile 11 |
ptpAltPtpProfile12 |
252 |
alt ptp profile 12 |
ptpAltPtpProfile13 |
253 |
alt ptp profile 13 |
ptpAltPtpProfile14 |
254 |
alt ptp profile 14 |
ptpReserved |
255 |
reserved |
COMMANDS
The ptpAnnounce command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.
ptpAnnounce cget option
Returns the current value of the configuration option given by option. Option may have any of the values accepted by the ptpAnnounce command.
ptpAnnounce config option value
Modify the configuration options of the port. If no option is specified, returns a list describing all of the available options (see STANDARD OPTIONS) for ptpAnnounce.
ptpAnnounce setDefault
Sets to IxTclHal default values for all configuration options.
EXAMPLES
See example under ptp command.
SEE ALSO
ptp, ptpDelayRequest, ptpProperties, ptpFollowUp, ptpDelayResponse, ptpSync, ptpDiscoveredInfo.