mx-remote 1.0.0

Client library for Pulse-Eight MatrixOS devices over UDP multicast/broadcast
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
// Author: Lars Op den Kamp (lars@opdenkamp-it.nl)
// Copyright (c) 2026 Op den Kamp IT Solutions

//! Coverage over the opcode handlers.
//!
//! A handler nothing exercises has every field unpinned by construction, which
//! neither an offset sweep nor a poisoned fixture reports: both measure tests
//! that run, and an unexercised handler does not.

use crate::event::Event;
use crate::types::{ArcStatus, PowerStatus, AMP_TONE_HTTP_MAX, AMP_TONE_HTTP_MIN};
use crate::wire::{
    op, parse_bay_config, BayFeatures, BayStatus, DeviceFeature, EdidProfile, MxrSignalType,
    RcAction, RcKey, RcType, V2IP_PORT_VIDEO,
};

use crate::testing::{bay_config_rec, field, hello_payload, poisoned, stream_rec, uid_n};

use super::Harness;

/// A matrix with two inputs and one amplified output.
fn bay_state(n: u8) -> Harness {
    let mut h = Harness::new(n);
    h.hello(0x28, "FF88", "HD0001", DeviceFeature::VIDEO_ROUTING);
    let mut cfg = bay_config_rec(
        1,
        0,
        0,
        "Input 1",
        "Apple TV",
        BayStatus::NONE,
        BayFeatures::HDMI_IN,
    );
    cfg.extend(bay_config_rec(
        2,
        1,
        0,
        "Output 1",
        "TV",
        BayStatus::NONE,
        BayFeatures::HDMI_OUT | BayFeatures::AUDIO_AMP_OUT,
    ));
    cfg.extend(bay_config_rec(
        3,
        0,
        1,
        "Input 2",
        "Blu-ray",
        BayStatus::NONE,
        BayFeatures::HDMI_IN,
    ));
    h.feed(op::SYS_BAY_CONFIG, &cfg);
    h
}

#[test]
fn bay_targeted_handlers_reach_the_bay_they_name() {
    let mut h = bay_state(110);
    let sender = h.sender;

    // 0x04 DEV_CONNECT: an input reports signal, an output reports hot-plug.
    // The port and the flag differ and the other bay is asserted untouched, so
    // reading the port one byte over lands on the wrong bay rather than on the
    // same value.
    h.feed(op::DEV_CONNECT, &[2, 1]);
    assert_eq!(
        h.bay(2).hpd_detected,
        Some(true),
        "connect status did not set hot-plug on an output"
    );
    assert_ne!(
        h.bay(1).signal_detected,
        Some(true),
        "connect status for port 2 reached port 1"
    );

    // 0x05 DEV_POWER_CHANGE
    h.feed(op::DEV_POWER_CHANGE, &[2, 1]);
    assert_eq!(h.bay(2).power_status, Some(PowerStatus::On));
    assert_ne!(
        h.bay(1).power_status,
        Some(PowerStatus::On),
        "power change for port 2 reached port 1"
    );

    // 0x27 BAY_HIDE, addressed by uid then a u16 port
    let mut hide = sender.as_bytes().to_vec();
    hide.extend_from_slice(&[2, 0, 1]);
    h.feed(op::BAY_HIDE, &hide);
    assert_eq!(h.bay(2).hidden, Some(true));

    // 0x14 AUDIO_SET_VOLUME: uid, u16 port, then volume and mute
    let mut vol = sender.as_bytes().to_vec();
    vol.extend_from_slice(&[2, 0, 40, 45, 0, 0, 0, 0]);
    h.feed(op::AUDIO_SET_VOLUME, &vol);
    let volume = h.bay(2).audio_volume.expect("volume not recorded");
    assert_eq!(
        (volume.volume_left, volume.volume_right),
        (Some(40), Some(45))
    );

    // 0x12 AUDIO_VOLUME_MUTE: the notification form, port as a single byte
    h.feed(op::AUDIO_VOLUME_MUTE, &[2, 55, 60, 0]);
    let volume = h.bay(2).audio_volume.expect("volume not recorded");
    assert_eq!(
        (volume.volume_left, volume.volume_right),
        (Some(55), Some(60))
    );

    // 0x0B RC_KEY and 0x0D RC_ACTION, both a u16 port from protocol 6
    h.feed(op::RC_KEY, &[1, 0, 0x41, 0x00]);
    assert!(h.saw(|e| matches!(e, Event::KeyPressed { key, .. } if *key == RcKey::from_wire(0x41))));
    h.feed(
        op::RC_ACTION,
        &[1, 0, RcAction::POWER_ON.to_wire() as u8, 0],
    );
    assert!(h.saw(
        |e| matches!(e, Event::ActionReceived { action, .. } if *action == RcAction::POWER_ON)
    ));

    // 0x11 AUDIO_CLIP
    h.feed(op::AUDIO_CLIP, &[2, 1]);
    assert!(h.saw(
        |e| matches!(e, Event::AudioClipped { clip, .. } if clip.port == 2 && clip.clip == 1)
    ));

    // 0x39 BAY_STATUS: a u16 port, then mxr_cfg_signal, which is a 14-byte
    // description followed by a 2-byte signal type. The type bytes are
    // non-zero here, so a description read past 14 picks them up.
    let mut st = poisoned(28);
    st[0..2].copy_from_slice(&1u16.to_le_bytes());
    st[2..16].copy_from_slice(b"1080p60 444 8b"); // exactly 14: no terminator
    st[16] = 0x13;
    st[17] = 0x20; // signal type, not part of the description
    st[20..24].copy_from_slice(&BayStatus::SIGNAL_DETECTED.bits().to_le_bytes());
    st[24..28].copy_from_slice(&BayFeatures::HDMI_IN.bits().to_le_bytes());
    h.feed(op::BAY_STATUS, &st);
    assert_eq!(h.bay(1).signal_detected, Some(true));
    assert_eq!(h.bay(1).features, BayFeatures::HDMI_IN);
    assert_eq!(h.bay(1).signal_type.as_deref(), Some("1080p60 444 8b"));

    // The port is two bytes wide, and no bay can sit above 255, so a status
    // frame naming port 257 belongs to no bay at all. Either half of that port
    // read on its own lands on bay 1 and applies this description to it.
    st[0] = 1;
    st[1] = 1;
    st[2..16].copy_from_slice(b"480i60 422 12 ");
    h.feed(op::BAY_STATUS, &st);
    assert_eq!(
        h.bay(1).signal_type.as_deref(),
        Some("1080p60 444 8b"),
        "a status frame for port 257 reached port 1"
    );
}

