Fix Alternate-ID Bug, Handle Mixup Affecting Windows (#54)

Changelog.md

@@ -1,3 +1,8 @@
+# 0.7.3
+- Fix USB handle mixup affecting Windows builds
+- Fix GUI bug with remapping alternate IDs
+- Update all underlying dependencies
+
 # 0.7.2
 - Fix internal indices for `n`, `o`, and `u`.
 - Add annotated hex dumps for more keyboards for future RE work

Dockerfile

@@ -3,7 +3,7 @@ FROM centos:centos7
 # Dependencies
 ENV INST yum install -y --setopt=skip_missing_names_on_install=False
 RUN $INST https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm centos-release-scl
-RUN $INST autoconf devtoolset-11 ninja-build kernel-headers perl-core python36 python36-pip bzip2
+RUN $INST autoconf devtoolset-11 kernel-headers perl-core python36 python36-pip bzip2
 
 # Environment Configuration
 ENV CC=/opt/rh/devtoolset-11/root/usr/bin/gcc \
@@ -30,4 +30,4 @@ WORKDIR /nudelta
 COPY . .
 RUN yarn
 RUN yarn build
-RUN cp -r /nudelta/dist/*.AppImage /nudelta.AppImage
+RUN cp -r /nudelta/dist/*.AppImage /nudelta.AppImage

Readme.md

@@ -43,34 +43,25 @@ Contributions are super appreciated for all of these.
 
 ### Build Requirements
 * C++17 Compiler
+    * Clang recommended for macOS/Linux
+    * MSVC recommended for Windows
 * Cmake
 * Node 14+ with Yarn
 
-## Build (GUI)
+## Build
 
 ```sh
 git clone https://github.com/donn/nudelta
 cd nudelta
 git submodule update --init --recursive
 rm -rf build
 yarn
-yarn build
+yarn build-native # CLI / Library
+yarn build # GUI
 ```
 
 The Linux AppImage will be found under ./dist, and the Mac app will be found under ./dist/mac.
 
-## Build (CLI)
-```sh
-git clone https://github.com/donn/nudelta
-cd nudelta
-git submodule update --init --recursive
-mkdir build
-cd build
-cmake ..
-make -j$(nproc)
-sudo make install
-```
-
 ## Using the CLI
 
 You will need to use **sudo** on Linux. On macOS, you will need to grant Input Monitoring permissions to whichever Terminal host you're using to run Nudelta, likely Terminal.app.

lib/nuphy.cpp

@@ -111,8 +111,7 @@ void set_report(NuPhy::Handles handles, uint8_t *data, size_t dataSize) {
     if (!hidAccess.value()) {
         throw std::runtime_error(hidAccessFailureMessage);
     }
-    auto bytesWritten =
-        hid_send_feature_report(handles.request, data, dataSize);
+    auto bytesWritten = hid_send_feature_report(handles.data, data, dataSize);
     if (bytesWritten < 0) {
         auto errorString = fmt::format(
             "Failed to write to keyboard: {}",
@@ -172,7 +171,7 @@ std::string represent_hid_struct(hid_device_info *info) {
 // path
 // - So far, I've identified col06 as the one for keymap data, col05 for
 // requests
-std::string writeCol = "col05";
+std::string requestCol = "col05";
 std::string dataCol = "col06";
 
 std::shared_ptr< NuPhy > NuPhy::find(bool verify) {
@@ -197,7 +196,7 @@ std::shared_ptr< NuPhy > NuPhy::find(bool verify) {
             for (auto it = path.begin(); it != path.end(); it++) {
                 *it = char(std::tolower(*it));
             }
-            if (path.find(writeCol) != -1) {
+            if (path.find(requestCol) != -1) {
                 if (requestPath.has_value()) {
                     throw std::runtime_error(
                         "Multiple keyboards with the same product ID found! Please ensure only one keyboard is plugged in.\n"

package.json

@@ -1,7 +1,7 @@
 {
     "name": "nudelta",
     "author": "Mohamed Gaber <me@donn.website>",
-    "version": "0.7.2",
+    "version": "0.7.3",
     "license": "GPL-3.0-or-later",
     "homepage": "https://github.com/donn/nudelta#readme",
     "description": "An open-source alternative to the NuPhy Console",
@@ -15,6 +15,7 @@
         "build-native": "node util/build-native.js",
         "build-ui": "rollup -c",
         "watch": "nodemon --ext .js,.mjs,.cjs,.css --ignore ui/app-dist/ --exec sh -c \"yarn build-ui && electron .\"",
+        "watch-win": "nodemon --ext .js,.mjs,.cjs,.css --ignore ui/app-dist/ --exec cmd /c \"yarn build-ui && electron .\"",
         "format": "prettier --write . && clang-format -i include/*.hpp lib/*.cpp src/*.cpp",
         "lint": "prettier --check . && clang-format --dry-run --Werror include/*.hpp lib/*.cpp src/*.cpp"
     },

ui/src/app.js

@@ -201,7 +201,7 @@ function redrawKeyboard() {
 }
 
 function drawOptionArray(e, remap, key, alt, column, row) {
-    let id = key.id;
+    let id = alt ? key.altID : key.id;
     let defaultMapping = alt ? key.altDefaultMapping : key.defaultMapping;
     let defaultModifiers = alt ? key.altDefaultModifiers : key.defaultModifiers;
 
@@ -451,7 +451,7 @@ function setsEqual(lhs, rhs) {
  */
 function updateKeymap(event) {
     let remap = window.config.getRemap(window.mode);
-    console.log("load", JSON.stringify(remap));
+    console.log("Before: ", JSON.stringify(remap));
     let key = window.currentKey;
 
     let currentRemap = remap[key.id] ?? {};
@@ -483,7 +483,6 @@ function updateKeymap(event) {
 
     if (key.altID) {
         let currentRemap = remap[key.altID] ?? {};
-
         let incomingID = g("#keycode-selector-alt").value;
         let incomingModifiers = new Set();
         let defaultModifiers = new Set(key.altDefaultModifiers);
@@ -509,7 +508,7 @@ function updateKeymap(event) {
             remap[key.altID] = currentRemap;
         }
     }
-    console.log("save", JSON.stringify(remap));
+    console.log("After: ", JSON.stringify(remap));
     window.config.setRemap(window.mode, remap);
 }