XNET Write (Frame CAN).vi

XNET Write (Frame CAN).vi

Purpose

Writes data to a session as an array of CAN frames. The session must use a CAN interface and a mode of Frame Output Stream, Frame Output Queued, or Frame Output Single-Point.

Format

Inputs

	session in is the session to write. This session is selected from the LabVIEW project or returned from the XNET Create Session VI. The session mode must be Frame Output Stream, Frame Output Queued, or Frame Output Single-Point.
	data provides the array of LabVIEW clusters. Each array element corresponds to a frame value to transmit. For a Frame Output Single-Point session mode, the order of frames in the array corresponds to the order in the session list. The data you write is queued up for transmit on the network. Using the default queue configuration for this mode, you can safely write 64 frames if you have a sufficiently long timeout. To write more data, refer to the XNET Session Number of Values Unused property to determine the actual amount of queue space available for write. For an example of how this data applies to network traffic, refer to Frame Output Stream Mode, Frame Output Queued Mode, or Frame Output Single-Point Mode. Additionally, the XNET Write (Frame CAN) VI can be called on any signal or frame input session if it contains one or more Event Remote frames (refer to CAN:Timing Type). In this case, it signals an event to transmit those remote frames. The data parameter is ignored in this case, and you can set it to an empty array. The elements of each cluster are specific to the CAN protocol. For more information, refer to Summary of the CAN Standard or the CAN protocol specification. The cluster elements are: identifier is the CAN frame arbitration identifier. If extended? is false, the identifier uses standard format, so 11 bits of this identifier are valid. If extended? is true, the identifier uses extended format, so 29 bits of this identifier are valid. extended? is a Boolean value that determines whether the identifier uses extended format (true) or standard format (false). echo? is not used for transmit. You must set this element to false. type is the frame type (decimal value in parentheses): CAN Data (0) The CAN data frame contains payload data. This is the most commonly used frame type for CAN. In ISO CAN FD interface mode, this transmits a frame according to the interface setting (FD or FD+BRS). ISO CAN FD mode allows transmitting CAN 2.0, CAN FD, or CAN FD+BRS frames using the frame type (refer to the types listed below). CAN 2.0 Data (8) The CAN data frame contains payload data. In ISO CAN FD interface mode, this frame is transmitted as a CAN 2.0 frame. When the interface is not in ISO CAN FD mode, this type is treated like CAN Data (0). CAN FD Data (16) The CAN data frame contains payload data. In ISO CAN FD interface mode, this frame is transmitted as a CAN FD (no BRS) frame. When the interface is not in ISO CAN FD mode, this type is treated like CAN Data (0). CAN FD+BRS Data (24) The CAN data frame contains payload data. In ISO CAN FD+BRS mode, this frame is transmitted as a CAN FD+BRS frame. When the interface is not in ISO CAN FD mode, this type is treated like CAN Data (0). CAN Remote (1) CAN remote frame. Your application transmits a CAN remote frame to request data for the corresponding identifier. A remote ECU should respond with a CAN data frame for the identifier, which you can obtain using the XNET Read VI. timestamp represents absolute time using the LabVIEW absolute timestamp type. timestamp is not used for transmit. You must set this element to the default value, invalid (0). payload is the array of data bytes for a CAN data frame. The array size indicates the payload length of the frame value to transmit. According to the CAN protocol, the payload length range is 0–8. For CAN FD, the range can be 0–8, 12, 16, 20, 24, 32, 48, or 64. When the session mode is Frame Output Single-Point or Frame Output Queued, the number of bytes in the payload array must be less than or equal to the Payload Length property of the corresponding frame. You can leave all other CAN frame cluster elements uninitialized. For more information, refer to the topic for each mode. For a transmitted remote frame (CAN Remote type), the payload length in the frame value specifies the number of payload bytes requested. Your application provides this payload length by filling payload with the requested number of bytes. This enables your application to specify the frame payload length, but the actual values in the payload bytes are ignored (not contained in the transmitted frame).
	timeout is the time to wait for the CAN frame data to be queued up for transmit. The timeout is a LabVIEW relative time, represented as 64-bit floating-point in units of seconds. If timeout is positive, the XNET Write (Frame CAN) VI waits up to that timeout for space to become available in queues. If the space is not available prior to the timeout, a timeout error is returned. If timeout is negative, the XNET Write (Frame CAN) VI waits indefinitely for space to become available in queues. If timeout is 0, the XNET Write (Frame CAN) VI does not wait and immediately returns with a timeout error if all data cannot be queued. Regardless of the timeout used, if a timeout error occurs, none of the data is queued, so you can attempt to call the XNET Write (Frame CAN) VI again at a later time with the same data. This input is optional. The default value is 10.0 (10 seconds). If the session mode is Frame Output Single-Point, you must set timeout to 0.0. Because this mode writes the most recent value of each frame, timeout does not apply.
	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.
	error out is the error cluster output (refer to Error Handling).

Description

The data represents an array of CAN frames. Each CAN frame uses a LabVIEW cluster with CAN-specific elements.

The CAN frames are associated to the session's list of frames as follows:

• Frame Output Stream: Array of all frame values for transmit (list ignored).
• Frame Output Queued: Array of frame values to transmit for the single frame specified in the list.
• Frame Output Single-Point: Array of single frame values, one for each frame specified in the list.
• Any signal or frame input mode: The data parameter is ignored, and you can set it to an empty array. The VI transmits an event remote frame.