#[test]
fn routing_and_device_handlers() {
    let mut h = bay_state(111);
    let sender = h.sender;

    // 0x08 MX_ROUTE, packed with u16 ports: sink at 0, selected at 2, video at
    // 4, scrambled at 6, audio at 7. Selected is deliberately a different bay
    // from video, so decoding it as the video source is visible.
    let mut rt = poisoned(9);
    rt[0..2].copy_from_slice(&2u16.to_le_bytes()); // sink
    rt[2..4].copy_from_slice(&2u16.to_le_bytes()); // selected: not the shown input
    rt[4..6].copy_from_slice(&1u16.to_le_bytes()); // video
    rt[7..9].copy_from_slice(&3u16.to_le_bytes()); // audio: a different bay again
    h.feed(op::MX_ROUTE, &rt);
    assert_eq!(h.bay(2).video_source.map(|b| b.port), Some(1));
    assert_eq!(h.bay(2).effective_audio_source().map(|b| b.port), Some(3));

    // 0x15 SYS_TEMPERATURE: a count then that many readings
    h.feed(op::SYS_TEMPERATURE, &[2, 41, 43]);
    assert_eq!(h.device().temperatures, vec![41, 43]);

    // 0x44 V2IP_BAY_MAPPINGS: count<<1|is_input, first bay, then uids from 8
    let mapped = uid_n(112);
    let mut bm = poisoned(24);
    bm[0..2].copy_from_slice(&((1u16 << 1) | 1).to_le_bytes());
    bm[2..4].copy_from_slice(&0u16.to_le_bytes()); // first bay number
    bm[8..24].copy_from_slice(mapped.as_bytes());
    h.feed(op::V2IP_BAY_MAPPINGS, &bm);
    assert_eq!(h.bay(1).v2ip_uid, mapped);

    // 0x40 V2IP_TILING addressed at a known device caches as its window
    let mut tl = sender.as_bytes().to_vec();
    tl.resize(24, 0);
    tl[16..18].copy_from_slice(&640u16.to_le_bytes());
    tl[20..22].copy_from_slice(&1920u16.to_le_bytes());
    tl[22..24].copy_from_slice(&1080u16.to_le_bytes());
    h.feed(op::V2IP_TILING, &tl);
    let tiling = h.device().tiling.expect("tiling not recorded");
    assert_eq!(
        (tiling.pos_x, tiling.width, tiling.height),
        (640, 1920, 1080)
    );
}

