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
InvalidStateErrorDOMException-
Returned if the port is not open. Call
SerialPort.open()to avoid this error. NetworkErrorDOMException-
Returned if the signals on the device could not be set.
Specifications
| Specification |
|---|
| Web Serial API # dom-serialport-setsignals |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
setSignals
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- In development. Supported in a pre-release version.
- In development. Supported in a pre-release version.
- No support
- No support
- See implementation notes.