API 说明
============================

rokae 工控机主控支持的 API
++++++++++++++++++++++++++++++++++++++++++

+--------+-------------------------+----------+
| 指令号 | 命令                    | 支持情况 |
+========+=========================+==========+
| 100    | 获取机械臂程序版本号    | 支持     |
+--------+-------------------------+----------+
| 101    | 发送速度数据            | 支持     |
+--------+-------------------------+----------+
| 102    | 发送加速度数据          | 支持     |
+--------+-------------------------+----------+
| 103    | 发送圆滑过渡参数        | 支持     |
+--------+-------------------------+----------+
| 104    | 发送工具坐标系(TCP)参数 | 支持     |
+--------+-------------------------+----------+
| 105    | 设置数字量输出          | 支持     |
+--------+-------------------------+----------+
| 106    | SetJointsMovej          | 支持     |
+--------+-------------------------+----------+
| 107    | SetCartMovel            | 支持     |
+--------+-------------------------+----------+
| 108    | SetJoinsMovel           | 支持     |
+--------+-------------------------+----------+
| 109    | SetCartMovej            | 支持     |
+--------+-------------------------+----------+
| 110    | MovejSequence           | 支持     |
+--------+-------------------------+----------+
| 111    | MovelSequence           | 支持     |
+--------+-------------------------+----------+
| 112    | SetJointsMovejDo        | 不支持   |
+--------+-------------------------+----------+
| 113    | SetCartMovelDo          | 不支持   |
+--------+-------------------------+----------+
| 114    | SetJointsMovelDo        | 不支持   |
+--------+-------------------------+----------+
| 115    | SetJointsMovejGroupDo   | 不支持   |
+--------+-------------------------+----------+
| 116    | SetCartMovelGroupDo     | 不支持   |
+--------+-------------------------+----------+
| 117    | SetJointsMovelGroupDo   | 不支持   |
+--------+-------------------------+----------+
| 118    | MovelUntil              | 不支持   |
+--------+-------------------------+----------+
| 119    | 获取数字量输入状态      | 不支持   |
+--------+-------------------------+----------+
| 120    | 获取数字量输出状态      | 不支持   |
+--------+-------------------------+----------+
| 121    | 获取模拟量输入口数值    | 不支持   |
+--------+-------------------------+----------+
| 122    | 获取机械臂当前角度      | 支持     |
+--------+-------------------------+----------+
| 123    | 获取机械臂当前位姿      | 支持     |
+--------+-------------------------+----------+
| 200    | 机械臂后台发送状态      | 支持     |
+--------+-------------------------+----------+


rokae 机械臂主控支持的 API
+++++++++++++++++++++++++++++++++++

.. function:: PROC xyzConnect(string sock)
   :noindex:

   连接指定socket

   :param sock: socket名称，定义在全局变量中
   :type sock: VAR string


.. function:: PROC xyzClose(string sock)
   :noindex:

   关闭指定socket

   :param sock: socket名称，定义在全局变量中
   :type sock: VAR string

.. function:: FUNC int xyzSwitchApp(string app_name)
   :noindex:

   切换应用

   :param app_name: 应用名称
   :type app_name: string
   :return: err_code
   :rtype: int

.. function:: FUNC int xyzSwitchFlow(string flow_name)
   :noindex:

   切换flow

   :param flow_name: flow名称
   :type flow_name: string
   :return: err_code
   :rtype: int

.. function:: FUNC int xyzSwitchItem(int ws_id, string item_codename)
   :noindex:

   切换工件

   :param  ws_id: 工作空间 id
   :type ws_id: int
   :param item_codename: 工件名称
   :type item_codename: string
   :return: err_code
   :rtype: int

.. function:: FUNC int xyzSwitchTool(string tool_name)
   :noindex:

   切换工具

   :param tool_name: 工具名称
   :type tool_name: string
   :return: err_code
   :rtype: int

.. function:: FUNC int xyzReqCapImg(int ws_id)
   :noindex:

   请求拍照

   :param  ws_id: 工作空间 id
   :type ws_id: int
   :param  Token: 请求拍照结果,全局变量
   :type Token: int
   :return: err_code
   :rtype: int			

