NexMotion  1.4.0
Open Robots & Machines [WIP]
Group_Speed_Config

Group Speed Ratio Configuration Functions. More...

Collaboration diagram for Group_Speed_Config:

Functions

RTN_ERR FNTYPE NMC_GroupSetSpeedRatio (I32_T DevID, I32_T GroupIndex, F64_T Percentage)
 Set the speed percentage of a group from 0.0 to 100.0%. More...
 
RTN_ERR FNTYPE NMC_GroupGetSpeedRatio (I32_T DevID, I32_T GroupIndex, F64_T *PRetPercentage)
 Get the speed percentage of a group from 0.0 to 100.0%. More...
 

Detailed Description

Group Speed Ratio Configuration Functions.

Function Documentation

RTN_ERR FNTYPE NMC_GroupGetSpeedRatio ( I32_T  DevID,
I32_T  GroupIndex,
F64_T PRetPercentage 
)

Get the speed percentage of a group from 0.0 to 100.0%.

Parameters
DevIDDecice ID (DevID)
GroupIndexGroup Inex
[out]PRetPercentage[Input] A pointer variable, [Output] Velocity percentage.
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:

Examples:

I32_T devID = 0;
I32_T groupIndex = 0;
F64_T percentage = 0.0;
RTN_ERR ret = 0;
ret = NMC_GroupGetSpeedRatio( devID, groupIndex, &percentag e );
if( ret != 0 ) return ret;

Reference:

RTN_ERR FNTYPE NMC_GroupSetSpeedRatio ( I32_T  DevID,
I32_T  GroupIndex,
F64_T  Percentage 
)

Set the speed percentage of a group from 0.0 to 100.0%.

Parameters
DevIDDecice ID (DevID)
GroupIndexGroup Inex
PercentageSpeed percentage to be set (0 to 100 %)
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:

Examples:

I32_T devID = 0;
I32_T groupIndex = 0;
F64_T percentage = 100.0;
RTN_ERR ret = 0;
ret = NMC_GroupSetSpeedRatio( devID, groupIndex, percentag e );
if( ret != 0 ) return ret;

Reference: