chrome.usb

Mô tả

Sử dụng API chrome.usb để tương tác với các thiết bị USB đã kết nối. API này cung cấp quyền truy cập vào các thao tác USB từ ngữ cảnh của ứng dụng. Khi sử dụng API này, ứng dụng có thể hoạt động như trình điều khiển cho các thiết bị phần cứng. Lỗi do API này tạo ra được báo cáo bằng cách đặt runtime.lastError và thực thi lệnh gọi lại thông thường của hàm. Các tham số thông thường của lệnh gọi lại sẽ không được xác định trong trường hợp này.

Quyền

usb

Loại

ConfigDescriptor

Thuộc tính

  • hoạt động

    boolean

    Chrome 47 trở lên

    Đây có phải là cấu hình đang hoạt động không?

  • configurationValue

    số

    Số cấu hình.

  • mô tả

    chuỗi không bắt buộc

    Nội dung mô tả cấu hình.

  • extra_data

    ArrayBuffer

    Dữ liệu mô tả bổ sung liên kết với cấu hình này.

  • giao diện

    InterfaceDescriptor[]

    Giao diện có sẵn.

  • maxPower

    số

    Công suất tối đa mà thiết bị này cần, tính bằng miliampe (mA).

  • remoteWakeup

    boolean

    Thiết bị hỗ trợ tính năng đánh thức từ xa.

  • selfPowered

    boolean

    Thiết bị tự cấp nguồn.

ConnectionHandle

Thuộc tính

  • handle

    số

    Một handle mờ đại diện cho kết nối này với thiết bị USB và tất cả giao diện đã xác nhận quyền sở hữu và các lượt chuyển đang chờ xử lý được liên kết. Một tay điều khiển mới sẽ được tạo mỗi khi thiết bị được mở. Tên người dùng kết nối khác với Device.device.

  • productId

    số

    Mã sản phẩm.

  • vendorId

    số

    Mã nhà cung cấp thiết bị.

ControlTransferInfo

Thuộc tính

  • dữ liệu

    ArrayBuffer không bắt buộc

    Dữ liệu cần truyền (chỉ cần thiết cho các lượt chuyển dữ liệu đầu ra).

  • chỉ đường

    Hướng

    Hướng chuyển ("in" hoặc "out").

  • index

    số

    Trường wIndex, hãy xem Ibid.

  • chiều dài

    số không bắt buộc

    Số byte tối đa cần nhận (chỉ bắt buộc đối với các lượt chuyển dữ liệu đầu vào).

  • người nhận

    Người nhận

    Mục tiêu chuyển. Bạn phải xác nhận quyền sở hữu mục tiêu do index cung cấp nếu "interface" hoặc "endpoint".

  • request

    số

    Trường bRequest, xem Bản sửa đổi 1.1 của quy cách Buýt nối tiếp đa năng § 9.3.

  • requestType

    RequestType

    Loại yêu cầu.

  • tạm ngừng

    số không bắt buộc

    Chrome 43 trở lên

    Hết thời gian chờ yêu cầu (tính bằng mili giây). Giá trị mặc định 0 cho biết không có thời gian chờ.

  • value

    số

    Trường wValue, hãy xem Ibid.

Device

Thuộc tính

  • thiết bị

    số

    Mã nhận dạng mờ cho thiết bị USB. Giá trị này không thay đổi cho đến khi bạn rút phích cắm thiết bị.

  • manufacturerName

    chuỗi

    Chrome 46 trở lên

    Chuỗi iManufacturer được đọc từ thiết bị, nếu có.

  • productId

    số

    Mã sản phẩm.

  • Tên sản phẩm

    chuỗi

    Chrome 46 trở lên

    Chuỗi iProduct được đọc từ thiết bị, nếu có.

  • serialNumber

    chuỗi

    Chrome 46 trở lên

    Chuỗi iSerialNumber được đọc từ thiết bị, nếu có.

  • vendorId

    số

    Mã nhà cung cấp thiết bị.

  • version

    số

    Chrome 51 trở lên

    Phiên bản thiết bị (trường bcdDevice).

DeviceFilter

Thuộc tính

  • interfaceClass

    số không bắt buộc

    Lớp giao diện USB, khớp với mọi giao diện trên thiết bị.

  • interfaceProtocol

    số không bắt buộc

    Giao thức giao diện USB, chỉ được kiểm tra nếu lớp con giao diện khớp.

  • interfaceSubclass

    số không bắt buộc

    Lớp con giao diện USB, chỉ được đánh dấu nếu lớp giao diện khớp.

  • productId

    số không bắt buộc

    Mã sản phẩm của thiết bị, chỉ được kiểm tra nếu mã nhà cung cấp khớp.

  • vendorId

    số không bắt buộc

    Mã nhận dạng nhà cung cấp thiết bị.

