• 64bit Baud Rate
• Application Protocol
• CAN:64bit FD Baud Rate
• CAN:FD ISO Mode
• CAN:I/O Mode
• Comment
• Configuration Status
• Database
• ECUs
• FlexRay:Action Point Offset
• FlexRay:CAS Rx Low Max
• FlexRay:Channels
• FlexRay:Cluster Drift Damping
• FlexRay:Cold Start Attempts
• FlexRay:Cycle
• FlexRay:Dynamic Segment Start
• FlexRay:Dynamic Slot Idle Phase
• FlexRay:Latest Guaranteed Dynamic Slot
• FlexRay:Latest Usable Dynamic Slot
• FlexRay:Listen Noise
• FlexRay:Macro Per Cycle
• FlexRay:Macrotick
• FlexRay:Max Without Clock Correction Fatal
• FlexRay:Max Without Clock Correction Passive
• FlexRay:Minislot
• FlexRay:Minislot Action Point Offset
• FlexRay:Network Management Vector Length
• FlexRay:NIT
• FlexRay:NIT Start
• FlexRay:Number of Minislots
• FlexRay:Number of Static Slots
• FlexRay:Offset Correction Start
• FlexRay:Payload Length Dynamic Maximum
• FlexRay:Payload Length Maximum
• FlexRay:Payload Length Static
• FlexRay:Static Slot
• FlexRay:Symbol Window
• FlexRay:Symbol Window Start
• FlexRay:Sync Node Max
• FlexRay:TSS Transmitter
• FlexRay:Use Wakeup?
• FlexRay:Wakeup Symbol Rx Idle
• FlexRay:Wakeup Symbol Rx Low
• FlexRay:Wakeup Symbol Rx Window
• FlexRay:Wakeup Symbol Tx Idle
• FlexRay:Wakeup Symbol Tx Low
• Frames
• Name (Short)
• PDUs
• PDUs Required?
• Protocol
• Schedules
• Signals
• Tick

Data Type	Direction	Required?	Default
u32	Read/Write	No	Read from Database

XNET Frame

nxPropFrm_ApplicationProtocol

This property specifies the frame's application protocol. It is an enumerated list of two values:

Enumeration	Value	Description
None	0	The default application protocol.
J1939	1	Indicates J1939 frames. The value enables the following features: - Sending/receiving long frames as the SAE J1939 specification specifies, using the J1939 transport protocol. - Using a special notation for J1939 identifiers.

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

XNET Cluster

nxPropClst_DatabaseRef

Refnum to the cluster parent database.

The parent database is defined when the cluster object is created. You cannot change it afterwards.

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

XNET Session

nxPropSession_Protocol

This property returns the protocol that the interface in the session uses.

The values (enumeration) for this property are:

0	CAN
1	FlexRay
2	LIN
3	Ethernet

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayActPtOff

This property specifies the number of macroticks (MT) that the action point is offset from the beginning of a static slot or symbol window.

This property corresponds to the global cluster parameter gdActionPointOffset in the FlexRay Protocol Specification.

The action point is that point within a given slot where the actual transmission of a frame starts. This is slightly later than the start of the slot, to allow for a clock drift between the network nodes.

The range for this property is 1–63 MT.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayCASRxLMax

This property specifies the upper limit of the collision avoidance symbol (CAS) acceptance window. The CAS symbol is transmitted by the FlexRay interface (node) during the symbol window within the communication cycle. A receiving FlexRay interface considers the CAS to be valid if the pattern's low level is within 29 gdBit (cdCASRxLowMin) and CAS Rx Low Max.

This property corresponds to the global cluster parameter gdCASRxLowMax in the FlexRay Protocol Specification.

The values for this property are in the range 67–99 gdBit.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayChannels

This property specifies the FlexRay channels used in the cluster. Frames defined in this cluster are expected to use the channels this property specifies. Refer to the XNET Frame FlexRay:Channel Assignment property.

This property corresponds to the global cluster parameter gChannels in the FlexRay Protocol Specification.

A FlexRay cluster supports two independent network wires (channels A and B). You can choose to use both or only one in your cluster.

The values (enumeration) for this property are:

