PUSICAN应用接口二次开发说明文档V0 1 0

1、CQPUSICQPUSI ROBOTROBOT CONTROLCONTROL SYSTEMSYSTEM YANLANYANLAN AUTOMATIONAUTOMATION TECHNOLOGYTECHNOLOGY PUMAOPUMAO AUTOMATIONAUTOMATION TECHNOLOGYTECHNOLOGY PUSICANPUSICAN 二次开发手册二次开发手册 PMC007xxPMC007xx 系列系列 微型一体化步进电机控制器微型一体化步进电机控制器 PUSICAN 应用接口二次开发手册 CQPUSI Robot Control System Page 2 of 24 1.版本控

2、制版本控制 1）文档更新记录文档更新记录 日期更新人版本备注 2018-04-20huangchengV0.1.0Initial PUSICAN 应用接口二次开发手册 CQPUSI Robot Control System Page 3 of 24 目录 1概述.5 2接口说明.5 2.1结构和类型.5 2.1.1接口返回参数.5 2.1.2CAN 适配器.5 2.1.3CAN 通讯波特率.5 2.1.4PUSICAN 设备型号.6 2.1.5从站改变回调函数.6 2.1.6跟踪信息回调函数.6 2.1.7TPDO 回调函数.6 2.2应用接口函数.6 2.2.1设置回调函数.6 2.2.2初

3、始化.7 2.2.3设置 TCP 客户端参数.7 2.2.4设置串口参数.7 2.2.5打开适配器端口.7 2.2.6关闭适配器端口.7 2.2.7从站在线状态.8 2.2.8启动节点.8 2.2.9停止节点.8 2.2.10复位节点.8 2.2.11复位通信.9 2.2.12进入预操作状态.9 2.2.13保存对象字典.9 2.2.14获取马达状态.9 2.2.15获取控制状态.9 2.2.16获取马达使能状态.10 2.2.17设置马达使能状态.10 2.2.18获取峰值电流.10 2.2.19设置峰值电流.10 2.2.20获取电流衰减.11 2.2.21设置电流衰减.11 2.2.22

4、获取细分.11 2.2.23设置细分.11 2.2.24获取工作模式.12 2.2.25设置工作模式.12 2.2.26获取转动方向.12 2.2.27设置转动方向.12 2.2.28获取启动速度.13 2.2.29设置启动速度.13 2.2.30获取停止速度.13 2.2.31设置停止速度.13 2.2.32获取加速度系数.13 PUSICAN 应用接口二次开发手册 CQPUSI Robot Control System Page 4 of 24 2.2.33设置加速度系数.14 2.2.34获取减速度系数.14 2.2.35设置减速度系数.14 2.2.36获取最大速度.14 2.2.37

5、设置最大速度.15 2.2.38获取马达位置.15 2.2.39设置马达位置.15 2.2.40相对位置步进.15 2.2.41绝对位置步进.15 2.2.42终止步进.16 2.2.43获取外部停止使能.16 2.2.44设置外部停止使能.16 2.2.45获取外部停止触发方式.16 2.2.46设置外部停止触发方式.17 2.2.47获取外部停止去抖时间.17 2.2.48设置外部停止去抖时间.17 2.2.49清外部紧急停止.17 2.2.50设置组 ID.18 2.2.51设置 PVT 模式.18 2.2.52设置最大 PVT 数.18 2.2.53设置 PVT1 参数.18 2.2.

6、54设置 PVT2 参数.19 2.2.55设置 PVT3 参数.19 2.2.56写 PVT 参数.19 2.2.57启动 PVT 步进.20 2.2.58终止 PVT 步进.20 2.2.59获取 GPIO 方向.20 2.2.60设置 GPIO 方向.20 2.2.61获取 GPIO 端口配置.20 2.2.62设置 GPIO 端口配置.21 2.2.63获取 GPIO 端口值.21 2.2.64设置 GPIO 端口值.21 2.2.65设置幻彩灯参数.21 2.2.66设置幻彩灯使能.22 2.2.67设置幻彩灯颜色.22 2.2.68写 PDO.22 2.2.69读 PDO.22 3

