Struct PiperBuilder 

pub struct PiperBuilder { /* private fields */ }

Piper Builder（链式构造）

使用 Builder 模式创建 Piper 实例，支持链式调用。

Example

use piper_driver::{PiperBuilder, PipelineConfig};

// 使用默认配置
let piper = PiperBuilder::new()
    .build()
    .unwrap();

// 自定义波特率和 Pipeline 配置
let config = PipelineConfig {
    receive_timeout_ms: 5,
    frame_group_timeout_ms: 20,
    velocity_buffer_timeout_us: 20_000,
};
let piper = PiperBuilder::new()
    .baud_rate(500_000)
    .pipeline_config(config)
    .build()
    .unwrap();

Implementations

impl PiperBuilder

pub fn new() -> Self

创建新的 Builder

Example

use piper_driver::PiperBuilder;

let builder = PiperBuilder::new();

pub fn with_driver_type(self, driver_type: DriverType) -> Self

显式指定驱动类型（可选，默认 Auto）

Example

use piper_driver::{PiperBuilder, DriverType};

// 强制使用 GS-USB
let piper = PiperBuilder::new()
    .with_driver_type(DriverType::GsUsb)
    .build()
    .unwrap();

pub fn interface(self, interface: impl Into<String>) -> Self

设置 CAN 接口（可选，默认自动检测）

注意

• Linux: 此参数可以是 SocketCAN 接口名称（如 “can0” 或 “vcan0”）或 GS-USB 设备序列号
  • 如果接口名是 “can0”/“can1” 等，优先使用 SocketCAN（通过 Smart Default）
  • 如果接口名是设备序列号或未提供，使用 GS-USB
• macOS/Windows (GS-USB): 此参数用作设备序列号，用于区分多个 GS-USB 设备
  • 如果提供序列号，只打开匹配序列号的设备
  • 如果不提供，自动选择第一个找到的设备

Example

use piper_driver::PiperBuilder;

// 通过序列号指定设备
let piper = PiperBuilder::new()
    .interface("ABC123456")
    .build()
    .unwrap();

pub fn baud_rate(self, baud_rate: u32) -> Self

设置 CAN 波特率（可选，默认 1M）

pub fn pipeline_config(self, config: PipelineConfig) -> Self

设置 Pipeline 配置（可选）

pub fn with_daemon(self, daemon_addr: impl Into<String>) -> Self

使用守护进程模式（可选）

当指定守护进程地址时，使用 GsUsbUdpAdapter 通过守护进程访问 GS-USB 设备。 这解决了 macOS 下 GS-USB 设备重连后无法正常工作的限制。

参数

• daemon_addr: 守护进程地址
  • UDS 路径（如 “/tmp/gs_usb_daemon.sock”）
  • UDP 地址（如 “127.0.0.1:8888”）

Example

use piper_driver::PiperBuilder;

// 使用 UDS 连接守护进程
let piper = PiperBuilder::new()
    .with_daemon("/tmp/gs_usb_daemon.sock")
    .build()
    .unwrap();

// 使用 UDP 连接守护进程（用于跨机器调试）
let piper = PiperBuilder::new()
    .with_daemon("127.0.0.1:8888")
    .build()
    .unwrap();

pub fn build(self) -> Result<Piper, DriverError>

构建 Piper 实例

创建并启动 Piper 实例，启动后台 IO 线程。

Errors

• DriverError::Can: CAN 设备初始化失败

Example

use piper_driver::PiperBuilder;

match PiperBuilder::new().build() {
    Ok(piper) => {
        // 使用 piper 读取状态
        let state = piper.get_joint_position();
    }
    Err(e) => {
        eprintln!("Failed to create Piper: {}", e);
    }
}

Trait Implementations

impl Default for PiperBuilder

fn default() -> Self

Returns the “default value” for a type.