1	Channel A only
2	Channel B only
3	Channels A and B
This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayClstDriftDmp

This property specifies the cluster drift damping factor, based on the longest microtick used in the cluster. Use this global FlexRay parameter to compute the local cluster drift damping factor for each cluster node. You can access the local cluster drift for the XNET FlexRay interface from the XNET Session Interface:FlexRay:Cluster Drift Damping property.

This property corresponds to the global cluster parameter gdClusterDriftDamping in the FlexRay Protocol Specification.

The values for this property are in the range 0–5 MT.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayColdStAts

This property specifies the maximum number of times a node in this cluster can start the cluster by initiating schedule synchronization. This global cluster parameter is applicable to all cluster notes that can perform a coldstart (send startup frames).

This property corresponds to the global cluster parameter gColdStartAttempts in the FlexRay Protocol Specification.

The values for this property are in the range 2–31.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetPropert function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayCycle

This property specifies the duration of one FlexRay communication cycle, expressed in microseconds.

This property corresponds to the global cluster parameter gdCycle in the FlexRay Protocol Specification.

All frame transmissions complete within a cycle. After this time, the frame transmissions restart with the first frame in the next cycle. The communication cycle counts increment from 0–63, after which the cycle count resets back to 0.

The range for this property is 10–16000 µs.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read Only	N/A	Calculated from Other Cluster Properties

XNET Cluster

nxPropClst_FlexRayDynSegStart

This property specifies the start of the dynamic segment, expressed as the number of macroticks (MT) from the start of the cycle.

The range for this property is 8–15998 MT.

This property is calculated from other cluster properties. It is based on the total static segment size. It is set to 0 if the FlexRay:Number of Minislots property is 0 (no dynamic segment exists).

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayDynSlotIdlPh

This property specifies the dynamic slot idle phase duration.

This property corresponds to the global cluster parameter gdDynamicSlotIdlePhase in the FlexRay Protocol Specification.

The values for this property are in the range 0–2 minislots.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read Only	N/A	Calculated from Other Cluster Properties

XNET Cluster

nxPropClst_FlexRayLatestGuarDyn

This property specifies the highest slot ID in the dynamic segment that still can transmit a full-length (for example, Payload Length Dynamic Maximum) frame, provided all previous slots in the dynamic segment have transmitted full-length frames also.

A larger slot ID cannot be guaranteed to transmit a full-length frame in each cycle (although a frame might go out depending on the dynamic segment load).

The range for this property is 2–2047 slots.

This read-only property is calculated from other cluster properties. If the Number of Minislots is zero, no dynamic slots exist, and this property returns 0. Otherwise, the Number of Minislots is used along with Payload Length Dynamic Maximum to determine the latest dynamic slot guaranteed to transmit in the next cycle. In other words, when all preceding dynamic slots transmit with Payload Length Dynamic Maximum, this dynamic slot also can transmit with Payload Length Dynamic Maximum, and its frame ends prior to the end of the dynamic segment.

Data Type	Direction	Required?	Default
u32	Read Only	N/A	Calculated from Other Cluster Properties

XNET Cluster

nxPropClst_FlexRayLatestUsableDyn

This property specifies the highest slot ID in the dynamic segment that can still transmit a full-length (that is, Payload Length Dynamic Maximum) frame, provided no other frames have been sent in the dynamic segment.

A larger slot ID cannot transmit a full-length frame (but could probably still transmit a shorter frame).

The range for this property is 2–2047.

This read-only property is calculated from other cluster properties. If the Number of Minislots is zero, no dynamic slots exist, and this property returns 0. Otherwise, Number of Minislots is used along with Payload Length Dynamic Maximum to determine the latest dynamic slot that can be used when all preceding dynamic slots are empty (zero payload length). In other words, this property is calculated under the assumption that all other dynamic slots use only one minislot, and this dynamic slot uses the number of minislots required to deliver the maximum payload. The frame for this dynamic slot must end prior to the end of the dynamic segment. Any frame transmitted in a preceding dynamic slot is likely to preclude this slot's frame.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayLisNoise

This property specifies the upper limit for the startup and wakeup listen timeout in the presence of noise. It is used as a multiplier for the Interface:FlexRay:Listen Timeout property.

This property corresponds to the global cluster parameter gListenNoise in the FlexRay Protocol Specification.

The values for this property are in the range 2–16.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayMacroPerCycle

This property specifies the number of macroticks in a communication cycle. For example, if the FlexRay cycle has a duration of 5 ms (5000 µs), and the duration of a macrotick is 1 µs, the XNET Cluster FlexRay:Macro Per Cycle property is 5000.

This property corresponds to the global cluster parameter gMacroPerCycle in the FlexRay Protocol Specification.

The macrotick (MT) is the basic timing unit in the FlexRay cluster. Nearly all timing-dependent properties are expressed in terms of macroticks.

The range for this property is 10–16000 MT.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
f64	Read Only	N/A	Calculated from Other Cluster Parameters

XNET Cluster

nxPropClst_FlexRayMacrotick

This property specifies the duration of the clusterwide nominal macrotick, expressed in microseconds.

This property corresponds to the global cluster parameter gdMacrotick in the FlexRay Protocol Specification.

The macrotick (MT) is the basic timing unit in the FlexRay cluster. Nearly all timing-dependent properties are expressed in terms of macroticks.

The range for this property is 1–6 µs.

This property is calculated from the XNET Cluster FlexRay:Cycle and FlexRay:Macro Per Cycle properties and rounded to the nearest permitted value.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayMaxWoClkCorFat

This property defines the number of consecutive even/odd cycle pairs with missing clock correction terms that cause the controller to transition from the Protocol Operation Control status of Normal Active or Normal Passive to the Halt state. Use this global parameter as a threshold for testing the clock correction failure counter.

This property corresponds to the global cluster parameter gMaxWithoutClockCorrectionFatal in the FlexRay Protocol Specification.

The values for this property are in the range 1–15 even/odd cycle pairs.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayMaxWoClkCorPas

This property defines the number of consecutive even/odd cycle pairs with missing clock correction terms that cause the controller to transition from the Protocol Operation Control status of Normal Active to Normal Passive. Use this global parameter as a threshold for testing the clock correction failure counter.

Note  This property, Max Without Clock Correction Passive, <= Max Without Clock Correction Fatal <= 15. This property corresponds to the global cluster parameter gMaxWithoutClockCorrectionPassive in the FlexRay Protocol Specification.

The values for this property are in the range 1–15 even/odd cycle pairs.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayMinislotActPt

This property specifies the number of macroticks (MT) the minislot action point is offset from the beginning of a minislot.

This property corresponds to the global cluster parameter gdMinislotActionPointOffset in the FlexRay Protocol Specification.

The action point is that point within a given slot where the actual transmission of a frame starts. This is slightly later than the start of the slot to allow for a clock drift between the network nodes.

The range for this property is 1–31 MT.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayMinislot

This property specifies the duration of a minislot, expressed in macroticks (MT).

This property corresponds to the global cluster parameter gdMinislot in the FlexRay Protocol Specification.

In the dynamic segment of the FlexRay cycle, frames can have variable payload length.

Minislots are the dynamic segment time increments. In a minislot, a dynamic frame can start transmission, but it usually spans several minislots. If no frame transmits, the slot counter (slot ID) is incremented to allow for the next frame.

The total dynamic segment length is determined by multiplying this property by the Number Of Minislots property. The total dynamic segment length must be shorter than the Macro Per Cycle property minus the total static segment length.

The range for this property is 2–63 MT.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayNMVecLen

This property specifies the length of the Network Management vector (NMVector) in a cluster.

Only frames transmitted in the static segment of the communication cycle use the NMVector. The NMVector length specifies the number of bytes in the payload segment of the FlexRay frame transmitted in the status segment that can be used as the NMVector.

This property corresponds to the global cluster parameter gNetworkManagementVectorLength in the FlexRay Protocol Specification.

The range for this property is 0–12 bytes.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read Only	N/A	Calculated from Other Cluster Properties

XNET Cluster

nxPropClst_FlexRayNITStart

This property specifies the start of the Network Idle Time (NIT), expressed as the number of macroticks (MT) from the start of the cycle.

