全部產品
Search
文件中心

IoT Platform:JavaScript指令碼樣本

更新時間:Jun 30, 2024

本文提供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);
}