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

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

.. function::  xyzSwitchApp(app_id)
   :noindex:

   切换应用

   :param app_id: 应用名称
   :type app_id: string
   :return: err_code
   :rtype: INT

.. function:: xyzSwitchFlow(flow_name)
   :noindex:

   切换任务

   :param flow_name: 任务 id
   :type flow_name: string
   :return: err_code
   :rtype: INT

.. function:: xyzSwitchTool(tool_id)
   :noindex:

   切换工具

   :param tool_id: 工具名称
   :type tool: string
   :return: err_code
   :rtype: INT

.. function:: xyzReqCapImg(vision_service_id)
   :noindex:

   请求拍照

   :param  vision_service_id: 视觉服务 id
   :type vision_service_id: INT
   :return: err_code 错误代码

            token 请求拍照结果时使用的 token

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

   获取拍照结果

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

.. function:: xyzCapImg(vision_service_id)
   :noindex:

   拍照

   :param  vision_service_id: 需要进行拍照操作的视觉服务 id
   :type vision_service_id: INT
   :return: err_code
   :rtype: INT

.. function:: xyzReqGraspPose(workspace_id)
   :noindex:

   请求抓取位姿

   :param  workspace_id: 需要获取抓取点位的工作空间id
   :type workspace_id: INT
   :return: err_code 错误代码

            token 返回的用于获取目标点位时使用的token


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

   获取抓取位姿

   :param  token: 求抓取目标点位时返回的token
   :type token: INT
   :return: err_code 错误代码

            grasp_pose 抓取位姿

            grasp_pose_num 可供抓取的点数量

            pipeline_num pipeline文件number

            register_num 用到的注册文件的注册number

.. function:: xyzReqObjPose(workspace_id)
   :noindex:

   请求物体位姿

   :param  workspace_id: 需要获取物体位姿的工作空间id
   :type workspace_id: INT
   :return: err_code 错误代码

            obj_token 物体位姿识别的token

.. function:: xyzGetObjPose(self, token)
   :noindex:

   获取物体位姿

   :param  token: 请求物体位姿时得到的token
   :type token: INT

   :return: err_code 错误代码

            obj_pose 物体位姿

            obj_pose_num 物体数量

            obj_pose_type 当前返回的物体 pose 类型

.. function:: xyzResetTask()
   :noindex:

   重置任务

   :return: err_code
   :rtype: INT

.. function:: xyzSendCurrentJoints()
   :noindex:

   发送机械臂当前角度：j1~j6: 机械臂当前的角度信息，如果机械臂轴数小于6轴，则需要对应位置补零，依旧发送六个数。

   :return: err_code
   :rtype: INT

.. function:: xyzSendCurrentPose()
   :noindex:

   发送机械臂法兰当前位姿

   :return: err_code
   :rtype: INT

.. function:: xyzSendCurrentExtJoints
   :noindex:

   发送机械臂当前扩展轴位置：j1~j6: 机械臂当前扩展轴的角度信息，如果扩展轴数不足6的,需要补零后发送六个数。

   :return: err_code
   :rtype: INT

.. function:: xyzReqPick()
   :noindex:

   请求pick动作规划

   :return: err_code
   :rtype: INT


.. function:: xyzReqPlace()
   :noindex:

   请求place动作规划

   :return: err_code
   :rtype: INT

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

   请求pick和place规划

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

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

   获取取料入框轨迹

   :param ws_id: 工作空间id
   :type ws_id: INT
   :return: err_code 错误代码

            pipeline_num pipeline文件number

            register_num 用到的注册文件的注册number

            traj_num 轨迹点数

            wp_type 轨迹点类型（数组）

            wp 轨迹点（数组）

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

   获取取料出框轨迹

   :param ws_id: 工作空间id
   :type ws_id: INT
   :return: err_code 错误代码

            pipeline_num pipeline文件number

            register_num 用到的注册文件的注册number

            traj_num 轨迹点数

            wp_type 轨迹点类型（数组）

            wp 轨迹点（数组）

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

   获取放料入框轨迹

   :param ws_id: 工作空间id
   :type ws_id: INT
   :return: err_code 错误代码

            pipeline_num pipeline文件number

            register_num 用到的注册文件的注册number

            traj_num 轨迹点数

            wp_type 轨迹点类型（数组）

            wp 轨迹点（数组）

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

   获取放料出框轨迹

   :param ws_id: 工作空间id
   :type ws_id: INT
   :return: err_code 错误代码

            pipeline_num pipeline文件number

            register_num 用到的注册文件的注册number

            traj_num 轨迹点数

            wp_type 轨迹点类型（数组）

            wp 轨迹点（数组）

.. function:: xyzSwitchStrat(strat_name)
   :noindex:

   请求切换策略

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


.. function:: xyzUpdateTotePose()
   :noindex:

   料箱重定位

   :return: err_code
            pose 料箱位姿

.. function:: xyzUpdateObjPoseOnHand()
   :noindex:

   工件在上手的二次定位

   :return: err_code
   :rtype: INT

.. function:: xyzUpdateObjPoseToHand()
   :noindex:

   工件不在手上的二次定位

   :return: err_code 错误代码

            pipeline_num pipeline文件number

            register_num 用到的注册文件的注册number

            traj_num 轨迹点数

            wp_type 轨迹点类型（数组）

            wp 轨迹点（数组）

.. function:: xyzGetObjPoseType()
   :noindex:

   获取工件姿态类型

   :return: err_code

            pose_type 姿态类型

.. function:: xyzResetPalletStatus()

   重置工业码垛状态

   :return: err_code
   :rtype: INT

.. function:: xyzSwitchItem(item_codename)

   切换工件

   :param item_codename: 工件名称
   :type item_codename: string
   :return: err_code
   :rtype: INT

.. function:: xyzCalculateGraspPose(ws_id)

   计算抓取位姿

   :param ws_id: 工作空间id
   :type ws_id: INT
   :return: err_code 错误代码

            grasp_pose 抓取位姿

            grasp_pose_num 可供抓取的点数量

            pipeline_num pipeline文件number

            register_num 用到的注册文件的注册number

.. function:: xyzCalculateObjPose(ws_id)

   计算物体位姿

   :param ws_id: 工作空间id
   :type ws_id: INT
   :return: err_code 错误代码

            obj_pose 物体位姿

            obj_pose_num 物体数量

            obj_pose_type 当前返回的物体 pose 类型