Skip to content

安装与环境配置

本文基于 Revo 3 SDK 2.0 系列。dev 阶段可能提供 2.0.0-rc.N 预发布包,文档统一按 2.0 或 2.x 描述;合并正式站前再冻结准确版本。对外示例仓库名为 brainco-revo3-sdk,Python wheel 包名为 bc-revo3-sdk

支持范围

语言与工具链

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

操作系统与架构

平台要求
Linuxx86_64 或 aarch64;发布 wheel 使用 manylinux_2_31
macOSx86_64 或 Apple Silicon;可用软件包请以正式发布信息为准
WindowsWindows 10/11 x86_64

获取 SDK 与示例代码

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

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

克隆 2.x 示例时请显式选择 dev 分支:

bash
git clone --branch dev --single-branch https://github.com/BrainCoTech/brainco-revo3-sdk.git
bash
git clone --branch dev --single-branch git@github.com:BrainCoTech/brainco-revo3-sdk.git

版本兼容性提示

Revo 3 SDK v2.x 采用全新的架构与对象模型,与旧版 v1.x 不兼容。请使用 dev 分支或 SDK 包中配套的 2.x 示例代码,避免参考 main 分支的历史 1.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

正式版 wheel 发布后,请通过 BrainCo 发布渠道获取与操作系统和 CPU 架构一致的文件:

平台Wheel 文件名
Ubuntu/Linux x86_64bc_revo3_sdk-2.0.0-cp310-abi3-manylinux_2_31_x86_64.whl
Ubuntu/Linux aarch64bc_revo3_sdk-2.0.0-cp310-abi3-manylinux_2_31_aarch64.whl
Windows x86_64bc_revo3_sdk-2.0.0-cp310-abi3-win_amd64.whl

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

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

安装后核对版本:

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

输出应属于 2.0 系列,例如 2.0.0-rc.32.0.0-rc.4 或正式版 2.0.0。上述 wheel 尚未通过公开 OSS 地址或 PyPI 上线;请联系技术支持确认获取渠道,不要使用公开的 1.5.1 包替代。

解压获取到的 2.x 示例包后,可安装完整 Python 示例依赖:

bash
python -m pip install ./examples/python

examples/python/pyproject.toml 约束 bc-revo3-sdk>=2.0.0,<3,并会安装 GUI 和示例依赖。仅使用 SDK 的项目无需安装这些额外依赖。

准备 C/C++ SDK

C/C++ 项目需要同一版本 SDK 包中的动态库和公开头文件。解压获取到的 SDK 包后,构建随附示例:

bash
make -C examples/c

公开接口文件:

文件用途
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 只读取设备和健康状态,不会发送运动指令。

帮助