本文以解析上下行属性数据的脚本为例,介绍数据解析脚本的编辑和测试过程,并提供一个脚本示例。

步骤一:编辑脚本

  1. 物联网平台控制台,创建产品,数据格式选择为透传/自定义格式。
  2. 为该产品定义物模型。请参见新增物模型中,“自定义属性”章节。

    本示例中定义了以下三个属性。

    标识符(identifer) 数据类型 取值范围 读写类型
    prop_float 浮点单精度 float -100~100 读写
    prop_int16 整数型 int32 -100~100 读写
    prop_bool 布尔型 bool 0:开;1:关 读写
  3. 在设备通信协议中做如下定义:
    表 1. 设备上报数据请求
    字段 字节数
    帧类型 1字节
    请求ID 4字节
    属性prop_int16 2字节
    属性prop_bool 1字节
    属性prop_float 4字节
    表 2. 设备上报数据响应
    字段 字节数
    帧类型 1字节
    请求ID 4字节
    结果code 1字节
    表 3. 设置属性请求
    字段 字节数
    帧类型 1字节
    请求ID 4字节
    属性prop_int16 2字节
    属性prop_bool 1字节
    属性prop_float 4字节
    表 4. 属性设置响应
    字段 字节数
    帧类型 1字节
    请求ID 4字节
    结果code 1字节
  4. 编写脚本。

    在物联网平台控制台,产品详情页的数据解析页签下,编写脚本。

    脚本中需定义以下两个方法:

    • 将Alink JSON格式数据转为设备自定义数据格式:protocolToRawData
    • 将设备自定义数据格式转Alink JSON格式数据:rawDataToProtocol

    完整的示例脚本Demo,请参见本文附录:示例脚本。



步骤二:在线测试脚本

脚本编辑完成后,使用模拟数据在线测试脚本。

  • 模拟解析设备上报的属性数据。

    选择模拟类型为设备上报数据,输入以下模拟的设备上报数据,然后单击运行

    0x00002233441232013fa00000

    数据解析引擎会按照脚本规则,将透传数据转换为JSON格式数据。运行结果栏将显示解析结果。

    {
        "method": "thing.event.property.post", 
        "id": "2241348", 
        "params": {
            "prop_float": 1.25, 
            "prop_int16": 4658, 
            "prop_bool": 1
        }, 
        "version": "1.0"
    }
  • 模拟解析物联网平台下发的返回结果数据。

    选择模拟类型为设备接收数据,输入以下JSON格式数据,然后单击运行

    {
      "id": "12345",
      "version": "1.0",
      "code": 200,
      "method": "thing.event.property.post",
      "data": {}
    }

    数据解析引擎会将JSON格式数据转换为以下数据。

    0x0200003039c8
  • 模拟解析物联网平台下发的属性设置数据。

    选择模拟类型为设备接收数据,输入以下JSON格式数据,然后单击运行

    {
        "method": "thing.service.property.set", 
        "id": "12345", 
        "version": "1.0", 
        "params": {
            "prop_float": 123.452, 
            "prop_int16": 333, 
            "prop_bool": 1
        }
    }

    数据解析引擎会将JSON格式数据转换为以下数据。

    0x0100003039014d0142f6e76d
  • 模拟解析设备返回的属性设置结果数据。

    选择模拟类型为设备上报数据,输入以下数据,然后单击运行

    0x0300223344c8

    数据解析引擎会将透传数据转换为以下JSON格式数据。

    {
      "code": "200",
      "data": {},
      "id": "2241348",
      "version": "1.0"
    }

若脚本不正确,运行结果栏将显示报错信息。您需根据报错信息,查找错误,并修改脚本代码。



步骤三:提交脚本

确认脚本可以正确解析数据后,单击提交,将该脚本提交到物联网平台系统,以供数据上下行时,物联网平台调用该脚解析数据。

说明 仅提交后的脚本才能被物联网平台调用;草稿状态的脚本不能被调用。


步骤四:使用真实设备调试

正式使用脚本之前,请使用真实设备与物联网平台进行上下行消息通信,以验证物联网平台能顺利调用脚本,解析上下行数据。

调试方法:

  • 测试上报属性数据

    1. 使用设备端上报设备属性数据,如0x00002233441232013fa00000

    2. 在物联网平台控制台,该设备的设备详情运行状态页签下,查看是否有相应的属性数据。
  • 测试下发属性数据

    1. 在物联网平台控制台,选择监控运维 > 在线调试

    2. 选择要调试的产品和设备,并选择调试真实设备,功能选择为要调试的属性identifier,如属性(prop_int16),方法选择为设置,输入以下数据,单击发送指令

      {
          "method": "thing.service.property.set", 
          "id": "12345", 
          "version": "1.0", 
          "params": {
              "prop_float": 123.452, 
              "prop_int16": 333, 
              "prop_bool": 1
          }
      }
    3. 查看设备端是否收到该属性设置指令。

    4. 在该设备的设备详情运行状态页签下,查看设备是否上报当前属性数据。

附录:示例脚本

根据脚本示例Demo如下:

