openlogi-device-registry 0.8.0

Pure hardware identity registry for OpenLogi devices and receivers.
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

//! Logitech Litra raw-HID identities.

use crate::LOGITECH_VENDOR_ID;

/// Stable driver-family identifier carried by standalone Litra inventory.
pub const LITRA_DRIVER_ID: &str = "litra";
/// Litra Glow product ID.
pub const LITRA_GLOW_PRODUCT_ID: u16 = 0xc900;
/// Litra Beam product ID.
pub const LITRA_BEAM_PRODUCT_ID: u16 = 0xc901;
/// Litra vendor usage page.
pub const LITRA_USAGE_PAGE: u16 = 0xff43;
/// Litra vendor usage ID.
pub const LITRA_USAGE_ID: u16 = 0x0202;

/// A supported Litra product model.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LitraModel {
    /// Logitech Litra Glow.
    Glow,
    /// Logitech Litra Beam.
    Beam,
}

/// A known Litra raw-HID identity and its static product metadata.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct LitraDescriptor {
    /// USB vendor ID.
    pub vendor_id: u16,
    /// USB product ID.
    pub product_id: u16,
    /// HID usage page of the writable vendor collection.
    pub usage_page: u16,
    /// HID usage ID of the writable vendor collection.
    pub usage_id: u16,
    /// Product model selected by this identity.
    pub model: LitraModel,
    /// Stable standalone-driver family identifier.
    pub driver_id: &'static str,
    /// Exact model identifier used by the OpenLogi asset registry.
    pub registry_model_id: &'static str,
}

impl LitraDescriptor {
    const fn logitech(product_id: u16, model: LitraModel, registry_model_id: &'static str) -> Self {
        Self {
            vendor_id: LOGITECH_VENDOR_ID,
            product_id,
            usage_page: LITRA_USAGE_PAGE,
            usage_id: LITRA_USAGE_ID,
            model,
            driver_id: LITRA_DRIVER_ID,
            registry_model_id,
        }
    }
}

/// All standalone Litra raw-HID identities supported by OpenLogi.
pub const LITRA_DEVICES: &[LitraDescriptor] = &[
    LitraDescriptor::logitech(LITRA_GLOW_PRODUCT_ID, LitraModel::Glow, "8c900"),
    LitraDescriptor::logitech(LITRA_BEAM_PRODUCT_ID, LitraModel::Beam, "8c901"),
];

/// Finds a Litra descriptor by its complete writable raw-HID identity.
#[must_use]
pub fn find_litra(
    vendor_id: u16,
    product_id: u16,
    usage_page: u16,
    usage_id: u16,
) -> Option<&'static LitraDescriptor> {
    LITRA_DEVICES.iter().find(|device| {
        device.vendor_id == vendor_id
            && device.product_id == product_id
            && device.usage_page == usage_page
            && device.usage_id == usage_id
    })
}

/// Whether an HID descriptor identifies a supported Litra interface.
#[must_use]
pub fn matches_litra(vendor_id: u16, product_id: u16, usage_page: u16, usage_id: u16) -> bool {
    find_litra(vendor_id, product_id, usage_page, usage_id).is_some()
}

#[cfg(test)]
mod tests {
    use super::{LITRA_DEVICES, LITRA_DRIVER_ID, LitraModel, find_litra};
    use crate::LOGITECH_VENDOR_ID;

    #[test]
    fn litra_identities_are_unique() {
        for (index, device) in LITRA_DEVICES.iter().enumerate() {
            assert!(
                LITRA_DEVICES[..index].iter().all(|other| {
                    (
                        other.vendor_id,
                        other.product_id,
                        other.usage_page,
                        other.usage_id,
                    ) != (
                        device.vendor_id,
                        device.product_id,
                        device.usage_page,
                        device.usage_id,
                    )
                }),
                "duplicate Litra identity {:04x}:{:04x}/{:04x}:{:04x}",
                device.vendor_id,
                device.product_id,
                device.usage_page,
                device.usage_id
            );
        }
    }

    #[test]
    fn complete_identity_selects_glow_metadata() {
        let glow =
            find_litra(LOGITECH_VENDOR_ID, 0xc900, 0xff43, 0x0202).expect("Litra Glow identity");

        assert_eq!(glow.model, LitraModel::Glow);
        assert_eq!(glow.driver_id, LITRA_DRIVER_ID);
        assert_eq!(glow.registry_model_id, "8c900");
        assert!(find_litra(LOGITECH_VENDOR_ID, 0xc900, 0xff43, 0x0203).is_none());
    }

    #[test]
    fn complete_identity_selects_beam_metadata() {
        let beam =
            find_litra(LOGITECH_VENDOR_ID, 0xc901, 0xff43, 0x0202).expect("Litra Beam identity");

        assert_eq!(beam.model, LitraModel::Beam);
        assert_eq!(beam.registry_model_id, "8c901");
    }
}