eyou_planet_sdk  1.0
eyou_planet_sdk library
宏定义 | 类型定义 | 枚举 | 函数
eu_planet.h 文件参考

浏览源代码.

宏定义

#define EXTERNFUNC
 
#define PLANET_SUCCESS   (0)
 
#define PLANET_FAILED_ERRORDEVIECTYPE   (1)
 
#define PLANET_FAILED_DEVICEDISABLED   (2)
 
#define PLANET_FAILED_SETFAILED   (3)
 
#define PLANET_FAILED_MAXBYTESLIMIT   (4)
 
#define PLANET_FAILED_NORECEIVE   (5)
 
#define PLANET_FAILED_UNKNOW   (100)
 

类型定义

typedef void(* planet_SendCallFunc) (unsigned id, const unsigned char *data, unsigned size)
 发送数据回调函数 更多...
 
typedef void(* planet_ReceiveCallFunc) (unsigned id, const unsigned char *data, unsigned size)
 接收数据回调函数 更多...
 

枚举

enum  planet_DeviceType { planet_DeviceType_USBCAN2 = 4 , planet_DeviceType_Canable = 11 }
 设备类型 更多...
 
enum  planet_Baudrate { planet_Baudrate_500 = 500 , planet_Baudrate_1000 = 1000 }
 波特率 更多...
 

函数

EXTERNFUNC int planet_setSendCallFunction (planet_SendCallFunc callFunc)
 设置发送数据回调函数，可以通过该函数捕获实际发送的can数据 更多...
 
EXTERNFUNC int planet_setReceiveCallFunction (planet_ReceiveCallFunc callFunc)
 设置接收数据回调函数，可以通过该函数捕获实际接收的can数据 更多...
 
EXTERNFUNC int planet_initDLL (planet_DeviceType devType, unsigned devIndex, unsigned channel, planet_Baudrate baudrate)
 初始化dll，调用其他函数前，必须先调用该函数进行初始化，初始化成功后设备自动打开 更多...
 
EXTERNFUNC int planet_freeDLL (unsigned devIndex)
 关闭设备，释放资源，成功初始化设备后，需要在程序结束时调用该函数 更多...
 
EXTERNFUNC int planet_getHeartbeat (unsigned devIndex, unsigned id, bool *heartbeat, unsigned timeout=100)
 获得电机心跳状态 更多...
 
EXTERNFUNC int planet_getMotorType (unsigned devIndex, unsigned id, unsigned *type, unsigned timeout=100)
 获得电机类型 更多...
 
EXTERNFUNC int planet_getSerialNumber (unsigned devIndex, unsigned id, unsigned *serialNum, unsigned timeout=100)
 获得电机序列号 更多...
 
EXTERNFUNC int planet_getHardwareVersion (unsigned devIndex, unsigned id, unsigned *hdVersion, unsigned timeout=100)
 获得硬件版本号 更多...
 
EXTERNFUNC int planet_getFirmwareVersion (unsigned devIndex, unsigned id, unsigned *fmVersion, unsigned timeout=100)
 获得电机固件版本号 更多...
 
EXTERNFUNC int planet_getCurrent (unsigned devIndex, unsigned id, float *current, unsigned timeout=100)
 获得电机电流值（q值） 更多...
 
EXTERNFUNC int planet_getVelocity (unsigned devIndex, unsigned id, float *velocity, unsigned timeout=100)
 获得电机速度（rpm） 更多...
 
EXTERNFUNC int planet_getPosition (unsigned devIndex, unsigned id, float *position, unsigned timeout=100)
 获得电机位置（°） 更多...
 
EXTERNFUNC int planet_getTargetCurrent (unsigned devIndex, unsigned id, float *current, unsigned timeout=100)
 获得目标电流值（q值） 更多...
 
EXTERNFUNC int planet_setTargetCurrent (unsigned devIndex, unsigned id, float current, unsigned timeout=100)
 设置目标电流值（q值） 更多...
 
EXTERNFUNC int planet_getTargetVelocity (unsigned devIndex, unsigned id, float *velocity, unsigned timeout=100)
 获得电机目标速度（rpm） 更多...
 
EXTERNFUNC int planet_setTargetVelocity (unsigned devIndex, unsigned id, float velocity, unsigned timeout=100)
 设置电机目标速度（rpm） 更多...
 
EXTERNFUNC int planet_getTargetPosition (unsigned devIndex, unsigned id, float *position, unsigned timeout=100)
 获得电机目标位置（°） 更多...
 
EXTERNFUNC int planet_setTargetPosition (unsigned devIndex, unsigned id, float position, unsigned timeout=100)
 设置电机目标位置（°），该函数不适用于同步位置模式，位置模式下设置电机目标位置 参见:quick_setTargetPosition 更多...
 
EXTERNFUNC int planet_quick_setTargetPosition (unsigned devIndex, unsigned id, float position)
 设置电机目标位置（°），该函数用于同步位置模式，实现快写，无需等待控制器返回确认，可以快速连续设置，实现轨迹规划 更多...
 
EXTERNFUNC int planet_getTargetAcceleration (unsigned devIndex, unsigned id, float *acc, unsigned timeout=100)
 获得电机目标加速度（rpm/s） 更多...
 
EXTERNFUNC int planet_setTargetAcceleration (unsigned devIndex, unsigned id, float acc, unsigned timeout=100)
 设置电机目标加速度（rpm/s） 更多...
 
EXTERNFUNC int planet_getTargetDeceleration (unsigned devIndex, unsigned id, float *dec, unsigned timeout=100)
 获得电机目标减速度（rpm/s） 更多...
 
EXTERNFUNC int planet_setTargetDeceleration (unsigned devIndex, unsigned id, float dec, unsigned timeout=100)
 设置电机目标减速度（rpm/s） 更多...
 
EXTERNFUNC int planet_getMode (unsigned devIndex, unsigned id, unsigned *mode, unsigned timeout=100)
 获得电机控制模式 更多...
 
EXTERNFUNC int planet_setMode (unsigned devIndex, unsigned id, unsigned mode, unsigned timeout=100)
 设置电机控制模式 更多...
 
EXTERNFUNC int planet_getEnabled (unsigned devIndex, unsigned id, bool *enable, unsigned timeout=100)
 获得电机使能状态 更多...
 
EXTERNFUNC int planet_setEnabled (unsigned devIndex, unsigned id, bool enable, unsigned timeout=100)
 设置电机使能状态 更多...
 