DevicePromptOptions

Thuộc tính

  • bộ lọc

    DeviceFilter[] không bắt buộc

    Lọc danh sách thiết bị được hiển thị cho người dùng. Nếu bạn cung cấp nhiều bộ lọc, thì những thiết bị khớp với bất kỳ bộ lọc nào sẽ xuất hiện.

  • nhiều

    boolean không bắt buộc

    Cho phép người dùng chọn nhiều thiết bị.

Direction

Direction, Recipient, RequestType và TransferType đều liên kết với các tên tương ứng trong quy cách USB.

Enum

"trong"

"out"

EndpointDescriptor

Thuộc tính

  • xử lý

    số

    Địa chỉ điểm cuối.

  • chỉ đường

    Hướng

    Hướng chuyển.

  • extra_data

    ArrayBuffer

    Dữ liệu mô tả bổ sung liên kết với điểm cuối này.

  • maximumPacketSize

    số

    Kích thước gói tối đa.

  • pollingInterval

    số không bắt buộc

    Khoảng thời gian thăm dò ý kiến (chỉ dành cho chế độ gián đoạn và đồng bộ).

  • đồng bộ hoá

    SynchronizationType không bắt buộc

    Chế độ đồng bộ hoá chuyển (chỉ đồng bộ).

  • loại

    TransferType

    Loại chuyển.

  • mức sử dụng

    UsageType không bắt buộc

    Gợi ý về cách sử dụng điểm cuối.

EnumerateDevicesAndRequestAccessOptions

Thuộc tính

  • interfaceId

    số không bắt buộc

    Mã giao diện để yêu cầu quyền truy cập. Chỉ có trên Chrome OS. Điều này không ảnh hưởng đến các nền tảng khác.

  • productId

    số

    Mã sản phẩm.

  • vendorId

    số

    Mã nhà cung cấp thiết bị.

EnumerateDevicesOptions

Thuộc tính

  • bộ lọc

    DeviceFilter[] không bắt buộc

    Hệ thống sẽ trả về một thiết bị khớp với bất kỳ bộ lọc nào đã cho. Danh sách bộ lọc trống sẽ trả về tất cả thiết bị mà ứng dụng có quyền truy cập.

  • productId

    số không bắt buộc

    Không dùng nữa

    Tương đương với việc thiết lập DeviceFilter.productId.

  • vendorId

    số không bắt buộc

    Không dùng nữa

    Tương đương với việc thiết lập DeviceFilter.vendorId.

GenericTransferInfo

Thuộc tính

  • dữ liệu

    ArrayBuffer không bắt buộc

    Dữ liệu cần truyền (chỉ cần thiết cho các lượt chuyển dữ liệu đầu ra).

  • chỉ đường

    Hướng

    Hướng chuyển ("in" hoặc "out").

  • điểm cuối

    số

    Địa chỉ điểm cuối mục tiêu. Bạn phải xác nhận quyền sở hữu giao diện chứa điểm cuối này.

  • chiều dài

    số không bắt buộc

    Số byte tối đa cần nhận (chỉ bắt buộc đối với các lượt chuyển dữ liệu đầu vào).

  • tạm ngừng

    số không bắt buộc

    Chrome 43 trở lên

    Hết thời gian chờ yêu cầu (tính bằng mili giây). Giá trị mặc định 0 cho biết không có thời gian chờ.

InterfaceDescriptor

Thuộc tính

  • alternateSetting

    số

    Số chế độ cài đặt thay thế của giao diện (mặc định là 0)

  • mô tả

    chuỗi không bắt buộc

    Nội dung mô tả về giao diện.

  • điểm cuối

    EndpointDescriptor[]

    Các điểm cuối có sẵn.

  • extra_data

    ArrayBuffer

    Dữ liệu mô tả bổ sung liên kết với giao diện này.

  • interfaceClass

    số

    Lớp giao diện USB.

  • interfaceNumber

    số

    Số giao diện.

  • interfaceProtocol

    số

    Giao thức giao diện USB.

  • interfaceSubclass

    số

    Lớp con giao diện USB.

IsochronousTransferInfo

Thuộc tính

  • packetLength

    số

    Chiều dài của mỗi gói trong quá trình chuyển này.

  • gói

    số

    Tổng số gói trong quá trình chuyển này.

  • transferInfo

    GenericTransferInfo

    Chuyển tham số. Chiều dài chuyển hoặc vùng đệm dữ liệu được chỉ định trong khối tham số này được phân tách dọc theo ranh giới packetLength để tạo thành các gói riêng lẻ của quá trình chuyển.

Recipient

Enum

"device"

"giao diện"

"điểm cuối"

"other"

RequestType

Enum