The NIT is a period at the end of a FlexRay communication cycle where no frames are transmitted. The network nodes use it to re-sync their clocks to the common network time.

The range for this property is 8–15998 MT.

This property is calculated from other cluster properties. It is the total size of the static and dynamic segments plus the symbol window length, which is optional in a FlexRay communication cycle.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayNIT

This property is the Network Idle Time (NIT) duration, expressed in macroticks (MT).

This property corresponds to the global cluster parameter gdNIT in the FlexRay Protocol Specification.

The NIT is a period at the end of a FlexRay communication cycle where no frames are transmitted. The network nodes use it to re-sync their clocks to the common network time.

Configure the NIT to be the Macro Per Cycle property minus the total static and dynamic segment lengths minus the optional symbol window duration.

The range for this property is 2–805 MT.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayNumMinislt

This property specifies the number of minislots in the dynamic segment.

This property corresponds to the global cluster parameter gNumberOfMinislots in the FlexRay Protocol Specification.

In the FlexRay cycle dynamic segment, frames can have variable payload lengths.

Minislots are the dynamic segment time increments. In a minislot, a dynamic frame can start transmission, but it usually spans several minislots. If no frame transmits, the slot counter (slot ID) is incremented to allow for the next frame.

The total dynamic segment length is determined by multiplying this property by the Minislot property. The total dynamic segment length must be shorter than the Macro Per Cycle property minus the total static segment length.

The range for this property is 0–7986.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayNumStatSlt

This property specifies the number of static slots in the static segment.

This property corresponds to the global cluster parameter gNumberOfStaticSlots in the FlexRay Protocol Specification.

Each static slot is used to transmit one (static) frame on the bus.

The total static segment length is determined by multiplying this property by the Static Slot property. The total static segment length must be shorter than the Macro Per Cycle property.

The range for this property is 2–1023.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayOffCorSt

This property specifies the start of the offset correction phase within the Network Idle Time (NIT), expressed as the number of macroticks (MT) from the start of the cycle.

This property corresponds to the global cluster parameter gOffsetCorrectionStart in the FlexRay Protocol Specification.

The NIT is a period at the end of a FlexRay communication cycle where no frames are transmitted. The network nodes use it to re-sync their clocks to the common network time.

The Offset Correction Start is usually configured to be NITStart + 1, but can deviate from that value. The range for this property is 9–15999 MT.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

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

XNET Cluster

nxPropClst_FlexRayPayldLenDynMax

This property specifies the maximum of the payload lengths of all dynamic frames.

In the FlexRay cycle dynamic segment, frames can have variable payload length.

The range for this property is 0–254 bytes (even numbers only).

The value returned for this property is the maximum of the payload lengths of all frames defined for the dynamic segment in the database.

Use this property to calculate the XNET Cluster FlexRay:Latest Usable Dynamic Slot and FlexRay:Latest Guaranteed Dynamic Slot properties.

You may temporarily set this to a larger value (if it is not yet the maximum), and then this value is returned for this property. But this setting is lost once the database is closed, and after a reopen, the maximum of the frames is returned again. The changed value is returned from the FlexRay:Payload Length Dynamic Maximum property until the database is closed.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read Only	N/A	Calculated from Other Cluster Properties

nxPropClst_FlexRayPayldLenMax

XNET Cluster

This property returns the payload length of any frame (static or dynamic) in this cluster with the longest payload.

The range for this property is 0–254 bytes (even numbers only). The payload specifies that the frame transfers the data.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayPayldLenSt

This property specifies the payload length of a static frame. All static frames in a cluster have the same payload length.

This property corresponds to the global cluster parameter gPayloadLengthStatic in the FlexRay Protocol Specification.

The range for this property is 0–254 bytes (even numbers only).

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayStatSlot

This property specifies the duration of a slot in the static segment in macroticks (MT).

This property corresponds to the global cluster parameter gdStaticSlot in the FlexRay Protocol Specification.

Each static slot is used to transmit one (static) frame on the bus.

The static slot duration takes into account the XNET Cluster FlexRay:Payload Length Static and FlexRay:Action Point Offset properties, as well as maximum propagation delay.

