Node.js中SerialPort(串口)模块使用

目录
  • 目的
  • 模块安装
    • 基础使用
    • 扫描端口
    • 打开端口
    • 发送数据
    • 接收数据
    • 错误处理
  • 数据解析器
  • SerialPort类
    • 构造方法
    • 属性
    • 事件
    • 方法
  • 命令行工具
  • 总结

目的

上位机与各种电路模块间常常采用串口进行通讯,Node.js中可以使用SerialPort模块操作串口,这篇文章将对其使用进行简单说明。

官网:https://serialport.io/
文档:https://serialport.io/docs/
项目地址:https://github.com/serialport/node-serialport

目前SerialPort模块版本为 9.2.7

模块安装

使用下面命令就可以安装SerialPort模块:

npm install serialport

SerialPort模块功能中有部分是用C/C++实现的,所以不同的平台需要该平台可用的二进制文件才能运行,对于常见的平台通常会有预编译好的二进制文件。如果没有的话通常会尝试使用 node-gyp (依赖Python 3.x)进行编译,通常包管理器会自动处理相关事务:

有时候或是有些平台下可能需要手动编译。对于编译而言需要平台上有相应的编译工具,可以参考 《Node.js入门 02:包管理器npm》 这个文章中的模块编译章节。

安装了编译工具后可以重新安装SerialPort模块或者手动进行编译处理,具体内容可以参考SerialPort模块文档中 Installing SerialPort 章节:https://serialport.io/docs/guide-installation/

基础使用

安装SerialPort模块后可以使用 const SerialPort = require('serialport') 方式导入。

扫描端口

使用 SerialPort.list(): Promise<PortInfo[]> 静态方法可以获取设备上的串口列表,比如下面演示:

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);
    }
})();

打开端口

默认情况下创建 SerialPort 对象就会打开端口,比如下面这样:

const SerialPort = require('serialport');

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

SerialPort类的构造方法中有一个 autoOpen 选项用于控制创建对象是是否自动打开端口,默认为自动打开,也可以将它关闭,这样可以后面手动进行打开端口动作:

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

更多内容可以参考下面章节SerialPort类的构造方法说明。

发送数据

可以使用SerialPort对象的 write 方法发送数据,该方法会将要发送的数据放入发送缓存,然后依次发送,比如下面这样:

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

port.write('Hello world!\n'); // 发送字符串
port.write(Buffer.from('Hey!\n')); // 发送Buffer数据
port.write(new Uint8Array([0x48, 0x69, 0x21, 0x0A])); // 发送字节数组

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操作成功!');
});

需要注意的是上面的回调函数非异常状态下触发的时候只是表示 write 方法本身操作完成,并不代表数据完全从端口发送完成,可以使用 drain 方法来处理,该方法会阻塞直到发送完成:

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

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

接收数据

可以使用下面方式接收数据:

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

// 以 paused mode 监听收到的数据,需要主动读取数据
port.on('readable', () => {
    console.log(port.read()); // 使用read方法读取数据,可以指定读取字节数
});

// 以 flowing mode 监听收到的数据
port.on('data', (data) => {
    console.log(data);
});

除了上面方式外,也可以使用 pipe 将数据传送到另一个流。

错误处理

SerialPort对象大多数操作都有回调函数,回调函数中的第一个参数都是异常对象。另外也可以通过 error 事件来统一处理异常:

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个字节触发
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
指定时间未收到数据触发解析:

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毫秒未接到数据触发
parser.on('data', chunk => {
    console.log(chunk); // 打印收到的数据
});

maxBufferSize选项用于指定接收到该数量数据后就算没有超时也将触发动作。

Readline Parser
以行为单位解析数据,默认行分隔符为 \n,可以使用 delimiter 选项重新设置为其它的,比如 \r\n

Ready Parser
以开始标志进行解析。

Regex Parser
以正则表达式为分隔进行解析。

SerialPort类

使用SerialPort模块主要就是使用SerialPort类,其介绍在SerialPort模块文档中 Stream Interface 章节:https://serialport.io/docs/api-stream,这里稍微摘录下其中部分内容。

构造方法

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

构造方法用于创建一个串口对象,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有下面几个属性可读:
pathbaudRateisOpenbinding

事件

SerialPort会触发的事件有下面几个:

  • open 端口打开时触发;
  • error 发送错误时触发;
  • close 端口关闭时触发;
  • data 收到数据时触发;
  • drain 如果write方法返回false,则再次调用write方法时将触发该事件;

方法

