すべてのプロダクト
Search
ドキュメントセンター

IoT Platform:PHP サンプルスクリプト

最終更新日:Mar 26, 2025

このトピックでは、TSL (Thing Specification Language) メッセージの解析に使用できる PHP スクリプトテンプレートと PHP サンプルスクリプトについて説明します。

スクリプトテンプレート

次のスクリプトテンプレートに基づいて PHP スクリプトを作成し、TSL メッセージを解析できます。

説明 このスクリプトテンプレートは、[データ型] パラメーターが [カスタム] に設定されている製品にのみ適用されます。
<?php
/**
 * IoT Platform がダウンストリームデータを送信するときに、Alink JSON データをデバイスが認識できるデータに変換します。
 * $jsonObj: 入力パラメーター。値は、連想配列を示す JSON オブジェクトです。
 * $rawData: 出力パラメーター。値は、値の範囲が [0,255] の整数の配列です。配列要素は空にできません。
 */
function protocolToRawData($jsonObj)
{
    $rawData = array();
    return $rawData;
}

/**
 * デバイスが IoT Platform にデータを送信するときに、デバイスのカスタムデータを Alink JSON データに変換します。
 * $rawData: 入力パラメーター。値は整数の配列です。
 * $jsonObj: 出力パラメーター。値は、連想配列を示す JSON オブジェクトです。各キーの値は文字列である必要があります。ただし、文字列は 10 などの数字だけで構成することはできません。キー値は空にできません。
 */
function rawDataToProtocol($rawData)
{
    $jsonObj = array();
    return $jsonObj;
}

/**
 * デバイスが IoT Platform にデータを送信するときに、デバイスがカスタムトピックに送信するデータを変換します。JSONデータに変換します。
 * $topic: デバイスがメッセージを送信するトピックを指定する入力パラメーター。値は文字列です。
 * $rawData: 入力パラメーター。値は整数の配列です。
 * $jsonObj: 出力パラメーター。値は、連想配列を示す JSON オブジェクトです。各キーの値は文字列である必要があります。ただし、文字列は 10 などの数字だけで構成することはできません。キー値は空にできません。
 */
function transformPayload($topic, $rawData)
{
    $jsonObj = array();
    return $jsonObj;
}

スクリプト作成の注意事項

  • グローバル変数または静的変数は使用しないでください。そうしないと、結果に一貫性がなくなる可能性があります。
  • スクリプトは、2 の補数演算を使用してデータを処理するために使用されます。[-128,127] の範囲の値の補数の範囲は [0,255] です。たとえば、-1 の補数は 10 進数で 255 です。
  • rawDataToProtocol 関数は、デバイスによって送信されたメッセージを解析します。関数の入力パラメーターは整数配列です。0xFF をビット単位の AND 演算に使用して、補数を取得します。返される結果は連想配列です。各 キー 値には、配列以外の文字が含まれている必要があります。たとえば、キー 値が 10 の場合、PHP 配列は整数 10 を取得します。
  • protocolToRawData 関数は、IoT Platform によって送信されたダウンストリームメッセージを解析し、配列を返します。配列は共通の PHP 配列である必要があります。配列の各要素は、値の範囲が [0,255] の整数である必要があります。
  • transformPayload 関数は、カスタムトピックに送信されたデータを解析します。関数の入力パラメーターは整数配列です。0xFF をビット単位の AND 演算に使用して、補数を取得します。返される結果は連想配列です。各 キー 値には、配列以外の文字が含まれている必要があります。たとえば、キー 値が 10 の場合、PHP 配列は整数 10 を取得します。
  • PHP ランタイム環境は、例外処理に関して非常に厳格です。エラーが発生した場合、後続のロジックは実装されません。コードの堅牢性を確保するために、エラーをキャプチャして処理する必要があります。

サンプルスクリプト

次のサンプルスクリプトは、「TSL データを解析するスクリプトを送信する」トピックで定義されているプロパティとプロトコルに基づいて記述されています。

TSL モデルでサポートされているデータ型の詳細については、「サポートされているデータ型」をご参照ください。デバイスが TSL プロパティデータまたはイベントデータを送信した後、IoT Platform は Alink JSON 形式のデータを含むレスポンスを生成します。IoT Platform は、レスポンスをデバイスに送信する前に、スクリプトを使用してデータの形式をデバイスが認識できる形式に変換します。Alink JSON 形式の詳細については、「デバイスのプロパティ、イベント、およびサービス」をご参照ください。

<?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]; // コマンドフィールド。
    if ($fHead == 0x00) {
        $jsonMap['method'] = 'thing.event.property.post '; // プロパティを送信するために使用されるトピック。データ形式: Alink JSON。
        $jsonMap['version'] = '1.0'; // プロトコルのバージョン。この値は固定です。データ形式: Alink JSON。
        $jsonMap['id'] = '' . getInt32($data, 1); // リクエストの ID。データ形式: Alink JSON。
        $params = [];
        $params['prop_int16'] = getInt16($data, 5); // 製品の prop_int16 プロパティの値。
        $params['prop_bool'] = $data[7]; // 製品の prop_bool プロパティの値。
        $jsonMap['params'] = params; // params フィールド。データ形式: Alink JSON。
    } else if ($fHead == 0x03) {
        $jsonMap['version'] = '1.0'; // プロトコルのバージョン。この値は固定です。データ形式: Alink JSON。
        $jsonMap['id'] = '' . getInt32($data, 1); // リクエストの ID。データ形式: Alink JSON。
        $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'];
        // カスタムプロトコル形式に基づいて生データを連結します。
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex(0x01))); // コマンドフィールド。
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex(intval($id)))); // リクエストの ID。データ形式: Alink JSON。
        $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))); // コマンドフィールド。
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex(intval($id)))); // リクエストの ID。データ形式: Alink JSON。
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex($code)));
    } else { // 不明なコマンド。コマンドは実行されません。
        $code = $json['code'];
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex(0xff))); // コマンドフィールド。
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex(intval($id)))); // リクエストの ID。データ形式: Alink JSON。
        $payloadArray = concat($payloadArray, hexStringToByteArray(toHex($code)));
    }
    return $payloadArray;
}

/*
  サンプルデータ:
  次のカスタムトピックを使用してデータを送信します。
     /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;
}