Deskripsi
Menggunakan chrome.usb
API untuk berinteraksi dengan perangkat USB yang terhubung. API ini memberikan 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 menetapkan runtime.lastError
dan menjalankan callback reguler fungsi. Dalam kasus ini, parameter reguler callback tidak akan ditentukan.
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
Antarmuka yang tersedia.
-
maxPower
angka
Daya maksimum yang dibutuhkan perangkat ini dalam miliampe (mA).
-
remoteWakeup
boolean
Perangkat mendukung bangun jarak jauh.
-
selfPowered
boolean
Perangkat menyala sendiri.
ConnectionHandle
Properti
-
handle
angka
Tuas buram yang mewakili koneksi ini ke perangkat USB dan semua antarmuka terkait yang diklaim serta transfer yang tertunda. Nama sebutan channel baru akan dibuat setiap kali perangkat dibuka. Tuas koneksi berbeda dengan
Device.device
. -
productId
angka
ID produk.
-
vendorId
angka
ID vendor perangkat.
ControlTransferInfo
Properti
-
data
ArrayBuffer opsional
Data yang akan dikirim (hanya diperlukan oleh transfer output).
-
direction
Arah transfer (
"in"
atau"out"
). -
index
angka
Kolom
wIndex
, lihat Ibid. -
length
nomor opsional
Jumlah maksimum byte yang akan diterima (hanya diperlukan oleh transfer input).
-
penerima
Target transfer. Target yang diberikan oleh
index
harus diklaim jika"interface"
atau"endpoint"
. -
minta
angka
Kolom
bRequest
, lihat Revisi Spesifikasi Bus Serial Universal 1.1 § 9.3. -
requestType
Jenis permintaan.
-
timeout
nomor opsional
Chrome 43 dan yang lebih baruWaktu tunggu permintaan (dalam milidetik). Nilai default
0
menunjukkan tidak ada waktu tunggu. -
value
angka
Kolom
wValue
, lihat Ibid.
Device
Properti
-
perangkat
angka
ID buram untuk perangkat USB. Mode ini tetap tidak berubah hingga perangkat dicabut.
-
manufacturerName
string
Chrome 46+String iManufacturer 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, hanya diperiksa jika sub-class antarmuka cocok.
-
interfaceSubclass
nomor opsional
Subclass antarmuka USB, dicentang hanya 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
EndpointDescriptor
Properti
-
alamat
angka
Alamat endpoint.
-
direction
Arah transfer.
-
extra_data
ArrayBuffer
Data deskriptor tambahan yang terkait dengan endpoint ini.
-
maximumPacketSize
angka
Ukuran paket maksimum.
-
pollingInterval
nomor opsional
Interval polling (khusus interupsi dan isochronous).
-
sinkronisasi
SynchronizationType opsional
Mode sinkronisasi transfer (khusus isochronous).
-
tipe
Jenis transfer.
-
penggunaan
UsageType opsional
Petunjuk penggunaan endpoint.
EnumerateDevicesAndRequestAccessOptions
Properti
-
interfaceId
nomor opsional
ID antarmuka untuk meminta akses. Hanya tersedia di Chrome OS. Perubahan ini tidak berpengaruh pada platform lain.
-
productId
angka
ID produk.
-
vendorId
angka
ID vendor perangkat.
EnumerateDevicesOptions
Properti
-
filter
DeviceFilter[] opsional
Perangkat yang cocok dengan filter yang diberikan akan ditampilkan. Daftar filter kosong akan menampilkan semua perangkat yang izinnya dimiliki aplikasi.
-
productId
nomor opsional
Tidak digunakan lagiSetara dengan setelan
DeviceFilter.productId
. -
vendorId
nomor opsional
Tidak digunakan lagiSetara dengan setelan
DeviceFilter.vendorId
.
GenericTransferInfo
Properti
-
data
ArrayBuffer opsional
Data yang akan dikirim (hanya diperlukan oleh transfer output).
-
direction
Arah transfer (
"in"
atau"out"
). -
endpoint
angka
Alamat endpoint target. Antarmuka yang berisi endpoint ini harus diklaim.
-
length
nomor opsional
Jumlah maksimum byte yang akan diterima (hanya diperlukan oleh transfer input).
-
timeout
nomor opsional
Chrome 43 dan yang lebih baruWaktu tunggu permintaan (dalam milidetik). Nilai default
0
menunjukkan tidak ada waktu tunggu.
InterfaceDescriptor
Properti
-
alternateSetting
angka
Nomor setelan alternatif antarmuka (default-nya adalah
0
-
deskripsi
string opsional
Deskripsi antarmuka.
-
endpoint
Endpoint yang tersedia.
-
extra_data
ArrayBuffer
Data deskriptor tambahan yang dikaitkan dengan antarmuka ini.
-
interfaceClass
angka
Class antarmuka USB.
-
interfaceNumber
angka
Nomor antarmuka.
-
interfaceProtocol
angka
Protokol antarmuka USB.
-
interfaceSubclass
angka
Subclass antarmuka USB.
IsochronousTransferInfo
Properti
-
packetLength
angka
Panjang setiap paket dalam transfer ini.
-
paket
angka
Jumlah total paket dalam transfer ini.
-
transferInfo
Parameter transfer. Panjang transfer atau buffer data yang ditentukan dalam blok parameter ini dibagi di sepanjang batas
packetLength
untuk membentuk paket individual transfer.
Recipient
Enum
"endpoint"
RequestType
Enum
"class"
"vendor"
SynchronizationType
Untuk mode interupsi dan isokron, SynchronizationType dan UsageType dipetakan ke nama yang sama dalam spesifikasi USB.
Enum
TransferResultInfo
Properti
-
data
ArrayBuffer opsional
Data yang ditampilkan melalui transfer input.
undefined
untuk transfer output. -
resultCode
nomor opsional
Nilai
0
menunjukkan bahwa transfer berhasil. Nilai lain menunjukkan kegagalan.
TransferType
Enum
"control"
"isochronous"
"bulk"
UsageType
Enum
"data"
Metode
bulkTransfer()
chrome.usb.bulkTransfer(
handle: ConnectionHandle,
transferInfo: GenericTransferInfo,
callback?: function,
)
Melakukan transfer massal pada perangkat yang ditentukan.
Parameter
-
handle
Koneksi terbuka ke perangkat.
-
transferInfo
Parameter transfer.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(info: TransferResultInfo) => void
-
info
-
Hasil
-
Promise<TransferResultInfo>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
claimInterface()
chrome.usb.claimInterface(
handle: ConnectionHandle,
interfaceNumber: number,
callback?: function,
)
Mengklaim antarmuka di perangkat USB. Sebelum data dapat ditransfer ke antarmuka atau endpoint terkait, antarmuka harus diklaim. Hanya satu handle koneksi yang dapat mengklaim antarmuka pada satu waktu. Jika antarmuka sudah diklaim, panggilan ini akan gagal.
releaseInterface
harus dipanggil saat antarmuka tidak lagi diperlukan.
Parameter
-
handle
Koneksi terbuka ke perangkat.
-
interfaceNumber
angka
Antarmuka yang akan diklaim.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
Hasil
-
Promise<void>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
closeDevice()
chrome.usb.closeDevice(
handle: ConnectionHandle,
callback?: function,
)
Menutup tuas koneksi. Memanggil operasi pada tuas setelah ditutup adalah operasi yang aman, tetapi tidak menyebabkan tindakan apa pun yang perlu dilakukan.
Parameter
-
handle
ConnectionHandle
yang akan ditutup. -
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
Hasil
-
Promise<void>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
controlTransfer()
chrome.usb.controlTransfer(
handle: ConnectionHandle,
transferInfo: ControlTransferInfo,
callback?: function,
)
Melakukan transfer kontrol pada perangkat yang ditentukan.
Transfer kontrol mengacu pada perangkat, antarmuka, atau endpoint. Transfer ke antarmuka atau endpoint mengharuskan antarmuka untuk diklaim.
Parameter
-
handle
Koneksi terbuka ke perangkat.
-
transferInfo
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(info: TransferResultInfo) => void
-
info
-
Hasil
-
Promise<TransferResultInfo>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
findDevices()
chrome.usb.findDevices(
options: EnumerateDevicesAndRequestAccessOptions,
callback?: function,
)
Menemukan perangkat USB yang ditentukan oleh vendor, produk, dan ID antarmuka (opsional) dan jika izin memungkinkan membuka untuk digunakan.
Jika permintaan akses ditolak atau perangkat gagal dibuka, handle koneksi tidak akan dibuat atau ditampilkan.
Memanggil metode ini sama dengan memanggil getDevices
diikuti dengan openDevice
untuk setiap perangkat.
Parameter
-
Properti yang akan ditelusuri di perangkat target.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(handles: ConnectionHandle[]) => void
-
akun
-
Hasil
-
Promise<ConnectionHandle[]>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
getConfiguration()
chrome.usb.getConfiguration(
handle: ConnectionHandle,
callback?: function,
)
Mendapatkan deskriptor konfigurasi untuk konfigurasi yang saat ini dipilih.
Parameter
-
handle
Koneksi terbuka ke perangkat.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(config: ConfigDescriptor) => void
-
config
-
Hasil
-
Promise<ConfigDescriptor>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
getConfigurations()
chrome.usb.getConfigurations(
device: Device,
callback?: function,
)
Menampilkan kumpulan lengkap deskriptor konfigurasi perangkat.
Parameter
-
perangkat
Device
untuk mengambil deskripsi. -
callback
fungsi opsional
Parameter
callback
terlihat seperti:(configs: ConfigDescriptor[]) => void
-
konfigurasi
-
Hasil
-
Promise<ConfigDescriptor[]>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
getDevices()
chrome.usb.getDevices(
options: EnumerateDevicesOptions,
callback?: function,
)
Menghitung perangkat USB yang terhubung.
Parameter
-
Properti yang akan ditelusuri di perangkat target.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(devices: Device[]) => void
-
perangkat
-
Hasil
-
Promise<Perangkat[]>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
getUserSelectedDevices()
chrome.usb.getUserSelectedDevices(
options: DevicePromptOptions,
callback?: function,
)
Menampilkan pemilih perangkat kepada pengguna dan menampilkan Device
yang dipilih. Jika pengguna membatalkan, perangkat pemilih akan kosong. Gestur pengguna diperlukan agar dialog ditampilkan. Tanpa gestur pengguna, callback akan berjalan seolah-olah pengguna membatalkan.
Parameter
-
opsi
Konfigurasi kotak dialog pemilih perangkat.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(devices: Device[]) => void
-
perangkat
-
Hasil
-
Promise<Perangkat[]>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
interruptTransfer()
chrome.usb.interruptTransfer(
handle: ConnectionHandle,
transferInfo: GenericTransferInfo,
callback?: function,
)
Melakukan transfer interupsi pada perangkat yang ditentukan.
Parameter
-
handle
Koneksi terbuka ke perangkat.
-
transferInfo
Parameter transfer.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(info: TransferResultInfo) => void
-
info
-
Hasil
-
Promise<TransferResultInfo>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
isochronousTransfer()
chrome.usb.isochronousTransfer(
handle: ConnectionHandle,
transferInfo: IsochronousTransferInfo,
callback?: function,
)
Melakukan transfer isochronous pada perangkat tertentu.
Parameter
-
handle
Koneksi terbuka ke perangkat.
-
transferInfo
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(info: TransferResultInfo) => void
-
info
-
Hasil
-
Promise<TransferResultInfo>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
listInterfaces()
chrome.usb.listInterfaces(
handle: ConnectionHandle,
callback?: function,
)
Mencantumkan semua antarmuka di perangkat USB.
Parameter
-
handle
Koneksi terbuka ke perangkat.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(descriptors: InterfaceDescriptor[]) => void
-
descriptors
-
Hasil
-
Promise<InterfaceDescriptor[]>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
openDevice()
chrome.usb.openDevice(
device: Device,
callback?: function,
)
Membuka perangkat USB yang ditampilkan oleh getDevices
.
Parameter
-
perangkat
Device
yang akan dibuka. -
callback
fungsi opsional
Parameter
callback
terlihat seperti:(handle: ConnectionHandle) => void
-
handle
-
Hasil
-
Promise<ConnectionHandle>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
releaseInterface()
chrome.usb.releaseInterface(
handle: ConnectionHandle,
interfaceNumber: number,
callback?: function,
)
Merilis antarmuka yang diklaim.
Parameter
-
handle
Koneksi terbuka ke perangkat.
-
interfaceNumber
angka
Antarmuka yang akan dirilis.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
Hasil
-
Promise<void>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
requestAccess()
chrome.usb.requestAccess(
device: Device,
interfaceId: number,
callback?: function,
)
Fungsi ini khusus ChromeOS dan memanggilnya di platform lain akan gagal. Sekarang operasi ini secara implisit dilakukan sebagai bagian dari openDevice
dan fungsi ini akan menampilkan true
di semua platform.
Meminta akses dari perantara izin ke perangkat yang diklaim oleh Chrome OS jika antarmuka yang ditentukan pada perangkat tidak diklaim.
Parameter
-
perangkat
Device
yang aksesnya akan diminta. -
interfaceId
angka
Antarmuka khusus yang diminta.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(success: boolean) => void
-
berhasil
boolean
-
Hasil
-
Promise<boolean>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
resetDevice()
chrome.usb.resetDevice(
handle: ConnectionHandle,
callback?: function,
)
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
-
handle
Tuas koneksi untuk direset.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(success: boolean) => void
-
berhasil
boolean
-
Hasil
-
Promise<boolean>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
setConfiguration()
chrome.usb.setConfiguration(
handle: ConnectionHandle,
configurationValue: number,
callback?: function,
)
Pilih konfigurasi perangkat.
Fungsi ini menyetel ulang perangkat secara efektif dengan memilih salah satu konfigurasi perangkat yang tersedia. Hanya nilai konfigurasi yang lebih besar dari 0
yang valid, tetapi beberapa perangkat yang berisi bug memiliki konfigurasi 0
yang berfungsi dengan baik, sehingga nilai ini diizinkan.
Parameter
-
handle
Koneksi terbuka ke perangkat.
-
configurationValue
angka
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
Hasil
-
Promise<void>
Chrome 116 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
setInterfaceAlternateSetting()
chrome.usb.setInterfaceAlternateSetting(
handle: ConnectionHandle,
interfaceNumber: number,
alternateSetting: number,
callback?: function,
)
Memilih setelan alternatif pada antarmuka yang telah diklaim sebelumnya.
Parameter
-
handle
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 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
Peristiwa
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 waktu penginstalan, saat pengguna menerima izin opsional (lihat permissions.request
), atau melalui getUserSelectedDevices
.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(device: Device) => void
-
perangkat
-
onDeviceRemoved
chrome.usb.onDeviceRemoved.addListener(
callback: function,
)
Peristiwa yang dihasilkan saat perangkat dihapus dari sistem. Lihat onDeviceAdded
untuk mengetahui peristiwa mana yang ditayangkan.