booster_sdk 0.1.0

An SDK for controlling Booster robots
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

//! Booster Robotics SDK for Rust.
//!
//! This crate provides high-level, asynchronous control APIs for Booster robots,
//! alongside the transport layer abstractions and shared domain types that power
//! those APIs.
//!
//! ## Modules
//! - [`client`]: robot control interfaces such as [`client::BoosterClient`]
//!   for locomotion, manipulation, and gesture commands.
//! - [`dds`]: DDS transport primitives for communicating with Booster services.
//! - [`types`]: core data structures, error types, and helper utilities shared across
//!   the SDK.
//!
//! ## Getting Started
//!
//! Most applications will interact with the [`client`] module:
//!
//! ```no_run
//! use booster_sdk::client::BoosterClient;
//! use booster_sdk::types::RobotMode;
//!
//! # async fn demo() -> booster_sdk::types::Result<()> {
//! let client = BoosterClient::new()?;
//! client.change_mode(RobotMode::Walking).await?;
//! client.move_robot(0.5, 0.0, 0.0).await?;
//! # Ok(())
//! # }
//! ```
//!
//! For advanced scenarios you can work directly with the [`dds`] module or compose
//! your own data pipelines using the types re-exported from [`types`].

pub mod client;
pub mod dds;
pub mod types;