qmk_via_api/
api_commands.rs

1#[cfg(feature = "python")]
2use pyo3::prelude::*;
3
4#[cfg_attr(feature = "python", pyclass)]
5#[derive(Clone, Copy, Debug, PartialEq)]
6pub enum ViaCommandId {
7    GetProtocolVersion = 0x01,
8    GetKeyboardValue = 0x02,
9    SetKeyboardValue = 0x03,
10    DynamicKeymapGetKeycode = 0x04,
11    DynamicKeymapSetKeycode = 0x05,
12    DynamicKeymapClearAll = 0x06,
13    CustomMenuSetValue = 0x07, // Deprecated alias: BACKLIGHT_CONFIG_SET_VALUE
14    CustomMenuGetValue = 0x08, // Deprecated alias: BACKLIGHT_CONFIG_GET_VALUE
15    CustomMenuSave = 0x09,     // Deprecated alias: BACKLIGHT_CONFIG_SAVE
16    EepromReset = 0x0a,
17    BootloaderJump = 0x0b,
18    DynamicKeymapMacroGetCount = 0x0c,
19    DynamicKeymapMacroGetBufferSize = 0x0d,
20    DynamicKeymapMacroGetBuffer = 0x0e,
21    DynamicKeymapMacroSetBuffer = 0x0f,
22    DynamicKeymapMacroReset = 0x10,
23    DynamicKeymapGetLayerCount = 0x11,
24    DynamicKeymapGetBuffer = 0x12,
25    DynamicKeymapSetBuffer = 0x13,
26    DynamicKeymapGetEncoder = 0x14,
27    DynamicKeymapSetEncoder = 0x15,
28}
29
30#[cfg_attr(feature = "python", pyclass)]
31#[derive(Clone, Copy, Debug, PartialEq)]
32pub enum ViaChannelId {
33    IdCustomChannel = 0,
34    IdQmkBacklightChannel = 1,
35    IdQmkRgblightChannel = 2,
36    IdQmkRgbMatrixChannel = 3,
37    IdQmkAudioChannel = 4,
38    IdQmkLedMatrixChannel = 5,
39}
40
41#[cfg_attr(feature = "python", pyclass)]
42#[derive(Clone, Copy, Debug, PartialEq)]
43pub enum ViaQmkBacklightValue {
44    IdQmkBacklightBrightness = 1,
45    IdQmkBacklightEffect = 2,
46}
47
48#[cfg_attr(feature = "python", pyclass)]
49#[derive(Clone, Copy, Debug, PartialEq)]
50pub enum ViaQmkRgblightValue {
51    IdQmkRgblightBrightness = 1,
52    IdQmkRgblightEffect = 2,
53    IdQmkRgblightEffectSpeed = 3,
54    IdQmkRgblightColor = 4,
55}
56
57#[cfg_attr(feature = "python", pyclass)]
58#[derive(Clone, Copy, Debug, PartialEq)]
59pub enum ViaQmkRgbMatrixValue {
60    IdQmkRgbMatrixBrightness = 1,
61    IdQmkRgbMatrixEffect = 2,
62    IdQmkRgbMatrixEffectSpeed = 3,
63    IdQmkRgbMatrixColor = 4,
64}
65
66#[cfg_attr(feature = "python", pyclass)]
67#[derive(Clone, Copy, Debug, PartialEq)]
68pub enum ViaQmkLedMatrixValue {
69    IdQmkLedMatrixBrightness = 1,
70    IdQmkLedMatrixEffect = 2,
71    IdQmkLedMatrixEffectSpeed = 3,
72}
73
74#[cfg_attr(feature = "python", pyclass)]
75#[derive(Clone, Copy, Debug, PartialEq)]
76pub enum ViaQmkAudioValue {
77    IdQmkAudioEnable = 1,
78    IdQmkAudioClickyEnable = 2,
79}