.. function:: FUNC int xyzGetCapImg(int token)
   :noindex:

   获取拍照结果

   :param  token: 请求拍照时返回的 token
   :type token: int
   :return: err_code
   :rtype: int	

.. function:: FUNC int xyzCapImg(int ws_id)
   :noindex:

   拍照

   :param  ws_id: 需要进行拍照操作的工作空间id
   :type ws_id: int
   :return: err_code
   :rtype: int	

.. function:: FUNC int xyzReqGraspPose(int ws_id)
   :noindex:

   请求抓取位姿

   :param  ws_id: 需要获取抓取点位的工作空间id
   :type ws_id: INintT
   :param  Token: 返回的用于获取目标点位时使用的Token,全局变量
   :type token: int			
   :return: err_code
   :rtype: int	

.. function:: FUNC int xyzGetGraspPose(int token)
   :noindex:

   获取抓取位姿

   :param  token: 求抓取目标点位时返回的token
   :type token: int
   :param  PoseNum: 可供抓取的点数量
   :type PoseNum: int
   :param  PipeNum: pipeline编号
   :type PipeNum: int
   :param  RegNum: 注册编号
   :type RegNum: int
   :param  GraspPose: 抓取位姿
   :type GraspPose: pose   
   :return: err_code
   :rtype: int	

.. function:: FUNC int xyzReqObjPose(int ws_id)
   :noindex:

   请求物体位姿

   :param  ws_id: 需要获取物体位姿的工作空间id
   :type ws_id: int
   :param  Token: 物体位姿识别的token
   :type Token: int			
   :return: err_code
   :rtype: int	


.. function:: FUNC int xyzGetObjPose(int token)
   :noindex:

   获取物体位姿

   :param  token: 请求物体位姿时得到的token
   :type token: int
   :param  PoseNum: 可供抓取的点数量
   :type PoseNum: int
   :param  PipeNum: pipeline编号
   :type PipeNum: int
   :param  RegNum: 注册编号
   :type RegNum: int
   :param  ObjectPose: 抓取位姿
   :type ObjectPose: pose   
   :return: err_code
   :rtype: int	


.. function:: FUNC int xyzResetVision(int ws_id)
   :noindex:

   重置视觉

   :param  ws_id: 需要重置视觉的工作空间id
   :type ws_id: int	
   :return: err_code
   :rtype: int

.. function:: FUNC int xyzSendCurrentJoints()
   :noindex:

   发送当前机器人角度

   :return: err_code
   :rtype: int			

.. function:: FUNC int xyzSendCurrentCartPose()
   :noindex:

    发送当前机器人位姿

   :return: err_code
   :rtype: int

.. function:: FUNC int xyzSendCurrentExtJoints()
   :noindex:

   发送当前机器人外部角

   :return: err_code
   :rtype: int

.. function:: FUNC int xyzReqPick()
   :noindex:

   请求pick动作规划

   :return: err_code
   :rtype: int


.. function:: FUNC int xyzReqPlace()
   :noindex:

   请求place动作规划

   :return: err_code
   :rtype: int

.. function:: FUNC int xyzReqPickPlace(int ws_id)
   :noindex:

   请求pick和place规划

   :param  ws_id: 工作空间id
   :type ws_id: int	
   :return: err_code
   :rtype: int			

.. function:: FUNC int xyzGetPickin(int ws_id)
   :noindex:

   获取取料入框轨迹

   :param  PoseNum: 可供抓取的点数量
   :type PoseNum: int
   :param  PipeNum: pipeline编号
   :type PipeNum: int
   :param  RegNum: 注册编号
   :type RegNum: int
   :param  WaypointType: 轨迹点类型
   :type WaypointType: int array
   :param  JointWaypoints: joints类型轨迹点
   :type JointWaypoints: joints array
   :param  CartWaypoints: cart类型轨迹点
   :type CartWaypoints: cart array
   :return: err_code
   :rtype: int	 	

.. function:: FUNC int xyzGetPickout(int ws_id)
   :noindex:

   获取取料出框轨迹

   :param  PoseNum: 可供抓取的点数量
   :type PoseNum: int
   :param  PipeNum: pipeline编号
   :type PipeNum: int
   :param  RegNum: 注册编号
   :type RegNum: int
   :param  WaypointType: 轨迹点类型
   :type WaypointType: int array
   :param  JointWaypoints: joints类型轨迹点
   :type JointWaypoints: joints array
   :param  CartWaypoints: cart类型轨迹点
   :type CartWaypoints: cart array
   :return: err_code
   :rtype: int	 		

