flex_load_axis_configuration_parameter

NI-Motion Functions

flex_load_axis_configuration_parameter

Device Compatibility

Device Compatibility
7330
N
7340
N
7344
N
7350
N
7390
N
NI SoftMotion Controller for CANopen—Xenus
Y
NI SoftMotion Controller for CANopen—Accelnet
Y

Load Axis Configuration Parameter

Usage

status = flex_load_axis_configuration_parameter(i32 boardID, i32 axis, TnimcAxisConfigurationParameter attribute, NIMC_DATA* value);

Purpose

Loads data on a per axis basis for an axis configuration object on 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 i32 assigned by Measurement & Automation Explorer (MAX)
axis i32 axis to configure
attribute TnimcAxisConfigurationParameter attribute to set
value NIMC_DATA the value for the attribute you are loading

Parameter Discussion

axis is the axis to configure with this function. Valid values are NIMC_AXIS1 through NIMC_AXIS30. On motion controllers that support fewer than thirty axes, configuring non-existent axes returns error –70006 (NIMC_badResourceIDOrAxisError). Refer to Axes for axis resource IDs.

attribute is the attribute to load. The following are valid attributes:

  • TnimcAxisConfigurationParameterEnable—Set boolData in the NIMC_DATA structure to NIMC_TRUE to enable the axis, and NIMC_FALSE to disable the axis.

value is the value for the attribute you are loading in the following structure:

struct{
   i32 longData;
   u8 boolData;
   f64 doubleData;
} NIMC_DATA;

Based on the attribute the correct member of NIMC_DATA needs to be set.

Using This Function

Use this function to load the data on a per axis basis for the Axis Configuration object on the motion controller.

Remarks

This section includes information about how the behavior of this function differs among the controllers that support it.

NI 73xx Controller Considerations

The following list includes considerations you must make when you are using this function with a 73xx controller:

  • Because the number of axes enabled depends on the control loop rate, use the Enable Axis function to enable/disable an axis for 73xx controllers.