Skip to main content

Mobile Base Python SDK for Reachy 2021

As of July 2022, the Reachy robot gained mobility!

Reachy is now equipped with an omnidirectional open source mobile base allowing the robot to move in any direction, turn itself around, go through doors or squeeze through tight spaces.

The mobile base Python SDK is a pure Python SDk library that let you control Reachy's mobile base even without having Reachy's motors turned on.

You can use the SDK over the network. The communication to the robot is done via gRPC and can thus work on most kind of network configurations. Local control of the mobile base directly on Reachy's computer can simply be done using the localhost IP.

License

The mobile base SDK, and the rest of Reachy software, is open-source and released under an Apache-2.0 License.

Installation

From PyPi

pip install mobile-base-sdk

From the source

git clone https://github.com/pollen-robotics/mobile-base-sdk
pip install -e mobile-base-sdk

We recommend using a virtual environment for your development.

The SDK depends on numpy, grpc and reachy-sdk-api.

Getting Started

A section in our online documentation is dedicated to the mobile base SDK to learn how to use it.

Connecting the SDK to Reachy's mobile base is as simple as:

from mobile_base_sdk import MobileBaseSDK

mobile_base = MobileBaseSDK(host='my-reachy-ip')

Examples

Examples are available in this repository as notebooks or Python scripts to show you how to use the mobile base Python SDK.

You will find: *
* *

Connect to a Reachy

It is also possible to connect simultaneously to Reachy and its mobile base using reachy-sdk.

from reachy_sdk import ReachySDK

reachy = ReachySDK(host='my-reachy-ip', with_mobile_base=True)
reachy.mobile_base.goto(x=0.5, y=0.0, theta=0.0)

See the dedicated notebook for an example of using both Reachy and its mobile base simultaneously.

Support

This project adheres to the Contributor code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to contact@pollen-robotics.com.

Visit pollen-robotics.com to learn more or join our Dicord community if you have any questions or want to share your ideas. Follow @PollenRobotics on Twitter for important announcements.

Release files for mobile-base-sdk 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mobile-base-sdk 1.0.2
File Size Uploaded
mobile-base-sdk-1.0.2.tar.gz 10.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mobile-base-sdk 1.0.2
File Interpreter ABI Platform
mobile_base_sdk-1.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 22.3 kB

Release files / mobile-base-sdk-1.0.2.tar.gz

Download URL mobile-base-sdk-1.0.2.tar.gz
Size 10.7 kB
Tags Source
SHA-256 checksum
How to use checksums
3f32c6ef9ffdb00d5062f45d6e4f22a00fa9cb0ef7d3e2a64622f47a711b581d
BLAKE2b-256 checksum
How to use checksums
3334d6372fb204fae4fc60a2ad3d6fefd27f2a998a4228671f2f13bb7e591b21
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.14

Release files / mobile_base_sdk-1.0.2-py3-none-any.whl

Download URL mobile_base_sdk-1.0.2-py3-none-any.whl
Size 11.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e9021d901692bf7902aec8ee9204fbfc1d73d401fcbfff218526a360991d7271
BLAKE2b-256 checksum
How to use checksums
f43af158068e7be4f8a86da5fb64a976e8905a82acc9f5c32a3d38c8707485c0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.14

Release history Release notifications | RSS feed

This release

1.0.2 This release

2 release files

1.0.0

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page