piper-sdk 0.0.3

Unified SDK for Piper robot arm control with real-time performance
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
//! Robot 协议测试
//!
//! 测试各种协议反馈帧的解析和状态更新。

use piper_sdk::can::{CanAdapter, CanError, PiperFrame};
use piper_sdk::driver::*;
use piper_sdk::protocol::ids::*;
use std::collections::VecDeque;
use std::sync::{Arc, Mutex};

/// MockCanAdapter 用于测试
struct MockCanAdapter {
    receive_queue: Arc<Mutex<VecDeque<PiperFrame>>>,
    sent_frames: Arc<Mutex<Vec<PiperFrame>>>,
}

impl MockCanAdapter {
    fn new() -> Self {
        Self {
            receive_queue: Arc::new(Mutex::new(VecDeque::new())),
            sent_frames: Arc::new(Mutex::new(Vec::new())),
        }
    }

    fn queue_frame(&self, frame: PiperFrame) {
        self.receive_queue.lock().unwrap().push_back(frame);
    }
}

impl CanAdapter for MockCanAdapter {
    fn send(&mut self, frame: PiperFrame) -> Result<(), CanError> {
        self.sent_frames.lock().unwrap().push(frame);
        Ok(())
    }

    fn receive(&mut self) -> Result<PiperFrame, CanError> {
        self.receive_queue.lock().unwrap().pop_front().ok_or(CanError::Timeout)
    }
}

/// 测试 RobotStatusFeedback (0x2A1) 更新 RobotControlState
#[test]
fn test_robot_status_feedback_update() {
    let mock_can = MockCanAdapter::new();
    let mock_can_clone = Arc::new(mock_can);

    let can_adapter = MockCanAdapter {
        receive_queue: mock_can_clone.receive_queue.clone(),
        sent_frames: mock_can_clone.sent_frames.clone(),
    };
    let piper = Piper::new(can_adapter, None).unwrap();

    // 创建 RobotStatusFeedback 帧 (0x2A1)
    let status_frame = PiperFrame::new_standard(
        ID_ROBOT_STATUS as u16,
        &[
            0x01,        // Byte 0: CanControl 模式
            0x00,        // Byte 1: Normal 状态
            0x01,        // Byte 2: MOVE J 模式
            0x00,        // Byte 3: Closed 示教状态
            0x00,        // Byte 4: Arrived 运动状态
            0x05,        // Byte 5: 轨迹点索引 5
            0b0011_1111, // Byte 6: 所有关节角度超限位(Bit 0-5 = 1)
            0b0000_0000, // Byte 7: 无通信异常
        ],
    );
    mock_can_clone.queue_frame(status_frame);

    // 等待 IO 线程处理
    std::thread::sleep(std::time::Duration::from_millis(200));

    // 验证 RobotControlState 已更新
    let control = piper.get_robot_control();

    // 验证基本字段已更新(不会崩溃)
    assert_eq!(control.control_mode, control.control_mode);
    assert_eq!(control.robot_status, control.robot_status);
}

/// 测试 GripperFeedback (0x2A8) 更新 RobotControlState 和 GripperState
#[test]
fn test_gripper_feedback_update() {
    let mock_can = MockCanAdapter::new();
    let mock_can_clone = Arc::new(mock_can);

    let can_adapter = MockCanAdapter {
        receive_queue: mock_can_clone.receive_queue.clone(),
        sent_frames: mock_can_clone.sent_frames.clone(),
    };
    let piper = Piper::new(can_adapter, None).unwrap();

    // 创建 GripperFeedback 帧 (0x2A8)
    // travel_mm: 100mm = 100000 (0.001mm 单位) -> i32
    // torque_nm: 1.0 N·m = 1000 (0.001N·m 单位) -> i16
    let travel_mm = 100000i32;
    let torque_nm = 1000i16;
    let status_byte = 0u8; // 状态位(简化)

    let mut data = [0u8; 8];
    data[0..4].copy_from_slice(&travel_mm.to_be_bytes());
    data[4..6].copy_from_slice(&torque_nm.to_be_bytes());
    data[6] = status_byte;
    // Byte 7: 保留

    let gripper_frame = PiperFrame::new_standard(ID_GRIPPER_FEEDBACK as u16, &data);
    mock_can_clone.queue_frame(gripper_frame);

    // 等待 IO 线程处理
    std::thread::sleep(std::time::Duration::from_millis(200));

    // 验证状态已更新(不会崩溃)
    let _control = piper.get_robot_control();
    let _gripper = piper.get_gripper();
    let _driver = piper.get_joint_driver_low_speed();
}

