使用SerialPort库进行Node物联网项目开发

如果说Nodejs将JavaScript的应用从网页端扩展到了服务器和操作系统端，Electron为JavaScript实现了跨平台应用的能力，那么SerialPort就是打通JavaScript软件与硬件的关键部件。著名的Johnny-Five物联网平台开发包的核心部件就是SerialPort,而Mozilla的WebThings

Gateway物联网关也是在SerialPort基础上实现的。这是因为，虽然已经历经了几十年光阴，串口在通讯传输速度上已经远远跟不上现代的通讯手段，但由于其廉价、简便、稳定可靠且经历时间验证的特点，在当前的工业与民生中仍然具有相当重要的地位，而SerialPort正是作为串口与计算机系统连接的中枢，成为互联网开发利器的JavaScript打通软件与硬件系统的关键。

更准确来说，SerialPort是运行在Node平台上的开发包，其安装也是通过npm install完成的。在SerialPort官方首页有一段简单的应用例程。装完SerialPort后，用这段程序就可以立即上手（当然，你还需要一个串口终端设备并且编写了终端部分的程序，如果没有，也可以通过本文后面的仿真器模拟出来一个。）

const SerialPort = require('serialport')
const Readline = require('@serialport/parser-readline')
const port = new SerialPort(path, { baudRate: 256000 })

const parser = new Readline()
port.pipe(parser)

parser.on('data', line => console.log(`> ${line}`))
port.write('ROBOT POWER ON\n')
*//> ROBOT ONLINE*

SerialPort包由SerialPort,Bindings,Interfaces和Parsers几部分组成，并且提供了一些比如串口列表等命令行工具（这些工具在旧版本里是SerialPort的一部分，但是目前版本中都可以独立运行了）。

1. Bindings

