本文提供JavaScript語言的物模型消息解析腳本模板和示例。

腳本模板

以下為JavaScript腳本模板,您可以基于以下模板編寫物模型消息解析腳本。

說明 本模板僅適用于數據格式透傳/自定義的產品。
/**
 *  將Alink協議的數據轉換為設備能識別的格式數據,物聯網平臺給設備下發數據時調用
 *  入參:jsonObj,對象,不能為空。
 *  出參:rawData,byte[]數組,不能為空。
 *
 */
function protocolToRawData(jsonObj) {
    return rawdata;
}

/**
 * 將設備的自定義格式數據轉換為Alink協議的數據,設備上報數據到物聯網平臺時調用。
 * 入參:rawData,byte[]數組,不能為空。
 * 出參:jsonObj,對象,不能為空。
 */
function rawDataToProtocol(rawData) {
    return jsonObj;
}
            

腳本編寫注意事項

  • 請避免使用全局變量,否則會造成執行結果不一致。
  • 腳本中,處理數據采用補碼的方式, [-128, 127]補碼范圍為[0, 255]。例如,-1對應的補碼為255(10進制表示)。
  • 解析設備上報數據的函數(rawDataToProtocol)的入參為整型數組。需要通過0xFF進行與操作,獲取其對應的補碼。
  • 解析物聯網平臺下發數據的函數(protocolToRawData)的返回結果為數組。數組元素為整型,取值為[0, 255]。

腳本示例

以下是基于提交物模型消息解析腳本中定義的屬性和通信協議編寫的腳本。

物模型消息中數據類型說明,請參見物模型支持的數據類型。物模型屬性、事件上報數據后,物聯網平臺返回的Alink格式響應結果,會通過腳本解析轉換后返回給設備。Alink數據格式說明,請參見設備屬性、事件、服務

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,設備上報屬性設置的結果到云端。
var SELF_DEFINE_TOPIC_UPDATE_FLAG = '/user/update'  //自定義Topic:/user/update。
var SELF_DEFINE_TOPIC_ERROR_FLAG = '/user/update/error' //自定義Topic:/user/update/error。
/*
示例數據:
設備上報屬性數據:
傳入參數:
    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;
}

/*
  示例數據
  自定義Topic:
     /user/update,上報數據。
  輸入參數:
     topic:/{productKey}/{deviceName}/user/update
     bytes: 0x000000000100320100000000
  輸出參數:
  {
     "prop_float": 0,
     "prop_int16": 50,
     "prop_bool": 1,
     "topic": "/{productKey}/{deviceName}/user/update"
   }
 */
function transformPayload(topic, 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 = {};

    if(topic.includes(SELF_DEFINE_TOPIC_ERROR_FLAG)) {
        jsonMap['topic'] = topic;
        jsonMap['errorCode'] = dataView.getInt8(0)
    } else if (topic.includes(SELF_DEFINE_TOPIC_UPDATE_FLAG)) {
        jsonMap['topic'] = topic;
        jsonMap['prop_int16'] = dataView.getInt16(5);
        jsonMap['prop_bool'] = uint8Array[7];
        jsonMap['prop_float'] = dataView.getFloat32(8);
    }

    return jsonMap;
}

//以下是部分輔助函數。
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);
}