Add some examples.

Author: jonathanpallant

Cargo.toml

@@ -7,5 +7,6 @@ keywords = ["arm", "cortex-m", "template", "video", "menu"]
 categories = ["embedded", "no-std"]
 license = "MIT OR Apache-2.0"
 repository = "https://github.com/rust-embedded-community/pc-keyboard.git"
+edition = "2021"
 
 [dependencies]

examples/decoder.rs

@@ -0,0 +1,33 @@
+use pc_keyboard::Ps2Decoder;
+
+fn main() {
+    let mut decoder = Ps2Decoder::new();
+
+    // If you get all 11 bits as on `u16`
+    match decoder.add_word(0x0402) {
+        Ok(byte) => println!("Word 0x0402 is byte 0x{:02x}", byte),
+        Err(e) => println!("Word 0x0402 failed to decode: {:?}", e),
+    }
+
+    // If you get a bit at a time
+    for bit in [
+        false, true, false, false, false, false, false, false, false, false, true,
+    ] {
+        match decoder.add_bit(bit) {
+            Ok(None) => println!("Added {}, not enough bits yet!", bit as u8),
+            Ok(Some(byte)) => println!("Added {}, got byte 0x{byte:02x}", bit as u8),
+            Err(e) => println!("Failed to decode: {e:?}"),
+        }
+    }
+
+    // Flipped a random bit, so we get a parity error
+    for bit in [
+        false, true, false, false, false, false, true, false, false, false, true,
+    ] {
+        match decoder.add_bit(bit) {
+            Ok(None) => println!("Added {}, not enough bits yet!", bit as u8),
+            Ok(Some(byte)) => println!("Added {}, got byte 0x{byte:02x}", bit as u8),
+            Err(e) => println!("Failed to decode: {e:?}"),
+        }
+    }
+}

examples/layout.rs

@@ -0,0 +1,55 @@
+use pc_keyboard::{
+    layouts::{AnyLayout, Uk105Key},
+    DecodedKey, EventDecoder, KeyCode, KeyEvent, KeyState,
+};
+
+fn main() {
+    let mut decoder = EventDecoder::new(
+        AnyLayout::Uk105Key(Uk105Key),
+        pc_keyboard::HandleControl::Ignore,
+    );
+
+    // User presses 'A' on their UK keyboard, gets a lower-case 'a'.
+    let decoded_key = decoder.process_keyevent(KeyEvent {
+        code: KeyCode::A,
+        state: KeyState::Down,
+    });
+    assert_eq!(Some(DecodedKey::Unicode('a')), decoded_key);
+    println!("Got {:?}", decoded_key);
+
+    // User releases 'A' on their UK keyboard
+    let decoded_key = decoder.process_keyevent(KeyEvent {
+        code: KeyCode::A,
+        state: KeyState::Up,
+    });
+    assert_eq!(None, decoded_key);
+
+    // User presses 'Shift' on their UK keyboard
+    let decoded_key = decoder.process_keyevent(KeyEvent {
+        code: KeyCode::LShift,
+        state: KeyState::Down,
+    });
+    assert_eq!(None, decoded_key);
+
+    // User presses 'A' on their UK keyboard, now gets a Capital A
+    let decoded_key = decoder.process_keyevent(KeyEvent {
+        code: KeyCode::A,
+        state: KeyState::Down,
+    });
+    assert_eq!(Some(DecodedKey::Unicode('A')), decoded_key);
+    println!("Got {:?}", decoded_key);
+
+    // User releases 'A' on their UK keyboard
+    let decoded_key = decoder.process_keyevent(KeyEvent {
+        code: KeyCode::A,
+        state: KeyState::Up,
+    });
+    assert_eq!(None, decoded_key);
+
+    // User releases 'Shift' on their UK keyboard
+    let decoded_key = decoder.process_keyevent(KeyEvent {
+        code: KeyCode::LShift,
+        state: KeyState::Up,
+    });
+    assert_eq!(None, decoded_key);
+}

examples/scancodes.rs

@@ -0,0 +1,56 @@
+use pc_keyboard::{KeyEvent, ScancodeSet, ScancodeSet1, ScancodeSet2};
+
+fn main() {
+    let mut s = ScancodeSet1::new();
+    // [ 0x01 ] means "Pressed Escape" in Set 1
+    match s.advance_state(0x01) {
+        Ok(Some(KeyEvent { code, state })) => {
+            println!("Scancode Set 1 0x01 is KeyCode '{code:?}' KeyState '{state:?}'");
+        }
+        Ok(None) => {
+            println!("This is wrong, we didn't think that was a complete sequence");
+        }
+        Err(e) => {
+            println!("There was an error: {e:?}");
+        }
+    }
+    // [ 0x81 ] means "Released Escape" in Set 1
+    match s.advance_state(0x81) {
+        Ok(Some(KeyEvent { code, state })) => {
+            println!("Scancode Set 1 0x81 is KeyCode '{code:?}' KeyState '{state:?}'");
+        }
+        Ok(None) => {
+            println!("This is wrong, we didn't think that was a complete sequence");
+        }
+        Err(e) => {
+            println!("There was an error: {e:?}");
+        }
+    }
+
+    let mut s = ScancodeSet2::new();
+    // [ 0x01 ] means "Pressed F9" in Set 2
+    match s.advance_state(0x01) {
+        Ok(Some(KeyEvent { code, state })) => {
+            println!("Scancode Set 2 0x01 is KeyCode '{code:?}' KeyState '{state:?}'");
+        }
+        Ok(None) => {
+            println!("This is wrong, we didn't think that was a complete sequence");
+        }
+        Err(e) => {
+            println!("There was an error: {e:?}");
+        }
+    }
+    // [ 0xF0, 0x01 ] means "Released F9" in Set 2
+    assert_eq!(Ok(None), s.advance_state(0xF0));
+    match s.advance_state(0x01) {
+        Ok(Some(KeyEvent { code, state })) => {
+            println!("Scancode Set 2 0xF0 0x01 is KeyCode '{code:?}' KeyState '{state:?}'");
+        }
+        Ok(None) => {
+            println!("This is wrong, we didn't think that was a complete sequence");
+        }
+        Err(e) => {
+            println!("There was an error: {e:?}");
+        }
+    }
+}