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

kawasaki 工控机主控支持的 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    | 机械臂后台发送状态      | 支持     |
+--------+-------------------------+----------+


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

.. function:: .PROGRAM xyz_sw_app(.error_code, .$app_name)
   :noindex:

   切换应用

   :param app_name: 应用名称
   :type app_name: string
   :return: .error_code
   :rtype: num

.. function:: .PROGRAM xyz_sw_item(.error_code, .$item_name)
   :noindex:

   切换工件

   :param item_name: 工件名称
   :type obj_name: string
   :return: .error_code
   :rtype: num

.. function:: .PROGRAM xyz_sw_tool(.error_code, .$tool_name)
   :noindex:

   切换工具

   :param tool_name: 工具名称
   :type tool_name: string
   :return: .error_code
   :rtype: num

.. function:: .PROGRAM xyz_r_capimg(.error_code, .ws_id, .token)
   :noindex:

   请求拍照

   :param  ws_id: 工作空间 id
   :type ws_id: num
   :param  token: 获取拍照结果的凭据
   :type token: num
   :return: error_code
   :rtype: num			

.. function:: .PROGRAM xyz_g_capimg(.error_code, .token)
   :noindex:

   获取拍照结果

   :param  token: 请求拍照时返回的 token
   :type token: num
   :return: error_code
   :rtype: num	

.. function:: .PROGRAM xyz_capimg(.error_code)
   :noindex:

   拍照

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

.. function:: .PROGRAM xyz_r_g_pose(.error_code, .ws_id, .token)
   :noindex:

   请求抓取位姿

   :param  ws_id: 需要获取抓取点位的工作空间id
   :type ws_id: num
   :param  token: 返回的用于获取目标点位时使用的token
   :type token: num			
   :return: error_code
   :rtype: num	

.. function:: .PROGRAM xyz_g_g_pose(.error_code, .token, .pose_num, .pose_type)
   :noindex:

   获取抓取位姿

   :param  token: 请求抓取目标点位时返回的token
   :type token: num
   :param  pose_num: 可供抓取的点数量
   :type pose_num: num
   :param  pose_type: 当前返回的抓取点的 pose 类型
   :type pose_type: num
   :param  grasp_pose: 抓取位姿（全局变量）
   :type grasp_pose: XYZOAT   
   :return: error_code
   :rtype: num	

.. function:: .PROGRAM xyz_r_o_pose(.error_code, .ws_id, .token)
   :noindex:

   请求物体位姿

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


.. function:: .PROGRAM xyz_g_o_pose(.error_code, .token, .pose_num, .pose_type)
   :noindex:

   获取物体位姿

   :param  token: 请求物体位姿时得到的token
   :type token: num
   :param  pose_num: 物体数量
   :type pose_num: num
   :param  pose_type: 当前返回的物体 pose 类型
   :type pose_type: num
   :param  object_pose: 物体位姿（全局变量）
   :type object_pose: XYZOAT   
   :return: error_code
   :rtype: num	


.. function:: .PROGRAM xyz_reset_v(.error_code, .ws_id)
   :noindex:

   重置视觉

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