7、函数调用流程.23 PUSICAN 应用接口二次开发手册 CQPUSI Robot Control System Page 5 of 24 1概述概述 PUSICAN 工具用于 PMC007xx 系列微型一体化步进电机控制器的控制，本文档用于 描述 PUSICAN 应用接口二次开发及使用说明。 应用接口层函数封装在 PUSICANControl.dll 中，头文件为 PUSICANControlLib.h。 2接口说明接口说明 2.1结构和类型结构和类型 2.1.12.1.1接口返回参数接口返回参数 typedef enum PCAN_SUCCESS = 0, /*操作成功*/ PCAN_GE

8、NERNAL_ERR = 1, /*通用错误*/ PCAN_LOADDRIVER_FAIL = 2, /* 装载驱动失败 */ PCAN_OPEN_FAIL = 3, /*打开适配器失败*/ PCAN_READSDO_FAIL = 4, /*读 SDO 失败*/ PCAN_READSDO_TIMEOUT = 5, /*读 SDO 超时*/ PCAN_WRITESDO_FAIL = 6, /*写 SDO 失败*/ PCAN_WRITESDO_TIMEOUT = 7, /*写 SDO 超时*/ PCAN_NOIDLE_SDO_CLIENT = 8,/*SDO 客户端没有可用的通道*/ PCAN_W

9、RITEPDO_FAIL = 9,/*写 PDO 失败*/ PCAN_NO_SUPPORT_TCP_CONNCT = 10,/*不支持 TCP 连接*/ PCAN_NO_SUPPORT_SP_CONNCT = 11,/*不支持串口连接*/ PCANResult; 2.1.22.1.2CANCAN 适配器适配器 typedef enum LANMA_A1PLUS = 0,/蓝马电子 A1+ LEDIA = 1,/乐的 USB-CAN YL9100 = 2,/YL9100 IXXAT = 3,/IXXAT GC_USBCAN_I = 4,/广成 USBCAN-I ZLG_USBCAN_I = 5,

10、/周立功 USBCAN-I ZLG_USBCAN_E_U = 6,/周立功 USBCAN-E-U ZLG_CANET_TCPC = 7,/周立功 CANET-TCP 客户端 CX_CANALYST_II= 8,/创芯 CANalyst-II ZLG_CANCOM_100IE = 9,/周立功 CANCOM-100IE ADAPT_TYPE_T; 2.1.32.1.3CANCAN 通讯波特率通讯波特率 typedef enum BR_10KBPS = 0, BR_20KBPS = 1, BR_50KBPS = 2, BR_100KBPS = 3, PUSICAN 应用接口二次开发手册 CQPUS

11、I Robot Control System Page 6 of 24 BR_125KBPS = 4, BR_250KBPS = 5, BR_500KBPS = 6, BR_800KBPS = 7, BR_1000KBPS = 8, BAUDRATE_T; 2.1.42.1.4PUSICANPUSICAN 设备型号设备型号 typedef enum PMC007C3S = 0, PMC007C6S = 1, PMC007C3SE = 2, PMC007C6SE = 3, PCAN_TYPE_T; 2.1.52.1.5从站改变回调函数从站改变回调函数 回调函数定义： typedef PCANRe