EXTERNFUNC int planet_getStopRunState (unsigned devIndex, unsigned id, bool *state, unsigned timeout=100)
 
EXTERNFUNC int planet_setStopRunState (unsigned devIndex, unsigned id, bool state, unsigned timeout=100)
 设置电机停止状态 更多...
 
EXTERNFUNC int planet_getAlert (unsigned devIndex, unsigned id, unsigned *alert, unsigned timeout=100)
 获得电机的警告 更多...
 
EXTERNFUNC int planet_getElectronicGearRatio (unsigned devIndex, unsigned id, float *ratio, unsigned timeout=100)
 获得电机的电子齿轮比 更多...
 
EXTERNFUNC int planet_getVoltage (unsigned devIndex, unsigned id, float *voltage, unsigned timeout=100)
 获得电机的电压（V） 更多...
 
EXTERNFUNC int planet_getProtectedVoltage (unsigned devIndex, unsigned id, float *voltage, unsigned timeout=100)
 获得电机的保护电压（V） 更多...
 
EXTERNFUNC int planet_setProtectedVoltage (unsigned devIndex, unsigned id, float voltage, unsigned timeout=100)
 设置电机的保护电压（V） 更多...
 
EXTERNFUNC int planet_getTemperature (unsigned devIndex, unsigned id, float *tem, unsigned timeout=100)
 获得电机的温度（℃） 更多...
 
EXTERNFUNC int planet_getProtectedTemperature (unsigned devIndex, unsigned id, float *protectedTem, unsigned timeout=100)
 获得电机的保护温度（℃） 更多...
 
EXTERNFUNC int planet_setProtectedTemperature (unsigned devIndex, unsigned id, float tem, unsigned timeout=100)
 设置电机保护温度（℃） 更多...
 
EXTERNFUNC int planet_getRecoveryTemperature (unsigned devIndex, unsigned id, float *recoveryTem, unsigned timeout=100)
 获得电机恢复温度（℃） 更多...
 
EXTERNFUNC int planet_setRecoveryTemperature (unsigned devIndex, unsigned id, float tem, unsigned timeout=100)
 设置电机恢复温度（℃） 更多...
 
EXTERNFUNC int planet_getPOfCurrentLoop (unsigned devIndex, unsigned id, unsigned *p, unsigned timeout=100)
 获得电流环p值 更多...
 
EXTERNFUNC int planet_setPOfCurrentLoop (unsigned devIndex, unsigned id, unsigned p, unsigned timeout=100)
 设置电流环p值 更多...
 
EXTERNFUNC int planet_getIOfCurrentLoop (unsigned devIndex, unsigned id, unsigned *i, unsigned timeout=100)
 获得电流环i值 更多...
 
EXTERNFUNC int planet_setIOfCurrentLoop (unsigned devIndex, unsigned id, unsigned i, unsigned timeout=100)
 设置电流环i值 更多...
 
EXTERNFUNC int planet_getPOfVelocityLoop (unsigned devIndex, unsigned id, unsigned *p, unsigned timeout=100)
 获得速度环p值 更多...
 
EXTERNFUNC int planet_setPOfVelocityLoop (unsigned devIndex, unsigned id, unsigned p, unsigned timeout=100)
 设置速度环p值 更多...
 
EXTERNFUNC int planet_getIOfVelocityLoop (unsigned devIndex, unsigned id, unsigned *i, unsigned timeout=100)
 获得速度环i值 更多...
 
EXTERNFUNC int planet_setIOfVelocityLoop (unsigned devIndex, unsigned id, unsigned i, unsigned timeout=100)
 设置速度环i值 更多...
 
EXTERNFUNC int planet_getPOfPositionLoop (unsigned devIndex, unsigned id, unsigned *p, unsigned timeout=100)
 获得位置环p值 更多...
 
EXTERNFUNC int planet_setPOfPositionLoop (unsigned devIndex, unsigned id, unsigned p, unsigned timeout=100)
 设置位置环p值 更多...
 
EXTERNFUNC int planet_getIOfPositionLoop (unsigned devIndex, unsigned id, unsigned *i, unsigned timeout=100)
 获得位置环i值 更多...
 
EXTERNFUNC int planet_setIOfPositionLoop (unsigned devIndex, unsigned id, unsigned i, unsigned timeout=100)
 设置位置环i值 更多...
 
EXTERNFUNC int planet_getIntegralLimit (unsigned devIndex, unsigned id, float *limit, unsigned timeout=100)
 获得力矩环积分限制 更多...
 
EXTERNFUNC int planet_setIntegralLimit (unsigned devIndex, unsigned id, float limit, unsigned timeout=100)
 设置力矩环积分限制 更多...
 
EXTERNFUNC int planet_getMaxCurrent (unsigned devIndex, unsigned id, float *current, unsigned timeout=100)
 获得电机最大电流值（q值） 更多...
 
EXTERNFUNC int planet_setMaxCurrent (unsigned devIndex, unsigned id, float current, unsigned timeout=100)
 设置电机最大电流值（q值） 更多...
 
EXTERNFUNC int planet_getMaxVelocity (unsigned devIndex, unsigned id, float *velocity, unsigned timeout=100)
 获得电机最大速度值（rpm） 更多...
 
EXTERNFUNC int planet_setMaxVelocity (unsigned devIndex, unsigned id, float velocity, unsigned timeout=100)
 设置电机最大速度值（rpm） 更多...
 
EXTERNFUNC int planet_getMaxVelocityOfVelocityLadderCurve (unsigned devIndex, unsigned id, float *velocity, unsigned timeout=100)
 获得速度梯形曲线的最大速度（rpm） 更多...
 
EXTERNFUNC int planet_setMaxVelocityOfVelocityLadderCurve (unsigned devIndex, unsigned id, float velocity, unsigned timeout=100)
 设置速度梯形曲线的最大速度（rpm） 更多...
 
EXTERNFUNC int planet_getMaxAccelerationOfVelocityLadderCurve (unsigned devIndex, unsigned id, float *acc, unsigned timeout=100)
 获得速度梯形曲线的最大加速度（rpm/s） 更多...
 
EXTERNFUNC int planet_setMaxAccelerationOfVelocityLadderCurve (unsigned devIndex, unsigned id, float acc, unsigned timeout=100)
 设置速度梯形曲线的最大加速度（rpm/s） 更多...
 
EXTERNFUNC int planet_getMaxDecelerationOfVelocityLadderCurve (unsigned devIndex, unsigned id, float *dec, unsigned timeout=100)
 获得速度梯形曲线的最大减速度（rpm/s） 更多...
 
