Add web command to request device access (microsoft#152310)

* Add web command to request serial access Signed-off-by: thegecko <[email protected]> * Add support for requesting HID devices Signed-off-by: thegecko <[email protected]>
0YJ · Jun 21, 2022 · dd2ca4c · dd2ca4c
1 parent 9ec50c6
commit dd2ca4c
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 5 deletions.
diff --git a/src/vs/base/browser/usb.ts → src/vs/base/browser/deviceAccess.ts b/src/vs/base/browser/usb.ts → src/vs/base/browser/deviceAccess.ts
@@ -22,7 +22,7 @@ export interface UsbDeviceData {
 	readonly vendorId: number;
 }
 
-export async function requestUsb(options?: { filters?: unknown[] }): Promise<UsbDeviceData | undefined> {
+export async function requestUsbDevice(options?: { filters?: unknown[] }): Promise<UsbDeviceData | undefined> {
 	const usb = (navigator as any).usb;
 	if (!usb) {
 		return undefined;
@@ -50,3 +50,59 @@ export async function requestUsb(options?: { filters?: unknown[] }): Promise<Usb
 		vendorId: device.vendorId,
 	};
 }
+
+// https://wicg.github.io/serial/
+
+export interface SerialPortData {
+	readonly usbVendorId?: number | undefined;
+	readonly usbProductId?: number | undefined;
+}
+
+export async function requestSerialPort(options?: { filters?: unknown[] }): Promise<SerialPortData | undefined> {
+	const serial = (navigator as any).serial;
+	if (!serial) {
+		return undefined;
+	}
+
+	const port = await serial.requestPort({ filters: options?.filters ?? [] });
+	if (!port) {
+		return undefined;
+	}
+
+	const info = port.getInfo();
+	return {
+		usbVendorId: info.usbVendorId,
+		usbProductId: info.usbProductId
+	};
+}
+
+// https://wicg.github.io/webhid/
+
+export interface HidDeviceData {
+	readonly opened: boolean;
+	readonly vendorId: number;
+	readonly productId: number;
+	readonly productName: string;
+	readonly collections: [];
+}
+
+export async function requestHidDevice(options?: { filters?: unknown[] }): Promise<HidDeviceData | undefined> {
+	const hid = (navigator as any).hid;
+	if (!hid) {
+		return undefined;
+	}
+
+	const devices = await hid.requestDevice({ filters: options?.filters ?? [] });
+	if (!devices.length) {
+		return undefined;
+	}
+
+	const device = devices[0];
+	return {
+		opened: device.opened,
+		vendorId: device.vendorId,
+		productId: device.productId,
+		productName: device.productName,
+		collections: device.collections
+	};
+}
diff --git a/src/vs/workbench/browser/actions/workspaceCommands.ts b/src/vs/workbench/browser/actions/workspaceCommands.ts
@@ -306,4 +306,3 @@ CommandsRegistry.registerCommand('_workbench.getRecentlyOpened', async function
 
 	return workspacesService.getRecentlyOpened();
 });
-
diff --git a/src/vs/workbench/browser/window.ts b/src/vs/workbench/browser/window.ts
@@ -6,7 +6,7 @@
 import { isSafari, setFullscreen } from 'vs/base/browser/browser';
 import { addDisposableListener, addDisposableThrottledListener, detectFullscreen, EventHelper, EventType, windowOpenNoOpener, windowOpenPopup, windowOpenWithSuccess } from 'vs/base/browser/dom';
 import { DomEmitter } from 'vs/base/browser/event';
-import { requestUsb, UsbDeviceData } from 'vs/base/browser/usb';
+import { HidDeviceData, requestHidDevice, requestSerialPort, requestUsbDevice, SerialPortData, UsbDeviceData } from 'vs/base/browser/deviceAccess';
 import { timeout } from 'vs/base/common/async';
 import { Event } from 'vs/base/common/event';
 import { Disposable } from 'vs/base/common/lifecycle';
@@ -248,7 +248,17 @@ export class BrowserWindow extends Disposable {
 
 		// Allow extensions to request USB devices in Web
 		CommandsRegistry.registerCommand('workbench.experimental.requestUsbDevice', async (_accessor: ServicesAccessor, options?: { filters?: unknown[] }): Promise<UsbDeviceData | undefined> => {
-			return requestUsb(options);
+			return requestUsbDevice(options);
+		});
+
+		// Allow extensions to request Serial devices in Web
+		CommandsRegistry.registerCommand('workbench.experimental.requestSerialPort', async (_accessor: ServicesAccessor, options?: { filters?: unknown[] }): Promise<SerialPortData | undefined> => {
+			return requestSerialPort(options);
+		});
+
+		// Allow extensions to request HID devices in Web
+		CommandsRegistry.registerCommand('workbench.experimental.requestHidDevice', async (_accessor: ServicesAccessor, options?: { filters?: unknown[] }): Promise<HidDeviceData | undefined> => {
+			return requestHidDevice(options);
 		});
 	}
 }
diff --git a/src/vs/workbench/services/extensions/browser/webWorkerExtensionHost.ts b/src/vs/workbench/services/extensions/browser/webWorkerExtensionHost.ts
@@ -132,7 +132,7 @@ export class WebWorkerExtensionHost extends Disposable implements IExtensionHost
 		const iframe = document.createElement('iframe');
 		iframe.setAttribute('class', 'web-worker-ext-host-iframe');
 		iframe.setAttribute('sandbox', 'allow-scripts allow-same-origin');
-		iframe.setAttribute('allow', 'usb; cross-origin-isolated;');
+		iframe.setAttribute('allow', 'usb; serial; hid; cross-origin-isolated;');
 		iframe.setAttribute('aria-hidden', 'true');
 		iframe.style.display = 'none';