12、sult (_stdcall * LPPCAN_SLAVECHANGECB)(DWORD dwNodeID,BOOL bOnline); 当从站上线或掉线时回调此函数。 2.1.62.1.6跟踪信息回调函数跟踪信息回调函数 回调函数定义： typedef PCANResult (_stdcall * LPPCAN_TRACECB)(char* szTrace); 通过此回调函数输出跟踪信息。 2.1.72.1.7TPDOTPDO 回调函数回调函数 回调函数定义： typedef PCANResult (_stdcall * LPPCAN_TPDOCB)(DWORD dwNodeID,DWORD

13、 dwTPDOChannel,BYTE* pTPDOData,DWORD dwLen); 接收到 TPDO 报文时回调此函数。 2.2应用接口函数应用接口函数 2.2.12.2.1设置回调函数设置回调函数 描述描述 设置接口的回调函数，如果对回调信息不关心可不调用此函数或者传入 NULL。 PCANResult _stdcall PCAN_SetEventCallback(LPPCAN_SLAVECHANGECB funcSlaveChangeCallback,LPPCAN_TRACECB funcTraceCallback,LPPCAN_TPDOCB funcTPDOCallback); 参

14、数参数 funcSlaveChangeCallback：从站状态改变后的回调函数； funcTraceCallback：跟踪信息回调函数； funcTPDOCallback：TPDO 回调函数； 返回值返回值 见 2.1.1 描述 PUSICAN 应用接口二次开发手册 CQPUSI Robot Control System Page 7 of 24 2.2.22.2.2初始化初始化 描述描述 PUSICANControl 的相关变量初始化。 PCANResult _stdcall PCAN_Init(ADAPT_TYPE_T adaptType,PCAN_TYPE_T devType,DWOR

15、D dwTraceLevel); 参数参数 adaptType：CAN 适配器类型； devType：PUSI 的 CAN 设备类型； dwTraceLevel：跟踪信息等级，TRACE_LEVEL0,只打印应用层跟踪信息； TRACE_LEVEL1,打印应用层和驱动层跟踪信息； 返回值返回值 见 2.1.1 描述 2.2.32.2.3设置设置 TCPTCP 客户端参数客户端参数 描述描述 设置以太网转 CAN 适配器的 TCP 客户端参数，非以太网转 CAN 适配器不需调用此 函数。 PCANResult _stdcall PCAN_SetTCPClient(char *szIPAddr,D

16、WORD dwPort); 参数参数 szIPAddr：IP 地址，类似“192.168.0.1“； dwPort：通信端口； 返回值返回值 见 2.1.1 描述 2.2.42.2.4设置串口参数设置串口参数 描述描述 设置串口转 CAN 适配器的串口通信参数，非串口转 CAN 适配器不需调用此函数。 PCANResult _stdcall PCAN_SetSerialPort(DWORD dwPort,DWORD dwBaud); 参数参数 dwPort：串口号； dwBaud：串口通信的波特率； 返回值返回值 见 2.1.1 描述 2.2.52.2.5打开适配器端口打开适配器端口 描述描述

17、 打开 CAN 适配器端口 PCANResult _stdcall PCAN_OpenPort(BAUDRATE_T baudrate); 参数参数 baudrate：CAN 通信波特率； 返回值返回值 见 2.1.1 描述 2.2.62.2.6关闭适配器端口关闭适配器端口 描述描述 PUSICAN 应用接口二次开发手册 CQPUSI Robot Control System Page 8 of 24 关闭 CAN 适配器端口 PCANResult _stdcall PCAN_ClosePort(void); 参数参数 无 返回值返回值 见 2.1.1 描述 2.2.72.2.7从站在线状态从

18、站在线状态 描述描述 判断从站是否上线 PCANResult _stdcall PCAN_IsSlaveOnline(DWORD dwNodeID,BOOL *pOnline); 参数参数 dwNodeID：从站的节点 ID； pOnline：在线状态； 返回值返回值 见 2.1.1 描述 2.2.82.2.8启动节点启动节点 描述描述 启动从站节点，NMT 指令 PCANResult _stdcall PCAN_StartNode(DWORD dwNodeID); 参数参数 dwNodeID:从站的节点 ID； 返回值返回值 见 2.1.1 描述 2.2.92.2.9停止节点停止节点 描述描

