chrome.usb

Deskripsi

Gunakan chrome.usb API untuk berinteraksi dengan perangkat USB yang terhubung. API ini menyediakan akses ke operasi USB dari dalam konteks aplikasi. Dengan menggunakan API ini, aplikasi dapat berfungsi sebagai driver untuk perangkat hardware. Error yang dihasilkan oleh API ini dilaporkan dengan menyetel runtime.lastError dan mengeksekusi callback reguler fungsi. Parameter reguler callback tidak akan ditentukan dalam kasus ini.

Izin

usb

Jenis

ConfigDescriptor

Properti

  • aktif

    boolean

    Chrome 47+

    Apakah ini konfigurasi aktif?

  • configurationValue

    angka

    Nomor konfigurasi.

  • deskripsi

    string opsional

    Deskripsi konfigurasi.

  • extra_data

    ArrayBuffer

    Data deskriptor tambahan yang terkait dengan konfigurasi ini.

  • antarmuka

    InterfaceDescriptor[]

    Antarmuka yang tersedia.

  • maxPower

    angka

    Daya maksimum yang dibutuhkan oleh perangkat ini dalam miliampere (mA).

  • remoteWakeup

    boolean

    Perangkat mendukung aktifkan dari jarak jauh.

  • selfPowered

    boolean

    Perangkat memiliki daya sendiri.

ConnectionHandle

Properti

  • handle

    angka

    Handle buram yang merepresentasikan koneksi ini ke perangkat USB dan semua antarmuka yang diklaim terkait serta transfer yang tertunda. Setiap kali perangkat dibuka, akan dibuat handle baru. Handle koneksi berbeda dengan Device.device.

  • productId

    angka

    ID produk.

  • vendorId

    angka

    ID vendor perangkat.

ControlTransferInfo

Properti

  • data

    ArrayBuffer opsional

    Data yang akan ditransmisikan (hanya diperlukan oleh transfer output).

  • direction

    Arah

    Arah transfer ("in" atau "out").

  • indeks

    angka

    Kolom wIndex, lihat Ibid.

  • panjang

    nomor opsional

    Jumlah maksimum byte yang akan diterima (hanya diperlukan oleh transfer input).

  • penerima

    Penerima

    Target transfer. Target yang diberikan oleh index harus diklaim jika "interface" atau "endpoint".

  • minta

    angka

    Kolom bRequest, lihat Universal Serial Bus Specification Revision 1.1 § 9.3.

  • requestType

    RequestType

    Jenis permintaan.

  • timeout

    nomor opsional

    Chrome 43+

    Waktu tunggu permintaan (dalam milidetik). Nilai default 0 menunjukkan tidak ada waktu tunggu.

  • nilai

    angka

    Kolom wValue, lihat Ibid.

Device

Properti

  • perangkat

    angka

    ID buram untuk perangkat USB. Setelan ini tetap tidak berubah hingga perangkat dicabut.

  • manufacturerName

    string

    Chrome 46+

    String iManufacturer yang dibaca dari perangkat, jika tersedia.

  • productId

    angka

    ID produk.

  • productName

    string

    Chrome 46+

    String iProduct yang dibaca dari perangkat, jika tersedia.

  • serialNumber

    string

    Chrome 46+

    String iSerialNumber yang dibaca dari perangkat, jika tersedia.

  • vendorId

    angka

    ID vendor perangkat.

  • versi

    angka

    Chrome 51+

    Versi perangkat (kolom bcdDevice).

DeviceFilter

Properti

  • interfaceClass

    nomor opsional

    Class antarmuka USB, cocok dengan antarmuka apa pun di perangkat.

  • interfaceProtocol

    nomor opsional

    Protokol antarmuka USB, diperiksa hanya jika sub-kelas antarmuka cocok.

  • interfaceSubclass

    nomor opsional

    Sub-class antarmuka USB, hanya diperiksa jika class antarmuka cocok.

  • productId

    nomor opsional

    ID produk perangkat, hanya diperiksa jika ID vendor cocok.

  • vendorId

    nomor opsional

    ID vendor perangkat.