#[test]
fn command_handlers_reach_their_events() {
    let mut h = bay_state(113);
    let target = uid_n(114);

    h.feed(op::SYS_DISCOVER, &[]);
    h.feed(op::V2IP_DETECT_BAYS, &[]);
    h.feed(op::V2IP_UPGRADE_FPGA, &[]);
    h.feed(op::SYS_MONITORING_PULSE, &[]);
    assert!(h.saw(|e| matches!(e, Event::DiscoverRequest { .. })));
    assert!(h.saw(|e| matches!(e, Event::DetectBaysRequested { .. })));
    assert!(h.saw(|e| matches!(e, Event::UpgradeFpgaRequested { .. })));
    assert!(h.saw(|e| matches!(e, Event::MonitoringPulse { .. })));

    h.feed(op::SYS_REBOOT, target.as_bytes());
    assert!(
        h.saw(|e| matches!(e, Event::RebootRequested { request, .. } if request.target == target))
    );

    let mut ep = target.as_bytes().to_vec();
    ep.extend_from_slice(&EdidProfile::UHD_4K.to_wire().to_le_bytes());
    ep.resize(24, 0);
    h.feed(op::BAY_EDID_PROFILE, &ep);
    assert!(h.saw(
        |e| matches!(e, Event::EdidProfileChangeRequested { change, .. }
        if change.target == target && change.profile == EdidProfile::UHD_4K)
    ));

    h.feed(op::V2IP_LINK_REMOTE, target.as_bytes());
    assert!(h.saw(|e| matches!(e, Event::V2ipLinkChanged { target: t, .. } if *t == target)));
}

/// 0x1F V2IP_SOURCE_SWITCH: a sink is told which groups to subscribe to, and
/// the sources are resolved back to the bays advertising those addresses.
#[test]
fn v2ip_source_switch_resolves_the_advertising_bay() {
    let mut h = Harness::new(120);
    let src = h.sender;
    h.hello(0x28, "ONEIP-TX", "TX9", DeviceFeature::V2IP_SOURCE);
    h.feed(
        op::SYS_BAY_CONFIG,
        &bay_config_rec(
            1,
            0,
            0,
            "Input 1",
            "Apple TV",
            BayStatus::NONE,
            BayFeatures::HDMI_IN,
        ),
    );
    h.feed(
        op::SYS_BAY_V2IP_SOURCES,
        &stream_rec(src, "239.5.5.1", "239.5.5.2", "239.5.5.3", V2IP_PORT_VIDEO),
    );

    let sink = uid_n(121);
    h.feed_as(
        sink,
        op::SYS_HELLO,
        &hello_payload(0x28, "ONEIP-RX", "RX9", "4.8.0", DeviceFeature::V2IP_SINK),
    );
    h.feed_as(
        sink,
        op::SYS_BAY_CONFIG,
        &bay_config_rec(
            1,
            1,
            0,
            "Output 1",
            "TV",
            BayStatus::NONE,
            BayFeatures::V2IP_SINK_LOCAL,
        ),
    );

    let mut p = sink.as_bytes().to_vec();
    p.extend_from_slice(&[239, 5, 5, 1]); // video group
    p.extend_from_slice(&[239, 5, 5, 2]); // audio group
    h.feed_as(sink, op::V2IP_SOURCE_SWITCH, &p);

    let out = h
        .state
        .bay(crate::wire::BayUid::new(sink, 1))
        .expect("sink bay");
    assert_eq!(
        out.video_source.map(|b| b.device),
        Some(src),
        "video source did not resolve to the advertising device"
    );
}