EXTERNFUNC int planet_setMaxDecelerationOfVelocityLadderCurve (unsigned devIndex, unsigned id, float dec, unsigned timeout=100)
 设置速度梯形曲线的最大减速度（rpm/s） 更多...
 
EXTERNFUNC int planet_getMaxVelocityOfPositionLadderCurve (unsigned devIndex, unsigned id, float *dec, unsigned timeout=100)
 获得位置梯形曲线的最大速度（rpm） 更多...
 
EXTERNFUNC int planet_setMaxVelocityOfPositionLadderCurve (unsigned devIndex, unsigned id, float velocity, unsigned timeout=100)
 设置位置梯形曲线的最大速度（rpm） 更多...
 
EXTERNFUNC int planet_getMaxAccelerationOfPositionLadderCurve (unsigned devIndex, unsigned id, float *acc, unsigned timeout=100)
 获得位置梯形曲线的最大加速度（rpm/s） 更多...
 
EXTERNFUNC int planet_setMaxAccelerationOfPositionLadderCurve (unsigned devIndex, unsigned id, float acc, unsigned timeout=100)
 设置位置梯形曲线的最大加速度（rpm/s） 更多...
 
EXTERNFUNC int planet_getMaxDecelerationOfPositionLadderCurve (unsigned devIndex, unsigned id, float *dec, unsigned timeout=100)
 获得位置梯形曲线的最大减速度（rpm/s） 更多...
 
EXTERNFUNC int planet_setMaxDecelerationOfPositionLadderCurve (unsigned devIndex, unsigned id, float dec, unsigned timeout=100)
 设置位置梯形曲线的最大减速度（rpm/s） 更多...
 
EXTERNFUNC int planet_getLimitState (unsigned devIndex, unsigned id, bool *state, unsigned timeout=100)
 获得电机限位状态 更多...
 
EXTERNFUNC int planet_setLimitState (unsigned devIndex, unsigned id, bool state, unsigned timeout=100)
 设置电机的限位状态 更多...
 
EXTERNFUNC int planet_getMaxPosition (unsigned devIndex, unsigned id, float *position, unsigned timeout=100)
 获得电机最大位置（°） 更多...
 
EXTERNFUNC int planet_setMaxPosition (unsigned devIndex, unsigned id, float position, unsigned timeout=100)
 设置电机最大位置（°） 更多...
 
EXTERNFUNC int planet_getMinPosition (unsigned devIndex, unsigned id, float *position, unsigned timeout=100)
 获得电机最小位置（°） 更多...
 
EXTERNFUNC int planet_setMinPosition (unsigned devIndex, unsigned id, float position, unsigned timeout=100)
 设置电机最小位置（°） 更多...
 
EXTERNFUNC int planet_getOriginPositionOffset (unsigned devIndex, unsigned id, float *offset, unsigned timeout=100)
 获得电机的位置偏置（原始数据，没有进行q24转换） 更多...
 
EXTERNFUNC int planet_getPositionOffset (unsigned devIndex, unsigned id, float *offset, unsigned timeout=100)
 获得电机的位置偏置（°） 更多...
 
EXTERNFUNC int planet_setPositionOffset (unsigned devIndex, unsigned id, float position, unsigned timeout=100)
 设置电机的位置偏置（°） 更多...
 
EXTERNFUNC int planet_getSingleLapPositionRange (unsigned devIndex, unsigned id, int *range, unsigned timeout=100)
 获得上电时刻单圈位置范围值 更多...
 
EXTERNFUNC int planet_setSingleLapPositionRange (unsigned devIndex, unsigned id, int range, unsigned timeout=100)
 设置电机上电时刻的单圈位置范围值 更多...
 
EXTERNFUNC int planet_getAntiCoggingTorqueEnabled (unsigned devIndex, unsigned id, bool *enable, unsigned timeout=100)
 获取抗齿槽转矩补偿状态 更多...
 
EXTERNFUNC int planet_setAntiCoggingTorqueEnabled (unsigned devIndex, unsigned id, bool enable, unsigned timeout=100)
 设置抗齿槽转矩补偿 更多...
 
EXTERNFUNC int planet_getBrakeEnabled (unsigned devIndex, unsigned id, bool *enable, unsigned timeout=100)
 获取抱闸使能状态 更多...
 
EXTERNFUNC int planet_setBrakeEnabled (unsigned devIndex, unsigned id, bool enable, unsigned timeout=100)
 设置抱闸使能状态 更多...
 
EXTERNFUNC int planet_getCanBaudrate (unsigned devIndex, unsigned id, int *baudrate, unsigned timeout=100)
 获得电机的波特率 更多...
 
EXTERNFUNC int planet_setCanBaudrate (unsigned devIndex, unsigned id, int baudrate, unsigned timeout=100)
 设置电机的波特率 更多...
 
EXTERNFUNC int planet_setID (unsigned devIndex, unsigned id, unsigned newId, unsigned timeout=100)
 设置电机的id（范围是1~255） 更多...
 
EXTERNFUNC int planet_saveParas (unsigned devIndex, unsigned id, unsigned timeout=100)
 保存控制器参数，当前修改的控制器参数，重新上电后仍然生效 更多...
 
EXTERNFUNC int planet_getProductInfo (unsigned devIndex, unsigned id, unsigned *info, unsigned timeout=100)
 获取产品信息 更多...
 
EXTERNFUNC int planet_setProductInfo (unsigned devIndex, unsigned id, unsigned info, unsigned timeout=100)
 设置产品信息 更多...
 
EXTERNFUNC int planet_getProtectionSwitch (unsigned devIndex, unsigned id, unsigned *value, unsigned timeout=100)
 读取保护开关状态 更多...
 
EXTERNFUNC int planet_setProtectionSwitch (unsigned devIndex, unsigned id, unsigned value, unsigned timeout=100)
 设置保护开关状态 更多...
 
EXTERNFUNC int planet_getRatedTorque (unsigned devIndex, unsigned id, unsigned *torque, unsigned timeout=100)
 读取额定扭矩 更多...
 
EXTERNFUNC int planet_getDefaultTorqueFactor (unsigned devIndex, unsigned id, unsigned *factor, unsigned timeout=100)
 读取默认扭矩因子 更多...
 
EXTERNFUNC int planet_getTorqueFactor (unsigned devIndex, unsigned id, unsigned *factor, unsigned timeout=100)
 读取扭矩因子 更多...
 