var COMMAND_REPORT = 0x00; //属性上报
var COMMAND_SET = 0x01; //属性设置
var COMMAND_REPORT_REPLY = 0x02; //上报数据返回结果
var COMMAND_SET_REPLY = 0x03; //属性设置设备返回结果
var COMMAD_UNKOWN = 0xff;    //未知的命令
var ALINK_PROP_REPORT_METHOD = 'thing.event.property.post'; //物联网平台Topic, 设备上传属性数据到云端
var ALINK_PROP_SET_METHOD = 'thing.service.property.set'; //物联网平台Topic, 云端下发属性控制指令到设备端
var ALINK_PROP_SET_REPLY_METHOD = 'thing.service.property.set'; //物联网平台Topic, 设备上报属性设置的结果到云端
/*
示例数据:
设备上报数据
传入参数 ->
    0x000000000100320100000000
输出结果 ->
    {"method":"thing.event.property.post","id":"1","params":{"prop_float":0,"prop_int16":50,"prop_bool":1},"version":"1.0"}

属性设置的返回结果
传入参数 ->
    0x0300223344c8
输出结果 ->
    {"code":"200","data":{},"id":"2241348","version":"1.0"}
*/
function rawDataToProtocol(bytes) {
    var uint8Array = new Uint8Array(bytes.length);
    for (var i = 0; i < bytes.length; i++) {
        uint8Array[i] = bytes[i] & 0xff;
    }
    var dataView = new DataView(uint8Array.buffer, 0);
    var jsonMap = new Object();
    var fHead = uint8Array[0]; // command
    if (fHead == COMMAND_REPORT) {
        jsonMap['method'] = ALINK_PROP_REPORT_METHOD; //ALink JSON格式 - 属性上报topic
        jsonMap['version'] = '1.0'; //ALink JSON格式 - 协议版本号固定字段
        jsonMap['id'] = '' + dataView.getInt32(1); //ALink JSON格式 - 标示该次请求id值
        var params = {};
        params['prop_int16'] = dataView.getInt16(5); //对应产品属性中 prop_int16
        params['prop_bool'] = uint8Array[7]; //对应产品属性中 prop_bool
        params['prop_float'] = dataView.getFloat32(8); //对应产品属性中 prop_float
        jsonMap['params'] = params; //ALink JSON格式 - params标准字段
    } else if(fHead == COMMAND_SET_REPLY) {
        jsonMap['version'] = '1.0'; //ALink JSON格式 - 协议版本号固定字段
        jsonMap['id'] = '' + dataView.getInt32(1); //ALink JSON格式 - 标示该次请求id值
        jsonMap['code'] = ''+ dataView.getUint8(5);
        jsonMap['data'] = {};
    }

    return jsonMap;
}
/*
示例数据:
属性设置
传入参数 ->
    {"method":"thing.service.property.set","id":"12345","version":"1.0","params":{"prop_float":123.452, "prop_int16":333, "prop_bool":1}}
输出结果 ->
    0x0100003039014d0142f6e76d

设备上报的返回结果
传入数据 ->
    {"method":"thing.event.property.post","id":"12345","version":"1.0","code":200,"data":{}}
输出结果 ->
    0x0200003039c8
*/
function protocolToRawData(json) {
    var method = json['method'];
    var id = json['id'];
    var version = json['version'];
    var payloadArray = [];
    if (method == ALINK_PROP_SET_METHOD) // 属性设置
    {
        var params = json['params'];
        var prop_float = params['prop_float'];
        var prop_int16 = params['prop_int16'];
        var prop_bool = params['prop_bool'];
        //按照自定义协议格式拼接 rawData
        payloadArray = payloadArray.concat(buffer_uint8(COMMAND_SET)); // command字段
        payloadArray = payloadArray.concat(buffer_int32(parseInt(id))); // ALink JSON格式 'id'
        payloadArray = payloadArray.concat(buffer_int16(prop_int16)); // 属性'prop_int16'的值
        payloadArray = payloadArray.concat(buffer_uint8(prop_bool)); // 属性'prop_bool'的值
        payloadArray = payloadArray.concat(buffer_float32(prop_float)); // 属性'prop_float'的值
    } else if (method ==  ALINK_PROP_REPORT_METHOD) { //设备上报数据返回结果
        var code = json['code'];
        payloadArray = payloadArray.concat(buffer_uint8(COMMAND_REPORT_REPLY)); //command字段
        payloadArray = payloadArray.concat(buffer_int32(parseInt(id))); // ALink JSON格式 'id'
        payloadArray = payloadArray.concat(buffer_uint8(code));
    } else { //未知命令,对于有些命令不做处理
        var code = json['code'];
        payloadArray = payloadArray.concat(buffer_uint8(COMMAD_UNKOWN)); //command字段
        payloadArray = payloadArray.concat(buffer_int32(parseInt(id))); // ALink JSON格式 'id'
        payloadArray = payloadArray.concat(buffer_uint8(code));
    }
    return payloadArray;
}
//以下是部分辅助函数
function buffer_uint8(value) {
    var uint8Array = new Uint8Array(1);
    var dv = new DataView(uint8Array.buffer, 0);
    dv.setUint8(0, value);
    return [].slice.call(uint8Array);
}
function buffer_int16(value) {
    var uint8Array = new Uint8Array(2);
    var dv = new DataView(uint8Array.buffer, 0);
    dv.setInt16(0, value);
    return [].slice.call(uint8Array);
}
function buffer_int32(value) {
    var uint8Array = new Uint8Array(4);
    var dv = new DataView(uint8Array.buffer, 0);
    dv.setInt32(0, value);
    return [].slice.call(uint8Array);
}
function buffer_float32(value) {
    var uint8Array = new Uint8Array(4);
    var dv = new DataView(uint8Array.buffer, 0);
    dv.setFloat32(0, value);
    return [].slice.call(uint8Array);
}

相关文档