/// 测试命令通道处理(验证命令帧被发送)
#[test]
fn test_command_channel_send() {
    let mock_can = MockCanAdapter::new();
    let mock_can_clone = Arc::new(mock_can);

    let can_adapter = MockCanAdapter {
        receive_queue: mock_can_clone.receive_queue.clone(),
        sent_frames: mock_can_clone.sent_frames.clone(),
    };
    let piper = Piper::new(can_adapter, None).unwrap();

    // 发送命令帧
    let cmd_frame = PiperFrame::new_standard(0x150, &[0x01, 0x02, 0x03]);
    piper.send_frame(cmd_frame).unwrap();

    // 等待 IO 线程处理命令
    std::thread::sleep(std::time::Duration::from_millis(200));
}

/// 测试 try_write() 非阻塞行为(使用 collision_protection 测试 RwLock)
#[test]
fn test_collision_protection_try_write_non_blocking() {
    let ctx = Arc::new(PiperContext::new());

    // 用户线程持有读锁(使用 collision_protection 测试 RwLock)
    let _read_guard = ctx.collision_protection.read().unwrap();

    // IO 线程尝试写入(使用 try_write)
    let result = ctx.collision_protection.try_write();
    assert!(
        result.is_err(),
        "try_write should fail when read lock is held"
    ); // 应该失败,但不阻塞

    // 释放读锁后,写入应该成功
    drop(_read_guard);
    let mut write_guard = ctx.collision_protection.write().unwrap();

    // 更新数据
    write_guard.hardware_timestamp_us = 1000;
    write_guard.protection_levels = [1, 2, 3, 4, 5, 6];

    drop(write_guard);

    // 验证写入成功
    let read_guard = ctx.collision_protection.read().unwrap();
    assert_eq!(read_guard.hardware_timestamp_us, 1000);
}

/// 测试 JointDriverLowSpeedFeedback (0x261-0x266) 更新 JointDriverLowSpeedState
#[test]
fn test_joint_driver_low_speed_feedback_update() {
    let mock_can = MockCanAdapter::new();
    let mock_can_clone = Arc::new(mock_can);

    let can_adapter = MockCanAdapter {
        receive_queue: mock_can_clone.receive_queue.clone(),
        sent_frames: mock_can_clone.sent_frames.clone(),
    };
    let piper = Piper::new(can_adapter, None).unwrap();

    // 创建 6 个关节的低速反馈帧 (0x261-0x266)
    for joint_index in 1..=6 {
        let id = ID_JOINT_DRIVER_LOW_SPEED_BASE + (joint_index as u32 - 1);
        let voltage = 240 + joint_index as u16 * 10; // 24.0V + 0.1V * joint_index (0.1V 单位)
        let driver_temp = 35 + joint_index as i16;
        let motor_temp = 30 + joint_index as i8;
        let bus_current = 1000 + joint_index as u16 * 100; // 1.0A + 0.1A * joint_index (0.001A 单位)

        let mut data = [0u8; 8];
        data[0..2].copy_from_slice(&voltage.to_be_bytes());
        data[2..4].copy_from_slice(&driver_temp.to_be_bytes());
        data[4] = motor_temp as u8;
        data[5] = 0; // 状态位(简化)
        data[6..8].copy_from_slice(&bus_current.to_be_bytes());

        let mut frame = PiperFrame::new_standard(id as u16, &data);
        frame.timestamp_us = 3000 + joint_index;
        mock_can_clone.queue_frame(frame);
    }

    // 等待 IO 线程处理
    std::thread::sleep(std::time::Duration::from_millis(300));

    // 验证 JointDriverLowSpeedState 已更新(不会崩溃)
    let _driver = piper.get_joint_driver_low_speed();
}

