medius 3.4.3

Host control library for the medius transparent mouse passthrough box
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
//! OPTION command and QUERY(OPTIONS): payload bytes, `parse_resp` decoding, and query roundtrips, pinned to the `ctrl_proto.h` wire format.

use std::time::Duration;

#[cfg(feature = "mock")]
use crate::protocol::FrameType;
use crate::protocol::command::{
    emit_pace_payload, imperfect_payload, move_ride_payload, name_payload, render_payload,
    spread_payload,
};
use crate::protocol::{Resp, parse_resp};
use crate::types::{
    EmitPace, EmitPaceStatus, ImperfectStatus, RenderMode, RenderStatus, SpreadStatus,
};

#[test]
fn option_payload_bytes() {
    assert_eq!(imperfect_payload(true), [0, 1]);
    assert_eq!(imperfect_payload(false), [0, 0]);
    assert_eq!(move_ride_payload(5), [1, 5, 0]);
    assert_eq!(move_ride_payload(0), [1, 0, 0]);
    assert_eq!(move_ride_payload(1000), [1, 0xE8, 0x03]);
    assert_eq!(emit_pace_payload(0, 0, 0), [2, 0, 0, 0, 0, 0]);
    assert_eq!(emit_pace_payload(1, 0, 0), [2, 1, 0, 0, 0, 0]);
    assert_eq!(emit_pace_payload(2, 1000, 0), [2, 2, 0xE8, 0x03, 0, 0]);
    assert_eq!(emit_pace_payload(0, 0, 125), [2, 0, 0, 0, 0x7D, 0]);
    assert_eq!(
        emit_pace_payload(2, 500, 1000),
        [2, 2, 0xF4, 0x01, 0xE8, 0x03]
    );
    // The texture is its own command, so nothing about it can disturb the pace.
    assert_eq!(render_payload(0, false), [5, 0, 0]);
    assert_eq!(render_payload(2, true), [5, 2, 1]);
    assert_eq!(render_payload(3, false), [5, 3, 0]);
    assert_eq!(spread_payload(0), [6, 0, 0]);
    assert_eq!(spread_payload(100), [6, 100, 0]);
    assert_eq!(spread_payload(250), [6, 250, 0]);
    assert_eq!(spread_payload(1000), [6, 0xE8, 0x03]);
    assert_eq!(name_payload("AB"), vec![3, b'A', b'B']);
    assert_eq!(name_payload(""), vec![3]);
}

#[test]
fn emit_pace_wire_is_the_pace_alone() {
    use crate::device::options::emit_pace_wire;
    assert_eq!(emit_pace_wire(EmitPace::Learned), (0, 0));
    assert_eq!(emit_pace_wire(EmitPace::Interval), (1, 0));
    assert_eq!(emit_pace_wire(EmitPace::Fixed(500)), (2, 500));
}

#[test]
fn render_mode_round_trips_its_own_wire_byte() {
    for (m, w) in [
        (RenderMode::Off, 0u8),
        (RenderMode::Stock, 1),
        (RenderMode::Despiked, 2),
        (RenderMode::Unsmoothed, 3),
    ] {
        assert_eq!(m.to_wire(), w);
        assert_eq!(RenderMode::from_u8(w), Some(m));
    }
    // A value this crate does not know is refused rather than silently read as Off.
    assert_eq!(RenderMode::from_u8(4), None);
    assert_eq!(RenderMode::from_u8(0x80), None);
}

#[test]
fn decode_imperfect_through_parse_resp() {
    let Some(Resp::Imperfect(i)) = parse_resp(&[9, 0, 1, 1, 1]) else {
        panic!("expected Imperfect");
    };
    assert_eq!(
        i,
        ImperfectStatus {
            allowed: true,
            over_capacity: true,
            clone_imperfect: true
        }
    );
    let Some(Resp::Imperfect(none)) = parse_resp(&[9, 0, 0, 0, 0]) else {
        panic!("expected Imperfect");
    };
    assert_eq!(none, ImperfectStatus::default());
    assert!(parse_resp(&[9, 0, 0, 0]).is_none());
}

