Particle 集成

概述
Particle集成教程
- 前提条件
- Particle Photon设置
ThingsBoard集成配置
下一步

概述

Particle是通过IoT连接多种设备的云平台。将Particle与ThingsBoard集成后，可在ThingsBoard IoT平台中连接、管理、通信、处理和可视化设备数据。

Particle集成教程

本教程使用开发板Particle Photon。您也可使用其他Particle设备连接至Particle并在ThingsBoard中获取数据。

前提条件

要获取数据，需要一个Particle控制台账户。
要发送下行数据，还需要Particle CLI来生成访问令牌。

Particle Photon设置

首先，我们需要将设备连接到Particle控制台以获取数据。
为此，请按照官方指南执行以下步骤：

为设备通电：将USB电缆插入电源。（您的电脑完全可以用于此目的。）Particle设备无需通过电脑连接Wi-Fi。
您也可以使用移动电源、电池扩展板或连接到VIN引脚的其他电源为设备供电。
插入电源后，设备上的RGB LED应开始闪烁蓝色。
如果设备没有闪烁蓝色，请长按 SETUP按钮。
使用设置Web应用将Photon连接到互联网：
- 访问 setup.particle.io
- 点击 Setup a Photon
- 点击NEXT后，将会出现一个文件（photonsetup.html）
- 打开该文件

设备连接成功后，将在Particle控制台中可见。这样您就可以创建集成以在ThingsBoard中接收数据。

设备列表

ThingsBoard集成配置

要从Particle控制台接收数据，需要在ThingsBoard上创建集成并获取Particle集成的URL。

上行数据转换器

在设置Particle集成之前，需要先创建一个上行数据转换器，这是一个用于解析和转换Particle集成接收到的数据的脚本，将其转换为ThingsBoard可以使用的格式。

要创建上行数据转换器，请进入Data Converters页面，点击Add new data converter -> Create new converter，将其命名为“Uplink data converter for Particle Integration”，并选择类型为Uplink。目前请使用调试模式。

调试模式

启用调试模式可追踪与integrations执行相关的事件、状态及潜在错误，便于开发和排障。

调试模式设置可组合使用或完全关闭。

可使用 TBEL（TBEL）或 JavaScript 开发用户自定义函数。建议使用 TBEL，其在ThingsBoard 中的执行效率远高于 JS。

TBELRecommended

JavaScript

请将以下脚本复制并粘贴到 Decoder function 区域：

// Decode an uplink message from a buffer
// payload - array of bytes
// metadata - key/value object

/** Decoder **/

// decode payload to JSON
var data = decodeToJson(payload);
if (data.coreid != "api") {
    var deviceName = data.coreid;
    var deviceType = 'Photon';
    var groupName = 'Particle devices';

    var attributes = {
        integrationName: metadata['integrationName']
    };

    var telemetry = {};

    if (data.data == 'online' || data.data == 'offline') {
        attributes.status = data.data;
    } else {
        telemetry.rawData = data.data;
    }

// Result object with device/asset attributes/telemetry data
    var result = {
// Use deviceName and deviceType or assetName and assetType, but not both.
        deviceName: deviceName,
        deviceType: deviceType,
        groupName: groupName,
        attributes: attributes,
        telemetry: telemetry
    };

    /** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/

    return result;
}

请将以下脚本复制并粘贴到 Decoder function 区域：

// Decode an uplink message from a buffer
// payload - array of bytes
// metadata - key/value object

/** Decoder **/

// decode payload to JSON
var data = decodeToJson(payload);
if (data.coreid != "api") {
    var deviceName = data.coreid;
    var deviceType = 'Photon';
    var groupName = 'Particle devices';

    var attributes = {
        integrationName: metadata['integrationName']
    };

    var telemetry = {};

    if (data.data == 'online' || data.data == 'offline') {
        attributes.status = data.data;
    } else {
        telemetry.rawData = data.data;
    }

// Result object with device/asset attributes/telemetry data
    var result = {
// Use deviceName and deviceType or assetName and assetType, but not both.
        deviceName: deviceName,
        deviceType: deviceType,
        groupName: groupName,
        attributes: attributes,
        telemetry: telemetry
    };

    /** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/

    return result;
}
/** Helper functions **/

function decodeToString(payload) {
    return String.fromCharCode.apply(String, payload);
}

function decodeToJson(payload) {
    // covert payload to string.
    var str = decodeToString(payload);

    // parse string to JSON
    var data = JSON.parse(str);
    return data;
}

下行配置（可选）

创建下行数据转换器

下行数据转换器用于转换传出的RPC消息，然后集成将其发送至您的设备。

创建另一个转换器，命名为“Downlink data converter for Particle Integration”，类型选择Downlink。要查看事件，请启用调试模式。

TBELRecommended

JavaScript

可使用我们的 Downlink Converter 示例，或根据您的配置自行编写：

/** Encoder **/

var command = {};
command["method"] = msg.method;
if (msg.params == "false" || msg.params == "true") {
    command["params"] = Boolean.valueOf(msg.params);
} else {
    command["params"] = msg.params;
}

var result = {

    // downlink data content type: JSON, TEXT or BINARY (base64 format)
    contentType: "JSON",

    // downlink data
    data: JSON.stringify(command),

    // Optional metadata object presented in key/value format
    metadata: {
            deviceId: metadata.deviceName
    }

};

return result;

可使用我们的 Downlink Converter 示例，或根据您的配置自行编写：

/** Encoder **/

var command = {};
command["method"] = msg.method;
if (msg.params == "false" || msg.params == "true") {
    command["params"] = Boolean.valueOf(msg.params);
} else {
    command["params"] = msg.params;
}

var result = {

    // downlink data content type: JSON, TEXT or BINARY (base64 format)
    contentType: "JSON",

    // downlink data
    data: JSON.stringify(command),

    // Optional metadata object presented in key/value format
    metadata: {
            deviceId: metadata.deviceName
    }

};

return result;

在Particle CLI中创建访问令牌

要向设备发送消息，需要一个访问令牌。您可以使用Particle CLI来创建它。
使用以下命令安装：

bash <( curl -sL https://particle.io/install-cli )

然后，根据官方文档，使用以下命令登录：

particle login

登录后，需要创建访问令牌。
您可以使用以下命令之一来完成：

创建永不过期的令牌（适用于集成） -

particle token create --never-expires

创建具有默认过期时间（90天）的令牌 -

particle token create

令牌已创建

保存创建的令牌，下一步将会用到。

Particle集成设置

现在，需要在ThingsBoard中创建集成。请按照以下步骤操作：

进入Integrations页面，点击Add new integration按钮。将其命名为Particle Integration，并选择类型为Particle。
现在，选择之前创建的Uplink data Converter for Particle Integration。点击Next。
如果添加了下行数据转换器，请选择它。点击Next。
如果添加了下行数据转换器并创建了令牌，请开启Allow downlink并粘贴您的访问令牌。点击Add创建集成。