rmk 0.8.3

Keyboard firmware written in Rust
Documentation 
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

extern crate rmk;

/// Macro for testing key sequence.
///
/// # Arguments:
///     - keyboard: keyboard initialization
///     - sequence: key sequence: [row, col, pressed, press_delay], where press_delay is the time interval in ms between last key action and current key
///     - expected_reports: [modifiers, [keycodes; 6]], represents the hid report which will be sent to the host
#[macro_export]
macro_rules! key_sequence_test {
    (keyboard: $keyboard:expr, sequence: [$([$row:expr, $col:expr, $pressed:expr, $delay:expr]),* $(,)?], expected_reports: [$([$modifier:expr, $keys:expr]),* $(,)?]) => {
        ::embassy_futures::block_on(async {
            let mut keyboard = $keyboard;
            let sequence = vec![
                $(
                    $crate::common::TestKeyPress {
                        row: $row,
                        col: $col,
                        pressed: $pressed,
                        delay: $delay,
                    },
                )*
            ];
            let expected_reports = vec![
                $(
                    rmk::descriptor::KeyboardReport {
                        modifier: $modifier,
                        keycodes: $keys,
                        leds: 0,
                        reserved: 0,
                    },
                )*
            ];

            $crate::common::run_key_sequence_test(&mut keyboard, &sequence, &expected_reports).await;
        });
    };
}

/// Convert a key `k!(key)` to the u8 representation in hid report.
/// For example, `KeyCode::A` will be converted to `0x04`.
#[macro_export]
macro_rules! kc_to_u8 {
    ($key: ident) => {
        rmk::types::keycode::KeyCode::$key as u8
    };
}