RKTK API Docs RKTK Home Repo

Struct Matrix

Source
pub struct Matrix<OP: OutputPin, IP: InputPin + Wait, T: Fn(usize, usize) -> Option<(usize, usize)>, const OUTPUT_PIN_COUNT: usize, const INPUT_PIN_COUNT: usize, const ROWS: usize, const COLS: usize> { /* private fields */ }
Expand description

Matrix scanner

NOTE: COLS const generic is the number of columns. Though you can set this value same as specified in [rktk::::config::static_config::Keyboard::cols], for split keyboard, this also can be set to “columns of the half keyboard”. By using this value, you can save memory usage.

Implementations§

Source§

impl<OP: OutputPin, IP: InputPin + Wait, T: Fn(usize, usize) -> Option<(usize, usize)>, const OUTPUT_PIN_COUNT: usize, const INPUT_PIN_COUNT: usize, const ROWS: usize, const COLS: usize> Matrix<OP, IP, T, OUTPUT_PIN_COUNT, INPUT_PIN_COUNT, ROWS, COLS>

Source

pub fn new( output_pins: [OP; OUTPUT_PIN_COUNT], input_pins: [IP; INPUT_PIN_COUNT], map_key_pos: T, scan_delay: Option<Duration>, ) -> Self

Initialize the scanner.

§Arguments
  • output_pins: Output pins to control the matrix.
  • input_pins: Input pins to read the matrix.
  • left_detect_key: The (logical, not pin index) key position to detect the hand.
  • map_key: Function to map key position from pin index. This function must return position within specified ROWS and COLS. Signature: (input_pin_idx, output_pin_idx) -> Option<(row, col)>
  • scan_delay: Delay between output pin change and input read. This is executed for each col/row so, this should be short enough to scan the matrix in a reasonable time. Default: 5us

Trait Implementations§

Source§

impl<OP: OutputPin, IP: InputPin + Wait, T: Fn(usize, usize) -> Option<(usize, usize)>, const OUTPUT_PIN_COUNT: usize, const INPUT_PIN_COUNT: usize, const ROWS: usize, const COLS: usize> KeyscanDriver for Matrix<OP, IP, T, OUTPUT_PIN_COUNT, INPUT_PIN_COUNT, ROWS, COLS>

Source§

async fn scan(&mut self, cb: impl FnMut(KeyChangeEvent))

Scans a key and returns the delta from the previous key scan

Auto Trait Implementations§

§

impl<OP, IP, T, const OUTPUT_PIN_COUNT: usize, const INPUT_PIN_COUNT: usize, const ROWS: usize, const COLS: usize> Freeze for Matrix<OP, IP, T, OUTPUT_PIN_COUNT, INPUT_PIN_COUNT, ROWS, COLS>
where T: Freeze, OP: Freeze, IP: Freeze,

§

impl<OP, IP, T, const OUTPUT_PIN_COUNT: usize, const INPUT_PIN_COUNT: usize, const ROWS: usize, const COLS: usize> RefUnwindSafe for Matrix<OP, IP, T, OUTPUT_PIN_COUNT, INPUT_PIN_COUNT, ROWS, COLS>

§

impl<OP, IP, T, const OUTPUT_PIN_COUNT: usize, const INPUT_PIN_COUNT: usize, const ROWS: usize, const COLS: usize> Send for Matrix<OP, IP, T, OUTPUT_PIN_COUNT, INPUT_PIN_COUNT, ROWS, COLS>
where T: Send, OP: Send, IP: Send,

§

impl<OP, IP, T, const OUTPUT_PIN_COUNT: usize, const INPUT_PIN_COUNT: usize, const ROWS: usize, const COLS: usize> Sync for Matrix<OP, IP, T, OUTPUT_PIN_COUNT, INPUT_PIN_COUNT, ROWS, COLS>
where T: Sync, OP: Sync, IP: Sync,

§

impl<OP, IP, T, const OUTPUT_PIN_COUNT: usize, const INPUT_PIN_COUNT: usize, const ROWS: usize, const COLS: usize> Unpin for Matrix<OP, IP, T, OUTPUT_PIN_COUNT, INPUT_PIN_COUNT, ROWS, COLS>
where T: Unpin, OP: Unpin, IP: Unpin,

§

impl<OP, IP, T, const OUTPUT_PIN_COUNT: usize, const INPUT_PIN_COUNT: usize, const ROWS: usize, const COLS: usize> UnwindSafe for Matrix<OP, IP, T, OUTPUT_PIN_COUNT, INPUT_PIN_COUNT, ROWS, COLS>
where T: UnwindSafe, OP: UnwindSafe, IP: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromColor<T> for T

Source§

fn from_color(color: T) -> T

Converts from the source color type
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

Source§

fn into_color(self) -> U

Converts into the target color type
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.