/// The bay descriptor underpins most of the read API - names, ports, sources,
/// EDID profile, remote-control target, status and features all come from this
/// one record. Every field gets a distinct value, so reading any of them at a
/// neighbour's offset changes the result.
#[test]
fn bay_config_decodes_every_field() {
    // Packed: port 0, mode 1, bay 2, a 2-byte union at 3, name 5, user name
    // 21, mxr_cfg_signal 37 (a 14-byte description then a 2-byte type),
    // status 53, features 57. 61 bytes.
    let mut rec = poisoned(crate::wire::BAY_CONFIG_SIZE);
    rec[0] = 7; // port
    rec[1] = 1; // mode: output
    rec[2] = 3; // bay number
    rec[3] = 11; // video source, or the low byte of the EDID/RC union
    rec[4] = 22; // audio source, or its high byte
    rec[5..21].copy_from_slice(b"0123456789ABCDEF"); // fills the field: no terminator
    field(&mut rec, 21, 16, "Living Room TV");
    rec[37..51].copy_from_slice(b"1080p60 444 8b"); // exactly 14: no terminator either
    rec[51..53].copy_from_slice(&0x2013u16.to_le_bytes());
    rec[53..57].copy_from_slice(&BayStatus::HIDDEN.bits().to_le_bytes());
    rec[57..61].copy_from_slice(&BayFeatures::HDMI_OUT.bits().to_le_bytes());

    let c = parse_bay_config(&rec).expect("record did not parse");
    assert_eq!((c.port, c.modenum, c.bay), (7, 1, 3));
    assert_eq!((c.video_source, c.audio_source), (11, 22));
    // The same two bytes are a 12-bit EDID profile and a 4-bit remote-control
    // target on a source bay.
    assert_eq!(
        c.edid_profile,
        EdidProfile::from_wire((22 & 0x0F) << 8 | 11)
    );
    assert_eq!(c.rc_type, RcType::from_wire(1));
    assert_eq!(c.bay_name, "0123456789ABCDEF");
    assert_eq!(c.user_name, "Living Room TV");
    // The description stops at 14; the two bytes after it are the signal type.
    assert_eq!(c.signal_type, "1080p60 444 8b");
    assert_eq!(c.signal_mode.svd(), 0x13);
    assert_eq!(c.signal_mode.bpp(), Some(8));
    assert_eq!(c.status, BayStatus::HIDDEN);
    assert_eq!(c.features, BayFeatures::HDMI_OUT);
}

/// The same record reaching a bay through the dispatcher.
#[test]
fn bay_config_reaches_the_bay() {
    let mut h = Harness::new(130);
    h.hello(0x28, "FF88", "BC0001", DeviceFeature::VIDEO_ROUTING);

    let mut rec = bay_config_rec(
        9,
        1,
        2,
        "Output 9",
        "Kitchen",
        BayStatus::HIDDEN,
        BayFeatures::HDMI_OUT,
    );
    rec[37..51].copy_from_slice(b"2160p50 420 10");
    rec[51..53].copy_from_slice(&0x4062u16.to_le_bytes()); // svd 98, bpp index 2 = 10
    h.feed(op::SYS_BAY_CONFIG, &rec);

    let bay = h.bay(9);
    assert_eq!(bay.user_name(), "Kitchen");
    assert_eq!(bay.port_name, "Output 9");
    assert_eq!(bay.hidden, Some(true));
    assert_eq!(bay.features, BayFeatures::HDMI_OUT);
    assert_eq!(bay.signal_type.as_deref(), Some("2160p50 420 10"));
    assert_eq!(bay.signal_mode.svd(), 98);
    assert_eq!(bay.signal_mode.bpp(), Some(10));
    assert_eq!(bay.arc, ArcStatus::Inactive);
    assert_eq!(bay.signal_mode, MxrSignalType::from_wire(0x4062));
}

/// An amplifier with one zone on the given port.
fn amp_state(n: u8, port: u8) -> Harness {
    let mut h = Harness::new(n);
    h.hello(0x28, "ProAmp8", "AMP0001", DeviceFeature::AUDIO_AMPLIFIER);
    h.feed(
        op::SYS_BAY_CONFIG,
        &bay_config_rec(
            port,
            1,
            0,
            "Zone 4",
            "Kitchen",
            BayStatus::NONE,
            BayFeatures::AUDIO_AMP_OUT,
        ),
    );
    h
}

