rmk 0.8.2

Keyboard firmware written in Rust
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106

use embassy_time::{Instant, Timer};

use crate::debounce::{DebounceState, DebouncerTrait};
use crate::driver::flex_pin::FlexPin;
use crate::event::{Event, KeyboardEvent};
use crate::input_device::InputDevice;
use crate::matrix::{KeyState, MatrixTrait};

pub enum ScanLocation {
    Pins(usize, usize),
    Ignore,
}

/// Matrix is the physical pcb layout of the keyboard matrix.
pub struct BidirectionalMatrix<
    Pin: FlexPin,
    D: DebouncerTrait<ROW, COL>,
    const PIN_NUM: usize,
    const ROW: usize,
    const COL: usize,
> {
    /// Input pins of the pcb matrix
    pins: [Pin; PIN_NUM],
    /// Debouncer
    debouncer: D,
    /// Key state matrix
    key_state: [[KeyState; COL]; ROW],
    /// Start scanning
    scan_start: Option<Instant>,
    /// Current scan pos: (row_idx, col_idx)
    scan_pos: (usize, usize),
    /// Scan map
    scan_map: [[ScanLocation; COL]; ROW],
}

impl<Pin: FlexPin, D: DebouncerTrait<ROW, COL>, const PIN_NUM: usize, const ROW: usize, const COL: usize>
    BidirectionalMatrix<Pin, D, PIN_NUM, ROW, COL>
{
    /// Create a matrix from input and output pins.
    pub fn new(pins: [Pin; PIN_NUM], debouncer: D, scan_map: [[ScanLocation; COL]; ROW]) -> Self {
        BidirectionalMatrix {
            pins,
            debouncer,
            key_state: [[KeyState::new(); COL]; ROW],
            scan_start: None,
            scan_pos: (0, 0),
            scan_map,
        }
    }
}

impl<Pin: FlexPin, D: DebouncerTrait<ROW, COL>, const PIN_NUM: usize, const ROW: usize, const COL: usize> InputDevice
    for BidirectionalMatrix<Pin, D, PIN_NUM, ROW, COL>
{
    async fn read_event(&mut self) -> crate::event::Event {
        loop {
            let (scan_x_start, scan_y_start) = self.scan_pos;

            // Scan following the scan map and send report
            // Loop through rows.
            for scan_y_idx in scan_y_start..self.scan_map.len() {
                // Loop trough cols.
                let scan_x_start_current = if scan_y_idx == scan_y_start { scan_x_start } else { 0 };
                for scan_x_idx in scan_x_start_current..self.scan_map[scan_y_idx].len() {
                    if let ScanLocation::Pins(in_idx, out_idx) = self.scan_map[scan_y_idx][scan_x_idx] {
                        let [in_pin, out_pin] = self.pins.get_disjoint_mut([in_idx, out_idx]).unwrap();
                        // Set output pin to high.
                        out_pin.set_as_output();
                        out_pin.set_high().ok();
                        Timer::after_micros(1).await;

                        // Check input pin and debounce
                        let debounce_state = self.debouncer.detect_change_with_debounce(
                            scan_y_idx,
                            scan_x_idx,
                            in_pin.is_high().ok().unwrap_or_default(),
                            &self.key_state[scan_y_idx][scan_x_idx],
                        );
                        if let DebounceState::Debounced = debounce_state {
                            self.key_state[scan_y_idx][scan_x_idx].toggle_pressed();
                            self.scan_pos = (scan_y_idx, scan_x_idx);
                            return Event::Key(KeyboardEvent::key(
                                scan_y_idx as u8,
                                scan_x_idx as u8,
                                self.key_state[scan_y_idx][scan_x_idx].pressed,
                            ));
                        }

                        // Pull output pin back to low
                        out_pin.set_low().ok();
                        out_pin.set_as_input();
                        Timer::after_micros(1).await;
                    }
                }
            }
            self.scan_pos = (0, 0);
        }
    }
}

impl<Pin: FlexPin, D: DebouncerTrait<ROW, COL>, const PIN_NUM: usize, const ROW: usize, const COL: usize>
    MatrixTrait<ROW, COL> for BidirectionalMatrix<Pin, D, PIN_NUM, ROW, COL>
{
    #[cfg(feature = "async_matrix")]
    async fn wait_for_key(&mut self) {}
}