各種共通仕様

本チュートリアルでは、 IoT Connect Gateway の各種設定のうち、共通のものをご説明します。

1. ヘッダ情報

各社クラウドサービスおよび IoT Connect Gateway の設定画面で名称は違いますが、同様の設定となります。

グループ詳細情報設定では、下記のオプションを有効にすることで、ヘッダ情報を付与することが出来ます。


1.1 設定画面での名称

  • メタデータ操作
    • 「Google Cloud Pub/Sub」
    • 「AWS Lambda」
    • 「ストレージ」
  • ヘッダ設定
    • 「Azure Event Hubs」
    • 「スタンダード(HTTPプロトコル)」
    • 「Things Cloud(HTTP)」
  • オプション
    • 「スタンダード(MQTTプロトコル)」

      ※付与の順番などの詳細については、後述の「付録」を参照ください。


1.2 詳細

ヘッダ情報
  • IMSI付与

    有効にするとIMSIがメタデータとして送信されます(初期値:有効)

  • IMEI付与

    有効にするとIMEIがメタデータとして送信されます。

  • MSISDN付与

    有効にするとMSISDNがメタデータとして送信されます。

  • デバイス名付与

    有効にするとデバイス名がメタデータとして送信されます。 こちら の 「SIM設定」 にて登録したデバイス名です。


2. カスタムメタデータ

各社クラウドサービスおよび IoT Connect Gateway の設定画面で名称は違いますが、同様の設定となります。

グループ詳細情報設定では、下記のオプションを有効にすることで、カスタムデータを付与することが出来ます。


2.1 設定画面での名称

  • カスタムメタデータ
    • 「Google Cloud Pub/Sub」
    • 「AWS Lambda」
  • カスタムヘッダ
    • 「Azure Event Hubs」
    • 「スタンダード(HTTPプロトコル)」
    • 「ストレージ」

2.2 詳細

ヘッダ情報
  • 有効

    カスタムデータを付与する場合に有効にします。

  • 操作

    add, replace, remove から選択します(必須)

  • ヘッダ名

    ヘッダ名を指定します(必須)

  • ヘッダ値

    ヘッダ値を指定します(必須)

「+」ボタンで複数個指定出来ます。「-」ボタンで削除出来ます。


3. プレースホルダ

IoT Connect Gateway には、便利な機能として、 プレースホルダ があります。

「スタンダード」 の Path設定、 「コンフィグマネージャー」 の 「テンプレート」 内の記述、 「ストレージ」 のファイルパス設定にて利用可能です。

設定項目 設定内容
$imsi SIM設定のIMSIの値と置換
$imei SIM設定のIMEIの値と置換
$deviceName SIM設定のデバイス名の値と置換
$msisdn SIM設定のMSISDNの値と置換
$hsn SIM設定のHSNの値と置換
$optionData1 SIM設定のOptionDataの付与情報1の値と置換
$optionData2 SIM設定のOptionDataの付与情報2の値と置換
$optionData3 SIM設定のOptionDataの付与情報3の値と置換
日時データ
IoT Connect Gateway に着信した日時を プレースホルダ の値として付与します。
ex> $YY, $MM, $DD etc

※MomentJs(https://momentjs.com/docs/#/displaying/)の各Formatの先頭に“$”を付与することにより設定可能です。
※日時データは、「ストレージ」 機能でのみで有効です。

4. 操作ボタン

IoT Connect Gateway の設定一覧画面には、 操作ボタン があります。

操作ボタン より各種設定の詳細閲覧、複製、編集、削除、クリップボードにコピー、ロールバックが可能です。

アイコン 名称 操作内容
../../_images/01.views.png
詳細 設定内容の詳細を閲覧します。複製及び編集が可能な設定については詳細ページから行うことも可能です。
../../_images/02.copy.png
複製 設定内容を複製します。バックアップや元の設定を流用した設定を行う際に使用します。
../../_images/03.edit.png
編集 設定内容を編集します。既存の設定内容を変更する際に使用します。
../../_images/04.delete.png
削除 設定内容を削除します。不要になった設定を削除する際に使用します。
../../_images/05.clipboard.png
クリップボードにコピー 設定内容をクリップボードにコピーします。設定内容をテキストで保存する際に使用します。
../../_images/06.rollback.png
ロールバック 設定内容をロールバックします。設定内容を作成時に戻す際に使用します。

5. ヘルプページ

IoT Connect Gateway の設定一覧画面には、 ヘルプページ があります。

ヘルプページ より各設定のチュートリアルページの参照やヒントの表示が可能です。

ヘルプページのリンク
番号 内容
IoT Connect Gateway のチュートリアルページにリンクしています。
マウスオーバーで各項目の設定ヒントが表示されます。
該当機能のチュートリアル詳細ページにリンクしています。マウスオーバーでリンク先URLが表示されます。
該当機能のチュートリアルのトップページにリンクしています。

6. 付録

MQTTプロトコル利用時の追加メタデータ付与について

IoTデバイスが送信したメッセージに IoT Connect Gateway で設定した追加メタデータを付与して転送先サービスに転送します。 転送先サービスの種類に応じて、以下の処理を実施します。

Google Cloud IoT Core(gcp-iot)
  • 有効化設定された追加メタデータをトピックに追加
  • データ間は"/"でつなげるが、この場合の"/"は文字列であり、Subfolderの階層は1階層とする。
IoTデバイスが送信するトピック 転送先サービスに送信されるトピック
/device/test/event/ /device/test/events/{custom subfolder}/{IMSI}/{IMEI}/{MSISDN}/{DeviceName}
AWS IoT
  • 有効化設定された追加メタデータをトピックに追加
IoTデバイスが送信するトピック 転送先サービスに送信されるトピック
/device/test/ /device/test/{custom subfolder}/{IMSI}/{IMEI}/{MSISDN}/{DeviceName}
Azure IoT Hub (azure-iot)
  • 有効化設定された追加メタデータをトピックに追加
IoTデバイスが送信するトピック 転送先サービスに送信されるトピック
/devices/test/messages/events /devices/test/messages/events/{custom subfolder}/imsi={IMSI}&imei={IMEI}&msisdn={MSISDN}&device_name={DeviceName}
Things Cloud (things-iot)
  • 有効化設定された追加メタデータはInventory Template(111)を使用して送信
  • 追加メタデータをONにしているグループの CONNECTパケットを送信後にInventory Templateにメタデータ情報を入れて送信する。
  • MSISDN/Device Name:OFF固定
イベント / ファンクション のメッセージ受信チェックについての補足

「GCP Pub/Sub」 「Azure Event Hubs」 において、受信したメッセージが以下の場合はエラーレスポンスをIoTデバイスに返却します。

  • Content type=text の場合

    ヘッダに "Content-Type: text/plain" を指定しなかった場合

  • Content type=Binary の場合

    ヘッダに "Accept-Encoding: gzip, deflate, br" のいずれかを指定しなかった場合

  • Content type=JSON の場合

    ボディが JSONフォーマット でない場合

「Things Cloud」 のHTTPメッセージ受信チェックについての補足

受信したメッセージが以下の場合はエラーレスポンスをIoTデバイスに返却します。

  • IoT Connect Gateway のSIM情報にSystemIDが未登録、かつIoTデバイスが送信したメッセージのBodyに"$tc_systemid"が含まれる場合。