Nodejs Serialport文档翻译

相关文章推荐

阳光的木耳 · QApplication.processEv ...· 1 月前 ·

痛苦的开心果 · what happens when i ...· 10 月前 ·

暴躁的石榴 · PyCharm中的list引发意外类型警告 ...· 1 年前 ·

失恋的充电器 · 使用TensorFlow，GPU和Docke ...· 1 年前 ·

腾讯云

备案控制台

开发者社区

TVP

文章/答案/技术大牛

写文章

专栏首页技术综合 Nodejs Serialport文档翻译

3 0

分享

平台/架构

Node v4.x

Node v6.x

Node v7.x

Linux / ia32

Linux / x64

Linux / ARM v6¹

Linux / ARM v7¹

Linux / ARM v8¹

Linux / MIPSel¹

Linux / PPC64¹

Windows² / x86

Windows² / x64

OSX³ / x64
npm install serialport 
# 如果你没有安装node/npn，先添加它们
sudo apk add --no-cache nodejs
# 添加必要的构建库和运行依赖
sudo apk add --no-cache make gcc g++ python linux-headers udev
# 然后我们就能安装 serialport, 强制它编译
npm install serialport --build-from-source
# 如果你使用root来安装，你需要使用
#告知npm构建serialport在安装的时间内
npm install serialport --build-from-source
#如果你有一个依赖serialport的包，你可以告知npm去特别重新构建它。
npm rebuild serialport --build-from-source
#或者除去包名，重新构建所有
npm rebuild --build-from-source
Revision

CPU

Arm Version

A, A+, B, B+

32-bit ARM1176JZF-S

ARMv6

Compute Module

32-bit ARM1176JZF-S

ARMv6

Zero

32-bit ARM1176JZF-S

ARMv6

B2

32-bit ARM Cortex-A7

ARMv7

B3

32-bit ARM Cortex-A53

