const SerialPort = require('serialport');

SerialPort.list().then((ports) => {
    console.log(ports); // 打印串口列表
}).catch((err) => {
    console.log(err);
});

在這里插入圖片描述

需要注意的是同一個端口在這個列表中有可能會重復出現。

也可以使用 async / await 方式使用上面方法：

const SerialPort = require('serialport');

(async () => {
    try {
        let ports = await SerialPort.list();
        console.log(ports); // 打印串口列表
    } catch (error) {
        console.log(error);
    }
})();

在這里插入圖片描述

打開端口

默認情況下創(chuàng)建 SerialPort 對象就會打開端口，比如下面這樣：

const SerialPort = require('serialport');

const port = new SerialPort('COM6', (err) => {
    if (err) {
        console.log('端口打開失??！');
        return;
    }
    console.log('端口打開成功！');
});

SerialPort類的構造方法中有一個 autoOpen 選項用于控制創(chuàng)建對象是是否自動打開端口，默認為自動打開，也可以將它關閉，這樣可以后面手動進行打開端口動作：

const SerialPort = require('serialport');

const port = new SerialPort('COM6', { autoOpen: false });

port.open(function (err) {
    if (err) {
        console.log('端口打開失敗！');
        return;
    }
    console.log('端口打開成功！');
});

SerialPort類的構造方法中可以使用 baudRate 選項設置串口通訊波特率，默認為9600：

const SerialPort = require('serialport');

const port = new SerialPort('COM6', { baudRate: 115200 }); // 設置波特率為115200

更多內容可以參考下面章節(jié)SerialPort類的構造方法說明。

發(fā)送數據

可以使用SerialPort對象的 write 方法發(fā)送數據，該方法會將要發(fā)送的數據放入發(fā)送緩存，然后依次發(fā)送，比如下面這樣：

const SerialPort = require('serialport');
const port = new SerialPort('COM6');

port.write('Hello world!\n'); // 發(fā)送字符串
port.write(Buffer.from('Hey!\n')); // 發(fā)送Buffer數據
port.write(new Uint8Array([0x48, 0x69, 0x21, 0x0A])); // 發(fā)送字節(jié)數組

在這里插入圖片描述

write 方法也可以添加回調函數：

const SerialPort = require('serialport');
const port = new SerialPort('COM6');

port.write('Hello world!\n', (err) => {
    if (err) {
        console.log('write操作失??！');
        return;
    }
    console.log('write操作成功！');
});

需要注意的是上面的回調函數非異常狀態(tài)下觸發(fā)的時候只是表示 write 方法本身操作完成，并不代表數據完全從端口發(fā)送完成，可以使用 drain 方法來處理，該方法會阻塞直到發(fā)送完成：

const SerialPort = require('serialport');
const port = new SerialPort('COM6');

port.write('Hello world!\n');
port.drain(err => {
    if (err) return;
    console.log('發(fā)送完成！');
});

接收數據

可以使用下面方式接收數據：

const SerialPort = require('serialport');
const port = new SerialPort('COM6');

// 以 paused mode 監(jiān)聽收到的數據，需要主動讀取數據
port.on('readable', () => {
    console.log(port.read()); // 使用read方法讀取數據，可以指定讀取字節(jié)數
});

// 以 flowing mode 監(jiān)聽收到的數據
port.on('data', (data) => {
    console.log(data);
});

在這里插入圖片描述

除了上面方式外，也可以使用 pipe 將數據傳送到另一個流。

錯誤處理

SerialPort對象大多數操作都有回調函數，回調函數中的第一個參數都是異常對象。另外也可以通過 error 事件來統(tǒng)一處理異常：

const SerialPort = require('serialport');
const port = new SerialPort('COM6');

port.on('error', err => {
    console.log(err);
});

數據解析器

SerialPort模塊中準備了一些數據解析器，主要用來處理收到的一些一些常見形式的串口數據，主要提供的功能如下：

ByteLength Parser
以收到的數據長度為單位進行解析：

const SerialPort = require('serialport');
const port = new SerialPort('COM6');

