NexMotion  1.4.0
Open Robots & Machines [WIP]
Axis_Config

Axis Configuration Functions. More...

Collaboration diagram for Axis_Config:

Functions

RTN_ERR FNTYPE NMC_AxisSetParamI32 (I32_T DevID, I32_T AxisIndex, I32_T ParamNum, I32_T SubIndex, I32_T ParaValueI32)
 Set the axis parameters (I_32T data type) More...
 
RTN_ERR FNTYPE NMC_AxisGetParamI32 (I32_T DevID, I32_T AxisIndex, I32_T ParamNum, I32_T SubIndex, I32_T *PRetParaValueI32)
 Get the axis parameters (I_32T data type) More...
 
RTN_ERR FNTYPE NMC_AxisSetParamF64 (I32_T DevID, I32_T AxisIndex, I32_T ParamNum, I32_T SubIndex, F64_T ParaValueF64)
 Set the axis patameters (F64_T data type) More...
 
RTN_ERR FNTYPE NMC_AxisGetParamF64 (I32_T DevID, I32_T AxisIndex, I32_T ParamNum, I32_T SubIndex, F64_T *PRetParaValueF64)
 Get the axis parameters (F64_T data type) More...
 

Detailed Description

Axis Configuration Functions.

Function Documentation

RTN_ERR FNTYPE NMC_AxisGetParamF64 ( I32_T  DevID,
I32_T  AxisIndex,
I32_T  ParamNum,
I32_T  SubIndex,
F64_T PRetParaValueF64 
)

Get the axis parameters (F64_T data type)

Parameters
DevIDDevice ID (DevID)
AxisIndexAxis index
ParamNumParameter number
SubIndexParameter Sub-index
[out]PRetParaValueF64[Output] Value to be returned (double precision float)
Returns
Return an error code.
If the function is called successfully, the return value is ERR_NEXMOTION_SUCCESS (0). Otherwise, the return value is an error code. All error codes are defined in the header file, NexMotionError.h.

Usage:
Please refer to the section: Axis Parameters. The device will load the configurations in according with the configuration file during starting. The function can be used to get some axis parameters. A suitable function shall be selected depended on the data type of the parameters (F64_T).

Examples:

Reference:
Please refer to the section: Axis Parameters.

RTN_ERR FNTYPE NMC_AxisGetParamI32 ( I32_T  DevID,
I32_T  AxisIndex,
I32_T  ParamNum,
I32_T  SubIndex,
I32_T PRetParaValueI32 
)

Get the axis parameters (I_32T data type)

Parameters
DevIDDevice ID (DevID)
AxisIndexAxis index
ParamNumParameter number
SubIndexParameter Sub-index
[out]PRetParaValueI32[Output] Value to be returned (signed integer)
Returns
Return an error code.
If the function is called successfully, the return value is ERR_NEXMOTION_SUCCESS (0). Otherwise, the return value is an error code. All error codes are defined in the header file, NexMotionError.h.

Usage:
Please refer to the section: Axis Parameters. The device will load the configurations in according with the configuration file during starting. The function can be used to get some axis parameters. A suitable function shall be selected depended on the data type of the parameters (I32_T).

Examples:

Reference:
Please refer to the section: Axis Parameters.

RTN_ERR FNTYPE NMC_AxisSetParamF64 ( I32_T  DevID,
I32_T  AxisIndex,
I32_T  ParamNum,
I32_T  SubIndex,
F64_T  ParaValueF64 
)

Set the axis patameters (F64_T data type)

Parameters
DevIDDevice ID (DevID)
AxisIndexAxis index
ParamNumParameter number
SubIndexParameter Sub-index
[in]ParaValueF64[Input] Value to be set (double precision float)
Returns
Return an error code.
If the function is called successfully, the return value is ERR_NEXMOTION_SUCCESS (0). Otherwise, the return value is an error code. All error codes are defined in the header file, NexMotionError.h.

Usage:
Please refer to the section: Axis Parameters. The device will load the configurations in according with the configuration file during starting. The function can be used to set some axis parameters. A suitable function shall be selected depended on the data type of the parameters (F64_T).

Examples:

Reference:
Please refer to the section: Axis Parameters.

RTN_ERR FNTYPE NMC_AxisSetParamI32 ( I32_T  DevID,
I32_T  AxisIndex,
I32_T  ParamNum,
I32_T  SubIndex,
I32_T  ParaValueI32 
)

Set the axis parameters (I_32T data type)

Parameters
DevIDDevice ID (DevID)
AxisIndexAxis index
ParamNumParameter number
SubIndexParameter Sub-index
[in]ParaValueI32[Input] Value to be set (siged integer)
Returns
Return an error code.
If the function is called successfully, the return value is ERR_NEXMOTION_SUCCESS (0). Otherwise, the return value is an error code. All error codes are defined in the header file, NexMotionError.h.

Usage:
Please refer to the section: Axis Parameters. The device will load the configurations in according with the configuration file during starting. The function can be used to set some axis parameters. A suitable function shall be selected depended on the data type of the parameters (I32_T).

Examples:

Reference:
Please refer to the section: Axis Parameters.