串口:open() 方法

安全上下文:此功能仅在安全上下文(HTTPS)中可用,在某些或所有支持的浏览器中可用。

实验性:这是一个实验性技术
在生产环境中使用此功能之前,请仔细查看浏览器兼容性表

注意:此功能在专用 Web 工作线程中可用。

SerialPort接口的open()方法返回一个Promise,当端口打开时,该方法将解析。默认情况下,端口以 8 个数据位、1 个停止位和无奇偶校验打开。baudRate参数是必需的。

语法

js
open(options)

参数

options

具有以下任意值的对象

baudRate

一个正的非零值,指示应建立串行通信的波特率。

bufferSize 可选

一个无符号长整数,指示要建立的读写缓冲区的大小。如果未传递,则默认为 255。

dataBits 可选

一个值为 7 或 8 的整数,指示每帧的数据位数。如果未传递,则默认为 8。

flowControl 可选

流量控制类型,可以是"none""hardware"。默认值为"none"

parity 可选

奇偶校验模式,可以是"none""even""odd"。默认值为"none"

stopBits 可选

一个值为 1 或 2 的整数,指示帧末尾的停止位数。如果未传递,则默认为 1。

返回值

一个Promise

异常

InvalidStateError DOMException

如果端口已打开,则返回此异常。

NetworkError DOMException

如果打开端口的尝试失败,则返回此异常。

示例

在串行端口上进行通信之前,必须先打开它。打开端口允许站点指定控制数据传输和接收方式的必要参数。开发人员应查看要连接的设备的文档以获取适当的参数。

js
await port.open({ baudRate: 9600 /* pick your baud rate */ });

规范

规范
Web 串口 API
# dom-serialport-open

浏览器兼容性

BCD 表仅在启用 JavaScript 的浏览器中加载。