EXTERNFUNC int planet_setTorqueFactor (unsigned devIndex, unsigned id, unsigned factor, unsigned timeout=100)
 设置扭矩因子 更多...
 
EXTERNFUNC int planet_getStallProtectionTime (unsigned devIndex, unsigned id, unsigned *time, unsigned timeout=100)
 读取堵转保护时间 更多...
 
EXTERNFUNC int planet_setStallProtectionTime (unsigned devIndex, unsigned id, unsigned time, unsigned timeout=100)
 设置堵转保护时间 更多...
 
EXTERNFUNC int planet_getFPGAErrorCount (unsigned devIndex, unsigned id, unsigned *count, unsigned timeout=100)
 读取FPGA通讯错误计数 更多...
 
EXTERNFUNC int planet_getSecondEncoderAngle (unsigned devIndex, unsigned id, unsigned *angle, unsigned timeout=100)
 读取第二磁编角度参数 更多...
 
EXTERNFUNC int planet_getSecondaryEncoderOffset (unsigned devIndex, unsigned id, unsigned *offset, unsigned timeout=100)
 读取第二磁编校准偏移 更多...
 
EXTERNFUNC int planet_setSecondaryEncoderOffset (unsigned devIndex, unsigned id, unsigned offset, unsigned timeout=100)
 设置第二磁编校准偏移 更多...
 
EXTERNFUNC int planet_getFirstEncoderAngle (unsigned devIndex, unsigned id, unsigned *offset, unsigned timeout=100)
 读取第一磁编角度参数 更多...
 
EXTERNFUNC int planet_writeData (unsigned devIndex, unsigned id, unsigned char *sendData, int sendLength)
 发送can数据，数据长度不能超过8 更多...
 

宏定义说明

◆ EXTERNFUNC

#define EXTERNFUNC

◆ PLANET_FAILED_DEVICEDISABLED

#define PLANET_FAILED_DEVICEDISABLED   (2)

执行失败，设备不存在

◆ PLANET_FAILED_ERRORDEVIECTYPE

#define PLANET_FAILED_ERRORDEVIECTYPE   (1)

执行失败，不支持的设备类型

◆ PLANET_FAILED_MAXBYTESLIMIT

#define PLANET_FAILED_MAXBYTESLIMIT   (4)

执行失败，发送的字节数超出限制

◆ PLANET_FAILED_NORECEIVE

#define PLANET_FAILED_NORECEIVE   (5)

执行失败，没有接收到回应数据

◆ PLANET_FAILED_SETFAILED

#define PLANET_FAILED_SETFAILED   (3)

执行失败，写入控制器数据失败

◆ PLANET_FAILED_UNKNOW

#define PLANET_FAILED_UNKNOW   (100)

执行失败，未知错误

◆ PLANET_SUCCESS

#define PLANET_SUCCESS   (0)

执行成功

类型定义说明

◆ planet_ReceiveCallFunc

typedef void(* planet_ReceiveCallFunc) (unsigned id, const unsigned char *data, unsigned size)

接收数据回调函数

参数
id电机id
datacan数据
size数据长度

◆ planet_SendCallFunc

typedef void(* planet_SendCallFunc) (unsigned id, const unsigned char *data, unsigned size)

发送数据回调函数

参数
id电机id
datacan数据
size数据长度

枚举类型说明

◆ planet_Baudrate

enum planet_Baudrate

波特率

枚举值
planet_Baudrate_500 

波特率500

planet_Baudrate_1000 

波特率1000

◆ planet_DeviceType

enum planet_DeviceType

设备类型

枚举值
planet_DeviceType_USBCAN2 

创芯USB转CAN设备

planet_DeviceType_Canable 

意优canable设备

函数说明

◆ planet_freeDLL()

EXTERNFUNC int planet_freeDLL ( unsigned  devIndex)

关闭设备，释放资源，成功初始化设备后，需要在程序结束时调用该函数

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getAlert()

EXTERNFUNC int planet_getAlert ( unsigned  devIndex,
unsigned  id,
unsigned *  alert,
unsigned  timeout = 100 
)

获得电机的警告

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
alert存放读取的电机警告
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getAntiCoggingTorqueEnabled()

EXTERNFUNC int planet_getAntiCoggingTorqueEnabled ( unsigned  devIndex,
unsigned  id,
bool *  enable,
unsigned  timeout = 100 
)

获取抗齿槽转矩补偿状态

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
enable存放读取的使能状态
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getBrakeEnabled()

EXTERNFUNC int planet_getBrakeEnabled ( unsigned  devIndex,
unsigned  id,
bool *  enable,
unsigned  timeout = 100 
)

获取抱闸使能状态

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
enable存放读取的使能状态
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getCanBaudrate()

EXTERNFUNC int planet_getCanBaudrate ( unsigned  devIndex,
unsigned  id,
int *  baudrate,
unsigned  timeout = 100 
)

获得电机的波特率

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
baudrate存放读取的电机波特率
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getCurrent()

EXTERNFUNC int planet_getCurrent ( unsigned  devIndex,
unsigned  id,
float *  current,
unsigned  timeout = 100 
)

获得电机电流值（q值）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
current存放读取的电流值（q值）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getDefaultTorqueFactor()

EXTERNFUNC int planet_getDefaultTorqueFactor ( unsigned  devIndex,
unsigned  id,
unsigned *  factor,
unsigned  timeout = 100 
)

读取默认扭矩因子

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
factor存放读取的扭矩因子
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getElectronicGearRatio()

EXTERNFUNC int planet_getElectronicGearRatio ( unsigned  devIndex,
unsigned  id,
float *  ratio,
unsigned  timeout = 100 
)

获得电机的电子齿轮比

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
ratio存放读取的电机电子齿轮比
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getEnabled()

EXTERNFUNC int planet_getEnabled ( unsigned  devIndex,
unsigned  id,
bool *  enable,
unsigned  timeout = 100 
)

获得电机使能状态

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
enable存放读取的电机使能状态
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getFirmwareVersion()

EXTERNFUNC int planet_getFirmwareVersion ( unsigned  devIndex,
unsigned  id,
unsigned *  fmVersion,
unsigned  timeout = 100 
)

获得电机固件版本号

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
fmVersion存放读取的固件版本号
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getFirstEncoderAngle()

EXTERNFUNC int planet_getFirstEncoderAngle ( unsigned  devIndex,
unsigned  id,
unsigned *  offset,
unsigned  timeout = 100 
)

读取第一磁编角度参数

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
offset存放读取的参数值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getFPGAErrorCount()

EXTERNFUNC int planet_getFPGAErrorCount ( unsigned  devIndex,
unsigned  id,
unsigned *  count,
unsigned  timeout = 100 
)

读取FPGA通讯错误计数

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
count存放读取的错误计数值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getHardwareVersion()

EXTERNFUNC int planet_getHardwareVersion ( unsigned  devIndex,
unsigned  id,
unsigned *  hdVersion,
unsigned  timeout = 100 
)

获得硬件版本号

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
hdVersion存放读取的硬件版本号
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getHeartbeat()

EXTERNFUNC int planet_getHeartbeat ( unsigned  devIndex,
unsigned  id,
bool *  heartbeat,
unsigned  timeout = 100 
)

获得电机心跳状态

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
heartbeat存放读取的心跳状态
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getIntegralLimit()

EXTERNFUNC int planet_getIntegralLimit ( unsigned  devIndex,
unsigned  id,
float *  limit,
unsigned  timeout = 100 
)

获得力矩环积分限制

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
limit存放读取的积分限制
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getIOfCurrentLoop()

EXTERNFUNC int planet_getIOfCurrentLoop ( unsigned  devIndex,
unsigned  id,
unsigned *  i,
unsigned  timeout = 100 
)

获得电流环i值

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
i存放读取的电流环i值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getIOfPositionLoop()

EXTERNFUNC int planet_getIOfPositionLoop ( unsigned  devIndex,
unsigned  id,
unsigned *  i,
unsigned  timeout = 100 
)

获得位置环i值

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
i存放读取的位置环i值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getIOfVelocityLoop()

EXTERNFUNC int planet_getIOfVelocityLoop ( unsigned  devIndex,
unsigned  id,
unsigned *  i,
unsigned  timeout = 100 
)

获得速度环i值

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
i存放读取的速度环i值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getLimitState()

EXTERNFUNC int planet_getLimitState ( unsigned  devIndex,
unsigned  id,
bool *  state,
unsigned  timeout = 100 
)

获得电机限位状态

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
state存放读取的限位状态
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getMaxAccelerationOfPositionLadderCurve()

EXTERNFUNC int planet_getMaxAccelerationOfPositionLadderCurve ( unsigned  devIndex,
unsigned  id,
float *  acc,
unsigned  timeout = 100 
)

获得位置梯形曲线的最大加速度（rpm/s）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
acc存放读取的位置梯形曲线的最大加速度（rpm/s）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getMaxAccelerationOfVelocityLadderCurve()

EXTERNFUNC int planet_getMaxAccelerationOfVelocityLadderCurve ( unsigned  devIndex,
unsigned  id,
float *  acc,
unsigned  timeout = 100 
)

获得速度梯形曲线的最大加速度（rpm/s）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
acc存放读取的速度梯形曲线的最大加速度（rpm/s）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getMaxCurrent()

EXTERNFUNC int planet_getMaxCurrent ( unsigned  devIndex,
unsigned  id,
float *  current,
unsigned  timeout = 100 
)

获得电机最大电流值（q值）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
current存放读取的电机最大电流值（q值）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getMaxDecelerationOfPositionLadderCurve()

EXTERNFUNC int planet_getMaxDecelerationOfPositionLadderCurve ( unsigned  devIndex,
unsigned  id,
float *  dec,
unsigned  timeout = 100 
)

获得位置梯形曲线的最大减速度（rpm/s）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
dec存放读取的位置梯形曲线最大减速度（rpm/s）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getMaxDecelerationOfVelocityLadderCurve()

EXTERNFUNC int planet_getMaxDecelerationOfVelocityLadderCurve ( unsigned  devIndex,
unsigned  id,
float *  dec,
unsigned  timeout = 100 
)

获得速度梯形曲线的最大减速度（rpm/s）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
dec存放读取的速度梯形曲线的最大减速度（rpm/s）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getMaxPosition()

EXTERNFUNC int planet_getMaxPosition ( unsigned  devIndex,
unsigned  id,
float *  position,
unsigned  timeout = 100 
)

获得电机最大位置（°）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
position存放读取的电机最大位置（°）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getMaxVelocity()

EXTERNFUNC int planet_getMaxVelocity ( unsigned  devIndex,
unsigned  id,
float *  velocity,
unsigned  timeout = 100 
)

获得电机最大速度值（rpm）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
velocity存放读取的电机最大速度值（rpm）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getMaxVelocityOfPositionLadderCurve()

EXTERNFUNC int planet_getMaxVelocityOfPositionLadderCurve ( unsigned  devIndex,
unsigned  id,
float *  dec,
unsigned  timeout = 100 
)

获得位置梯形曲线的最大速度（rpm）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
dec存放读取的位置梯形曲线最大速度（rpm）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getMaxVelocityOfVelocityLadderCurve()

EXTERNFUNC int planet_getMaxVelocityOfVelocityLadderCurve ( unsigned  devIndex,
unsigned  id,
float *  velocity,
unsigned  timeout = 100 
)

获得速度梯形曲线的最大速度（rpm）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
velocity存放读取的速度梯形曲线最大速度（rpm）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getMinPosition()

EXTERNFUNC int planet_getMinPosition ( unsigned  devIndex,
unsigned  id,
float *  position,
unsigned  timeout = 100 
)

获得电机最小位置（°）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
position存放读取的电机最小位置（°）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getMode()

EXTERNFUNC int planet_getMode ( unsigned  devIndex,
unsigned  id,
unsigned *  mode,
unsigned  timeout = 100 
)

获得电机控制模式

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
mode存放读取的电机控制模式,模式如下: 1: 轮廓位置控制模式 3: 速度模式 4: 电流模式 5: 同步位置模式
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getMotorType()

EXTERNFUNC int planet_getMotorType ( unsigned  devIndex,
unsigned  id,
unsigned *  type,
unsigned  timeout = 100 
)

获得电机类型

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
type存放读取的电机类型
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getOriginPositionOffset()

EXTERNFUNC int planet_getOriginPositionOffset ( unsigned  devIndex,
unsigned  id,
float *  offset,
unsigned  timeout = 100 
)

获得电机的位置偏置（原始数据，没有进行q24转换）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
offset存放读取的电机的位置偏置（原始数据，没有进行q24转换
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getPOfCurrentLoop()

