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>
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>
Sourcepub fn new(
output_pins: [OP; OUTPUT_PIN_COUNT],
input_pins: [IP; INPUT_PIN_COUNT],
map_key_pos: T,
scan_delay: Option<Duration>,
) -> Self
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 specifiedROWS
andCOLS
. 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>
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))
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>
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>
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>
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>
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>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CheckedAs for T
impl<T> CheckedAs for T
Source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.
Source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
Source§fn checked_cast_from(src: Src) -> Option<Dst>
fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.
Source§impl<T> FromColor<T> for T
impl<T> FromColor<T> for T
Source§fn from_color(color: T) -> T
fn from_color(color: T) -> T
Converts from the source color type
Source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
Source§fn into_color(self) -> U
fn into_color(self) -> U
Converts into the target color type
Source§impl<T> OverflowingAs for T
impl<T> OverflowingAs for T
Source§fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
Source§fn overflowing_cast_from(src: Src) -> (Dst, bool)
fn overflowing_cast_from(src: Src) -> (Dst, bool)
Casts the value.
Source§impl<T> SaturatingAs for T
impl<T> SaturatingAs for T
Source§fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
Source§fn saturating_cast_from(src: Src) -> Dst
fn saturating_cast_from(src: Src) -> Dst
Casts the value.
Source§impl<T> UnwrappedAs for T
impl<T> UnwrappedAs for T
Source§fn unwrapped_as<Dst>(self) -> Dstwhere
T: UnwrappedCast<Dst>,
fn unwrapped_as<Dst>(self) -> Dstwhere
T: UnwrappedCast<Dst>,
Casts the value.
Source§impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere
Src: UnwrappedCast<Dst>,
impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere
Src: UnwrappedCast<Dst>,
Source§fn unwrapped_cast_from(src: Src) -> Dst
fn unwrapped_cast_from(src: Src) -> Dst
Casts the value.
Source§impl<T> WrappingAs for T
impl<T> WrappingAs for T
Source§fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
Source§fn wrapping_cast_from(src: Src) -> Dst
fn wrapping_cast_from(src: Src) -> Dst
Casts the value.