SerialPort.getSignals()

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The SerialPort.getSignals() method of the SerialPort interface returns a Promise that resolves with an object containing the current state of the port's control signals.

Syntax

getSignals()

Parameters

None.

Return value

Returns a Promise that resolves with an object containing the following members:

clearToSend

A boolean indicating to the other end of a serial connection that is clear to send data.

dataCarrierDetect

A boolean that toggles the control signal needed to communicate over a serial connection.

dataSetReady

A boolean indicating whether the device is ready to send and receive data.

ringIndicator

A boolean indicating whether a ring signal should be sent down the serial connection.

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-getsignals

Browser compatibility

BCD tables only load in the browser