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

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

注意： 由于elite 工控机主控程序不支持设置ACC与ZONE，故ACC与ZONE需要在下位机 ``xyz_motion.jbi`` 中修改。

elite工控机主控定义了一些全局变量，不允许用户使用，占用情况如下(``xyz_motion.jbi``)：
另请注意： elite机器人的各种类型寄存器（包括tool寄存器），在使用前均需要打开，否则无法读写。

+---------------------------------------------------+
| B字节型                                           |
+-----------+------------------+--------------------+
| 地址      | 含义             | 说明(是否用户可写) |
+-----------+------------------+--------------------+
| B005~B009 | 内部使用         | x                  |
+-----------+------------------+--------------------+
| B018      | 读写标志位       | x                  |
+-----------+------------------+--------------------+
| B019      | 运动标志位       | x                  |
+-----------+------------------+--------------------+
| B020      | 运动角速度       | x                  |
+-----------+------------------+--------------------+

+-----------------------------------------------------+
| I整数型                                             |
+-----------+--------------------+--------------------+
| 地址      | 含义               | 说明(是否用户可写) |
+-----------+--------------------+--------------------+
| I010      | 运动线速度         | x                  |
+-----------+--------------------+--------------------+



+-------------------------------------------------+
| P位置型                                         |
+-----------+----------------+--------------------+
| 地址      | 含义           | 说明(是否用户可写) |
+-----------+----------------+--------------------+
| P001      | 接收的点       | x                  |
+-----------+----------------+--------------------+
| P002      | 发送的点       | x                  |
+-----------+----------------+--------------------+
| P003      | 中转的点       | x                  |
+-----------+----------------+--------------------+


+-------------------------------------------------+
| V位置型                                         |
+-----------+----------------+--------------------+
| 地址      | 含义           | 说明(是否用户可写) |
+-----------+----------------+--------------------+
| V001      | 接收的点       | x                  |
+-----------+----------------+--------------------+
| V002      | 接收的点       | x                  |
+-----------+----------------+--------------------+
| V003      | 发送的点       | x                  |
+-----------+----------------+--------------------+



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

elite机械臂主控定义了一些全局变量，不允许用户占用，占用情况如下(如 ``cart_move_basic.jbi``)：


+-------------------------------------------------+
| B字节型                                         |
+-----------+----------------+--------------------+
| 地址      | 含义           | 说明(是否用户可写) |
+-----------+----------------+--------------------+
| B001      | 通讯标志位     | x                  |
+-----------+----------------+--------------------+
| B002      | 发送命令标志位 | x                  |
+-----------+----------------+--------------------+
| B003      | 错误代码       | x                  |
+-----------+----------------+--------------------+
| B004      | 字符串编号     | x                  |
+-----------+----------------+--------------------+
| B011~B017 | 预留，请勿使用 | x                  |
+-----------+----------------+--------------------+
| B021~B050 | 轨迹点类型     | x                  |
+-----------+----------------+--------------------+

+-----------------------------------------------------------------------+
| I整数型                                                               |
+-----------+--------------------------------------+--------------------+
| I011~I021 | 自定义请求发送整数                   | x                  |
+-----------+--------------------------------------+--------------------+
| I021~I030 | 自定义请求接收整数                   | x                  |
+-----------+--------------------------------------+--------------------+

+-------------------------------------------------+
| P位置型                                         |
+-----------+----------------+--------------------+
| 地址      | 含义           | 说明(是否用户可写) |
+-----------+----------------+--------------------+
| P001      | 接收的点       | x                  |
+-----------+----------------+--------------------+
| P002      | 发送的点       | x                  |
+-----------+----------------+--------------------+
| P011~P040 | 轨迹点         | read only          |
+-----------+----------------+--------------------+

+-------------------------------------------------+
| V位置型                                         |
+-----------+----------------+--------------------+
| 地址      | 含义           | 说明(是否用户可写) |
+-----------+----------------+--------------------+
| V001      | 接收的点       | x                  |
+-----------+----------------+--------------------+
| V003      | 发送的点       | x                  |
+-----------+----------------+--------------------+
| V011~V040 | 轨迹点         | read only          |
+-----------+----------------+--------------------+