SerialPort可用的一些方法如下:

  • open(() => {}): void 打开端口;
  • update(options: updateOptions, callback?: err => {}): void 更改波特率;
  • write(data: string|Buffer|Array<number>, encoding?: string, callback?: error => {}): boolean 发送数据;
  • read(size?: number): string|Buffer|null 读取数据;
  • close(callback?: error => {}): void 关闭端口;
  • set(options: setOptions, callback?: error => {}): void 设置流控制;
  • get(callback: (error, data: ModemStatus) => {}): void 获取已打开端口的流控制状态;
  • flush(callback? error => {}):void 清空接收和发送缓存中未处理数据;
  • drain(callback? error => {}):void 等待数据发送完成;
  • pause(): this 暂停 flowing mode 触发data事件,转为 paused mode;
  • resume(): this 恢复 data 事件,从 paused mode 转为 flowing mode;

命令行工具

SerialPort模块也提供了一些命令行工具,用于直接在命令行界面中使用。下面是官网首页的使用演示:

更多内容可以参考SerialPort模块文档中 Command Line Tools 章节:https://serialport.io/docs/guide-cli

总结

Node.js的SerialPort模块使用主要就是上面一些内容了。

另外需要提一点的是SerialPort模块并不是直接操作串口,而是调用了各个平台上底层的接口来使用串口,如果有进行相关内容的开发或是有特殊需求的话可以参考SerialPort模块文档中Binding相关内容。

到此这篇关于Node.js中SerialPort(串口)模块使用的文章就介绍到这了,更多相关Node.js SerialPort内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

时间: 2021-11-23

详解NodeJS模块化

目录 一.前言 二.正文 2.1.什么是模块 2.2.Resolving 2.3.require.resolve 2.4.模块间的父子依赖关系 2.5.exports, module.exports 2.6.模块循环依赖 2.7..json和.node 2.8.Wrapping 2.9.Cache 三.总结 一.前言 我们知道,Node.js是基于CommonJS规范进行模块化管理的,模块化是面对复杂的业务场景不可或缺的工具,或许你经常使用它,但却从没有系统的了解过,所以今天我们来聊一聊Node

Node.js中的模块化,npm包管理器详解

目录 模块化的基本概念 什么是模块化 模块化拆分的好处 Node.js中的模块化 Node.js中模块的分类 加载模块 模块作用域 向外共享模块作用域中的成员 module对象 exports对象 npm与包 包 如何下载包 在项目中安装包的命令 解决下包速度慢的问题 为什么下包速度慢 解决方法一--淘宝NPM镜像服务器 解决方法二--切换npm的下包镜像源 解决方法三--nrm 总结 模块化的基本概念 什么是模块化 模块化是指解决一个复杂问题时,自顶向下逐层把系统划分成若干模块的过程.对于整个

node.js核心模块有哪些

全局对象 在浏览器JS中,通常window是全局对象,而nodejs中的全局对象是global,所有全局变量都是global对象的属性. 在nodejs中能够直接访问到的对象通常都是global的属性,如console. process等 全局对象与全局变量 global最根本的作用是作为全局变量的宿主. 全局变量的条件: 在最外层定义的变量:全局对象的属性:隐式定义的变量(未定义直接赋值的变量) 定义一个全局变量,同时也是全局对象的属性. 永远使用var定义变量以避免引入全局变量,因为全局变量

详解nodejs内置模块