#[test]
fn decode_move_ride_through_parse_resp() {
    let Some(Resp::MovementRiding(w)) = parse_resp(&[9, 1, 5, 0]) else {
        panic!("expected MovementRiding");
    };
    assert_eq!(w, Some(Duration::from_millis(5)));
    let Some(Resp::MovementRiding(off)) = parse_resp(&[9, 1, 0, 0]) else {
        panic!("expected MovementRiding");
    };
    assert_eq!(off, None);
    assert!(parse_resp(&[9, 1, 0]).is_none());
}

#[test]
fn decode_emit_pace_through_parse_resp() {
    // Five distinct numbers, so swapping any two fields fails.
    let Some(Resp::EmitPace(s)) =
        parse_resp(&[9, 2, 2, 0xE8, 0x03, 0xFA, 0x00, 0x7D, 0x00, 0x64, 0x00, 1])
    else {
        panic!("expected EmitPace");
    };
    assert_eq!(
        s,
        EmitPaceStatus {
            mode: EmitPace::Fixed(1000),
            resolved_hz: 250,
            force_hz: Some(125),
            advertised_hz: 100,
            force_active: true,
        }
    );
    // Unforced still reports what the clone advertises, so a host can see native rate.
    let Some(Resp::EmitPace(native)) = parse_resp(&[9, 2, 0, 0, 0, 0, 0, 0, 0, 0xE8, 0x03, 0])
    else {
        panic!("expected EmitPace");
    };
    assert_eq!(
        native,
        EmitPaceStatus {
            mode: EmitPace::Learned,
            resolved_hz: 0,
            force_hz: None,
            advertised_hz: 1000,
            force_active: false,
        }
    );
    let Some(Resp::EmitPace(nothing)) = parse_resp(&[9, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]) else {
        panic!("expected EmitPace");
    };
    assert_eq!(
        nothing,
        EmitPaceStatus {
            mode: EmitPace::Learned,
            resolved_hz: 0,
            force_hz: None,
            advertised_hz: 0,
            force_active: false,
        }
    );
    // An 11-byte value is short of the shape and is refused rather than read with a defaulted field.
    assert!(parse_resp(&[9, 2, 2, 0xE8, 0x03, 0xFA, 0x00, 0x7D, 0x00, 0x64, 0x00]).is_none());
    // An unknown pace is refused rather than silently read as a default.
    assert!(parse_resp(&[9, 2, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0]).is_none());
    // The bit-packed encodings an older box used are now just unknown paces.
    assert!(parse_resp(&[9, 2, 0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0]).is_none());
    assert!(parse_resp(&[9, 2, 0x82, 0, 0, 0, 0, 0, 0, 0, 0, 0]).is_none());
}

#[test]
fn decode_spread_through_parse_resp() {
    // Two distinct values, so swapping the fields fails. 8125 us is 0x1FBD.
    let Some(Resp::Spread(s)) = parse_resp(&[9, 6, 250, 0, 0xBD, 0x1F, 0, 0]) else {
        panic!("expected Spread");
    };
    assert_eq!(
        s,
        SpreadStatus {
            percent: 250,
            span_us: 8125,
        }
    );
    // Off, with nothing learnt.
    let Some(Resp::Spread(s)) = parse_resp(&[9, 6, 0, 0, 0, 0, 0, 0]) else {
        panic!("expected Spread");
    };
    assert_eq!(s, SpreadStatus::default());
    // A span past the top of an i32 is still read as the unsigned microseconds it is.
    let Some(Resp::Spread(s)) = parse_resp(&[9, 6, 1, 0, 0xFF, 0xFF, 0xFF, 0xFF]) else {
        panic!("expected Spread");
    };
    assert_eq!(s.span_us, u32::MAX);
    // A short value is not padded.
    assert!(parse_resp(&[9, 6, 100, 0, 0, 0, 0]).is_none());
}

#[cfg(feature = "mock")]
#[test]
fn mock_spread_answers_zero_until_a_period_is_learned() {
    use crate::{Device, MockBox, SpreadStatus};
    // A fresh box boots at 100 percent and has learned nothing, so it is spreading across nothing.
    let mock = MockBox::new();
    let device = Device::with_mock(mock.clone());
    assert_eq!(
        device.query_spread().unwrap(),
        SpreadStatus {
            percent: 100,
            span_us: 0
        }
    );
    // Once a 125 Hz loop is learned, the full percent is that whole interval.
    mock.set_spread_learned(8000);
    assert_eq!(
        device.query_spread().unwrap(),
        SpreadStatus {
            percent: 100,
            span_us: 8000
        }
    );
    device.set_spread(50).unwrap();
    assert_eq!(
        device.query_spread().unwrap(),
        SpreadStatus {
            percent: 50,
            span_us: 4000
        }
    );
    // Above 100 overlaps rather than being clamped.
    device.set_spread(200).unwrap();
    assert_eq!(device.query_spread().unwrap().span_us, 16000);
    // Off answers no interval even with a period learned.
    device.set_spread(0).unwrap();
    assert_eq!(
        device.query_spread().unwrap(),
        SpreadStatus {
            percent: 0,
            span_us: 0
        }
    );
}

