Skip to content

Commit 658f595

Browse files
Rename Serial API to Web Serial API (GoogleChrome#4590)
1 parent be0e96b commit 658f595

File tree

2 files changed

+58
-57
lines changed

2 files changed

+58
-57
lines changed

src/site/content/en/blog/fugu-status/index.md

+28-28
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: New capabilities status
33
subhead: Web apps should be able to do anything iOS/Android/desktop apps can. The members of the cross-company capabilities project want to make it possible for you to build and deliver apps on the open web that have never been possible before.
44
date: 2018-11-12
5-
updated: 2021-01-21
5+
updated: 2021-02-03
66
tags:
77
- blog
88
- capabilities
@@ -228,20 +228,6 @@ latest version of Chrome, and in many cases other Chromium based browsers.
228228
<em>Updated December 18, 2019</em><a name="shape-barcode"></a>
229229
</td>
230230
</tr>
231-
<tr>
232-
<td>
233-
<a href="/serial/">
234-
Serial API
235-
</a>
236-
</td>
237-
<td>
238-
The Serial API provides a way for websites to read from and
239-
write to a serial device with scripts. The API bridges the web and
240-
the physical world by allowing websites to communicate with serial
241-
devices, such as microcontrollers and 3D printers.<br>
242-
<em>Updated January 21, 2021</em>
243-
</td>
244-
</tr>
245231
<tr>
246232
<td>
247233
<a href="/shape-detection/">Shape&nbsp;Detection (Barcode)</a>
@@ -272,19 +258,6 @@ latest version of Chrome, and in many cases other Chromium based browsers.
272258
<em>Updated June 24, 2020</em>
273259
</td>
274260
</tr>
275-
<tr>
276-
<td>
277-
<a href="/hid/">WebHID API</a>
278-
</td>
279-
<td>
280-
There is a long tail of human interface devices (HIDs), such as
281-
alternative keyboards or exotic gamepads, that are too new, too old,
282-
or too uncommon to be accessible by systems' device drivers. The
283-
WebHID API solves this by providing a way to implement
284-
device-specific logic in JavaScript.<br>
285-
<em>Updated January 21, 2021</em>
286-
</td>
287-
</tr>
288261
<tr>
289262
<td>
290263
<a href="/nfc/">Web NFC</a>
@@ -300,6 +273,20 @@ latest version of Chrome, and in many cases other Chromium based browsers.
300273
<em>Updated January 21, 2021</em>
301274
</td>
302275
</tr>
276+
<tr>
277+
<td>
278+
<a href="/serial/">
279+
Web Serial API
280+
</a>
281+
</td>
282+
<td>
283+
The Web Serial API provides a way for websites to read from and
284+
write to a serial device with scripts. The API bridges the web and
285+
the physical world by allowing websites to communicate with serial
286+
devices, such as microcontrollers and 3D printers.<br>
287+
<em>Updated January 21, 2021</em>
288+
</td>
289+
</tr>
303290
<tr>
304291
<td>
305292
<a href="/sms-receiver-api-announcement/">Web OTP API</a>
@@ -335,6 +322,19 @@ latest version of Chrome, and in many cases other Chromium based browsers.
335322
<em>Updated November 8, 2019</em>
336323
</td>
337324
</tr>
325+
<tr>
326+
<td>
327+
<a href="/hid/">WebHID API</a>
328+
</td>
329+
<td>
330+
There is a long tail of human interface devices (HIDs), such as
331+
alternative keyboards or exotic gamepads, that are too new, too old,
332+
or too uncommon to be accessible by systems' device drivers. The
333+
WebHID API solves this by providing a way to implement
334+
device-specific logic in JavaScript.<br>
335+
<em>Updated January 21, 2021</em>
336+
</td>
337+
</tr>
338338
</tbody>
339339
</table>
340340
</div>

src/site/content/en/blog/serial/index.md

+30-29
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
title: Read from and write to a serial port
3-
subhead: The Serial API allows websites to communicate with serial devices.
3+
subhead: The Web Serial API allows websites to communicate with serial devices.
44
authors:
55
- beaufortfrancois
66
date: 2020-08-12
7-
updated: 2021-01-25
7+
updated: 2021-02-03
88
hero: hero.jpg
99
thumbnail: thumbnail.jpg
1010
alt: |
1111
Old modems, routers, network equipment. Serial, phone, audio, ethernet connectors.
1212
description: |
13-
The Serial API bridges the web and the physical world by allowing websites to communicate with serial devices.
13+
The Web Serial API bridges the web and the physical world by allowing websites to communicate with serial devices.
1414
tags:
1515
- blog # blog is a required tag for the article to show up in the blog.
1616
- capabilities
@@ -20,21 +20,21 @@ feedback:
2020
---
2121

2222
{% Aside 'success' %}
23-
The Serial API, part of the [capabilities project](/fugu-status/), launched in
24-
Chrome&nbsp;89.
23+
The Web Serial API, part of the [capabilities project](/fugu-status/), launched
24+
in Chrome&nbsp;89.
2525
{% endAside %}
2626

27-
## What is the Serial API? {: #what }
27+
## What is the Web Serial API? {: #what }
2828

2929
A serial port is a bidirectional communication interface that allows sending and
3030
receiving data byte by byte.
3131

32-
The Serial API provides a way for websites to read from and write to a serial
33-
device with JavaScript. Serial devices are connected either through a serial
34-
port on the user's system or through removable USB and Bluetooth devices that
35-
emulate a serial port.
32+
The Web Serial API provides a way for websites to read from and write to a
33+
serial device with JavaScript. Serial devices are connected either through a
34+
serial port on the user's system or through removable USB and Bluetooth devices
35+
that emulate a serial port.
3636

37-
In other words, the Serial API bridges the web and the physical world by
37+
In other words, the Web Serial API bridges the web and the physical world by
3838
allowing websites to communicate with serial devices, such as microcontrollers
3939
and 3D printers.
4040

@@ -77,21 +77,21 @@ communication between the website and the device that it is controlling.
7777

7878
</div>
7979

80-
## Using the Serial API {: #use }
80+
## Using the Web Serial API {: #use }
8181

8282
### Feature detection {: #feature-detection }
8383

84-
To check if the Serial API is supported, use:
84+
To check if the Web Serial API is supported, use:
8585

8686
```js
8787
if ("serial" in navigator) {
88-
// The Serial API is supported.
88+
// The Web Serial API is supported.
8989
}
9090
```
9191

9292
### Open a serial port {: #open-port }
9393

94-
The Serial API is asynchronous by design. This prevents the website UI from
94+
The Web Serial API is asynchronous by design. This prevents the website UI from
9595
blocking when awaiting input, which is important because serial data can be
9696
received at any time, requiring a way to listen to it.
9797

@@ -164,7 +164,7 @@ options are optional and have convenient [default values].
164164

165165
### Read from a serial port {: #read-port }
166166

167-
Input and output streams in the Serial API are handled by the Streams API.
167+
Input and output streams in the Web Serial API are handled by the Streams API.
168168

169169
{% Aside %}
170170
If streams are new to you, check out [Streams API
@@ -487,22 +487,23 @@ const [appReadable, devReadable] = port.readable.tee();
487487

488488
## Dev Tips {: #dev-tips }
489489

490-
Debugging the Serial API in Chrome is easy with the internal page, `chrome://device-log`
491-
where you can see all serial device related events in one single place.
490+
Debugging the Web Serial API in Chrome is easy with the internal page,
491+
`chrome://device-log` where you can see all serial device related events in one
492+
single place.
492493

493494
<figure class="w-figure">
494-
<img src="./device-log-page-screenshot.jpg" class="w-screenshot" alt="Screenshot of the internal page for debugging the Serial API.">
495-
<figcaption class="w-figcaption">Internal page in Chrome for debugging the Serial API.</figcaption>
495+
<img src="./device-log-page-screenshot.jpg" class="w-screenshot" alt="Screenshot of the internal page for debugging the Web Serial API.">
496+
<figcaption class="w-figcaption">Internal page in Chrome for debugging the Web Serial API.</figcaption>
496497
</figure>
497498

498499
## Codelab {: #codelab }
499500

500-
In the [Google Developer codelab], you'll use the Serial API to interact with a
501-
[BBC micro:bit] board to show images on its 5x5 LED matrix.
501+
In the [Google Developer codelab], you'll use the Web Serial API to interact
502+
with a [BBC micro:bit] board to show images on its 5x5 LED matrix.
502503

503504
## Browser support {: #browser-support }
504505

505-
The Serial API is available on all desktop platforms (Chrome OS, Linux, macOS,
506+
The Web Serial API is available on all desktop platforms (Chrome OS, Linux, macOS,
506507
and Windows) in Chrome 89.
507508

508509
## Polyfill {: #polyfill }
@@ -514,28 +515,28 @@ been claimed by a built-in device driver.
514515

515516
## Security and privacy {: #security-privacy }
516517

517-
The spec authors have designed and implemented the Serial API using the core
518+
The spec authors have designed and implemented the Web Serial API using the core
518519
principles defined in [Controlling Access to Powerful Web Platform Features],
519520
including user control, transparency, and ergonomics. The ability to use this
520521
API is primarily gated by a permission model that grants access to only a single
521522
serial device at a time. In response to a user prompt, the user must take active
522523
steps to select a particular serial device.
523524

524525
To understand the security tradeoffs, check out the [security] and [privacy]
525-
sections of the Serial API Explainer.
526+
sections of the Web Serial API Explainer.
526527

527528
## Feedback {: #feedback }
528529

529530
The Chrome team would love to hear about your thoughts and experiences with the
530-
Serial API.
531+
Web Serial API.
531532

532533
### Tell us about the API design
533534

534535
Is there something about the API that doesn't work as expected? Or are there
535536
missing methods or properties that you need to implement your idea?
536537

537-
File a spec issue on the [Serial API GitHub repo][issues] or add your thoughts
538-
to an existing issue.
538+
File a spec issue on the [Web Serial API GitHub repo][issues] or add your
539+
thoughts to an existing issue.
539540

540541
### Report a problem with the implementation
541542

@@ -549,7 +550,7 @@ sharing quick and easy repros.
549550

550551
### Show support
551552

552-
Are you planning to use the Serial API? Your public support helps the Chrome
553+
Are you planning to use the Web Serial API? Your public support helps the Chrome
553554
team prioritize features and shows other browser vendors how critical it is to
554555
support them.
555556

0 commit comments

Comments
 (0)