qmk-via-api 0.7.0

VIA api implementation for QMK-based keyboards
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

use crate::Result;
use hidapi::HidApi;

#[cfg(feature = "python")]
use pyo3::prelude::*;

const VIA_USAGE_PAGE: u16 = 0xff60;

/// Information about a connected VIA-compatible keyboard.
#[cfg_attr(feature = "python", pyclass(get_all, from_py_object))]
#[derive(Clone, Debug)]
pub struct KeyboardDeviceInfo {
    /// USB vendor ID
    pub vendor_id: u16,
    /// USB product ID
    pub product_id: u16,
    /// HID usage page (expected to be 0xFF60 for VIA)
    pub usage_page: u16,
    /// Optional manufacturer string
    pub manufacturer: Option<String>,
    /// Optional product string
    pub product: Option<String>,
    /// Optional serial number string
    pub serial_number: Option<String>,
}

/// Scan for connected VIA keyboards.
#[cfg_attr(feature = "python", pyfunction)]
pub fn scan_keyboards() -> Result<Vec<KeyboardDeviceInfo>> {
    let api = HidApi::new()?;

    Ok(api
        .device_list()
        .filter(|d| d.usage_page() == VIA_USAGE_PAGE)
        .map(|d| KeyboardDeviceInfo {
            vendor_id: d.vendor_id(),
            product_id: d.product_id(),
            usage_page: d.usage_page(),
            manufacturer: d.manufacturer_string().map(|s| s.to_string()),
            product: d.product_string().map(|s| s.to_string()),
            serial_number: d.serial_number().map(|s| s.to_string()),
        })
        .collect())
}