Group_Config

Group Configuration Functions. More...

Collaboration diagram for Group_Config:

Functions
RTN_ERR FNTYPE	NMC_GroupSetParamI32 (I32_T DevID, I32_T GroupIndex, I32_T ParamNum, I32_T SubIndex, I32_T ParaValueI32)
	Set the Group Parameters (I32_T, data type). More...
RTN_ERR FNTYPE	NMC_GroupGetParamI32 (I32_T DevID, I32_T GroupIndex, I32_T ParamNum, I32_T SubIndex, I32_T *PRetParaValueI32)
	Get the Group Parameters (I32_T, data type). More...
RTN_ERR FNTYPE	NMC_GroupSetParamF64 (I32_T DevID, I32_T GroupIndex, I32_T ParamNum, I32_T SubIndex, F64_T ParaValueF64)
	Set the group parameters (F64_T, data type). More...
RTN_ERR FNTYPE	NMC_GroupGetParamF64 (I32_T DevID, I32_T GroupIndex, I32_T ParamNum, I32_T SubIndex, F64_T *PRetParaValueF64)
	Get the group parameters (F64_T, data type). More...
RTN_ERR FNTYPE	NMC_GroupAxSetParamI32 (I32_T DevID, I32_T GroupIndex, I32_T GroupAxisIndex, I32_T ParamNum, I32_T SubIndex, I32_T ParaValueI32)
	Set the parameters of group axis (I32_T, data type) More...
RTN_ERR FNTYPE	NMC_GroupAxGetParamI32 (I32_T DevID, I32_T GroupIndex, I32_T GroupAxisIndex, I32_T ParamNum, I32_T SubIndex, I32_T *PRetParaValueI32)
	Get the parameters of group axis (I32_T, data type). More...
RTN_ERR FNTYPE	NMC_GroupAxSetParamF64 (I32_T DevID, I32_T GroupIndex, I32_T GroupAxisIndex, I32_T ParamNum, I32_T SubIndex, F64_T ParaValueF64)
	Set the parameters of group axis (F64_T, data type) More...
RTN_ERR FNTYPE	NMC_GroupAxGetParamF64 (I32_T DevID, I32_T GroupIndex, I32_T GroupAxisIndex, I32_T ParamNum, I32_T SubIndex, F64_T *PRetParaValueF64)
	Get the parameters of group axis (F64_T, data type). More...

Detailed Description

Group Configuration Functions.

Function Documentation

RTN_ERR FNTYPE NMC_GroupAxGetParamF64	(	I32_T	DevID,
		I32_T	GroupIndex,
		I32_T	GroupAxisIndex,
		I32_T	ParamNum,
		I32_T	SubIndex,
		F64_T *	PRetParaValueF64
	)

Get the parameters of group axis (F64_T, data type).

Parameters

	DevID	Device ID (Dev ID)
	GroupIndex	Group index
	GroupAxisIndex	Group axis index
	ParamNum	Parameter number
	SubIndex	Parameter 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.

Examples:

I32_T devID = 0;
I32_T groupIndex = 0;
I32_T groupAxisIndex = 2;
I32_T paramNum = 0x21; // Set the deceleration to stop motion.
I32_T subIndex = 0;
F64_T paraValueF64 = 0; // Value of the deceleration to stop motion.
RTN_ERR ret = 0;
ret = NMC_GroupAxGetParamF64( devID, groupIndex, groupAxisIndex, paramNum, subIndex, &paraValueF64 );
if( ret != 0 ) return ret;

Reference:

RTN_ERR FNTYPE NMC_GroupAxGetParamI32	(	I32_T	DevID,
		I32_T	GroupIndex,
		I32_T	GroupAxisIndex,
		I32_T	ParamNum,
		I32_T	SubIndex,
		I32_T *	PRetParaValueI32
	)

Get the parameters of group axis (I32_T, data type).

Parameters

	DevID	Device ID (Dev ID)
	GroupIndex	Group index
	GroupAxisIndex	Group axis index
	ParamNum	Parameter number
	SubIndex	Parameter 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.

Examples:

I32_T devID = 0;
I32_T groupIndex = 0;
I32_T groupAxisIndex = 2
I32_T paramNum = 0x30; // The get command is an absolute or incremental parameter
I32_T subIndex = 0;
I32_T paraValueI32 = 0;
RTN_ERR ret = 0;
ret = NMC_GroupAxGetParamI32( devID, groupIndex, groupAxisIndex, paramNum, subIndex, &paraValueI32 );
if( ret != 0 ) return ret;

Reference:

RTN_ERR FNTYPE NMC_GroupAxSetParamF64	(	I32_T	DevID,
		I32_T	GroupIndex,
		I32_T	GroupAxisIndex,
		I32_T	ParamNum,
		I32_T	SubIndex,
		F64_T	ParaValueF64
	)

Set the parameters of group axis (F64_T, data type)

Parameters

DevID	Device ID (Dev ID)
GroupIndex	Group Index
GroupAxisIndex	Group Axis Index
ParamNum	Parameter Number
SubIndex	Parameter Sub-Index
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.

Examples:

