Skip to content

安装与环境配置 ​

本文适用于 Revo 3 SDK 2.3.0。公开源码示例仅位于 brainco-revo3-sdk 仓库;bc-revo3-sdk 是可安装的 Python wheel 分发包名,不是公开源码仓库。

2.3.0 新增支持固件上的显式整手控制模式读写,原有 MIT 指令接口保持不变。旧固件继续使用原控制入口,不调用新增模式接口;详见整手控制模式说明。触觉布局和 Linux glibc 2.31 支持沿用 2.2.1 行为。下方命令固定到配套示例提交,避免后续主分支更新导致版本混用。

支持范围 ​

语言与工具链 ​

语言要求
Python3.10 或更高版本;发布 wheel 使用 cp310-abi3
C++支持 C++17 或更高版本的编译器

操作系统与架构 ​

平台要求
Linuxx86_64 或 aarch64;glibc 2.31 或更新版本(如 Ubuntu 20.04);发布 wheel 使用 manylinux_2_31
macOSApple Silicon arm64;Intel x86_64 仅提供尽力兼容,不作为正式验证范围
WindowsWindows 10/11 x86_64

获取 SDK 与示例代码 ​

Revo 3 SDK v2.x 的 Python wheel、C/C++ 头文件、动态库及随附示例包请通过 BrainCo 官方渠道 获取。

如需在线查看 2.x 开源示例程序与独立工具,请访问对外的 brainco-revo3-sdk 示例仓库。

克隆正式示例:

bash
git clone https://github.com/BrainCoTech/brainco-revo3-sdk.git
cd brainco-revo3-sdk
git checkout cbf39e7c795421cb81d5a75c7dd8db5b9fa434e4
bash
git clone git@github.com:BrainCoTech/brainco-revo3-sdk.git
cd brainco-revo3-sdk
git checkout cbf39e7c795421cb81d5a75c7dd8db5b9fa434e4

版本兼容性提示

Revo 3 SDK v2.x 采用全新的架构与对象模型,与旧版 v1.x 不兼容。请使用正式示例仓库或 SDK 包中配套的 2.x 示例代码。

安装 Python SDK ​

先创建 Python 3.10 或更高版本的独立虚拟环境:

bash
python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
powershell
py -3.10 -m venv .venv
.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip

从 PyPI 安装正式版:

bash
python -m pip install "bc-revo3-sdk==2.3.0"

也可以通过 BrainCo 发布渠道获取与操作系统和 CPU 架构一致的 wheel:

平台Wheel 文件名
Ubuntu/Linux x86_64bc_revo3_sdk-2.3.0-cp310-abi3-manylinux_2_31_x86_64.whl
Ubuntu/Linux aarch64bc_revo3_sdk-2.3.0-cp310-abi3-manylinux_2_31_aarch64.whl
macOS Apple Siliconbc_revo3_sdk-2.3.0-cp310-abi3-macosx_11_0_arm64.whl
Windows x86_64bc_revo3_sdk-2.3.0-cp310-abi3-win_amd64.whl

下载完成后,从 wheel 所在目录安装:

bash
python -m pip install ./bc_revo3_sdk-2.3.0-cp310-abi3-*.whl

安装后核对版本:

bash
python -c "from bc_revo3_sdk import main_mod as sdk; print(sdk.get_sdk_version())"

输出必须为 2.3.0。头文件、动态库、Python wheel 和示例不得混用不同 SDK 版本。

在公开示例仓库根目录安装 Python 示例依赖:

bash
python -m pip install ./python
# Optional GUI dependencies
python -m pip install "./python[gui]"

python/pyproject.toml 约束 bc-revo3-sdk>=2.3.0,<3,并安装示例依赖;GUI 依赖需要单独选择 gui extra。仅使用 SDK 的项目无需安装这些额外依赖。

准备 C/C++ SDK ​

C/C++ 项目需要同一版本 SDK 包中的动态库和公开头文件。在公开示例仓库根目录下载 SDK 并构建示例:

bash
bash download-lib.sh
make -C c

Linux 默认下载包含 libusb、libudev 的 portable 包。这两个第三方运行库也可由系统包管理器提供;已安装兼容系统库的环境可选择不携带它们的 system 包:

bash
# Debian / Ubuntu
sudo apt-get install libusb-1.0-0 libudev1
bash download-lib.sh --system-deps
make -C c

下载脚本先检查动态依赖,缺失时终止并保留原有安装;不会安装或覆盖系统库。两种模式都保留 SDK 与第三方许可。此选项只影响 C/C++ 分发,不改变 Python wheel 的依赖打包方式。

公开接口文件:

文件用途
dist/include/revo3-sdk.hC11 兼容的 C ABI
dist/include/revo3/revo3.hppC++17 RAII 包装层

C++ 项目应包含 revo3/revo3.hpp 并使用 revo3::Manager。纯 C 或跨语言绑定使用 revo3-sdk.h。头文件、动态库和 Python 包不得混用不同 SDK 版本。

Linux 设备权限 ​

串口通常要求当前用户属于 dialout 组:

bash
sudo usermod -a -G dialout "$USER"

重新登录后检查权限是否生效:

bash
id
ls -l /dev/ttyUSB0

CAN 设备还需要相应驱动和系统网络接口配置。具体要求取决于使用的 CAN FD 适配器。

下一步 ​

安装完成后运行快速开始。默认 quickstart 只读取设备和健康状态,不会发送运动指令。

帮助