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
45
46
47
48
49
50
51
52
53
54
55
56
57

pub mod api;
pub mod api_commands;
pub mod error;
pub mod keycodes;
pub mod scan;
pub mod utils;

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

pub use error::*;

#[cfg(feature = "python")]
create_exception!(qmk_via_api, QmkViaError, PyException);
#[cfg(feature = "python")]
create_exception!(qmk_via_api, HidError, QmkViaError);
#[cfg(feature = "python")]
create_exception!(qmk_via_api, DeviceNotFoundError, QmkViaError);
#[cfg(feature = "python")]
create_exception!(qmk_via_api, UnsupportedProtocolError, QmkViaError);
#[cfg(feature = "python")]
create_exception!(qmk_via_api, SizeMismatchError, QmkViaError);
#[cfg(feature = "python")]
create_exception!(qmk_via_api, CommandResponseError, QmkViaError);
#[cfg(feature = "python")]
create_exception!(qmk_via_api, InvalidArgumentError, QmkViaError);

#[cfg(feature = "python")]
#[pymodule]
fn qmk_via_api(_py: Python, m: &Bound<'_, PyModule>) -> PyResult<()> {
    m.add_class::<api::KeyboardApi>()?;
    m.add_class::<api_commands::ViaCommandId>()?;
    m.add_class::<api::MatrixInfo>()?;
    m.add_class::<scan::KeyboardDeviceInfo>()?;
    m.add("QmkViaError", _py.get_type::<QmkViaError>())?;
    m.add("HidError", _py.get_type::<HidError>())?;
    m.add("DeviceNotFoundError", _py.get_type::<DeviceNotFoundError>())?;
    m.add(
        "UnsupportedProtocolError",
        _py.get_type::<UnsupportedProtocolError>(),
    )?;
    m.add("SizeMismatchError", _py.get_type::<SizeMismatchError>())?;
    m.add(
        "CommandResponseError",
        _py.get_type::<CommandResponseError>(),
    )?;
    m.add(
        "InvalidArgumentError",
        _py.get_type::<InvalidArgumentError>(),
    )?;
    m.add_function(wrap_pyfunction!(scan::scan_keyboards, m)?)?;
    Ok(())
}