Kachaka API 客户端使用指南：全面掌握机器人控制接口

概述

Kachaka API 客户端库为开发者提供了一套简洁高效的接口，用于控制Kachaka机器人完成各种任务。该库封装了底层的gRPC通信细节，使开发者能够通过简单的Python方法调用来实现复杂的机器人操作。

环境准备

在使用Kachaka API客户端前，需要确保已安装必要的依赖库：

%pip install -q matplotlib numpy
import matplotlib.pyplot as plt
import numpy as np
from IPython.display import Image, display

这些可视化库虽然不是必须的，但在处理机器人传感器数据或地图信息时非常有用。

客户端初始化

创建Kachaka API客户端非常简单：

import kachaka_api
client = kachaka_api.KachakaApiClient()

如果需要从外部设备连接机器人，可以指定机器人的IP地址和端口：

client = kachaka_api.KachakaApiClient("<机器人IP地址>:26400")

机器人信息获取

基础信息查询

# 获取机器人序列号
serial_number = client.get_robot_serial_number()

# 获取软件版本信息
version_info = client.get_robot_version()

这些信息对于设备管理和故障排查非常有用。

环境信息管理

位置与家具信息

# 获取所有目的地信息
locations = client.get_locations()

# 获取默认目的地ID
default_loc_id = client.get_default_location_id()

# 获取所有家具信息
shelves = client.get_shelves()

# 获取当前载具的家具ID
current_shelf_id = client.get_moving_shelf_id()

位置和家具信息包含ID、名称和位姿(位置和朝向)数据，位姿单位是米(m)和弧度(rad)。

机器人控制命令

基本移动控制

# 移动家具到指定位置
client.move_shelf("S01", "L01")

# 使用名称而非ID进行操作(需先更新解析器)
client.update_resolver()
client.move_shelf("书架", "餐厅")

# 返回家具到存储位置
client.return_shelf("S01")

# 放下当前载具的家具
client.undock_shelf()

导航功能

# 移动到指定位置
client.move_to_location("L01")

# 返回充电站
client.return_home()

# 载入当前前方的家具
client.dock_shelf()

# 移动到指定位置并载入任意家具
client.dock_any_shelf_with_registration("L01", False)

低级运动控制

# 指定坐标移动
client.move_to_pose(0.5, 0.0, 0)

# 直线移动
client.move_forward(0.5)  # 前进0.5米
client.move_forward(-0.4, speed=0.3)  # 以0.3m/s速度后退0.4米

# 原地旋转
import math
client.rotate_in_place(math.pi)  # 旋转180度

# 位置校准
client.localize()

命令管理与状态监控

命令控制

# 取消当前命令
client.cancel_command()

# 检查命令执行状态
is_running = client.is_command_running()

# 获取当前执行的命令
current_command = client.get_running_command()

# 获取最后命令结果
last_result = client.get_last_command_result()

# 获取命令历史
history = client.get_history_list()

等待控制

# 进入等待状态30秒
client.lock(30.0)

# 在等待结束后执行语音(不取消等待)
client.speak("等待状态已解除", cancel_all=False)

# 手动解除等待
client.proceed()

高级功能

快捷命令

# 获取所有快捷命令
shortcuts = client.get_shortcuts()

# 执行快捷命令
shortcut_id = min(shortcuts.keys())
client.start_shortcut_command(shortcut_id, True)

系统设置

# 重置家具位置
client.reset_shelf_pose("S01")

# 设置自动充电
client.set_auto_homing_enabled(True)

# 音量控制
current_volume = client.get_speaker_volume()  # 获取当前音量(0-10)
client.set_speaker_volume(10)  # 设置最大音量

手动控制模式

# 启用手动控制(60秒后自动关闭)
client.set_manual_control_enabled(True)

# 检查手动控制状态
is_manual = client.get_manual_control_enabled()

# 发送速度指令
for i in range(100):
    client.set_robot_velocity(0.0, 0.3)  # 原地旋转

传感器数据获取

# 获取电池信息(电量百分比, 充电状态)
battery_level, charging_status = client.get_battery_info()

充电状态为1表示正在充电，2表示正在放电。

最佳实践建议

1. 错误处理：所有API调用都应添加适当的异常处理，特别是移动相关命令
2. 状态验证：在执行关键操作前，先检查机器人当前状态
3. 资源管理：长时间不使用时，应让机器人返回充电站
4. 日志记录：记录重要操作和结果，便于问题排查
5. 用户反馈：通过语音或状态显示为用户提供操作反馈

通过合理组合这些API，开发者可以实现复杂的机器人自动化流程，如自动巡逻、物品搬运等应用场景。