Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements and additions to Web Serial API docs #37015

Merged
merged 5 commits into from
Dec 2, 2024

Conversation

chrisdavidmills
Copy link
Contributor

Description

MDN documented the Web Serial API a few years ago now (it was first supported in Chrome 89), but the MDN docs have not been updated much since then, for example to include support for Bluetooth RFCOMM services (originally only wired ports such as actual serial ports and USB devices were supported), which was added in Chrome 117 — see https://chromestatus.com/feature/5686596809523200.

This PR adds docs for Bluetooth RFCOMM support and other improvements besides, Specially:

  • bluetoothServiceClassId properties inside the Serial.requestPort() filters option.
  • The Serial.requestPort() allowedBluetoothServiceClassIds option.
  • The bluetoothServiceClassId property inside the object returned by the SerialPort.getInfo() method.
  • A mention of the Permissions Policy integration on the main landing page.
  • A few other assorted language improvements and description and example additions.
  • Some improvements to the SerialPort.close(), and SerialPort.forget() pages, to clarify the distinction between them and add more info generally.

Motivation

Additional details

Related issues and pull requests

@chrisdavidmills chrisdavidmills requested a review from a team as a code owner November 28, 2024 14:51
@chrisdavidmills chrisdavidmills requested review from wbamberg and removed request for a team November 28, 2024 14:51
@github-actions github-actions bot added Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed labels Nov 28, 2024
Copy link
Contributor

github-actions bot commented Nov 28, 2024

files/en-us/web/api/serial/requestport/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/serial/getports/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/serialport/close/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/serialport/forget/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/serialport/forget/index.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 thanks!

@chrisdavidmills
Copy link
Contributor Author

Cool, cheers @wbamberg!

Any other comments, @beaufortfrancois?

Copy link
Contributor

@beaufortfrancois beaufortfrancois left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with nit

files/en-us/web/api/serial/requestport/index.md Outdated Show resolved Hide resolved
@chrisdavidmills chrisdavidmills merged commit 0e2c698 into mdn:main Dec 2, 2024
8 checks passed
@chrisdavidmills chrisdavidmills deleted the web-serial-updates branch December 2, 2024 10:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants