chrome.usb

说明

使用 chrome.usb API 与连接的 USB 设备进行交互。此 API 允许在应用上下文中访问 USB 操作。使用此 API，应用可以充当硬件设备的驱动程序。此 API 生成的错误通过设置 runtime.lastError 并执行函数的常规回调来报告。在这种情况下，回调的常规参数将处于未定义状态。

权限

usb

可用性

仅限 ChromeOS

类型

ConfigDescriptor

属性

  • 活跃

    布尔值

    Chrome 47 及更高版本

    这是有效配置吗？

  • configurationValue

    数值

    配置编号。

  • 说明

    字符串 可选

    配置的说明。

  • extra_data

    ArrayBuffer

    与此配置关联的额外描述符数据。

  • 可用的接口。

  • maxPower

    数值

    此设备所需的最大功率，以毫安 (mA) 为单位。

  • remoteWakeup

    布尔值

    设备支持远程唤醒。

  • selfPowered

    布尔值

    设备是自供电的。

ConnectionHandle

属性

  • 句柄

    数值

    一个不透明句柄，表示与 USB 设备的此连接以及所有关联的已声明接口和待处理传输。每次打开设备时，系统都会创建一个新句柄。连接句柄与 Device.device 不同。

  • productId

    数值

    商品 ID。

  • vendorId

    数值

    设备供应商 ID。

ControlTransferInfo

属性

  • 数据

    ArrayBuffer 可选

    要传输的数据（仅输出传输需要）。

  • 方向

    方向

    传输方向（"in" 或 "out"）。

  • 索引

    数值

    wIndex 字段，请参阅同上。

  • 长度

    number 可选

    要接收的最大字节数（仅输入传输需要）。

  • 收件人

    Recipient

    转移目标。如果 "interface" 或 "endpoint"，则必须声明 index 给出的目标。

  • request

    数值

    bRequest 字段，请参阅通用串行总线规范修订版 1.1 § 9.3。

  • requestType

    RequestType

    请求类型。

  • 超时

    number 可选

    Chrome 43 及更高版本

    请求超时（以毫秒为单位）。默认值 0 表示无超时。

  • 值

    数值

    wValue 字段，请参阅同上。

Device

属性

  • 设备

    数值

    USB 设备的不透明 ID。在设备拔出之前，该值保持不变。

  • manufacturerName

    字符串

    Chrome 46 及更高版本

    从设备读取的 iManufacturer 字符串（如果有）。

  • productId

    数值

    商品 ID。

  • productName

    字符串

    Chrome 46 及更高版本

    从设备读取的 iProduct 字符串（如果有）。

  • serialNumber

    字符串

    Chrome 46 及更高版本

    从设备读取的 iSerialNumber 字符串（如有）。

  • vendorId

    数值

    设备供应商 ID。

  • 版本

    数值

    Chrome 51 及更高版本

    设备版本（bcdDevice 字段）。

DeviceFilter

属性

  • interfaceClass

    number 可选

    USB 接口类，与设备上的任何接口匹配。

  • interfaceProtocol

    number 可选

    USB 接口协议，仅在接口子类匹配时检查。

  • interfaceSubclass

    number 可选

    USB 接口子类，仅在接口类匹配时检查。

  • productId

    number 可选

    设备产品 ID，仅在供应商 ID 匹配时才会检查。

  • vendorId

    number 可选

    设备供应商 ID。

DevicePromptOptions

属性

  • 过滤器

    DeviceFilter[] 可选

    过滤向用户显示的设备列表。如果提供了多个过滤条件，系统会显示与任一过滤条件匹配的设备。

  • 多个

    布尔值 （可选）

    允许用户选择多台设备。

Direction

Direction、Recipient、RequestType 和 TransferType 均映射到 USB 规范中的同名项。

枚举

"in"

"out"

EndpointDescriptor

属性

  • 地址

    数值

    端点地址。

  • 方向

    方向

    传输方向。

  • extra_data

    ArrayBuffer

    与此端点关联的额外描述符数据。

  • maximumPacketSize

    数值

    数据包大小上限。

  • pollingInterval

    number 可选

    轮询间隔（仅限中断和等时）。

  • 同步

    SynchronizationType 可选

    传输同步模式（仅限等时）。

  • 类型

    TransferType

    转移类型。

  • 使用量

    UsageType （可选）

    端点使用提示。

EnumerateDevicesAndRequestAccessOptions

属性

  • interfaceId

    number 可选

    要请求访问权限的接口 ID。仅适用于 ChromeOS。它对其他平台没有影响。

  • productId

    数值

    商品 ID。

  • vendorId

    数值

    设备供应商 ID。

EnumerateDevicesOptions

属性

  • 过滤器

    DeviceFilter[] 可选

    系统会返回与任何给定过滤条件匹配的设备。如果过滤条件列表为空，系统会返回应用有权访问的所有设备。

  • productId

    number 可选

    已弃用

    等同于设置 DeviceFilter.productId。

  • vendorId

    number 可选

    已弃用

    等同于设置 DeviceFilter.vendorId。

GenericTransferInfo