DevicePromptOptions

Properti

  • filter

    DeviceFilter[] opsional

    Memfilter daftar perangkat yang ditampilkan kepada pengguna. Jika beberapa filter disediakan, perangkat yang cocok dengan filter apa pun akan ditampilkan.

  • lebih dari satu

    boolean opsional

    Izinkan pengguna memilih beberapa perangkat.

Direction

Direction, Recipient, RequestType, dan TransferType semuanya dipetakan ke nama yang sama dalam spesifikasi USB.

Enum

"in"

"out"

EndpointDescriptor

Properti

  • alamat

    angka

    Alamat endpoint.

  • direction

    Arah

    Arah transfer.

  • extra_data

    ArrayBuffer

    Data deskriptor tambahan yang terkait dengan endpoint ini.

  • maximumPacketSize

    angka

    Ukuran paket maksimum.

  • pollingInterval

    nomor opsional

    Interval polling (hanya untuk interupsi dan isokron).

  • sinkronisasi

    SynchronizationType opsional

    Mode sinkronisasi transfer (khusus isokron).

  • jenis

    TransferType

    Jenis transfer.

  • penggunaan

    UsageType opsional

    Petunjuk penggunaan endpoint.

EnumerateDevicesAndRequestAccessOptions

Properti

  • interfaceId

    nomor opsional

    ID antarmuka untuk meminta akses. Hanya tersedia di ChromeOS. Hal ini tidak memengaruhi platform lain.

  • productId

    angka

    ID produk.

  • vendorId

    angka

    ID vendor perangkat.

EnumerateDevicesOptions

Properti

  • filter

    DeviceFilter[] opsional

    Perangkat yang cocok dengan filter tertentu akan ditampilkan. Daftar filter kosong akan menampilkan semua perangkat yang memiliki izin aplikasi.

  • productId

    nomor opsional

    Tidak digunakan lagi

    Setara dengan menyetel DeviceFilter.productId.

  • vendorId

    nomor opsional

    Tidak digunakan lagi

    Setara dengan menyetel DeviceFilter.vendorId.

GenericTransferInfo

Properti

  • data

    ArrayBuffer opsional

    Data yang akan ditransmisikan (hanya diperlukan oleh transfer output).

  • direction

    Arah

    Arah transfer ("in" atau "out").

  • endpoint

    angka

    Alamat endpoint target. Antarmuka yang berisi endpoint ini harus diklaim.

  • panjang

    nomor opsional

    Jumlah maksimum byte yang akan diterima (hanya diperlukan oleh transfer input).

  • timeout

    nomor opsional

    Chrome 43+

    Waktu tunggu permintaan (dalam milidetik). Nilai default 0 menunjukkan tidak ada waktu tunggu.

InterfaceDescriptor

