Struct KeyboardApi

pub struct KeyboardApi { /* private fields */ }

Implementations

impl KeyboardApi

pub fn new(vid: u16, pid: u16, usage_page: u16) -> PyResult<Self>

pub fn hid_command( &self, command: ViaCommandId, bytes: Vec<u8>, ) -> Option<Vec<u8>>

Sends a raw HID command prefixed with the command byte and returns the response if successful.

pub fn hid_read(&self) -> Option<Vec<u8>>

Reads from the HID device. Returns None if the read fails.

pub fn hid_send(&self, bytes: Vec<u8>) -> Option<()>

Sends a raw HID command prefixed with the command byte. Returns None if the send fails.

pub fn get_protocol_version(&self) -> Option<u16>

Returns the protocol version of the keyboard.

pub fn get_layer_count(&self) -> Option<u8>

Returns the number of layers on the keyboard.

pub fn get_key(&self, layer: Layer, row: Row, col: Column) -> Option<u16>

Returns the keycode at the given layer, row, and column.

pub fn set_key( &self, layer: Layer, row: Row, column: Column, val: u16, ) -> Option<u16>

Sets the keycode at the given layer, row, and column.

pub fn read_raw_matrix( &self, matrix_info: MatrixInfo, layer: Layer, ) -> Option<Vec<u16>>

Returns the keycodes for the given matrix info (number of rows and columns) and layer.

pub fn write_raw_matrix( &self, matrix_info: MatrixInfo, keymap: Vec<Vec<u16>>, ) -> Option<()>

Writes a keymap to the keyboard for the given matrix info (number of rows and columns).

pub fn get_keyboard_value( &self, command: KeyboardValue, parameters: Vec<u8>, result_length: usize, ) -> Option<Vec<u8>>

Returns a keyboard value. This can be used to retrieve keyboard information like uptime, layout options, switch matrix state and firmware version.

pub fn set_keyboard_value( &self, command: KeyboardValue, parameters: Vec<u8>, ) -> Option<()>

Sets a keyboard value. This can be used to set keyboard values like layout options or device indication.

pub fn get_encoder_value( &self, layer: Layer, id: u8, is_clockwise: bool, ) -> Option<u16>

Gets the encoder value for the given layer, id, and direction.

pub fn set_encoder_value( &self, layer: Layer, id: u8, is_clockwise: bool, keycode: u16, ) -> Option<()>

Sets the encoder value for the given layer, id, direction, and keycode.

pub fn get_custom_menu_value(&self, command_bytes: Vec<u8>) -> Option<Vec<u8>>

Get a custom menu value. This is a generic function that can be used to get any value specific to arbitrary keyboard functionalities.

pub fn set_custom_menu_value(&self, args: Vec<u8>) -> Option<()>

Set a custom menu value. This is a generic function that can be used to set any value specific to arbitrary keyboard functionalities.

pub fn save_custom_menu(&self, channel: u8) -> Option<()>

Saves the custom menu values for the given channel id.

pub fn get_backlight_brightness(&self) -> Option<u8>

Gets the backlight brightness.

pub fn set_backlight_brightness(&self, brightness: u8) -> Option<()>

Sets the backlight brightness.

pub fn get_backlight_effect(&self) -> Option<u8>

Gets the backlight effect.

pub fn set_backlight_effect(&self, effect: u8) -> Option<()>

Sets the backlight effect.

pub fn get_rgblight_brightness(&self) -> Option<u8>

Gets the RGB light brightness.

pub fn set_rgblight_brightness(&self, brightness: u8) -> Option<()>

Sets the RGB light brightness.

pub fn get_rgblight_effect(&self) -> Option<u8>

Gets the RGB light effect.

pub fn set_rgblight_effect(&self, effect: u8) -> Option<()>

Sets the RGB light effect.

pub fn get_rgblight_effect_speed(&self) -> Option<u8>

Gets the RGB light effect speed.

pub fn set_rgblight_effect_speed(&self, speed: u8) -> Option<()>

Sets the RGB light effect speed.

pub fn get_rgblight_color(&self) -> Option<(u8, u8)>