属性

  • 数据

    ArrayBuffer 可选

    要传输的数据（仅输出传输需要）。

  • 方向

    方向

    传输方向（"in" 或 "out"）。

  • endpoint

    数值

    目标端点地址。必须声明包含此端点的接口。

  • 长度

    number 可选

    要接收的最大字节数（仅输入传输需要）。

  • 超时

    number 可选

    Chrome 43 及更高版本

    请求超时（以毫秒为单位）。默认值 0 表示无超时。

InterfaceDescriptor

属性

  • alternateSetting

    数值

    接口备用设置编号（默认为 0

  • 说明

    字符串 可选

    接口的说明。

  • endpoints

    EndpointDescriptor[]

    可用端点。

  • extra_data

    ArrayBuffer

    与此接口关联的额外描述符数据。

  • interfaceClass

    数值

    USB 接口类。

  • interfaceNumber

    数值

    接口编号。

  • interfaceProtocol

    数值

    USB 接口协议。

  • interfaceSubclass

    数值

    USB 接口子类。

IsochronousTransferInfo

属性

  • packetLength

    数值

    此传输中每个数据包的长度。

  • 数据包

    数值

    此次转移中的数据包总数。

  • transferInfo

    GenericTransferInfo

    转移作业参数。此参数块中指定的传输长度或数据缓冲区会沿 packetLength 边界拆分，以形成传输的各个数据包。

Recipient

枚举

"device"

"interface"

"endpoint"

"other"

RequestType

枚举

"standard"

"class"

"vendor"

"reserved"

SynchronizationType

对于中断和同步模式，SynchronizationType 和 UsageType 会映射到 USB 规范中的同名类型。

枚举

"asynchronous"

"adaptive"

"synchronous"

TransferResultInfo

属性

  • 数据

    ArrayBuffer 可选

    输入转移作业返回的数据。undefined（对于输出传输）。

  • resultCode

    number 可选

    值 0 表示转移作业成功。其他值表示失败。

TransferType

枚举

"control"

"interrupt"

"isochronous"

"bulk"

UsageType

枚举

"data"

"feedback"

"explicitFeedback"

"periodic"

"notification"

方法

bulkTransfer()

Promise 
chrome.usb.bulkTransfer(
  handle: ConnectionHandle,
  transferInfo: GenericTransferInfo,
  callback?: function,
): Promise<TransferResultInfo>

在指定设备上执行批量传输。

参数

返回

  • Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

claimInterface()

Promise 
chrome.usb.claimInterface(
  handle: ConnectionHandle,
  interfaceNumber: number,
  callback?: function,
): Promise<void>

声明对 USB 设备上的接口的所有权。在将数据传输到接口或关联的端点之前，必须先声明接口。在任何给定时间，只能有一个连接句柄声明接口。如果接口已被声明，此调用将失败。

当不再需要该接口时，应调用 releaseInterface。

参数

  • 与设备的开放连接。

  • interfaceNumber

    数值

    要声明的接口。

  • callback

    函数可选

    callback 参数如下所示： 

    () => void

返回

  • 承诺<void>

    Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

closeDevice()

Promise 
chrome.usb.closeDevice(
  handle: ConnectionHandle,
  callback?: function,
): Promise<void>

关闭连接句柄。在句柄关闭后对其调用操作是安全操作，但不会导致执行任何操作。

参数

返回

  • 承诺<void>

    Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

controlTransfer()

Promise 
chrome.usb.controlTransfer(
  handle: ConnectionHandle,
  transferInfo: ControlTransferInfo,
  callback?: function,
): Promise<TransferResultInfo>

在指定设备上执行控制传输。

控制传输是指设备、接口或端点。如需转移到某个接口或端点，必须先声明该接口。

参数

返回

  • Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

findDevices()

Promise 
chrome.usb.findDevices(
  options: EnumerateDevicesAndRequestAccessOptions,
  callback?: function,
): Promise<ConnectionHandle[]>

查找由供应商、产品和（可选）接口 ID 指定的 USB 设备，并在权限允许的情况下打开这些设备以供使用。

如果访问请求被拒绝或设备无法打开，则不会创建或返回连接句柄。

调用此方法等同于依次为每个设备调用 getDevices 和 openDevice。

参数

返回

  • Promise<ConnectionHandle[]>

    Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getConfiguration()

Promise 
chrome.usb.getConfiguration(
  handle: ConnectionHandle,
  callback?: function,
): Promise<ConfigDescriptor>

获取当前所选配置的配置描述符。

参数

返回

  • Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getConfigurations()

Promise Chrome 47 及更高版本 
chrome.usb.getConfigurations(
  device: Device,
  callback?: function,
): Promise<ConfigDescriptor[]>

返回完整的设备配置描述符集。

参数

返回

  • Promise<ConfigDescriptor[]>

    Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getDevices()

Promise 
chrome.usb.getDevices(
  options: EnumerateDevicesOptions,
  callback?: function,
): Promise<Device[]>

枚举已连接的 USB 设备。

参数

返回

  • Promise<Device[]>

    Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getUserSelectedDevices()

