Web Serial API

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

1. promiseを新しいプロミスとする。
2. thisの関連する グローバルオブジェクトに関連付けられた Documentが使用を 許可されていないポリシー制御 機能の名前が「serial」である場合、拒否は promiseを「SecurityError」DOMExceptionで行い、 promiseを返す。
3. 関連する グローバルオブジェクト（thisのもの）が 一時的な 有効化を持たない場合、拒否は promiseを 「SecurityError」DOMExceptionで行い、 promiseを返す。
4. options["filters"]が存在する場合、 filterごとに、 options["filters"]について次の 手順を実行する:
   1. filter["bluetoothServiceClassId"]が 存在する 場合:
      1. filter["usbVendorId"]が 存在する場合、 拒否は promiseをTypeError で行い、promiseを返す。
      2. filter["usbProductId"]が 存在する場合、 拒否は promiseをTypeError で行い、promiseを返す。
   2. filter["usbVendorId"]が 存在しない場合、拒否は promiseをTypeError で行い、 promiseを返す。
      注記

      この検査は、次の複合規則を実装する: SerialPortFilterを 空にすることはできず、 usbProductId が指定されている場合は、 usbVendorId も指定されなければならない。
5. 次の手順を並列に実行する:
   1. allPortsを空のリストとする。
   2. 各 システムに登録されている Bluetooth デバイスについて:
      1. 各 BluetoothServiceUUID uuid（デバイスがサポートするもの）について:
         1. uuidがブロック対象の Bluetooth サービスクラス UUIDでない場合:
            • uuidが Serial Port Profile サービスクラス IDに等しい場合、または
            • options["allowedBluetoothServiceClassIds"]が 存在し、かつ包含の対象が uuidである場合:
              1. portをSerialPort とする。これは Bluetooth デバイス上のサービスを表す。
              2. 追加として、 portをallPortsに加える。
   3. 各 利用可能な非 Bluetooth シリアルポートについて:
      1. portをSerialPortとする。これは そのポートを表す。
      2. 追加として、 portをallPortsに加える。
   4. シリアルポートへのアクセスをサイトに許可するようユーザーに求めるため、 次の条件で選んだallPorts内のポートのリストをユーザーに提示する。その選別では、いずれかのフィルターに一致するという条件をoptions["filters"] が存在する場合に適用し、そうでない場合はallPortsをそのまま使用する。
   5. ユーザーがポートを選択しない場合、グローバル タスクをキューに入れる。 これは関連する グローバルオブジェクト（thisのもの）上で、シリアルポートタスクソースを使用する。このタスクで拒否はpromiseを 「NotFoundError」DOMException で行い、これらの手順を中止する。
   6. portをSerialPortとする。これは ユーザーが選択したポートを表す。
   7. グローバル タスクをキューに入れる。これは関連する グローバルオブジェクト（ thisのもの）上で、シリアルポートタスクソースを使用する。このタスクにより解決されるのは 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 で拒否し、 promise を返す。
3. options["baudRate"] が 0 の場合、 promise を TypeError で拒否し、 promise を返す。
4. options["dataBits"] が 7 または 8 でない場合、 promise を TypeError で拒否し、 promise を返す。
5. options["stopBits"] が 1 または 2 でない場合、 promise を TypeError で拒否し、 promise を返す。
6. options["bufferSize"] が 0 の場合、 promise を TypeError で拒否し、 promise を返す。
7. 必要に応じて、options["bufferSize"] が 実装でサポートできるサイズより大きい場合、 promise を TypeError で拒否し、 promise を返す。
8. this.[[state]] を "opening" に設定する。
9. 次の手順を 並行して実行する。
   1. オペレーティングシステムを呼び出し、options で指定された接続パラメータ（またはデフォルト値）を使って シリアルポートを開く。
   2. これが何らかの理由で失敗した場合、グローバルタスクをキューし、 関連するグローバルオブジェクト上で this の serial port task source を使い、 reject して promise を "NetworkError" DOMException で拒否し、これらの手順を中止する。
   3. this.[[state]] を "opened" に設定する。
   4. this.[[bufferSize]] を options["bufferSize"] に設定する。
   5. グローバルタスクをキューし、 関連するグローバルオブジェクト上で this の serial port task source を使い、 resolve し、 promise を undefined で解決する。
