Half-Duplex Serial Port
This package uses serialport and adds half-duplex functionality (i.e. send-and-receive). It supports TypeScript.
For serial communication, one usually wants to send a command and wait for an answer. This Promise based library does exactly that.
Half-duplex means that there can always be only one party sending data. Since the commands are asynchronous and Promise based, they are protected internally with a Semaphore and not more than one caller can send and receive data at the same time.
const serial = SerialHalfDuplex ;const timeoutMillis = 200;serial;
See your favourite editor’s autocomplete support for the full documentation.
new SerialHalfDuplex( port : ISerialPort, args? : SerialHalfDuplexArgs )
args allows to configure
delimiterwhich marks the end of a response
debugMode : boolean
Enable debug mode (print incoming and outgoing messages).
sendAndReceive( cmd : Buffer, timeout : number ) : Promise<Buffer>
Send a command and wait for an answer.
The timeout is in milliseconds. It is required because serial communication does not specify a request/response protocol and we just assume the client will respond within a defined amount of time (but it might not reply at all, for example because it is disconnected).
sendAndReceiveMany( …, expectedLines : number ) : Promise<Buffer>
Send a command and wait for multiple answers.
The command resolves when at least one line is returned within the timeout.
Waiting for multiple lines is useful in cases where a device returns multiple
lines to one command. For example, the Acer beamer H5382BD sends
*001\rLAMP 0\r when querying the lamp state.
send( cmd : Buffer ) : Promise<void>
Simply send a command without waiting for an answer.
Testing serial communication
Testing serial ports without the real target device can be done e.g.
- by programming an Arduino to behave like the real device
Socat can open a pair of serial ports.
socat -d -d pty,raw,echo=0 pty,raw,echo=0 2019/12/22 09:57:26 socat N PTY is /dev/pts/3 2019/12/22 09:57:26 socat N PTY is /dev/pts/4 2019/12/22 09:57:26 socat N starting data transfer loop with FDs [5,5] and [7,7]
Minicom can then connect to one end and the application to the other end. Do
not forget to enable echo (
Ctrl+A E) and disable hardware flow control
Ctrl+A O → Serial port setup → Hardware Flow Control).
minicom -b 9600 -o -D /dev/pts/4
- Breaking: Updated
serialportto v9 to support Node.js 14. This requires Node.js > 8.
- Changed: Documentation updated
SerialHalfDuplex.sendAndReceiveMany. Receives more than one line.
SerialHalfDuplexaccepts a configuration object to configure the response delimiter
SerialHalfDuplex.openSerialPortnow accepts arguments for serial port configuration.