Installation and environment

This page targets the Revo 3 SDK 2.0 series. Dev-stage packages may use a 2.0.0-rc.N prerelease version while the documentation uses 2.0 or 2.x; the exact version will be frozen before the documentation is merged into the production site. The public example repository is brainco-revo3-sdk, while the Python wheel package is bc-revo3-sdk.

Supported environment

Languages and toolchains

Language	Requirement
Python	3.10 or later; release wheels use cp310-abi3
C++	C++17 or later compiler

Operating systems and architectures

Platform	Requirement
Linux	x86_64 or aarch64; release wheels use manylinux_2_31
macOS	x86_64 or Apple Silicon; consult the official release information for available artifacts
Windows	Windows 10/11 x86_64

Obtain SDK & Examples

Obtain the Revo 3 SDK v2.x package (Python wheel, C/C++ headers, dynamic libraries, and bundled examples) through official BrainCo release channels.

To browse 2.x code examples and standalone utilities online, visit the public brainco-revo3-sdk example repository (dev branch).

Explicitly select the dev branch when cloning the 2.x examples:

HTTPS

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

SSH

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

Version Compatibility

Revo 3 SDK v2.x introduces a redesigned architecture and object model, and is not backward-compatible with v1.x. Always refer to the dev branch or your SDK package for version-matched 2.x examples instead of legacy 1.x examples.

Install the Python SDK

Create an isolated Python 3.10 or later environment:

Linux / macOS

python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip

Windows PowerShell

py -3.10 -m venv .venv
.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip

When the stable wheels are released, obtain the file matching the operating system and architecture through a BrainCo release channel:

Platform	Wheel filename
Ubuntu/Linux x86_64	bc_revo3_sdk-2.0.0-cp310-abi3-manylinux_2_31_x86_64.whl
Ubuntu/Linux aarch64	bc_revo3_sdk-2.0.0-cp310-abi3-manylinux_2_31_aarch64.whl
Windows x86_64	bc_revo3_sdk-2.0.0-cp310-abi3-win_amd64.whl

Install the downloaded wheel and verify its version:

python -m pip install ./bc_revo3_sdk-2.0.0-cp310-abi3-*.whl
python -c "from bc_revo3_sdk import main_mod as sdk; print(sdk.get_sdk_version())"

The output must belong to the 2.0 series, such as 2.0.0-rc.3, 2.0.0-rc.4, or the final 2.0.0. The wheels listed above are not yet available through public OSS URLs or PyPI. Contact support to confirm the release channel; do not substitute the public 1.5.1 package.

After extracting the 2.x example package, install its full dependencies with:

python -m pip install ./examples/python

The bundled examples/python/pyproject.toml constrains bc-revo3-sdk>=2.0.0,<3 and installs the GUI and example dependencies. Applications that use only the SDK do not need these additional packages.

Prepare C/C++

C/C++ applications require public headers and shared libraries from the same versioned SDK package. Build the bundled examples with:

make -C examples/c

File	Purpose
dist/include/revo3-sdk.h	C11-compatible C ABI
dist/include/revo3/revo3.hpp	C++17 RAII wrapper

Include revo3/revo3.hpp and use revo3::Manager in C++. Use revo3-sdk.h for pure C and foreign-language bindings. Do not mix headers, libraries, or Python packages from different SDK versions.

Linux device permissions

Serial ports commonly require membership in the dialout group:

sudo usermod -a -G dialout "$USER"

Log in again, then check id and the target device node. CAN devices also require the driver and network-interface configuration for the selected adapter.

Continue with the Quick Start. The default quickstart reads device and health state and sends no motion commands.