Installation
This document guides you through the hardware and software preparation steps required to start using the Rainbow Robotics SDK.
Requirements
- Supported OS: Ubuntu 22.04
- C++ Compiler: GCC >= 11
- Python: >= 3.10
- Build Tool: CMake >= 3.30
- C++ Package Manager: Conan
- Python Package Manager: Poetry
Installing CMake
Check and install the required version of CMake:
bash
# Check the currently installed CMake version
cmake --version
# If the CMake version is below 3.30, remove the existing version
sudo apt remove --purge cmake
sudo apt autoremove
# Install the latest version
sudo snap install cmake --classic
# Verify the installed version of CMake
cmake --version
Installing Conan
If Conan is already installed, you can skip this step.
bash
# Install Conan
pip install conan
# Detect Conan profiles
conan profile detect --force
Installing Poetry
If Poetry is already installed, you can skip this step.
bash
curl -sSL https://install.python-poetry.org | python3 -
source ~/.profile
# Check installation
poetry --version
Installing the SDK
Steps to install and build the Rainbow Robotics SDK. If you have an SSH key, you can clone the repository via SSH. Otherwise, use the HTTPS method.
Option 1: Clone via SSH (for users with an SSH key)
bash
git clone --recurse-submodules git@github.com:RainbowRobotics/rby1-sdk.git
Option 2: Clone via HTTPS
bash
git clone --recurse-submodules https://github.com/RainbowRobotics/rby1-sdk.git
C++ Usage
bash
# Install dependency packages
cd rby1-sdk
conan install . -s build_type=Release -b missing -of build
# Create CMake presets
cmake --preset conan-release -D BUILD_EXAMPLES=ON
# Perform the build
cmake --build --preset conan-release
Python Usage
bash
cd rby1-sdk
# Install related packages
poetry install
# Activate the virtual environment
poetry shell
pip install .
Running Example Programs
Run the example programs using the installed SDK:
⚠️ IMPORTANT WARNING: Ensure the surroundings are safe before executing.
bash
# Run the C++ example program
./build/examples/cpp/example_demo_motion [RPC IP]:50051
# While in poetry shell, ensure the ROBOT_ADDRESS is correct in demo_motion.py
python examples/python/demo_motion.py