/// 测试 CollisionProtectionLevelFeedback (0x47B) 更新 CollisionProtectionState
#[test]
fn test_collision_protection_level_feedback_update() {
    let mock_can = MockCanAdapter::new();
    let mock_can_clone = Arc::new(mock_can);

    let can_adapter = MockCanAdapter {
        receive_queue: mock_can_clone.receive_queue.clone(),
        sent_frames: mock_can_clone.sent_frames.clone(),
    };
    let piper = Piper::new(can_adapter, None).unwrap();

    // 创建 CollisionProtectionLevelFeedback 帧 (0x47B)
    // Byte 0-5: 6 个关节的保护等级 (0-8)
    let protection_frame = PiperFrame::new_standard(
        ID_COLLISION_PROTECTION_LEVEL_FEEDBACK as u16,
        &[
            0x05, // J1: 等级 5
            0x05, // J2: 等级 5
            0x05, // J3: 等级 5
            0x04, // J4: 等级 4
            0x04, // J5: 等级 4
            0x04, // J6: 等级 4
            0x00, // Byte 6: 保留
            0x00, // Byte 7: 保留
        ],
    );
    mock_can_clone.queue_frame(protection_frame);

    // 等待 IO 线程处理
    std::thread::sleep(std::time::Duration::from_millis(200));

    // 验证 JointDriverLowSpeedState 已更新(不会崩溃)
    let _driver = piper.get_joint_driver_low_speed();
}

/// 测试 MotorLimitFeedback (0x473) 配置累积(6次查询)
#[test]
fn test_motor_limit_feedback_accumulation() {
    let mock_can = MockCanAdapter::new();
    let mock_can_clone = Arc::new(mock_can);

    let can_adapter = MockCanAdapter {
        receive_queue: mock_can_clone.receive_queue.clone(),
        sent_frames: mock_can_clone.sent_frames.clone(),
    };
    let piper = Piper::new(can_adapter, None).unwrap();

    // 发送 6 个 0x473 帧,每个关节一次
    for joint_index in 1..=6 {
        let max_angle_deg = (180.0 * 10.0) as i16; // 180.0° = 1800 (0.1° 单位)
        let min_angle_deg = (-180.0 * 10.0) as i16; // -180.0° = -1800
        let max_velocity_rad_s = (5.0 * 100.0) as u16; // 5.0 rad/s = 500 (0.01rad/s 单位)

        let mut data = [0u8; 8];
        data[0] = joint_index;
        data[1..3].copy_from_slice(&max_angle_deg.to_be_bytes());
        data[3..5].copy_from_slice(&min_angle_deg.to_be_bytes());
        data[5..7].copy_from_slice(&max_velocity_rad_s.to_be_bytes());

        let mut frame = PiperFrame::new_standard(ID_MOTOR_LIMIT_FEEDBACK as u16, &data);
        frame.timestamp_us = 4000 + joint_index as u64;
        mock_can_clone.queue_frame(frame);
    }

    // 等待 IO 线程处理
    std::thread::sleep(std::time::Duration::from_millis(300));

    // 验证配置状态已更新(不会崩溃)
    let _limits = piper.get_joint_limit_config().unwrap();
    let _accel = piper.get_joint_accel_config().unwrap();
    let _end_limits = piper.get_end_limit_config().unwrap();
}

/// 测试 MotorMaxAccelFeedback (0x47C) 配置累积(6次查询)
#[test]
fn test_motor_max_accel_feedback_accumulation() {
    let mock_can = MockCanAdapter::new();
    let mock_can_clone = Arc::new(mock_can);

    let can_adapter = MockCanAdapter {
        receive_queue: mock_can_clone.receive_queue.clone(),
        sent_frames: mock_can_clone.sent_frames.clone(),
    };
    let piper = Piper::new(can_adapter, None).unwrap();

    // 发送 6 个 0x47C 帧,每个关节一次
    for joint_index in 1..=6 {
        let max_accel_rad_s2 = (10.0 * 100.0) as u16; // 10.0 rad/s² = 1000 (0.001rad/s² 单位,但代码中似乎用的是 0.01rad/s² 单位)

        let mut data = [0u8; 8];
        data[0] = joint_index;
        data[1..3].copy_from_slice(&max_accel_rad_s2.to_be_bytes());
        // Byte 3-7: 保留

        let mut frame = PiperFrame::new_standard(ID_MOTOR_MAX_ACCEL_FEEDBACK as u16, &data);
        frame.timestamp_us = 5000 + joint_index as u64;
        mock_can_clone.queue_frame(frame);
    }

    // 等待 IO 线程处理
    std::thread::sleep(std::time::Duration::from_millis(300));

    // 验证配置状态已更新(不会崩溃)
    let _limits = piper.get_joint_limit_config().unwrap();
    let _accel = piper.get_joint_accel_config().unwrap();
    let _end_limits = piper.get_end_limit_config().unwrap();
}