#[test]
fn decode_render_through_parse_resp() {
    // Three distinct values, so swapping any two fields fails.
    let Some(Resp::Render(s)) = parse_resp(&[9, 5, 1, 1, 0]) else {
        panic!("expected Render");
    };
    assert_eq!(
        s,
        RenderStatus {
            mode: RenderMode::Stock,
            full: true,
            ready: false,
        }
    );
    for (byte, mode) in [
        (0u8, RenderMode::Off),
        (1, RenderMode::Stock),
        (2, RenderMode::Despiked),
        (3, RenderMode::Unsmoothed),
    ] {
        let Some(Resp::Render(s)) = parse_resp(&[9, 5, byte, 0, 1]) else {
            panic!("expected Render");
        };
        assert_eq!((s.mode, s.full, s.ready), (mode, false, true));
    }
    // An unknown mode is refused rather than read as a default, and a short value is not padded.
    assert!(parse_resp(&[9, 5, 4, 0, 0]).is_none());
    assert!(parse_resp(&[9, 5, 0, 0]).is_none());
    // Any non-zero reads as set, the way the firmware writes a bool byte.
    let Some(Resp::Render(nz)) = parse_resp(&[9, 5, 2, 7, 9]) else {
        panic!("expected Render");
    };
    assert!(nz.full && nz.ready);
}

#[cfg(feature = "mock")]
#[test]
fn mock_emit_pace_matches_firmware_snap() {
    use crate::{Device, EmitPace, EmitPaceStatus, MockBox, RenderMode};
    // The mock models firmware pacing: Fixed(400) snaps to 1000/3 = 333 Hz on the 1 ms frame clock
    // and Fixed(2000) clamps to 1 kHz, as hardware does.
    let mock = MockBox::new().with_emit_pace(EmitPace::Fixed(400));
    let device = Device::with_mock(mock.clone());
    assert_eq!(
        device.query_emit_pace().unwrap(),
        EmitPaceStatus {
            mode: EmitPace::Fixed(400),
            resolved_hz: 333,
            force_hz: None,
            advertised_hz: 0,
            force_active: false,
        }
    );
    mock.set_emit_pace(EmitPace::Fixed(2000));
    assert_eq!(
        device.query_emit_pace().unwrap(),
        EmitPaceStatus {
            mode: EmitPace::Fixed(1000),
            resolved_hz: 1000,
            force_hz: None,
            advertised_hz: 0,
            force_active: false,
        }
    );
    // The texture is its own command now, but it still governs the resolved rate.
    device.set_render(RenderMode::Stock, false).unwrap();
    device.set_emit_pace(EmitPace::Learned, None).unwrap();
    assert_eq!(device.query_emit_pace().unwrap().resolved_hz, 0);
    // Onto a Fixed rate the snapped value stands whatever the texture is doing.
    device.set_emit_pace(EmitPace::Fixed(250), None).unwrap();
    assert_eq!(
        device.query_emit_pace().unwrap(),
        EmitPaceStatus {
            mode: EmitPace::Fixed(250),
            resolved_hz: 250,
            force_hz: None,
            advertised_hz: 0,
            force_active: false,
        }
    );
    device.set_render(RenderMode::Off, false).unwrap();
    device.set_emit_pace(EmitPace::Learned, None).unwrap();
    assert_eq!(
        device.query_emit_pace().unwrap(),
        EmitPaceStatus {
            mode: EmitPace::Learned,
            resolved_hz: 0,
            force_hz: None,
            advertised_hz: 0,
            force_active: false,
        }
    );

    // Armed, a rendered stream on a learnt pace self-paces every millisecond and says so.
    let armed = Device::with_mock(MockBox::new().with_render_ready(true));
    armed.set_render(RenderMode::Stock, false).unwrap();
    armed.set_emit_pace(EmitPace::Learned, None).unwrap();
    assert_eq!(armed.query_emit_pace().unwrap().resolved_hz, 1000);
    armed.set_render(RenderMode::Off, false).unwrap();
    assert_eq!(armed.query_emit_pace().unwrap().resolved_hz, 0);
}