概述 nodejs内置模块指的是除默认提供的语法之外,提供的美容,无需下载,直接引入,引入只写名称即可. nodejs内置模块: 1.path模块  用于处理文件路径. path.normalize(路径解析,得到规范路径): path.join(路径合并): path.resolve(获取绝对路径): path.relative(获取相对路径). ...... 2.until模块  弥补js功能不足,新增API. util.format(格式化输出字符串); util.isArray(检查是否

详解python内置模块urllib

urllib 是 python 的内置模块, 主要用于处理url相关的一些操作,例如访问url.解析url等操作. urllib 包下面的 request 模块主要用于访问url,但是用得太多,因为它的光芒全都被 requests 这个第三方库覆盖了,最常用的还是 parse 模块. 写爬虫过程中,经常要对url进行参数的拼接.编码.解码,域名.资源路径提取等操作,这时 parse 模块就可以排上用场. 一.urlparse urlparse 方法是把一个完整的URL拆分成不同的组成部分,你可以

详解nodeJs文件系统(fs)与流(stream)

一.简介 本文将介绍node.js文件系统(fs)和流(stream)的一些API已经参数使用情况. 二.目录 文件系统将介绍以下方法: 1.fs.readFile 2.fs.writeFile 3.fs.open 4.fs.read 5.fs.stat 6.fs.close 7.fs.mkdir 8.fs.rmdir 9.fs.readdir 10.fs.unlink stream流的四种类型readable,writable,duplex,transform以及stream对象的事件. 三.

详解Nodejs内存治理

s运行的宿主环境不同,相应的对内存治理的要求也不一样,当宿主环境是浏览器时,由于网页的运行时间短,且只运行在用户的机器上(相当于分布式),即使内存使用过多或者存在一定的内存泄漏,也并不会对终端用户产生太大的影响.当宿主环境编程服务器(Node)时,情况就大不相同了,本身代码运行在固定的几台机器(集中式)上,而且运行的时间是长时间运行,一旦内存治理不好出现了内存膨胀甚至是内存泄漏的情况的话,就会出现服务器端响应时间变长甚至是服务crash的情况. Nodejs是基于V8构建的,所以在Node中使用

详解NodeJS Https HSM双向认证实现

工作中需要建立一套HSM的HTTPS双向认证通道,即通过硬件加密机(Ukey)进行本地加密运算的HTTPS双向认证,和银行的UKEY认证类似. NodeJS可以利用openSSL的HSM plugin方式实现,但是需要编译C++,太麻烦,作者采用了利用Node Socket接口,纯JS自行实现Https/Http协议的方式实现 具体实现可以参考如下 node-https-hsm TLS规范自然是参考RFC文档 The Transport Layer Security (TLS) Protocol

详解Nodejs get获取远程服务器接口数据

本文实例为大家分享了Nodejs get获取远程服务器接口数据的具体代码,供大家参考,具体内容如下 1.GET模块:_get.js /** * Created by jinx on 7/7/17. */ var http = require('http'); module.exports = { /** * 测试获取所有的区域 * / locations: function (cb) { http.get('http://wx.xx.com/locations', function (res)

详解nodejs通过响应回写的方式渲染页面资源

我们一般通过node框架提供的api操作页面渲染,如何利用原始回写的方式来实现同样的功能呢 下面是通过node 提供的异步地读取一个文件的全部内容api readFile进行操作,代码如下: html <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content=&quo

详解Nodejs 部署到阿里云全过程

整个部署过程学到了不少东西,记录一下. 1. 到阿里云购买云服务器 ECS . https://www.aliyun.com/product/ecs 如果是在校学生,在淘宝有实名认证,且在学信网有注册,可以试试抢学生的首月优惠套餐. https://www.aliyun.com/act/aliyun/campus.html 作为一个穷逼+不熟悉服务器配置的菜鸟.选了最便宜的套餐: CPU: 1核 / 内存: 1024 MB / 带宽:1Mbps / 操作系统: CentOS 7.0 购买环节会设

详解NodeJs项目 CentOs linux服务器线上部署

1.安装nodejs 官网仓库下载好NodeJs的Linux包(我用的 node-v9.9.0-linux-x64.tar.gz)到本地然后通过FTP(filezilla)上传到服务器;或者可以直接在服务器终端使用 wget 命令下载. [root@10 /] wget https://nodejs.org/dist/v9.9.0/node-v9.9.0-linux-x64.tar.gz 1.解压 node-v9.9.0-linux-x64.tar.gz 找到你上传的位置目录 [root@10

详解Nodejs mongoose

前言 Mongoose 是在nodejs环境下,对mongodb进行便捷操作的对象模型工具.本文介绍解(翻)密(译)Mongoose插件. Schema 开始我们就要讲到Schema,一个Schema对应的是mongodb的collection(相当于SQL table),并且定义其结构. var mongoose = require('mongoose'); var Schema = mongoose.Schema; //定义一个博客结构 var blogSchema = new Schema

详解nodejs解压版安装和配置(带有搭建前端项目脚手架)

nodejs 安装 我先前用了nvm,觉得nvm挺厉害可以随时更换nodejs版本,但是研究了下,可能自己功力不够还是什么,并不好用,中间还出现了错误:所以最后还是卸载了: 本文图文并茂的一步一步的来,旨在好用简洁: 1]第一步:下载nodejs 中文官网: https://nodejs.org/zh-cn/download/ 如下图是最新的版本,不用怕这是最新的直接下载就可以了,选择windows版本,LTS是长期支持版本,箭头所示下载64位压缩版:个人觉得压缩版本就够了:(可能安装版的功能更