Expand description
Piper SDK - 松灵机械臂 Rust SDK
高性能、跨平台、零抽象开销的 Rust SDK,专用于松灵 Piper 机械臂的高频力控(>1kHz)。
§架构设计
本 SDK 采用分层架构,从底层到高层:
- CAN 层 (
can): CAN 硬件抽象,支持 SocketCAN 和 GS-USB - 协议层 (
protocol): 类型安全的协议编码/解码 - 驱动层 (
driver): IO 线程管理、状态同步、帧解析 - 客户端层 (
client): 类型安全、易用的控制接口
§快速开始
大多数用户应该使用高层 API(客户端接口):
use piper_sdk::prelude::*;
// 或
use piper_sdk::{Piper, Observer};需要直接控制 CAN 帧或需要更高性能的用户可以使用驱动层:
use piper_sdk::driver::{Piper as Driver, PiperBuilder};Modules§
Macros§
- init_
logger - 初始化日志系统(便捷宏)
Structs§
- Observer
- 状态观察器(只读接口,View 模式)
- Piper
- Piper 机械臂(Type State Pattern)
- Piper
Builder - Client 层 Piper Builder
- Piper
Frame - CAN 2.0 标准帧的统一抽象
- Recording
Config - 录制配置
- Recording
Handle - 录制句柄(用于控制和监控)
- Recording
Metadata - 录制元数据
- Recording
Stats - 录制统计
Enums§
- CanError
- CAN 适配层统一错误类型
- Driver
Error - 驱动层错误类型
- Protocol
Error - 协议解析错误类型
- Stop
Condition - 停止条件