NexMotion  1.4.0
Open Robots & Machines [WIP]
System_Config

System Configuration Functions. More...

Collaboration diagram for System_Config:

Functions

RTN_ERR FNTYPE NMC_DeviceSetParam (I32_T DevID, I32_T ParamNum, I32_T SubIndex, I32_T ParaValue)
 Set device parameters. More...
 
RTN_ERR FNTYPE NMC_DeviceGetParam (I32_T DevID, I32_T ParamNum, I32_T SubIndex, I32_T *PRetParaValue)
 Get device parameters. More...
 
RTN_ERR FNTYPE NMC_SetIniPath (_opt_null_ const char *PIniPath)
 Set the path of the ini file. More...
 

Detailed Description

System Configuration Functions.

Function Documentation

RTN_ERR FNTYPE NMC_DeviceGetParam ( I32_T  DevID,
I32_T  ParamNum,
I32_T  SubIndex,
I32_T PRetParaValue 
)

Get device parameters.

Parameters
DevIDDevice ID (DevID)
ParamNumParameter Number
SubIndexParameter Sub-index
[out]PRetParaValue[Output] The value to be returned after the function is called successfully.
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, System Parameters.

Reference:
Please refer to the section, System Parameters.

RTN_ERR FNTYPE NMC_DeviceSetParam ( I32_T  DevID,
I32_T  ParamNum,
I32_T  SubIndex,
I32_T  ParaValue 
)

Set device parameters.

Parameters
DevIDDevice ID (DevID)
ParamNumParameter Number
SubIndexParameter Sub-index
ParaValueValue to be set
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, System Parameters.

Reference:
Please refer to the section, System Parameters.

RTN_ERR FNTYPE NMC_SetIniPath ( _opt_null_ const char *  PIniPath)

Set the path of the ini file.

Parameters
PIniPathThe ini file to be set. it shall be a C string, and can be set to NULL(0) to reset the path to the default value.
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:
During the starting, the system will load the configurations in accordance with the file, NexMotionLibConfig.ini. Also, the function can be called to specify the ini file path. The default path is C:\NEXCOM\.

Reference:
NMC_DeviceOpenUp() and NMC_DeviceOpenUpRequest()