In the FlexRay cycle static segment, all frames must have the same payload length; therefore, the duration of a static frame is the same.

The total static segment length is determined by multiplying this property by the FlexRay:Number Of Static Slots property. The total static segment length must be shorter than the FlexRay:Macro Per Cycle property.

The range for this property is 4–661 MT.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read Only	N/A	Calculated from Other Cluster Properties

XNET Cluster

nxPropClst_FlexRaySymWinStart

This property specifies the macrotick offset at which the symbol window begins from the start of the cycle. During the symbol window, a channel sends a single Media Test Access Symbol (MTS).

The range for this property is 8–15998 MT.

This property is calculated from other cluster properties. It is based on the total static and dynamic segment size. It is set to zero if the Symbol Window property is 0 (no symbol window exists).

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRaySymWin

This property specifies the symbol window duration, expressed in macroticks (MT).

This property corresponds to the global cluster parameter gdSymbolWindow in the FlexRay Protocol Specification.

The symbol window is a slot after the static and dynamic segment, and is used to transmit Collision Avoidance symbols (CAS) and/or Media Access Test symbols (MTS). The symbol window is optional for a given cluster (the Symbol Window property can be zero). A symbol transmission starts at the action point offset within the symbol window.

The range for this property is 0–142 MT.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRaySyncNodeMax

This property specifies the maximum number of nodes that may send frames with the sync frame indicator bit set to one.

This property corresponds to the global cluster parameter gSyncNodeMax in the FlexRay Protocol Specification.

Sync frames define the zero points for the clock drift measurement. Startup frames are special sync frames transmitted first after a network startup. There must be at least two startup nodes in a network.

The range for this property is 2–15.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayTSSTx

This property specifies the number of bits in the Transmission Start Sequence (TSS). A frame transmission may be truncated at the beginning. The amount of truncation depends on the nodes involved and the channel topology layout. For example, the purpose of the TSS is to "open the gates" of an active star (that is, to cause the star to properly set up input and output connections). During this setup, an active star truncates a number of bits at the beginning of a communication element. The TSS prevents the frame or symbol content from being truncated. You must set this property to be greater than the expected worst case truncation of a frame.

This property corresponds to the global cluster parameter gdTSSTransmitter in the FlexRay Protocol Specification.

The range for this property is 3–15 bit.

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

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

XNET Cluster

nxPropClst_FlexRayUseWakeup

This property indicates whether the FlexRay cluster supports wakeup. This value is set to True if the WAKE-UP tree is present in the FIBEX file. This values is set to False if the WAKE-UP tree is not present in the FIBEX file.

When this property is True, the FlexRay cluster uses wakeup functionality; otherwise, the FlexRay cluster does not use wakeup functionality.

When creating a new database, the default value of this property is false. However, if you set any wakeup parameter (for example, FlexRay:Wakeup Symbol Rx Idle), this property automatically is set to True, and the WAKE-UP tree is saved in the FIBEX file when saved.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayWakeSymRxIdl

This property specifies the number of bits the node uses to test the idle portion duration of a received wakeup symbol. Collisions, clock differences, and other effects can deform the transmitted wakeup pattern.

This property corresponds to the global cluster parameter gdWakeupSymbolRxIdle in the FlexRay Protocol Specification.

The range for this property is 14–59 gdBit (bit duration).

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayWakeSymRxLow

This property specifies the number of bits the node uses to test the low portion duration of a received wakeup symbol. This lower limit of zero bits must be received for the receiver to detect the low portion. Active starts, clock differences, and other effects can deform the transmitted wakeup pattern.

This property corresponds to the global cluster parameter gdWakeupSymbolRxLow in the FlexRay Protocol Specification.

The range for this property is 10–55 gdBit (bit duration).

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayWakeSymRxWin

This property specifies the size of the window used to detect wakeups. Detection of a wakeup requires a low and idle period from one WUS (wakeup symbol) and a low period from another WUS, to be detected entirely within a window of this size. Clock differences and other effects can deform the transmitted wakeup pattern.

This property corresponds to the global cluster parameter gdWakeupSymbolRxWindow in the FlexRay Protocol Specification.