Gets the RGB light color.

pub fn set_rgblight_color(&self, hue: u8, sat: u8) -> Option<()>

Sets the RGB light color.

pub fn get_rgb_matrix_brightness(&self) -> Option<u8>

Gets the RGB matrix brightness.

pub fn set_rgb_matrix_brightness(&self, brightness: u8) -> Option<()>

Sets the RGB matrix brightness.

pub fn get_rgb_matrix_effect(&self) -> Option<u8>

Gets the RGB matrix effect.

pub fn set_rgb_matrix_effect(&self, effect: u8) -> Option<()>

Sets the RGB matrix effect.

pub fn get_rgb_matrix_effect_speed(&self) -> Option<u8>

Gets the RGB matrix effect speed.

pub fn set_rgb_matrix_effect_speed(&self, speed: u8) -> Option<()>

Sets the RGB matrix effect speed.

pub fn get_rgb_matrix_color(&self) -> Option<(u8, u8)>

Gets the RGB matrix color.

pub fn set_rgb_matrix_color(&self, hue: u8, sat: u8) -> Option<()>

Sets the RGB matrix color.

pub fn get_led_matrix_brightness(&self) -> Option<u8>

Gets the LED matrix brightness.

pub fn set_led_matrix_brightness(&self, brightness: u8) -> Option<()>

Sets the LED matrix brightness.

pub fn get_led_matrix_effect(&self) -> Option<u8>

Gets the LED matrix effect.

pub fn set_led_matrix_effect(&self, effect: u8) -> Option<()>

Sets the LED matrix effect.

pub fn get_led_matrix_effect_speed(&self) -> Option<u8>

Gets the LED matrix effect speed.

pub fn set_led_matrix_effect_speed(&self, speed: u8) -> Option<()>

Sets the LED matrix effect speed.

pub fn save_lighting(&self) -> Option<()>

Saves the lighting settings.

pub fn get_audio_enabled(&self) -> Option<bool>

Gets the audio enabled state.

pub fn set_audio_enabled(&self, enabled: bool) -> Option<()>

Sets the audio enabled state.

pub fn get_audio_clicky_enabled(&self) -> Option<bool>

Gets the audio clicky enabled state.

pub fn set_audio_clicky_enabled(&self, enabled: bool) -> Option<()>

Sets the audio clicky enabled state.

pub fn get_macro_count(&self) -> Option<u8>

Gets the macro count.

pub fn get_macro_bytes(&self) -> Option<Vec<u8>>

Gets the macro bytes. All macros are separated by 0x00.

pub fn set_macro_bytes(&self, data: Vec<u8>) -> Option<()>

Sets the macro bytes.

pub fn reset_macros(&self) -> Option<()>

Resets all saved macros.

pub fn reset_eeprom(&self) -> Option<()>

Resets the EEPROM, clearing all settings like keymaps and macros.

pub fn jump_to_bootloader(&self) -> Option<()>

Jumps to the bootloader.

Trait Implementations

impl HasPyGilRef for KeyboardApi

type AsRefTarget = PyCell<KeyboardApi>

Utility type to make Py::as_ref work.

impl IntoPy<Py<PyAny>> for KeyboardApi

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PyClass for KeyboardApi

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for KeyboardApi

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<KeyboardApi>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<KeyboardApi> for PyClassImplCollector<KeyboardApi>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a KeyboardApi

type Holder = Option<PyRef<'py, KeyboardApi>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut KeyboardApi

type Holder = Option<PyRefMut<'py, KeyboardApi>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<KeyboardApi> for PyClassImplCollector<KeyboardApi>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for KeyboardApi

const NAME: &'static str = "KeyboardApi"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> &PyType

👎Deprecated since 0.21.0: PyTypeInfo::type_object will be replaced by PyTypeInfo::type_object_bound in a future PyO3 version

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_type_of will be replaced by PyTypeInfo::is_type_of_bound in a future PyO3 version

Checks if object is an instance of this type or a subclass of this type.

fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_exact_type_of will be replaced by PyTypeInfo::is_exact_type_of_bound in a future PyO3 version

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for KeyboardApi