#[cfg(feature = "mock")]
#[test]
fn render_round_trips_over_the_command_path() {
    use crate::{Device, MockBox, RenderStatus};
    let mock = MockBox::new();
    let device = Device::with_mock(mock.clone());
    // The factory setting: de-spiked, native motion relayed, nothing learned yet.
    assert_eq!(
        device.query_render().unwrap(),
        RenderStatus {
            mode: RenderMode::Despiked,
            full: false,
            ready: false,
        }
    );
    for mode in [
        RenderMode::Off,
        RenderMode::Stock,
        RenderMode::Despiked,
        RenderMode::Unsmoothed,
    ] {
        for full in [false, true] {
            device.set_render(mode, full).unwrap();
            let s = device.query_render().unwrap();
            assert_eq!((s.mode, s.full), (mode, full));
        }
    }
    // A box reports a learned profile, separating a box set to a mode from one rendering with it.
    let armed = Device::with_mock(MockBox::new().with_render_ready(true));
    assert!(armed.query_render().unwrap().ready);
}

#[cfg(feature = "mock")]
#[test]
fn an_unknown_render_value_discards_the_whole_command() {
    use crate::protocol::FrameType;
    use crate::protocol::opcode::OPT_RENDER;
    use crate::{Device, MockBox};
    let mock = MockBox::new();
    let device = Device::with_mock(mock.clone());
    device.set_render(RenderMode::Stock, true).unwrap();
    let before = device.query_render().unwrap();
    // Past the typed API: the box refuses a mode past the last and a `full` past 1 without coercing
    // either, so the standing setting survives both.
    for bad in [[OPT_RENDER, 4, 0], [OPT_RENDER, 2, 2]] {
        device.link.send(FrameType::Option, &bad).unwrap();
        assert_eq!(device.query_render().unwrap(), before);
    }
}

#[cfg(feature = "mock")]
#[test]
fn mock_rate_force_matches_firmware_snap() {
    use crate::{Device, MockBox};
    // A clone that declares 125 Hz, with the opt-in on so a force can actually apply.
    let mock = MockBox::new()
        .with_advertised_hz(125)
        .with_rate_force(Some(300));
    let device = Device::with_mock(mock.clone());
    device.allow_imperfect_clones(true).unwrap();
    // 300 Hz resolves to bInterval 2, the interval a host would actually keep for 1000/300.
    let s = device.query_emit_pace().unwrap();
    assert_eq!(s.force_hz, Some(300));
    assert_eq!(s.advertised_hz, 500);
    assert!(s.force_active);
    // Above the frame-clock ceiling resolves to bInterval 1.
    mock.set_rate_force(Some(4000));
    let s = device.query_emit_pace().unwrap();
    assert_eq!(s.force_hz, Some(4000));
    assert_eq!(s.advertised_hz, 1000);
    // 125 is exactly a power-of-two interval, so it is the one rate that comes back unchanged.
    mock.set_rate_force(Some(125));
    assert_eq!(device.query_emit_pace().unwrap().advertised_hz, 125);
    // The slowest a full-speed clone can advertise: bInterval 128, the largest power of two in a byte.
    mock.set_rate_force(Some(1));
    assert_eq!(device.query_emit_pace().unwrap().advertised_hz, 7);
    // Some(0) is what the wire calls off, and dividing by it would panic.
    mock.set_rate_force(Some(0));
    let s = device.query_emit_pace().unwrap();
    assert_eq!(s.force_hz, None);
    assert!(!s.force_active);
    mock.set_rate_force(None);
    let s = device.query_emit_pace().unwrap();
    assert_eq!(s.force_hz, None);
    assert!(!s.force_active);
    assert_eq!(s.advertised_hz, 125);
}