.. function:: FUNC int xyzGetPlacein(int ws_id)
   :noindex:

   获取放料入框轨迹

   :param  PoseNum: 可供抓取的点数量
   :type PoseNum: int
   :param  PipeNum: pipeline编号
   :type PipeNum: int
   :param  RegNum: 注册编号
   :type RegNum: int
   :param  WaypointType: 轨迹点类型
   :type WaypointType: int array
   :param  JointWaypoints: joints类型轨迹点
   :type JointWaypoints: joints array
   :param  CartWaypoints: cart类型轨迹点
   :type CartWaypoints: cart array
   :return: err_code
   :rtype: int	 	

.. function:: FUNC int xyzGetPlaceout(int ws_id)
   :noindex:

   获取放料出框轨迹

   :param  PoseNum: 可供抓取的点数量
   :type PoseNum: int
   :param  PipeNum: pipeline编号
   :type PipeNum: int
   :param  RegNum: 注册编号
   :type RegNum: int
   :param  WaypointType: 轨迹点类型
   :type WaypointType: int array
   :param  JointWaypoints: joints类型轨迹点
   :type JointWaypoints: joints array
   :param  CartWaypoints: cart类型轨迹点
   :type CartWaypoints: cart array
   :return: err_code
   :rtype: int	 					

.. function:: FUNC int xyzSwitchStrat(string strat_name)
   :noindex:

   请求切换策略

   :param strat_name: 策略名称
   :type strat_name: string
   :return: err_code
   :rtype: int


.. function:: FUNC int xyzUpdateTotePose()
   :noindex:

   料箱重定位

   :param TotePose: 料箱位姿
   :type TotePose: pose
   :return: err_code
   :rtype: int

.. function:: FUNC int xyzUpdateObjPoseOnHand()
   :noindex:

   工件在上手的二次定位

   :return: err_code
   :rtype: int		

.. function:: FUNC int xyzUpdateObjPoseToHand()
   :noindex:

   工件不在手上的二次定位

   :param  PoseNum: 可供抓取的点数量
   :type PoseNum: int
   :param  PipeNum: pipeline编号
   :type PipeNum: int
   :param  RegNum: 注册编号
   :type RegNum: int
   :param  WaypointType: 轨迹点类型
   :type WaypointType: int array
   :param  JointWaypoints: joints类型轨迹点
   :type JointWaypoints: joints array
   :param  CartWaypoints: cart类型轨迹点
   :type CartWaypoints: cart array
   :return: err_code
   :rtype: int	 

.. function:: FUNC int xyzGetObjPoseType()
   :noindex:

   获取工件姿态类型

   :param PoseType: 工件姿态类型
   :type PoseType: int
   :return: err_code
   :rtype: int

.. function:: FUNC int xyzResetPalletStatus()
   :noindex:
   
   重置工业码垛状态

   :return: err_code
   :rtype: int	

.. function:: FUNC int xyzCalculateGraspPose(int ws_id)
   :noindex:

   计算抓取位姿

   :param  ws_id: 工作空间 id
   :type ws_id: int
   :param  PoseNum: 可供抓取的点数量
   :type PoseNum: int
   :param  PipeNum: pipeline编号
   :type PipeNum: int
   :param  RegNum: 注册编号
   :type RegNum: int
   :param  GraspPose: 抓取位姿
   :type GraspPose: pose 
   :return: err_code
   :rtype: int	 	

.. function:: FUNC int xyzCalculateObjectPose(int ws_id)
   :noindex:

   计算物体位姿

   :param  ws_id: 工作空间 id
   :type ws_id: int
   :param  PoseNum: 可供抓取的点数量
   :type PoseNum: int
   :param  PipeNum: pipeline编号
   :type PipeNum: int
   :param  RegNum: 注册编号
   :type RegNum: int
   :param  ObjectPose: 物体位姿
   :type ObjectPose: pose 
   :return: err_code
   :rtype: int