/// Amp zone settings, laid out from the C declaration. Every field gets a
/// distinct value, and the delays exceed 65535 samples - the range a reading
/// that took the two padding bytes as part of the value could not represent.
#[test]
fn amp_zone_settings_decode() {
    let mut h = amp_state(140, 4);
    let sender = h.sender;

    const DELAY_L: u32 = 96_000; // 2s at 48kHz
    const DELAY_R: u32 = 144_000; // 3s
    let mut p = poisoned(56);
    p[0..16].copy_from_slice(sender.as_bytes());
    p[16..18].copy_from_slice(&4u16.to_le_bytes()); // zone
    p[18..22].copy_from_slice(&[200, 201, 12, 220]);
    p[24..28].copy_from_slice(&DELAY_L.to_le_bytes());
    p[28..32].copy_from_slice(&DELAY_R.to_le_bytes());
    p[32..37].copy_from_slice(&[130, 131, 1, 2, 33]);
    p[40..44].copy_from_slice(&900u32.to_le_bytes());
    p[44..49].copy_from_slice(&[120, 121, 122, 123, 124]);
    p[49..54].copy_from_slice(&[140, 141, 142, 143, 144]);
    h.feed(op::AMP_ZONE_SETTINGS, &p);

    let s = h.bay(4).amp_settings.expect("no amp settings");
    assert!(
        h.saw(|e| matches!(e, Event::AmpZoneSettingsChanged { .. })),
        "event did not fire"
    );
    assert_eq!((s.gain_left, s.gain_right), (200, 201));
    assert_eq!((s.volume_min, s.volume_max), (12, 220));
    assert_eq!(
        (s.delay_left, s.delay_right),
        (DELAY_L, DELAY_R),
        "padding read as part of the delay?"
    );
    assert_eq!((s.bass, s.treble), (130, 131));
    assert_eq!((s.bridged, s.power_mode, s.power_level), (1, 2, 33));
    assert_eq!(s.power_timeout, 900);
    assert_eq!(s.eq_left, [120, 121, 122, 123, 124]);
    assert_eq!(s.eq_right, [140, 141, 142, 143, 144]);
}

/// 0x3E: a target uid, then the Dolby mode byte and a flags byte.
#[test]
fn amp_dolby_decode() {
    let mut h = Harness::new(141);
    h.hello(0x28, "ProAmp8", "AMP0002", DeviceFeature::AUDIO_AMPLIFIER);
    let sender = h.sender;

    let mut p = poisoned(24);
    p[0..16].copy_from_slice(sender.as_bytes());
    p[16] = 2; // four-zone Dolby mode
    p[17] = 0x1 | 0x4; // upmix and upmix active; Dolby not detected
    h.feed(op::AMP_DOLBY_STATE, &p);

    let d = h.device().dolby_settings.expect("no dolby settings");
    assert_eq!(d.mode, 2);
    assert!(d.pcm_upmix && !d.dolby_detected && d.pcm_upmix_active);
}

/// The amp allocates the whole struct and writes through a struct pointer, so
/// the wire image carries the compiler's padding and 2-byte tail. A frame of
/// only the 54 bytes the fields occupy is not one the amp sends.
#[test]
fn amp_zone_settings_require_the_full_struct() {
    let mut h = amp_state(142, 4);
    let sender = h.sender;

    let mut short = poisoned(55);
    short[0..16].copy_from_slice(sender.as_bytes());
    short[16..18].copy_from_slice(&4u16.to_le_bytes());
    short[18] = 200;
    h.feed(op::AMP_ZONE_SETTINGS, &short);
    assert!(h.bay(4).amp_settings.is_none(), "a short frame was decoded");
}

/// An amp leaves the payload target zeroed and identifies itself in the frame
/// header, so the fallback to the sender is the normal path rather than an
/// edge case.
#[test]
fn amp_settings_with_a_zero_target_use_the_sender() {
    let mut h = amp_state(143, 2);

    let mut p = poisoned(56);
    p[0..16].fill(0); // target left zero, as the amp sends it
    p[16..18].copy_from_slice(&2u16.to_le_bytes());
    p[18] = 190;
    p[19] = 191;
    p[24..28].copy_from_slice(&48_000u32.to_le_bytes());
    h.feed(op::AMP_ZONE_SETTINGS, &p);

    let s = h
        .bay(2)
        .amp_settings
        .expect("a zero target should resolve to the sender");
    assert_eq!((s.gain_left, s.delay_left), (190, 48_000));
}

/// A tone byte outside the amp's HTTP bounds still decodes: the mesh receive
/// path copies these through without a range check, so the wire can carry any
/// value and this library reports what arrived rather than what one device's
/// own API would have accepted.
#[test]
fn amp_tone_outside_the_http_bounds_is_not_clamped() {
    let mut h = amp_state(144, 1);
    let sender = h.sender;

    let mut p = poisoned(56);
    p[0..16].copy_from_slice(sender.as_bytes());
    p[16..18].copy_from_slice(&1u16.to_le_bytes());
    p[32] = AMP_TONE_HTTP_MAX + 12; // above what the HTTP API allows
    p[33] = AMP_TONE_HTTP_MIN - 12; // below it
    h.feed(op::AMP_ZONE_SETTINGS, &p);

    let s = h.bay(1).amp_settings.expect("no amp settings");
    assert_eq!(
        (s.bass, s.treble),
        (AMP_TONE_HTTP_MAX + 12, AMP_TONE_HTTP_MIN - 12),
        "tone should be reported unclamped"
    );
}