#[cfg(feature = "mock")]
#[test]
fn mock_leaves_a_force_inert_without_the_opt_in() {
    use crate::{Device, EmitPace, MockBox};
    // The box gates a force on the imperfect opt-in; a mock reporting it active regardless would pass
    // host code every real box disagrees with.
    let mock = MockBox::new().with_advertised_hz(125);
    let device = Device::with_mock(mock.clone());
    device.set_emit_pace(EmitPace::Learned, Some(1000)).unwrap();
    let s = device.query_emit_pace().unwrap();
    assert_eq!(s.force_hz, Some(1000));
    assert!(!s.force_active);
    assert_eq!(s.advertised_hz, 125);
    device.allow_imperfect_clones(true).unwrap();
    let s = device.query_emit_pace().unwrap();
    assert!(s.force_active);
    assert_eq!(s.advertised_hz, 1000);
}

#[test]
fn unknown_option_id_and_missing_id_are_none() {
    assert!(parse_resp(&[9, 0xFF, 0, 0]).is_none());
    assert!(parse_resp(&[9]).is_none());
}

#[cfg(feature = "mock")]
#[test]
fn set_movement_riding_rounds_sub_ms_up_to_on() {
    use crate::{Device, MockBox};
    let mock = MockBox::new();
    let device = Device::with_mock(mock.clone());
    // a non-zero Some window under 1 ms must not silently round down to off
    device
        .set_movement_riding(Some(Duration::from_micros(500)))
        .unwrap();
    let frame = mock
        .recorded_frames()
        .into_iter()
        .find(|f| f.ty == FrameType::Option)
        .unwrap();
    assert_eq!(frame.payload, vec![1, 1, 0]);
}

#[cfg(feature = "mock")]
#[test]
fn set_movement_riding_saturates_at_u16_max() {
    use crate::{Device, MockBox};
    let mock = MockBox::new();
    let device = Device::with_mock(mock.clone());
    // a window past u16::MAX ms must saturate, not wrap
    device
        .set_movement_riding(Some(Duration::from_millis(100_000)))
        .unwrap();
    let frame = mock
        .recorded_frames()
        .into_iter()
        .find(|f| f.ty == FrameType::Option)
        .unwrap();
    assert_eq!(frame.payload, vec![1, 0xFF, 0xFF]);
}

#[cfg(feature = "mock")]
#[test]
fn set_name_sends_option_frame_and_clear_is_empty() {
    use crate::{Device, MockBox};
    let mock = MockBox::new();
    let device = Device::with_mock(mock.clone());
    device.set_name("Left PC").unwrap();
    let frame = mock
        .recorded_frames()
        .into_iter()
        .find(|f| f.ty == FrameType::Option)
        .unwrap();
    assert_eq!(frame.payload, b"\x03Left PC".to_vec());
    device.clear_name().unwrap();
    let cleared = mock
        .recorded_frames()
        .into_iter()
        .rfind(|f| f.ty == FrameType::Option)
        .unwrap();
    assert_eq!(cleared.payload, vec![3]);
}

#[cfg(feature = "mock")]
#[test]
fn set_name_sends_the_value_raw_for_the_box_to_sanitize() {
    use crate::{Device, MockBox};
    // set_name sends the string as is and the box sanitises, so a control byte goes out on the wire
    // (the box drops it) with no host error.
    let mock = MockBox::new();
    let device = Device::with_mock(mock.clone());
    device.set_name("A\tB").unwrap();
    let frame = mock
        .recorded_frames()
        .into_iter()
        .find(|f| f.ty == FrameType::Option)
        .unwrap();
    assert_eq!(frame.payload, vec![3, b'A', b'\t', b'B']);
}

#[test]
fn bearing_payload_bytes() {
    use crate::protocol::command::bearing_payload;
    use crate::protocol::opcode::{BEARING_PER_AXIS, BEARING_VECTOR};
    assert_eq!(bearing_payload(20, BEARING_PER_AXIS), [4, 20, 0, 0]);
    assert_eq!(bearing_payload(500, BEARING_VECTOR), [4, 0xF4, 0x01, 1]);
    assert_eq!(bearing_payload(0, BEARING_PER_AXIS), [4, 0, 0, 0]);
}