The range for this property is 76–301 gdBit (bit duration).

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayWakeSymTxIdl

This property specifies the number of bits the node uses to transmit the wakeup symbol idle portion.

This property corresponds to the global cluster parameter gdWakeupSymbolTxIdle in the FlexRay Protocol Specification.

The range for this property is 45–180 gdBit (bit duration).

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

Data Type	Direction	Required?	Default
u32	Read/Write	Yes	Read from Database

XNET Cluster

nxPropClst_FlexRayWakeSymTxLow

This property specifies the number of bits the node uses to transmit the wakeup symbol low phase.

This property corresponds to the global cluster parameter gdWakeupSymbolTxLow in the FlexRay Protocol Specification.

The range for this property is 15–60 gdBit (bit duration).

This property is required. If the property does not contain a valid value, and you create an XNET session that uses this cluster, the session returns an error. To ensure that the property contains a valid value, you can do one of the following:

• Use a database file (or alias) to create the session.

  The file formats require a valid value in the text for this property.

• Set a value using the nxdbSetProperty function.

  This is needed when you create your own in-memory database (:memory:) rather than use a file. The property does not contain a default in this case, so you must set a valid value prior to creating a session.

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

XNET Cluster

nxPropClst_BaudRate64

The Baud Rate property sets the baud rate all cluster nodes use. This baud rate represents the rate from the database, so it is read-only from the session. Use a session interface property (for example, XNET Session Interface:64bit Baud Rate) to override the database baud rate with an application-specific baud rate.

For CAN, this rate can be 33333, 40000, 50000, 62500, 80000, 83333, 100000, 125000, 160000, 200000, 250000, 400000, 500000, 800000, or 1000000. Some transceivers may support only a subset of these values.

If you need values other than these, use the custom settings as described in the XNET Session Interface:64bit Baud Rate property.

For FlexRay, this rate can be 2500000, 5000000, or 10000000.

For LIN, this rate can be 2400–20000 inclusive.

If you need values other than these, use the custom settings as described in the XNET Session Interface:64bit Baud Rate property.

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

XNET Cluster

nxPropClst_CanFdBaudRate64

The 64bit FD Baud Rate property sets the fast data baud rate for the CAN FD+BRS CAN:I/O Mode property. This property represents the database fast data baud rate for the CAN FD+BRS I/O Mode. Refer to the CAN:I/O Mode property for a description of this mode. Use a session interface property (for example, Interface:CAN:64bit FD Baud Rate) to override the database fast baud rate with an application-specific fast baud rate.

NI-XNET CAN hardware currently accepts the following numeric baud rates: 200000, 250000, 400000, 500000, 800000, 1000000, 1250000, 1600000, 2000000, 2500000, 4000000, 5000000, and 8000000. Some transceivers may support only a subset of these values.

If you need values other than these, use the custom settings as described in the Interface:CAN:64bit FD Baud Rate property.

Data Type	Direction	Required?	Default
u32	Read Only	No	ISO

XNET Cluster

nxPropClst_CanFdIsoMode

This property specifies whether the CAN FD cluster is working in ISO CAN FD mode, Non-ISO CAN FD mode, or Legacy ISO mode. The default is ISO CAN FD mode. You define the value in a dialog box that appears when you define an alias for the database.

Data Type	Direction	Required?	Default
u32	Read/Write	No	Cluster I/O Mode

XNET Frame

nxPropFrm_CANioMode

This property specifies the frame's I/O mode.

• nxCANioMode_CAN (0)
• nxCANioMode_CAN_FD (1)
• nxCANioMode_CAN_FD_BRS (2)

This property is used in ISO CAN FD+BRS mode only. In this mode, you can specify every frame to be transmitted in CAN 2.0, CAN FD, or CAN FD+BRS mode. CAN FD+BRS frames require the interface to be in CAN FD+BRS mode; otherwise, it is transmitted in CAN FD mode.

When the interface is in Non-ISO CAN FD or Legacy ISO CAN FD mode, this property is disregarded. In Non-ISO CAN FD and Legacy ISO CAN FD mode, you must use the Interface:CAN:Transmit I/O Mode property to switch the transmit mode.