10. 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を新しい ReadableStreamとする。
5. pullAlgorithmを次の手順とする:
   1. desiredSizeをハイウォーターマークまで 満たすための望ましいサイズとする。その対象は this.[[readable]]である。
   2. this.[[readable]]の 現在の BYOB 要求ビューが null でない場合、 desiredSizeをthis.[[readable]]の 現在の BYOB 要求ビューの バイト 長に設定する。
   3. promiseを新しいプロミスとする。
   4. 次の手順を並列に 実行する:
      1. オペレーティングシステムを呼び出し、ポートから最大desiredSize バイトを読み取り、その結果をバイト列 bytesに格納する。
         注記

         this.[[state]]が "forgotten"になることは、 the port was disconnectedであるかのように扱わなければならない。
      2. グローバル タスクをキューに入れる。対象は関連する グローバルオブジェクト （thisのもの）であり、 タスクソースにはシリアルポートタスク ソースを使用し、 次の手順を実行する:
         1. エラーが発生しなかった場合:
            1. this.[[readable]]の 現在の BYOB 要求ビューが null でない場合、書き込みでは bytesを this.[[readable]]の 現在の BYOB 要求ビューに書き込み、 viewをthis.[[readable]]の 現在の BYOB 要求ビューに設定する。
            2. それ以外の場合、viewを、次の方法で 作成した Uint8Array に設定する。これはbytesから、thisの関連する Realm内で作成する。
            3. エンキューとして、 viewを this.[[readable]]に追加する。
            4. 解決する対象を promise、値をundefinedとする。
         2. バッファーオーバーラン状態が発生した場合、 エラーを 次に対して呼び出す: this.[[readable]]。その際、 "BufferOverrunError" DOMException を用いる。さらに、 次の手順を呼び出す: 読み取り可能ストリームの終了を 処理する。
         3. ブレーク状態が発生した場合、 エラーを 次に対して呼び出す: this.[[readable]]。その際、 "BreakError" DOMException を用いる。さらに、 次の手順を呼び出す: 読み取り可能ストリームの終了を 処理する。
         4. フレーミングエラーが発生した場合、 エラーを 次に対して呼び出す: this.[[readable]]。その際、 "FramingError" DOMException を用いる。さらに、 次の手順を呼び出す: 読み取り可能ストリームの終了を 処理する。
         5. パリティエラーが発生した場合、 エラーを 次に対して呼び出す: this.[[readable]]。その際、 "ParityError" DOMException を用いる。さらに、 次の手順を呼び出す: 読み取り可能ストリームの終了を 処理する。
         6. オペレーティングシステムエラーが発生した場合、 エラーを 次に対して呼び出す: this.[[readable]]。その際、 "UnknownError" DOMException を用いる。さらに、次の手順を呼び出す: 読み取り可能ストリームの終了を 処理する。
         7. the port was disconnectedの場合、次の 手順を実行する:
            1. this.[[readFatal]]を trueに設定する。
            2. エラーを 次に対して呼び出す: this.[[readable]]。その際、 次の "NetworkError" DOMExceptionを用いる。
            3. 次の手順を呼び出す: 読み取り可能 ストリームの終了を処理する。
   5. promiseを返す。
6. cancelAlgorithmを次の手順とする:
   1. promiseを新しいプロミスとする。
   2. 次の手順を並列に 実行する。
      1. オペレーティングシステムを呼び出して、ポートの すべてのソフトウェアおよびハードウェア受信バッファーの内容を破棄する。
      2. グローバル タスクをキューに入れる。対象は関連する グローバルオブジェクト （thisのもの）であり、 タスクソースにはシリアルポートタスク ソースを使用し、 次の手順を実行する:
         1. 次の手順を呼び出す: 読み取り可能ストリームの終了を 処理する。
         2. 解決する対象を promise、値をundefinedとする。
   3. promiseを返す。