#[test]
fn bearing_decodes_from_a_resp() {
    use crate::protocol::{Resp, parse_resp};
    use crate::types::BearingMode;
    use std::time::Duration;
    let Some(Resp::Bearing(b)) = parse_resp(&[9, 4, 20, 0, 0]) else {
        panic!("expected Bearing");
    };
    assert_eq!(b.window, Some(Duration::from_millis(20)));
    assert_eq!(b.mode, BearingMode::PerAxis);
    assert!(b.is_live());

    // A zero window is off, not a zero-length one: the relative directions do nothing at all.
    let Some(Resp::Bearing(off)) = parse_resp(&[9, 4, 0, 0, 1]) else {
        panic!("expected Bearing");
    };
    assert_eq!(off.window, None);
    assert_eq!(off.mode, BearingMode::Vector);
    assert!(!off.is_live());

    // An unknown mode is not silently read as per-axis.
    assert!(parse_resp(&[9, 4, 20, 0, 7]).is_none());
    assert!(parse_resp(&[9, 4, 20, 0]).is_none());
}

#[cfg(feature = "mock")]
#[test]
fn set_bearing_sends_the_option_frame() {
    use crate::types::BearingMode;
    use crate::{Device, MockBox};
    use std::time::Duration;
    let mock = MockBox::new();
    let device = Device::with_mock(mock.clone());
    device
        .set_bearing(Some(Duration::from_millis(20)), BearingMode::Vector)
        .unwrap();
    let frame = mock
        .recorded_frames()
        .into_iter()
        .find(|f| f.ty == FrameType::Option)
        .unwrap();
    assert_eq!(frame.payload, vec![4, 20, 0, 1]);

    device.set_bearing(None, BearingMode::PerAxis).unwrap();
    let off = mock
        .recorded_frames()
        .into_iter()
        .rfind(|f| f.ty == FrameType::Option)
        .unwrap();
    assert_eq!(off.payload, vec![4, 0, 0, 0]);
}

#[cfg(feature = "mock")]
#[test]
fn query_bearing_round_trips_through_the_mock() {
    use crate::types::{Bearing, BearingMode};
    use crate::{Device, MockBox};
    use std::time::Duration;
    let want = Bearing {
        window: Some(Duration::from_millis(35)),
        mode: BearingMode::Vector,
    };
    let mock = MockBox::new().with_bearing(want);
    let device = Device::with_mock(mock);
    assert_eq!(device.query_bearing().unwrap(), want);
}

#[cfg(feature = "mock")]
#[test]
fn scale_sends_the_lock_frame_with_the_percentage() {
    use crate::{Axis, Device, Direction, MockBox};
    let mock = MockBox::new();
    let device = Device::with_mock(mock.clone());
    device.scale(Axis::X, Direction::Against, 40).unwrap();
    device.scale(Axis::Y, Direction::With, 130).unwrap();
    let frames: Vec<Vec<u8>> = mock
        .recorded_frames()
        .into_iter()
        .filter(|f| f.ty == FrameType::Lock)
        .map(|f| f.payload)
        .collect();
    assert_eq!(
        frames,
        vec![vec![3, 0, 0, 4, 40, 0], vec![3, 1, 0, 3, 130, 0]]
    );
}

#[cfg(feature = "mock")]
#[test]
fn lock_and_unlock_are_the_two_ends_of_the_scale() {
    use crate::{Axis, Device, Direction, MockBox};
    let mock = MockBox::new();
    let device = Device::with_mock(mock.clone());
    device.lock(Axis::X, Direction::Positive).unwrap();
    device.unlock(Axis::X, Direction::Positive).unwrap();
    let frames: Vec<Vec<u8>> = mock
        .recorded_frames()
        .into_iter()
        .filter(|f| f.ty == FrameType::Lock)
        .map(|f| f.payload)
        .collect();
    assert_eq!(
        frames,
        vec![vec![3, 0, 0, 1, 0, 0], vec![3, 0, 0, 1, 100, 0]]
    );
}

#[cfg(feature = "mock")]
#[test]
fn a_relative_direction_is_refused_on_a_catch_subscription() {
    use crate::{CatchFilter, Device, Direction, Error, MockBox, TrafficClass};
    let device = Device::with_mock(MockBox::new());
    let err = device
        .catch_events([
            CatchFilter::traffic(TrafficClass::VendorBulk, 3).with_direction(Direction::Against)
        ])
        .unwrap_err();
    assert!(
        matches!(
            err,
            Error::RelativeDirection {
                direction: Direction::Against,
                ..
            }
        ),
        "expected RelativeDirection, got {err:?}"
    );
}