跳到主要内容

KUAVO Humanoid SDK

Version License Supported Python Versions

KUAVO Humanoid SDK是一个用于控制KUAVO人形机器人的综合Python SDK。该SDK提供了机器人状态管理、手臂和头部控制以及末端执行器操作的接口。它可以通过局域网传输数据以控制机器人，只要安装相应Python包即可。 该SDK旨在简化机器人控制的复杂性，使开发者能够快速实现各种机器人应用。

注意: 该SDK目前仅支持ROS1，暂不支持ROS2。

image

Features 特性​

Robot State Management 机器人状态管理​

  • IMU data: acceleration, angular velocity, euler angles
    IMU 数据: 加速度、角速度、欧拉角
  • Joint/motor states: position, velocity, torque
    关节/电机状态: 位置、速度、扭矩
  • Torso state: position, orientation, velocity
    躯干状态: 位置、方向、速度
  • Odometry information
    里程计信息
  • End-effector states:
    • Gripper (LejuClaw): position, velocity, torque, grasp status
      夹爪 (LejuClaw): 位置、速度、扭矩、抓握状态
    • Dexterous hand (QiangNao): position, velocity, torque
      灵巧手 (QiangNao): 位置、速度、扭矩
    • Touch Dexterous hand (QiangNao_Touch): position, velocity, torque, touch state
      触觉灵巧手 (QiangNao_Touch): 位置、速度、扭矩、触觉状态
    • End-effector position and orientation
      末端执行器位置和方向
  • Motion states: stand, walk, step_control, trot
    运动状态: 站立、行走、步态控制、小跑

Motion Control 运动控制​

  • Arm Control 手臂控制

    • Joint position control
      关节位置控制
    • End-effector 6D control via inverse kinematics
      通过逆运动学控制末端执行器 6D
    • Forward kinematics (FK) for computing end-effector pose
      正向运动学 (FK) 用于计算末端执行器姿态
    • Keyframe sequence control for complex motions
      关键帧序列控制复杂动作

  • End-effector Control 末端执行器控制

    • Gripper control (position control with configurable velocity and torque)
      夹爪控制 (可配置速度和扭矩的位置控制)
    • Dexterous hand control 灵巧手控制
      • Position control
        位置控制
      • Pre-defined hand gestures (OK, 666, fist, etc.)
        预定义手势 (OK、666、拳头等)

  • Head Control 头部控制

    • Position control
      位置控制

  • Torso Control 躯干控制

    • Height control (squatting)
      高度控制 (下蹲)
    • Forward/backward tilt control
      前倾/后倾控制

  • Dynamic Motion Control 动态运动控制

    • Stance
      站立
    • Trot
      小跑
    • Walking (xy and yaw velocity control)
      行走 (xy 和偏航速度控制)
    • Stepping (gait switching)
      步态切换

Robot Basic Information 机器人基本信息​

  • Robot type: kuavo
    机器人类型: kuavo
  • Robot version
    机器人版本
  • End-effector type
    末端执行器类型
  • Joint names
    关节名称
  • Total degrees of freedom: 28
    总自由度: 28
  • Arm degrees of freedom: 7 per arm
    手臂自由度: 每只手臂 7 个
  • Head degrees of freedom: 2
    头部自由度: 2
  • Leg degrees of freedom: 12
    腿部自由度: 12

Installation 安装​

注意：目前该 SDK 有两个版本，稳定版和测试版。它们的区别是：

  • 稳定版本：对应于 kuavo-ros-opensource 的 master 分支所提供的功能。
  • 测试版本：比正式版本更激进，同时提供了更丰富的功能，对应于 kuavo-ros-opensource 的 beta 分支所提供的功能。

友好的提醒：请明确您需要安装的版本。如果您的 SDK 版本与 kuavo-ros-opensource 不匹配，某些功能可能不可用。

安装命令​

  • 安装最新稳定版本：
    pip install kuavo-humanoid-sdk-ws
  • 安装最新测试版本：
    pip install --pre kuavo-humanoid-sdk-ws
  • 本地开发安装（可编辑模式）：
    cd src/kuavo_humanoid_websocket_sdk  
    chmod +x install.sh  
    ./install.sh

Upgrade Instructions 升级说明​

升级前，您可以使用以下命令检查当前已安装的版本：

pip show kuavo-humanoid-sdk

输出示例：

Name: kuavo-humanoid-sdk  
Version: 1.1.6  
...

注意：如果版本号包含字母 b，则表示是测试版，例如 版本：0.1.2b113。

升级场景​

  1. 从稳定版本升级到最新稳定版本：
    pip install --upgrade kuavo-humanoid-sdk-ws
  2. 从测试版升级到最新稳定版：
    pip install --upgrade --force-reinstall kuavo-humanoid-sdk-ws
  3. 从稳定版/测试版升级到最新测试版：
    pip install --upgrade --pre kuavo-humanoid-sdk-ws

Quick Start 快速入门​

在运行任何代码之前，请确保通过以下命令之一启动机器人：

  • 对于模拟：

    roslaunch humanoid_controllers load_kuavo_mujoco_sim.launch

  • 对于真实机器人：

    roslaunch humanoid_controllers load_kuavo_real.launch

  • 启动Websocket服务器（如果使用Websocket通信）： 详细说明请参考Websockets通信文档

Documentation 文档​

文档以两种格式提供：

  • HTML 格式：需要通过运行脚本生成。
  • Markdown 格式：直接查看。

生成文档：

cd <kuavo-ros-opensource>/src/kuavo_humanoid_websocket_sdk
chmod +x gen_docs.sh
./gen_docs.sh

Examples 示例​

在运行任何代码示例之前，请确保启动机器人。

示例代码链接：

License 许可证​

此项目根据 MIT 许可证授权 - 详细内容请参阅 LICENSE 文件。

Contact & Support 联系方式与支持​