Bindings(绑定）是SerialPort连接软件与硬件平台的基础，一般来说，SerialPort库会自动探测并与平台绑定(Binding)，不需要人为去调用Bindings来绑定Linux、Windows或是mac平台。当然，SerialPort也提供了一个修改Bindings的路径，这是通过内置的Stream包实现的（按照开发者的意图，用户永远不需要直接操作Bindings包）。

var SerialPort = require('@serialport/stream');
SerialPort.Binding = MyBindingClass;

通常来说，人为修改绑定在使用中并没有太大便利，但对于调试则非常重要，这是因为，在调试时用户可以修改绑定来调用一个仿真的串口。

2. Stream Interfaces

SerialPort的接口界面是通过流(Stream)实现的，流也是Nodejs的核心部件之一。在新建SerialPort时，需要提供串口的常规参数，包括portName端口号，baudRate波特率等等，主要包括下面这些属性。

*/***** @typedef {Object} openOptions*** @property {boolean} [autoOpen=true] 此选项为真时会在自动打开串口.*** @property {number=} [baudRate=9600] 波特率110～115200，支持自定义（这一点太强大了）*** @property {number} [dataBits=8] 数据位，可以是8, 7, 6, or 5.*** @property {number} [highWaterMark=65536] 数据缓冲区大小，最大64k.*** @property {boolean} [lock=true] 锁定串口禁止其他设备使用，在windows平台下只能为true.*** @property {number} [stopBits=1] 停止位: 1 or 2.*** @property {string} [parity=none] 校验位:'none','even','mark','odd','space'.*** @property {boolean} [rtscts=false] 流(flow)控制设置，以下几个都是*** @property {boolean} [xon=false]*** @property {boolean} [xoff=false]*** @property {boolean} [xany=false]*** @property {object=} bindingOptions 绑定选项，一般不需要设置*** @property {Binding=} Binding 默认为静态属性`Serialport.Binding`.*** @property {number} [bindingOptions.vmin=1] 参见linux下 termios命令*** @property {number} [bindingOptions.vtime=0]***/*

一个SerialPort对象支持的属性包括baudRate,binding,isOpen和path，其中除了baudRate可以通过update方法修改为，其他属性均为只读。 一个SerialPort对象支持的事件包括open,error,close,data,drain,使用时可通过监听不同事件处理任务。 一个SrialPort对象支持open,update,close,read,write等方法，用于实现各种串口功能。 需要注意的是，随着版本的不断更迭，SerialPort的接口内容也不断有所调整，编程时要格外小心。例如，通常在新建串口前需要先获取可用的串口列表。官方提供了静态方法SerialPort.list()可以返回当前所有串口列表。但随着版本更新，官方文档中的SerialPort已经升级为Promise方式，文档中直接获取的方法会返回错误，需要修改为类似以下形式才能使用。

SerialPort.list()
    .then((ports) => {
        ports.forEach( (port)=> {
            console.log(port.comName);
            console.log(port.pnpId);
            console.log(port.manufacturer);
        });

    })
        .catch((err)=>{
            console.log(err);
        });

3. Parsers

Parsers包继承自Nodejs Transform Stream,提供了一些实用的串口协议解析接口，比如对收到的大量串口数据，要根据特定的标识进行分割、解析的时候，就可以用Delimiter解析器，类似的解析器还包括Readline（分行读取），ByteLength(按长度截取），InterByteTimeout(超时）以及功能强大的Regex（正则表达式）解析器等等。

const SerialPort = require('serialport')
const Readline = require('@serialport/parser-readline')
const port = new SerialPort('/dev/tty-usbserial1')
const parser = new Readline()
port.pipe(parser)
parser.on('data', console.log)
port.write('ROBOT PLEASE RESPOND\n')
*//也可以简化为***const parser = port.pipe(new Readline());

SerialPort的Parsers大部分都是分割长数据，在实际使用中遇到了一个数据不足的问题，即由于传输速度低，一条消息被分割成好几条发送，在收到之后需要组合在一起（有特定的字符表示完整信息的结尾），在这种情况下，官方的Parsers均不合适，为了实现这一功能，自己手动写了一个ConcatParser，来实现将几段数据拼接的功能，ConcatParser同时提供了超时和超出缓冲区长度两个选项，以保证端口不会处于无限等待的状态。ConcatParser的实现如下。

'use strict';
const { Transform } = require('stream');

class ConcatParser extends Transform {
    constructor(options = {}) {
        super(options);
        try {
            if (typeof options.boundary === 'undefined') {
                throw new TypeError('"boundary" is not a bufferable object');
            }

            if (options.boundary.length === 0) {
                throw new TypeError('"boundary" has a 0 or undefined length');
            }

            this.includeBoundary = typeof options.includeBoundary !== 'undefined' ? options.includeBoundary : true;
            this.interval = typeof options.interval !== 'undefined' ? options.interval : 3000;
            this.maxBufferSize = typeof options.maxBufferSize !== 'undefined' ? options.maxBufferSize : 65535;
            this.intervalID = -1;
            this.boundary = Buffer.from(options.boundary);
            this.buffer = Buffer.alloc(0);

        } catch (error) {
           throw new Error('Init concatparser error');
        }
    }

    _transform(chunk, encoding, cb) {

        clearTimeout(this.intervalID);
        let data = Buffer.concat([this.buffer, chunk]),
            dataLength = data.length,
            position;

        if (dataLength >= this.maxBufferSize) {
            this.buffer = data.slice(0, this.maxBufferSize);
            data = Buffer.alloc(0);
            this.emitData();
        } else if ((position = data.indexOf(this.boundary)) !== -1) {
            this.buffer = data.slice(0, position + (this.includeBoundary ? this.boundary.length : 0));
            data = Buffer.alloc(0);
            this.emitData();
        }
        this.buffer = data;
        this.intervalID = setTimeout(this.emitData.bind(this), this.interval);
        cb();
    }

    emitData() {
        clearTimeout(this.intervalID);
        if (this.buffer.length > 0) {
            this.push(this.buffer);
        }
        this.buffer = Buffer.alloc(0);
    }
    _flush(cb) {
        this.emitData();
        cb();
    }
}

module.exports = ConcatParser;

4. 命令行接口

SerialPort库提供了几个命令行接口，可以通过npx直接运行。几个接口分别是SerialPort List,SerialPort REPL和SerialPort Terminal,使用方法为：

npx @serialport/list [options] *//可能需要先安装 npm @serialport/list***npx @serialport/repl npx @serialport/terminal  -p  [options]

@serialport/list 用来列出系统中所有串口，接受格式化、版本等选项，可以通过-h 查看帮助。@serialport/repl提供了一个可以直接通过命令行操作串口的接口，可以通过命令行直接进行串口读写等操作。@serialport/terminal提供了一个简单的接口可以获取连接在串口上的终端设备的基础信息。

5. Mock串口仿真器

Mock是SerialPort库中最好用的功能之一，它通过模拟的硬件串口接口，让开发工作可以脱离硬件来完成测试。这在是DD或者TDD开发过程中是必不可少的。一个简单的Mock串口仿真器使用方法如下：

const SerialPort = require('@serialport/stream')
const MockBinding = require('@serialport/binding-mock')

SerialPort.Binding = MockBinding

*// Create a port and enable the echo and recording.***MockBinding.createPort('/dev/ROBOT', { echo: true, record: true })
const port = new SerialPort('/dev/ROBOT')

Mock串口仿真器可以实现SerialPort库中所有功能的测试，通过Mock的源码可以看出这些接口及测试时检测的途径。

const AbstractBinding = require('@serialport/binding-abstract')
const debug = require('debug')('serialport/binding-mock')

let ports = {}
let serialNumber = 0

function resolveNextTick(value) {
  return new Promise(resolve => process.nextTick(() => resolve(value)))
}

*/***** Mock包，用来模拟硬件串口的实现***/*
class MockBinding extends AbstractBinding {

 *//如果record为真，这个缓存Buffer中会存入所有写到虚拟串口中的内容，可以检查串口传出的数据***  readonly recording: Buffer

  *// 最后一次写入串口的缓存Buffer***  readonly lastWrite: null | Buffer

  *//静态方法，用于创建一个虚拟串口***  static createPort(path: string, opt: { echo?: boolean, record?: boolean, readyData?: Buffer}): void

  *//静态方法，用于复位所有虚拟串口***  static reset(): void

  *// 静态方法，用于列出所有虚拟串口***  static list(): Promise

  *// 从一个虚拟串口Emit（发出）指定数据***  emitData(data: Buffer | string | number[])

  *// 其他支持的标准串口接口方法***  open(path: string, opt: OpenOpts): Promise
  close(): Promise
  read(buffer: Buffer, offset: number, length: number): Promise
  write(buffer: Buffer): Promise
  update(options: { baudRate: number }): Promise
  set(options): Promise
  get(): Promise
  getBaudRate(): Promise
  flush(): Promise
  drain(): Promise
}