Skip to main content

python binding of booster robotic sdk

Project description

Booster Robotics SDK

Booster Robotics SDK aims to provide a simple and easy-to-use interface for developers to control the Booster Robotics products. Booster Robotics SDK provides APIs for both C++ and Python.

Prebuild environment

  • OS (Ubuntu 22.04 LTS)
  • CPU (aarch64 and x86_64)
  • Compiler (gcc version 11.4.0)

Installation of deps

sudo ./install.sh

C++ SDK Usage

Build C++ examples

mkdir build
cd build
cmake ..
make

Run examples

1. run b1_loco_example_client locally

cd build
./b1_loco_example_client 127.0.0.1

2. run b1_low_level_subscriber locally

cd build
./b1_low_level_subscriber

3. run other example xxx locally

cd build
./xxx 127.0.0.1

Python SDK Usage

Option 1: Install via pip (Recommended)

The easiest way to use the SDK with Python is to install the pre-built package.

pip install booster_robotics_sdk_python --user

Option 2: Build from Source

If you need to build the Python binding locally for development or debugging purposes, follow these steps:

Install build dependencies

pip3 install pybind11
pip3 install pybind11-stubgen

if pybind11-stubgen cannot be found even after pip install, export PATH

export PATH=/home/[user name]/.local/bin:$PATH

Build and install

mkdir build
cd build
cmake .. -DBUILD_PYTHON_BINDING=on
make
sudo make install

Python example

python3 python_example/sdk_pybind_b1_exmaple.py 127.0.0.1

Note: If you installed via pip, you can find the examples at ~/.local/lib/python3.10/site-packages/python_example.

License

This project is licensed under the Apache License, Version 2.0. See the LICENSE file for details.

This project uses the following third-party libraries:

  • fastDDS (Apache License 2.0)
  • pybind11 (BSD 3-Clause License)
  • pybind11-stubgen (MIT License)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

booster_robotics_sdk_python_kaweees-0.0.1.tar.gz (6.0 MB view details)

Uploaded Source

File details

Details for the file booster_robotics_sdk_python_kaweees-0.0.1.tar.gz.

File metadata

  • Download URL: booster_robotics_sdk_python_kaweees-0.0.1.tar.gz
  • Upload date:
  • Size: 6.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for booster_robotics_sdk_python_kaweees-0.0.1.tar.gz
Algorithm Hash digest
SHA256 0077f4285916013be06a327e2a7002bb9bcbd06b8d71447147780a2130d58c8d
MD5 6c44ca6ac487f15b9cdd050e9faa120a
BLAKE2b-256 51b5c865338e014c906e83d0b28fd9e6065247d0c30733041ad19d14afed9751

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page