Properti

  • alternateSetting

    angka

    Nomor setelan alternatif antarmuka (defaultnya 0

  • deskripsi

    string opsional

    Deskripsi antarmuka.

  • endpoint

    EndpointDescriptor[]

    Endpoint yang tersedia.

  • extra_data

    ArrayBuffer

    Data deskriptor tambahan yang terkait dengan antarmuka ini.

  • interfaceClass

    angka

    Class antarmuka USB.

  • interfaceNumber

    angka

    Nomor antarmuka.

  • interfaceProtocol

    angka

    Protokol antarmuka USB.

  • interfaceSubclass

    angka

    Sub-class antarmuka USB.

IsochronousTransferInfo

Properti

  • packetLength

    angka

    Panjang setiap paket dalam transfer ini.

  • paket

    angka

    Jumlah total paket dalam transfer ini.

  • transferInfo

    GenericTransferInfo

    Parameter transfer. Panjang transfer atau buffer data yang ditentukan dalam blok parameter ini dibagi di sepanjang batas packetLength untuk membentuk setiap paket transfer.

Recipient

Enum

"device"

"antarmuka"

"endpoint"

"lainnya"

RequestType

Enum

"standard"

"class"

"vendor"

"reserved"

SynchronizationType

Untuk mode interupsi dan isokronus, SynchronizationType dan UsageType dipetakan ke nama yang sama dalam spesifikasi USB.

Enum

"asynchronous"

"adaptive"

"synchronous"

TransferResultInfo

Properti

  • data

    ArrayBuffer opsional

    Data yang ditampilkan oleh transfer input. undefined untuk transfer output.

  • resultCode

    nomor opsional

    Nilai 0 menunjukkan bahwa transfer berhasil. Nilai lainnya menunjukkan kegagalan.

TransferType

Enum

"kontrol"

"interrupt"

"isokronus"

"bulk"

UsageType

Enum

"data"

"feedback"

"explicitFeedback"

"berkala"

"notification"

Metode

bulkTransfer()

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

Melakukan transfer massal di perangkat yang ditentukan.

Parameter

Hasil

  • Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

claimInterface()

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

Mengklaim antarmuka pada perangkat USB. Sebelum data dapat ditransfer ke antarmuka atau endpoint terkait, antarmuka harus diklaim. Hanya satu handle koneksi yang dapat mengklaim antarmuka pada waktu tertentu. Jika antarmuka sudah diklaim, panggilan ini akan gagal.

releaseInterface harus dipanggil saat antarmuka tidak lagi diperlukan.

Parameter

  • Koneksi terbuka ke perangkat.

  • interfaceNumber

    angka

    Antarmuka yang akan diklaim.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    () => void

Hasil

  • Promise<void>

    Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

closeDevice()

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

Menutup handle koneksi. Memanggil operasi pada handle setelah ditutup adalah operasi yang aman, tetapi tidak menyebabkan tindakan apa pun dilakukan.

Parameter

Hasil

  • Promise<void>

    Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

controlTransfer()

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

Melakukan transfer kontrol pada perangkat yang ditentukan.

Transfer kontrol mengacu pada perangkat, antarmuka, atau endpoint. Transfer ke antarmuka atau endpoint memerlukan klaim antarmuka.

Parameter

Hasil

  • Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

findDevices()

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

Menemukan perangkat USB yang ditentukan oleh ID vendor, produk, dan (opsional) antarmuka, lalu membukanya untuk digunakan jika izin mengizinkan.

Jika permintaan akses ditolak atau perangkat gagal dibuka, handle koneksi tidak akan dibuat atau ditampilkan.

Memanggil metode ini sama dengan memanggil getDevices yang diikuti dengan openDevice untuk setiap perangkat.

Parameter

Hasil

  • Promise<ConnectionHandle[]>

    Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

getConfiguration()

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

Mendapatkan deskriptor konfigurasi untuk konfigurasi yang saat ini dipilih.

Parameter

Hasil

  • Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

getConfigurations()

Promise Chrome 47+ 
chrome.usb.getConfigurations(
  device: Device,
  callback?: function,
): Promise<ConfigDescriptor[]>

Menampilkan set lengkap deskriptor konfigurasi perangkat.

Parameter

Hasil

  • Promise<ConfigDescriptor[]>

    Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

getDevices()

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

Mencantumkan perangkat USB yang terhubung.

Parameter

  • Properti yang akan ditelusuri di perangkat target.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (devices: Device[]) => void

Hasil

  • Promise<Device[]>

    Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

getUserSelectedDevices()

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

Menampilkan pemilih perangkat kepada pengguna dan menampilkan Device yang dipilih. Jika pengguna membatalkan pemilih, perangkat akan kosong. Gestur pengguna diperlukan agar dialog ditampilkan. Tanpa gestur pengguna, callback akan berjalan seolah-olah pengguna membatalkan.

Parameter

  • Konfigurasi kotak dialog pemilih perangkat.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (devices: Device[]) => void

Hasil

  • Promise<Device[]>

    Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

interruptTransfer()

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

Melakukan transfer interupsi pada perangkat yang ditentukan.

Parameter

Hasil

  • Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

isochronousTransfer()

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

Melakukan transfer isokronus pada perangkat tertentu.

Parameter

Hasil

  • Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

listInterfaces()

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

Mencantumkan semua antarmuka di perangkat USB.

Parameter

Hasil

  • Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

openDevice()

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

Membuka perangkat USB yang ditampilkan oleh getDevices.

Parameter

Hasil

  • Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

releaseInterface()

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

Melepaskan antarmuka yang diklaim.

Parameter

  • Koneksi terbuka ke perangkat.

  • interfaceNumber

    angka

    Antarmuka yang akan dilepaskan.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    () => void

Hasil

  • Promise<void>

    Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

requestAccess()

Promise Tidak digunakan lagi
chrome.usb.requestAccess(
  device: Device,
  interfaceId: number,
  callback?: function,
): Promise<boolean>

Fungsi ini khusus untuk ChromeOS dan memanggilnya di platform lain akan gagal. Operasi ini sekarang dilakukan secara implisit sebagai bagian dari openDevice dan fungsi ini akan menampilkan true di semua platform.

Meminta akses dari broker izin ke perangkat yang diklaim oleh Chrome OS jika antarmuka tertentu di perangkat tidak diklaim.

Parameter

  • perangkat

    Perangkat

    Device yang akan diminta aksesnya.

  • interfaceId

    angka

    Antarmuka tertentu yang diminta.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (success: boolean) => void

    • berhasil

      boolean

Hasil

  • Promise<boolean>

    Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

resetDevice()

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

Mencoba mereset perangkat USB. Jika reset gagal, handle koneksi yang diberikan akan ditutup dan perangkat USB akan tampak terputus lalu terhubung kembali. Dalam hal ini, getDevices atau findDevices harus dipanggil lagi untuk mendapatkan perangkat.

Parameter

  • Tuas koneksi yang akan direset.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (success: boolean) => void

    • berhasil

      boolean

Hasil

  • Promise<boolean>

    Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

setConfiguration()

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

Pilih konfigurasi perangkat.

Fungsi ini secara efektif mereset perangkat dengan memilih salah satu konfigurasi yang tersedia di perangkat. Hanya nilai konfigurasi yang lebih besar dari 0 yang valid, tetapi beberapa perangkat yang bermasalah memiliki konfigurasi 0 yang berfungsi, sehingga nilai ini diizinkan.

Parameter

  • Koneksi terbuka ke perangkat.

  • configurationValue

    angka

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    () => void

Hasil

  • Promise<void>

    Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

setInterfaceAlternateSetting()

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

Memilih setelan alternatif pada antarmuka yang sebelumnya diklaim.

Parameter

  • Koneksi terbuka ke perangkat tempat antarmuka ini telah diklaim.

  • interfaceNumber

    angka

    Antarmuka yang akan dikonfigurasi.

  • alternateSetting

    angka

    Setelan alternatif yang akan dikonfigurasi.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    () => void

Hasil

  • Promise<void>

    Chrome 116+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

Acara

onDeviceAdded

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

Peristiwa yang dihasilkan saat perangkat ditambahkan ke sistem. Peristiwa hanya disiarkan ke aplikasi dan ekstensi yang memiliki izin untuk mengakses perangkat. Izin mungkin telah diberikan pada saat penginstalan, saat pengguna menyetujui izin opsional (lihat permissions.request), atau melalui getUserSelectedDevices.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    (device: Device) => void

onDeviceRemoved

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

Peristiwa yang dihasilkan saat perangkat dihapus dari sistem. Lihat onDeviceAdded untuk mengetahui peristiwa mana yang dikirimkan.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    (device: Device) => void