Web Serial API

requestPort()メソッドの手順は以下のとおりです：

1. promiseを新しいpromiseとして作成する。
2. thisの 関連グローバルオブジェクトに 関連付けられたDocumentが 使用許可のある "serial" ポリシー制御機能でない場合、 reject promiseに"SecurityError" DOMExceptionで返し、終了。
3. 関連グローバルオブジェクトが thisに トランジェントアクティベーションがなければ、reject promiseに "SecurityError" DOMExceptionで返し、終了。
4. もしoptions["filters"]が存在する場合、すべてのfilterについて以下を実行する:
   1. もしfilter["bluetoothServiceClassId"] が存在する場合:
      1. filter["usbVendorId"] が存在する場合、 reject promiseにTypeErrorで返し、終了。
      2. filter["usbProductId"] が存在する場合、 reject promiseにTypeErrorで返し、終了。
   2. もしfilter["usbVendorId"]が存在しない場合、 reject promiseにTypeErrorで返し、終了。
      注

      このチェックはSerialPortFilterが空であることはできず、 usbProductIdを指定する場合は usbVendorIdも指定する必要があるという組み合わせルールを実装しています。
5. 並列で以下を実行：
   1. allPortsを空のリストとして用意する。
   2. システムに登録済みBluetoothデバイスについて各デバイスに対し：
      1. デバイスがサポートする BluetoothServiceUUID uuidごとに：
         1. uuidがブロックされたBluetoothサービスクラスUUIDでない場合：
            • uuidが Serial Port Profile service class IDと等しい場合、または
            • options["allowedBluetoothServiceClassIds"] が存在し、そのリストにuuidが含まれている場合：
              1. portを該当サービスを示すSerialPortとして生成。
              2. それをallPortsに追加する。
   3. 各 利用可能な非Bluetoothシリアルポートについて：
      1. portを該当ポートを表すSerialPortとして生成。
      2. それをallPortsに追加。
   4. ユーザーへ、allPortsリストのうちoptions["filters"]のいずれかのフィルターに マッチするもののみ（あるいはフィルターがなければすべて）を選ばせるプロンプトを表示する。
   5. ユーザーがポートを選択しなかった場合は、グローバルタスクをキューし、関連グローバルオブジェクトのserial port task sourceで reject promiseに "NotFoundError" DOMException で返し、以降中断。
   6. ユーザーが選んだポートを示すportを SerialPortとして用意。
   7. グローバルタスクをキューし、 関連グローバルオブジェクトのserial port task sourceで resolve promiseにportを渡す。
6. promise を返す。

シリアルポートは、利用可能とは、有線の場合は物理的にシステムに接続されているポート、無線の場合はデバイスがシステムに登録されているポートを指します。

WebIDLdictionary SerialPortRequestOptions {
  sequence<SerialPortFilter> filters;
  sequence<BluetoothServiceUUID> allowedBluetoothServiceClassIds;
};

WebIDLdictionary SerialPortFilter {
  unsigned short usbVendorId;
  unsigned short usbProductId;
  BluetoothServiceUUID bluetoothServiceClassId;
};

getPorts()メソッドの手順は以下の通りです：

1. promiseを新しいpromiseとして作成する。
2. thisの 関連グローバルオブジェクトに 関連付けられたDocumentが 使用許可のある "serial"というポリシー制御機能でない場合、 reject promiseに"SecurityError" DOMExceptionで返し、終了。
3. 並列で以下を実行：
   1. availablePortsを、ユーザーがrequestPort()の実行でサイトにアクセス許可を付与した利用可能なシリアルポートとする。
   2. portsを、availablePorts内のSerialPort一覧とする。
   3. グローバルタスクをキューし、関連グローバルオブジェクトのserial port task sourceで resolve promiseにportsを渡す。
4. promise を返す。

ユーザーがrequestPort()の呼び出しでサイトへのアクセスを許可したシリアルポートが 論理的に接続された場合、以下の手順を実行します：

