WebUSB | Frontend Practical Guide

Limited support 一部のブラウザのみ対応。使用時はサポート状況を確認すること。

対応ブラウザ

機能	デスクトップ				モバイル
機能	Chrome	Edge	Firefox	Safari	Chrome Android	Safari iOS
`USB` 実験的	61	79			61
`usb` usb は Navigator インターフェイスの読み取り専用プロパティで、現在の文書内の USBオブジェクトを返し、WebUSB API の機能へのアクセスを提供します。	61	79			61
`connect_event` 実験的 USB インターフェイスの connect イベントは、ペア設定済みのデバイスが接続された時発火します。	61	79			61
`disconnect_event` 実験的 USB インターフェイスの disconnect イベントは、ペア設定済みのデバイスが切断された時発火します。	61	79			61
`getDevices` 実験的 USB インターフェイスの getDevices メソッドは、接続されたペア設定済みのデバイスを表す USBDevice の配列で解決する Promise を返します｡デバイスのペア設定については、USB.requestDevice() を参照してください。	61	79			61
`requestDevice` 実験的 USB インターフェイスの requestDevice() メソッドは、指定のデバイスが見つかった場合は USBDevice のインスタンスで解決する Promise を返します｡このメソッドを呼ぶと､ユーザーエージェントのペア設定手続きを開始します｡	61	79			61
`worker_support` 実験的労働者で利用可能	118	118			118
`USBAlternateInterface` 実験的 WebUSB API の USBAlternateInterface インターフェイスは、USB デバイスが提供するインターフェイスの特定のコンフィギュレーションの情報を提供します。インターフェイスには 1 個以上のオルタネイト設定があり、これらによりデバイスの動作モードに基づくエンドポイント一式の設定ができます。	61	79			61
`alternateSetting` 実験的	61	79			61
`endpoints` 実験的	61	79			61
`interfaceClass` 実験的	61	79			61
`interfaceName` 実験的	61	79			61
`interfaceProtocol` 実験的	61	79			61
`interfaceSubclass` 実験的	61	79			61
`USBAlternateInterface` 実験的 USBAlternateInterface()`コンストラクタ	61	79			61
`worker_support` 実験的労働者で利用可能	118	118			118
`USBConfiguration` 実験的 WebUSB API の USBConfiguration インターフェイスは、USB デバイスの特定のコンフィギュレーションおよびそれがサポートするインターフェイスの情報を提供します。	61	79			61
`configurationName` 実験的 USBConfiguration インターフェイスの読み取り専用プロパティ configurationName は、デバイスによって提供されたこのコンフィギュレーションを説明する名前を返します。これはこのコンフィギュレーションを定義しているコンフィギュレーションディスクリプターの iConfiguration フィールドで提供されるインデックスのストリングディスクリプターの値と一致します。	61	79			61
`configurationValue` 実験的 USBConfiguration インターフェイスの読み取り専用プロパティ configurationValue は、このコンフィギュレーションのコンフィギュレーション番号を返します。これはデバイスによって提供されたこのコンフィギュレーションを定義しているコンフィギュレーションディスクリプターの bConfigurationValue フィールドと一致します。	61	79			61
`interfaces` 実験的 USBConfiguration インターフェイスの読み取り専用プロパティ interfaces は、このコンフィギュレーションが対応しているそれぞれのインターフェイスを表す USBInterface のインスタンスが格納された配列を返します。	61	79			61
`USBConfiguration` 実験的 USBConfiguration() コンストラクターは、渡された USBDevice の指定のコンフィギュレーション番号のコンフィギュレーションの情報が格納された新しい USBConfiguration オブジェクトを生成します。	61	79			61
`worker_support` 実験的労働者で利用可能	118	118			118
`USBConnectionEvent` 実験的 WebUSB API の USBConnectionEvent は、ユーザーエージェントが新しい USB デバイスの接続や切断を検出したとき、USB.connectevent および USB.disconnectevent に渡されるイベント型です。	61	79			61
`device` 実験的 USBConnectionEvent インターフェイスの読み取り専用プロパティ device は、接続中または切断中のデバイスを表す USBDevice オブジェクトを返します。	61	79			61
`USBConnectionEvent` 実験的 USBConnectionEvent() コンストラクターは、新しい USBConnectionEvent オブジェクトを生成します。このコンストラクターは通常使われず、このオブジェクトは USB デバイスの接続や切断に伴ってブラウザーが生成します。	61	79			61
`worker_support` 実験的労働者で利用可能	118	118			118
`USBDevice` 実験的 WebUSB API の USBDevice インターフェイスは、ペアリングした USB デバイスのメタデータへのアクセスと、デバイスの制御用のメソッドを提供します。	61	79			61
`claimInterface` 実験的 USBDevice インターフェイスの claimInterface() メソッドは、要求したインターフェイスの排他アクセスを獲得したら解決する Promise を返します。	61	79			61
`clearHalt` 実験的 USBDevice インターフェイスの clearHalt() メソッドは、停止状態のクリアが完了したら解決する Promise を返します。停止状態はデバイスへ、またはデバイスからのデータ転送が 'stall' 状態であるときであり、ウェブページ (USB の用語ではホストシステム) がこの状態をクリアする必要があります。詳細を参照してください。	61	79			61
`close` 実験的 USBDevice インターフェイスの close() メソッドは、すべての開いているインターフェイスが解放され、デバイスのセッションが終了したら解決する Promise を返します。	61	79			61
`configuration` 実験的 USBDevice インターフェイスの読み取り専用プロパティ configuration は、ペアリングした USB デバイスの現在選択されているインターフェイスを表す USBConfiguration オブジェクトを返します。	61	79			61
`configurations` 実験的 USBDevice インターフェイスの読み取り専用プロパティ configurations は、ペアリングした USB デバイスの制御用のデバイス固有のインターフェイスの array を返します。	61	79			61
`controlTransferIn` 実験的 USBDevice インターフェイスの controlTransferIn() メソッドは、コマンドまたは状態の操作の要求の USB デバイスへの送信 (USB デバイスでの受信) が完了したら USBInTransferResult で解決する Promise を返します。	61	79			61
`controlTransferOut` 実験的 USBDevice インターフェイスの controlTransferOut() メソッドは、コマンドまたは状態の操作の USB デバイスからの転送が完了したら USBOutTransferResult で解決する Promise を返します。	61	79			61
`deviceClass` 実験的 USBDevice インターフェイスの読み取り専用プロパティ deviceClass は、デバイスとともに動く USB ドライバーのロード用に USB デバイスを特定する 3 個のプロパティのうちの 1 個です。他の 2 個のプロパティは USBDevice.deviceSubclass と USBDevice.deviceProtocol です。	61	79			61
`deviceProtocol` 実験的 USBDevice インターフェイスの読み取り専用プロパティ deviceProtocol は、デバイスとともに動く USB ドライバーのロード用に USB デバイスを特定する 3 個のプロパティのうちの 1 個です。他の 2 個のプロパティは USBDevice.deviceClass と USBDevice.deviceSubclass です。	61	79			61
`deviceSubclass` 実験的 USBDevice インターフェイスの読み取り専用プロパティ deviceSubclass は、デバイスとともに動く USB ドライバーのロード用に USB デバイスを特定する 3 個のプロパティのうちの 1 個です。他の 2 個のプロパティは USBDevice.deviceClass と USBDevice.deviceProtocol です。	61	79			61
`deviceVersionMajor` 実験的 USBDevice インターフェイスの読み取り専用プロパティ deviceVersionMajor は、セマンティックバージョニングスキームによるデバイスのメジャーバージョン番号です。	61	79			61
`deviceVersionMinor` 実験的 USBDevice インターフェイスの読み取り専用プロパティ deviceVersionMinor は、セマンティックバージョニングスキームによるデバイスのマイナーバージョン番号です。	61	79			61
`deviceVersionSubminor` 実験的 USBDevice インターフェイスの読み取り専用プロパティ deviceVersionSubminor は、セマンティックバージョニングスキームによるデバイスのパッチバージョン番号です。	61	79			61
`forget` 実験的 USBDevice インターフェイスの forget() メソッドは、すべての実行中の操作が中止され、すべての開いているインターフェイスが解放され、デバイスのセッションが終了し、許可をリセットしたら解決する Promise を返します。	101	101			101
`isochronousTransferIn` 実験的 USBDevice インターフェイスの isochronousTransferIn() メソッドは、時間が重要な情報の USB デバイスへの送信 (USB デバイスによる受信) が完了したら USBIsochronousInTransferResult で解決する Promise を返します。	61	79			61
`isochronousTransferOut` 実験的 USBDevice インターフェイスの isochronousTransferOut() メソッドは、時間が重要な情報の USB デバイスからの転送が完了したら USBIsochronousOutTransferResult で解決する Promise を返します。	61	79			61
`manufacturerName` 実験的 USBDevice インターフェイスの読み取り専用プロパティ manufacturerName は、この USB デバイスを製造した組織の名前です。	61	79			61
`open` 実験的 USBDevice インターフェイスの open() メソッドは、デバイスのセッションが開始したら解決する Promise を返します。	61	79			61
`opened` 実験的 USBDevice インターフェイスの読み取り専用プロパティ opened は、ペアリングした USB デバイスとのセッションが開始しているかを表します。デバイスは、ウェブページから制御する前に開かれなければなりません。	61	79			61
`productId` 実験的 USBDevice インターフェイスの読み取り専用プロパティ productId は、製造元が定義する、USB デバイスを識別するコードです。	61	79			61
`productName` 実験的 USBDevice インターフェイスの読み取り専用プロパティ productName は、製造元が定義する、USB デバイスを識別する名前です。	61	79			61
`releaseInterface` 実験的 USBDevice インターフェイスの releaseInterface() メソッドは、要求済みのインターフェイスが排他アクセスから解放されたら解決する Promise を返します。	61	79			61
`reset` 実験的 USBDevice インターフェイスの reset() メソッドは、デバイスがリセットされ、アプリケーションによる操作がすべてキャンセルされ、それらのプロミスが拒否されたら解決する Promise を返します。	61	79			61
`selectAlternateInterface` 実験的 USBDevice インターフェイスの selectAlternateInterface() メソッドは、指定のオルタナティブエンドポイントが選択されたら解決する Promise を返します。	61	79			61
`selectConfiguration` 実験的 USBDevice インターフェイスの selectConfiguration() メソッドは、指定のコンフィギュレーションが選択されたら解決する Promise を返します。	61	79			61
`serialNumber` 実験的 USBDevice インターフェイスの読み取り専用プロパティ serialNumber は、製造元が定義する、特定の USB デバイスのシリアル番号です。	61	79			61
`transferIn` 実験的 USBDevice インターフェイスの transferIn() メソッドは、USB デバイスからバルクまたはインタラプトデータを受信したら USBInTransferResult で解決する Promise を返します。	61	79			61
`transferOut` 実験的 USBDevice インターフェイスの transferOut() メソッドは、USB デバイスにバルクまたはインタラプトデータを送信したら USBOutTransferResult で解決する Promise を返します。	61	79			61
`usbVersionMajor` 実験的 USBDevice インターフェイスの読み取り専用プロパティ usbVersionMajor は、デバイスが対応している USB のプロトコルバージョンを表す 3 個のプロパティのうちの 1個です。他の 2 個のプロパティは USBDevice.usbVersionMinor と USBDevice.usbVersionSubminor です。	61	79			61
`usbVersionMinor` 実験的 USBDevice インターフェイスの読み取り専用プロパティ usbVersionMinor は、デバイスが対応している USB のプロトコルバージョンを表す 3 個のプロパティのうちの 1個です。他の 2 個のプロパティは USBDevice.usbVersionMajor と USBDevice.usbVersionSubminor です。	61	79			61
`usbVersionSubminor` 実験的 USBDevice インターフェイスの読み取り専用プロパティ usbVersionSubminor は、デバイスが対応している USB のプロトコルバージョンを表す 3 個のプロパティのうちの 1個です。他の 2 個のプロパティは USBDevice.usbVersionMajor と USBDevice.usbVersionMinor です。	61	79			61
`vendorId` 実験的 USBDevice インターフェイスの読み取り専用プロパティ vendorId は、usb.org で割り当てられた公式なベンダー ID です。	61	79			61
`worker_support` 実験的労働者で利用可能	118	118			118
`USBEndpoint` 実験的 WebUSB API の USBEndpoint インターフェイスは、USB デバイスが提供するエンドポイントの情報を提供します。エンドポイントは、デバイスに送信またはデバイスから受信する単方向のデータストリームを表します。	61	79			61
`direction` 実験的	61	79			61
`endpointNumber` 実験的	61	79			61
`packetSize` 実験的	61	79			61
`type` 実験的	61	79			61
`USBEndpoint` 実験的 USBEndpoint()` コンストラクタ	61	79			61
`worker_support` 実験的労働者で利用可能	118	118			118
`USBInterface` 実験的 WebUSB API の USBInterface インターフェイスは、USB デバイスが提供するインターフェイスの情報を提供します。インターフェイスは、デバイスの機能を表し、特定のプロトコルを実装し、双方向通信用のエンドポイントを含むことができます。	61	79			61
`alternate` 実験的	61	79			61
`alternates` 実験的	61	79			61
`claimed` 実験的	61	79			61
`interfaceNumber` 実験的	61	79			61
`USBInterface` 実験的 USBInterface()`コンストラクタ	61	79			61
`worker_support` 実験的労働者で利用可能	118	118			118
`USBInTransferResult` 実験的 WebUSB API の USBInTransferResult インターフェイスは、USBDevice インターフェイスの transferIn() および controlTransferIn() メソッドを呼び出した結果を提供します。これは、USB デバイスから USB ホストへのデータ転送の要求の結果を表します。	61	79			61
`data` 実験的	61	79			61
`status` 実験的	61	79			61
`USBInTransferResult` 実験的 USBInTransferResult()`コンストラクタ	61	79			61
`worker_support` 実験的労働者で利用可能	118	118			118
`USBIsochronousInTransferPacket` 実験的 WebUSB API の USBIsochronousInTransferPacket インターフェイスは、USBDevice インターフェイスの isochronousTransferIn() メソッドの呼び出しに対する応答の一部です。これは、アイソクロナスエンドポイントによる USB デバイスから USB ホストへのデータ転送の要求における個別のパケットの状態を表します。	61	79			61
`data` 実験的	61	79			61
`status` 実験的	61	79			61
`USBIsochronousInTransferPacket` 実験的 USBIsochronousInTransferPacket()`コンストラクタ	61	79			61
`worker_support` 実験的労働者で利用可能	118	118			118
`USBIsochronousInTransferResult` 実験的 WebUSB API の USBIsochronousInTransferResult インターフェイスは、USBDevice インターフェイスの isochronousTransferIn() メソッドを呼び出した結果を提供します。これは、USB デバイスから USB ホストへのデータ転送の要求の結果を表します。	61	79			61
`data` 実験的	61	79			61
`packets` 実験的	61	79			61
`USBIsochronousInTransferResult` 実験的 USBIsochronousInTransferResult()` コンストラクタ	61	79			61
`worker_support` 実験的労働者で利用可能	118	118			118
`USBIsochronousOutTransferPacket` 実験的 WebUSB API の USBIsochronousOutTransferPacket インターフェイスは、USBDevice インターフェイスの isochronousTransferOut() メソッドの呼び出しに対する応答の一部です。これは、アイソクロナスエンドポイントによる USB ホストから USB デバイスへのデータ転送の要求における個別のパケットの状態を表します。	61	79			61
`bytesWritten` 実験的	61	79			61
`status` 実験的	61	79			61
`USBIsochronousOutTransferPacket` 実験的 USBIsochronousOutTransferPacket()` コンストラクタ	61	79			61
`worker_support` 実験的労働者で利用可能	118	118			118
`USBIsochronousOutTransferResult` 実験的 WebUSB API の USBIsochronousOutTransferResult インターフェイスは、USBDevice インターフェイスの isochronousTransferOut() メソッドの呼び出しの結果を提供します。これは、USB ホストから USB デバイスへのデータ転送の要求の結果を表します。	61	79			61
`packets` 実験的	61	79			61
`USBIsochronousOutTransferResult` 実験的 USBIsochronousOutTransferResult()` コンストラクタ	61	79			61
`worker_support` 実験的労働者で利用可能	118	118			118
`USBOutTransferResult` 実験的 WebUSB API の USBOutTransferResult インターフェイスは、USBDevice インターフェイスの transferOut() および controlTransferOut() メソッドを呼び出した結果を提供します。これは、USB ホストから USB デバイスへのデータ転送の要求の結果を表します。	61	79			61
`bytesWritten` 実験的	61	79			61
`status` 実験的	61	79			61
`USBOutTransferResult` 実験的 USBOutTransferResult()`コンストラクタ	61	79			61
`worker_support` 実験的労働者で利用可能	118	118			118
`usb` WorkerNavigator インターフェイスの読み取り専用プロパティ usb は、現在の文書用の USB オブジェクトを返し、WebUSB API の機能へのアクセスを可能にします。	118	118			118
その他
`html.elements.iframe.allow.usb` 実験的	60	79			60
`http.headers.Permissions-Policy.usb` 実験的 HTTP の Permissions-Policy ヘッダーにおける usb ディレクティブは、現在の文書が WebUSB API を使用できるかどうかを制御します。	88	88			88

1+対応 (バージョン) 未対応 ※注釈ありサブ機能の解説は MDN Web Docs (CC BY-SA 2.5)

基本構文

JAVASCRIPT

const device = await navigator.usb.requestDevice({
  filters: [{ vendorId: 0x1234 }]
});
await device.open();
await device.selectConfiguration(1);
await device.claimInterface(0);

実務での使いどころ

WebUSB の活用

安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。

注意点

一部のブラウザでのみ対応。使用前にブラウザサポートを確認すること。

対応ブラウザ

基本構文

実務での使いどころ

WebUSB の活用

注意点

アクセシビリティ

参考リンク