7. バイト読み取りを サポートするようセットアップする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を新しい WritableStreamとする。
5. signalをstreamのシグナルとする。
6. writeAlgorithmを次の手順とし、chunkを与える:
   1. promiseを新しいプロミスとする。
   2. 表明: signalは中止済みではない。
   3. chunkをIDL 値に 変換することができず、変換先の型が BufferSourceである場合、 拒否はpromiseをTypeError で行い、 promiseを返す。それ以外の場合、変換結果を 変数 sourceに保存する。
   4. バッファーソースの コピーを取得する対象をsourceとし、 結果をbytesに保存する。
   5. 並列 に、次の手順を実行する:
      1. オペレーティングシステムを呼び出し、bytesをポートに書き込む。 または、将来の結合のためにチャンクを保存する。
         注記

         オペレーティングシステムは、この操作から、 bytesが送信用にキューに入れられた時点で戻ってもよく、 実際に送信された後まで待つ必要はない。
         注記

         this.[[state]]が "forgotten"になることは、 the port was disconnectedであるかのように扱わなければならない。
      2. グローバル タスクをキューに入れる。対象は関連する グローバルオブジェクト （thisのもの）であり、 タスクソースにはシリアルポートタスク ソースを使用し、 次の手順を実行する:
         1. チャンクが正常に書き込まれたか、または 将来の結合のために保存された場合、解決する対象をpromise、値を undefinedとする。
            注記

            [STREAMS]は、次を規定する: writeAlgorithmの呼び出しは、 Promise がこのアルゴリズムの 前回の呼び出しによって返され、解決された後にのみ行われる。 効率化のため、実装は このPromiseを 早期に解決して、 複数のチャンク（WritableStreamの 内部キュー内で待機しているもの）を、オペレーティング システムへの単一の要求に結合してもよい。
         2. オペレーティングシステムエラーが発生した場合、 拒否はpromiseを"UnknownError" DOMExceptionで行う。
         3. the port was disconnectedの場合、次の 手順を実行する:
            1. this.[[writeFatal]]を trueに設定する。
            2. 拒否はpromiseを"NetworkError" DOMExceptionで行う。
            3. 次の手順を呼び出す: 書き込み可能 ストリームの終了を処理する。
         4. signalが中止済みである場合、拒否は promiseをsignalの中止 理由で行う。
   6. promiseを返す。
7. abortAlgorithmを次の手順とする:
   1. promiseを新しいプロミスとする。
   2. 次の手順を並列に 実行する。
      1. オペレーティングシステムを呼び出して、ポートの すべてのソフトウェアおよびハードウェア送信バッファーの内容を破棄する。
      2. グローバル タスクをキューに入れる。対象は関連する グローバルオブジェクト （thisのもの）であり、 タスクソースにはシリアルポートタスク ソースを使用し、 次の手順を実行する:
         1. 次の手順を呼び出す: 書き込み可能ストリームの終了を 処理する。
         2. 解決する対象をpromise、値をundefinedとする。
   3. promiseを返す。
8. closeAlgorithmを次の手順とする:
   1. promiseを新しいプロミスとする。
   2. 次の手順を並列に 実行する。
      1. オペレーティングシステムを呼び出して、ポートのすべての ソフトウェアおよびハードウェア送信バッファーの内容をフラッシュする。
      2. グローバル タスクをキューに入れる。対象は関連する グローバルオブジェクト （thisのもの）であり、 タスクソースにはシリアルポートタスク ソースを使用し、 次の手順を実行する:
         1. 次の手順を呼び出す: 書き込み可能ストリームの終了を 処理する。
         2. signalが中止済みである場合、拒否は promiseをsignalの中止 理由で行う。
         3. それ以外の場合、解決する対象をpromise、値をundefinedとする。
   3. promiseを返す。
9. セットアップする streamについて、 writeAlgorithmをwriteAlgorithmに設定し、 abortAlgorithmをabortAlgorithmに設定し、 closeAlgorithmをcloseAlgorithmに設定し、 highWaterMarkをthis.[[bufferSize]]に設定し、 さらに sizeAlgorithmをバイト数を数えるサイズアルゴリズムに設定する。
10. 追加として、次の 中止手順をsignalに加える:
    1. ポートへ書き込むためのオペレーティングシステムの呼び出しが、 書き込まれたデータ量にかかわらず、可能な限り早く 戻るようにする。
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 のすべてのメンバーが存在しない場合、 promise を TypeError で拒否し、 promise を返す。
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' です。