属性上报预处理规则

约 1742 字大约 6 分钟

属性上报预处理规则

属性上报预处理规则 的触发时间，是在云平台接收到硬件上报的属性，且在正式更新设备属性之前。适合用于对设备上报属性做必要的格式处理、二次计算、转化、合并等，总之可以进行任意的加工。

目前支持的操作如下：

预处理函数

提供了可编程的云函数，支持 Javascript 编程语言，如下：

module.exports = function (report_attributes) {
    /**
     * report_attributes:   上报的属性对象，同时作为函数返回值。函数中可操作属性对象。
     */
    
    return report_attributes;
}

提示

当您在消息规则中编辑云函数时，可以多多使用在线调试功能，帮助您验证代码的准确性，并提升开发速度。详细介绍请浏览：每日调用上亿次的消息规则云函数，如何在线测试？open in new window。

示例：对设备上报的属性值做一些计算处理

这是一个最简单的例子，对设备上报的 temperature 温度属性值乘一个固定的系数 0.1，我们编写预处理函数如下：

 module.exports = function (report_attributes) {
    /**
     * report_attributes:   上报的属性对象，同时作为函数返回值。函数中可操作属性对象。
     */
    
    if (report_attributes.temperature !== undefined) {
        report_attributes.temperature = report_attributes.temperature * 0.1;
    }
    
    return report_attributes;
}

当设备上报属性为：

{
    "temperature": 261
}

经过以上规则预处理后，设备上报的消息实际上变成了：

{
    "temperature": 26.1
}

示例：根据电池电压计算电池剩余容量

设备定时上报电池的原始电压值，根据电池手册中容量的计算方法，我们可以写出以下的预处理函数：

 module.exports = function (report_attributes) {
    /**
     * report_attributes:   上报的属性对象，同时作为函数返回值。函数中可操作属性对象。
     */
    
    if (report_attributes.volt !== undefined) {
        report_attributes.battery = (report_attributes.volt - 3.6) / 0.4 * 100;
    }
    
    return report_attributes;
}

以上函数中，判断设备上报的 volt 属性如果存在，则通过计算，生成一个新的属性 battery 表示电池电量百分比。

示例：记录属性上报次数

假设我们要记录设备上报湿度 humidity 的次数，可以写一个这样的预处理函数：

module.exports = function (report_attributes) {

    if (report_attributes.humidity !== undefined) {
        // 读取设备当前的属性
        var curr_attrs = Cloud.getCurrentAttributes();

        if (curr_attrs.count === undefined) {
            // 计数count不存在，说明是首次上报
            report_attributes.count = 1;
        } else {
            // 计数+1
            report_attributes.count = curr_attrs.count + 1;
        }
        
    }

    return report_attributes;

}

在此基础上，还可以改为只统计当日的上报次数，或者计算当日的湿度平均值，思考一下如何实现呢？

示例：记录设备属性上报的最后更新时间

假设我们希望在控制台或者用户 App 中，直观的显示设备最后一次上报属性的日期时间，可以通过以下的属性上报预处理函数，生成一个新的属性 last_update_time 保存日期时间，您可以将这个属性放在 ThingsX App 的设备界面上。

这里会用到另一个内置函数 Cloud.Utils.dateFormat。

module.exports = function (report_attributes) {

    report_attributes.last_update_time = Cloud.Utils.dateFormat("YYYY-MM-DD HH:mm:ss");

    return report_attributes;

}

如果我们的需求更进一步，希望记录湿度上报的最后更新时间，修改一下如下：

module.exports = function (report_attributes) {

    if (report_attributes.humidity !== undefined) {
        report_attributes.last_update_time = Cloud.Utils.dateFormat("YYYY-MM-DD HH:mm:ss");
    }

    return report_attributes;

}

ThingsCloud 还支持完善的时区设置，假设这里使用美国东部时区来生成日期时间，修改如下：

module.exports = function (report_attributes) {

    // 在函数开头设置时区
    Cloud.Utils.setTimezone("America/New_York");

    report_attributes.last_update_time = Cloud.Utils.dateFormat("YYYY-MM-DD HH:mm:ss");

    return report_attributes;

}