.. function:: .PROGRAM xyz_s_joints(.error_code, .#joints)
   :noindex:

   发送特定关节位姿

   :param joints: 需要发送的关节位姿
   :type joints: 关节位姿变量
   :return: error_code
   :rtype: num			

.. function:: .PROGRAM xyz_s_c_pose(.error_code)
   :noindex:

   发送特定笛卡尔空间位姿

   :param sending_pose: 需要发送的笛卡尔空间位姿（全局变量）
   :type sending_pose: XYZOAT
   :return: error_code
   :rtype: num

.. function:: .PROGRAM xyz_s_ext_j(.error_code, .#ext_joints)
   :noindex:

   发送特定外部轴关节位姿

   :param ext_joints: 需要发送的关节位姿
   :type ext_joints: 关节位姿变量
   :return: error_code
   :rtype: num

.. function:: .PROGRAM xyz_r_pick(.error_code)
   :noindex:

   请求pick动作规划

   :return: error_code
   :rtype: num


.. function:: .PROGRAM xyz_r_place(.error_code)
   :noindex:

   请求place动作规划

   :return: error_code
   :rtype: num

.. function:: .PROGRAM xyz_r_picpla(.error_code)
   :noindex:
   
   请求pick和place规划

   :return: error_code
   :rtype: num			

.. function:: .PROGRAM xyz_g_picin(.error_code, .pose_type, .wps_num, .wps_type[], .#jnts_traj[])
   :noindex:

   获取取料入框轨迹

   :param pose_num: 轨迹点数
   :type pose_num: num
   :param  pose_type: 轨迹点 pose 类型
   :type pose_type: num
   :param  wps_type[]: 轨迹点类型数组
   :type wps_type[]: array
   :param  jnts_traj[]: 轨迹点关节位姿数组
   :type jnts_traj[]: array
   :param  cart_traj[]: 轨迹点笛卡尔空间位姿数组（全局变量）
   :type cart_traj[]: array  
   :return: error_code
   :rtype: num			

.. function:: .PROGRAM xyz_g_picout(.error_code, .pose_type, .wps_num, .wps_type[], .#jnts_traj[])
   :noindex:

   获取取料出框轨迹

   :param pose_num: 轨迹点数
   :type pose_num: num
   :param  pose_type: 轨迹点 pose 类型
   :type pose_type: num
   :param  wps_type[]: 轨迹点类型数组
   :type wps_type[]: array
   :param  jnts_traj[]: 轨迹点关节位姿数组
   :type jnts_traj[]: array
   :param  cart_traj[]: 轨迹点笛卡尔空间位姿数组（全局变量）
   :type cart_traj[]: array  
   :return: error_code
   :rtype: num		

.. function:: .PROGRAM xyz_g_plain(.error_code, .pose_type, .wps_num, .wps_type[], .#jnts_traj[])
   :noindex:

   获取放料入框轨迹

   :param pose_num: 轨迹点数
   :type pose_num: num
   :param  pose_type: 轨迹点 pose 类型
   :type pose_type: num
   :param  wps_type[]: 轨迹点类型数组
   :type wps_type[]: array
   :param  jnts_traj[]: 轨迹点关节位姿数组
   :type jnts_traj[]: array
   :param  cart_traj[]: 轨迹点笛卡尔空间位姿数组（全局变量）
   :type cart_traj[]: array  
   :return: error_code
   :rtype: num	

.. function:: .PROGRAM xyz_g_plaout(.error_code, .pose_type, .wps_num, .wps_type[], .#jnts_traj[])
   :noindex:

   获取放料出框轨迹

   :param pose_num: 轨迹点数
   :type pose_num: num
   :param  pose_type: 轨迹点 pose 类型
   :type pose_type: num
   :param  wps_type[]: 轨迹点类型数组
   :type wps_type[]: array
   :param  jnts_traj[]: 轨迹点关节位姿数组
   :type jnts_traj[]: array
   :param  cart_traj[]: 轨迹点笛卡尔空间位姿数组（全局变量）
   :type cart_traj[]: array  
   :return: error_code
   :rtype: num					

.. function:: .PROGRAM xyz_sw_strat(.error_code, .$strat_name)
   :noindex:

   请求切换策略

   :param strat_name: 策略名称
   :type strat_name: string
   :return: error_code
   :rtype: num


.. function:: .PROGRAM xyz_u_t_pose(.error_code)
   :noindex:

   料箱重定位

   :param tote_pose: 料箱位姿(全局变量)
   :type tote_pose: pose
   :return: error_code
   :rtype: num

.. function:: .PROGRAM xyz_u_obj_oh(.error_code)
   :noindex:

   工件在上手的二次定位

   :return: error_code
   :rtype: num		

.. function:: .PROGRAM xyz_u_obj_th(.error_code, .pose_type, .wps_num, .wps_type[], .#jnts_traj[], .cart_traj[])
   :noindex:

   工件不在手上的二次定位，获取二次抓取的轨迹

   :param pose_num: 轨迹点数
   :type pose_num: num
   :param  pose_type: 轨迹点 pose 类型
   :type pose_type: num
   :param  wps_type[]: 轨迹点类型数组
   :type wps_type[]: array
   :param  jnts_traj[]: 轨迹点关节位姿数组
   :type jnts_traj[]: array
   :param  cart_traj[]: 轨迹点笛卡尔空间位姿数组（全局变量）
   :type cart_traj[]: array  
   :return: error_code
   :rtype: num

.. function:: .PROGRAM xyz_g_obj_pt(.error_code, .pose_type)
   :noindex:

   获取工件姿态类型

   :param pose_type: 工件姿态类型
   :type pose_type: num
   :return: error_code
   :rtype: num

.. function:: .PROGRAM xyz_reset_ps(.error_code)
   :noindex:

   重置工业码垛状态

   :return: error_code
   :rtype: num		

.. function:: .PROGRAM xyz_exectraj(.cmd, .pose_type, .wps_num, .wps_type[], .#jnts_traj[])
   :noindex:
   
   用于执行一段轨迹，注意所有笛卡尔空间位姿与轨迹点皆为全局变量

   :param pose_num: 轨迹点数
   :type pose_num: num
   :param  pose_type: 轨迹点 pose 类型
   :type pose_type: num
   :param  wps_type[]: 轨迹点类型数组
   :type wps_type[]: array
   :param  jnts_traj[]: 轨迹点关节位姿数组
   :type jnts_traj[]: array
   :param  cart_traj[]: 轨迹点笛卡尔空间位姿数组（全局变量）
   :type cart_traj[]: array  
   :return: error_code
   :rtype: num