设备访问

与基于 Chromium 的浏览器一样，Electron 通过 Web API 提供对设备硬件的访问。在大多数情况下，这些 API 的工作方式与浏览器中的相同，但有一些差异需要考虑。Electron 和浏览器之间的主要区别在于请求设备访问时会发生什么。在浏览器中，用户会看到一个弹出窗口，他们可以在其中授予对单个设备的访问权限。在 Electron 中，提供了可供开发者使用的 API，开发者可以使用这些 API 自动选择设备或通过开发者创建的界面提示用户选择设备。

Web Bluetooth API

可以使用 Web Bluetooth API 与蓝牙设备进行通信。为了在 Electron 中使用此 API，开发人员需要处理与设备请求关联的 webContents 上的 select-bluetooth-device 事件。

此外，ses.setBluetoothPairingHandler(handler) 可用于在需要其他验证（如 PIN 码）时处理 Windows 或 Linux 上与蓝牙设备的配对。

示例

此示例演示了一个 Electron 应用程序，该应用程序在单击“测试蓝牙”按钮时会自动选择第一个可用的蓝牙设备。

docs/fiddles/features/web-bluetooth (33.0.1)在 Fiddle 中打开

main.js
preload.js
index.html
renderer.js

const { app, BrowserWindow, ipcMain } = require('electron/main')
const path = require('node:path')

let bluetoothPinCallback
let selectBluetoothCallback

function createWindow () {
  const mainWindow = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      preload: path.join(__dirname, 'preload.js')
    }
  })

  mainWindow.webContents.on('select-bluetooth-device', (event, deviceList, callback) => {
    event.preventDefault()
    selectBluetoothCallback = callback
    const result = deviceList.find((device) => {
      return device.deviceName === 'test'
    })
    if (result) {
      callback(result.deviceId)
    } else {
      // The device wasn't found so we need to either wait longer (eg until the
      // device is turned on) or until the user cancels the request
    }
  })

  ipcMain.on('cancel-bluetooth-request', (event) => {
    selectBluetoothCallback('')
  })

  // Listen for a message from the renderer to get the response for the Bluetooth pairing.
  ipcMain.on('bluetooth-pairing-response', (event, response) => {
    bluetoothPinCallback(response)
  })

  mainWindow.webContents.session.setBluetoothPairingHandler((details, callback) => {
    bluetoothPinCallback = callback
    // Send a message to the renderer to prompt the user to confirm the pairing.
    mainWindow.webContents.send('bluetooth-pairing-request', details)
  })

  mainWindow.loadFile('index.html')
}

app.whenReady().then(() => {
  createWindow()

  app.on('activate', function () {
    if (BrowserWindow.getAllWindows().length === 0) createWindow()
  })
})

app.on('window-all-closed', function () {
  if (process.platform !== 'darwin') app.quit()
})

const { contextBridge, ipcRenderer } = require('electron/renderer')

contextBridge.exposeInMainWorld('electronAPI', {
  cancelBluetoothRequest: () => ipcRenderer.send('cancel-bluetooth-request'),
  bluetoothPairingRequest: (callback) => ipcRenderer.on('bluetooth-pairing-request', () => callback()),
  bluetoothPairingResponse: (response) => ipcRenderer.send('bluetooth-pairing-response', response)
})

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
    <meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'">
    <title>Web Bluetooth API</title>
  </head>
  <body>
    <h1>Web Bluetooth API</h1>

    <button id="clickme">Test Bluetooth</button>
    <button id="cancel">Cancel Bluetooth Request</button>

    <p>Currently selected bluetooth device: <strong id="device-name""></strong></p>

    <script src="./renderer.js"></script>
  </body>
</html>

async function testIt () {
  const device = await navigator.bluetooth.requestDevice({
    acceptAllDevices: true
  })
  document.getElementById('device-name').innerHTML = device.name || `ID: ${device.id}`
}

document.getElementById('clickme').addEventListener('click', testIt)

function cancelRequest () {
  window.electronAPI.cancelBluetoothRequest()
}

document.getElementById('cancel').addEventListener('click', cancelRequest)

window.electronAPI.bluetoothPairingRequest((event, details) => {
  const response = {}

  switch (details.pairingKind) {
    case 'confirm': {
      response.confirmed = window.confirm(`Do you want to connect to device ${details.deviceId}?`)
      break
    }
    case 'confirmPin': {
      response.confirmed = window.confirm(`Does the pin ${details.pin} match the pin displayed on device ${details.deviceId}?`)
      break
    }
    case 'providePin': {
      const pin = window.prompt(`Please provide a pin for ${details.deviceId}.`)
      if (pin) {
        response.pin = pin
        response.confirmed = true
      } else {
        response.confirmed = false
      }
    }
  }

  window.electronAPI.bluetoothPairingResponse(response)
})

