SerialPort: setSignals() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Note: This feature is available in Dedicated Web Workers.
The setSignals() method of the SerialPort interface sets control signals on the port and returns a Promise that resolves when they are set.
Syntax
setSignals()
setSignals(options)
Parameters
optionsOptional-
An object with any of the following values:
dataTerminalReady-
A boolean indicating whether to invoke the operating system to either assert (if true) or de-assert (if false) the "data terminal ready" or "DTR" signal on the serial port.
requestToSend-
A boolean indicating whether to invoke the operating system to either assert (if true) or de-assert (if false) the "request to send" or "RTS" signal on the serial port.
break-
A boolean indicating whether to invoke the operating system to either assert (if true) or de-assert (if false) the "break" signal on the serial port.
Return value
A Promise.
Exceptions
The returned Promise rejects with one of the following exceptions:
InvalidStateErrorDOMException-
If
setSignals()is called when the port is not open. CallSerialPort.open()to open the port first. NetworkErrorDOMException-
If the signals on the device could not be set.
Examples
Assert the data terminal ready signal
The following example asserts the DTR signal when a connection is established.
await port.open({ baudRate: 9600 });
await port.setSignals({ dataTerminalReady: true });
Specifications
| Specification |
|---|
| Web Serial API # dom-serialport-setsignals |