全部產品
Search
文件中心

IoT Platform:PHP指令碼樣本

更新時間:Jun 30, 2024

本文提供PHP語言的物模型訊息解析指令碼模板和樣本。

指令碼模板

您可以基於以下PHP指令碼模板編寫訊息解析指令碼。

說明 本模板僅適用於資料格式透傳/自訂的產品。
<?php
/**
 *  將Alink協議的資料轉換為裝置能識別的格式資料,物聯網平台給裝置下發資料時調用。
 *  入參:$jsonObj,關聯陣列。
 *  出參:$rawData,普通數組,數組元素為整數,取值範圍為0~255,不可為空。
 */
function protocolToRawData($jsonObj)
{
    $rawData = array();
    return $rawData;
}

/**
 * 將裝置的自訂格式資料轉換為Alink協議的資料,裝置上報資料到物聯網平台時調用。
 * 入參:$rawData,普通數組,數組元素為整數。
 * 出參:$jsonObj,關聯陣列,數組key取值為英文字串,不能是字元類型的數字,如"10",不可為空。
 */
function rawDataToProtocol($rawData)
{
    $jsonObj = array();
    return $jsonObj;
}

/**
 * 將裝置自訂Topic資料轉換為JSON格式資料,裝置上報資料到物聯網平台時調用。
 * 入參:$topic,字串,裝置上報訊息的Topic。
 * 入參:$rawData,普通數組,數組元素為整數。
 * 出參:$jsonObj,關聯陣列,數組key取值為英文字串,不能是字元類型的數字,如"10",不可為空。
 */
function transformPayload($topic, $rawData)
{
    $jsonObj = array();
    return $jsonObj;
}

指令碼編寫注意事項

  • 請避免使用全域變數或者static變數,否則會造成執行結果不一致。
  • 指令碼中,處理資料採用補碼的方式,[-128, 127]補碼範圍為[0, 255]。例如,-1對應的補碼為255(10進位表示)。
  • 解析裝置上報訊息的函數(rawDataToProtocol)的入參為整型數組。需要通過0xFF進行與操作,擷取其對應的補碼。返回結果為關聯陣列,要求key取值包含非數組字元(如數組key為“10”,PHP數組中會擷取到整數10)。
  • 解析物聯網平台下發訊息的函數(protocolToRawData)的返回結果為數組,要求為PHP普通數組。數組元素為整型,取值範圍為0~255。
  • 自訂協議解析的函數(transformPayload)的入參為整型數組。需要通過0xFF進行與操作,擷取其對應的補碼。返回結果為關聯陣列,要求key取值包含非數組字元(如數組key為“10”,PHP數組中會擷取到整數10)。
  • PHP執行環境對於異常處理會很嚴格,如發生錯誤會直接拋出異常,後續代碼不會執行。保證代碼的健壯性,對於異常需要捕獲並進行處理。

指令碼樣本

以下是基於提交物模型訊息解析指令碼中定義的屬性和通訊協定編寫的指令碼。

物模型訊息中資料類型說明,請參見物模型支援的資料類型。物模型屬性、事件上報資料後,物聯網平台返回的Alink格式響應結果,會通過指令碼解析轉換後返回給裝置。Alink資料格式說明,請參見裝置屬性、事件、服務

<?php
/*
樣本資料:
裝置上報資料:
傳入參數:
    0x0000000001003201
輸出結果:
    {"method":"thing.event.property.post","id":"1","params":{"prop_int16":50,"prop_bool":1},"version":"1.0"}

屬性設定的返回結果:
傳入參數:
    0x0300223344c8
輸出結果:
    {"code":"200","id":"2241348","version":"1.0"}
*/
function rawDataToProtocol($bytes)
{
    $data = [];
    $length = count($bytes);
    for ($i = 0; $i < $length; $i++) {
        $data[$i] = $bytes[$i] & 0xff;
    }

    $jsonMap = [];
    $fHead = $data[0]; //command欄位。
    if ($fHead == 0x00) {
        $jsonMap['method'] = 'thing.event.property.post'; //ALink JSON格式,屬性上報topic。
        $jsonMap['version'] = '1.0'; //ALink JSON格式,協議版本號碼固定欄位。
        $jsonMap['id'] = '' . getInt32($data, 1); //ALink JSON格式,標示該次請求id值。
        $params = [];
        $params['prop_int16'] = getInt16($data, 5); //對應產品屬性中prop_int16。
        $params['prop_bool'] = $data[7]; //對應產品屬性中prop_bool。
        $jsonMap['params'] = $params; //ALink JSON格式,params標準欄位。
    } else if ($fHead == 0x03) {
        $jsonMap['version'] = '1.0'; //ALink JSON格式,協議版本號碼固定欄位。
        $jsonMap['id'] = '' . getInt32($data, 1); //ALink JSON格式,標示該次請求id值。
        $jsonMap['code'] = getInt8($data, 5);
    }

    return $jsonMap;
}