Promise 
chrome.usb.getUserSelectedDevices(
  options: DevicePromptOptions,
  callback?: function,
): Promise<Device[]>

向用户显示设备选择器，并返回所选的 Device。如果用户取消选择器，则设备列表将为空。需要用户手势才能显示对话框。如果没有用户手势，回调将像用户取消一样运行。

参数

  • 设备选择器对话框的配置。

  • callback

    函数可选

    callback 参数如下所示： 

    (devices: Device[]) => void

返回

  • Promise<Device[]>

    Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

interruptTransfer()

Promise 
chrome.usb.interruptTransfer(
  handle: ConnectionHandle,
  transferInfo: GenericTransferInfo,
  callback?: function,
): Promise<TransferResultInfo>

在指定设备上执行中断传输。

参数

返回

  • Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

isochronousTransfer()

Promise 
chrome.usb.isochronousTransfer(
  handle: ConnectionHandle,
  transferInfo: IsochronousTransferInfo,
  callback?: function,
): Promise<TransferResultInfo>

在特定设备上执行等时传输。

参数

返回

  • Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

listInterfaces()

Promise 
chrome.usb.listInterfaces(
  handle: ConnectionHandle,
  callback?: function,
): Promise<InterfaceDescriptor[]>

列出 USB 设备上的所有接口。

参数

返回

  • Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

openDevice()

Promise 
chrome.usb.openDevice(
  device: Device,
  callback?: function,
): Promise<ConnectionHandle>

打开 getDevices 返回的 USB 设备。

参数

返回

  • Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

releaseInterface()

Promise 
chrome.usb.releaseInterface(
  handle: ConnectionHandle,
  interfaceNumber: number,
  callback?: function,
): Promise<void>

释放已声明的接口。

参数

  • 与设备的开放连接。

  • interfaceNumber

    数值

    要发布的接口。

  • callback

    函数可选

    callback 参数如下所示： 

    () => void

返回

  • 承诺<void>

    Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

requestAccess()

Promise 已弃用
chrome.usb.requestAccess(
  device: Device,
  interfaceId: number,
  callback?: function,
): Promise<boolean>

此函数专用于 ChromeOS，在其他平台上调用会失败。此操作现在作为 openDevice 的一部分隐式执行，并且此函数将在所有平台上返回 true。

如果设备上的指定接口未被占用，则向权限代理请求访问 ChromeOS 占用的设备。

参数

  • 设备

    设备

    要请求访问权限的 Device。

  • interfaceId

    数值

    请求的特定接口。

  • callback

    函数可选

    callback 参数如下所示： 

    (success: boolean) => void

    • 成功

      布尔值

返回

  • Promise<boolean>

    Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

resetDevice()

Promise 
chrome.usb.resetDevice(
  handle: ConnectionHandle,
  callback?: function,
): Promise<boolean>

尝试重置 USB 设备。如果重置失败，系统会关闭给定的连接句柄，并且 USB 设备会显示为已断开连接，然后重新连接。在这种情况下，必须再次调用 getDevices 或 findDevices 才能获取设备。

参数

  • 要重置的连接句柄。

  • callback

    函数可选

    callback 参数如下所示： 

    (success: boolean) => void

    • 成功

      布尔值

返回

  • Promise<boolean>

    Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

setConfiguration()

Promise 
chrome.usb.setConfiguration(
  handle: ConnectionHandle,
  configurationValue: number,
  callback?: function,
): Promise<void>

选择设备配置。

此函数通过选择设备的某个可用配置来有效重置设备。只有大于 0 的配置值才有效，但某些有问题的设备具有有效的配置 0，因此允许使用此值。

参数

  • 与设备的开放连接。

  • configurationValue

    数值

  • callback

    函数可选

    callback 参数如下所示： 

    () => void

返回

  • 承诺<void>

    Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

setInterfaceAlternateSetting()

Promise 
chrome.usb.setInterfaceAlternateSetting(
  handle: ConnectionHandle,
  interfaceNumber: number,
  alternateSetting: number,
  callback?: function,
): Promise<void>

在之前声明的接口上选择备用设置。

参数

  • 与已声明此接口的设备的开放连接。

  • interfaceNumber

    数值

    要配置的接口。

  • alternateSetting

    数值

    要配置的备用设置。

  • callback

    函数可选

    callback 参数如下所示： 

    () => void

返回

  • 承诺<void>

    Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

事件

onDeviceAdded

chrome.usb.onDeviceAdded.addListener(
  callback: function,
)

在向系统添加设备时生成的事件。事件只会广播到有权访问设备的应用和扩展程序。权限可能是在安装时授予的，当时用户接受了可选权限（请参阅 permissions.request），也可能是通过 getUserSelectedDevices 授予的。

参数

  • callback

    函数

    callback 参数如下所示： 

    (device: Device) => void

onDeviceRemoved

chrome.usb.onDeviceRemoved.addListener(
  callback: function,
)

从系统中移除设备时生成的事件。如需了解哪些事件会传送，请参阅 onDeviceAdded。

参数

  • callback

    函数

    callback 参数如下所示： 

    (device: Device) => void