Application Protocol
Higher-level application protocol of the interface used to create the session. This property is a ring (enumerated list).
Auto Start?
Configures whether to automatically start the output session. Input sessions always start automatically.
Cluster
Cluster (network) used to create the session (XNET Cluster I/O Name).
Database
Database used to create the session (XNET Database I/O Name).
Ethernet:Filtering:Frame Filter
Specifies a string to be applied as a filter for incoming frames. Only frames that match the filter will be received on this stream. The filter uses the pcap-filter syntax, which is the industry standard used by network analysis tools such as tcpdump and Wireshark.
Ethernet:Logging:Error?
Indicates if an error has occurred in the logging thread. To see the error information, stop the session using XNET Stop; the error from the logging thread will be merged with the error of the XNET Stop VI.
Ethernet:Logging:Filepath
This property specifies the path to the file to which you want to log data. The file should use the .pcapng extension. No default file path is provided, so you must write this property with a valid file path when logging is enabled with Mode. The operation used to open the file is determined by the Operation property.
Ethernet:Logging:Mode
This property enables or disables logging. The value is Off by default, so you must write this property to Log in order to enable logging. This property uses a ring as described in the following table: Off: Disable logging for the session Log: Enable logging for the session. You cannot read data using XNET Read when using this mode. If you require access to the data, read from the log file.
Ethernet:Logging:MultipleFiles:EnableMultipleFiles
Enables multiple log files to be created for a single session; use FileSizeThreshold to determine log file size. If true, FileSizeThreshold must be greater than 0. Generated file names include an incrementing index and timestamp of the start of capture.
Ethernet:Logging:MultipleFiles:FileSizeThreshold
Threshold, specified in bytes, above which a new log file will be created if the value of EnableMultipleFiles is true. FileSizeThreshold is ignored if EnableMultipleFiles is false.
Ethernet:Logging:Operation
This property specifies how to create the log file. This property uses a ring as described in the following table: Create or Replace: Create a new log file, or replace an existing log file. Create: Create a new log file. If the file already exists, XNET returns an error.
Ethernet:Number of Frames Received
This is a count of frames received by the session. When logging is off, these frames can be obtained from XNET Read. When logging is on, these frames are stored in the log file. When an input session is used for the Ethernet endpoint, the Interface:Ethernet:Endpoint:Receive Filter property determines which frames are received by the session. This count resets to zero when the session starts. The count is unchanged when the session stops.
Ethernet:Source MAC Address Auto?
Indicates whether the endpoint automatically uses the MAC Address property as the source MAC address in transmitted frames. When this property is true (default), the endpoint ignores the source MAC address in frame data provided to Write (e.g. Write (Frame Ethernet) ). The endpoint automatically replaces the source MAC address in frame data with the endpoint's MAC Address property, and uses that for the transmitted frame. This convenience allows you to leave the source MAC address uninitialized (e.g. all zero) in frame data. When this property is false, the endpoint uses the source MAC address in frame data for each transmitted frame. You must provide a valid source MAC address in frame data provided to Write. This can be useful if you are simulating a specific ECU in the network.
Frame:Active
This property provides access to properties for a specific frame running within the session. Writing this property sets the active frame for subsequent properties in the Frame category. The string syntax supports the following options: - Decimal number: This is interpreted as the index of the signal or frame in the session's list. If the session is signal I/O, subsequent frame properties change the signal's parent frame. - XNET Frame: If the session is frame I/O, you can wire a frame name from the session's List of Frames property. - XNET Signal: If the session is signal I/O, you can wire a signal name from the session's List of Signals property. Subsequent frame properties change the signal's parent frame. If the session is Frame Stream Input or Frame Stream Output, this property has no effect, because stream I/O sessions do not use specific frames. The default value of this property is 0, the first frame or signal in the session's list. If the empty string is wired to this property, this is converted to 0 internally.
Frame:CAN:Start Time Offset
Use this property to configure the amount of time that must elapse between the session being started and the time that the first frame is transmitted across the bus. This is different than the cyclic rate, which determines the time between subsequent frame transmissions. Use this property to have more control over the schedule of frames on the bus, to offer more determinism by configuring cyclic frames to be spaced evenly. If you do not set this property, NI-XNET chooses this start time offset based on the CAN arbitration identifier and periodic transmit time.
Frame:CAN:Transmit Time
Use this property to change the frame's transmit time while the session is running. The transmit time is the amount of time that must elapse between subsequent transmissions of a cyclic frame. The default value of this property comes from the database (the XNET Frame CAN:Transmit Time property). If you set this property while a frame object is currently started, the frame object is stopped, the cyclic rate updated, and then the frame object is restarted. Because of the stopping and starting, the frame's start time offset is re-evaluated.
Frame:LIN:Transmit N Corrupted Checksums
When set to a nonzero value, this property causes the next N number of checksums to be corrupted. It is valid for output sessions only. This property is useful for testing ECU behavior when a corrupted checksum is transmitted.
Frame:Output Queue Update Frequency
This property defines after how many frames the NI-XNET firmware notifies the driver of new frames. The default is 0 which means an internally selected rate which depends on the queue size. If for large queues this rate appears too slow, you can override the default.
Frame:SAE J1939:Address Filter
Use this property to restrict reception of SAE J1939 PGNs to a certain source address.
Frame:Skip N Cyclic Frames
When set to a nonzero value N, this property causes the next N cyclic frames to be skipped. When the frame's transmission time arrives and the skip count is nonzero, a frame value is dequeued (if this is not a single-point session), and the skip count is decremented, but the frame actually is not transmitted across the bus. When the skip count decrements to zero, subsequent cyclic transmissions resume. This property is valid only for output sessions and frames with cyclic timing (that is, not event-based frames). This property is useful for testing of ECU behavior when a cyclic frame is expected, but is missing for N cycles.
Interface:64bit Baud Rate
CAN, FlexRay, or LIN interface baud rate. The default for this interface property is the same as the cluster's baud rate in the database.
Interface:Adjust Local Time
A write of this property applies a positive or negative phase adjustment, in nanoseconds, to the local time that is used for timestamping of frames. This adjustment can be used to align the local time with another timescale or device.
Interface:Bus Error Frames to Input Stream?
Configures the hardware to place a CAN or LIN bus error frame into the Stream Input queue after it is generated.
Interface:CAN:64bit FD Baud Rate
Fast interface baud rate used for CAN FD with Baud Rate Switching. The default for this interface property is the same as the cluster's CAN FD baud rate in the database.
Interface:CAN:Disable Protocol Exception Handling
Indicates that the default protocol exception handling is disabled and instead an error frame is transmitted. The default for this interface property is TRUE.
Interface:CAN:Enable Edge Filter
Indicates that two dominant time quanta are required to detect an edge for hard synchronization. The default for this interface property is FALSE.
Interface:CAN:External Transceiver Config
This property allows you to configure XS series CAN hardware to communicate properly with your external transceiver.
Interface:CAN:FD ISO Mode
Indicates to use the pre-ISO definition of the CAN FD specification. This property is a ring (enumerated list). The default for this interface property is ISO.
Interface:CAN:I/O Mode
CAN I/O Mode. This property is a ring (enumerated list). The default for this interface property is the same as the cluster's CAN I/O Mode in the database.
Interface:CAN:Listen Only?
Configures whether the CAN interface transmits any information to the CAN bus (boolean).
Interface:CAN:Pending Transmit Order
The Pending Transmit Order property configures how the CAN interface manages the internal queue of frames. More than one frame may desire to transmit at the same time. NI-XNET stores the frames in an internal queue and transmits them onto the CAN bus when the bus is idle. This property modifies how NI-XNET handles this queue of frames. The following table lists the accepted values: - As Submitted - By Identifier When you configure this property to be As Submitted, frames are transmitted in the order that they were submitted into the queue. There is no reordering of any frames, and a higher priority frame may be delayed due to the transmission or retransmission of a previously submitted frame. However, this mode has the highest performance. When you configure this property to be By Identifier, frames with the highest priority identifier (lower CAN ID value) transmit first.
Interface:CAN:Single Shot Transmit?
Configures whether the CAN interface retries failed transmissions.
Interface:CAN:Termination
Configures the onboard termination at the connector (port) of the CAN interface. Termination is off by default.
Interface:CAN:Transceiver State
Configures the CAN transceiver and CAN controller states, such as whether the transceiver is asleep or communicating.
Interface:CAN:Transceiver Type
For XNET hardware that provides a software-selectable transceiver, this property allows you to set the transceiver type. You also can use this property to determine the current transceiver type, even for hardware with a fixed transceiver. HS is High Speed. LS is Low Speed / Fault Tolerant. SW is Single Wire. External is your own external transceiver. Disc is disconnected.
Interface:CAN:Transmit I/O Mode
CAN I/O Mode used for transmission. This property is a ring (enumerated list). The default for this interface property is the same as the cluster's CAN I/O Mode in the database.
Interface:CAN:Transmit Pause
Indicates that the transmitter waits for two full bit times after successful transmission before transmitting the next frame. The default for this interface property is FALSE.
Interface:Echo Transmit?
Configures whether input sessions will contain frames transmitted by the interface (boolean).
Interface:Ethernet:Endpoint:Receive Filter
For each frame received by the interface, the frame is forwarded to either the XNET endpoint or the OS stack (not both). This property configures zero, one, or two identification elements (filters) for this forwarding decision. The following C language pseudo-code describes how XNET forwards each received frame to either the XNET endpoint or the OS stack: // TRUE forwards to XNET endpoint, FALSE forwards to OS stack boolean forwardFrameToEndpoint = FALSE; for (int i = 0; i < 2; i++) { boolean endpointMatch = ( RxFilter[i].useVID || RxFilter[i].usePriority || RxFilter[i].useDestinationMAC ); if ( RxFilter[i].useVID && (RxFilter[i].VID != frameVID) endpointMatch = FALSE; if ( RxFilter[i].usePriority && (RxFilter[i].Priority != framePriority) ) endpointMatch = FALSE; if ( RxFilter[i].useDestinationMAC && (RxFilter[i].DestinationMAC != frameDestinationMAC) ) endpointMatch = FALSE; // Only one element must match in order to forward to XNET endpoint. forwardFrameToEndpoint = forwardFrameToEndpoint || endpointMatch; } Refer to detailed help for default values, and the type and range for each field.
Interface:Ethernet:Endpoint:Transmit Bandwidth
This property configures the maximum bandwidth for the credit-based shaper algorithm specified in IEEE Std 802.1Q, which is used for all transmit from the endpoint. The value is in units of bits per second.
Interface:Ethernet:IPv4 Address
Indicates the IPv4 address that is configured on the XNET interface in the network by the OS stack. The IPv4 address is returned as a string in dotted-decimal notation. For example: 192.0.2.1.
Interface:Ethernet:Jumbo Frames
Indicates the jumbo frame setting for the interface. Use NI-MAX or the System Configuration XNET:Interface:Ethernet:Jumbo Frames property to change the Jumbo Frames property.
Interface:Ethernet:Link Speed
Indicates the current link speed on the interface or shows if the link is down.
Interface:Ethernet:Link Speed Configured
Indicates the link speed that is configured for the Ethernet PHY on the interface. This property is configured using MAX or the System Configuration property Link Speed Configured.
Interface:Ethernet:MAC Address
Indicates the MAC address that uniquely identifies the XNET Interface in the network. This MAC address applies to the endpoint as well as the OS stack. The MAC address is an individual (unicast) EUI-48 MAC address that is assigned to the hardware according to the requirements of IEEE Std 802. The data type is an array of 6 bytes.
Interface:Ethernet:OS Network Adapter Description
On XNET Ethernet products, each port can be accessed as an XNET interface, or using operating system (OS) APIs for Ethernet. This property returns the description of this XNET session's Ethernet interface as represented in the OS. In NI Measurement and Automation Explorer (MAX), this name is shown in the Network Settings tab for the system, listed under Network Adapters. On Windows, this is the network adapter description. On Linux, this is the network interface name. On Linux, this name is the same as the OS Network Adapter Name property.
Interface:Ethernet:OS Network Adapter Name
On XNET Ethernet products, each port can be accessed as an XNET interface, or using operating system (OS) APIs for Ethernet. This property returns the name of this XNET session's Ethernet interface as represented in the OS. This name is used in applications such as Wireshark. On Windows, this is the network adapter name. On Linux, this is the network interface name. On Linux, this name is the same as the OS Network Adapter Description property.
Interface:Ethernet:Operational Status
Indicates the operational status of the interface (i.e. communicating or not). It is a ring as described in the following table: Down: The interface can not transmit or receive frames (packets) Up: The interface is ready to transmit and receive frames (packets) This property corresponds to interface operational status as specified in IETF management standards like RFC 2863 and RFC 8343.
Interface:Ethernet:Output Stream Timescale
Defines which timescale (Local Time or Network Time) is used for Output Stream Timing. This property configures which timestamp the hardware uses to evaluate when to output a frame.
Interface:Ethernet:PHY Power Mode
Indicates the current power mode of the PHY. If the XNET device supports the sleep/wake capability, the PHY Power Mode can be changed by calling the XNET Write (State Ethernet Sleep) and XNET Write (State Ethernet Wake) VIs.
Interface:Ethernet:PHY State
Indicates the mode for which the interface is configured to use the Ethernet PHY: Master, Slave, or Autonegotiate. This property is configured using MAX or the System Configuration property PHY State Configured.
Interface:Ethernet:Port Mode
Indicates the hardware connectivity for the port. This property is configured using MAX or the System Configuration property PHY State Configured. It is a ring of values, as described in the following table: Direct: The port is directly connected, such that frames received and transmitted on the port have no relationship to any other port on the XNET device. Input and output sessions are supported in Direct mode. Tap: This port is connected to another port on the XNET device using a Tap. The pair of connected ports are referred to as tap partners. A frame received on one Tap partner is immediately transmitted out the other tap partner, to mimic behavior of an Ethernet cable. Output sessions are not supported in Tap mode.
Interface:Ethernet:Signal Quality
Indicates the signal quality of the interface. For PXIe-8521, PXIe-8522, and PXIe-8523 modules, this value is similar to the Signal Quality Index (SQI) as defined in the OPEN Alliance TC1 standard; 7 indicates the best link quality, while 0 indicates the lowest link quality.
Interface:Ethernet:Sleep Capability
Indicates whether the sleep capability is enabled or disabled/not available for the interface. This property is configured using NI MAX or the System Configuration property Sleep Capability Configured.
Interface:Ethernet:Statistics:MAC:Counter Names
This property returns the name of each Ethernet statistics property supported by XNET. The name uses uppercase for the first letter of each word, with space as a separator between words. The name at a specific index corresponds to the counter at the same index in Counter Values. The size of this property's array of strings is the same as the size of the Counter Values array of strings. Counter Names and Counter Values are intended to be used together in order to display all statistics on the front panel. These properties do not require knowledge of specific property names. For example, if a new version of NI-XNET adds a statistic property (at the end of the arrays), the new property will display without change to your LabVIEW application.
Interface:Ethernet:Statistics:MAC:Counter Values
This property returns the counter value of each Ethernet statistics property supported by XNET. Each counter value is returned as a string for display, but the internal counter uses type of U64 in order to avoid rollover. The counter resets to zero when the interface starts, and increments according to the description in Counter Names. The counter value at a specific index corresponds to the name at the same index in Counter Names. The size of this property's array of counters is the same as the size of the Counter Names array of strings. Refer to Counter Names for a description of each counter value. The array of counters are not provided as a single snapshot in time. For example, it is possible that a new frame is received as the values are returned, such that index 3 does not count the new frame, and index 4 does count the new frame.
Interface:Ethernet:Statistics:MAC:Rx Bad Frames Count
This is a count of frames received with an error detected by the Ethernet MAC and/or PHY.
Interface:Ethernet:Statistics:MAC:Rx Bytes Count
This is a count of the number of bytes (octets) received. The count for each frame is its frame length. Bad frames are counted in addition to good frames. Reading this counter twice can be used to obtain an estimate of received bandwidth over the time between the two reads.
Interface:Ethernet:Statistics:MAC:Rx Good Frames Count
This is a count of error-free frames received. This count is equal to (Rx Good Unicast + Rx Good Multicast + Rx Good Broadcast).
Interface:Ethernet:Statistics:MAC:Tx Bytes Count
This is a count of the number of bytes (octets) transmitted. The count for each frame is its frame length. Reading this counter twice can be used to obtain an estimate of transmitted bandwidth over the time between the two reads.
Interface:Ethernet:Statistics:MAC:Tx Good Frames Count
This is a count of error-free frames transmitted. This count is equal to (Tx Good Unicast + Tx Good Multicast + Tx Good Broadcast).
Interface:Ethernet:Statistics:PHY:Counter Names
This property returns the name of each Ethernet statistics PHY property supported by XNET. The name uses uppercase for the first letter of each word, with space as a separator between words. The name at a specific index corresponds to the counter at the same index in Counter Values. The array of strings for this property is the same size as the Counter Values array of strings.
Interface:Ethernet:Statistics:PHY:Counter Values
This property returns the counter value of each Ethernet statistics PHY property supported by XNET. Each counter value is returned as a string for display, but the internal counter uses a 64-bit unsigned integer (U64) data type to avoid rollover. The counter resets to zero when the system powers up or the device is reset, and increments according to the description in Ethernet Statistics PHY Properties. The counter value at a specific index corresponds to the name at the same index in Counter Names. The array of strings for this property is the same size as the Counter Names array of strings. Refer to Ethernet Statistics PHY Properties for a description of each counter value.
Interface:Ethernet:Statistics:PHY:Low Power Sleep Count
Count of the number of Low Power Sleep (LPS) commands the local port's PHY has observed. This count includes both the sent and received LPS commands.
Interface:Ethernet:Statistics:PHY:Sleep Failure Count
Count of the number of sleep failures as reported by the PHY.
Interface:Ethernet:Statistics:PHY:Wake Up Failure Count
Count of the number of wake up failures as reported by the PHY.
Interface:Ethernet:Statistics:PHY:Wake Up Pulse Count
Count of the number of Wake Up Pulse (WUP) commands the local port's PHY has observed. The count includes both the sent and received WUP commands.
Interface:Ethernet:Statistics:PHY:Wake Up Request Count
Count of the number of Wake Up Request (WUR) commands the local port's PHY has observed. This count only includes the WUR commands received from the remote port.
Interface:Ethernet:Time Sync:Adjust Network Time
When this clock is the grandmaster (i.e. Grandmaster Clock ID equals Clock ID), a write of this property applies a positive or negative phase adjustment to the time distributed to the network. This can be used in align the network's time with another timescale. The data type is I64 in nanoseconds.
Interface:Ethernet:Time Sync:BMCA Enabled?
Enables (runs) the Best Master Clock Algorithm (BMCA) of the time synchronization Protocol. The BMCA dynamically exchanges messages over the network in order to select the best grandmaster in the network, and to change all port states in order to transfer timing messages from the selected grandmaster to slaves. When this property is true, the Protocol runs the BMCA. When this property is false, the BMCA is not operational.
Interface:Ethernet:Time Sync:Clock Accuracy
This property provides the accuracy of the hardware clock (e.g. oscillator) distributed by the clock when it is the grandmaster.
Interface:Ethernet:Time Sync:Clock Class
This property provides the traceability of time or frequency distributed by the clock when it is the grandmaster.
Interface:Ethernet:Time Sync:Clock ID
This property uniquely identifies the clock in the network.
Interface:Ethernet:Time Sync:Clock Offset Scaled Log Variance
This property provides an estimate of the precision of the timestamping that the clock uses for the protocol. The estimate depends on the stability of the hardware clock (e.g. oscillator), as well as any error introduced in the timestamping process. The estimate is a second-order statistic on the variation of the frequency of the hardware clock. Valid values range from 0 to 65535.
Interface:Ethernet:Time Sync:Grandmaster Clock Accuracy
This property provides the Clock Accuracy of the currently selected grandmaster for this clock.
Interface:Ethernet:Time Sync:Grandmaster Clock Class
This property provides the Clock Class of the currently selected grandmaster for this clock.
Interface:Ethernet:Time Sync:Grandmaster Clock ID
This property provides the Clock ID of the currently selected grandmaster for this clock.
Interface:Ethernet:Time Sync:Grandmaster Clock Offset Scaled Log Variance
This property provides the Clock Offset Scaled Log Variance of the currently selected grandmaster for this clock.
Interface:Ethernet:Time Sync:Grandmaster Priority1
This property provides the Priority1 of the currently selected grandmaster for this clock.
Interface:Ethernet:Time Sync:Grandmaster Priority2
This property provides the Priority2 of the currently selected grandmaster for this clock.
Interface:Ethernet:Time Sync:Offset From Master
This property provides the positive or negative offset in time between this clock and the grandmaster. This property can be used to determine when this XNET Interface is sufficiently synchronized to the grandmaster in order to continue. The data type is I64 in nanoseconds.
Interface:Ethernet:Time Sync:Port:AS Capable?
This property is specific to the IEEE Std 802.1AS Protocol. It returns true if the neighboring port is running the protocol according to the requirements in the standard (false otherwise).
Interface:Ethernet:Time Sync:Port:Announce Receipt Timeout
If Port State is Slave, this property configures the number of Announce intervals (per Log Announce Interval) to wait without receiving a Announce message, before assuming that the neighboring Master is no longer available, and the BMCA needs to run if enabled.
Interface:Ethernet:Time Sync:Port:Announce Transmit Enabled?
Enables the transmit of Announce messages, which provide properties of this port as a potential grandmaster. Since Announce messages are required for proper operation of the BMCA, this property is ignored when BMCA Enabled? is true. When this property is true, the port transmits Announce messages. This value is the default behavior as specified in the protocol standard. When this property is false, the port does not transmit Announce messages. When this property is false in the grandmaster, slave ports will not receive information about that grandmaster (e.g. properties like Grandmaster Clock Accuracy). Therefore, the false value is useful for in-vehicle applications in which each slave assumes properties for its grandmaster as part of the vehicle's static design.
Interface:Ethernet:Time Sync:Port:Log Announce Interval
If Announce Transmit Enabled? is true, this property provides the current interval used for successive transmits of the Announce message by this port.
Interface:Ethernet:Time Sync:Port:Log Announce Interval Configured
If Announce Transmit Enabled? is true, this property configures the interval between successive transmits of the Announce message by this port.
Interface:Ethernet:Time Sync:Port:Log Pdelay_Req Interval
If Pdelay Enabled? is true, this property provides the current interval used for successive transmits of the Pdelay_Req message by this port.
Interface:Ethernet:Time Sync:Port:Log Pdelay_Req Interval Configured
If Pdelay Enabled? is true, this property configures the interval between successive transmits of the Pdelay_Req message by this port.
Interface:Ethernet:Time Sync:Port:Log Sync Interval
If Port State is Master, this property provides the current interval used for successive transmits of the Sync message by this port.
Interface:Ethernet:Time Sync:Port:Log Sync Interval Configured
If Port State is Master, this property configures the interval between successive transmits of the Sync message by this port.
Interface:Ethernet:Time Sync:Port:Pdelay Enabled?
Enables the exchange of Pdelay (peer-to-peer delay) messages, as a means of measuring Propagation Delay. When this property is true, the port transmits Pdelay request messages (Pdelay_Req) to the neighboring clock and processes received Pdelay response messages (Pdelay_Resp). The port also processes received Pdelay request messages and transmits Pdelay response messages. The Propagation Delay is measured using this message exchange. The Propagation Delay Configured property is not used while Pdelay is enabled. When this property is false, Pdelay messages are not transmitted, and received Pdelay messages are ignored. The false value is useful for in-vehicle applications in which the topology for time synchronization is considered to be part of the vehicle's static design. The Propagation Delay Configured property must be used in order to specify the propagation delay for the port. The read-only Propagation Delay property reflects Propagation Delay Configured.
Interface:Ethernet:Time Sync:Port:Port State
This property provides the current state of the port. It is a ring as described in the following table: Disabled: The protocol is disabled on the port. No protocol messages are transmitted in this state. The port discards received messages for the protocol. The port is in this state when Protocol Enabled? is false. Master: The port is sending time. If the clock has only one port, the port is acting as grandmaster. Passive: The port is exchanging messages to measure Propagation Delay, but the port is not sending time (Master) or receiving time (Slave). Slave: The port is receiving time. In IEEE Std 802.1AS, the port is not necessarily synchronized (calibrated). In IEEE Std 1588, the port is assumed to be synchronized.
Interface:Ethernet:Time Sync:Port:Port State Configured
This property configures the Port State when BMCA Enabled? is false. Valid values are Master and Slave. If BMCA Enabled? is true, the value in this property is ignored.
Interface:Ethernet:Time Sync:Port:Propagation Delay
This property provides the propagation delay for the Ethernet cable between this clock and its neighboring clock. Propagation delay is the time it takes for a single bit to travel along the wire (i.e. PHY to PHY). Propagation delay is a fundamental measurement that is required for time synchronization. The data type is DBL in seconds, which is typically used in LabVIEW for relative times. If nanoseconds are desired, multiply this value by 1,000,000,000. The propagation speed for copper wires is close to 2 * 10^8 meters/second. Therefore, multiplying this property value by 200,000,000 provides a close approximation of the cable length in meters. For example, 800 nanoseconds of propagation delay occurs with approximately 160 meters of copper cable.
Interface:Ethernet:Time Sync:Port:Propagation Delay Configured
This property configures the Propagation Delay when Pdelay Enabled? is false.
Interface:Ethernet:Time Sync:Port:Propagation Delay Threshold
For IEEE Std 802.1AS, if the Propagation Delay exceeds the threshold in this property, the protocol assumes that a switch/router that is not 802.1AS-capable exists between this clock and the neighboring 802.1AS-capable clock. Since the resulting asymmetries have an adverse effect of time synchronization accuracy, this port sets AS Capable? to false. The data type is DBL in seconds, which is typically used in LabVIEW for relative times. If nanoseconds are desired, multiply this value by 1000000000. The propagation speed for copper wires is close to 2 * 10^8 meters/second. Therefore, multiplying this property value by 200000000 provides a close approximation of the cable length in meters. If Pdelay Enabled? is false, this property is ignored.
Interface:Ethernet:Time Sync:Port:Statistics:Counter Names
This property returns the name of each Time Sync Port statistics property supported by XNET. The name uses uppercase for the first letter of each word, with space as a separator between words. The name at a specific index corresponds to the counter at the same index in Counter Values. The size of this property's array of strings is the same as the size of the Counter Values array of strings. Counter Names and Counter Values are intended to be used together in order to display all statistics on the front panel. These properties do not require knowledge of specific property names. For example, if a new version of NI-XNET adds a statistic property (at the end of the arrays), the new property will display without change to your LabVIEW application.
Interface:Ethernet:Time Sync:Port:Statistics:Counter Values
This property returns the counter value of each Time Sync Port statistics property supported by XNET. Each counter value is returned as a string for display, but the internal counter uses type of U64 in order to avoid rollover. The counter resets to zero when the interface starts, and increments according to the description in Counter Names. The counter value at a specific index corresponds to the name at the same index in Counter Names. The size of this property's array of counters is the same as the size of the Counter Names array of strings. Refer to Counter Names for a description of each counter value. The array of counters are not provided as a single snapshot in time. For example, it is possible that a new frame is received as the values are returned, such that index 3 does not count the new frame, and index 4 does count the new frame.
Interface:Ethernet:Time Sync:Port:Statistics:Rx Announce Count
This is a count of the number of Announce messages received.
Interface:Ethernet:Time Sync:Port:Statistics:Rx Pdelay Request Count
This is a count of the number of Pdelay_Req messages received.
Interface:Ethernet:Time Sync:Port:Statistics:Rx Sync Count
This is a count of the number of Sync messages received.
Interface:Ethernet:Time Sync:Port:Statistics:Tx Announce Count
This is a count of the number of Announce messages transmitted.
Interface:Ethernet:Time Sync:Port:Statistics:Tx Pdelay Request Count
This is a count of the number of Pdelay_Req messages transmitted.
Interface:Ethernet:Time Sync:Port:Statistics:Tx Sync Count
This is a count of the number of Sync messages transmitted.
Interface:Ethernet:Time Sync:Port:Sync Receipt Timeout
If Port State is Slave, this property configures the number of Sync intervals (per Log Sync Interval) to wait without receiving a Sync message, before assuming that the neighboring Master is no longer available, and the BMCA needs to run if enabled.
Interface:Ethernet:Time Sync:Port:Sync Status
This property provides the current synchronization status of the time sync protocol. It is a ring as described in the following table: Synced: The time sync protocolâ€™s clock is successfully synchronized with other clocks in the network. This value is returned when the time synchronization protocol's Synced property is true. EnetLinkDown: The interface can not transmit or receive frames (packets). ProtocolDisabled: The time sync protocol is disabled. MeasuringPropDelay: The port is exchanging messages to measure Propagation Delay, but the port is not sending time (Master) or receiving time (Slave). MasterPendingAnnounce: The Port State is Master with the BMCA enabled and is waiting until at least two Announce Intervals have elapsed before declaring the port synchronized. This avoids reporting a false-positive when the BMCA has not finished electing the best master. WaitingForMaster: The Port State is Slave and a Sync message has not been received from the master. SyncingToMaster: The Port State is Slave and XNET's clock adjustment algorithm (servo) has not reached its final state (calibrated). A sufficient number of messages need to be exchanged such that synchronization quality (e.g. Offset From Master) is unlikely to improve significantly, but no fixed metric is applied as a threshold. PeerNotProtoCapable: The time sync protocol is not detecting a neighbor that is running the protocol according to the requirements in the standard. PropDelayExceedsTreshold: For IEEE Std 802.1AS, the measured propagation delay exceeds the value specified by the property Propagation Delay Threshold. As a result, the time sync protocol sets the property AS Capable false. SyncReceiptTimeout: The Port State is Slave and the time sync protocol has not received a Sync message from the Master in at least the number of Sync intervals specified by the property Sync Receipt Timeout. FrequencyOutOfRange: The Port State is Slave and the grandmasterâ€™s clock has exceeded the frequency range of XNET's clock (+/- 100 ppm). SyncIntervalOutOfRange: The Port State is Slave and the master is sending Sync messages outside of the supported Sync interval range. MultipleMastersDetected: The Port State is configured as Master with the BMCA disabled and another master has been detected by the time sync protocol.
Interface:Ethernet:Time Sync:Port:Synced?
This property indicates whether the time sync protocol's clock is successfully synchronized to other clocks in the network.
Interface:Ethernet:Time Sync:Priority1
The BMCA uses this property as the first comparison to determine the grandmaster. Lower values take precedence. Valid values range from 0 to 255. The value 255 specifies that the clock is not grandmaster-capable (slave only).
Interface:Ethernet:Time Sync:Priority2
The BMCA uses this property as a secondary comparison, after comparing the properties for clock quality, and before using Clock ID as a tie-breaker. Lower values take precedence. Valid values range from 0 to 255.
Interface:Ethernet:Time Sync:Protocol
This property configures the time synchronization protocol that the clock is using. This protocol is indicated in all time sync messages that are transmitted by the session's interface (port).
Interface:Ethernet:Time Sync:Protocol Enabled?
Enables (runs) the time synchronization Protocol. When this property is true, the Protocol transmits and receives messages in order to synchronize time with its neighboring ports. When this property is false, the Protocol does not transmit messages, and messages received for the protocol are ignored.
Interface:Ethernet:Time Sync:Steps to Grandmaster
This property provides the number of steps that this clock is removed from the grandmaster. For example, if there is a single Ethernet cable that connects this clock to the grandmaster, this property returns the value 1.
Interface:Ethernet:Time Sync:VLAN Tag:Enabled?
Enables the use of VLAN Tags with the time sync protocol. When this property is true, the protocol transmits messages with the user-provided VLAN Tag added. Received protocol messages which don't have a matching VLAN Tag are discarded. When this property is false, the time sync protocol does not add VLAN Tags to any transmitted messages, and received messages with a VLAN Tag are discarded.
Interface:Ethernet:Time Sync:VLAN Tag:ID
When time sync protocol VLAN Tags are enabled, this property configures the VLAN ID for transmitted messages, and discards received messages that don't have a matching VLAN ID. The VLAN ID is a 12-bit field with values 0..4095, with 0 and 4095 being reserved.
Interface:Ethernet:Trigger PPS Synced?
Indicates if the configured PXI trigger that carries a pulse per second (PPS) has synchronized the network timekeeper on this interface.
Interface:FlexRay:Accepted Startup Range
Range of clock deviation allowed for startup frames during integration of nodes. Expressed in microticks (0-1875).
Interface:FlexRay:Allow Halt Due To Clock?
Controls the transition of the interface to the POC:halt-state due to a clock synchronization errors (boolean).
Interface:FlexRay:Allow Passive to Active
Number of consecutive even/odd cycle pairs that must have valid clock correction terms before communication will be allowed to transition from the POC:normal-passive state to POC:normal-active state. Expressed as the number of even/odd cycle pairs (0-31).
Interface:FlexRay:Auto Asleep When Stopped?
Specifies whether the FlexRay interface (node) automatically places the FlexRay transceiver and controller into sleep when the interface is stopped.
Interface:FlexRay:Cluster Drift Damping
Cluster drift damping factor used for rate correction. Expressed in microticks (0-20).
Interface:FlexRay:Coldstart?
Indicates whether the FlexRay interface operates as a coldstart node on the cluster (boolean). This property is read-only, and is calculated from the Key Slot Identifier property.
Interface:FlexRay:Connected Channels
This property specifies the channel(s) that the FlexRay interface (node) is physically connected to. The default value of this property is all channels available on the cluster.
Interface:FlexRay:Decoding Correction
Value used to calculate the difference between primary time reference point and secondary time reference point (for clock synchronization) Expressed in microtick (14-143).
Interface:FlexRay:Delay Compensation Ch A
Value used to compensate for reception delays on channel A. Expressed in microticks (0-200).
Interface:FlexRay:Delay Compensation Ch B
Value used to compensate for reception delays on channel B. Expressed in microticks (0-200).
Interface:FlexRay:Key Slot Identifier
FlexRay slot number from which the NI-XNET FlexRay interface transmits a startup frame, during the process of integration with other cluster nodes. The default value of this property is 0 (no startup frame).
Interface:FlexRay:Latest Tx
Number of the last minislot in which a frame transmission can start in the dynamic segment (0-7981). This property is read-only, because it is calculated using the frames in the dynamic segment that you specify for transmit.
Interface:FlexRay:Listen Timeout
Upper limit for the start up listen timeout and wake up listen timeout. Expressed in microticks (1284-1283846).
Interface:FlexRay:Macro Initial Offset Ch A
Number of macroticks between the static slot boundary and the following macrotick boundary of the secondary time reference point based on the nominal macrotick duration. Applies to channel A only. Expressed in macroticks (2-72).
Interface:FlexRay:Macro Initial Offset Ch B
Number of macroticks between the static slot boundary and the following macrotick boundary of the secondary time reference point based on the nominal macrotick duration. Applies to channel B only. Expressed in macroticks (2-72).
Interface:FlexRay:Max Drift
Maximum drift offset between two nodes that operate with unsynchronized clocks over one communication cycle. Expressed in microticks (2-1923).
Interface:FlexRay:Micro Initial Offset Ch A
Number of microticks between the closest macrotick boundary described by Interface property Macro Initial Offset Ch A and the secondary time reference point. Applies to channel A only. Expressed in microticks (0-240).
Interface:FlexRay:Micro Initial Offset Ch B
Number of microticks between the closest macrotick boundary described by Interface property Macro Initial Offset Ch B and the secondary time reference point. Applies to channel B only. Expressed in microticks (0-240).
Interface:FlexRay:Microtick
Duration of a microtick, expressed in microseconds. This property is read-only, because it is calculated as a function of the Cluster property Baud Rate and the Interface property Samples Per Microtick.
Interface:FlexRay:Null Frames To Input Stream?
For Frame Input Stream session, return FlexRay null frames from XNET Read? Default is false (no null frames returned).
Interface:FlexRay:Offset Correction
Read-only property that provides the offset correction value, expressed in microticks. The offset correction synchronizes the start time of the cycle.
Interface:FlexRay:Offset Correction Out
Magnitude of the maximum permissible offset correction value. Expressed in microticks (5-15266).
Interface:FlexRay:Rate Correction
Read-only property that provides the rate correction value. Expressed in microticks. The rate correction synchronizes frequency.
Interface:FlexRay:Rate Correction Out
Magnitude of the maximum permissible rate correction value. Expressed in microticks (2-1923).
Interface:FlexRay:Samples Per Microtick
Number of samples per microtick. This property is a ring (enumerated list).
Interface:FlexRay:Single Slot Enabled?
Configures whether the FlexRay interface (node) should enter single slot mode following startup (boolean).
Interface:FlexRay:Sleep
Use the Sleep property to change the NI-XNET FlexRay interface sleep/awake state and optionally to initiate a wakeup on the FlexRay cluster.
Interface:FlexRay:Statistics Enabled?
Configures whether to enable reporting of FlexRay error statistics to XNET Read (State FlexRay Statistics).
Interface:FlexRay:Symbol Frames To Input Stream?
This property indicates whether the Frame Input Stream mode session should return FlexRay symbols from the XNET Read VI.
Interface:FlexRay:Sync Frame Status
Status of sync frames since start of the interface. This property is a ring (enumerated list).
Interface:FlexRay:Sync Frames Channel A Even
Array of sync frames (slot IDs) transmitted or received on channel A during the last even cycle (array of u32).
Interface:FlexRay:Sync Frames Channel A Odd
Array of sync frames (slot IDs) transmitted or received on channel A during the last odd cycle (array of u32).
Interface:FlexRay:Sync Frames Channel B Even
Array of sync frames (slot IDs) transmitted or received on channel B during the last even cycle (array of u32).
Interface:FlexRay:Sync Frames Channel B Odd
Array of sync frames (slot IDs) transmitted or received on channel B during the last odd cycle (array of u32).
Interface:FlexRay:Termination
Configures the onboard termination at the connector (port) of the FlexRay interface. This applies to both channels (A and B). Termination is off by default.
Interface:FlexRay:Wakeup Channel
Channel used by the interface to send the wakeup pattern. This property is a ring (enumerated list). This property is used only when Coldstart? is true.
Interface:FlexRay:Wakeup Pattern
Number of repetitions of the wakeup symbol that are combined to form a wakeup pattern when the interface enters the POC:wakeup-send state (2-63). This property is used only when Coldstart? is true.
Interface:I/O Name
Interface used to create the session (XNET Interface I/O Name).
Interface:LIN:Break Delimiter Length
This property determines the length of the delimiter placed between the break and sync in the header. This length is in addition to the length internally added by the hardware serial UART, which is approximately equal to one bit-time at a baud rate equal to 9/break bit-length * bus baud-rate. The value is specified in bit-times at the bus baud-rate. The default value is 0. The maximum value varies per the break length value, in order to keep the overall break transmit time below the maximum specified for LIN (1.4 * 14 bit times): - Break bit length: 10 Break delimiter length (max): 8 - Break bit length: 11 Break delimiter length (max): 7 - Break bit length: 12 Break delimiter length (max): 6 - Break bit length: 13 (default): Break delimiter length (max): 5 - Break bit length: 14 Break delimiter length (max): 4 - Break bit length: 15 Break delimiter length (max): 2 - Break bit length: 16 Break delimiter length (max): 1 - Break bit length: 17 (or greater) Break delimiter length: 0
Interface:LIN:Break Length
This property determines the length of the serial break used at the start of a frame header (schedule entry). The value is specified in bit-times. The valid range is 13â€“36 (inclusive). The default value is 13, which is the value the LIN standard specifies.
Interface:LIN:Checksum to Input Stream?
This property indicates whether checksums are reported in Input Stream session frames. The default of FALSE indicates that each frame Event ID equals 0. TRUE indicates that each frame Event ID contains the received checksum.
Interface:LIN:Diagnostics P2min
When the interface is the slave, this is the minimum time in seconds between reception of the last frame of the diagnostic request message and transmission of the response for the first frame in the diagnostic response message by the slave.
Interface:LIN:Diagnostics STmin
When the interface is the slave, this is the minimum time in seconds it places between the end of transmission of a frame in a diagnostic response message and the start of transmission of the response for the next frame in the diagnostic response message.
Interface:LIN:Master?
This boolean property specifies the NI-XNET LIN interface role on the network: master (true) or slave (false). The default value for this property is false (slave). If you call the XNET Write (State LIN Schedule Change) VI to request execution of a schedule, that implicitly sets this property to true (master).
Interface:LIN:No Response Frames to Input Stream?
This property indicates whether No Response frames are copied to Input Stream sessions. The default of FALSE indicates that these frames are ignored.
Interface:LIN:Output Stream Slave Response List By NAD
This property provides a list of NADs for use with the replay feature (Interface:Output Stream Timing property set to Replay Exclusive or Replay Inclusive). Besides filtering for the frame ID through the Interface:Interface:Output Stream List By ID property this property allows another level of filtering frames by the NAD of the sending device.
Interface:LIN:Schedules
This property provides the list of schedules for use when the NI-XNET LIN interface acts as a master (Interface:LIN:Master? is true). When the interface is master, you can wire one of these schedules to the XNET Write (State LIN Schedule Change) VI to request a schedule change. When the interface is slave, you cannot control the schedule, and the XNET Write (State LIN Schedule Change) VI returns an error if it cannot set the interface into master mode (for example, if the interface already is started). This array of XNET LIN Schedule I/O names is the same list as the XNET Cluster LIN:Schedules property used to configure the session.
Interface:LIN:Sleep
Use this property to change the NI-XNET LIN interface sleep/awake state and optionally to change remote node (ECU) sleep/awake states. The property is a ring (enumerated list) with the following values: - Remote Sleep: Set interface to sleep locally and transmit sleep requests to remote nodes - Remote Wake: Set interface to awake locally and transmit wakeup requests to remote nodes - Local Sleep: Set interface to sleep locally and not to interact with the network - Local Wake: Set interface to awake locally and not to interact with the network The property is write only. Setting a new value is effectively a request, and the property node returns before the request is complete. To detect the current interface sleep/wake state, use the XNET Read (State LIN Comm) VI.
Interface:LIN:Start Allowed without Bus Power?
This property allows to start a LIN session without bus power being applied to the interface. If set to FALSE (default), this attempt causes an error condition.
Interface:LIN:Termination
The Termination property configures the NI-XNET interface LIN connector (port) onboard termination. The enumeration is Off (disabled) and On (enabled). The default value is Off.
Interface:Output Stream List
The Output Stream List property provides a list of frames for use with the replay feature (Interface:Output Stream Timing property set to Replay Exclusive or Replay Inclusive). In Replay Exclusive mode, the firmware transmits only frames that do not appear in the list. In Replay Inclusive mode, the firmware transmits only frames that appear in the list. Using these modes, you can either emulate an ECU (Replay Inclusive, where the list contains the frames the ECU transmits) or test an ECU (Replay Exclusive, where the list contains the frames the ECU transmits), or some other combination. This property's data type is an array of XNET Frame from a database. When you are using a database file such as CANdb or FIBEX, each XNET frame uses the string name. If you are not using a database file or prefer to specify the frames using CAN arbitration IDs, you can use Interface:CAN:Output Stream List By ID instead of this property.
Interface:Output Stream List By ID
The Output Stream List By ID property provides a list of frames for use with the replay feature (Interface:Output Stream Timing property set to Replay Exclusive or Replay Inclusive). This property serves the same purpose as Interface:Output Stream List, in that it provides a list of frames for replay filtering. This property provides an alternate format for you to specify the frames by their CAN/LIN arbitration ID. The property's data type is an array of unsigned 32-bit integer (U32). Each integer represents a CAN/LIN frame's identifier, using the same encoding as the Raw Frame Format. Within each CAN frame ID value, bit 29 (hex 20000000) indicates the CAN identifier format (set for extended, clear for standard). If bit 29 is clear, the lower 11 bits (0â€“10) contain the CAN frame identifier. If bit 29 is set, the lower 29 bits (0â€“28) contain the CAN frame identifier.
Interface:Output Stream Timing
The Output Stream Timing property configures how the firmware transmits frames queued using a Frame Output Stream session. The following table lists the accepted values: - Immediate - Replay Exclusive - Replay Inclusive When you configure this property to be Immediate, frames are dequeued from the queue and transmitted immediately to the bus. The firmware transmits all frames in the queue as fast as possible. Immediate is the default value. When you configure this property as Replay Exclusive or Replay Inclusive, the firmware is placed into a Replay mode. In this mode, the firmware evaluates the frame timestamps and attempts to maintain the original transmission times as the timestamp stored in the frame indicates. The actual transmission time is based on the relative time difference between the first dequeued frame and the time contained in the dequeued frame. When in one of the replay modes, you can use the Interface:Output Stream List property to supply a list. In Replay Exclusive mode, the firmware transmits only frames that do not appear in the list. In Replay Inclusive mode, the firmware transmits only frames that appear in the list. Using these modes, you can either emulate an ECU (Replay Inclusive, where the list contains the frames the ECU transmits) or test an ECU (Replay Exclusive, where the list contains the frames the ECU transmits), or some other combination. You can replay all frames by using Replay Exclusive mode without setting any list.
Interface:Source Terminal:Start Trigger
This property specifies the name of a terminal where there is a digital signal to use as the Start Trigger source. The data type is NI Terminal (DAQmx terminal). This property is supported for C Series modules in a CompactDAQ chassis. It is not supported for CompactRIO, PXI, or PCI. Use this property to connect the interface Start Trigger to triggers in other modules and/or interfaces. When you read this property, you specify the interface Start Trigger as the source of a connection. When you write this property, you specify the interface Start Trigger as the destination of a connection, and the value you write represents the source. For example, to connect the Start Trigger of analog input module for use as Start Trigger of a CAN interface, read the DAQmx Trigger Node property Start:Digital Edge:Source, and write the resulting value to this CAN interface property. The connection that is created by this property is disconnected when you clear (close) all relevant sessions.
Interface:Start Trigger Frames to Input Stream?
Configures the hardware to place a start trigger frame into the Stream Input queue after it is generated.
List of Frames
List of frames used to create the session (array of XNET Frame I/O Name). This property is valid only for sessions with a mode of Frame Input or Frame Output. For Signal Input/Output session, use the List of Signals property.
List of Signals
List of signals used to create the session (array of XNET Signal I/O Name). This property is valid only for sessions with a mode of Signal Input or Signal Output. For Frame Input/Output session, use the List of Frames property.
Mode
Mode used to create the session. This property is a ring (enumerated list).
Number in List
Number of frames or signals in the session's list.
Number of Values Pending
Number of values pending for the session.
Number of Values Unused
Number of values unused for the session.
Payload Length Maximum
Maximum payload length of all frames in this session, expressed as bytes. This property does not apply to Signal sessions (only Frame).
Protocol
Protocol of the interface used to create the session. This property is a ring (enumerated list).
Queue Size
For output sessions, queues store data passed to the XNET Write VI and not yet transmitted onto the network. For input sessions, queues store data received from the network and not yet obtained using the XNET Read VI. For most applications, the default queue sizes are sufficient. You can write to this property to override the default.
Resample Rate
Rate used to resample frame data to/from signal data in waveforms.
SAE J1939:ECU
Set the ECU which is emulated by this session. This will set various internal properties for the session like the J1939 node address and name.
SAE J1939:ECU Busy
Indicates whether the J1939 session temporarily does not accept long messages.
SAE J1939:Include Destination Address in PGN
Include the J1939 destination address (PDU1 PS field) when matching received frames to database frames.
SAE J1939:Maximum Repeat CTS
Maximum number of CTS repetitions for the J1939 Transport Protocol.
SAE J1939:Node Address
The J1939 node address that this session uses to read and write address specific frames.
SAE J1939:Node Name
The J1939 Node Name associated with this session. This is usually assigned as content of the J1939:ECU property, but can be read out or overridden manually.
SAE J1939:Number of Packets Received
Maximum number of packets received in a block for the J1939 Transport Protocol.
SAE J1939:Number of Packets Response
Maximum number of packets transmitted in a block for the J1939 Transport Protocol.
SAE J1939:Timing:Hold Time Th
Changes the Hold Time Timeout value at the responder node. Value specifies the minimum delay between a TP.CM_CTS hold message and the next TP.CM_CTS message, in seconds.
SAE J1939:Timing:Response Time Tr_GD
Changes the Device Response Time for TP.CM_BAM messages. Value is the minimum delay between sending two TP.CM_BAM messages, in seconds. Recommended range is 0.05 to 0.200 s.
SAE J1939:Timing:Response Time Tr_SD
Changes the Device Response Time value for TP.CM_RTS/CTS messages. Value specifies the minimum delay between receipt of a message and sending a response. This value also specifies a minimum time delay between packets of a multipacket message directed to a specific destination.
SAE J1939:Timing:Timeout T1
Changes the timeout T1 value for the responder node. Value is the maximum gap between two received TP.DT messages, in seconds.
SAE J1939:Timing:Timeout T2
Changes the timeout T2 value at the responder node. Value is the maximum gap between sending out a TP.CM_CTS message and receiving the next TP.DT message, in seconds.
SAE J1939:Timing:Timeout T3
Changes the timeout T3 value at the originator node. Value is the maximum gap between sending out a TP.CM_RTS message or the last TP.DT message and receiving the TP.CM_CTS response, in seconds.
SAE J1939:Timing:Timeout T4
Changes the timeout T4 value at the originator node. Value is the maximum gap between the TP.CM_CTS hold message and the next TP.CM_CTS message, in seconds.

NI-XNET LabVIEW API Reference

Log in to get a better experience