More READMEs

Author: nullstalgia

README.md

@@ -18,8 +18,8 @@ Index of contents:
 Detailed descriptions of controller hardware, Bluetooth packet types and contents, and other firmware oddities.
 
 - [Daydream Controller (a.k.a. Paprika)](Writeups/Reference%20-%20Daydream%20%28Paprika%29.md)
-  - [Beeped-out PCB Top](PCB%20Beepouts/Daydream%20PCB%20Beepout%20Top.png)
-  - [Beeped-out PCB Bottom](PCB%20Beepouts/Daydream%20PCB%20Beepout%20Bottom.png)
+  - [Beeped-out PCB Top](Writeups/PCB%20Beepouts/Daydream%20PCB%20Beepout%20Top.png)
+  - [Beeped-out PCB Bottom](Writeups/PCB%20Beepouts/Daydream%20PCB%20Beepout%20Bottom.png)
 
 - [GearVR Controller (a.k.a. Gochugaru)](Writeups/Reference%20-%20GearVR%20%28Gochugaru%29.md)
 
@@ -30,14 +30,22 @@ Detailed descriptions of controller hardware, Bluetooth packet types and content
   - Parsing and generating Daydream MTP Serial packets.
   - `no_std` and `no_alloc` compatible!
 - [`daydream-airmouse`](daydream-airmouse/)
-  - WIP crate for generating mouse movement commands based on the IMU + touchpad + button inputs of the Daydream/GearVR controllers.
+  - **WIP** Crate for generating mouse movement commands based on the IMU + touchpad + button inputs of the Daydream/GearVR controllers.
   - `no_std` and `no_alloc` compatible!
 - [`daydream-airmouse-uinput`](daydream-airmouse-uinput/)
-  - Linux-only uinput-enabled client for controlling the mouse via [`daydream-airmouse`](daydream-airmouse/)
+  - Linux-only uinput-enabled client for controlling the mouse via [`daydream-airmouse`](daydream-airmouse/).
+  - Primarily a testbed to speed up development, not intended for daily use.
 - [`daydream-airmouse-esp`](daydream-airmouse-esp/)
-  - WIP ESP32-S3 firmware to connect to Daydream/GearVR controllers and output mouse/keyboard events over native USB HID.
+  - **WIP** ESP32-S3 firmware to connect to Daydream/GearVR controllers and output mouse/keyboard events over native USB HID.
   - Very early (non-functional ATM), ironing out BLE connection issues with the still-blossoming esp-rs toolchain.
   - Uses `no_std`.
 - [`gamepad-motion-helpers`](gamepad-motion-helpers/)
   - A from-scratch native Rust port of Jibb Smart's original C++ [GamepadMotionHelpers](https://github.com/JibbSmart/GamepadMotionHelpers).
+  - Tests compare against the original library via [`gamepad_motion`](https://crates.io/crates/gamepad_motion)!
   - `no_std` and `no_alloc` compatible!
+
+### Special thanks:
+
+- [MuffinTastic](https://github.com/MuffinTastic) for their encouragment, assistance, and knowledge.
+- [`deku`](https://github.com/sharksforarms/deku) for making working with bitfields a pleasure rather than a pain.
+- [ImHex](https://github.com/WerWolv/ImHex) for being excellent overall, especially with it's support for visualizing patterns.

Writeups/Reference - Daydream (Paprika).md

@@ -64,7 +64,7 @@
     * Per-device
   * Hardware Revision - `0x2A27`
     * `HW_VERSION` and `BOOTLOADER_VERSION` joined by a `.`
-    * Examples I've seen:
+    * Values I've seen:
       * `0003.ffff`
       * `0007.0003`
       * `0005.0003`
@@ -243,7 +243,7 @@ Ensure RTS and DTR are asserted `true` after connecting to the USB Serial Port.
 `/etc/udev/rules.d/99-paprika-udev.rules`
 
 ````
-# Google Daydream Controller (Paprika/D801) USB CDC-ACM  
+# Google Daydream Controller (Paprika/D801) USB CDC-ACM
 ATTRS{idVendor}=="18d1", ATTRS{idProduct}=="9210", MODE="0666", ENV{ID_MM_DEVICE_IGNORE}="1", ENV{ID_MM_PORT_IGNORE}="1"
 ````
 

daydream-airmouse-esp/README.md

@@ -0,0 +1,5 @@
+# daydream-airmouse-esp
+
+- **WIP** ESP32-S3 firmware to connect to Daydream/GearVR controllers and output mouse/keyboard events over native USB HID.
+- Very early (non-functional ATM), ironing out BLE connection issues with the still-blossoming esp-rs toolchain.
+- Uses `no_std`.

daydream-airmouse-uinput/README.md

@@ -0,0 +1,4 @@
+# daydream-airmouse-uinput
+
+- Linux-only uinput-enabled client for controlling the mouse via [`daydream-airmouse`](daydream-airmouse/).
+- Primarily a testbed to speed up development, not intended for daily use.

daydream-airmouse/README.md

@@ -0,0 +1,4 @@
+# daydream-airmouse
+
+- **WIP** Crate for generating mouse movement commands based on the IMU + touchpad + button inputs of the Daydream/GearVR controllers.
+- `no_std` and `no_alloc` compatible!

daydream-catcher/README.md

@@ -0,0 +1,7 @@
+# daydream-catcher
+
+- Parses Daydream (Paprika) and GearVR (Gochugaru) controller packets.
+- Parses and generates Daydream MTP Serial packets.
+  - The framed packet format used by the (USB) Serial bus when the console is in Prod mode.
+- `no_std` and `no_alloc` compatible!
+- Uses `glam@0.14-0.30` for the resulting Vector3 and Matrix types.

gamepad-motion-helpers/README.md

@@ -0,0 +1,9 @@
+# gamepad-motion-helpers
+
+- A from-scratch native Rust port of Jibb Smart's original C++ [GamepadMotionHelpers](https://github.com/JibbSmart/GamepadMotionHelpers).
+- Tests compare against the original via `autocxx` via [`gamepad_motion`](https://crates.io/crates/gamepad_motion)!
+- `no_std` and `no_alloc` compatible!
+
+TODO:
+
+- Needs a polish pass on the available API, the one-to-one match is pretty clunky.