19、述 停止从站节点，NMT 指令 PCANResult _stdcall PCAN_StopNode(DWORD dwNodeID); 参数参数 dwNodeID:从站的节点 ID； 返回值返回值 见 2.1.1 描述 2.2.102.2.10 复位节点复位节点 描述描述 复位从站节点，NMT 指令 PCANResult _stdcall PCAN_ResetNode(DWORD dwNodeID); 参数参数 dwNodeID:从站的节点 ID； 返回值返回值 见 2.1.1 描述 PUSICAN 应用接口二次开发手册 CQPUSI Robot Control System Page 9 of

20、 24 2.2.112.2.11 复位通信复位通信 描述描述 复位从站节点，NMT 指令 PCANResult _stdcall PCAN_ResetCommunication(DWORD dwNodeID); 参数参数 dwNodeID:从站的节点 ID； 返回值返回值 见 2.1.1 描述 2.2.122.2.12 进入预操作状态进入预操作状态 描述描述 从站节点进入预操作状态，NMT 指令 PCANResult _stdcall PCAN_EnterPreoperational(DWORD dwNodeID); 参数参数 dwNodeID:从站的节点 ID； 返回值返回值 见2.1.1描

21、述 2.2.132.2.13 保存对象字典保存对象字典 描述描述 保存对象字典 PCANResult _stdcall PCAN_SaveObjectDict(DWORD dwNodeID); 参数参数 NodeID：从站的节点 ID； 返回值返回值 见 2.1.1 描述 2.2.142.2.14 修改节点修改节点 IDID 描述描述 修改控制器的节点 ID PCANResult _stdcall PCAN_SaveObjectDict(DWORD dwNodeID,DWORD dwNewNodeID); 参数参数 dwNodeID：从站的节点 ID； dwNewNodeID：修改的新的节点

22、ID； 返回值返回值 见 2.1.1 描述 2.2.152.2.15 获取马达状态获取马达状态 描述描述 获取马达状态 PCANResult _stdcall PCAN_GetMotorStatus(DWORD dwNodeID,DWORD* pMotorStatus); 参数参数 PUSICAN 应用接口二次开发手册 CQPUSI Robot Control System Page 10 of 24 dwNodeID：从站的节点 ID； pMotorStatus:马达的状态，相应位的定义 ES_UVLO、ES_BERR、ES_AERR、ES_BOC、ES_AOC、ES_OTS； 返回值返回值

23、 见 2.1.1 描述 2.2.162.2.16 获取控制状态获取控制状态 描述描述 获取控制状态 PCANResult _stdcall PCAN_GetControlStatus(DWORD dwNodeID,DWORD* pControlStatus); 参数参数 dwNodeID：从站的节点 ID； pMotorStatus:控制状态，相应位的定义 CS_EXT1、CS_EXT2、CS_STALL、CS_BUSY、CS_EXT3、CS_PVT3_FIFO_EMPTY、C S_PVT3_LOW_THRESHOLD、CS_PVT3_HIGH_THRESHOLD； 返回值返回值 见 2.1.

24、1 描述 2.2.172.2.17 获取马达使能状态获取马达使能状态 描述描述 获取马达使能状态 PCANResult _stdcall PCAN_GetMotorEnable(DWORD dwNodeID,BOOL *pMotorEnable); 参数参数 dwNodeID：从站的节点 ID； pMotorEnable:马达使能状态； 返回值返回值 见 2.1.1 描述 2.2.182.2.18 设置马达使能状态设置马达使能状态 描述描述 设置马达使能状态 PCANResult _stdcall PCAN_SetMotorEnable(DWORD dwNodeID,BOOL bMotorEn

25、able); 参数参数 dwNodeID：从站的节点 ID； bMotorEnable:马达使能状态； 返回值返回值 见 2.1.1 描述 2.2.192.2.19 获取峰值电流获取峰值电流 描述描述 获取峰值电流 PCANResult _stdcall PCAN_GetPeakCurrent(DWORD dwNodeID,DWORD *pPeakCurrent); PUSICAN 应用接口二次开发手册 CQPUSI Robot Control System Page 11 of 24 参数参数 dwNodeID：从站的节点 ID； pPeakCurrent:获取的峰值电流； 返回值返回值 见