EXTERNFUNC int planet_getPOfCurrentLoop ( unsigned  devIndex,
unsigned  id,
unsigned *  p,
unsigned  timeout = 100 
)

获得电流环p值

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
p存放读取的电流环p值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getPOfPositionLoop()

EXTERNFUNC int planet_getPOfPositionLoop ( unsigned  devIndex,
unsigned  id,
unsigned *  p,
unsigned  timeout = 100 
)

获得位置环p值

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
p存放读取的位置环p值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getPOfVelocityLoop()

EXTERNFUNC int planet_getPOfVelocityLoop ( unsigned  devIndex,
unsigned  id,
unsigned *  p,
unsigned  timeout = 100 
)

获得速度环p值

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
p存放读取的速度环p值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getPosition()

EXTERNFUNC int planet_getPosition ( unsigned  devIndex,
unsigned  id,
float *  position,
unsigned  timeout = 100 
)

获得电机位置（°）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
position存放读取的电机位置（°）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getPositionOffset()

EXTERNFUNC int planet_getPositionOffset ( unsigned  devIndex,
unsigned  id,
float *  offset,
unsigned  timeout = 100 
)

获得电机的位置偏置（°）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
offset存放读取的电机的位置偏置（°）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getProductInfo()

EXTERNFUNC int planet_getProductInfo ( unsigned  devIndex,
unsigned  id,
unsigned *  info,
unsigned  timeout = 100 
)

获取产品信息

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
info存放读取的信息
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getProtectedTemperature()

EXTERNFUNC int planet_getProtectedTemperature ( unsigned  devIndex,
unsigned  id,
float *  protectedTem,
unsigned  timeout = 100 
)

获得电机的保护温度（℃）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
protectedTem存放读取的电机保护温度（℃）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getProtectedVoltage()

EXTERNFUNC int planet_getProtectedVoltage ( unsigned  devIndex,
unsigned  id,
float *  voltage,
unsigned  timeout = 100 
)

获得电机的保护电压（V）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
voltage存放读取的电机保护电压（V）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getProtectionSwitch()

EXTERNFUNC int planet_getProtectionSwitch ( unsigned  devIndex,
unsigned  id,
unsigned *  value,
unsigned  timeout = 100 
)

读取保护开关状态

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
value存放读取的使能状态
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getRatedTorque()

EXTERNFUNC int planet_getRatedTorque ( unsigned  devIndex,
unsigned  id,
unsigned *  torque,
unsigned  timeout = 100 
)

读取额定扭矩

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
torque存放读取的扭矩值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getRecoveryTemperature()

EXTERNFUNC int planet_getRecoveryTemperature ( unsigned  devIndex,
unsigned  id,
float *  recoveryTem,
unsigned  timeout = 100 
)

获得电机恢复温度（℃）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
recoveryTem存放读取的电机恢复温度（℃）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getSecondaryEncoderOffset()

EXTERNFUNC int planet_getSecondaryEncoderOffset ( unsigned  devIndex,
unsigned  id,
unsigned *  offset,
unsigned  timeout = 100 
)

读取第二磁编校准偏移

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
offset存放读取的偏移值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getSecondEncoderAngle()

EXTERNFUNC int planet_getSecondEncoderAngle ( unsigned  devIndex,
unsigned  id,
unsigned *  angle,
unsigned  timeout = 100 
)

读取第二磁编角度参数

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
angle存放读取的参数
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getSerialNumber()

EXTERNFUNC int planet_getSerialNumber ( unsigned  devIndex,
unsigned  id,
unsigned *  serialNum,
unsigned  timeout = 100 
)

获得电机序列号

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
serialNum存放读取的电机序列号
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getSingleLapPositionRange()

EXTERNFUNC int planet_getSingleLapPositionRange ( unsigned  devIndex,
unsigned  id,
int *  range,
unsigned  timeout = 100 
)

获得上电时刻单圈位置范围值

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
range存放读取的单圈范围值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getStallProtectionTime()

EXTERNFUNC int planet_getStallProtectionTime ( unsigned  devIndex,
unsigned  id,
unsigned *  time,
unsigned  timeout = 100 
)

读取堵转保护时间

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
time存放读取的时间
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getStopRunState()

EXTERNFUNC int planet_getStopRunState ( unsigned  devIndex,
unsigned  id,
bool *  state,
unsigned  timeout = 100 
)

获得电机停止状态

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
state存放读取的电机停止状态
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getTargetAcceleration()

EXTERNFUNC int planet_getTargetAcceleration ( unsigned  devIndex,
unsigned  id,
float *  acc,
unsigned  timeout = 100 
)

获得电机目标加速度（rpm/s）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
acc存放读取的电机目标加速度（rpm/s）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getTargetCurrent()

EXTERNFUNC int planet_getTargetCurrent ( unsigned  devIndex,
unsigned  id,
float *  current,
unsigned  timeout = 100 
)

获得目标电流值（q值）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
current存放读取的目标电流值（q值）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getTargetDeceleration()

EXTERNFUNC int planet_getTargetDeceleration ( unsigned  devIndex,
unsigned  id,
float *  dec,
unsigned  timeout = 100 
)

获得电机目标减速度（rpm/s）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
dec存放读取的电机目标减速度（rpm/s）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getTargetPosition()

EXTERNFUNC int planet_getTargetPosition ( unsigned  devIndex,
unsigned  id,
float *  position,
unsigned  timeout = 100 
)

获得电机目标位置（°）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
position存放读取的电机目标位置（°）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getTargetVelocity()

EXTERNFUNC int planet_getTargetVelocity ( unsigned  devIndex,
unsigned  id,
float *  velocity,
unsigned  timeout = 100 
)

获得电机目标速度（rpm）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
velocity存放读取的电机目标速度（rpm）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getTemperature()

EXTERNFUNC int planet_getTemperature ( unsigned  devIndex,
unsigned  id,
float *  tem,
unsigned  timeout = 100 
)

获得电机的温度（℃）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
tem存放读取的电机温度（℃）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getTorqueFactor()

EXTERNFUNC int planet_getTorqueFactor ( unsigned  devIndex,
unsigned  id,
unsigned *  factor,
unsigned  timeout = 100 
)

读取扭矩因子

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
factor存放读取的扭矩因子
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getVelocity()

EXTERNFUNC int planet_getVelocity ( unsigned  devIndex,
unsigned  id,
float *  velocity,
unsigned  timeout = 100 
)

获得电机速度（rpm）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
velocity存放读取的电机速度（rpm）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_getVoltage()

