medius 3.3.0

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

//! Typed response/event decoders (box → PC).

use std::time::Duration;

use super::opcode::{
    OPT_BEARING, OPT_EMIT, OPT_IMPERFECT, OPT_MOVE_RIDE, Q_CAPS, Q_CATCH, Q_CLIP, Q_DEVICE_INFO,
    Q_FIRMWARE, Q_HEALTH, Q_LOCKS, Q_OPTIONS, Q_RATE, Q_STATS, Q_VERSION,
};
use crate::types::{
    Bearing, Caps, CatchState, ClipStatus, DeviceInfo, EmitPaceStatus, FirmwareInfo, Health,
    ImperfectStatus, Locks, LogLevel, LogLine, Rate, Stats, Version,
};

/// A decoded `RESP` (§4.1), keyed by the `what` selector at `payload[0]`.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Resp {
    Version(Version),
    Health(Health),
    DeviceInfo(DeviceInfo),
    Caps(Caps),
    Rate(Rate),
    Stats(Stats),
    Locks(Locks),
    Catch(CatchState),
    Imperfect(ImperfectStatus),
    /// `RESP(OPTIONS, MOVE_RIDE)`: the movement-riding window (`None` = off).
    MovementRiding(Option<Duration>),
    /// `RESP(OPTIONS, EMIT)`: the emit-rate pacing mode and the rate in effect.
    EmitPace(EmitPaceStatus),
    /// `RESP(OPTIONS, BEARING)`: the bearing window and how it is read.
    Bearing(Bearing),
    /// `RESP(CLIP)`: the device-side clip ring and playback status.
    Clip(ClipStatus),
    /// `RESP(FIRMWARE)`: both chips' versions and slot state (§4.16).
    Firmware(FirmwareInfo),
}

/// Parse a `RESP` payload (§4.1): `[what u8][data..]`.
pub fn parse_resp(payload: &[u8]) -> Option<Resp> {
    let what = *payload.first()?;
    match what {
        Q_VERSION => {
            if payload.len() < 11 {
                return None;
            }
            let mut mac = [0u8; 6];
            mac.copy_from_slice(&payload[5..11]);
            Some(Resp::Version(Version {
                proto_ver: payload[1],
                fw_major: payload[2],
                fw_minor: payload[3],
                fw_patch: payload[4],
                mac,
                // Variable ASCII name tail after the MAC, LEN-delimited like DEVICE_INFO's product; an
                // older box with no tail decodes to an empty name (the 11-byte header still parses).
                name: String::from_utf8_lossy(&payload[11..]).into_owned(),
            }))
        }
        Q_HEALTH => {
            if payload.len() < 2 {
                return None;
            }
            Some(Resp::Health(Health::from_flags(payload[1])))
        }
        Q_DEVICE_INFO => DeviceInfo::from_payload(payload).map(Resp::DeviceInfo),
        Q_CAPS => Caps::from_payload(payload).map(Resp::Caps),
        Q_RATE => Rate::from_payload(payload).map(Resp::Rate),
        Q_STATS => Stats::from_payload(payload).map(Resp::Stats),
        Q_LOCKS => Locks::from_payload(payload).map(Resp::Locks),
        Q_CATCH => CatchState::from_payload(payload).map(Resp::Catch),
        Q_CLIP => ClipStatus::from_payload(payload).map(Resp::Clip),
        Q_FIRMWARE => FirmwareInfo::from_payload(payload).map(Resp::Firmware),
        Q_OPTIONS => {
            let id = *payload.get(1)?;
            match id {
                OPT_IMPERFECT => ImperfectStatus::from_payload(payload).map(Resp::Imperfect),
                OPT_MOVE_RIDE => {
                    if payload.len() < 4 {
                        return None;
                    }
                    let ms = u16::from_le_bytes([payload[2], payload[3]]);
                    let dur = (ms != 0).then(|| Duration::from_millis(ms as u64));
                    Some(Resp::MovementRiding(dur))
                }
                OPT_EMIT => EmitPaceStatus::from_payload(payload).map(Resp::EmitPace),
                OPT_BEARING => Bearing::from_payload(payload).map(Resp::Bearing),
                _ => None,
            }
        }
        _ => None,
    }
}

/// Parse a `LOG` payload (§4.7): `[level u8][text UTF-8 (LEN-1)]`.
pub fn parse_log(payload: &[u8]) -> LogLine {
    match payload.split_first() {
        Some((&level, text)) => LogLine {
            level: LogLevel::from_u8(level),
            text: String::from_utf8_lossy(text).into_owned(),
        },
        None => LogLine {
            level: LogLevel::Info,
            text: String::new(),
        },
    }
}