26、 2.1.1 描述 2.2.202.2.20 设置峰值电流设置峰值电流 描述描述 设置峰值电流 PCANResult _stdcall PCAN_SetPeakCurrent(DWORD dwNodeID,DWORD dwPeakCurrent); 参数参数 dwNodeID：从站的节点 ID； dwPeakCurrent:设置的峰值电流； 返回值返回值 见 2.1.1 描述 2.2.212.2.21 获取电流衰减获取电流衰减 描述描述 获取电流衰减 PCANResult _stdcall PCAN_GetCurrentDecay(DWORD dwNodeID,DWORD *pCurrentD

27、ecay); 参数参数 dwNodeID：从站的节点 ID； pCurrentDecay:获取的电流衰减； 返回值返回值 见 2.1.1 描述 2.2.222.2.22 设置电流衰减设置电流衰减 描述描述 设置电流衰减 PCANResult _stdcall PCAN_SetCurrentDecay(DWORD dwNodeID,DWORD dwCurrentDecay); 参数参数 dwNodeID：从站的节点 ID； dwCurrentDecay:设置的电流衰减； 返回值返回值 见 2.1.1 描述 2.2.232.2.23 获取细分获取细分 描述描述 获取细分 PCANResult _s

28、tdcall PCAN_GetMicroStep(DWORD dwNodeID,DWORD *pMicroStep); 参数参数 dwNodeID：从站的节点 ID； PUSICAN 应用接口二次开发手册 CQPUSI Robot Control System Page 12 of 24 pMicroStep:获取的细分数； 返回值返回值 见 2.1.1 描述 2.2.242.2.24 设置细分设置细分 描述描述 设置细分 PCANResult _stdcall PCAN_SetMicroStep(DWORD dwNodeID,DWORD dwMicroStep); 参数参数 dwNodeID

29、：从站的节点 ID； dwMicroStep:设置的细分，取值 MS_0、MS_2、MS_4、MS_8、MS_16、MS_32、MS_64、MS_128、MS_256； 返回值返回值 见 2.1.1 描述 2.2.252.2.25 获取工作模式获取工作模式 描述描述 获取工作模式 PCANResult _stdcall PCAN_GetWorkMode(DWORD dwNodeID,DWORD *pWorkMode); 参数参数 dwNodeID：从站的节点 ID； pWorkMode:获取的工作模式； 返回值返回值 见 2.1.1 描述 2.2.262.2.26 设置工作模式设置工作模式 描

30、述描述 设置工作模式 PCANResult _stdcall PCAN_SetWorkMode(DWORD dwNodeID,DWORD dwWorkMode); 参数参数 dwNodeID：从站的节点 ID； dwWorkMode:设置工作模式，取值 WM_POS、WM_VELOCITY、WM_PVT、WM_ENC_FOLLOW； 返回值返回值 见 2.1.1 描述 2.2.272.2.27 获取转动方向获取转动方向 描述描述 获取电机转动方向 PCANResult _stdcall PCAN_GetDir(DWORD dwNodeID,DWORD *pDir); 参数参数 dwNodeID

31、：从站的节点 ID； PUSICAN 应用接口二次开发手册 CQPUSI Robot Control System Page 13 of 24 pDir:获取的转动方向； 返回值返回值 见 2.1.1 描述 2.2.282.2.28 设置转动方向设置转动方向 描述描述 设置电机转动方向 PCANResult _stdcall PCAN_SetDir(DWORD dwNodeID,DWORD dir); 参数参数 dwNodeID：从站的节点 ID； dir:设置的转动方向，取值 MOTOR_FORWARD、MOTOR_REVERSE； 返回值返回值 见 2.1.1 描述 2.2.292.2.2