1. portとして該当のSerialPortを用意する。
2. port.[[connected]]をtrueに設定。
3. イベント名connectをportで発火し、そのbubbles属性をtrueで初期化する。

シリアルポートは論理的に接続とは、有線シリアルポートの場合は物理的に接続されているとき、無線の場合はシステムが該当デバイスにアクティブ接続（例: Bluetooth L2CAPチャネルが開いている）を持っているときです。

ユーザーがrequestPort()の呼び出しでサイトへのアクセスを許可したシリアルポートが 論理的に接続でなくなった場合、以下の手順を実行します：

1. portとして該当のSerialPortを用意する。
2. port.[[connected]]をfalseに設定。
3. イベント名disconnectをportで発火し、そのbubbles属性をtrueで初期化する。

1. infoを空の順序付きマップとして用意する。
2. ポートがUSBデバイスの一部の場合、以下の手順を実施する：
   1. info["usbVendorId"] にデバイスのベンダーIDを設定。
   2. info["usbProductId"] にデバイスのプロダクトIDを設定。
3. ポートがBluetoothデバイス上のサービスである場合、以下の手順を実施する：
   1. info["bluetoothServiceClassId"] にBluetoothサービスのサービスクラスUUIDを設定
4. infoを返す。

WebIDLdictionary SerialPortInfo {
  unsigned short usbVendorId;
  unsigned short usbProductId;
  BluetoothServiceUUID bluetoothServiceClassId;
};

open() メソッドの手順は以下の通りです：

1. promise を 新しい promise として用意する。
2. もし this.[[state]] が "closed" 以外なら、 promise を "InvalidStateError" DOMException で reject し返す。
3. もし options["dataBits"] が 7 または 8 でなければ、 promise を TypeError で reject し返す。
4. もし options["stopBits"] が 1 または 2 でなければ、 promise を TypeError で reject し返す。
5. もし options["bufferSize"] が 0 なら、 promise を TypeError で reject し返す。
6. また、options["bufferSize"] が 実装がサポートできる値より大きい場合も、 promise を TypeError で reject し返すことができる。
7. this.[[state]] を "opening" に設定する。
8. 並列で以下を実施：
   1. オペレーティングシステムに指示して、options で指定された（またはデフォルト値）接続パラメータで シリアルポートを開く。
   2. 何らかの理由で失敗した場合、グローバルタスクをキューし、 関連グローバルオブジェクト の serial port task source で reject promise を "NetworkError" DOMException で返して、処理を中断する。
   3. this.[[state]] を "opened" に設定する。
   4. this.[[bufferSize]] を options["bufferSize"] に設定する。
   5. グローバルタスクをキューし、 関連グローバルオブジェクト の serial port task source で resolve promise を undefined にする。
9. promise を返す。

WebIDLdictionary SerialOptions {
  [EnforceRange] required unsigned long baudRate;
  [EnforceRange] octet dataBits = 8;
  [EnforceRange] octet stopBits = 1;
  ParityType parity = "none";
  [EnforceRange] unsigned long bufferSize = 255;
  FlowControlType flowControl = "none";
};

WebIDLenum ParityType {
  "none",
  "even",
  "odd"
};

WebIDLenum FlowControlType {
  "none",
  "hardware"
};

connected ゲッターの手順は：

1. this.[[connected]] を返す。

readable ゲッターの手順は以下の通りです：

