move into python package

Author: Evidlo

README.md

@@ -0,0 +1,16 @@
+# remarkable_sim
+
+![](screenshot.png)
+
+## Install
+
+Tkinter is a dependency. (`python3-tk` in Debian/Ubuntu)
+
+    pip install remarkable-sim
+    
+## Usage
+
+    resim
+    
+`resim` will create 3 FIFOs at `event0`, `event1`, and `event2` in the current directory and will attempt to read from `fb.pgm` 10 times per second.  The application under test should write to this framebuffer file and read evdev events from the FIFOs.
+    

evdev_notes.md

@@ -0,0 +1,74 @@
+- [event docs](https://www.kernel.org/doc/Documentation/input/multi-touch-protocol.txt)
+
+codes resolved with python evdev
+
+    dict(evdev.resolve_ecodes_dict({3: [0, 1, 24, 25, 26, 27]}))
+    
+# evdev Message Structure
+- https://stackoverflow.com/questions/23480741/obtaining-evdev-event-code-from-raw-bytes
+
+- 4 byte unsigned integer - seconds
+- 4 byte unsigned integer - microseconds
+- 2 byte unsigned integer - type
+- 2 byte unsigned integer - code
+- 4 byte signed integer - value
+
+# Coordinate Systems
+
+  Stylus          Touch         TKinter
++---------+    +---------+    +---------+
+| x       |    |       y |    | +---x   |
+| |       |    |       | |    | |       |
+| |       |    |       | |    | |       |
+| +--- y  |    |   x---+ |    | y       |
++---------+    +---------+    +---------+
+|o   o   o|    |o   o   o|    |o   o   o|
++---------+    +---------+    +---------+
+
+# evdev Event Files and Codes
+
+## event0 - Stylus
+- type 0 - ev_sync
+- type 1 - ev_key
+  - code [code #] - [name] - [desc] - [range]
+  - code 320 - toolpen - -
+  - code 321 - toolrubber - -
+  - code 330 - touch - -
+  - code 331 - stylus - -
+  - code 332 - stylus2 - -
+- type 3 - ev_abs - absolute
+  - code 0 - abs_x - xpos - (0: bottom, 20967: top)
+  - code 1 - abs_y - ypos - (0: left, 15725: right)
+  - code 24 - abs_pressure - (0, 4095)
+  - code 25 - abs_distance - distance between pen and surface - (0: lowered, ~100: raised)
+  - code 26 - abs_tilt_x - (-6300: pen flat pointing up, 6300: pen flat pointing down)
+  - code 27 - abs_tilt_y - (-6300: pen flat pointing right, 6300: pen flat pointing left
+
+## event1 - Touch
+- type 0 - ev_sync
+- type 1 - ev_key
+- type 3 - ev_abs
+  - code 25 - abs_mt_distance - unused?
+  - code 47 - abs_mt_slot - multitouch position number (see protocol example B in docs)
+  - code 48 - abs_mt_touch_major - touch size major axis - needs further study {4: pointer touch, 24: thumb touch}
+  - code 49 - abs_mt_touch_minor - touch size minor axis - 
+  - code 52 - abs_mt_orientation - touch orientation
+  - code 53 - abs_mt_position_x - xpos - (0: right side, 767: left side)
+  - code 54 - abs_mt_position_y - ypos - (0: bottom, 1023: top
+  - code 57 - abs_mt_tracking_id - press/release
+    - value=X - increments by +1 with each press
+    - value=-1 - release
+  - code 58 - abs_mt_pressure - not really pressure but contact area - {30: very light touch, 90: typical touch during swipe, 150: thumb on screen}
+  
+## event2 - Buttons
+- type 0 - ev_sync
+- type 1 - ev_key
+  - code 102 - home - middle button
+    - value 1 - press
+    - value 0 - release
+  - code 105 - left - left button
+  - code 106 - right - right button
+  - code 116 - power - suspend button
+  - code 143 - wakeup - unused?
+
+

remarkable_sim/__init__.py

@@ -0,0 +1,108 @@
+import time
+import os
+import struct
+import stat
+
+def affine_map(x, a0, a1, b0, b1):
+    """Map x in range (a0, a1) to (b0, b1)
+    Args:
+        x (float): input
+        a0 (float): input range start
+        a1 (float): input range start
+        b0 (float): output range start
+        b1 (float): output range start
+
+    Returns:
+        int: mapped coordinate
+    """
+
+    return int(((x - a0) / a1) * b1 + b0)
+
+def makefifo(path):
+    """Make a fifo, delete existing fifo
+
+    Args:
+        path (str): path to new fifo
+    """
+
+    if os.path.exists(path) and stat.S_ISFIFO(os.stat(path).st_mode):
+        os.remove(path)
+
+    os.mkfifo(path)
+
+    return os.open(path, os.O_RDWR)
+
+
+# write evdev events to fifos
+def write_evdev(f, e_type, e_code, e_value):
+    """Write evdev events to fifo
+
+    Args:
+        f (int): fd of fifo
+        e_type (int): evdev event type
+        e_code (int): evdev event code
+        e_value (int): evdev event value
+    """
+
+    print(f, e_type, e_code, e_value)
+
+    t = time.time_ns()
+    t_seconds = int(t / 1e9)
+    t_microseconds = int(t / 1e3 % 1e6)
+    os.write(
+        f,
+        struct.pack(
+            '2IHHi',
+            t_seconds,
+            t_microseconds,
+            e_type,
+            e_code,
+            e_value
+        )
+    )
+
+# ----- evdev codes -----
+# see evdev_notes.md
+
+# tuples containing (type, code)
+
+code_sync = (0, 0, 0)
+
+codes_stylus = {
+    'toolpen': (1, 320),
+    'toolrubber': (1, 321),
+    'touch': (1, 330),
+    'stylus': (1, 331),
+    'stylus2': (1, 332),
+    'abs_x': (3, 0),
+    'abs_y': (3, 1),
+    'abs_pressure': (3, 24),
+    'abs_distance': (3, 25),
+    'abs_tilt_x': (3, 26),
+    'abs_tilt_y': (3, 27)
+}
+
+codes_touch = {
+    'abs_mt_distance': (3, 25),
+    'abs_mt_slot': (3, 47),
+    'abs_mt_touch_major': (3, 48),
+    'abs_mt_touch_minor': (3, 49),
+    'abs_mt_orientation': (3, 52),
+    'abs_mt_position_x': (3, 53),
+    'abs_mt_position_y': (3, 54),
+    'abs_mt_tracking_id': (3, 57),
+    'abs_mt_pressure': (3, 58)
+}
+
+codes_button = {
+    'home': (1, 102),
+    'left': (1, 105),
+    'right': (1, 106),
+    'power': (1, 116),
+    'wakeup': (1, 143)
+}
+
+stylus_max_x = 20967
+stylus_max_y = 15725
+touch_max_x = 767
+touch_max_y = 1023