XNET Read (State Time Comm).vi
- Updated2023-11-11
- 3 minute(s) read
XNET Read (State Time Comm).vi
Purpose
Reads the time at which the session's interface completed its integration with the network cluster. This represents the time at which communication began.
Format
Inputs
![]() |
session in is the session to read. This session is selected from a LabVIEW project or returned from the XNET Create Session VI. |
![]() |
error in is the error cluster input (refer to Error Handling). |
Outputs
![]() |
session out is the same as session in, provided for use with subsequent VIs. |
![]() |
local time communicating returns the communication time of the interface as a LabVIEW absolute time, using the local timescale.
If the interface is not communicating when this read is called, local time communicating returns an invalid time (0). |
![]() |
network time communicating Ethernet only. Returns the interface communicating time as a LabVIEW absolute time, using the network timescale. The network time communicating timestamp is captured simultaneously with the local time communicating timestamp.
The network time start output is not applicable for CAN, FlexRay, and LIN and returns an invalid time (0). This output is optional. |
![]() |
network synced Ethernet only. Contains the value of the Synced property at the time that both timestamps are acquired, to specify whether the network time communicating timestamp is synchronized to the network (true) or not (false).
The network synced output is not applicable for CAN, FlexRay, and LIN and returns a value of false. This output is optional. |
![]() |
error out is the error cluster output (refer to Error Handling). |
Description
You can use this XNET Read VI instance with any XNET session mode. Because the time is associated with the interface, it can apply to multiple sessions.
This XNET Read VI instance returns time as a LabVIEW absolute timestamp data type.
After your application starts the XNET interface hardware, the communication controller begins to integrate with ECUs in the network. The timestamp at which this integration starts is available using the XNET Read (State Time Start) VI. Once the XNET interface is fully integrated and communicating on the network (transmitting and receiving frames), this VI captures and returns the time. For the CAN protocol, the time difference between Start and Communicating is very small. For the FlexRay protocol, the time difference can be many milliseconds due to factors such as clock synchronization and cycle length.