# booster_robotics_sdk_release

**Repository Path**: brimod/sdk_release

## Basic Information

- **Project Name**: booster_robotics_sdk_release
- **Description**: sdk_release
- **Primary Language**: C++
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2026-04-26
- **Last Updated**: 2026-05-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Booster Robotics SDK

Booster Robotics SDK 旨在为开发者提供一个简单易用的接口，用于控制 Booster Robotics 产品。
Booster Robotics SDK 为 C++ 和 Python 都提供了 API。

## 预构建环境
* 操作系统 (Ubuntu 22.04 LTS / 24.04 LTS)
* CPU (aarch64 和 x86_64)
* 编译器 (gcc)

## 安装
```bash
./install.sh
```

该脚本将：
- 安装系统依赖 (git, build-essential, cmake, libssl-dev, libasio-dev, libtinyxml2-dev)
- 将 SDK 头文件和库安装到 `~/.local/include` 和 `~/.local/lib`
- 在 `~/.profile` 中配置环境变量
- 安装完成后，运行 `source ~/.profile` 以应用环境变量更改

**注意：** SDK 不再需要 `sudo`，而是安装到用户目录而非系统级别的 `/usr/local`。

## C++ SDK 使用方法
### 构建 C++ 示例
```bash
mkdir build
cd build
cmake ..
make
```

### 运行示例
#### 1. 本地运行 b1_loco_example_client
```
cd build
./b1_loco_example_client 127.0.0.1
```
#### 2. 本地运行 b1_low_level_subscriber
```
cd build
./b1_low_level_subscriber
```
#### 3. 本地运行其他示例 xxx
```
cd build
./xxx 127.0.0.1
```

## Python SDK 使用方法

### 方式一：使用 venv（推荐）
我们推荐使用 Python 虚拟环境来避免系统级安装冲突。

```bash
./python_venv_setup.sh
source .venv/bin/activate
```

然后从源码构建 Python 绑定：
```bash
./build_python_binding.sh
```

### 方式二：通过 pip 安装（预构建）
如果您更喜欢使用预构建的包：
```bash
pip install booster_robotics_sdk_python --user
```

### Python 示例
```bash
python3 python_example/sdk_pybind_b1_exmaple.py 127.0.0.1
```
注意：如果通过 pip 安装，可以在 `~/.local/lib/python3.10/site-packages/python_example` 中找到示例。

## 许可证

本项目采用 Apache License 2.0 开源许可。详见 LICENSE 文件。

本项目使用了以下第三方库：
- fastDDS (Apache License 2.0)
- pybind11 (BSD 3-Clause License)
- pybind11-stubgen (MIT License)