NI XNET XNET Interface Properties - ni/grpc-device GitHub Wiki
- CAN.Termination Capability
- CAN.Transceiver Capability
- Device
- Dongle Compatible Firmware Version
- Dongle Compatible Revision
- Dongle Firmware Version
- Dongle ID
- Dongle Revision
- Dongle State
- Name
- Number
- Port Number
- Protocol
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 Only | No | N/A |
XNET Interface
nxPropIntf_DevRef
From the XNET Interface handle, this property returns the XNET device handle.
The XNET device handle returned is the physical XNET board that contains the XNET interface. This property determines the physical XNET device through the XNET Device Serial Number property for a given XNET Interface handle.
Data Type | Direction | Required? | Default |
---|---|---|---|
string | Read/Write | Yes | Defined in nxdbCreateObject |
XNET LIN Schedule Entry
nxPropLINSchedEntry_Name
String identifying the LIN schedule entry 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 schedule entry name must be unique for all entries in the same schedule.
Data Type | Direction | Required? | Default |
---|---|---|---|
u32 | Read Only | No | N/A |
XNET Interface
nxPropIntf_Num
Returns unique number associated with the XNET interface.
The XNET driver assigns each port connector in the system a unique number XNET driver. This number, plus its protocol name, is the interface name string. For example:
XNET Interface String Name | Number |
---|---|
CAN1 | 1 |
FlexRay3 | 3 |
Data Type | Direction | Required? | Default |
---|---|---|---|
u32 | Read Only | No | N/A |
XNET Interface
nxPropIntf_PortNum
Returns the physical port number printed near the connector on the XNET device.
The port numbers on an XNET board are physically identified with numbering. Use this property, along with the XNET Device Serial Number property, to associate an XNET interface with a physical (XNET board and port) combination.
Note It is easier to find the physical location of an XNET interface with nxBlink.
Data Type | Direction | Required? | Default |
---|---|---|---|
u32 | Read Only | No | N/A |
XNET Interface
nxPropIntf_CANTcvrCap
Returns an enumeration indicating the CAN bus physical transceiver support.
Enumeration | Value |
---|---|
High-Speed/Flexible Data-Rate (HS/FD) | 0 |
Low-Speed/Fault-Tolerant (LS/FT) | 1 |
XS (HS/FD, LS/FT, SW, or External) | 3 |
XS (HS/FD, LS/FT) | 4 |
The XS value in the enumeration indicates the board has multiple physical transceivers that you can configure in software. XS may support High-Speed and Flexible Data-Rate (HS/FD), Low-Speed Fault-Tolerant (LS/FT), Single Wire (SW), or can connect to an external transceiver. This value is switchable through the XNET Session Interface:CAN:Transceiver Type property.
Data Type | Direction | Required? | Default |
---|---|---|---|
u32 | Read Only | No | N/A |
XNET Interface
nxPropIntf_CANTermCap
Returns an enumeration indicating whether the XNET interface can terminate the CAN bus.
Enumeration | Value |
---|---|
No | 0 |
Yes | 1 |
Signal reflections on the CAN bus can cause communication failure. To prevent reflections, termination can be present as external resistance or resistance the XNET board applies internally. This enumeration determines whether the XNET board can add termination to the bus.
To select the CAN transceiver termination, refer to XNET Session Interface:CAN:Termination.
Data Type | Direction | Required? | Default |
---|---|---|---|
u32 | Read Only | No | N/A |
XNET Interface
nxPropIntf_DongleState
Returns an enumeration indicating the connected Transceiver Cable's state.
Description | State | Value |
---|---|---|
No dongle, no external power | nxDongleState_NoDongle_NoExtPower | 1 |
No dongle, has external power | nxDongleState_NoDongle_ExtPower | 2 |
Has dongle, no external power | nxDongleState_Dongle_NoExtPower | 3 |
Ready | nxDongleState_Ready | 4 |
Busy | nxDongleState_Busy | 5 |
Comm error | nxDongleState_CommError | 13 |
Overcurrent | nxDongleState_OverCurrent | 14 |
Some Transceiver Cable types require external power from the network connector for operation. Refer to the hardware-specific manual for more information.
Data Type | Direction | Required? | Default |
---|---|---|---|
u32 | Read Only | No | N/A |
XNET Interface
nxPropIntf_DongleID
Returns an enumeration indicating the connected Transceiver Cable's type.
Type | ID |
---|---|
CAN High Speed (HS) | 2 |
CAN Software-Selectable (XS) | 4 |
LIN | 6 |
Dongle-Less Design | 13 |
Unknown | 14 |
Dongle-Less Design indicates this interface is not a Transceiver Cable but a regular XNET expansion card, cDAQ Module, and so on.
Data Type | Direction | Required? | Default |
---|---|---|---|
u32 | Read Only | No | N/A |
XNET Interface
nxPropIntf_DongleRevision
Returns the connected Transceiver Cable's hardware revision number.
Data Type | Direction | Required? | Default |
---|---|---|---|
u32 | Read Only | No | N/A |
XNET Interface
nxPropIntf_DongleFirmwareVersion
Returns the connected Transceiver Cable's firmware revision number.
Data Type | Direction | Required? | Default |
---|---|---|---|
u32 | Read Only | No | N/A |
XNET Interface
nxPropIntf_DongleCompatibleRevision
Returns a number representing the oldest driver version compatible with the connected Transceiver Cable's hardware revision. The number is relative to the first driver version that supported the particular Transceiver Cable model, starting with 1 for the original revision.
A Transceiver Cable hardware revision might require a later XNET driver than the version that introduced support for this model for operation.
Data Type | Direction | Required? | Default |
---|---|---|---|
u32 | Read Only | No | N/A |
XNET Interface
nxPropIntf_DongleCompatibleFirmwareVersion
Returns a number representing the oldest driver version compatible with the connected Transceiver Cable's firmware. The number is relative to the first driver version that supported the Transceiver Cable, starting with 1 for the original revision.
A Transceiver Cable running an updated firmware version may require a later XNET driver than the version it shipped with for operation.