When the assigned database does not define the property in ISO CAN FD mode, the frames are transmitted with the Interface:CAN:I/O Mode property.

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

XNET Signal

nxPropSig_Comment

Comment describing the signal object.

A comment is a string containing up to 65535 characters.

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

XNET Signal

nxPropSig_ConfigStatus

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).

ECUs appear in the NI-XNET Database Editor only as transmitters and receivers of frames within clusters. They are not separate entities. That is, the same ECU might appear in different database clusters, but in the exported FIBEX file, they appear as different ECU entities.

In the LabVIEW Project Provider, you can sort frames by ECUs.

Each cluster can contain an arbitrary number of frames. A frame is a single message that is exchanged on the cluster. In NI-CAN, this is equivalent to an NI-CAN message.

The basic properties of a frame are its identifier (Arbitration ID for CAN, Slot ID for FlexRay) and the payload length, which can be any value between 0 and 8 for CAN and any even value between 0 and 254 for FlexRay.

In addition, several protocol-specific properties exist. You can use the NI-XNET Database Editor to edit these properties in a protocol type-specific way.

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

XNET Subframe

nxPropSubfrm_Name

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.

A Protocol Data Unit (PDU) is a data unit defined in a cluster and exchanged within a frame. Like a frame, a PDU contains an arbitrary number of signals. You can map one or more PDUs to a frame by defining a start bit and update bit in the frame properties window. You can map one PDU to multiple frames.

For CAN and LIN, NI-XNET supports only a one-to-one relationship between frames and PDUs, and does not support an update bit for PDUs. Signals returned from the frame are the same as signals returned from the mapped PDU. In this case, you can deactivate the Use PDUs editor option to hide PDUs in the editor. If the file contains frames with advanced PDU configuration (using a one-to-n or n-to-one relationship or update bits), you cannot deactivate Use PDUs in the editor.

FIBEX files prior to version 3.0, .DBC files, and .NCD files cannot contain an advanced PDU configuration.

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

XNET Cluster

nxPropClst_PDUsReqd

Determines whether using PDUs in the database API is required for this cluster.

If this property returns false, it is safe to use signals as child objects of a frame without PDUs. This behavior is compatible with NI-XNET 1.1 or earlier. Clusters from .dbc, .ncd, or FIBEX 2 files always return false for this property, so using PDUs from those files is not required.

If this property returns true, the cluster contains PDU configuration, which requires reading the PDUs as frame child objects and then signals as PDU child objects, as shown in the following figure.

Internally, the database always uses PDUs, but shows the same signal objects also as children of a frame.

The following conditions must be fulfilled for all frames in the cluster to return false from the PDUs Required? property:

• Only one PDU is mapped to the frame.
• This PDU is not mapped to other frames.
• The PDU Start Bit in the frame is 0.
• The PDU Update Bit is not used.

If the conditions are not fulfilled for a given frame, signals from the frame are still returned, but reading the property returns a warning.

The NI-XNET session supports frames requiring PDUs only for FlexRay. For frames requiring PDUs on a CAN or LIN cluster, the XNET Frame Configuration Status property and nxCreateSession return an error.

Each frame contains an arbitrary number of signals, which are the basic data exchange units on the network. These signals are equivalent to NI-CAN channels.

Some of the signal properties are:

• Start bit: the signal start position within the frame
• Number of bits: the signal length within the frame
• Data type: the data type (signed, unsigned, or float)
• Byte order: little or big endian
• Scaling factor and offset: for converting physical data to binary representation

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

XNET Cluster

nxPropClst_LINSchedules

An array of LIN schedules defined in this cluster. You assign a LIN schedule to a cluster when you create the LIN schedule object. You cannot change this assignment afterwards. The schedules in this array are sorted alphabetically by schedule name.

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

XNET Cluster

nxPropClst_LINTick

Relative time between LIN ticks (relative f64 in seconds). The LIN Schedule Entry Delay property must be a multiple of this tick.

This tick is referred to as the "timebase" in the LIN specification.

The XNET ECU LIN Master property defines the Tick property in this cluster. You cannot use the Tick property when there is no LIN Master property defined in this cluster.