IoT Platform:TSL モデルのよくある質問

症状

IoT Platform コンソールでプロダクトの TSL モデルをインポートする際、[TSL モデルのインポート] ダイアログボックスで 2 種類の検証失敗が発生する可能性があります。1 つは、即座に表示されるエラーメッセージ "The file content is not in a valid JSON format" で、もう 1 つは、詳細なエラー情報を取得するための [ダウンロードして表示] リンクが付いた検証例外です。

ソリューション

以下のソリューションは、2 種類の検証失敗に対応しています：

• TSL モデルファイルを確認し、JSON 形式のエラーを修正してから、ファイルを再アップロードします。

• [ダウンロードして表示] をクリックして、errors.txt ファイルを取得します。このファイルを使用して問題を特定し、解決します。

  errors.txt ファイルの詳細については、以下の例をご参照ください。

  TSL モデルファイルのサンプル：

  {
      "schema":"https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json",
      "profile":{
          "productKey":"a1Jk***"
      },
      "services":[],
      "properties": 1,
      "events": [],
      "functionBlockId": "module-test",
      "functionBlockName": "Custom Module 1"
  }

  ダウンロードした errors.txt ファイル：

  [
    {
      "path": [
        "properties"
      ],
      "property": "instance.properties",
      "message": "is not of a type(s) array",
      "schema": {
        "type": "array",
        "items": {
          "$ref": "#/definitions/propertyDefinition"
        }
      },
      "instance": 1,
      "name": "type",
      "argument": [
        "array"
      ],
      "stack": "instance.properties is not of a type(s) array"
    },
    {
      "path": [
        "functionBlockId"
      ],
      "property": "instance.functionBlockId",
      "message": "does not match pattern \"^[_a-zA-Z0-9]{1,30}$\"",
      "schema": {
        "type": "string",
        "pattern": "^[_a-zA-Z0-9]{1,30}$"
      },
      "instance": "module-test",
      "name": "pattern",
      "argument": "^[_a-zA-Z0-9]{1,30}$",
      "stack": "instance.functionBlockId does not match pattern \"^[_a-zA-Z0-9]{1,30}$\""
    }
  ]

  パラメーター	説明
  path	検証エラーの原因となった要素へのパスです。この例では、2 つのエラーが見つかりました： // properties パラメーターが正しく設定されていません。配列ではありません。 "path": [ "properties" ] // functionBlockId の値にハイフンが含まれていますが、これは無効です。 "path": [ "functionBlockId" ]
  property	パスで指定された、ルールに違反している特定のオブジェクトです。 たとえば、"path": ["functionBlockId" ] のプロパティは instance.functionBlockId です。
  message	具体的なエラーメッセージです。 たとえば、"path": ["functionBlockId" ] の場合、プロパティのエラーメッセージは does not match pattern \"^[_a-zA-Z0-9]{1,30}$\" です。
  schema	検証ルールの名前と内容です。 たとえば、"path": ["functionBlockId" ] の場合、ルールは type と pattern です。 ルールの定義に関する詳細については、「JSON Schema」をご参照ください。
  instance	検証対象の特定のオブジェクトです。 たとえば、"path": ["functionBlockId" ] の場合、TSL モデルファイル内の "functionBlockId": "module-test" の内容が検証されます。
  name	検証に失敗したルールの名前です。 たとえば、"path": ["functionBlockId" ] の場合、オブジェクト module-test は pattern ルールに準拠していません。
  argument	違反したルールの定義です。 たとえば、"path": ["functionBlockId" ] の場合、満たされなかった pattern ルールは ^[_a-zA-Z0-9]{1,30}$ として定義されています。
  stack	property フィールドと message フィールドを組み合わせた完全なエラーメッセージです。

詳細については、「jsonschema ドキュメント」をご参照ください。

機能的な違い

プロパティデータ、履歴データ、またはプロパティの一括データが IoT Platform に報告されると、プラットフォームはタイムスタンプに基づいて履歴データレコードを生成します。

通信トピックとデータ形式の違い

トピックとデータ形式は、各方法で異なります。詳細については、「デバイスによるプロパティの報告」、「履歴 TSL モデルデータの報告」、および「デバイスによるプロパティの一括報告」をご参照ください。

例

この例では、温度データを報告するデバイスを使用します。

• プロパティの報告：

  1. デバイスは、次の表に示すように、タイムスタンプ付きのスナップショットデータを左から右へ順番に報告します。

     13:00	14:00	15:00	15:10
     60	70	80	90

  2. 次に、デバイスは別のスナップショット値 100 を報告します。データは、タイムスタンプが含まれているかどうかに基づいて、異なる方法で更新されます：

     • タイムスタンプなし：時刻はデフォルトで現在の時刻 (例：15:30) に設定されます。この場合、IoT Platform コンソールに表示されるスナップショット値は 15:30 時点の 100 であり、履歴データリストの最新のエントリも 15:30 時点の 100 になります。

     • タイムスタンプあり：タイムスタンプが 15:00 の場合、15:00 のデータは 100 に更新されます。IoT Platform コンソールに表示されるスナップショット値は 15:00 時点の 100 になりますが、履歴データリストの最新のエントリは 15:10 時点の 90 のままです。

• 履歴データの報告：

  1. デバイスは、次の履歴データを同時に報告します。

     13:00	14:00	15:00	15:10
     60	70	80	90

  2. 次に、デバイスは次の履歴データを同時に報告します。

     13:10	14:10
     100	200

     この場合、IoT Platform コンソールに表示されるスナップショット値は、どちらの値が最後にデータベースに書き込まれたかに応じて、13:10 時点の 100 または 14:10 時点の 200 のいずれかになります。履歴データリストの最新のエントリは 15:10 時点の 90 のままです。