flex_get_motion_board_info |
Get Motion Board Information
Usage
status = flex_get_motion_board_info(u8 boardID, u32 informationType, u32* informationValue);
Purpose
Gets information about the properties and features of the motion controller.
 |
Tip Refer to the Remarks section for information about how the behavior of this function differs between controllers. |
Parameters
| Name | Type | Description |
|---|---|---|
| boardID | u8 | assigned by Measurement & Automation Explorer (MAX) |
| informationType | u32 | type of information you want to retrieve |
| informationValue | u32* | retrieved information |
Parameter Discussion
informationType is the selector for the type of controller information you want. Legal values are defined as constants in the NI-Motion header files MotnCnst.h (for C/C++ users) and motncnst.bas (for Visual Basic users) and are listed in the following section.
informationValue is the returned information of the type you selected.
The following table shows possible return values for each of the valid informationType values.
| informationType | informationValue | ||
| NIMC_BOARD_FAMILY (1100) | NIMC_NI_MOTION (0) | ||
| NIMC_BOARD_TYPE (1120) |
|
||
| NIMC_BUS_TYPE (1130) |
NIMC_PCI_BUS (1) NIMC_PXI_BUS (2) NIMC_1394_BUS (3) NIMC_CAN_BUS (4) |
||
| NIMC_NUM_AXES (1510) | Number of axes on the controller | ||
| NIMC_FIRMWARE_VERSION (3020) | Version-build code (MMmmbbbb)
|
||
| NIMC_DSP_VERSION (3030) | Version-build code (MMmmbbbb) | ||
| NIMC_FPGA_VERSION (3040) | Version-build code (MMmmbbbb) | ||
| NIMC_FPGA2_VERSION (3050) | Version-build code (MMmmbbbb) | ||
| NIMC_CONTROLLER_SERIAL_NUMBER (2040) | Controller serial number | ||
| NIMC_LOCAL_OR_REMOTE (2050) | NIMC_TRUE (1) (remote) NIMC_FALSE (0) (local) |
||
| NIMC_DRIVER_VERSION (2060) | Version-build code (MMmmbbbb) |
Using This Function
This function returns selected information about NI motion controllers including controller type and family, bus type, number of axes, and so on.
NI-Motion also has four information types for retrieving the version numbers and release dates of the firmware segments loaded in the onboard Flash ROM. All firmware segments are field upgradable using the Update Firmware option in Measurement & Automation Explorer. Versions are returned in a version-build code format:
Version-build code = MMmmbbbb, where
MM = the major version number,
mm = the minor version number, and
bbbb = the build number.
You can use this information to verify that the NI motion controller has the latest firmware downloaded on it.
Remarks
This section includes information about how the behavior of this function differs among the controllers that support it.
NI SoftMotion Controller Considerations
The following list includes considerations you must make when you are using this function with the NI SoftMotion Controller:
- The NI SoftMotion Controller does not support the following informationValue returned values:
- NIMC_FIRMWARE_VERSION
- NIMC_DSP_VERSION
- NIMC_FPGA_VERSION
- NIMC_FPGA2_VERSION