From ba693a5983f91bdc27222a4f9427a76d320dc1a5 Mon Sep 17 00:00:00 2001 From: iberianpig Date: Sat, 14 Sep 2024 20:39:46 +0900 Subject: [PATCH] docs: Update README.md for pointing stick support --- README.md | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4832e0c..e226cb0 100644 --- a/README.md +++ b/README.md @@ -82,11 +82,48 @@ remap: K: BTN_RIGHT ``` -## TODO List +## Pointing Stick Support + +### Overview +Fusuma::Plugin::Thumbsense provides experimental support for pointing stick devices. This functionality is currently limited to the **HHKB Studio** and utilizes HIDRAW. Please note that this feature is still in testing, and improvements may be made in future updates. + +see: https://github.com/iberianpig/fusuma-plugin-thumbsense/pull/4 + +### Setting Up Udev Rules + +To use the pointing stick touch support, you need to set up the following Udev rules to ensure that the HHKB Studio device is correctly recognized: + +1. **Create the Udev Rule File**: + Create a Udev rule file with the following command: + + ```sh + sudo nano /etc/udev/rules.d/60-udev-fusuma-thumbsense-hhkb-studio.rules + ``` + + Add the following content to the file: + + ```plaintext + # HHKB Studio (USB) + KERNEL=="hidraw*", SUBSYSTEM=="hidraw", ATTRS{idVendor}=="04fe", ATTRS{idProduct}=="0016", MODE="0666" + + # HHKB Studio (Bluetooth) + KERNEL=="hidraw*", SUBSYSTEM=="hidraw", ENV{DEVPATH}=="/devices/virtual/misc/uhid/*:04FE:0016.*/hidraw*", MODE="0666" + ``` + +2. **Reload the Udev Rules**: + Execute the following command to reload the Udev rules: + + ```sh + sudo udevadm control --reload-rules && sudo udevadm trigger + ``` + +## TODO LIST - ThumbSense - [x] Change remap layer while tapping - [x] Enable executing commands like `command:` and `sendkey:` + - [x] Support pointing stick devices(https://github.com/iberianpig/fusuma-plugin-thumbsense/pull/4) + - Now only HHKB Studio is supported using HIDRAW - Remap - [x] Remap to single key (e.g., `remap: { J: BTN_LEFT }`)