このトピックでは、IoT Platform コンソールで機能を定義する方法を説明します。

手順

  1. IoT Platform コンソールにログインします。
  2. 左側のナビゲーションウィンドウで、[デバイス] > [プロダクト] をクリックします。
  3. [プロダクト] ページで、機能を定義するプロダクトを検索し、[表示] をクリックします。
  4. プロダクト詳細ページで、[機能の定義] をクリックします。
  5. 標準機能を追加します。 [標準機能] に対応する [機能の追加] ボタンをクリックし、ダイアログボックスで、プロダクトに使用できる事前定義機能を選択します。


  6. 自己定義機能を追加します。 [自己定義機能] に対応する [機能の追加] ボタンをクリックし、プロダクトのカスタマイズ機能を定義します。 プロダクトに対し、プロパティ、サービス、イベントを定義できます。


    • プロパティを定義します。 [自己定義機能の追加] ダイアログボックスで、機能タイプとして [プロパティ] を選択します。

      プロパティのパラメーターを下記の一覧表に示します。

      パラメーター 説明
      機能名

      プロパティ名 (例: 消費電力) 機能名はプロダクト内で一意である必要があります。

      機能名は、漢字、英数字で始まる必要があり、漢字、英数字、ダッシュ (-)、アンダースコア (_) を含めることができます。長さは 30 文字を超えることはできません。

      プロダクト作成中に機能テンプレートを含むカテゴリを選択していた場合、標準機能ライブラリから選択可能な標準プロパティが表示されます。

      ゲートウェイ接続プロトコルが Modbus の場合、標準プロパティはサポートされません。 代わりに、プロパティを手動で定義する必要があります。
      識別子 プロパティを識別します。 プロダクト内で一意である必要があります。 Alink JSON の識別子パラメーターで、デバイスがこのプロパティのデータを報告したときキーとして使用されます。 特に、IoT Platform はこのパラメーターを使用して、データを受信するかどうかを確認および決定します。 識別子は英数字とアンダースコア (_) を含めることができ、長さは 50 文字を超えることはできません。 (例: PowerConsumption)
      set、get、post、time、value は、システムパラメーター名のため、識別子として使用することはできません。
      データ型
      • int32: 32 ビット整数。 "int32" を選択した場合、値の範囲、ステップ、および単位を定義する必要があります。
      • float: フロート。 "float" を選択した場合、値の範囲、ステップ、および単位を定義する必要があります。
      • double: ダブルフロート。 "double" を選択した場合、値の範囲、ステップ、および単位を定義する必要があります。
      • enum: 列挙型。 列挙項目を値と説明で指定する必要があります。 (例: 1: 加熱モード、2: 冷却モード)
      • bool: ブール型。 ブール値を指定する必要があります。 値は 0 と 1 です。 たとえば、無効を 0、有効を 1 で示すことができます。
      • text: テキスト文字列。 データ長を特定する必要があります。 最大値は 2048 バイトです。
      • date: タイムスタンプ。 ミリ秒単位の UTC タイムスタンプ文字列。
      • struct: JSON 構造。 JSON 構造を定義し、新しいパラメーターを追加します。 たとえば、ランプの色を赤、緑、青の 3 つのパラメーターで構成される構造として定義できます。 構造の入れ子はサポートされていません。
      • array: 配列。 配列内の要素には、int32、float、double、text、および struct からデータ型を選択する必要があります。 1 つの配列内で、要素のデータ型は同じにし、配列の長さは 128 要素を超えないようにします。
      ゲートウェイ接続プロトコルが Modbus の場合は、このパラメーターを設定しません。
      ステップ プロパティ、イベント、およびサービスの入出力パラメーター値の変更における最小粒度。 データ型が int32、float、または double の場合、ステップが必要です。
      単位 [なし] または適切な単位を選択できます。
      読み取り/書き込みタイプ
      • 読み取り/書き込み: 読み取りまたは書き込みのリクエストに対して、GET メソッドと SET メソッドがサポートされています。
      • 読み取り専用: 読み取り専用リクエストに対しては、GET メソッドのみがサポートされています。
      ゲートウェイ接続プロトコルが Modbus の場合は、このパラメーターを設定する必要はありません。
      説明 プロパティに関する説明や備考を入力します。 100 文字まで入力できます。
      詳細情報
      ゲートウェイ接続プロトコルは Modbus です。
      • 操作タイプ: 入力ステータス (読み取り専用)、コイルステータス (読み書き)、保持レジスタ (読み書き)、入力レジスタ (読み取り専用) の中から操作タイプを選択できます。
      • レジスタアドレス: 0x で始まる 16 進数のアドレスを入力します (例: 0xFE)。 範囲は、0x0 ~ 0xFFFF です。
      • 元のデータ型: int16、uint16、int32、uint32、int64、uint64、float、double、string、bool、およびカスタマイズされたデータ (RAW データ) など、複数のデータ型がサポートされています。
      • レジスタ数: 操作タイプが入力ステータス (読み取り専用) およびコイルステータス (読み書き) に設定されている場合、レジスタの数値範囲は 1 ~ 2000 です。 操作タイプが保持レジスタ (読み書き) および入力レジスタ (読み取り専用) の場合、レジスタの数値範囲は 1 ~ 125 です。
      • レジスタの上位バイトと下位バイトの切り替え: レジスタ内の 16 ビットデータの最初の 8 ビットと最後の 8 ビットを入れ替えます。
      • レジスタビットシーケンスの切り替え: 元の 32 ビットデータのビットを交換します。
      • ズーム係数: ズーム係数はデフォルトで 1 に設定されています。 負の数に設定することができますが、0 に設定することはできません。
      • 収集間隔: データ収集の時間間隔。 ミリ秒単位で、値を 10 より小さくすることはできません。
      • データレポート: データレポートのトリガーです。 [特定の時点] または [レポートの変更] のいずれかになります。
      詳細情報
      ゲートウェイ接続プロトコルは OPC UA です。
      ノード名です。プロパティ内で一意である必要があります。
    • サービスを定義します。 [自己定義機能の追加] ダイアログボックスで、機能タイプとして [サービス] を選択します。

      サービスのパラメーターは次のとおりです。

      パラメーター 説明
      機能名

      サービス名です。

      機能名は、英数字または漢字で始める必要があります。 英数字、漢字、ダッシュ (-)、アンダースコア (_) を含めることができ、長さは 30 文字を超えることはできません。

      プロダクト作成中に機能テンプレートを含むカテゴリを選択していた場合、システムは標準機能ライブラリから選択可能な標準プロパティを表示します。

      ゲートウェイ接続プロトコルが Modbus の場合、プロダクトにカスタマイズサービスを定義することはできません。
      識別子 サービスを識別します。 プロダクト内で一意である必要があります。 Alink JSON TSL 内の [識別子] パラメーターです。 このサービスが呼び出されると、キーとして使用されます。 識別子は、英字、数字、アンダースコア (_) を含めることができ、長さは 30 文字を超えることはできません。
      set、get、post、time、value は、システムパラメーター名のため、識別子として使用することはできません。
      呼び出し方式
      • 非同期: 非同期呼び出しの場合、IoT Platform はリクエストが送信された直後に結果を返します。デバイスからの応答は待ちません。
      • 同期: 同期呼び出しの場合、クラウドはデバイスからの応答を待ちます。 応答が受信されない場合、呼び出しはタイムアウトします。
      入力パラメーター サービスに入力パラメーターを設定します (省略可)。

      [パラメーターの追加] をクリックし、表示されるダイアログボックスで入力パラメーターを追加します。

      ゲートウェイ接続プロトコルが "OPC UA" の場合、パラメーターの順序をマークするために使用されるパラメーターインデックスを設定する必要があります。

      • プロパティを入力パラメーターとして選択することも、入力パラメーターを定義することもできます。 たとえば、Sprinkling_Interval プロパティと Sprinkling_Amount プロパティを Automatic_Sprinkler サービス機能の入力パラメーターとして指定します。 その場合、Automatic_Sprinkle が呼び出されると、スプリンクラーは散水間隔 (Sprinkling_Interval) と散水量 (Sprinkling_Amount) に従って自動的に散水を開始します。
      • set、get、post、time、value は、システムパラメーター名のため、入力パラメーターの識別子として使用することはできません。
      • 1 つのサービスに対して最大 20 個の入力パラメーターを追加します。
      出力パラメーター サービスに出力パラメーターを設定します (省略可)。

      [パラメーターの追加] をクリックし、表示されるダイアログボックスで出力パラメーターを追加します。

      ゲートウェイ接続プロトコルが OPC UA の場合、パラメーターの順序をマークするために使用されるパラメーターインデックスを設定する必要があります。

      • プロパティを出力パラメーターとして選択することも、出力パラメーターを定義することもできます。 たとえば、出力パラメーターとして SoilHumidity を指定します。 その場合、Automatic Sprinkler サービスが呼び出されると、IoT Platform は土壌湿度に関するデータを返します。
      • set、get、post、time、value は、システムパラメーター名のため、入力パラメーターの識別子として使用することはできません。
      • 1 つのサービスに対して最大 20 個の出力パラメーターを追加できます。
      詳細情報
      ゲートウェイ接続プロトコルは OPC UA です。
      ノード名です。サービス内で一意である必要があります。
      説明 サービスについての説明や備考を入力します。 100 文字まで入力できます。
    • イベントを定義します。 [自己定義機能の追加] ダイアログボックスで、機能タイプとして [イベント] をクリックします。

      イベントのパラメーターは次のとおりです。

      パラメーター 説明
      機能名

      イベント名です。

      機能名は、漢字、英字、または数字で始める必要があります。漢字、英字、数字、ダッシュ (-)、および下線 (_) を含めることができ、長さは 30 文字を超えることはできません。

      ゲートウェイ接続プロトコルが Modbus の場合は、イベントを定義できません。
      識別子 イベントを識別します。 プロダクト内で一意である必要があります。 Alink JSON TSL 内の [識別子] パラメーターで、デバイスがこのイベントのデータを報告するときにキーとして使用されます (例: ErrorCode)。
      set、get、post、time、value は、システムパラメーター名のため、入力パラメーターの識別子として使用することはできません。
      イベントタイプ
      • Info: デバイスによって報告される一般的な通知 (特定のタスクの完了など) を表します。
      • Alert: 予期しないまたは異常なイベントが発生したときにデバイスによって報告される警告を示します。 優先度は高めです。 イベントタイプに応じて、ロジックの処理や分析を実行できます。
      • Error: 予期しないまたは異常なイベントが発生したときにデバイスによって報告されるエラーを示します。 優先度は高めです。 イベントタイプに応じて、ロジックの処理や分析を実行できます。
      出力パラメーター イベントの出力パラメーターです。 [パラメーターの追加] をクリックし、表示されるダイアログボックスで出力パラメーターを追加します。 プロパティを出力パラメーターとして選択することも、出力パラメーターを定義することもできます。 たとえば、出力パラメーターとして Voltage を指定します。 この場合、デバイスは、故障診断のために現在の電圧値とともにエラーを報告します。

      ゲートウェイ接続プロトコルが OPC UA の場合、パラメーターの順序をマークするために使用されるパラメーターインデックスを設定する必要があります。

      • set、get、post、time、value は、システムパラメーター名のため、入力パラメーターの識別子として使用することはできません。
      • 1 つのイベントに対して最大 20 個の出力パラメーターを追加できます。
      詳細情報
      ゲートウェイ接続プロトコルは OPC UA です。
      ノード名です。イベント内で一意である必要があります。
      説明 イベントについての説明または備考を入力します。 100 文字まで入力できます。