/// 0x29 has four layouts across three version gates, plus two that share the
/// 0x22 stamp because the port and the feature word were widened without a
/// bump.
#[test]
fn network_status_layouts() {
    use crate::rx::network::parse_modern;
    use crate::types::MacAddress;
    use std::net::Ipv4Addr;

    // The later 0x22 form, as measured on a live mesh: name at 4, MAC at 21.
    let mut late = poisoned(144);
    late[0..2].copy_from_slice(&4u16.to_le_bytes());
    late[2..4].copy_from_slice(&((1u16 << 3) | (1 << 6)).to_le_bytes()); // igmp + uplink
    field(&mut late, 4, 17, "UTP PoE+");
    late[21..27].copy_from_slice(&[0x00, 0x15, 0x82, 0x13, 0x89, 0xae]);
    late[28..32].copy_from_slice(&[10, 8, 83, 228]);
    late[32..36].copy_from_slice(&[10, 8, 8, 254]);

    let s = parse_modern(&late).expect("late form did not parse");
    assert_eq!((s.port, s.name.as_str()), (4, "UTP PoE+"));
    assert_eq!(
        s.mac_address,
        Some(MacAddress([0x00, 0x15, 0x82, 0x13, 0x89, 0xae]))
    );
    assert_eq!(s.ip, Some(Ipv4Addr::new(10, 8, 83, 228)));
    assert_eq!(s.querier, Some(Ipv4Addr::new(10, 8, 8, 254)));

    // The earlier 0x22 form: everything ahead of the addresses shifts down
    // two, but the addresses do not move, because the address type aligns to 4.
    let mut early = poisoned(144);
    early[0] = 4;
    early[1] = (1 << 3) | (1 << 6);
    field(&mut early, 2, 17, "eth0");
    early[19..25].copy_from_slice(&[0x00, 0x15, 0x82, 0x13, 0x89, 0xae]);
    early[28..32].copy_from_slice(&[10, 8, 83, 229]);
    early[32..36].copy_from_slice(&[10, 8, 8, 254]);

    let s = parse_modern(&early).expect("early form did not parse");
    assert_eq!((s.port, s.name.as_str()), (4, "eth0"));
    assert_eq!(
        s.mac_address,
        Some(MacAddress([0x00, 0x15, 0x82, 0x13, 0x89, 0xae]))
    );
    assert_eq!(s.ip, Some(Ipv4Addr::new(10, 8, 83, 229)));
}

/// The legacy struct grew by appending, so a field only exists from the
/// version that added it: the addresses at 0x12 and the MAC at 0x21.
#[test]
fn network_status_legacy_gating() {
    use crate::rx::network::parse_legacy;
    use std::net::Ipv4Addr;

    let mut d = poisoned(146);
    field(&mut d, 112, 16, "UTP PoE+");
    d[132..136].copy_from_slice(&[10, 8, 83, 228]);
    d[136..140].copy_from_slice(&[10, 8, 8, 254]);
    d[140..146].copy_from_slice(&[0x00, 0x15, 0x82, 0x13, 0x89, 0xae]);

    let s = parse_legacy(&d, 0x21).expect("0x21 form did not parse");
    assert_eq!(s.name, "UTP PoE+");
    assert_eq!(s.ip, Some(Ipv4Addr::new(10, 8, 83, 228)));
    assert!(s.mac_address.is_some());

    // At 0x12 there is no MAC: offset 140 is whatever follows the struct.
    let s = parse_legacy(&d, 0x12).expect("0x12 form did not parse");
    assert_eq!(
        s.ip,
        Some(Ipv4Addr::new(10, 8, 83, 228)),
        "0x12 should still carry an address"
    );
    assert_eq!(s.mac_address, None, "0x12 predates the MAC");

    // At 0x06 there are no addresses either.
    let s = parse_legacy(&d, 0x06).expect("0x06 form did not parse");
    assert_eq!((s.ip, s.querier, s.mac_address), (None, None, None));
    assert_eq!(s.name, "UTP PoE+");
}