/*
樣本資料:
屬性設定:
傳入參數:
    {"method":"thing.service.property.set","id":"12345","version":"1.0","params":{"prop_int16":333, "prop_bool":1}}
輸出結果:
    0x013039014d01

裝置上報的返回結果:
傳入資料:
    {"method":"thing.event.property.post","id":"12345","version":"1.0","code":200,"data":{}}
輸出結果:
    0x023039c8
*/
function protocolToRawData($json)
{
    $method = $json['method'];
    $id = $json['id'];
    $version = $json['version'];
    $payloadArray = [];
    if ($method == 'thing.service.property.set') //屬性設定。
    {
        $params = $json['params'];
        $prop_int16 = $params['prop_int16'];
        $prop_bool = $params['prop_bool'];
        //按照自訂協議格式拼接rawData。
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex(0x01))); //command欄位。
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex(intval($id)))); //ALink JSON格式'id'。
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex($prop_int16))); //屬性'prop_int16'的值。
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex($prop_bool))); //屬性'prop_bool'的值。
    } else if ($method == 'thing.event.property.post') { //裝置上報資料返回結果。
        $code = $json['code'];
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex(0x02))); //command欄位。
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex(intval($id)))); //ALink JSON格式'id'。
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex($code)));
    } else { //未知命令,對於這些命令不做處理。
        $code = $json['code'];
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex(0xff))); //command欄位。
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex(intval($id)))); //ALink JSON格式'id'。
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex($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)
{
    $data = array();
    $length = count($bytes);
    for ($i = 0; $i < $length; $i++) {
        $data[$i] = $bytes[$i] & 0xff;
    }

    $jsonMap = array();

    if (strpos($topic, '/user/update/error') !== false) {
        $jsonMap['topic'] = $topic;
        $jsonMap['errorCode'] = getInt8($data, 0);
    } else if (strpos($topic, '/user/update') !== false) {
        $jsonMap['topic'] = $topic;
        $jsonMap['prop_int16'] = getInt16($data, 5);
        $jsonMap['prop_bool'] = $data[7];
    }

    return $jsonMap;
}

function getInt32($bytes, $index)
{
    $array = array($bytes[$index], $bytes[$index + 1], $bytes[$index + 2], $bytes[$index + 3]);

    return hexdec(byteArrayToHexString($array));
}

function getInt16($bytes, $index)
{
    $array = array($bytes[$index], $bytes[$index + 1]);

    return hexdec(byteArrayToHexString($array));
}

function getInt8($bytes, $index)
{
    $array = array($bytes[$index]);
    return hexdec(byteArrayToHexString($array));
}

function byteArrayToHexString($data)
{
    $hexStr = '';
    for ($i = 0; $i < count($data); $i++) {
        $hexValue = dechex($data[$i]);

        $tempHexStr = strval($hexValue);

        if (strlen($tempHexStr) === 1) {
            $hexStr = $hexStr . '0' . $tempHexStr;
        } else {
            $hexStr = $hexStr . $tempHexStr;
        }
    }

    return $hexStr;
}

function hexStringToByteArray($hex)
{
    $result = array();
    $index = 0;
    for ($i = 0; $i < strlen($hex) - 1; $i += 2) {
        $result[$index++] = hexdec($hex[$i] . $hex[$i + 1]);
    }
    return $result;
}


function concat($array, $data)
{
    return array_merge($array, $data);
}

function toHex($data)
{
    $var = dechex($data);
    $length = strlen($var);
    if ($length % 2 == 1) {
        $var = '0' . $var;
    }
    return $var;
}