From ff8aa3a7a0e4940abce68b6e25b5f91dea16359e Mon Sep 17 00:00:00 2001
From: Haobo Gu <haobogu@outlook.com>
Date: Fri, 27 Dec 2024 18:17:47 +0800
Subject: [PATCH] feat(input_device): add event definition

Signed-off-by: Haobo Gu <haobogu@outlook.com>
---
 rmk/src/event.rs | 64 ++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 54 insertions(+), 10 deletions(-)

diff --git a/rmk/src/event.rs b/rmk/src/event.rs
index 857602cc..9623b634 100644
--- a/rmk/src/event.rs
+++ b/rmk/src/event.rs
@@ -2,19 +2,63 @@ use defmt::Format;
 use postcard::experimental::max_size::MaxSize;
 use serde::{Deserialize, Serialize};
 
+/// Raw events from input devices and keyboards
+///
+/// This should be as close to the raw output of the devices as possible.
+/// The input processors receives it, processes it,
+/// and then converts it to the final keyboard/mouse report.
+#[non_exhaustive]
+#[derive(Serialize, Deserialize, Clone, Debug)]
+pub enum Event {
+    /// Keyboard event
+    Key(KeyEvent),
+    /// Multi-touch touchpad
+    Touchpad(TouchpadEvent),
+    /// Joystick, suppose we have x,y,z axes for this joystick
+    Joystick([AxisEvent; 3]),
+}
+
+/// Event for multi-touch touchpad
+#[derive(Serialize, Deserialize, Clone, Debug, Format, MaxSize)]
+pub struct TouchpadEvent {
+    /// Finger slot
+    pub finger: u8,
+    /// X, Y, Z axes for touchpad
+    pub axis: [AxisEvent; 3],
+}
+
+#[derive(Serialize, Deserialize, Clone, Debug, Copy, Format, MaxSize)]
+pub struct AxisEvent {
+    /// The axis event value type, relative or absolute
+    pub typ: AxisValType,
+    /// The axis name
+    pub axis: Axis,
+    /// Value of the axis event
+    pub value: i8,
+}
+
+#[derive(Serialize, Deserialize, Clone, Debug, Copy, Format, MaxSize)]
+pub enum AxisValType {
+    /// The axis value is relative
+    Rel,
+    /// The axis value is absolute
+    Abs,
+}
+
+#[derive(Serialize, Deserialize, Clone, Copy, Debug, Format, MaxSize)]
+#[non_exhaustive]
+pub enum Axis {
+    X,
+    Y,
+    Z,
+    H,
+    V,
+    // .. More is allowed
+}
+
 #[derive(Serialize, Deserialize, Clone, Copy, Debug, Format, MaxSize)]
 pub struct KeyEvent {
     pub row: u8,
     pub col: u8,
     pub pressed: bool,
 }
-
-
-#[derive(Serialize, Deserialize, Clone, Copy, Debug, Format, MaxSize)]
-pub struct MouseEvent {
-    pub buttons: u8,
-    pub x: i8,
-    pub y: i8,
-    pub wheel: i8, // Scroll down (negative) or up (positive) this many units
-    pub pan: i8,   // Scroll left (negative) or right (positive) this many units
-}