SerialPort: connect イベント

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

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

SerialPort インターフェイスの connect イベントは、ポートがデバイスに接続された時、発火します。このイベントは、USB で接続されたデバイスなどの取り外し可能なデバイスに関連付いたポートに関してのみ発火します。

このイベントは、このインターフェイスを返した Serial のインスタンスに伝搬します。

構文

addEventListener() のようなメソッドでイベント名を用いるか、イベントハンドラープロパティを設定します。

js
addEventListener("connect", (event) => {});

onconnect = (event) => {};

汎用の Event です。

バブリング

このイベントは Serial に伝搬します。event.target プロパティはイベントを発生させた SerialPort オブジェクトを指します。

詳しくは、イベントのバブリングとキャプチャリングを参照してください。

特定のポートが接続された時通知する

Serial.requestPort() メソッドは、ユーザーが選択した SerialPort で解決する Promise を返します。

js
// ユーザーにシリアルポートを選んでもらう
const port = await navigator.serial.requestPort();

port.addEventListener("connect", (event) => {
  // 選択されたポートが接続されたら通知する
});

新しく接続された任意のポートを監視する

connect イベントは Serial オブジェクトに伝搬し、ここで新しく接続された任意のポートを監視することができます。

js
navigator.serial.addEventListener("connect", (event) => {
  // 新しいポートが利用可能になったら通知する
  // 新しいポートを参照するには、`event.target` を使う
});

仕様書

Specification
Web Serial API
# dfn-connect
Web Serial API
# dom-serialport-onconnect

ブラウザーの互換性

BCD tables only load in the browser

関連情報