chore: make usb-interface command line argument optional (#2484)

UltimateHackingKeyboard · Jan 13, 2025 · dedc3d7 · dedc3d7
1 parent 72e28d4
commit dedc3d7
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 16 deletions.
diff --git a/packages/uhk-agent/src/util/command-line.ts b/packages/uhk-agent/src/util/command-line.ts
@@ -66,7 +66,7 @@ const sections: commandLineUsage.Section[] = [
             },
             {
                 name: 'pid',
-                description: 'Use the specified USB product id. If you set it you have to set the vid and usb-interface too.',
+                description: 'Use the specified USB product id. If you set it you have to set the vid too.',
                 type: Number
             },
             {
@@ -112,7 +112,7 @@ const sections: commandLineUsage.Section[] = [
             },
             {
                 name: 'vid',
-                description: 'Use the specified USB vendor id. If you set it you have to set the pid and usb-interface too.',
+                description: 'Use the specified USB vendor id. If you set it you have to set the pid too.',
                 type: Number
             }
         ]

diff --git a/packages/uhk-usb/src/utils/assert-command-line-options.ts b/packages/uhk-usb/src/utils/assert-command-line-options.ts
@@ -1,21 +1,26 @@
 import { CommandLineArgs } from 'uhk-common';
 
-const USB_PROPERTIES = ['vid', 'pid', 'usb-interface'];
-
 export function assertCommandLineOptions (options: CommandLineArgs) {
-    let anyUsbOption = false;
-    let allUsbOptions = true;
+    if (options['usb-interface'] !== null && options['usb-interface'] !== undefined) {
+        if (!options.vid && !options.pid) {
+            throw new Error('You have to set the vid, pid commandline options too');
+        }
+
+        if (!options.vid) {
+            throw new Error('You have to set the vid commandline options too');
+        }
 
-    for (const usbProperty of USB_PROPERTIES) {
-        if (options.hasOwnProperty(usbProperty)) {
-            anyUsbOption = true;
-        } else {
-            allUsbOptions = false;
+        if (!options.pid) {
+            throw new Error('You have to set the pid commandline options too');
         }
     }
 
-    if (anyUsbOption && !allUsbOptions) {
-        throw new Error('You have to set all of the following options: vid, pid, usb-interface');
+    if (options.vid && !options.pid) {
+        throw new Error('You have to set the pid commandline options too');
+    }
+
+    if (!options.vid && options.pid) {
+        throw new Error('You have to set the vid commandline options too');
     }
 
     if (options['report-id'] !== null && options['report-id'] !== undefined && options['no-report-id'] === true) {

diff --git a/packages/uhk-usb/src/utils/device-vid-pid-interface-filter.ts b/packages/uhk-usb/src/utils/device-vid-pid-interface-filter.ts
@@ -1,10 +1,16 @@
 import { Device } from 'node-hid';
 import { DeviceIdentifier } from 'uhk-common';
 
+import { isUhkCommunicationUsage } from '../util.js';
+
 export function deviceVidPidInterfaceFilter(deviceIdentifier: DeviceIdentifier): (device: Device) => boolean  {
+    const isInterfaceProvided = deviceIdentifier['usb-interface'] !== null && deviceIdentifier['usb-interface'] !== undefined;
+
     return (device: Device): boolean => {
         return device.vendorId === deviceIdentifier.vid
             && device.productId === deviceIdentifier.pid
-            && device.interface === deviceIdentifier['usb-interface'];
+            && ((isInterfaceProvided && device.interface === deviceIdentifier['usb-interface'])
+                || (!isInterfaceProvided && isUhkCommunicationUsage(device))
+            );
     };
 }
diff --git a/packages/usb/src/command-line.ts b/packages/usb/src/command-line.ts
@@ -27,7 +27,7 @@ export const yargs = Yargs(hideBin(process.argv))
         default: false,
     })
     .option('pid', {
-        description: 'Set USB product id. If you set it you have to set the vid and usb-interface too.',
+        description: 'Set USB product id. If you set it you have to set the vid too.',
         type: 'number'
     })
     .option('report-id', {
@@ -44,7 +44,7 @@ export const yargs = Yargs(hideBin(process.argv))
         default: false
     })
     .option('vid', {
-        description: 'Set USB vendor id. If you set it you have to set the pid and usb-interface too.',
+        description: 'Set USB vendor id. If you set it you have to set the pid too.',
         type: 'number'
     })
     .option('usb-interface', {