1. もしthis.[[readable]] が null でなければ this.[[readable]] を返す。
2. もしthis.[[state]] が "opened" でなければ null を返す。
3. もしthis.[[readFatal]] が true なら null を返す。
4. stream を new ReadableStream として生成。
5. pullAlgorithm を以下の手順とする：
   1. desiredSize を high water mark まで埋めるために必要なサイズ とする。対象は this.[[readable]]。
   2. もしthis.[[readable]] の current BYOB request view が non-null なら desiredSize を当該 view の byte length に設定。
   3. 並列で以下を実施：
      1. OSにポートから desiredSize バイト分読み込みの指示を出し（結果をbyte列bytesに格納）。
         注

         this.[[state]] が "forgotten" となる場合は「ポートが切断された」ものとして扱ってください。
      2. グローバルタスクをキューし 関連グローバルオブジェクト で this を使い serial port task source で 次の処理：
         1. エラーがなければ：
            1. もしthis.[[readable]] の current BYOB request view が non-null ならば、 write で bytes を this.[[readable]] の current BYOB request view に書き込んだうえで view をその view に設定。
            2. そうでなければ、create で Uint8Array をbytesから生成。view を（this の 関連Realm で）。
            3. Enqueue で view を this.[[readable]] へ。
         2. バッファオーバーランの場合は error を this.[[readable]]に "BufferOverrunError" DOMException で発生させ、handle closing the readable stream の手順を実行。
         3. ブレーク条件（break）も同上で "BreakError"。
         4. フレームエラーも同上で "FramingError"。
         5. パリティエラーも同上で "ParityError"。
         6. OSエラーは "UnknownError" DOMException で発生し handle closing the readable stream の手順。
         7. ポート切断の場合は下記：
            1. this.[[readFatal]] を true に設定
            2. error を this.[[readable]] に "NetworkError" DOMException で発生。
            3. handle closing the readable stream の手順
   4. a promise resolved with undefined を返す。
   注

   本アルゴリズムで返すPromiseは即時resolveされ、ストリームキャンセルを妨げません。 [STREAMS]仕様ではチャンクenqueueまで再度呼び出されないとしています。

6. cancelAlgorithm を以下の手順とする：
   1. promise を新しい promiseとする。
   2. 並列で以下を実施：
      1. OSにすべての受信バッファ（ソフトウェア/ハードウェア）の中身を破棄するよう指示
      2. グローバルタスクをキューし 関連グローバルオブジェクト で this を使い serial port task source で次の処理：
         1. handle closing the readable stream の手順を実行
         2. Resolve promise を undefined で。
   3. promise を返す
7. Set up with byte reading support で stream をセットアップし pullAlgorithm にpullAlgorithm、 cancelAlgorithm にcancelAlgorithmをセット、 highWaterMark も this.[[bufferSize]] にする。
8. this.[[readable]] を stream に設定。
9. stream を返す。

1. this.[[readable]] に null を設定。
2. もしthis.[[writable]] が null かつ this.[[pendingClosePromise]] が null でなければ resolve で this.[[pendingClosePromise]] を undefined で完了。

writable ゲッターの手順は以下の通りです：

1. もし this.[[writable]] が null でなければ this.[[writable]] を返す。
2. もし this.[[state]] が "opened" でなければ null を返す。
3. もし this.[[writeFatal]] が true なら null を返す。
4. stream を new WritableStream として作成。
5. signal を stream の signal とする。
6. writeAlgorithm を、chunk に対し以下の手順とする：
   1. promise を 新しい promise として用意。
   2. Assert: signal は aborted されていない。
   3. もし chunk が BufferSource 型IDL値に 変換 できなければ、 TypeError で promise を reject、return。それ以外の場合はその結果を source に保存。
   4. BufferSource のコピーを取得 し bytes に保存。
   5. 並列で次の処理：
      1. OSにbytesを書き込む指示（または将来coalesceのため一時保存）。
         注

         OSはこの操作をbytesを送信バッファに入れ終えたタイミングで返すこともあります（実際の送信完了前）。
         注

         this.[[state]] が "forgotten" となった場合は「ポート切断」として扱うこと。
      2. グローバルタスクをキューし 関連グローバルオブジェクト で this を使い serial port task source で以下の手順：
         1. チャンクが正常に書き込まれるか蓄積保存に成功したら、resolve で promise を undefined で完了。
            注

            [STREAMS]仕様により writeAlgorithm は前回返した Promise resolve後でないと呼ばれません。 複数チャンクを内部キューでまとめてOSへ送る実装も認められており、 パフォーマンス向上のためこのPromiseは早めにresolveできる場合があります。
         2. OSエラーの場合、 reject promise を "UnknownError" DOMException で返す。
         3. ポート切断時は下記：
            1. this.[[writeFatal]] を true に
            2. Reject promise を "NetworkError" DOMException で返す。
            3. handle closing the writable stream 手順を呼ぶ。
         4. もし signal が aborted なら reject promise を signal の abort reason で。
   6. promise を返す。
