NI XNET XNET ECU Properties

XNET ECU Properties

• Cluster
• Comment
• Configuration Status
• FlexRay:Coldstart?
• FlexRay:Connected Channels
• FlexRay:Startup Frame
• FlexRay:Wakeup Channels
• FlexRay:Wakeup Pattern
• Frames Received
• Frames Transmitted
• LIN Master
• LIN Version
• LIN:Initial NAD
• LIN:Configured NAD
• LIN:Supplier ID
• LIN:Function ID
• LIN:P2min
• LIN:STmin
• Name (Short)
• SAE J1939:Preferred Address
• SAE J1939:Node Name

Cluster

Data Type	Direction	Required?	Default
nxDatabaseRef_t	Read Only	N/A	N/A

Property Class

XNET PDU

Property ID

nxPropPDU_ClusterRef

Description

This property returns the reference (nxDatabaseRef_t) to the parent cluster in which the PDU has been created. You cannot change the parent cluster after creating the PDU object.

Comment

Data Type	Direction	Required?	Default
char *	Read/Write	No	Empty String

Property Class

XNET Signal

Property ID

nxPropSig_Comment

Description

Comment describing the signal object.

A comment is a string containing up to 65535 characters.

Configuration Status

Data Type	Direction	Required?	Default
i32	Read Only	No	N/A

Property Class

XNET Signal

Property ID

nxPropSig_ConfigStatus

Description

The signal object configuration status.

Configuration Status returns an NI-XNET error code. You can pass the value to the nxStatusToString error code input to convert the value to a text description of the configuration problem.

By default, incorrectly configured signals in the database are not returned from the XNET Frame Signals property because they cannot be used in the bus communication. You can change this behavior by setting the XNET Database ShowInvalidFromOpen? property to true. When a signal configuration status becomes invalid after the database is opened, the signal still is returned from the Signals property even if the ShowInvalidFromOpen? property is false.

Examples of invalid signal configuration:

• The signal is specified using bits outside the frame payload.
• The signal overlaps another signal in the frame. For example, two multiplexed signals with the same multiplexer value are using the same bit in the frame payload.
• The frame containing the signal is invalid (for example, a CAN frame is defined with more than 8 payload bytes).

Name (Short)

Data Type	Direction	Required?	Default
char *	Read/Write	Yes	Defined in nxdbCreateObject

Property Class

XNET Subframe

Property ID

nxPropSubfrm_Name

Description

String identifying a subframe object.

Lowercase letters (a–z), uppercase letters (A–Z), numbers, and the underscore (_) are valid characters for the short name. The space ( ), period (.), and other special characters are not supported within the name. The short name must begin with a letter (uppercase or lowercase) or underscore, and not a number. The short name is limited to 128 characters.

A subframe name must be unique for all subframes in a frame.

This short name does not include qualifiers to ensure that it is unique, such as the database, cluster, and frame name. It is for display purposes.

You can write this property to change the subframe's short name.

FlexRay:Coldstart?

Data Type	Direction	Required?	Default
bool	Read Only	N/A	N/A

Property Class

XNET ECU

Property ID

nxPropECU_FlexRayIsColdstart

Description

Indicates that the ECU is sending a startup frame.

This property is valid only for ECUs connected to a FlexRay bus. It returns true when one of the frames this ECU transmits has the XNET Frame FlexRay:Startup? property set to true. You can determine the frame transmitting the startup using the XNET ECU FlexRay:Startup Frame property. An ECU can send only one startup frame on the FlexRay bus.

FlexRay:Connected Channels

Data Type	Direction	Required?	Default
u32	Read/Write	No	Calculated from Cluster Settings

Property Class

XNET ECU

Short Name

nxPropECU_FlexRayConnectedChs

Description

This property specifies the channel(s) that the FlexRay ECU (node) is physically connected to. The default value of this property is connected to all channels available on the cluster.

This property corresponds to the pChannels node parameter in the FlexRay Protocol Specification.

The values supported for this property (enumeration) are A = 1, B = 2, and A and B = 3.

FlexRay:Startup Frame

Data Type	Direction	Required?	Default
nxDatabaseRef_t	Read Only	N/A	N/A

Property Class

XNET ECU

Property ID

nxPropECU_FlexRayStartupFrameRef

Description

Returns the refnum to the startup frame the ECU sends.

This property is valid only for ECUs connected to a FlexRay bus. If the ECU transmits a frame (refer to the XNET ECU Frames Transmitted property) with the XNET Frame FlexRay:Startup? property set to true, this property returns this frame. Otherwise, it is empty.

FlexRay:Wakeup Channels

Data Type	Direction	Required?	Default
u32	Read/Write	No	None

Property Class

XNET ECU

Short Name

nxPropECU_FlexRayWakeupChs

Description

This property specifies the channel(s) on which the FlexRay ECU (node) is allowed to generate the wakeup pattern. The default value of this property is not to be a wakeup node.

When importing from a FIBEX file, this parameter corresponds to a WAKE-UP-CHANNEL being set to True for each connected channel.

The values supported for this property (enumeration) are A = 1, B = 2, A and B = 3, and None = 4.

FlexRay:Wakeup Pattern

Data Type	Direction	Required?	Default
u32	Read/Write	No	2

Property Class

XNET ECU

Short Name

nxPropECU_FlexRayWakeupPtrn

Description

