Add docs on SerialPort.connected and Bluetooth port event support #37002
Conversation
chrisdavidmills
requested review from
wbamberg
and removed request for
a team
github-actions
bot
added
Content:WebAPI
|
Preview URLs
(comment last updated: 2024-11-29 12:50:58) |
| The following snippet invokes {{domxref("Serial.requestPort()")}} when the user presses a {{htmlelement("button")}}, prompting them to choose a serial port to connect to, then logs a message to the console reporting the connection status: | ||
|
|
||
| ```js | ||
| requestPortButton.onclick = async () => { |
There was a problem hiding this comment.
Our docs recommend addEventListener: https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks/Events#other_event_listener_mechanisms
There was a problem hiding this comment.
Good call; I've changed them to use addEventListener().
|
|
||
| ```js | ||
| navigator.serial.onconnect = ({ target: port }) => { | ||
| console.log(`onconnect event fired. Connected: ${port.connected}`); |
There was a problem hiding this comment.
| console.log(`onconnect event fired. Connected: ${port.connected}`); | |
| console.log(`connect event fired. Connected: ${port.connected}`); |
...etc
There was a problem hiding this comment.
I've updated both instances that were dubious.
| When a wireless device goes out of range of the host, any wireless serial port opened by a web app automatically closes, even though it stays logically connected. In such cases, the web app could attempt to reopen the port using {{domxref("SerialPort.open()")}}. | ||
|
|
||
| However, if the wireless device was intentionally disconnected (for example, if the user chose to disconnect it using the operating system control panel), the web app should refrain from reopening the port to prevent reconnecting to the wireless device. |
There was a problem hiding this comment.
This is really the key message about this PR AIUI. It would be good to have this in the description of "logically connected" instead of buried in an example down the page.
There was a problem hiding this comment.
I think that makes sense. I've moved this example and description up to a "Description" section up-top.
| // The port is logically connected | ||
| // automatically try to connect to the Bluetooth device |
There was a problem hiding this comment.
If we are connected, why are we trying to connect?
There was a problem hiding this comment.
Sorry, that should have been "automatically try to reopen the port" — updated. It should make more sense now.
…mills/content into web-serial-connected-property
There was a problem hiding this comment.
👍 Thanks Chris, I'm happy with this. I'm leaving this open in case @beaufortfrancois has more comments but happy for you to merge when you're ready.
Description
Chrome 130 supports the
SerialPort.connectedattribute, a boolean that reports whether a serial port is logically connected.Another part of this work item is that the
SerialPortconnectanddisconnectevents were previously only fired by physical/wired serial ports. With this change, wireless Bluetooth RFCOMM serial ports also fire these events when they connect and disconnect.This PR updates the docs to add a
connectedreference page and update the event pages to cover the Bluetooth support.Motivation
Additional details
Related issues and pull requests
See https://chromestatus.com/feature/5118102654418944.