7. abortAlgorithm を下記とする：
   1. promise を新しい promiseとする。
   2. 並列で以下を実施：
      1. OSに全てのソフトウェア・ハードウェア送信バッファの中身を破棄させる。
      2. グローバルタスクをキューし 関連グローバルオブジェクト で this を使い serial port task source で次の処理：
         1. handle closing the writable stream を呼ぶ。
         2. Resolve promise を undefined で。
   3. promise を返す
8. closeAlgorithm を下記とする：
   1. promise を新しい promiseとする。
   2. 並列で処理：
      1. OSにすべての送信バッファをフラッシュさせる。
      2. グローバルタスクをキューし 関連グローバルオブジェクト で this を使い serial port task source で次の処理：
         1. handle closing the writable stream を呼ぶ。
         2. もし signal が aborted なら reject promise を signal の abort reason で。
         3. それ以外は resolve promise を undefined で。
   3. promise を返す。
9. Set up stream の writeAlgorithm に writeAlgorithm を指定し、 abortAlgorithm に abortAlgorithm、 closeAlgorithm にcloseAlgorithm、 highWaterMark に this.[[bufferSize]] を、それから sizeAlgorithmはバイトカウントするアルゴリズムをセット。
10. Add で signal に以下のabort手順を追加：
    1. OSへの書込呼び出しをどれだけデータ送信したかに関わらず速やかに返すようにする。
11. this.[[writable]] を stream にセット。
12. stream を返す。

1. this.[[writable]] を null に設定。
2. もしthis.[[readable]] が null かつ this.[[pendingClosePromise]] が null でなければ resolve で this.[[pendingClosePromise]] を undefined で完了。

setSignals() メソッドの手順は以下の通りです：

1. promise を 新しい promise として用意する。
2. this.[[state]] が "opened" でなければ、 promise を "InvalidStateError" DOMException で reject し、返す。
3. signals の指定されたメンバーが一つも存在しなければ TypeError で promise を reject し返す。
4. 並列で次を実行：
   注

   本来は signals で指定された内容をアトミック（一度に）適用すべきですが、これを実現する手段はPOSIXやWindows APIにはないため、実装側はこの順序に依存することになります。
   1. signals["dataTerminalReady"] が存在すれば、OSに「data terminal ready（DTR）」信号をアサート（true）またはディアサート（false）を指示。
   2. signals["requestToSend"] が 存在すれば、OSに「request to send（RTS）」信号をアサートまたはディアサートを指示。
   3. signals["break"] があれば、OSに「break」信号のアサートまたはディアサートを指示。
      注

      「break」信号は一般的に送信線を「mark」電圧で保持する帯域内信号として実装されており、その間はデータ送信が停止します。
   4. 何らかの理由でOSがこれらの信号状態変更に失敗した場合、 グローバルタスクをキューし、 関連グローバルオブジェクト の serial port task source で promise を "NetworkError" DOMException で reject。
   5. グローバルタスクをキューし、 関連グローバルオブジェクト の serial port task source で resolve promise を undefined で完了。
5. promise を返す。

WebIDLdictionary SerialOutputSignals {
  boolean dataTerminalReady;
  boolean requestToSend;
  boolean break;
};