ARMv8
sudo npm install serialport --unsafe-perm --build-form-source
root@rpi3:~# npm install -g serialport
/usr/bin/serialport-list -> /usr/lib/node_modules/serialport/bin/serialport-list.js
/usr/bin/serialport-term -> /usr/lib/node_modules/serialport/bin/serialport-terminal.js
> serialport@4.0.3 install /usr/lib/node_modules/serialport
> node-pre-gyp install --fallback-to-build
gyp WARN EACCES user "root" does not have permission to access the dev dir "/root/.node-gyp/6.9.1"
gyp WARN EACCES attempting to reinstall using temporary dev dir "/usr/lib/node_modules/serialport/.node-gyp"
make: Entering directory '/usr/lib/node_modules/serialport/build'
make: *** No rule to make target '../.node-gyp/6.9.1/include/node/common.gypi', needed by 'Makefile'.  Stop.
make: Leaving directory '/usr/lib/node_modules/serialport/build'
gyp ERR! build error
gyp ERR! stack Error: `make` failed with exit code: 2
#Using Ubuntu and node 6
curl -sL https://deb.nodesource.com/setup_7.x | sudo -E bash -
sudo apt-get install -y nodejs
#Using Debian and node 6,使用root权限
curl -sL https://deb.nodesource.com/setup_7.x | bash - 
apt-get install -y nodejs
npm install serialport --build-from-source
var SerialPort = require('serialport');
var port = new SerialPort('/dev/tty-usbserial1',{
    baudRate: 57600
});
var SerialPort = require('serialport');
var port = new SerialPort('/dev/tty-usbserial1');
port.on('open',function(){
    port.write('main screen turn on ',function(err){
        if(err){
            return console.log('Error on write: ' ,err.message);
        console.log('message written');
//打开错误将会发出一个错误事件
port.on('error',function(err){
    console.log('Error: ',err.message);
});
var SerialPort = require('serialport');
var port = new SerialPort('/dev/tty-usbserial1',function(err){
    if(err){
        return console.log('Error:',err.message);
    port.write('main screen turn on',function(err){
        if(err){
            return console.log('Error on write: ',err.message);
        console.log('message written');
});
var SerialPort = require('serialport');
var port = new SerialPort('/dev/tty-usbserial1',{autoOpen:false});
port.open(function(err){
    if(err){
        return console.log('Error opening port: ',err.message);
    //写入失败将会被串口发出由于没有写回调。
    port.write('main screen turn on');
//开启事件总是会被发出
port.on('open',function(){
    //打开的逻辑
});
port.on('data',function(data){
    console.log('Data: '+data);
});
port.write('Hi Mon!');
port.write(new Buffer('Hi Mom!'));
DEBUG=serialport:main node myapp.js
DEBUG=serialport:* node myapp.js
DEBUG=* node myapp.js
Name

Type

Description

baudRate

<code>number</code>

串口的波特率，使用.update来改变它。只读

binding

<code>object</code>

支持串口的绑定对象，只读.

isOpen

<code>boolean</code>

如果串口打开时为true ，其他情况是 false.只读. (since 5.0.0)

path

<code>string</code>

串口的系统路径或者名称. 只读.

参数

类型

描述

path

<code>string</code>

串口打开的系统路径.例如, 在Mac/Linux上/dev/tty.XXX 或者 Windows上的 COM1 .

[options]

<code>openOptions</code>

串口配置选项

[openCallback]

<code>errorCallback</code>

当连接已经打开. 如果它没有提供以及由错误发生，它将会发出串口error事件。如果在openOptions中autoOpen被设置为false，回调将不会调用

参数

类型

描述

[callback]

<code>errorCallback</code>

当连接已经被打开. 如果它没有被提供以及有一个错误发生, 它将在串口上被发出error事件``.

参数

类型

描述

[options]

<code>object</code>

目前只有波特率是支持的

[options.baudRate]

<code>number</code>

设置波特率的串口是打开的。这应该匹配常见的波特率之一, 比如 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200. 当然不能担保, 串口连接的设备将支持请求的波特率,只要串口自己支持那个波特率.

[callback]

<code>errorCallback</code>

当波特率被改变的时候. 如果 .update 被调用而没有回调以及有一个错误,错误事件将会被触发。

参数

类型

描述

data

<code>string</code>

<code>array</code>

<code>buffer</code>

接收一个 Buffer 对象, 或者一个接受buffer构造函数的类型 (除了字节数组或者一个字符串).

[encoding]

<code>string</code>

编码, 如果数据块是一个字符串. 默认的是 'utf8'. 也接受 'ascii', 'base64', 'binary', 'hex' 查看 Buffers and Character Encodings了解所有可用的选项.

[callback]

<code>function</code>

第一次写入操作结束.数据可能还没有刷新到底层端口,没有参数.

参数

类型

描述

[size]

<code>number</code>

指明了会返回多少字节的数据如果是可用的话。

参数

类型

描述

callback

<code>errorCallback</code>

当连接被关闭.

参数

类型

默认值

描述

[options]

<code>object</code>

所有选项是操作系统默认的当串口被打开. 每个标志被设置为相同的调用提供或者是默认数据.如果选项没有提供将要使用的默认选项.

[options.brk]

<code>Boolean</code>

<code>false</code>

[options.cts]

<code>Boolean</code>

<code>false</code>

[options.dsr]

<code>Boolean</code>

<code>false</code>

[options.dtr]

<code>Boolean</code>

<code>true</code>

[options.rts]

<code>Boolean</code>

<code>true</code>

[callback]

<code>errorCallback</code>

当串口标志被设置.

参数

类型

描述

[callback]

<code>modemBitsCallback</code>

Called once the modem bits have been retrieved（当比特被恢复）

参数

类型

描述

[callback]

<code>errorCallback</code>

当刷新操作完成.

参数

类型

描述

[callback]

<code>errorCallback</code>

当耗尽操作返回
function writeAndDrain (data, callback) {
  sp.write(data, function () {
    sp.drain(callback);
}
var SerialPort = require('serialport/lib/serialport');
SerialPort.Binding = MyBindingClass;
名称

状态

描述

ByteLength

<code>Class</code>

发出数据的转换流作为缓存，在收到一个特定的字节数后

Delimiter

<code>Class</code>

发出数据的转换流，每次接受一个字节序列

Readline

<code>Class</code>

发出数据的转换流，在收到一个换行符之后
var SerialPort = require('serialport');
var Readline = SerialPort.parsers.Readline;
var port = new SerialPort('/dev/tty-usbserial1');
var parser = new Readline();
port.pipe(parser);
parser.on('data', console.log);
port.write('ROBOT PLEASE RESPOND\n');
// 可以缩短创建的解析程序和传输管道
var parser = port.pipe(new Readline());
var SerialPort = require('serialport');
var ByteLength = SerialPort.parsers.ByteLength
var port = new SerialPort('/dev/tty-usbserial1');
var parser = port.pipe(new ByteLength({length: 8}));
parser.on('data', console.log);
var SerialPort = require('serialport');
var Delimiter = SerialPort.parsers.Delimiter;
var port = new SerialPort('/dev/tty-usbserial1');
var parser = port.pipe(new Delimiter({delimiter: new Buffer('EOL')}));
parser.on('data', console.log);
var SerialPort = require('serialport');
var Readline = SerialPort.parsers.Readline;
var port = new SerialPort('/dev/tty-usbserial1');
var parser = port.pipe(Readline({delimiter: '\r\n'}));
parser.on('data', console.log);
参数

类型

callback

<code>listCallback</code>
// 示例的串口信息
  comName: '/dev/cu.usbmodem1421',
  manufacturer: 'Arduino (www.arduino.cc)',
  serialNumber: '757533138333964011C1',
  pnpId: undefined,
  locationId: '0x14200000',
  vendorId: '0x2341',
  productId: '0x0043'
}
var SerialPort = require('serialport');
SerialPort.list(function (err, ports) {
  ports.forEach(function(port) {
    console.log(port.comName);
    console.log(port.pnpId);
    console.log(port.manufacturer);
});
名称

类型

描述

isOpen

<code>boolean</code>

必须的属性. 串口打开就是true , 其他的是false.只读.

参数

类型

描述

options

<code>object</code>

options.disconnect

<code>function</code>

当binding被检测到一个没连接的串口，方法将会被调用. 这个方法应该在所有操作期间调用，而不是在操作正常回调后调用。SerialPort 将试图调用 close在断开连接后，以及会忽视所有错误.

参数

类型

path

<code>string</code>

openOptions

<code>openOptions</code>

参数

类型

描述

data

<code>buffer</code>

接受 Buffer 对象

length

<code>integer</code>

读取指定的最大字节数

参数

类型

描述

data

<code>buffer</code>

接受 Buffer 对象.

参数

类型

描述

[options]

<code>object</code>

目前只有波特率支持

[options.baudRate]

<code>number</code>

如果通过bingdings提供一个不支持的波特率，它将回调一个错误。

参数

类型

默认

描述

[options]

<code>object</code>

当串口被打开时，所有设置都是操作系统的默认设置. 每个标识都被设置成每次调用时提供的或者默认的数值。所有设置通常都是被提供的.

[options.brk]

<code>Boolean</code>

<code>false</code>

[options.cts]

<code>Boolean</code>

<code>false</code>

[options.dsr]

<code>Boolean</code>

<code>false</code>

[options.dtr]

<code>Boolean</code>

<code>true</code>

[options.rts]

<code>Boolean</code>

<code>true</code>

参数

类型

error

<code>error</code>

参数

类型

默认

error

<code>error</code>

status

<code>object</code>

[status.cts]

<code>boolean</code>

<code>false</code>

[status.dsr]

<code>boolean</code>

<code>false</code>

[status.dcd]

<code>boolean</code>

<code>false</code>

名称

类型

默认

描述

Binding

<code>module:serialport~Binding</code>

硬件访问绑定, 绑定是node SreialPort如何和底层系统通信.默认的，我们自动判断Windows (WindowsBinding), Linux (LinuxBinding) 和 OSX (DarwinBinding)系统，以及加载合适我们系统的模块.

autoOpen

<code>boolean</code>

<code>true</code>

在 nextTick自动打开串口

lock

<code>boolean</code>

<code>true</code>

防止其他进程打开串口. 目前不支持Windows系统.

baudRate

<code>number</code>

<code>9600</code>

已经打开的串口的波特率. 这个应该匹配一个常用的波特率，比如 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200. 这些是不确定的, 设备连接到串口上将支持请求的波特率，即使串口自己支持那个波特率。

dataBits

<code>number</code>

<code>8</code>

必须是其中之一: 8, 7, 6, or 5.

stopBits

<code>number</code>

<code>1</code>

必须是其中之一: 1 or 2.

highWaterMark

<code>number</code>

<code>16384</code>

读写缓存区大小，默认是 16k

parity

<code>string</code>

<code>"none"</code>

必须是其中之一: 'none', 'even', 'mark', 'odd', 'space'

rtscts

<code>boolean</code>

<code>false</code>

流控制设置

xon

<code>boolean</code>

<code>false</code>

流控制设置

xoff

<code>boolean</code>

<code>false</code>

流控制设置

xany

<code>boolean</code>

<code>false</code>

流控制设置

bindingOptions

<code>object</code>

设置特定的绑定选项

bindingOptions.vmin

<code>number</code>

<code>1</code>

查看man termios LinuxBinding和 DarwinBinding

bindingOptions.vtime

<code>number</code>

<code>0</code>

查看man termios LinuxBinding 和 DarwinBinding

参数

类型

描述

error

<code>error</code>

ports

<code>array</code>

串口信息的对象数组
$ serialport-list -h
  Usage: serialport-list [options]
  List available serial ports
  Options:
    -h, --help           输出帮助信息
    -V, --version        输出版本号
    -f, --format <type>  输出的格式： text, json, or jsonline. 默认的是: text
$ serialport-list
/dev/cu.Bluetooth-Incoming-Port
/dev/cu.usbmodem1421    Arduino (www.arduino.cc)
$ serialport-list -f json
[{"comName":"/dev/cu.Bluetooth-Incoming-Port"},{"comName":"/dev/cu.usbmodem1421","manufacturer":"Arduino (www.arduino.cc)","serialNumber":"752303138333518011C1","locationId":"0x14200000","vendorId":"0x2341","productId":"0x0043"}]
$ serialport-list -f jsonline
{"comName":"/dev/cu.Bluetooth-Incoming-Port"}
{"comName":"/dev/cu.usbmodem1421","manufacturer":"Arduino (www.arduino.cc)","serialNumber":"752303138333518011C1","locationId":"0x14200000","vendorId":"0x2341","productId":"0x0043"}
$ serialport-term -h
  Usage: serialport-term -p <port> [options]
  A basic terminal interface for communicating over a serial port. Pressing ctrl+c exits.
  Options:
    -h, --help                     输出帮助信息
    -V, --version                  输出版本号
    -l --list                      列出可用串口然后退出
    -p, --port, --portname <port>  串口的路径或者名称
    -b, --baud <baudrate>          波特率，默认是: 9600
    --databits <databits>          数据字节 默认是: 8
    --parity <parity>              奇偶性，默认是: none
    --stopbits <bits>              停止位，默认是: 1
    --echo --localecho             打印类型，你输入它们时.
$ serialport-term -l
/dev/cu.Bluetooth-Incoming-Port

治电小白菜

Nodejs Serialport文档翻译

Nodejs Serialport文档翻译

版本号:Serialport@5.0.0-beta3

平台支持

安装说明

安装的平台环境

Alpine Linux

Electron

非法指令

Mac OS X

Raspberry Pi Linux

sudo / root

Ubuntu/Debian Linux

Windows

协议

使用

打开一个串口

调试

错误处理

SerialPort ⏏

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

serialPort.open([callback])

serialPort.update([options],[callback])

serialPort.write(data,[encoding],[callback]) ⇒ <code>boolean</code>

serialPort.read([size]) ⇒ <code>string</code> | <code>Buffer</code> | <code>null</code>

serialPort.close(callback)

serialPort.set([options], [callback])

serialPort.get([callback])

serialPort.flush([callback])

serialPort.drain([callback])

serialPort.pause() ⇒

serialPort.resume() ⇒

Event: "error"

Event: "open"

Event: "data"

Event: "disconnect"

Event: "close"

SerialPort.Binding : <code> BaseBinding </code>

SerialPort.parsers : <code>object</code>

SerialPort.list(callback) : <code>function</code>

SerialPort~BaseBinding

new BaseBinding(options)

baseBinding.open(path, openOptions) ⇒ <code>Promise</code>

baseBinding.close() ⇒ <code>Promise</code>

baseBinding.read(data, length) ⇒ <code>Promise</code>

baseBinding.write(data) ⇒ <code>Promise</code>

baseBinding.update([options]) ⇒ <code>Promise</code>

baseBinding.set([options]) ⇒ <code>Promise</code>

baseBinding.get() ⇒ <code>Promise</code>

baseBinding.flush() ⇒ <code>Promise</code>

baseBinding.drain() ⇒ <code>Promise</code>

BaseBinding.list() ⇒ <code>Promise</code>

SerialPort~errorCallback : <code>function</code>

SerialPort~modemBitsCallback : <code>function</code>

SerialPort~openOptions : <code>Object</code>

SerialPort~listCallback : <code>function</code>

命令行工具

串口列表

串口终端