一、概述

Robot API 是双臂复合机器人平台的 Python 软件开发工具包（SDK）， 提供统一、便捷的接口用于控制机械臂运动、底盘导航、视觉感知、坐标转换、末端执行器控制等全栈能力， 并支持实时状态读取、Web 远程监控与多种通信协议。

SDK 采用 分层模块化架构 设计，各功能包独立可插拔， 底层封装了 TCP Socket、串口 Modbus RTU、RS-485、USB 等通信细节， 上层应用无需关心硬件协议，通过简洁的 Python API 即可快速集成机器人控制功能。

核心特性

适用场景

• 双臂复合机器人上位机应用程序开发
• 视觉引导抓取与搬运系统集成
• 移动底盘自主导航与巡检
• 多传感器数据融合与自动化流程
• 远程 Web 监控与遥操作

系统框图

二、支持的操作系统与软件版本

操作系统

Python 版本

第三方依赖一览

基础依赖安装

# 基础依赖
pip install numpy scipy opencv-python requests

# 串口通信
pip install pyserial

# Web 服务
pip install fastapi uvicorn python-multipart websockets

# 深度学习推理
pip install ultralytics

# 相机驱动
pip install pyrealsense2

# 机械臂官方 SDK
pip install pin==3.7.0 numpy==1.24.0 scipy==1.8.0

三、SDK 结构

3.1 包目录结构

robot_api_new/                          # SDK 根目录
│
├── README.md                           # 项目总体说明文档
│
├── tianlian_arm_api/                   # ① 天链机械臂控制 API
│   ├── __init__.py                     #   包入口，导出全部公开 API
│   ├── arm_controller.py               #   机械臂控制器（核心）
│   ├── gripper_controller.py           #   钧舵 RG 夹爪 Modbus RTU 驱动
│   └── arm_sdk/                        #   官方 TCB SDK (v22.07)
│
├── head_api/                           # ② 头部舵机控制 API
│   ├── head_api.py                     #   HeadControlSDK 主类
│   ├── servo_api.py                    #   舵机控制接口
│   └── test_api.py                     #   测试脚本
│
├── camera_api/                         # ③ Intel D435 相机 API
│   ├── D435_rgb_depth.py              #   D435Camera 封装类
│   ├── camera_list.py                  #   相机列表工具
│   └── D435_API_接口对照表.md          #   接口对照文档
│
├── yunji_api/                          # ④ 云迹 WATER 底盘 API
│   ├── yunji_chassis_api.py            #   TCP 客户端封装（核心）
│   ├── yunji_demo.py                   #   演示程序
│   └── yunji_chassis_api_call_manual.md # 调用手册
│
├── leesn_lift_api/                     # ⑤ 升降轴与夹爪控制 API
│   ├── web_server.py                   #   FastAPI Web 服务（入口）
│   ├── device_manager.py               #   设备管理器
│   ├── motor_service.py                #   升降轴 Modbus 服务（核心）
│   ├── gripper_service.py             #   EG2 夹爪服务
│   ├── pgc_gripper_service.py         #   PGC 夹爪服务
│   ├── lift_client.py                  #   升降轴 HTTP 客户端
│   ├── gripper_client.py              #   夹爪 HTTP 客户端
│   ├── leesn_control.py               #   Leesn Modbus 底层驱动
│   ├── config/devices.json            #   设备配置文件
│   └── logs/                           #   运行时日志
│
├── dahuan_api/                         # ⑥ 大寰 PGC 夹爪 API
│   └── dahuan_api.py                   #   PGCGripper Modbus RTU 驱动
│
├── convert_transform_api/              # ⑦ 坐标转换 API
│   ├── convert_transform_api.py        #   CameraToBaseConverter（核心）
│   ├── coordinate_transform.example.json # 配置文件示例
│   └── coordinate_transform_usage_example.py # 使用示例
│
├── yolo_infer_api/                     # ⑧ YOLO 推理 API
│   ├── yolo_infer_api.py              #   YOLO 推理封装（核心）
│   ├── yolo_infer_config.example.json # 配置文件示例
│   └── yolo_infer_usage_example.py    # 使用示例
│
├── yolo_api/                           # ⑨ YOLO 完整推理服务
│   ├── inference/                      #   推理模块
│   │   ├── yolo_infer_core.py         #   推理核心
│   │   ├── send_camera_to_api.py      #   相机推流 HTTP 服务
│   │   └── models/                    #   模型文件
│   ├── training/                      #   训练模块
│   │   ├── train_yolov8.py            #   训练脚本
│   │   └── dataset.yaml               #   数据集配置
│   └── logs/                          #   日志
│
├── robot_web_console/                  # ⑩ 统一 Web 控制台
│   ├── web_server.py                  #   FastAPI 入口（默认 :8010）
│   ├── device_manager.py              #   设备管理器
│   ├── config/devices.json            #   设备配置
│   ├── services/                      #   设备服务层
│   │   ├── lift_serial.py            #   升降轴串口服务
│   │   ├── gripper_eg2.py            #   EG2 夹爪服务
│   │   ├── gripper_dahuan.py         #   PGC 夹爪服务
│   │   └── vacuum_stub.py            #   吸盘 Stub
│   └── logs/                          #   运行日志
│
└── 具身双臂复合机器人SDK手册.docx/pdf   # 官方 SDK 手册

3.2 模块分层

3.3 模块文件说明

3.4 通信协议总览

四、注意事项