SerialPort: setSignals() method

{{SecureContext_Header}}{{APIRef("Web Serial API")}}{{SeeCompatTable}}{{AvailableInWorkers("window_and_dedicated")}}

The setSignals() method of the {{domxref("SerialPort")}} interface sets control signals on the port and returns a {{jsxref("Promise")}} that resolves when they are set.

Syntax

setSignals()
setSignals(options)

Parameters

• options {{Optional_Inline}}
  • : 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 {{jsxref("Promise")}}.

Exceptions

• InvalidStateError {{domxref("DOMException")}}
  • : Returned if the port is not open. Call {{domxref("SerialPort.open()")}} to avoid this error.
• NetworkError {{domxref("DOMException")}}
  • : Returned if the signals on the device could not be set.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}