This property specifies the number of repetitions of the wakeup symbol that are combined to form a wakeup pattern when the FlexRay ECU (node) enters the POC:WAKEUP_SEND state. The POC:WAKEUP_SEND state is one of the FlexRay controller state transitions during the wakeup process. In this state, the controller sends the wakeup pattern on the specified Wakeup Channel and checks for collisions on the bus.

This property is used when FlexRay:Wakeup Channels is set to a value other than None and FlexRay:Use Wakeup? is True.

This property corresponds to the pWakeupPattern node parameter in the FlexRay Protocol Specification.

The supported values for this property are 2–63.

Frames Received

Data Type	Direction	Required?	Default
nxDatabaseRef_t *	Read/Write	No	Empty Array

Property Class

XNET ECU

Property ID

nxPropECU_RxFrmRefs

Description

Returns an array of refnums to frames the ECU receives.

This property defines all frames the ECU receives. All frames an ECU receives in a given cluster must be defined in the same cluster.

Note  Invalid clusters, frames, and signals are not returned in properties that return XNET I/O Names for the database.

Frames Transmitted

Data Type	Direction	Required?	Default
nxDatabaseRef_t *	Read/Write	No	Empty Array

Property Class

XNET ECU

Property ID

nxPropECU_FrmsTx

Description

Returns an array of refnums to frames the ECU transmits.

This property defines all frames the ECU transmits. All frames an ECU transmits in a given cluster must be defined in the same cluster.

Note  Invalid clusters, frames, and signals are not returned in properties that return XNET I/O Names for the database.

LIN:Initial NAD

Data Type	Direction	Required?	Default
u32	Read/Write	N/A	N/A

Property Class

XNET ECU

Property ID

nxPropECU_LINInitialNAD

Description

Initial NAD of a LIN slave node. NAD is the address of a slave node and is used in diagnostic services. Initial NAD is replaced by configured NAD with node configuration services. This property must be defined before reading, either by writing to the property or by importing from an LDF.

Caution  This property is not saved in the FIBEX database. You can import it only from an LDF file.

LIN:Configured NAD

Data Type	Direction	Required?	Default
u32	Read/Write	N/A	N/A

Property Class

XNET ECU

Property ID

nxPropECU_LINConfigNAD

Description

Configured NAD of a LIN slave node. NAD is the address of a slave node and is used in diagnostic services. Initial NAD is replaced by configured NAD with node configuration services. This property must be defined before reading, either by writing to the property or by importing from an LDF.

Caution  This property is not saved in the FIBEX database. You can import it only from an LDF file.

LIN:Supplier ID

Data Type	Direction	Required?	Default
u32	Read/Write	N/A	N/A

Property Class

XNET ECU

Property ID

nxPropECU_LINSupplierID

Description

Supplier ID is a 16-bit value identifying the supplier of the LIN node (ECU). This property must be defined before reading, either by writing to the property or by importing from an LDF.

Caution  This property is not saved in the FIBEX database. You can import it only from an LDF file.

LIN:Function ID

Data Type	Direction	Required?	Default
u32	Read/Write	N/A	N/A

Property Class

XNET ECU

Property ID

nxPropECU_LINFunctionID

Description

Function ID is a 16-bit value identifying the function of the LIN node (ECU). This property must be defined before reading, either by writing to the property or by importing from an LDF.

Caution  This property is not saved in the FIBEX database. You can import it only from an LDF file.

LIN:P2min

Data Type	Direction	Required?	Default
Double	Read/Write	N/A	N/A

Property Class

XNET ECU

Property ID

nxPropECU_LINP2min

Description

The minimum time in seconds between reception of the last frame of the diagnostic request and the response sent by the node. This property must be defined before reading, either by writing to the property or by importing from an LDF.

Caution  This property is not saved in the FIBEX database. You can import it only from an LDF file.

LIN:STmin

Data Type	Direction	Required?	Default
Double	Read/Write	N/A	N/A

Property Class

XNET ECU

Property ID

nxPropECU_LINSTmin

Description

The minimum time in seconds the node requires to prepare for the next frame of the diagnostic service. This property must be defined before reading, either by writing to the property or by importing from an LDF.

Caution  This property is not saved in the FIBEX database. You can import it only from an LDF file.

SAE J1939:Preferred Address

Data Type	Direction	Required?	Default
u32	Read/Write	No	254 (Null)

Property Class

XNET ECU

Property ID

nxPropECU_J1939PreferredAddress

Description

The preferred J1939 node address to be used when simulating this ECU. If you assign this ECU to an XNET session (nxPropSession_J1939ECU property), XNET will start address claiming for this address using the nxPropECU_J1939NodeName property and use the address for the session when the address is granted.

SAE J1939:Node Name

Data Type	Direction	Required?	Default
u64	Read/Write	No	0

Property Class

XNET ECU

Property ID

nxPropECU_J1939NodeName

Description

The preferred J1939 node address to be used when simulating this ECU. If you assign this ECU to an XNET session nxPropSession_J1939ECU property), XNET will start address claiming for this address using this node name and the nxPropSession_J1939PreferredAddress) property.

LIN Master

Data Type	Direction	Required?	Default
bool	Read/Write	No	False

Property Class

XNET ECU

Property ID

nxPropECU_LINMaster

Description

Determines whether the ECU is a LIN master (true) or LIN slave (false).

LIN Version

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	N/A

Property Class

XNET ECU

Property ID

nxPropECU_LINProtocolVer

Description

Version of the LIN standard this ECU uses. The values (enumeration) for this property are:

• nxLINProtocolVer_1_2
• nxLINProtocolVer_1_3
• nxLINProtocolVer_2_0
• nxLINProtocolVer_2_1