API 使用 / 快速开始

快速开始

5 分钟从零跑通机器人仿真闭环。无需真实硬件。

1. 前置环境

依赖版本要求检查方式
Python≥ 3.11python --version
Git任意较新版本git --version
LLM API KeyOpenAI / Azure / 兼容服务前往对应平台注册获取

2. 安装

克隆仓库并以可编辑模式安装 PhyAgentOS。

git clone https://github.com/SYSU-HCP-EAI/PhyAgentOS.git
cd PhyAgentOS
python -m venv .venv
source .venv/bin/activate
pip install -e .

预期输出:Successfully installed PhyAgentOS-0.0.5paos CLI 命令生效。

备选:Conda 方式

conda env create -f environment.yml
conda activate paos
pip install -e .

可选:安装开发依赖

pip install -e ".[dev]"
常见错误:如果 pip install -e . 失败,确认 Python 版本 ≥ 3.11,执行 python --version 检查。

3. 初始化工作区

paos onboard 创建配置文件和工作区目录,以及所有协议 Markdown 文件。

paos onboard

该命令完成三件事:

  • 创建 ~/.PhyAgentOS/config.json — 系统配置文件
  • 创建 ~/.PhyAgentOS/workspace/ — 单机工作区目录
  • 生成协议文件:ENVIRONMENT.mdEMBODIED.mdACTION.mdLESSONS.md
升级 PhyAgentOS 版本后,重新执行一次 paos onboard 可以刷新配置模板。

4. 启动系统 — 第一个闭环

打开两个终端。一个运行硬件看门狗(Track B),另一个运行 Agent(Track A)。

终端 1:启动仿真 Watchdog

cd PhyAgentOS
python hal/hal_watchdog.py --driver simulation

预期输出:

[Watchdog] Driver 'simulation' loaded
[Watchdog] Profile installed → EMBODIED.md
[Watchdog] Polling ACTION.md…

终端 2:启动 Agent

cd PhyAgentOS
paos agent

出现交互提示后,输入任务:

> 看看桌上有什么,给我把那个苹果抓过来。

你将在终端 1 看到动作执行日志,在终端 2 收到 Agent 的完成确认。

刚才发生了什么

Agent 规划动作 → Critic 校验 → 写入 ACTION.md → Watchdog 读取 → Driver 执行 → 状态回写 ENVIRONMENT.md

验证结果

打开 ~/.PhyAgentOS/workspace/ENVIRONMENT.md,你会看到更新后的场景图,苹果位置已改变。

5. 可选:Runtime 会话冒烟测试

PhyAgentOS 还有一个基于会话的运行时(SESSIONS.md → WatchdogSupervisor → policy client → target)。运行这个轻量测试来验证。

python scripts/init_runtime_workspace.py --workspace /tmp/paos_runtime_smoke
python scripts/run_runtime_watchdog.py --workspace /tmp/paos_runtime_smoke --once

预期:会话 sess_dummy_smoke 被标记为 succeeded,episode 摘要写入 /tmp/paos_runtime_smoke/artifacts/runtime/<session_id>/episode.json

6. 可选:安装 ReKep 真机插件

如果你有真实机器人臂(Dobot、Franka 等),安装 ReKep 插件实现自然语言抓取。

python scripts/deploy_rekep_real_plugin.py \
  --repo-url https://github.com/baiyu858/PhyAgentOS-rekep-real-plugin.git

安装后,使用真机驱动启动:

python hal/hal_watchdog.py --driver rekep_real

7. 下一步