Access the TimeSynchronize object
The TIMESYNCHRONIZE object provides a Common Industrial Protocol (CIP) interface to the IEEE 1588 (IEC 61588) Standard for a precision clock synchronization protocol for networked measurement and control systems. Access the TIMESYNCHRONIZE object through the GSV/SSV instructions.
For more information about this object, refer to the Deploying Scalable Time Distribution within a Converged Plantwide Ethernet Architecture Design Guide.
Attribute | Data Type | Instruction | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|
ClockType | INT | GSV | The type of clock. | |||||||
Bit | Type of Clock | |||||||||
0 | Ordinary Clock | |||||||||
1 | Boundary Clock | |||||||||
2 | Peer-to-peer transparent clock | |||||||||
3 | End-to-end transparent clock | |||||||||
4 | Management Node | |||||||||
All other bits are reserved. | ||||||||||
CurrentTimeMicroseconds | DINT[2] DT LINT | GSV | Current value of System Time in microseconds. | |||||||
CurrentTimeNanoseconds | LINT LDT | GSV | Current value of System Time in nanoseconds. | |||||||
DomainNumber | SINT | GSV | The PTP clock domain. The value is between 0...255. The default is 0. | |||||||
CurrentTimeMicroseconds | LINT DINT | GSV | Current value of System Time in microseconds. | |||||||
CurrentTimeNanoseconds | LINT LDT | GSV | Current value of System Time in nanoseconds. | |||||||
DomainNumber | SINT | GSV | The PTP clock domain. The value is between 0...255. The default is 0. | |||||||
GrandMasterClockInfo | Structure | GSV | Property information about the grandmaster clock. Requires 24 bytes of storage. | |||||||
Grandmaster Clock Information structure: | ||||||||||
ClockIdentity | SINT[8] | |||||||||
ClockClass | INT | |||||||||
TimeAccuracy | INT | |||||||||
OffsetScaledLogVariance | INT | |||||||||
CurrentUtcOffset | INT | |||||||||
TimePropertyFlags | INT | |||||||||
TimeSource | INT | |||||||||
Priority1 | INT | |||||||||
Priority2 | INT | |||||||||
IsSynchronized | DINT | GSV | Local clock is synchronized with a master. | |||||||
Value | Meaning | |||||||||
0 | Not synchronized | |||||||||
1 | Synchronized | |||||||||
LocalClockInfo | Structure | GSV | Property information about the local clock. Requires 20 bytes of storage. | |||||||
Local Clock Information structure: | ||||||||||
ClockIdentity | SINT[8] | |||||||||
ClockClass | INT | |||||||||
TimeAccuracy | INT | |||||||||
OffsetScaledLogVariance | INT | |||||||||
CurrentUtcOffset | INT | |||||||||
TimePropertyFlags | INT | |||||||||
TimeSource | INT | |||||||||
ManufactureIdentity | DINT | GSV | The IEEE OUI (Organization Unique Identity) for the manufacturer. | |||||||
MaxOffsetFromMaster | LINT DINT | GSV / SSV | Maximum offset from master in nanoseconds. | |||||||
MeanPathDelayToMaster | LINT DINT | GSV | Average path delay from master to local clock in nanoseconds. | |||||||
NumberOfPorts | INT | GSV | The number of ports of this clock. | |||||||
OffsetFromMaster | LINT DINT | GSV | The calculated difference between the local clock and the master clock, based on the most recent Sync message, in nanoseconds. | |||||||
PTPEnable | DINT | GSV / SSV | The enable status for CIP Sync/PTP/Time Synchronization on the device.
| |||||||
ParentClockInfo | Structure | GSV | Property information about the parent clock. Requires 16 bytes of storage. | |||||||
Parent Clock Information structure: | ||||||||||
ClockIdentity | SINT[8] | |||||||||
PortNumber | INT | |||||||||
ObservedOffsetScaledLogVariance | INT | |||||||||
ObservedPhaseChangeRate | DINT | |||||||||
PortEnableInfo | Structure | GSV | The port enable configuration of each port on the device. Size = 2 + (No. of Enabled Ports x 4) Maxsize = 42 bytes | |||||||
Port Enable status structure: | ||||||||||
NumberOfPorts | INT | Maximum number of ports is 10. | ||||||||
Structure repeated for the number of ports: | ||||||||||
PortNumber | INT | |||||||||
PortEnable | INT | |||||||||
PortLogAnnounceIntervalInfo | Structure | GSV | The interval between successive "Announce" messages issued by a master clock on each PTP port of the device. Size = 2 + (No. of Enabled Ports x 4) Maxsize = 42 bytes | |||||||
Port Log Announce Interval structure: | ||||||||||
NumberOfPorts | INT | Maximum number of ports is 10. | ||||||||
Structure repeated for the number of ports: | ||||||||||
PortNumber | INT | |||||||||
PortLogAnnounceInterval | INT | |||||||||
PortLogSyncIntervalInfo | Structure | GSV | The interval between successive Sync messages issued by a master on each PTP port of the device. Size = 2 + (No. of Enabled Ports x 4) Maxsize = 42 bytes | |||||||
Port Log Sync Interval structure: | ||||||||||
NumberOfPorts | INT | Maximum number of ports is 10. | ||||||||
Structure repeated for the number of ports: | ||||||||||
PortNumber | INT | |||||||||
PortLogAnnounceInterval | INT | |||||||||
PortPhysicalAddressInfo | Structure | GSV | The physical and protocol address of each port of the device. Size = 2 + (No. of Enabled Ports x 36) Maxsize = 362 byts | |||||||
Port Physical Address structure: | ||||||||||
NumberOfPorts | INT | Maximum number of ports is 10. | ||||||||
Structure repeated for the number of ports: | ||||||||||
PortNumber | INT | |||||||||
Protocol | SINT[16] | |||||||||
SizeOfAddress | INT | |||||||||
Port Address | SINT[16] | |||||||||
PortProfileIdentityInfo | Structure | GSV | Profile of each port of the device. Size = 2 + (No. of Enabled Ports x 10) Maxsize = 102 | |||||||
Port Profile Identity structure: | ||||||||||
NumberOfPorts | INT | Maximum number of ports is 10. | ||||||||
Structure repeated for the number of ports: | ||||||||||
PortNumber | INT | |||||||||
ClockIdentity | SINT[8] | |||||||||
PortProtocolAddressInfo | Structure | GSV | The network and protocol address of each port of the device. Size = 2 + (No. of Enabled Ports x 22) Maxsize = 222 | |||||||
Port Protocol Address structure: | ||||||||||
NumberOfPorts | INT | Maximum number of ports is 10. | ||||||||
Structure repeated for the number of ports: | ||||||||||
PortNumber | INT | |||||||||
NetworkProtocol | INT | |||||||||
SizeOfAddress | INT | |||||||||
PortAddress | SINT[16] | |||||||||
PortStateInfo | Structure | GSV | The current state of each PTP port on the device. Size = 2 + (No. of Enabled Ports x 4) Maxsize = 42 bytes | |||||||
Port State structure: | ||||||||||
NumberOfPorts | INT | Maximum number of ports is 10. | ||||||||
Structure repeated for the number of ports: | ||||||||||
PortNumber | INT | |||||||||
PortState | INT | |||||||||
Priority1 | SINT | GSV / SSV | Priority1 (Master Override) value for the local clock. Note: Value is Unsigned. | |||||||
Priority2 | SINT | GSV / SSV | Priority2 (Tie Breaker) value for the local clock. Note: Value is Unsigned. | |||||||
ProductDescription | Structure | GSV | Product description of the device that contains the clock. Requires 68 bytes of storage. | |||||||
Product Description structure: | ||||||||||
Size | DINT | |||||||||
Description | SINT[64] | |||||||||
RevisionData | Structure | GSV | Revision data of the device that contains the clock. Requires 36 bytes of storage. | |||||||
Revision Data structure: | ||||||||||
Size | DINT | |||||||||
Revision | SINT[32] | |||||||||
StepsRemoved | INT | GSV | The number of CIP Sync Regions between the local clock and the grandmaster (that is, the number of boundary clocks +1) | |||||||
SystemTimeAndOffset | Structure | GSV | System time in microseconds and the offset to the local clock value. | |||||||
System Time and Offset structure: | ||||||||||
SystemTime | LINT DINT | |||||||||
SystemOffset | LINT DINT | |||||||||
UserDescription | Structure | GSV | User description of the device that contains the clock. Requires 132 bytes of storage. | |||||||
User Description structure: | ||||||||||
Size | DINT | |||||||||
Description | SINT[128] | |||||||||
Provide Feedback