const ByteLength = require('@serialport/parser-byte-length');
const parser = port.pipe(new ByteLength({ length: 8 })); // 每收到8個字節(jié)觸發(fā)
parser.on('data', chunk => {
    console.log(chunk); // 打印收到的數據
});

在這里插入圖片描述

ccTalk Parser
解析 ccTalk 格式數據，格式詳見：https://en.wikipedia.org/wiki/CcTalk

Delimiter Parser
以指定字符為界限處理數據：

const SerialPort = require('serialport');
const port = new SerialPort('COM6');

const Delimiter = require('@serialport/parser-delimiter');
const parser = port.pipe(new Delimiter({ delimiter: '\n' })); // 以 \n 分隔處理數據
parser.on('data', chunk => {
    console.log(chunk.toString()); // 打印收到的數據
});

在這里插入圖片描述

delimiter選項可以是 string|Buffer|number[] ；includeDelimiter選項表示數據中是否包含分隔符，默認不包含。

InterByteTimeout Parser
指定時間未收到數據觸發(fā)解析：

const SerialPort = require('serialport');
const port = new SerialPort('COM6');

const InterByteTimeout = require('@serialport/parser-inter-byte-timeout');
const parser = port.pipe(new InterByteTimeout({interval: 2000})); // 2000毫秒未接到數據觸發(fā)
parser.on('data', chunk => {
    console.log(chunk); // 打印收到的數據
});

在這里插入圖片描述

maxBufferSize選項用于指定接收到該數量數據后就算沒有超時也將觸發(fā)動作。

Readline Parser
以行為單位解析數據，默認行分隔符為 \n，可以使用 delimiter 選項重新設置為其它的，比如 \r\n 。

Ready Parser
以開始標志進行解析。

Regex Parser
以正則表達式為分隔進行解析。

SerialPort類

使用SerialPort模塊主要就是使用SerialPort類，其介紹在SerialPort模塊文檔中 Stream Interface 章節(jié)：https://serialport.io/docs/api-stream，這里稍微摘錄下其中部分內容。

構造方法

new SerialPort(path [, openOptions] [, openCallback])

構造方法用于創(chuàng)建一個串口對象，path為串口號，openCallback為自動打開失敗時的回調函數；

openOptions常用選項如下：

選項	類型	說明	默認值
autoOpen	boolean	自動打開端口	true
baudRate	number	波特率	9600
dataBits	number	數據位，可選值：8、7、6、5	8
highWaterMark	number	讀和寫緩存大小	65536
lock	boolean	鎖定端口，防止其它平臺打開（Windows上不支持false）	true
stopBits	number	停止位，可選值：1、2	1
parity	string	校驗，可選值：none、even、mark、odd、space	none
rtscts	boolean	流控制設置	false
xon	boolean	流控制設置	false
xoff	boolean	流控制設置	false
xany	boolean	流控制設置	false

屬性

SerialPort有下面幾個屬性可讀：
path 、 baudRate 、 isOpen 、 binding

事件

SerialPort會觸發(fā)的事件有下面幾個：

open 端口打開時觸發(fā)；
error 發(fā)送錯誤時觸發(fā)；
close 端口關閉時觸發(fā)；
data 收到數據時觸發(fā)；
drain 如果write方法返回false，則再次調用write方法時將觸發(fā)該事件；

方法

SerialPort可用的一些方法如下：

open(() => {}): void 打開端口；
update(options: updateOptions, callback?: err => {}): void 更改波特率；
write(data: string|Buffer|Array<number>, encoding?: string, callback?: error => {}): boolean 發(fā)送數據；
read(size?: number): string|Buffer|null 讀取數據；
close(callback?: error => {}): void 關閉端口；
set(options: setOptions, callback?: error => {}): void 設置流控制；
get(callback: (error, data: ModemStatus) => {}): void 獲取已打開端口的流控制狀態(tài)；
flush(callback? error => {}):void 清空接收和發(fā)送緩存中未處理數據；
drain(callback? error => {}):void 等待數據發(fā)送完成；
pause(): this 暫停 flowing mode 觸發(fā)data事件，轉為 paused mode；
resume(): this 恢復 data 事件，從 paused mode 轉為 flowing mode；