npm 包 qb1-serial-plain 使用教程

qb1-serial-plain 是一个 JavaScript 库，用于在前端使用 QB1 系列的串口扩展板。本文将介绍如何在前端项目中使用该 npm 包。

安装

首先，在终端中使用以下命令安装 qb1-serial-plain：

npm install qb1-serial-plain

初始化

在使用 qb1-serial-plain 之前，需要先进行初始化操作。初始化的第一步是创建一个 QB1Serial 对象：

const QB1Serial = require('qb1-serial-plain');

const qb1Serial = new QB1Serial();

通过以上代码，你就创建了一个 QB1Serial 对象。现在可以使用该对象中提供的方法来与 QB1 扩展板进行通信了。

方法

QB1Serial.portList()

该方法返回一个 Promise，该 Promise 的结果为一个包含串口端口名称的数组。使用该方法可以获取可用的串口端口名称。

const portListPromise = qb1Serial.portList();

portListPromise.then((portList) => {
    console.log(portList); // 输出可用的串口端口名称
}).catch((e) => {
    console.error(e); // 输出错误信息
});

QB1Serial.open(portName)

该方法用于打开一个串口端口并与 QB1 扩展板进行通信。需要传入一个 portName 参数来指定所要打开的串口端口名称。

const openPromise = qb1Serial.open('COM1');

openPromise.then(() => {
    console.log('串口已打开'); // 串口已打开
}).catch((e) => {
    console.error(e); // 输出错误信息
});

QB1Serial.send(data)

该方法用于向 QB1 扩展板发送数据。需要传入一个 data 参数来指定所要发送的数据。该方法会返回一个 Promise，该 Promise 的结果为发送成功的字节数。

const sendPromise = qb1Serial.send('Hello World!');

sendPromise.then((byteCount) => {
    console.log(`成功发送了 ${byteCount} 个字节`); // 成功发送了 12 个字节
}).catch((e) => {
    console.error(e); // 输出错误信息
});

QB1Serial.receive()

该方法用于从 QB1 扩展板接收数据。该方法会返回一个 Promise，该 Promise 的结果为接收到的数据。

const receivePromise = qb1Serial.receive();

receivePromise.then((data) => {
    console.log(`接收到了以下数据：${data}`); // 输出接收到的数据
}).catch((e) => {
    console.error(e); // 输出错误信息
});

QB1Serial.close()

该方法用于关闭已经打开的串口端口，结束与 QB1 扩展板的通信。

qb1Serial.close();

示例代码

以下是一个完整的使用 qb1-serial-plain 的示例代码：

-- -------------------- ---- -------
----- --------- - ----------------------------

----- --------- - --- ------------

------------------------------------ -- -
    -----------------------------------

    ------ ----------------------------
---------- -- -
    ---------------------

    ------ --------------------- ---------
------------------- -- -
    ------------------ ------------ ------

    ------ --------------------
-------------- -- -
    --------------------------------

    ------------------
------------ -- -
    -----------------
---

学习与指导意义

本文介绍了如何在前端项目中使用 qb1-serial-plain 包与串口扩展板进行通信。了解如何使用该包可以帮助我们更好地控制硬件设备，进而实现更多有趣的项目。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055ac781e8991b448d8605