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
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

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

// V3
#[cfg_attr(feature = "python", pyclass(from_py_object))]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum ViaCommandId {
    GetProtocolVersion = 0x01,
    GetKeyboardValue = 0x02,
    SetKeyboardValue = 0x03,
    DynamicKeymapGetKeycode = 0x04,
    DynamicKeymapSetKeycode = 0x05,
    DynamicKeymapClearAll = 0x06,
    CustomMenuSetValue = 0x07, // Deprecated alias: BACKLIGHT_CONFIG_SET_VALUE
    CustomMenuGetValue = 0x08, // Deprecated alias: BACKLIGHT_CONFIG_GET_VALUE
    CustomMenuSave = 0x09,     // Deprecated alias: BACKLIGHT_CONFIG_SAVE
    EepromReset = 0x0a,
    BootloaderJump = 0x0b,
    DynamicKeymapMacroGetCount = 0x0c,
    DynamicKeymapMacroGetBufferSize = 0x0d,
    DynamicKeymapMacroGetBuffer = 0x0e,
    DynamicKeymapMacroSetBuffer = 0x0f,
    DynamicKeymapMacroReset = 0x10,
    DynamicKeymapGetLayerCount = 0x11,
    DynamicKeymapGetBuffer = 0x12,
    DynamicKeymapSetBuffer = 0x13,
    DynamicKeymapGetEncoder = 0x14,
    DynamicKeymapSetEncoder = 0x15,
}

#[cfg_attr(feature = "python", pyclass(from_py_object))]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum ViaChannelId {
    IdCustomChannel = 0,
    IdQmkBacklightChannel = 1,
    IdQmkRgblightChannel = 2,
    IdQmkRgbMatrixChannel = 3,
    IdQmkAudioChannel = 4,
    IdQmkLedMatrixChannel = 5,
}

#[cfg_attr(feature = "python", pyclass(from_py_object))]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum ViaQmkBacklightValue {
    IdQmkBacklightBrightness = 1,
    IdQmkBacklightEffect = 2,
}

#[cfg_attr(feature = "python", pyclass(from_py_object))]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum ViaQmkRgblightValue {
    IdQmkRgblightBrightness = 1,
    IdQmkRgblightEffect = 2,
    IdQmkRgblightEffectSpeed = 3,
    IdQmkRgblightColor = 4,
}

#[cfg_attr(feature = "python", pyclass(from_py_object))]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum ViaQmkRgbMatrixValue {
    IdQmkRgbMatrixBrightness = 1,
    IdQmkRgbMatrixEffect = 2,
    IdQmkRgbMatrixEffectSpeed = 3,
    IdQmkRgbMatrixColor = 4,
}

#[cfg_attr(feature = "python", pyclass(from_py_object))]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum ViaQmkLedMatrixValue {
    IdQmkLedMatrixBrightness = 1,
    IdQmkLedMatrixEffect = 2,
    IdQmkLedMatrixEffectSpeed = 3,
}

#[cfg_attr(feature = "python", pyclass(from_py_object))]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum ViaQmkAudioValue {
    IdQmkAudioEnable = 1,
    IdQmkAudioClickyEnable = 2,
}

// V2
#[cfg_attr(feature = "python", pyclass(from_py_object))]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum ViaLightingValue {
    IdBacklightBrightness = 0x09,
    IdBacklightEffect = 0x0a,
    IdQmkRgblightBrightness = 0x80,
    IdQmkRgblightEffect = 0x81,
    IdQmkRgblightEffectSpeed = 0x82,
    IdQmkRgblightColor = 0x83,
}