Add device scanning

Author: srwi

Cargo.lock

@@ -5,20 +5,20 @@ description = "VIA api implementation for QMK-based keyboards"
 authors = ["Stephan Rumswinkel"]
 repository = "https://github.com/srwi/qmk-via-api"
 readme = "README.md"
-version = "0.2.1"
+version = "0.3.0"
 edition = "2021"
 
 [lib]
 name = "qmk_via_api"
 crate-type = ["cdylib", "lib"]  # "cdylib" is necessary to produce a shared library for Python to import from.
 
 [dependencies]
-hidapi = "2.6.1"
-itertools = "0.12.1"
-num_enum = "0.7.3"
-strum = "0.26.3"
-strum_macros = "0.26.3"
+hidapi = "2.6.3"
+itertools = "0.14.0"
+num_enum = "0.7.4"
+strum = "0.27.2"
+strum_macros = "0.27.2"
 
 [dependencies.pyo3]
-version = "0.21.0"
+version = "0.26.0"
 features = ["abi3-py38"]  # "abi3-py38" tells pyo3 (and maturin) to build using the stable ABI with minimum Python version 3.8.

Cargo.toml

@@ -21,16 +21,16 @@ cargo add qmk-via-api
 Usage example:
 
 ```rust
-use qmk_via_api::api::KeyboardApi;
-
-const PRODUCT_VID: u16 = 0x594D;
-const PRODUCT_PID: u16 = 0x604D;
-const USAGE_PAGE: u16 = 0xff60;
+use qmk_via_api::{api::KeyboardApi, scan::scan_keyboards};
 
 fn main() {
-    let api = KeyboardApi::new(PRODUCT_VID, PRODUCT_PID, USAGE_PAGE).unwrap();
-    println!("Protocol version: {:?}", api.get_protocol_version());
-    println!("Layer count: {:?}", api.get_layer_count());
+    if let Some(dev) = scan_keyboards().first() {
+        let api = KeyboardApi::new(dev.vendor_id, dev.product_id, dev.usage_page).unwrap();
+        println!("Protocol version: {:?}", api.get_protocol_version());
+        println!("Layer count: {:?}", api.get_layer_count());
+    } else {
+        println!("No devices found");
+    }
 }
 ```
 
@@ -46,15 +46,16 @@ Usage example:
 
 ```python
 import qmk_via_api
+from qmk_via_api import scan_keyboards
 
-PRODUCT_VID = 0x594D
-PRODUCT_PID = 0x604D
-USAGE_PAGE = 0xff60
-
-if __name__ == "__main__":
-    api = qmk_via_api.KeyboardApi(PRODUCT_VID, PRODUCT_PID, USAGE_PAGE)
+devices = scan_keyboards()
+if devices:
+    dev = devices[0]
+    api = qmk_via_api.KeyboardApi(dev.vendor_id, dev.product_id, dev.usage_page)
     print(f"Protocol version {api.get_protocol_version()}")
     print(f"Layers count: {api.get_layer_count()}")
+else:
+    print("No devices found")
 ```
 
 # License & Attribution

README.md

@@ -53,7 +53,7 @@ impl FromStr for KeyboardValue {
     }
 }
 
-#[pyclass]
+#[pyclass(unsendable)]
 pub struct KeyboardApi {
     device: hidapi::HidDevice,
 }

src/api.rs

@@ -3,10 +3,13 @@ use pyo3::prelude::*;
 pub mod api;
 pub mod api_commands;
 pub mod keycodes;
+pub mod scan;
 pub mod utils;
 
 #[pymodule]
-fn qmk_via_api(_py: Python, m: &PyModule) -> PyResult<()> {
+fn qmk_via_api(_py: Python, m: &Bound<'_, PyModule>) -> PyResult<()> {
     m.add_class::<api::KeyboardApi>()?;
+    m.add_class::<scan::KeyboardDeviceInfo>()?;
+    m.add_function(wrap_pyfunction!(scan::scan_keyboards, m)?)?;
     Ok(())
 }