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