"standard"

"class"

"vendor"

"đã đặt trước"

SynchronizationType

Đối với chế độ ngắt và đồng bộ, SynchronizationType và UsageType liên kết với các tên tương ứng trong quy cách USB.

Enum

"không đồng bộ"

"thích ứng"

"tương thích"

TransferResultInfo

Thuộc tính

  • dữ liệu

    ArrayBuffer không bắt buộc

    Dữ liệu được trả về bằng một lượt chuyển dữ liệu đầu vào. undefined để chuyển dữ liệu đầu ra.

  • resultCode

    số không bắt buộc

    Giá trị 0 cho biết quá trình chuyển đã thành công. Các giá trị khác cho biết không thành công.

TransferType

Enum

"control"

"interrupt"

"isochronous"

"hàng loạt"

UsageType

Enum

"data"

"feedback"

"explicitFeedback"

"periodic"

"notification"

Phương thức

bulkTransfer()

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

Thực hiện chuyển hàng loạt trên thiết bị đã chỉ định.

Tham số

Giá trị trả về

  • Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

claimInterface()

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

Xác nhận quyền sở hữu giao diện trên thiết bị USB. Trước khi có thể chuyển dữ liệu đến một giao diện hoặc các điểm cuối được liên kết, bạn phải xác nhận quyền sở hữu giao diện đó. Tại một thời điểm bất kỳ, chỉ một handle kết nối mới có thể xác nhận quyền sở hữu một giao diện. Nếu giao diện đã được xác nhận quyền sở hữu, lệnh gọi này sẽ không thành công.

Bạn nên gọi releaseInterface khi không cần giao diện nữa.

Tham số

  • Kết nối mở với thiết bị.

  • interfaceNumber

    số

    Giao diện cần được xác nhận quyền sở hữu.

  • lệnh gọi lại

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    () => void

Giá trị trả về

  • Promise<void>

    Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

closeDevice()

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

Đóng một handle kết nối. Việc gọi các thao tác trên một handle sau khi handle đó đã đóng là một thao tác an toàn nhưng không gây ra hành động nào.

Tham số

Giá trị trả về

  • Promise<void>

    Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

controlTransfer()

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

Thực hiện chuyển quyền kiểm soát trên thiết bị được chỉ định.

Các lượt chuyển quyền kiểm soát đề cập đến thiết bị, giao diện hoặc điểm cuối. Bạn cần xác nhận quyền sở hữu giao diện để chuyển sang một giao diện hoặc điểm cuối.

Tham số

Giá trị trả về

  • Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

findDevices()

Promise 
chrome.usb.findDevices(
  options: EnumerateDevicesAndRequestAccessOptions,
  callback?: function,
)

Tìm các thiết bị USB do nhà cung cấp, sản phẩm và mã giao diện (không bắt buộc) chỉ định và nếu có quyền, hãy mở các thiết bị đó để sử dụng.

Nếu yêu cầu truy cập bị từ chối hoặc không mở được thiết bị, thì hệ thống sẽ không tạo hoặc trả về handle kết nối.

Việc gọi phương thức này tương đương với việc gọi getDevices, theo sau là openDevice cho mỗi thiết bị.

Tham số

Giá trị trả về

  • Promise<ConnectionHandle[]>

    Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getConfiguration()

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

Lấy chỉ số mô tả cấu hình cho cấu hình hiện được chọn.

Tham số

Giá trị trả về

  • Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getConfigurations()

Promise Chrome 47 trở lên 
chrome.usb.getConfigurations(
  device: Device,
  callback?: function,
)

Trả về tập hợp đầy đủ các chỉ số mô tả cấu hình thiết bị.

Tham số

Giá trị trả về

  • Promise<ConfigDescriptor[]>

    Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getDevices()

Promise 
chrome.usb.getDevices(
  options: EnumerateDevicesOptions,
  callback?: function,
)

Liệt kê các thiết bị USB đã kết nối.

Tham số

  • Các thuộc tính cần tìm kiếm trên thiết bị mục tiêu.

  • lệnh gọi lại

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (devices: Device[]) => void

Giá trị trả về

  • Promise<Device[]>

    Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getUserSelectedDevices()

Promise 
chrome.usb.getUserSelectedDevices(
  options: DevicePromptOptions,
  callback?: function,
)

Trình bày bộ chọn thiết bị cho người dùng và trả về Device đã chọn. Nếu người dùng huỷ, các thiết bị bộ chọn sẽ trống. Cần có cử chỉ của người dùng để hộp thoại hiển thị. Nếu không có cử chỉ của người dùng, lệnh gọi lại sẽ chạy như thể người dùng đã huỷ.

Tham số

  • tùy chọn

    DevicePromptOptions

    Cấu hình của hộp thoại bộ chọn thiết bị.

  • lệnh gọi lại

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (devices: Device[]) => void