1. promise を 新しい promise とする。
2. this.[[state]] が "opened" でなければ promise を "InvalidStateError" DOMException で reject し返す。
3. 並列で下記を実行：
   1. シリアルポートに接続されているデバイスがアサートしている制御信号の状態をOSに問い合わせる。
   2. 何らかの理由でOSがこれらの信号の状態取得に失敗した場合は、 グローバルタスクをキューし、 関連グローバルオブジェクトの serial port task source で promise を "NetworkError" DOMException で reject し、処理を中断。
   3. dataCarrierDetect を「data carrier detect（DCD）」信号がデバイスでアサートされていれば true、それ以外は falseとする。
   4. clearToSend を「clear to send（CTS）」信号がアサートされていれば true、それ以外は false
   5. ringIndicator を「ring indicator（RI）」信号がアサートされていれば true、それ以外は false
   6. dataSetReady を「data set ready（DSR）」信号がアサートされていれば true、それ以外は false
   7. signals を 順序付きマップ «[ "dataCarrierDetect" → dataCarrierDetect, "clearToSend" → clearToSend, "ringIndicator" → ringIndicator, "dataSetReady" → dataSetReady ]» として用意。
   8. グローバルタスクをキューし 関連グローバルオブジェクトの serial port task source で resolve promise に signals を渡す。
4. promise を返す。

WebIDLdictionary SerialInputSignals {
  required boolean dataCarrierDetect;
  required boolean clearToSend;
  required boolean ringIndicator;
  required boolean dataSetReady;
};

close() メソッドの手順は以下の通りです：

1. promise を 新しい promise として用意。
2. this.[[state]] が "opened" でなければ promise を "InvalidStateError" DOMException で reject し返す。
3. cancelPromise を cancel を this.[[readable]] に呼び出した結果か、 a promise resolved with undefined（もし this.[[readable]] が null の場合）。
4. abortPromise を abort を this.[[writable]] に呼び出した結果か、 a promise resolved with undefined（もし this.[[writable]] が null の場合）。
5. pendingClosePromise を 新しい promise として用意。
6. もし this.[[readable]] および this.[[writable]] がともに null であれば、 resolve pendingClosePromise を undefined で完了。
7. this.[[pendingClosePromise]] に pendingClosePromise をセット。
8. combinedPromise を getting a promise to wait for all で «cancelPromise, abortPromise, pendingClosePromise» を対象に取得。
9. this.[[state]] を "closing" に。
10. React to combinedPromise.
    • もし combinedPromise がfulfilledの場合：
      1. 並列で下記実行
         1. OSへシリアルポートのクローズとリソース解放の指令
         2. this.[[state]] を "closed" に
         3. this.[[readFatal]] と this.[[writeFatal]] を false に。
         4. this.[[pendingClosePromise]] を null に。
         5. グローバルタスクをキューし 関連グローバルオブジェクト の serial port task source で resolve promise を undefined で解決。
    • もし combinedPromise が r の理由でrejectedの場合
      1. this.[[pendingClosePromise]] を null に。
      2. グローバルタスクをキューし 関連グローバルオブジェクト の serial port task source で reject promise を r で返す。
11. promise を返す。

forget() メソッドの手順は以下の通りです：

1. ユーザーエージェントがこの操作を実施できない場合（例：管理者ポリシーで許可された場合）は、a promise resolved with undefined を返す。
2. 並列で下記を実行：
   1. this.[[state]] を "forgetting" にする。
   2. ユーザーがrequestPort()の結果としてサイトに許可したシリアルポート一覧から this を削除する。
   3. this.[[state]] を "forgotten" にする。
   4. グローバルタスクをキューし 関連グローバルオブジェクト のserial port task sourceで resolve promise を undefined で実施。
3. promise を返す。

この仕様は、serial 属性で Navigator オブジェクトに公開されたメソッドを利用できるか制御する機能を定義します。

この機能のフィーチャ名は "serial" です。

この機能の デフォルト許可リスト は 'self' です。