.. function:: 切换应用
   :noindex:

   .. code-block:: 

      SET B002 501
      SET B004 1
      CALL JOB:xyz_send_recv

   输入：

   - B004：为后台字符串序号，为应用名称

   输出：

   - B003：返回 error code


.. function:: 切换流图
   :noindex:
   
   .. code-block:: 

      SET B002 502
      SET B004 1
      CALL JOB:xyz_send_recv
   

   输入：

   - B004：为后台字符串序号，为流图名称

   输出：

   - B003：返回 error code   


.. function:: 切换工具
   :noindex:
   
   .. code-block:: 

      SET B002 503
      SET B004 1
      CALL JOB:xyz_send_recv

   输入：

   - B004：为后台字符串序号，为工具名称

   输出：

   - B003：返回 error code  


.. function:: 请求拍照
   :noindex:
   
   .. code-block:: 

      SET B002 504
      SET B012 0
      CALL JOB:xyz_send_recv

   输入：

   - B012：视觉服务id

   输出：

   - B003：返回 error code  
   - B013：返回 token		


.. function:: 获取拍照结果
   :noindex:
   
   .. code-block::  

      SET B002 505
      SET B013 0
      CALL JOB:xyz_send_recv

   输入：

   - B013: token值
  
   输出：

   - B003：返回 error code  


.. function:: 拍照
   :noindex:
   
   .. code-block:: 

      SET B002 506
      SET B012 0
      CALL JOB:xyz_send_recv

   输入：

   - B012：视觉服务id

   输出：

   - B003：返回 error code  


.. function:: 请求抓取目标点位
   :noindex:
   
   .. code-block:: 

      SET B002 507
      SET B011 0
      CALL JOB:xyz_send_recv

   输入：

   - B011：工作空间id

   输出：

   - B003：返回 error code  


.. function:: 获取抓取目标点位
   :noindex:
   
   .. code-block:: 

      SET B002 508
      SET B013 0
      CALL JOB:xyz_send_recv


   输入：

   - B013：token值

   输出：

   - V001：目标点位姿
   - B014：当前有多少个可供抓取的点
   - B015：pipeline文件number值
   - B016：用到的注册文件的注册number值
   - B003：返回 error code    


.. function:: 请求物体位姿
   :noindex:
   
   .. code-block:: 

      SET B002 509
      SET B011 0
      CALL JOB:xyz_send_recv

   输入：

   - B011：工作空间id

   输出：

   - B013：返回的 token
   - B003：返回 error code 


.. function:: 获取物体位姿
   :noindex:
   
   .. code-block:: 

      SET B002 510
      SET B013 0
      CALL JOB:xyz_send_recv

   输入：

   - B013：工件位姿 token 

   输出：

   - V001：物体位姿
   - B014：当前物体位姿个数
   - B017：物体姿态类型
   - B003：返回 error code 


.. function:: 重置任务
   :noindex:
   
   .. code-block:: 

      SET B002 511
      CALL JOB:xyz_send_recv

   输出：

   - B003：返回 error code    


.. function:: 发送机械臂当前角度
   :noindex:

   .. code-block:: 

      SET B002 512
      SET P002 0,0,0,0,0,0
      CALL JOB:xyz_send_recv
   
   输入：

   - P002：机器人当前角度

   输出：

   - B003：返回 error code 


.. function:: 发送机械臂当前笛卡尔位姿
   :noindex:
   
   .. code-block:: 

      SET B002 513
      SET V003 0,0,0,0,0,0
      CALL JOB:xyz_send_recv
   
   输入：

   - V003：机器人当前笛卡尔位姿

   输出：

   - B003：返回 error code  


.. function:: 发送机械臂当前扩展轴位置
   :noindex:
   
   .. code-block:: 

      SET B002 514
      SET P002 0,0,0,0,0,0
      CALL JOB:xyz_send_recv
   
   输入：

   - P002：机器人当前角度

   输出：

   - B003：返回 error code   


.. function:: 请求pick动作规划
   :noindex:

   .. code-block:: 

      SET B002 515
      CALL JOB:xyz_send_recv

   输出：

   - B003：返回 error code  


.. function:: 请求place动作规划
   :noindex:

   .. code-block:: 

      SET B002 516
      CALL JOB:xyz_send_recv

   输出：

   - B003：返回 error code 


