SerialPort: setSignals() method
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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
options
Optional-
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
InvalidStateError
DOMException
-
Returned if the port is not open. Call
SerialPort.open()
to avoid this error. NetworkError
DOMException
-
Returned if the signals on the device could not be set.
Specifications
Specification |
---|
Web Serial API # dom-serialport-setsignals |
Browser compatibility
BCD tables only load in the browser