feat: --usb-non-blocking command line option (UltimateHackingKeyboard#1580)

ert78gb · web-flow · commit 5206ff8c9c1b · 2021-09-12T22:35:06.000+02:00
* feat: --usb-driver command line option

* feat: --usb-read-mode command line option

* try to use device.setNonBlocking(true)

* readSync

* set non blocking

* set non blocking commandline arg

* style: revert undentation
diff --git a/packages/uhk-agent/src/util/command-line.ts b/packages/uhk-agent/src/util/command-line.ts
@@ -10,7 +10,7 @@ const optionDefinitions: commandLineArgs.OptionDefinition[] = [
     { name: 'preserve-udev-rules', type: Boolean },
     { name: 'reenumerate-and-exit', type: String },
     { name: 'spe', type: Boolean }, // simulate privilege escalation error
-    { name: 'usb-driver', type: String }
+    { name: 'usb-non-blocking', type: Boolean }
 ];
 
 export const options: CommandLineArgs = commandLineArgs(optionDefinitions, { partial: true }) as CommandLineArgs;
@@ -50,6 +50,10 @@ const sections: commandLineUsage.Section[] = [
             {
                 name: 'spe',
                 description: 'Simulate privilege escalation error'
+            },
+            {
+                name: 'usb-non-blocking',
+                description: 'Use USB non-blocking communication'
             }
         ]
     }
diff --git a/packages/uhk-common/src/models/command-line-args.ts b/packages/uhk-common/src/models/command-line-args.ts
@@ -28,4 +28,8 @@ export interface CommandLineArgs {
      * simulate privilege escalation error
      */
     spe?: boolean;
+    /**
+     * Use USB non-blocking communication
+     */
+    'usb-non-blocking'?: boolean;
 }
diff --git a/packages/uhk-usb/src/uhk-hid-device.ts b/packages/uhk-usb/src/uhk-hid-device.ts
@@ -420,6 +420,10 @@ export class UhkHidDevice {
                 return null;
             }
             const device = new HID(dev.path);
+            if (this.options['usb-non-blocking']) {
+                this.logService.misc('[UhkHidDevice] set non blocking communication mode');
+                device.setNonBlocking(1 as any);
+            }
             this.logService.misc('[UhkHidDevice] Used device:', JSON.stringify(dev, usbDeviceJsonFormatter));
             return device;
         } catch (err) {
diff --git a/packages/usb/src/command-line.ts b/packages/usb/src/command-line.ts
@@ -11,6 +11,11 @@ export const yargs = Yargs
         default: 'none',
         choices: ['all', 'config', 'misc', 'none', 'usb']
     })
+    .option('usb-non-blocking', {
+        description: 'Use USB non blocking communication',
+        type: 'boolean',
+        default: false
+    })
     .help('help')
     .version(false)
 ;

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ const optionDefinitions: commandLineArgs.OptionDefinition[] = [`
`10`	`10`	`{ name: 'preserve-udev-rules', type: Boolean },`
`11`	`11`	`{ name: 'reenumerate-and-exit', type: String },`
`12`	`12`	`{ name: 'spe', type: Boolean }, // simulate privilege escalation error`
`13`		`- { name: 'usb-driver', type: String }`
	`13`	`+ { name: 'usb-non-blocking', type: Boolean }`
`14`	`14`	`];`
`15`	`15`
`16`	`16`	`export const options: CommandLineArgs = commandLineArgs(optionDefinitions, { partial: true }) as CommandLineArgs;`
`@@ -50,6 +50,10 @@ const sections: commandLineUsage.Section[] = [`
`50`	`50`	`{`
`51`	`51`	`name: 'spe',`
`52`	`52`	`description: 'Simulate privilege escalation error'`
	`53`	`+ },`
	`54`	`+ {`
	`55`	`+ name: 'usb-non-blocking',`
	`56`	`+ description: 'Use USB non-blocking communication'`
`53`	`57`	`}`
`54`	`58`	`]`
`55`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,4 +28,8 @@ export interface CommandLineArgs {`
`28`	`28`	`* simulate privilege escalation error`
`29`	`29`	`*/`
`30`	`30`	`spe?: boolean;`
	`31`	`+ /**`
	`32`	`+ * Use USB non-blocking communication`
	`33`	`+ */`
	`34`	`+ 'usb-non-blocking'?: boolean;`
`31`	`35`	`}`