.. function:: 请求pick和place规划
   :noindex:
   
   .. code-block:: 

      SET B002 517
      SET B011 0
      CALL JOB:xyz_send_recv

   输入：

   - B011: 工作空间id
   
   输出：

   - B003：返回 error code  


.. function:: 获取取料入框轨迹
   :noindex:
   
   .. code-block:: 

      SET B002 518
      SET B011 0
      CALL JOB:xyz_send_recv

   输入：

   - B011: 工作空间id
   
   输出：

   - B003：返回 error code  
   - B015：pipeline文件number值
   - B016：用到的注册文件的注册number值
   - 轨迹点


.. function:: 获取取料出框轨迹
   :noindex:
   
   .. code-block:: 

      SET B002 519
      SET B011 0
      CALL JOB:xyz_send_recv

   输入：

   - B011: 工作空间id
   
   输出：

   - B003：返回 error code  
   - B015：pipeline文件number值
   - B016：用到的注册文件的注册number值
   - 轨迹点


.. function:: 获取放料入框轨迹
   :noindex:
   
   .. code-block:: 

      SET B002 520
      SET B011 0
      CALL JOB:xyz_send_recv

   输入：

   - B011: 工作空间id
   
   输出：

   - B003：返回 error code  
   - B015：pipeline文件number值
   - B016：用到的注册文件的注册number值
   - 轨迹点


.. function:: 获取放料出框轨迹
   :noindex:
   
   .. code-block:: 

      SET B002 521
      SET B011 0
      CALL JOB:xyz_send_recv

   输入：

   - B011: 工作空间id
   
   输出：

   - B003：返回 error code  
   - B015：pipeline文件number值
   - B016：用到的注册文件的注册number值
   - 轨迹点


.. function:: 请求切换策略
   :noindex:
   
   .. code-block:: 

      SET B002 522
      SET B004 1
      CALL JOB:xyz_send_recv

   输入：

   - B004：为后台字符串序号，为策略名称

   输出：

   - B003：返回 error code  


.. function:: 料箱重定位
   :noindex:
   
   .. code-block::    

      SET B002 523
      CALL JOB:xyz_send_recv

   输出：

   - V001：料框位姿
   - B003：返回 error code


.. function:: 工件在上手的二次定位
   :noindex:
   
   .. code-block::

      SET B002 524
      CALL JOB:xyz_send_recv

   输出：

   - B003：返回 error code	


.. function:: 工件不在手上的二次定位
   :noindex:
   
   .. code-block::

      SET B002 525
      CALL JOB:xyz_send_recv
      ' 随后可以直接调用轨迹执行
      CALL JOB:xyz_exectraj

   输出：

   - B003：返回 error code  
   - B015：pipeline文件number值
   - B016：用到的注册文件的注册number值
   - 轨迹点


.. function:: 获取工件姿态类型
   :noindex:
   
   .. code-block::

      SET B002 526
      CALL JOB:xyz_send_recv

   输出：

   - B003：返回 error code	
   - B017：工件姿态类型	


.. function:: 重置工业码垛状态
   :noindex:
   
   .. code-block::

      SET B002 527
      CALL JOB:xyz_send_recv

   输出：

   - B003：返回 error code


.. function:: 切换工件
   :noindex:
   
   .. code-block::
      
      SET B002 528
      SET B004 0
      SET B011 0
      CALL JOB:xyz_send_recv


   输入：

   - B004：字符串序号，工件名称
   - B011：工作空间id

   输出：

   - B003：返回 error code


.. function:: 计算抓取目标点位
   :noindex:
   
   该指令等价于 请求抓取目标点位 + 获取抓取目标点位

   .. code-block:: 

      SET B002 529
      SET B011 0
      CALL JOB:xyz_send_recv

   输入：

   - B011：工作空间id

   输出：

   - V001：目标点位姿
   - B014：当前有多少个可供抓取的点
   - B015：pipeline文件number值
   - B016：用到的注册文件的注册number值
   - B003：返回 error code 


.. function:: 获取物体位姿
   :noindex:
   
   .. code-block:: 

      SET B002 530
      SET B011 0
      CALL JOB:xyz_send_recv

   输入：

   - B011：工作空间id

   输出：

   - V001：物体位姿
   - B014：当前物体位姿个数
   - B017：物体姿态类型
   - B003：返回 error code