WebHID API

可以使用 WebHID API 访问 HID 设备，例如键盘和游戏手柄。Electron 提供了多个用于处理 WebHID API 的 API。

当调用 navigator.hid.requestDevice 时，可以使用 Session 上的 select-hid-device 事件选择 HID 设备。此外，hid-device-added 和 hid-device-removed 事件可以在处理 select-hid-device 事件时用于处理设备的插入或拔出。**注意：**这些事件仅在 select-hid-device 的回调被调用之前触发。它们并非旨在用作通用的 HID 设备监听器。
ses.setDevicePermissionHandler(handler) 可用于为设备提供默认权限，而无需先通过 navigator.hid.requestDevice 请求设备权限。此外，Electron 的默认行为是通过相应 WebContents 的生命周期存储授予的设备权限。如果需要更长时间的存储，开发人员可以存储授予的设备权限（例如，在处理 select-hid-device 事件时），然后使用 setDevicePermissionHandler 从该存储中读取。
ses.setPermissionCheckHandler(handler) 可用于禁用特定来源的 HID 访问权限。

阻止列表

默认情况下，Electron 使用 Chromium 使用的相同阻止列表。如果希望覆盖此行为，可以通过设置 disable-hid-blocklist 标志来实现。

app.commandLine.appendSwitch('disable-hid-blocklist')

示例

此示例演示了一个 Electron 应用程序，该应用程序通过 ses.setDevicePermissionHandler(handler) 和通过单击“测试 WebHID”按钮时 Session 上的 select-hid-device 事件自动选择 HID 设备。

docs/fiddles/features/web-hid (33.0.1)在 Fiddle 中打开

main.js
index.html
renderer.js

const { app, BrowserWindow } = require('electron/main')

function createWindow () {
  const mainWindow = new BrowserWindow({
    width: 800,
    height: 600
  })

  mainWindow.webContents.session.on('select-hid-device', (event, details, callback) => {
    // Add events to handle devices being added or removed before the callback on
    // `select-hid-device` is called.
    mainWindow.webContents.session.on('hid-device-added', (event, device) => {
      console.log('hid-device-added FIRED WITH', device)
      // Optionally update details.deviceList
    })

    mainWindow.webContents.session.on('hid-device-removed', (event, device) => {
      console.log('hid-device-removed FIRED WITH', device)
      // Optionally update details.deviceList
    })

    event.preventDefault()
    if (details.deviceList && details.deviceList.length > 0) {
      callback(details.deviceList[0].deviceId)
    }
  })

  mainWindow.webContents.session.setPermissionCheckHandler((webContents, permission, requestingOrigin, details) => {
    if (permission === 'hid' && details.securityOrigin === 'file:///') {
      return true
    }
  })

  mainWindow.webContents.session.setDevicePermissionHandler((details) => {
    if (details.deviceType === 'hid' && details.origin === 'file://') {
      return true
    }
  })

  mainWindow.loadFile('index.html')
}

app.whenReady().then(() => {
  createWindow()

  app.on('activate', function () {
    if (BrowserWindow.getAllWindows().length === 0) createWindow()
  })
})

app.on('window-all-closed', function () {
  if (process.platform !== 'darwin') app.quit()
})

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
    <meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'">
    <title>WebHID API</title>
  </head>
  <body>
    <h1>WebHID API</h1>

    <button id="clickme">Test WebHID</button>

    <h3>HID devices automatically granted access via <i>setDevicePermissionHandler</i></h3>
    <div id="granted-devices"></div>

    <h3>HID devices automatically granted access via <i>select-hid-device</i></h3>
    <div id="granted-devices2"></div>

    <script src="./renderer.js"></script>
  </body>
</html>

function formatDevices (devices) {
  return devices.map(device => device.productName).join('<hr>')
}

async function testIt () {
  document.getElementById('granted-devices').innerHTML = formatDevices(await navigator.hid.getDevices())
  document.getElementById('granted-devices2').innerHTML = formatDevices(await navigator.hid.requestDevice({ filters: [] }))
}

document.getElementById('clickme').addEventListener('click', testIt)

Web Serial API

可以使用 Web Serial API 访问通过串行端口、USB 或蓝牙连接的串行设备。为了在 Electron 中使用此 API，开发人员需要处理与串行端口请求关联的 Session 上的 select-serial-port 事件。

还有几个其他用于处理 Web Serial API 的 API。

