npm 包 particle-api-js 使用教程

Particle API JS 是一个适用于 Particle（原 Spark）硬件和服务的 Node.js 和浏览器 JavaScript 库，可以让开发者使用 JavaScript 简单地与 Particle 云平台进行通信。该库可以用于获取设备信息、发布/订阅事件以及控制设备。

在本文中，我们将介绍如何在您的项目中使用 Particle API JS。

安装

首先，您需要确保已经安装了 Node.js 和 NPM。在命令行中运行以下命令进行安装：

npm install particle-api-js

配置

在项目中引入 Particle API JS 并创建一个实例：

const Particle = require('particle-api-js');
const particle = new Particle();

接着，您需要设置登录凭据（access token）以连接到 Particle 云平台。您可以在 Particle 控制台中生成一个 access token。将其存储在环境变量或配置文件中，然后使用以下代码将其传递给 Particle API JS：

particle.login({accessToken: 'YOUR_ACCESS_TOKEN'});

获取设备信息

要获取设备信息，请使用 getDevice() 方法并传递设备 ID 作为参数。例如，以下代码将打印设备名称：

particle.getDevice({deviceId: 'DEVICE_ID'}).then(function(device) {
  console.log('Device name:', device.name);
}, function(error) {
  console.error(error);
});

发布和订阅事件

要发布事件，请使用 publishEvent() 方法并传递事件名称、数据和可选的标记（ttl）：

particle.publishEvent({name: 'my_event', data: 'my_data', auth: 'YOUR_ACCESS_TOKEN'}).then(function(data) {
  console.log('Event published:', data);
}, function(error) {
  console.error(error);
});

要订阅事件，请使用 subscribe() 方法。以下代码将打印来自名为 "my_event" 的事件的数据：

particle.subscribe({eventName: 'my_event', auth: 'YOUR_ACCESS_TOKEN'}).then(function(stream) {
  stream.on('event', function(event) {
    console.log('Event data:', event.data);
  });
}, function(error) {
  console.error(error);
});

控制设备

要控制设备，请使用 callFunction() 方法并传递设备 ID、函数名称和参数：

particle.callFunction({deviceId: 'DEVICE_ID', name: 'my_function', argument: 'my_argument', auth: 'YOUR_ACCESS_TOKEN'}).then(function(data) {
  console.log('Function called:', data);
}, function(error) {
  console.error(error);
});

结论

在本文中，我们介绍了 Particle API JS 的基本用法。您现在应该能够使用 JavaScript 与 Particle 硬件和服务进行通信。祝您编写愉快！

参考链接：Particle API JS

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