SerialPort.open()
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。
SerialPort
インターフェイスの open()
メソッドは、ポートを開く処理が完了したら解決する Promise
を返します。デフォルトでは、ポートは 8 ビットのデータ、1 ビットのストップビット、パリティチェックなしで開かれます。パラメータ baudRate
は必須です。
構文
js
open(options)
引数
options
-
以下の値のうち任意のものが入ったオブジェクトです。
baudRate
-
シリアル通信を確立するボーレートを表す正の値です。
bufferSize
省略可-
確保する送信用と受信用のバッファーのサイズを表す
unsigned long
の整数です。指定されない場合のデフォルト値は 255 です。 dataBits
省略可-
1 フレームのデータビット数を表す、7 または 8 の整数です。指定されない場合のデフォルト値は 8 です。
flowControl
省略可-
"none"
または"hardware"
のいずれかで、フロー制御の種類を表します。デフォルト値は"none"
です。 parity
省略可-
"none"
,"even"
,"odd"
のいずれかで、パリティの種類を表します。デフォルト値は"none"
です。 stopBits
省略可-
フレームの最後のストップビットの数を表す、1 または 2の整数です。指定されない場合のデフォルト値は 1 です。
返値
Promise
を返します。
例外
InvalidStateError
DOMException
-
ポートが既に開かれているとき、返されます。
NetworkError
DOMException
-
ポートを開くのに失敗したとき、返されます。
例
シリアルポートで通信を行う前に、ポートを開く必要があります。ポートを開くことで、サイトはデータがどのように送受信されるかを決めるために必要なパラメータを設定できます。開発者は、適切なパラメータを決めるために接続するデバイスのドキュメントを参照するべきです。
js
await port.open({ baudRate: 9600 /* ボーレートを決める */ });
仕様書
Specification |
---|
Web Serial API # dom-serialport-open |
ブラウザーの互換性
BCD tables only load in the browser