Giá trị trả về

  • Promise<Device[]>

    Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

interruptTransfer()

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

Thực hiện chuyển gián đoạn trên thiết bị đã chỉ định.

Tham số

Giá trị trả về

  • Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

isochronousTransfer()

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

Thực hiện quá trình truyền đồng bộ trên thiết bị cụ thể.

Tham số

Giá trị trả về

  • Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

listInterfaces()

Promise 
chrome.usb.listInterfaces(
  handle: ConnectionHandle,
  callback?: function,
)

Liệt kê tất cả giao diện trên thiết bị USB.

Tham số

Giá trị trả về

  • Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

openDevice()

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

Mở một thiết bị USB do getDevices trả về.

Tham số

Giá trị trả về

  • Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

releaseInterface()

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

Phát hành giao diện đã được xác nhận quyền sở hữu.

Tham số

  • Kết nối mở với thiết bị.

  • interfaceNumber

    số

    Giao diện sẽ được phát hành.

  • lệnh gọi lại

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    () => void

Giá trị trả về

  • Promise<void>

    Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

requestAccess()

Promise Không dùng nữa
chrome.usb.requestAccess(
  device: Device,
  interfaceId: number,
  callback?: function,
)

Hàm này dành riêng cho Chrome OS và sẽ không gọi được trên các nền tảng khác. Thao tác này hiện được thực hiện ngầm trong openDevice và hàm này sẽ trả về true trên tất cả các nền tảng.

Yêu cầu quyền truy cập từ trình dàn xếp quyền vào một thiết bị do Chrome OS xác nhận quyền sở hữu nếu giao diện đã cho trên thiết bị không được xác nhận quyền sở hữu.

Tham số

  • thiết bị

    Thiết bị

    Device mà bạn muốn yêu cầu quyền truy cập.

  • interfaceId

    số

    Giao diện cụ thể được yêu cầu.

  • lệnh gọi lại

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (success: boolean) => void

    • thành công

      boolean

Giá trị trả về

  • Promise<boolean>

    Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

resetDevice()

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

Thử đặt lại thiết bị USB. Nếu không đặt lại được, tay điều khiển kết nối đã cho sẽ bị đóng và thiết bị USB sẽ có vẻ như bị ngắt kết nối rồi kết nối lại. Trong trường hợp này, bạn phải gọi lại getDevices hoặc findDevices để lấy thiết bị.

Tham số

  • Một tay cầm kết nối để đặt lại.

  • lệnh gọi lại

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (success: boolean) => void

    • thành công

      boolean

Giá trị trả về

  • Promise<boolean>

    Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

setConfiguration()

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

Chọn một cấu hình thiết bị.

Hàm này đặt lại thiết bị một cách hiệu quả bằng cách chọn một trong các cấu hình có sẵn của thiết bị. Chỉ những giá trị cấu hình lớn hơn 0 mới hợp lệ, tuy nhiên, một số thiết bị bị lỗi có cấu hình hoạt động 0 nên giá trị này được cho phép.

Tham số

  • Kết nối mở với thiết bị.

  • configurationValue

    số

  • lệnh gọi lại

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    () => void

Giá trị trả về

  • Promise<void>

    Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

setInterfaceAlternateSetting()

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

Chọn một chế độ cài đặt thay thế trên giao diện đã được xác nhận quyền sở hữu trước đó.

Tham số

  • Một kết nối mở với thiết bị mà giao diện này đã được xác nhận quyền sở hữu.

  • interfaceNumber

    số

    Giao diện cần định cấu hình.

  • alternateSetting

    số

    Chế độ cài đặt thay thế để định cấu hình.

  • lệnh gọi lại

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    () => void

Giá trị trả về

  • Promise<void>

    Chrome 116 trở lên

    Lời hứa chỉ được hỗ trợ cho Tệp kê khai V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

Sự kiện

onDeviceAdded

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

Sự kiện được tạo khi một thiết bị được thêm vào hệ thống. Các sự kiện chỉ được truyền đến các ứng dụng và tiện ích có quyền truy cập vào thiết bị. Quyền có thể đã được cấp tại thời điểm cài đặt, khi người dùng chấp nhận một quyền không bắt buộc (xem permissions.request) hoặc thông qua getUserSelectedDevices.

Tham số

  • lệnh gọi lại

    hàm

    Tham số callback có dạng như sau: 

    (device: Device) => void

onDeviceRemoved

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

Sự kiện được tạo khi một thiết bị bị xoá khỏi hệ thống. Xem onDeviceAdded để biết những sự kiện được phân phối.

Tham số

  • lệnh gọi lại

    hàm

    Tham số callback có dạng như sau: 

    (device: Device) => void