可以使用 Session 上的 serial-port-added 和 serial-port-removed 事件在处理 select-serial-port 事件时处理设备的插入或拔出。**注意：**这些事件仅在 select-serial-port 的回调被调用之前触发。它们并非旨在用作通用的串行端口监听器。
ses.setDevicePermissionHandler(handler) 可用于为设备提供默认权限，而无需先通过 navigator.serial.requestPort 请求设备权限。此外，Electron 的默认行为是通过相应 WebContents 的生命周期存储授予的设备权限。如果需要更长时间的存储，开发人员可以存储授予的设备权限（例如，在处理 select-serial-port 事件时），然后使用 setDevicePermissionHandler 从该存储中读取。
ses.setPermissionCheckHandler(handler) 可用于禁用特定来源的串行访问权限。

示例

此示例演示了一个 Electron 应用程序，该应用程序通过 ses.setDevicePermissionHandler(handler) 自动选择串行设备，并通过单击“测试 Web Serial”按钮时 Session 上的 select-serial-port 事件演示选择第一个可用的 Arduino Uno 串行设备（如果已连接）。

docs/fiddles/features/web-serial (33.0.1)在 Fiddle 中打开

main.js
index.html
renderer.js

const { app, BrowserWindow } = require('electron/main')

function createWindow () {
  const mainWindow = new BrowserWindow({
    width: 800,
    height: 600
  })

  mainWindow.webContents.session.on('select-serial-port', (event, portList, webContents, callback) => {
    // Add listeners to handle ports being added or removed before the callback for `select-serial-port`
    // is called.
    mainWindow.webContents.session.on('serial-port-added', (event, port) => {
      console.log('serial-port-added FIRED WITH', port)
      // Optionally update portList to add the new port
    })

    mainWindow.webContents.session.on('serial-port-removed', (event, port) => {
      console.log('serial-port-removed FIRED WITH', port)
      // Optionally update portList to remove the port
    })

    event.preventDefault()
    if (portList && portList.length > 0) {
      callback(portList[0].portId)
    } else {
      // eslint-disable-next-line n/no-callback-literal
      callback('') // Could not find any matching devices
    }
  })

  mainWindow.webContents.session.setPermissionCheckHandler((webContents, permission, requestingOrigin, details) => {
    if (permission === 'serial' && details.securityOrigin === 'file:///') {
      return true
    }

    return false
  })

  mainWindow.webContents.session.setDevicePermissionHandler((details) => {
    if (details.deviceType === 'serial' && details.origin === 'file://') {
      return true
    }

    return false
  })

  mainWindow.loadFile('index.html')

  mainWindow.webContents.openDevTools()
}

app.whenReady().then(() => {
  createWindow()

  app.on('activate', function () {
    if (BrowserWindow.getAllWindows().length === 0) createWindow()
  })
})

app.on('window-all-closed', function () {
  if (process.platform !== 'darwin') app.quit()
})

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
    <meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'">
    <title>Web Serial API</title>
  <body>
    <h1>Web Serial API</h1>

    <button id="clickme">Test Web Serial API</button>

    <p>Matching Arduino Uno device: <strong id="device-name""></strong></p>

    <script src="./renderer.js"></script>
  </body>
</html>

async function testIt () {
  const filters = [
    { usbVendorId: 0x2341, usbProductId: 0x0043 },
    { usbVendorId: 0x2341, usbProductId: 0x0001 }
  ]
  try {
    const port = await navigator.serial.requestPort({ filters })
    const portInfo = port.getInfo()
    document.getElementById('device-name').innerHTML = `vendorId: ${portInfo.usbVendorId} | productId: ${portInfo.usbProductId} `
  } catch (ex) {
    if (ex.name === 'NotFoundError') {
      document.getElementById('device-name').innerHTML = 'Device NOT found'
    } else {
      document.getElementById('device-name').innerHTML = ex
    }
  }
}

document.getElementById('clickme').addEventListener('click', testIt)

WebUSB API

可以使用 WebUSB API 访问 USB 设备。Electron 提供了多个用于处理 WebUSB API 的 API。

当调用 navigator.usb.requestDevice 时，可以使用 Session 上的 select-usb-device 事件选择 USB 设备。此外，Session 上的 usb-device-added 和 usb-device-removed 事件可以在处理 select-usb-device 事件时用于处理设备的插入或拔出。**注意：**这两个事件仅在 select-usb-device 的回调被调用之前触发。它们并非旨在用作通用的 USB 设备监听器。
当在 USB 设备上调用 device.forget() 时，可以使用 Session 上的 usb-device-revoked 事件进行响应。
ses.setDevicePermissionHandler(handler) 可用于为设备提供默认权限，而无需先通过 navigator.usb.requestDevice 请求设备权限。此外，Electron 的默认行为是通过相应 WebContents 的生命周期存储授予的设备权限。如果需要更长时间的存储，开发人员可以存储授予的设备权限（例如，在处理 select-usb-device 事件时），然后使用 setDevicePermissionHandler 从该存储中读取。
ses.setPermissionCheckHandler(handler) 可用于禁用特定来源的 USB 访问权限。
ses.setUSBProtectedClassesHandler 可用于允许使用默认情况下不可用的受保护的 USB 类。