EXTERNFUNC int planet_getVoltage ( unsigned  devIndex,
unsigned  id,
float *  voltage,
unsigned  timeout = 100 
)

获得电机的电压（V）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
voltage存放读取的电机电压（V）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_initDLL()

EXTERNFUNC int planet_initDLL ( planet_DeviceType  devType,
unsigned  devIndex,
unsigned  channel,
planet_Baudrate  baudrate 
)

初始化dll，调用其他函数前，必须先调用该函数进行初始化，初始化成功后设备自动打开

参数
devType设备类型
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
channel通道，该参数只针对创芯设备生效，设置0或1
baudrate波特率
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_quick_setTargetPosition()

EXTERNFUNC int planet_quick_setTargetPosition ( unsigned  devIndex,
unsigned  id,
float  position 
)

设置电机目标位置（°），该函数用于同步位置模式，实现快写，无需等待控制器返回确认，可以快速连续设置，实现轨迹规划

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
position电机目标位置（°）
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_saveParas()

EXTERNFUNC int planet_saveParas ( unsigned  devIndex,
unsigned  id,
unsigned  timeout = 100 
)

保存控制器参数，当前修改的控制器参数，重新上电后仍然生效

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setAntiCoggingTorqueEnabled()

EXTERNFUNC int planet_setAntiCoggingTorqueEnabled ( unsigned  devIndex,
unsigned  id,
bool  enable,
unsigned  timeout = 100 
)

设置抗齿槽转矩补偿

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
enable使能状态
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setBrakeEnabled()

EXTERNFUNC int planet_setBrakeEnabled ( unsigned  devIndex,
unsigned  id,
bool  enable,
unsigned  timeout = 100 
)

设置抱闸使能状态

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
enable使能状态
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setCanBaudrate()

EXTERNFUNC int planet_setCanBaudrate ( unsigned  devIndex,
unsigned  id,
int  baudrate,
unsigned  timeout = 100 
)

设置电机的波特率

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
baudrate电机波特率
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setEnabled()

EXTERNFUNC int planet_setEnabled ( unsigned  devIndex,
unsigned  id,
bool  enable,
unsigned  timeout = 100 
)

设置电机使能状态

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
enable电机使能状态
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setID()

EXTERNFUNC int planet_setID ( unsigned  devIndex,
unsigned  id,
unsigned  newId,
unsigned  timeout = 100 
)

设置电机的id（范围是1~255）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id原先电机id
newId新的电机id
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setIntegralLimit()

EXTERNFUNC int planet_setIntegralLimit ( unsigned  devIndex,
unsigned  id,
float  limit,
unsigned  timeout = 100 
)

设置力矩环积分限制

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
limit积分限制
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setIOfCurrentLoop()

EXTERNFUNC int planet_setIOfCurrentLoop ( unsigned  devIndex,
unsigned  id,
unsigned  i,
unsigned  timeout = 100 
)

设置电流环i值

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
i存放读取的电流环i值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setIOfPositionLoop()

EXTERNFUNC int planet_setIOfPositionLoop ( unsigned  devIndex,
unsigned  id,
unsigned  i,
unsigned  timeout = 100 
)

设置位置环i值

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
i位置环i值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setIOfVelocityLoop()

EXTERNFUNC int planet_setIOfVelocityLoop ( unsigned  devIndex,
unsigned  id,
unsigned  i,
unsigned  timeout = 100 
)

设置速度环i值

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
i速度环i值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setLimitState()

EXTERNFUNC int planet_setLimitState ( unsigned  devIndex,
unsigned  id,
bool  state,
unsigned  timeout = 100 
)

设置电机的限位状态

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
state电机限位状态
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setMaxAccelerationOfPositionLadderCurve()

EXTERNFUNC int planet_setMaxAccelerationOfPositionLadderCurve ( unsigned  devIndex,
unsigned  id,
float  acc,
unsigned  timeout = 100 
)

设置位置梯形曲线的最大加速度（rpm/s）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
acc最大加速度（rpm/s）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setMaxAccelerationOfVelocityLadderCurve()

EXTERNFUNC int planet_setMaxAccelerationOfVelocityLadderCurve ( unsigned  devIndex,
unsigned  id,
float  acc,
unsigned  timeout = 100 
)

设置速度梯形曲线的最大加速度（rpm/s）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
acc最大加速度（rpm/s）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setMaxCurrent()

EXTERNFUNC int planet_setMaxCurrent ( unsigned  devIndex,
unsigned  id,
float  current,
unsigned  timeout = 100 
)

设置电机最大电流值（q值）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
current最大电流值（q值）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setMaxDecelerationOfPositionLadderCurve()

EXTERNFUNC int planet_setMaxDecelerationOfPositionLadderCurve ( unsigned  devIndex,
unsigned  id,
float  dec,
unsigned  timeout = 100 
)

设置位置梯形曲线的最大减速度（rpm/s）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
dec最大减速度（rpm/s）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setMaxDecelerationOfVelocityLadderCurve()

EXTERNFUNC int planet_setMaxDecelerationOfVelocityLadderCurve ( unsigned  devIndex,
unsigned  id,
float  dec,
unsigned  timeout = 100 
)

设置速度梯形曲线的最大减速度（rpm/s）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
dec最大减速度（rpm/s）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setMaxPosition()

EXTERNFUNC int planet_setMaxPosition ( unsigned  devIndex,
unsigned  id,
float  position,
unsigned  timeout = 100 
)

设置电机最大位置（°）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
position最大位置（°）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setMaxVelocity()

EXTERNFUNC int planet_setMaxVelocity ( unsigned  devIndex,
unsigned  id,
float  velocity,
unsigned  timeout = 100 
)

设置电机最大速度值（rpm）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
velocity最大速度值（rpm）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setMaxVelocityOfPositionLadderCurve()

EXTERNFUNC int planet_setMaxVelocityOfPositionLadderCurve ( unsigned  devIndex,
unsigned  id,
float  velocity,
unsigned  timeout = 100 
)

设置位置梯形曲线的最大速度（rpm）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
velocity最大速度（rpm）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setMaxVelocityOfVelocityLadderCurve()

EXTERNFUNC int planet_setMaxVelocityOfVelocityLadderCurve ( unsigned  devIndex,
unsigned  id,
float  velocity,
unsigned  timeout = 100 
)

设置速度梯形曲线的最大速度（rpm）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
velocity速度梯形曲线的最大速度（rpm）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setMinPosition()