/// 测试 EndVelocityAccelFeedback (0x478) 更新 EndLimitConfigState
#[test]
fn test_end_velocity_accel_feedback_update() {
    let mock_can = MockCanAdapter::new();
    let mock_can_clone = Arc::new(mock_can);

    let can_adapter = MockCanAdapter {
        receive_queue: mock_can_clone.receive_queue.clone(),
        sent_frames: mock_can_clone.sent_frames.clone(),
    };
    let piper = Piper::new(can_adapter, None).unwrap();

    // 创建 EndVelocityAccelFeedback 帧 (0x478)
    // 最大线速度: 0.5 m/s = 500 (0.001m/s 单位)
    // 最大角速度: 1.0 rad/s = 1000 (0.001rad/s 单位)
    // 最大线加速度: 1.0 m/s² = 1000 (0.001m/s² 单位)
    // 最大角加速度: 2.0 rad/s² = 2000 (0.001rad/s² 单位)
    let max_linear_vel = 500u16;
    let max_angular_vel = 1000u16;
    let max_linear_accel = 1000u16;
    let max_angular_accel = 2000u16;

    let mut data = [0u8; 8];
    data[0..2].copy_from_slice(&max_linear_vel.to_be_bytes());
    data[2..4].copy_from_slice(&max_angular_vel.to_be_bytes());
    data[4..6].copy_from_slice(&max_linear_accel.to_be_bytes());
    data[6..8].copy_from_slice(&max_angular_accel.to_be_bytes());

    let mut frame = PiperFrame::new_standard(ID_END_VELOCITY_ACCEL_FEEDBACK as u16, &data);
    frame.timestamp_us = 6000;
    mock_can_clone.queue_frame(frame);

    // 等待 IO 线程处理
    std::thread::sleep(std::time::Duration::from_millis(200));

    // 验证配置状态已更新(不会崩溃)
    let _limits = piper.get_joint_limit_config().unwrap();
    let _accel = piper.get_joint_accel_config().unwrap();
    let _end_limits = piper.get_end_limit_config().unwrap();
}

/// 测试 CAN 接收错误处理(CanError::Timeout)
#[test]
fn test_can_receive_error_timeout() {
    let can_adapter = MockCanAdapter {
        receive_queue: Arc::new(Mutex::new(VecDeque::new())),
        sent_frames: Arc::new(Mutex::new(Vec::new())),
    };
    let piper = Piper::new(can_adapter, None).unwrap();

    // 不发送任何帧,MockCanAdapter 会返回 Timeout
    // 等待 IO 线程处理超时
    std::thread::sleep(std::time::Duration::from_millis(100));

    // 验证不会崩溃(超时是正常情况)
    let _joint_pos = piper.get_joint_position();
    let _end_pose = piper.get_end_pose();
}

/// 测试 CAN 发送错误处理
#[test]
fn test_can_send_error_handling() {
    // 注意:MockCanAdapter 总是返回 Ok(()),所以这个测试主要验证不会崩溃
    // 实际的发送错误处理逻辑在 io_loop 中
    let mock_can = MockCanAdapter::new();
    let mock_can_clone = Arc::new(mock_can);

    let can_adapter = MockCanAdapter {
        receive_queue: mock_can_clone.receive_queue.clone(),
        sent_frames: mock_can_clone.sent_frames.clone(),
    };
    let piper = Piper::new(can_adapter, None).unwrap();

    // 发送命令帧(应该成功)
    let cmd_frame = PiperFrame::new_standard(0x150, &[0x01]);
    assert!(piper.send_frame(cmd_frame).is_ok());
}

/// 测试帧解析错误处理(无效 CAN 帧)
#[test]
fn test_frame_parse_error_invalid_frame() {
    let mock_can = MockCanAdapter::new();
    let mock_can_clone = Arc::new(mock_can);

    let can_adapter = MockCanAdapter {
        receive_queue: mock_can_clone.receive_queue.clone(),
        sent_frames: mock_can_clone.sent_frames.clone(),
    };
    let piper = Piper::new(can_adapter, None).unwrap();

    // 创建一个无效的 CAN 帧(错误的 ID 或数据长度)
    // 例如:使用正确 ID 但数据长度不足
    let invalid_frame = PiperFrame::new_standard(ID_ROBOT_STATUS as u16, &[0x01; 4]); // 只有 4 字节,应该是 8 字节
    mock_can_clone.queue_frame(invalid_frame);

    // 等待 IO 线程处理
    std::thread::sleep(std::time::Duration::from_millis(200));

    // 验证不会崩溃(解析错误应该被捕获并记录警告)
    let _control = piper.get_robot_control();
}