示例

此示例演示了一个 Electron 应用程序，该应用程序通过 ses.setDevicePermissionHandler(handler) 和通过单击“测试 WebUSB”按钮时 Session 上的 select-usb-device 事件自动选择 USB 设备（如果已连接）。

docs/fiddles/features/web-usb (33.0.1)在 Fiddle 中打开

main.js
index.html
renderer.js

const { app, BrowserWindow } = require('electron/main')

function createWindow () {
  const mainWindow = new BrowserWindow({
    width: 800,
    height: 600
  })

  let grantedDeviceThroughPermHandler

  mainWindow.webContents.session.on('select-usb-device', (event, details, callback) => {
    // Add events to handle devices being added or removed before the callback on
    // `select-usb-device` is called.
    mainWindow.webContents.session.on('usb-device-added', (event, device) => {
      console.log('usb-device-added FIRED WITH', device)
      // Optionally update details.deviceList
    })

    mainWindow.webContents.session.on('usb-device-removed', (event, device) => {
      console.log('usb-device-removed FIRED WITH', device)
      // Optionally update details.deviceList
    })

    event.preventDefault()
    if (details.deviceList && details.deviceList.length > 0) {
      const deviceToReturn = details.deviceList.find((device) => {
        return !grantedDeviceThroughPermHandler || (device.deviceId !== grantedDeviceThroughPermHandler.deviceId)
      })
      if (deviceToReturn) {
        callback(deviceToReturn.deviceId)
      } else {
        callback()
      }
    }
  })

  mainWindow.webContents.session.setPermissionCheckHandler((webContents, permission, requestingOrigin, details) => {
    if (permission === 'usb' && details.securityOrigin === 'file:///') {
      return true
    }
  })

  mainWindow.webContents.session.setDevicePermissionHandler((details) => {
    if (details.deviceType === 'usb' && details.origin === 'file://') {
      if (!grantedDeviceThroughPermHandler) {
        grantedDeviceThroughPermHandler = details.device
        return true
      } else {
        return false
      }
    }
  })

  mainWindow.webContents.session.setUSBProtectedClassesHandler((details) => {
    return details.protectedClasses.filter((usbClass) => {
      // Exclude classes except for audio classes
      return usbClass.indexOf('audio') === -1
    })
  })

  mainWindow.loadFile('index.html')
}

app.whenReady().then(() => {
  createWindow()

  app.on('activate', function () {
    if (BrowserWindow.getAllWindows().length === 0) createWindow()
  })
})

app.on('window-all-closed', function () {
  if (process.platform !== 'darwin') app.quit()
})

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
    <meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'">
    <title>WebUSB API</title>
  </head>
  <body>
    <h1>WebUSB API</h1>

    <button id="clickme">Test WebUSB</button>

    <h3>USB devices automatically granted access via <i>setDevicePermissionHandler</i></h3>
    <div id="granted-devices"></div>

    <h3>USB devices automatically granted access via <i>select-usb-device</i></h3>
    <div id="granted-devices2"></div>

    <script src="./renderer.js"></script>
  </body>
</html>

function getDeviceDetails (device) {
  return device.productName || `Unknown device ${device.deviceId}`
}

async function testIt () {
  const noDevicesFoundMsg = 'No devices found'
  const grantedDevices = await navigator.usb.getDevices()
  let grantedDeviceList = ''
  if (grantedDevices.length > 0) {
    for (const device of grantedDevices) {
      grantedDeviceList += `<hr>${getDeviceDetails(device)}</hr>`
    }
  } else {
    grantedDeviceList = noDevicesFoundMsg
  }
  document.getElementById('granted-devices').innerHTML = grantedDeviceList

  grantedDeviceList = ''
  try {
    const grantedDevice = await navigator.usb.requestDevice({
      filters: []
    })
    grantedDeviceList += `<hr>${getDeviceDetails(grantedDevice)}</hr>`
  } catch (ex) {
    if (ex.name === 'NotFoundError') {
      grantedDeviceList = noDevicesFoundMsg
    }
  }
  document.getElementById('granted-devices2').innerHTML = grantedDeviceList
}

document.getElementById('clickme').addEventListener('click', testIt)

Web Bluetooth API​

示例​

WebHID API​

阻止列表​

示例​

Web Serial API​

示例​

WebUSB API​

示例​

Web Bluetooth API

示例

WebHID API

阻止列表

示例

Web Serial API

示例

WebUSB API

示例