I32_T devID = 0;
I32_T groupIndex = 0;
I32_T groupAxisIndex = 2;
I32_T paramNum = 0x21; // Set the deceleration to stop motion.
I32_T subIndex = 0;
F64_T paraValueF64 = 80.5; // Value of the deceleration to stop motion.
RTN_ERR ret = 0;
ret = NMC_GroupAxSetParamF64( devID, groupIndex, groupAxisIndex, paramNum, subIndex, paraValueF64 );
if( ret != 0 ) return ret;

Reference:

RTN_ERR FNTYPE NMC_GroupAxSetParamI32	(	I32_T	DevID,
		I32_T	GroupIndex,
		I32_T	GroupAxisIndex,
		I32_T	ParamNum,
		I32_T	SubIndex,
		I32_T	ParaValueI32
	)

Set the parameters of group axis (I32_T, data type)

Parameters

DevID	Device ID (Dev ID)
GroupIndex	Group Index
GroupAxisIndex	Group Axis Index
ParamNum	Parameter Number
SubIndex	Parameter Sub-Index
ParaValueI32	[Input] Value to be set (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.

Examples:

I32_T devID = 0;
I32_T groupIndex = 0;
I32_T groupAxisIndex = 2;
I32_T paramNum = 0x30; // The set command is an absolute or incremental parameter
I32_T subIndex = 0;
I32_T paraValueI32 = 1; // The command is incremental
RTN_ERR ret = 0;
ret = NMC_GroupAxSetParamI32( devID, groupIndex, groupAxisIndex, paramNum, subIndex, paraValueI32 );
if( ret != 0 ) return ret;

Reference:
None.

RTN_ERR FNTYPE NMC_GroupGetParamF64	(	I32_T	DevID,
		I32_T	GroupIndex,
		I32_T	ParamNum,
		I32_T	SubIndex,
		F64_T *	PRetParaValueF64
	)

Get the group parameters (F64_T, data type).

Parameters

	DevID	Device ID (Dev ID)
	GroupIndex	Group Index
	ParamNum	Parameter number
	SubIndex	Parameter 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.

Examples:

I32_T devID = 0;
I32_T groupIndex = 0;
I32_T paramNum = 0x21; // Set the deceleration to stop motion.
I32_T subIndex = 0;
F64_T paraValueF64 = 0;
RTN_ERR ret = 0;
ret = NMC_GroupGetParamF64( devID, groupIndex, paramNum, subIndex, &paraValueF64 );
if( ret != 0 ) return ret;

Reference:
None.

RTN_ERR FNTYPE NMC_GroupGetParamI32	(	I32_T	DevID,
		I32_T	GroupIndex,
		I32_T	ParamNum,
		I32_T	SubIndex,
		I32_T *	PRetParaValueI32
	)

Get the Group Parameters (I32_T, data type).

Parameters

	DevID	Device ID (DevID)
	GroupIndex	Group Index
	ParamNum	Parameter Number
	SubIndex	Parameter sub-index
[out]	PRetParaValueI32	[Input] A pointer variable, [Output] Value of the parameter

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.

Examples:

I32_T devID = 0;
I32_T groupIndex = 0;
I32_T paramNum = 0x30; // The get command is an absolute or incremental parameter
I32_T subIndex = 0;
I32_T paraValueI32 = 0;
RTN_ERR ret = 0;
ret = NMC_GroupGetParamI32( devID, groupIndex, paramNum, subIndex, &paraValueI32 );
if( ret != 0 ) return ret;

Reference:
None.

RTN_ERR FNTYPE NMC_GroupSetParamF64	(	I32_T	DevID,
		I32_T	GroupIndex,
		I32_T	ParamNum,
		I32_T	SubIndex,
		F64_T	ParaValueF64
	)

Set the group parameters (F64_T, data type).

Parameters

DevID	Device ID (Dev ID)
GroupIndex	Group Index
ParamNum	Parameter number
SubIndex	Parameter sub-index
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.

Examples:

I32_T devID = 0;
I32_T groupIndex = 0;
I32_T paramNum = 0x21; // Set the deceleration to stop motion.
I32_T subIndex = 0;
F64_T paraValueF64 = 80.5; // Value of the deceleration to stop motion.
RTN_ERR ret = 0;
ret = NMC_GroupSetParamF64( devID, groupIndex, paramNum, subIndex, paraValueF64 );
if( ret != 0 ) return ret;

Reference:
None.

RTN_ERR FNTYPE NMC_GroupSetParamI32	(	I32_T	DevID,
		I32_T	GroupIndex,
		I32_T	ParamNum,
		I32_T	SubIndex,
		I32_T	ParaValueI32
	)

Set the Group Parameters (I32_T, data type).

Parameters

DevID	Device ID (DevID)
GroupIndex	Group Index
ParamNum	Parameter Number
SubIndex	Parameter sub-index
ParaValueI32	[Input] Value to be set (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.

Examples:

I32_T devID = 0;
I32_T groupIndex = 0;
I32_T paramNum = 0x30; // The set command is an absolute or incremental parameter
I32_T subIndex = 0;
I32_T paraValueI32 = 1; // The command is incremental
RTN_ERR ret = 0;
ret = NMC_GroupSetParamI32( devID, groupIndex, paramNum, subIndex, paraValueI32 );
if( ret != 0 ) return ret;

Reference:
None.