32、9 获取启动速度获取启动速度 描述描述 获取启动速度 PCANResult _stdcall PCAN_GetStartSpeed(DWORD dwNodeID,DWORD *pStartSpeed); 参数参数 dwNodeID：从站的节点 ID； pStartSpeed:获取的启动速度； 返回值返回值 见 2.1.1 描述 2.2.302.2.30 设置启动速度设置启动速度 描述描述 设置启动速度 PCANResult _stdcall PCAN_SetStartSpeed(DWORD dwNodeID,DWORD dwStartSpeed); 参数参数 dwNodeID：从站的节点 ID

33、； dwStartSpeed:设置的启动速度； 返回值返回值 见 2.1.1 描述 2.2.312.2.31 获取停止速度获取停止速度 描述描述 获取停止速度 PCANResult _stdcall PCAN_GetStopSpeed(DWORD dwNodeID,DWORD *pStopSpeed); 参数参数 dwNodeID：从站的节点 ID； pStopSpeed：获取的停止速度； 返回值返回值 见 2.1.1 描述 PUSICAN 应用接口二次开发手册 CQPUSI Robot Control System Page 14 of 24 2.2.322.2.32 设置停止速度设置停止速

34、度 描述描述 设置停止速度 PCANResult _stdcall PCAN_SetStopSpeed(DWORD dwNodeID,DWORD dwStopSpeed); 参数参数 dwNodeID：从站的节点 ID； dwStopSpeed:设置的停止速度； 返回值返回值 见 2.1.1 描述 2.2.332.2.33 获取加速度系数获取加速度系数 描述描述 获取加速度系数 PCANResult _stdcall PCAN_GetAccel(DWORD dwNodeID,DWORD *pAccel); 参数参数 dwNodeID：从站的节点 ID； pAccel:获取的加速度系数； 返回值

35、返回值 见 2.1.1 描述 2.2.342.2.34 设置加速度系数设置加速度系数 描述描述 设置加速度系数 PCANResult _stdcall PCAN_SetAccel(DWORD dwNodeID,DWORD dwAccel); 参数参数 dwNodeID：从站的节点 ID； dwAccel:设置的加速度系数； 返回值返回值 见 2.1.1 描述 2.2.352.2.35 获取减速度系数获取减速度系数 描述描述 获取减速度系数 PCANResult _stdcall PCAN_GetDecel(DWORD dwNodeID,DWORD *pDecel); 参数参数 dwNodeID

36、：从站的节点 ID； pDecel:获取的减速度系数； 返回值返回值 见 2.1.1 描述 2.2.362.2.36 设置减速度系数设置减速度系数 描述描述 设置减速度系数 PCANResult _stdcall PCAN_SetDecel(DWORD dwNodeID,DWORD dwDecel); 参数参数 PUSICAN 应用接口二次开发手册 CQPUSI Robot Control System Page 15 of 24 dwNodeID：从站的节点 ID； dwDecel:设置的减速度系数； 返回值返回值 见 2.1.1 描述 2.2.372.2.37 获取最大速度获取最大速度 描

37、述描述 获取最大速度 PCANResult _stdcall PCAN_GetMaxSpeed(DWORD dwNodeID,int *pMaxSpeed); 参数参数 dwNodeID：从站的节点 ID； pMaxSpeed:获取的最大速度； 返回值返回值 见 2.1.1 描述 2.2.382.2.38 设置最大速度设置最大速度 描述描述 设置最大速度 PCANResult _stdcall PCAN_SetMaxSpeed(DWORD dwNodeID,int nMaxSpeed); 参数参数 dwNodeID：从站的节点 ID； nMaxSpeed:设置的最大速度； 返回值返回值 见 2.1.1 描述 2.2.392.2.39 获取马达位置获取马达位置 描述描述 获取马达位置 PCANResult _stdcall PCAN_Ge