EXTERNFUNC int planet_setMinPosition ( unsigned  devIndex,
unsigned  id,
float  position,
unsigned  timeout = 100 
)

设置电机最小位置（°）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
position最小位置（°）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setMode()

EXTERNFUNC int planet_setMode ( unsigned  devIndex,
unsigned  id,
unsigned  mode,
unsigned  timeout = 100 
)

设置电机控制模式

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
mode电机模式，模式如下: 1: 轮廓位置控制模式 3: 速度模式 4: 电流模式 5: 位置模式
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setPOfCurrentLoop()

EXTERNFUNC int planet_setPOfCurrentLoop ( unsigned  devIndex,
unsigned  id,
unsigned  p,
unsigned  timeout = 100 
)

设置电流环p值

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
p电流环p值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setPOfPositionLoop()

EXTERNFUNC int planet_setPOfPositionLoop ( unsigned  devIndex,
unsigned  id,
unsigned  p,
unsigned  timeout = 100 
)

设置位置环p值

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
p位置环p值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setPOfVelocityLoop()

EXTERNFUNC int planet_setPOfVelocityLoop ( unsigned  devIndex,
unsigned  id,
unsigned  p,
unsigned  timeout = 100 
)

设置速度环p值

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
p速度环p值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setPositionOffset()

EXTERNFUNC int planet_setPositionOffset ( unsigned  devIndex,
unsigned  id,
float  position,
unsigned  timeout = 100 
)

设置电机的位置偏置（°）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
position电机的位置偏置（°）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setProductInfo()

EXTERNFUNC int planet_setProductInfo ( unsigned  devIndex,
unsigned  id,
unsigned  info,
unsigned  timeout = 100 
)

设置产品信息

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
info产品信息
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setProtectedTemperature()

EXTERNFUNC int planet_setProtectedTemperature ( unsigned  devIndex,
unsigned  id,
float  tem,
unsigned  timeout = 100 
)

设置电机保护温度（℃）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
tem保护温度（℃）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setProtectedVoltage()

EXTERNFUNC int planet_setProtectedVoltage ( unsigned  devIndex,
unsigned  id,
float  voltage,
unsigned  timeout = 100 
)

设置电机的保护电压（V）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
voltage电机保护电压（V）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setProtectionSwitch()

EXTERNFUNC int planet_setProtectionSwitch ( unsigned  devIndex,
unsigned  id,
unsigned  value,
unsigned  timeout = 100 
)

设置保护开关状态

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
value使能状态
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setReceiveCallFunction()

EXTERNFUNC int planet_setReceiveCallFunction ( planet_ReceiveCallFunc  callFunc)

设置接收数据回调函数，可以通过该函数捕获实际接收的can数据

参数
callFunc回调函数地址
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setRecoveryTemperature()

EXTERNFUNC int planet_setRecoveryTemperature ( unsigned  devIndex,
unsigned  id,
float  tem,
unsigned  timeout = 100 
)

设置电机恢复温度（℃）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
tem存放读取的电机恢复温度（℃）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setSecondaryEncoderOffset()

EXTERNFUNC int planet_setSecondaryEncoderOffset ( unsigned  devIndex,
unsigned  id,
unsigned  offset,
unsigned  timeout = 100 
)

设置第二磁编校准偏移

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
offset偏移值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setSendCallFunction()

EXTERNFUNC int planet_setSendCallFunction ( planet_SendCallFunc  callFunc)

设置发送数据回调函数，可以通过该函数捕获实际发送的can数据

参数
callFunc回调函数地址
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setSingleLapPositionRange()

EXTERNFUNC int planet_setSingleLapPositionRange ( unsigned  devIndex,
unsigned  id,
int  range,
unsigned  timeout = 100 
)

设置电机上电时刻的单圈位置范围值

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
range单圈范围值
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setStallProtectionTime()

EXTERNFUNC int planet_setStallProtectionTime ( unsigned  devIndex,
unsigned  id,
unsigned  time,
unsigned  timeout = 100 
)

设置堵转保护时间

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
time时间
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setStopRunState()

EXTERNFUNC int planet_setStopRunState ( unsigned  devIndex,
unsigned  id,
bool  state,
unsigned  timeout = 100 
)

设置电机停止状态

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
state电机停止状态
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setTargetAcceleration()

EXTERNFUNC int planet_setTargetAcceleration ( unsigned  devIndex,
unsigned  id,
float  acc,
unsigned  timeout = 100 
)

设置电机目标加速度（rpm/s）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
acc电机目标加速度(rpm/s)
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setTargetCurrent()

EXTERNFUNC int planet_setTargetCurrent ( unsigned  devIndex,
unsigned  id,
float  current,
unsigned  timeout = 100 
)

设置目标电流值（q值）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
current目标电流值（q值）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setTargetDeceleration()

EXTERNFUNC int planet_setTargetDeceleration ( unsigned  devIndex,
unsigned  id,
float  dec,
unsigned  timeout = 100 
)

设置电机目标减速度（rpm/s）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
dec电机目标减速度（rpm/s）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setTargetPosition()

EXTERNFUNC int planet_setTargetPosition ( unsigned  devIndex,
unsigned  id,
float  position,
unsigned  timeout = 100 
)

设置电机目标位置（°），该函数不适用于同步位置模式，位置模式下设置电机目标位置 参见:quick_setTargetPosition

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
position电机目标位置（°）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setTargetVelocity()

EXTERNFUNC int planet_setTargetVelocity ( unsigned  devIndex,
unsigned  id,
float  velocity,
unsigned  timeout = 100 
)

设置电机目标速度（rpm）

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
velocity电机目标速度（rpm）
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_setTorqueFactor()

EXTERNFUNC int planet_setTorqueFactor ( unsigned  devIndex,
unsigned  id,
unsigned  factor,
unsigned  timeout = 100 
)

设置扭矩因子

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
factor扭矩因子
timeout函数执行后，等待timeout毫秒来接收执行结果
返回
执行成功返回CAN_SUCCESS，失败返回其他

◆ planet_writeData()

EXTERNFUNC int planet_writeData ( unsigned  devIndex,
unsigned  id,
unsigned char *  sendData,
int  sendLength 
)

发送can数据，数据长度不能超过8

参数
devIndex设备索引，第一个设备设置为0，第二个设备设置为1，以此类推
id电机id
sendData将要发送的can数据
sendLengthcan数据长度（不超过8位）
返回
执行成功返回CAN_SUCCESS，失败返回其他
制作者 doxygen 1.9.1