Table Of Contents

XNET Session Class

Last Modified: September 16, 2019

Reads and writes properties for an XNET Session I/O name.

Use the XNET Session property node to change the session configuration.

Name Description
Application Protocol Returns the application protocol that the session uses.
Auto Start? Automatically starts the output session on the first call to XNET Write.
Cluster Returns the cluster (network) used with XNET Create Session.
Database This property returns the database used with the XNET Create Session.
List of Signals Returns the list of frames in the session.
List of Frames Returns the list of frames in the session.
Payload Length Maximum Maximum payload length of all frames in this session, expressed as bytes (0-254). This property applies only to Frame sessions.
Protocol Returns the protocol that the interface in the session uses.
Mode Returns the session mode (ring) you provided this mode when you created the session.
Number in List Returns the number of frames or signals in the session's list. This is a quick way to get the size of the List of Frames or List of Signals property.
Number of Values Pending Returns the number of values (frames or signals) pending for the session.
Number of Values Unused Returns the number of values (frames or signals) unused for the session. If you get this property prior to starting the session, it provides the size of the underlying queue(s).
Resample Rate Rate used to resample frame data to/from signal data in waveforms.
Queue Size For output sessions, queues store data passed to XNET Write and not yet transmitted onto the network. For input sessions, queues store data received from the network and not yet obtained using XNET Read. For most applications, the default queue sizes are sufficient. You can write to this property to override the default.
Ethernet:Logging:Mode Enables or disables logging.
Ethernet:Logging:Filepath Specifies the path to the file in which you want to log data. The file must use the .pcap extension.
Ethernet:Logging:Operation Specifies the operation used to create the log file.
Ethernet:Number of Frames Received This is a cumulative count of frames received by the session while started.
Ethernet:Source MAC Address Auto? Configures whether the output session automatically uses the MAC Address property as the source MAC address in transmitted frames.
Frame:Active 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.
Frame:Output Queue Update Frequency Determines how often the NI-XNET firmware notifies the driver of frames being consumed from the output queue.
Frame:Skip N Cyclic Frames When set to a nonzero value N, this property causes the next N cyclic frames to be skipped.
Frame:CAN:Start Time Offset Specifies 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.
Frame:CAN:Transmit Time Specifies the amount of time that must elapse between subsequent transmissions of a cyclic frame.
Frame:LIN:Transmit N Corrupted Checksums When set to a nonzero value, this property causes the next N number of checksums to be corrupted.
Frame:SAE J1939:Address Filter Defines a filter for the source address of the PGN transmitting node. You can use this property when multiple nodes with different addresses are transmitting the same PGN. This property can be used only in input sessions.
Interface:64bit Baud Rate Sets the CAN, FlexRay, or LIN interface baud rate. The default value for this interface property is the same as the cluster's baud rate in the database.
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:Echo Transmit? Determines whether Frame Input or Signal Input sessions contain frames that the interface transmits.
Interface:I/O Name Returns a reference to the interface used to create the session.
Interface:Output Stream List Provides a list of frames for use with the replay feature (Interface:Output Stream Timing property set to Replay Exclusive or Replay Inclusive).
Interface:Output Stream List By ID Provides a list of frames for use with the replay feature.
Interface:Output Stream Timing The Output Stream Timing property configures how the hardware transmits frames queued using a Frame Output Stream session.
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.
Interface:CAN:External Transceiver Config Enables you to configure XS series CAN hardware to communicate properly with your external transceiver.
Interface:CAN:64bit FD Baud Rate Sets the fast data baud rate for CAN FD+BRS CAN:I/O Mode. The default value for this interface property is the same as the cluster's FD baud rate in the database.
Interface:CAN:I/O Mode Indicates the I/O Mode the interface is using: CAN (0), CAN FD (1), or CAN FD + BRS (2).
Interface:CAN:Listen Only? Determines whether the CAN interface transmits any information to the CAN bus.
Interface:CAN:Pending Transmit Order Configures how the CAN interface manages the internal queue of frames: As Submitted (0) or By Identifier (1).
Interface:CAN:Single Shot Transmit? Determines whether the CAN interface retries failed transmissions.
Interface:CAN:Termination Configures the onboard termination of the NI-XNET interface CAN connector (port) to be Off or On. CAN hardware can have different termination requirements;, and the Off and On values have different meanings.
Interface:CAN:Transceiver State Configures the CAN transceiver and CAN controller states, such as such as whether the transceiver is asleep or communicating.
Interface:CAN:Transceiver Type Enables you to set the transceiver type for XNET hardware that provides a software-selectable transceiver type.
Interface:CAN:Transmit I/O Mode Specifies the I/O Mode the interface uses when transmitting a CAN frame.
Interface:CAN:FD ISO Mode Indicates whether the interface is working in the ISO CAN FD standard or non-ISO CAN FD standard.
Interface:CAN:Enable Edge Filter When this property is enabled, the CAN hardware requires two consecutive dominant time quanta (tq) to detect an edge for hard synchronization.
Interface:CAN:Transmit Pause Indicates whether the CAN hardware pauses before transmitting the next frame.
Interface:CAN:Disable Protocol Exception Handling Indicates whether default protocol exception handling is disabled and the CAN hardware transmits an error frame instead.
Interface:Ethernet:Adjust Local Time Applies a positive or negative phase adjustment, in nanoseconds, to the local time that is used to timestamp Ethernet frames.
Interface:Ethernet:IPv4 Address Indicates the IPv4 address that is configured on the XNET interface in the network by the OS stack.
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.
Interface:Ethernet:Operational Status Indicates the operational status of the interface (that is, communicating or not).
Interface:Ethernet:OS Network Adapter Name Returns the name of this XNET session's Ethernet interface as represented in the OS. On XNET Ethernet products, each port can be accessed as an XNET interface or by using an operating system API for Ethernet.
Interface:Ethernet:OS Network Adapter Description Returns the description of this XNET session's Ethernet interface as represented in the OS. On XNET Ethernet products, each port can be accessed as an XNET interface or by using an operating system API for Ethernet.
Interface:Ethernet:PHY State Indicates the master/slave state that the interface is using for the Ethernet PHY.
Interface:Ethernet:Port Mode Indicates the hardware connectivity for the port.
Interface:Ethernet:Link Speed Configured Indicates the link speed that is configured for the Ethernet interface. This property is configured using NI-MAX or the System Configuration property Link Speed Configured.
Interface:Ethernet:Link Speed Indicates the current link speed on the interface or shows if the link is down.
Interface:Ethernet:Statistics:Counter Names Returns the name of each Ethernet statistics property supported by XNET.
Interface:Ethernet:Statistics:Counter Values Returns the counter value of each Ethernet statistics property supported by XNET.
Interface:Ethernet:Statistics:Rx Bytes Count 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.
Interface:Ethernet:Statistics:Rx Good Frames Count Count of error-free frames received.
Interface:Ethernet:Statistics:Rx Bad Frames Count Count of frames received with an error detected by the Ethernet MAC and/or PHY.
Interface:Ethernet:Statistics:Tx Bytes Count Count of the number of bytes (octets) transmitted. The count for each frame is its frame length.
Interface:Ethernet:Statistics:Tx Good Frames Count Count of error-free frames transmitted.
Interface:Ethernet:Endpoint:Receive Filter Each frame that is received by the interface 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.
Interface:Ethernet:Endpoint:Transmit Bandwidth Configures the maximum bandwidth for the credit-based shaper algorithm specified in IEEE Std 802.1Q, which is used for all transmissions from the endpoint.
Interface:Ethernet:Time Sync:Protocol Specifies the time synchronization protocol that the clock is using.
Interface:Ethernet:Time Sync:Protocol Enabled? Enables (runs) or disables the time synchronization protocol.
Interface:Ethernet:Time Sync:BMCA Enabled? Enables (runs) the Best Master Clock Algorithm (BMCA) of the time synchronization Protocol.
Interface:Ethernet:Time Sync:Offset From Master Provides the positive or negative offset in time between this clock and the grandmaster.
Interface:Ethernet:Time Sync:Clock ID This property uniquely identifies the clock in the network.
Interface:Ethernet:Time Sync:Clock Class Provides the traceability of time or frequency distributed by the clock when it is the grandmaster. The value for this property is an integer.
Interface:Ethernet:Time Sync:Clock Accuracy Indicates the accuracy of the hardware clock (e.g., oscillator) distributed by the clock when it is the grandmaster.
Interface:Ethernet:Time Sync:Clock Offset Scaled Log Variance Provides an estimate of the precision of the timestamping that the clock uses for the protocol.
Interface:Ethernet:Time Sync:Priority1 The best master clock algorithm (BMCA) uses this property as the first comparison to determine the grandmaster. Lower values take precedence.
Interface:Ethernet:Time Sync:Priority2 The best master clock algorithm (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.
Interface:Ethernet:Time Sync:Steps to Grandmaster Indicates 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:Grandmaster Clock ID This property provides the Clock ID of the currently selected grandmaster for this clock.
Interface:Ethernet:Time Sync:Grandmaster Clock Class Provides the Clock Class of the currently selected grandmaster for this clock.
Interface:Ethernet:Time Sync:Grandmaster Clock Accuracy Provides the Clock Accuracy of the currently selected grandmaster for this clock.
Interface:Ethernet:Time Sync:Grandmaster Clock Offset Scaled Log Variance Provides the Clock Offset Scaled Log Variance of the currently selected grandmaster for this clock.
Interface:Ethernet:Time Sync:Grandmaster Priority1 Provides the Priority1 property of the currently selected grandmaster for this clock.
Interface:Ethernet:Time Sync:Grandmaster Priority2 Provides the Priority2 property of the currently selected grandmaster for this clock.
Interface:Ethernet:Time Sync:Adjust Network Time When this clock is the grandmaster (that is, the Grandmaster Clock ID equals the Clock ID), a write of this property applies a positive or negative adjustment to the time distributed to the network. This can be used to align network time with another timescale.
Interface:Ethernet:Time Sync:Port:Port State Configured Configures the Port State when BMCA Enabled? is False. Valid values are Master and Slave.
Interface:Ethernet:Time Sync:Port:Port State Provides the current state of the port.
Interface:Ethernet:Time Sync:Port:Propagation Delay Provides the propagation delay for the Ethernet cable between this clock and its neighboring clock.
Interface:Ethernet:Time Sync:Port:Propagation Delay Configured Configures the Propagation Delay when Pdelay Enabled? is False. If Pdelay Enabled? is True, the value in this property is ignored.
Interface:Ethernet:Time Sync:Port:Propagation Delay Threshold Sets the threshold for the Propagation Delay property.
Interface:Ethernet:Time Sync:Port:Pdelay Enabled? Enables the exchange of Pdelay (peer-to-peer delay) messages, as a means of measuring Propagation Delay.
Interface:Ethernet:Time Sync:Port:Log Pdelay_Req Interval Configured If the Pdelay Enabled? property is True, this property configures the interval between successive transmissions of the Pdelay_Req message by this port.
Interface:Ethernet:Time Sync:Port:Log Pdelay_Req Interval If the Pdelay Enabled? property is True, this property provides the current interval used for successive transmissions of the Pdelay_Req 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 transmissions of the sync message by this port.
Interface:Ethernet:Time Sync:Port:Log Sync Interval
Interface:Ethernet:Time Sync:Port:Sync Receipt Timeout If Port State is Slave, this property configures the number of sync intervals to wait without receiving a sync message before assuming that the neighboring Master is no longer available and that the best master clock algorithm (BMCA) needs to run, if enabled.
Interface:Ethernet:Time Sync:Port:Log Announce Interval Configured If Announce Transmit Enabled? is True, this property provides the current interval used for successive transmissions of the announce message by this port.
Interface:Ethernet:Time Sync:Port:Log Announce Interval If Announce Transmit Enabled? is True, this property provides the current interval used for successive transmissions of the announce message by this port.
Interface:Ethernet:Time Sync:Port:Announce Transmit Enabled? Enables the transmit of announce messages, which provide properties of this port as a potential grandmaster.
Interface:Ethernet:Time Sync:Port:Announce Receipt Timeout If Port State is Slave, this property configures the number of announce intervals to wait without receiving an announce message before assuming that the neighboring Master is no longer available and that the best master clock algorithm (BMCA) needs to run, if enabled.
Interface:Ethernet:Time Sync:Port:AS Capable? Returns True if the neighboring port is running the protocol according to the requirements in the standard; it returns False otherwise.
Interface:Ethernet:Time Sync:Port:Synced? Indicates whether the clock using the time synchronization protocol is successfully synchronized to other clocks in the network.
Interface:Ethernet:Time Sync:Port:Sync Status Provides the current synchronization status of the time synchronization protocol.
Interface:Ethernet:Time Sync:Port:Statistics:Counter Names Returns the name of each Ethernet statistics property supported by XNET.
Interface:Ethernet:Time Sync:Port:Statistics:Counter Values returns the counter value of each Time Sync Port statistics property supported by XNET.
Interface:Ethernet:Time Sync:Port:Statistics:Rx Sync Count A count of the number of Sync messages received.
Interface:Ethernet:Time Sync:Port:Statistics:Rx Announce Count A count of the number of announce messages received.
Interface:Ethernet:Time Sync:Port:Statistics:Rx Pdelay Request Count A count of the number of Pdelay_Req messages received.
Interface:Ethernet:Time Sync:Port:Statistics:Tx Sync Count A count of the number of Sync messages transmitted.
Interface:Ethernet:Time Sync:Port:Statistics:Tx Announce Count A count of the number of announce messages transmitted.
Interface:Ethernet:Time Sync:Port:Statistics:Tx Pdelay Request Count A count of the number of Pdelay_Req messages transmitted.
Interface:FlexRay:Accepted Startup Range Range of clock deviation allowed for startup frames during node integration. 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 the FlexRay node can transition from the POC: normal-passive to the POC: normal-active state. The property is expressed as the number of even/odd cycle pairs, with values of 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 Local cluster drift damping factor used for rate correction. The range for the property is 0–20 MT.
Interface:Flexray:Coldstart? Indicates whether the FlexRay interface operates as a coldstart node on the cluster (boolean).
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 Specifies the value used to calculate the difference between primary time reference point and secondary time reference point (for clock synchronization). Expressed in microticks (14-143).
Interface:Flexray:Delay Compensation Ch A Specifies the value that the XNET FlexRay interface (node) uses to compensate for reception delays on channel A.
Interface:Flexray:Delay Compensation Ch B Specifies the value that the XNET FlexRay interface (node) uses to compensate for reception delays on channel B.
Interface:Flexray:Key Slot Identifier Specifies the 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 Specifies the upper limit for the startup listen timeout and wakeup listen timeout. Expressed in microticks (1284–1283846).
Interface:Flexray:Macro Initial Offset Ch A Specifies the 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 Specifies the 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 Specifies the number of microticks between the closest macrotick boundary described by the Macro Initial Offset Ch A Interface property 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 the Macro Initial Offset Ch B Interface property 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.
Interface:Flexray:Null Frames To Input Stream? Indicates whether the Frame Input Stream session should return FlexRay null frames from XNET Read>.
Interface:Flexray:Offset Correction Provides the maximum permissible offset correction value, expressed in microticks. The offset correction synchronizes the cycle start time.
Interface:Flexray:Offset Correction Out Specifies the magnitude of the maximum permissible offset correction value. Expressed in microticks (5-15266).
Interface:Flexray:Rate Correction Provides the rate correction value. Expressed in microticks. The rate correction synchronizes frequency. This property is read-only.
Interface:Flexray:Rate Correction Out Specifies the magnitude of the maximum permissible rate correction value. Expressed in microticks (2-1923).
Interface:Flexray:Samples Per Microtick Specifies the number of samples per microtick.
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:Single Slot Enabled? Configures whether the FlexRay interface (node) should enter single slot mode following startup (boolean).
Interface:FlexRay:Statistics Enabled? Configures whether to enable reporting of FlexRay error statistics.
Interface:FlexRay:Symbol Frames To Input Stream? This property indicates whether the Frame Input Stream Mode session should return FlexRay symbols from XNET Read.
Interface:FlexRay:Sync Frames Channel A Even Returns an array of sync frames (slot IDs) transmitted or received on channel A during the last even cycle.
Interface:FlexRay:Sync Frames Channel A Odd Returns an array of sync frames (slot IDs) transmitted or received on channel A during the last odd cycle.
Interface:FlexRay:Sync Frames Channel B Even Returns an array of sync frames (slot IDs) transmitted or received on channel B during the last even cycle.
Interface:FlexRay:Sync Frames Channel B Odd Returns an array of sync frames (slot IDs) transmitted or received on channel B during the last odd cycle.
Interface:FlexRay:Sync Frame Status This property returns the status of sync frames since the interface (enumeration) start.
Interface:FlexRay:Termination Controls termination at the NI-XNET interface (enumeration) connector (port).
Interface:FlexRay:Wakeup Channel Specifies the channel the FlexRay interface (node) uses to send a wakeup pattern.
Interface:FlexRay:Wakeup Pattern Specifies the 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).
Interface:LIN:Break Length Determines the length of the serial break used at the start of a frame header (schedule entry). The value is specified in bit-times.
Interface:LIN:DiagP2min 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 Sets the minimum time (in seconds) the interface places between the end of transmission of a frame in a diagnostic message and the start of transmission of the next frame in the diagnostic message.
Interface:LIN:Master? Specifies the role of the NI-XNET LIN interface the network: master (True) or slave (False). The default value is False.
Interface:LIN:Output Stream Slave Response List By NAD Provides a list of NADs for use with the replay feature (Interface:Output Stream Timing property set to Replay Exclusive or Replay Inclusive).
Interface:LIN:Schedules Provides the list of schedules for use when the NI-XNET LIN interface acts as a master (Interface:LIN:Master? is True).
Interface:LIN:Sleep Changes the sleep/awake state for the NI-XNET LIN interface, and can be used to change remote node (ECU) sleep/awake states.
Interface:LIN:Start Allowed without Bus Power? Configures whether a LIN session is allowed to start without bus power applied to the interface. The default value is False.
Interface:LIN:Termination Configures the NI-XNET interface LIN connector (port) onboard termination.
Interface:LIN:No Response Frames to Input Stream? Configures the hardware to place a LIN No Response frame in the Stream Input queue after it is generated.
Interface:LIN:Checksum to Input Stream? Configures the hardware to place the received checksum for each LIN data frame into the Event ID (Info) field. The default value is False.
Interface:Source Terminal:Start Trigger Specifies the name of the internal terminal to use as the interface Start Trigger. The data type is NI Terminal (DAQmx terminal).
SAE J1939:Node Address The J1939 node address that this session uses to read and write address specific frames.
SAE J1939:ECU Busy Indicates that the J1939 session temporarily does not accept long messages.
SAE J1939:ECU Assigns a database ECU to this session.
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:Maximum Repeat CTS Maximum number of CTS repetitions for the J1939 Transport Protocol.
SAE J1939:Number of Packets Received Maximum number of data packets that can be received in one block at the responder node 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:Include Destination Address in PGN Include the J1939 destination address (PDU1 PS field) when matching received frames to database frames.
SAE J1939:Timing:Hold Time Th Modifies the Hold Time Timeout value at the responder node.
J1939:Timing:Response Time Tr_SD Modifies the Device Response Time value for specific destination messages (TP.CM_RTS/CTS messages).
J1939:Timing:Response Time Tr_GD Modifies the Device Response Time value for global destination messages (TP.CM_BAM messages).
SAE J1939:Timing:Timeout T1 Modifies the timeout T1 value for the responder node.
SAE J1939:Timing:Timeout T2 Modifies the timeout T2 value at the responder node.
SAE J1939:Timing:Timeout T3 Modifies the timeout T3 value at the originator node.
SAE J1939:Timing:Timeout T4 Modifies the timeout T4 value at the originator node.

Recently Viewed Topics