チュートリアル - Azure IoT Central アプリケーションで新しい種類の IoT ゲートウェイデバイスを定義する

[アーティクル]
04/21/2024

このチュートリアルでは、スマートビルディング ゲートウェイデバイステンプレートを作成します。 スマートビルディング ゲートウェイデバイスは、他のダウンストリームデバイスとリレーションシップがあります。

ゲートウェイデバイスとそのダウンストリームデバイスの間の関係を示す図。

ゲートウェイデバイスでは、次のことも可能です:

自身のテレメトリ (温度など) を送信する。
オペレーターによって行われた書き込み可能なプロパティの更新に応答する。たとえば、オペレーターはテレメトリの送信間隔を変更できます。
コマンド (デバイスの再起動など) に応答する。

このチュートリアルでは、次の作業を行う方法について説明します。

ダウンストリームデバイステンプレートを作成する
ゲートウェイデバイステンプレートの作成
デバイステンプレートを公開する
シミュレートされたデバイスを作成する

前提条件

このチュートリアルを完了するには、以下が必要になります。

有効な Azure サブスクリプション Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。
カスタムアプリケーションテンプレートから作成された IoT Central アプリケーション。詳細については、「IoT Central アプリケーションを作成する」と「アプリケーションに関する情報」をご覧ください。

ダウンストリームデバイステンプレートを作成する

このチュートリアルでは、シミュレートされたダウンストリームデバイスを生成するために、Onset Hobo MX-100 Temp センサー デバイスおよび RS40 混雑状況センサー デバイス用のデバイステンプレートを使用します。

Onset Hobo MX-100 Temp センサー デバイスのデバイステンプレートを作成するには:

左側のペインで [デバイステンプレート] を選択します。次に、 [+ 新規] を選択して、テンプレートの追加を開始します。
Onset Hobo MX-100 Temp センサー デバイスのタイルが表示されるまで下にスクロールします。タイルを選択し、[次へ: 確認] を選択します。
[Review](確認) ページで [作成] を選択して、アプリケーションにデバイステンプレートを追加します。

RS40 混雑状況センサー デバイスのデバイステンプレートを作成するには:

左側のペインで [デバイステンプレート] を選択します。次に、 [+ 新規] を選択して、テンプレートの追加を開始します。
Rigado RS40 混雑状況センサー デバイスのタイルが表示されるまで下にスクロールします。タイルを選択し、[次へ: 確認] を選択します。
[Review](確認) ページで [作成] を選択して、アプリケーションにデバイステンプレートを追加します。

これで、次のように 2 種類のダウンストリームデバイスのデバイステンプレートが作成されました。

ゲートウェイデバイステンプレートの作成

このチュートリアルでは、ゲートウェイデバイスのデバイステンプレートもゼロから作成します。このテンプレートは、シミュレートされたゲートウェイデバイスをアプリケーション内に作成するために後で使用します。

新しいゲートウェイデバイステンプレートをアプリケーションに追加するには、次の手順を実行します。

左側のペインで [デバイステンプレート] を選択します。次に、 [+ 新規] を選択して、テンプレートの追加を開始します。
[テンプレートの種類の選択] ページで [IoT デバイス] タイルを選択し、 [次へ: カスタマイズ] を選択します。
[Customize device](デバイスのカスタマイズ) ページで、 [This is a gateway device](これはゲートウェイデバイスです) チェックボックスをオンにします。
テンプレート名として「スマートビルディングゲートウェイデバイス」と入力し、 [次: レビュー] を選択します。
[Review](レビュー) ページで、 [Create](作成) を選択します。
[モデルの作成] ページで、 [Custom model](カスタムモデル) タイルを選択します。
[+ 機能の追加] を選択して、機能を追加します。
表示名として「データの送信」と入力し、機能タイプとして [プロパティ] を選択します。
スキーマの型として [ブール値] を選択し、[書き込み可能] をオンに設定し、[保存]選択します。

リレーションシップの追加

次に、ダウンストリームデバイステンプレートにリレーションシップを追加します。

[スマートビルディングゲートウェイデバイス] テンプレートで、 [リレーションシップ] を選択します。
[+ リレーションシップの追加] を選択します。表示名として「環境センサー」と入力し、ターゲットとして [Hobo MX-100] を選択します。
再度、 [+ リレーションシップの追加] を選択します。表示名として「混雑状況センサー」と入力し、ターゲットとして [RS40 混雑状況センサー] を選択します。
[保存] を選択します。

クラウドプロパティを追加する

ゲートウェイデバイステンプレートにはクラウドプロパティを含めることができます。クラウドプロパティは IoT Central アプリケーション内のみに存在しており、デバイスとの間で送受信されることはありません。

クラウドプロパティをスマートビルディングゲートウェイデバイス テンプレートに追加するには、次の手順を実行します。

[スマートビルディングゲートウェイデバイス] テンプレートで、[スマートビルディングゲートウェイデバイス モデル] を選択します。
下表の情報に従って、ゲートウェイデバイステンプレートに 2 つのクラウドプロパティを追加します。

Display name 機能の種類セマンティックの種類スキーマ

Last Service Date クラウドプロパティなし Date

Customer Name クラウドプロパティなし String
[保存] を選択します。

Display name	機能の種類	セマンティックの種類	スキーマ
Last Service Date	クラウドプロパティ	なし	Date
Customer Name	クラウドプロパティ	なし	String

ビューの作成

作成者は、環境センサーデバイスの関連情報がオペレーターに表示されるよう、アプリケーションをカスタマイズできます。カスタマイズを行うことで、オペレーターがアプリケーションに接続された環境センサーデバイスを管理できるようになります。オペレーター向けのデバイス操作用のビューを 2 種類作成できます。

デバイスプロパティとクラウドプロパティを表示および編集するためのフォーム。
デバイスを視覚化するためのビュー。

スマートビルディングゲートウェイデバイス テンプレートの既定のビューを生成するには、次の手順を実行します。

[スマートビルディングゲートウェイデバイス] テンプレートで、 [ビュー] を選択します。
[既定のビューの生成] タイルを選択し、すべてのオプションが選択されていることを確認します。
[Generate default dashboard view](既定のダッシュボードビューの生成) を選択します。

デバイステンプレートを公開する

シミュレートされたゲートウェイデバイスを作成したり、実物のゲートウェイデバイスを接続したりする前に、デバイステンプレートを発行する必要があります。

ゲートウェイデバイステンプレートを発行するには、次の手順を実行します。

[デバイステンプレート] ページで [スマートビルディングゲートウェイデバイス] テンプレートを選択します。
[発行] を選択します。
[Publish a Device Template](デバイステンプレートの発行) ダイアログで、 [発行] を選択します。

デバイステンプレートを公開すると、 [デバイス] ページに表示され、オペレーターが確認できるようになります。オペレーターはテンプレートを利用し、デバイスインスタンスを作成したり、ルールと監視を確立したりできます。発行後のテンプレートを編集すると、アプリケーション全体で動作に影響を与えることがあります。

発行後にデバイステンプレートを変更する方法の詳細については、「既存のデバイステンプレートを編集する」を参照してください。

シミュレートされたデバイスを作成する

このチュートリアルでは、シミュレートされたダウンストリームデバイスとシミュレートされたゲートウェイデバイスを使用します。

シミュレートされたゲートウェイデバイスを作成するには、次の手順を実行します。

[デバイス] ページのデバイステンプレートの一覧で、 [スマートビルディングゲートウェイデバイス] を選択します。
[+ 新規] を選択して、新しいデバイスの追加を開始します。
生成されたデバイス ID とデバイス名を保持します。 [シミュレート済み] スイッチが [はい] になっていることを確認します。 ［作成］ を選択します

シミュレートされたダウンストリームデバイスを作成するには、次の手順を実行します。

[デバイス] ページのデバイステンプレートの一覧で、 [RS40 混雑状況センサー] を選択します。
[+ 新規] を選択して、新しいデバイスの追加を開始します。
生成されたデバイス ID とデバイス名を保持します。 [シミュレート済み] スイッチが [はい] になっていることを確認します。 ［作成］ を選択します
[デバイス] ページのデバイステンプレートの一覧で、[Hobo MX-100] を選択します。
[+ 新規] を選択して、新しいデバイスの追加を開始します。
生成されたデバイス ID とデバイス名を保持します。 [シミュレート済み] スイッチが [はい] になっていることを確認します。 ［作成］ を選択します

ダウンストリームデバイスのリレーションシップをゲートウェイデバイスに追加する

シミュレートされたデバイスをアプリケーションに作成したので、ダウンストリームデバイスとゲートウェイデバイスの間にリレーションシップを作成できます。

[デバイス] ページのデバイステンプレートの一覧で [Hobo MX-100] を選択し、シミュレートされた [Hobo MX-100] デバイスを選択します。
[ゲートウェイに接続] を選択します。
[ゲートウェイへの接続] ダイアログで、 [スマートビルディングゲートウェイデバイス] テンプレートを選択してから、前に作成したシミュレートされたインスタンスを選択します。
[接続] を選択します。
[デバイス] ページのデバイステンプレートの一覧で [RS40 混雑状況センサー] を選択してから、シミュレートされた [RS40 混雑状況センサー] デバイスを選択します。
[ゲートウェイに接続] を選択します。
[ゲートウェイへの接続] ダイアログで、 [スマートビルディングゲートウェイデバイス] テンプレートを選択してから、前に作成したシミュレートされたインスタンスを選択します。
[接続] を選択します。

これで、両方のシミュレートされたダウンストリームデバイスが、シミュレートされたゲートウェイデバイスに接続されました。ゲートウェイデバイスの [Downstream Devices](ダウンストリームデバイス) ビューに移動すると、関連するダウンストリームデバイスを確認できます。

実際のダウンストリームデバイスを接続する

「クライアントアプリケーションを作成して Azure IoT Central アプリケーションに接続する」チュートリアルのサンプルコードでは、デバイスによって送信されるプロビジョニングペイロードにデバイステンプレートのモデル ID を含める方法が示されています。

ダウンストリームデバイスを接続するときに、プロビジョニングペイロードを変更して、ゲートウェイデバイスの ID を含めることができます。モデル ID により、IoT Central はデバイスを正しいダウンストリームデバイステンプレートに割り当てることができます。ゲートウェイ ID により、IoT Central でダウンストリームデバイスとそのゲートウェイの間の関係を確立できます。この場合、デバイスによって送信されるプロビジョニングペイロードは、次の JSON のようになります。

{
  "modelId": "dtmi:rigado:HoboMX100;2",
  "iotcGateway":{
    "iotcGatewayId": "gateway-device-001"
  }
}

ゲートウェイではダウンストリームデバイスを登録し、プロビジョニングし、次のようにそのダウンストリームデバイスをゲートウェイと関連付けることができます。

JavaScript
Python

var crypto = require('crypto');


var ProvisioningTransport = require('azure-iot-provisioning-device-mqtt').Mqtt;
var SymmetricKeySecurityClient = require('azure-iot-security-symmetric-key').SymmetricKeySecurityClient;
var ProvisioningDeviceClient = require('azure-iot-provisioning-device').ProvisioningDeviceClient;

var provisioningHost = "global.azure-devices-provisioning.net";
var idScope = "<The ID scope from your SAS group enrollment in IoT Central>";
var groupSymmetricKey = "<The primary key from the SAS group enrollment>";
var registrationId = "<The device ID for the downstream device you're creating>";
var modelId = "<The model you're downstream device should use>";
var gatewayId = "<The device ID of your gateway device>";

// Calculate the device key from the group enrollment key
function computeDerivedSymmetricKey(deviceId, masterKey) {
    return crypto.createHmac('SHA256', Buffer.from(masterKey, 'base64'))
        .update(deviceId, 'utf8')
        .digest('base64');
}

var symmetricKey = computeDerivedSymmetricKey(registrationId, groupSymmetricKey);

var provisioningSecurityClient = new SymmetricKeySecurityClient(registrationId, symmetricKey);

var provisioningClient = ProvisioningDeviceClient.create(provisioningHost, idScope, new ProvisioningTransport(), provisioningSecurityClient);

// Use the DPS payload to:
// - specify the device capability model to use.
// - associate the device with a gateway.
var provisioningPayload = {modelId: modelId, iotcGateway: { iotcGatewayId: gatewayId}}

provisioningClient.setProvisioningPayload(provisioningPayload);

provisioningClient.register(function(err, result) {
  if (err) {
    console.log("Error registering device: " + err);
  } else {
    console.log('The registration status is: ' + result.status)
   }
});

from azure.iot.device import ProvisioningDeviceClient
import os
import base64
import hmac
import hashlib

provisioning_host = "global.azure-devices-provisioning.net"

id_scope = "<The ID scope from your SAS group enrollment in IoT Central>"
group_symmetric_key = "<The primary key from the SAS group enrollment>"
registration_id = "<The device ID for the downstream device you're creating>"
model_id = "<The model you're downstream device should use>"
gateway_id = "<The device ID of your gateway device>"

# Calculate the device key from the group enrollment key
def compute_device_key (device_id, group_key):
    message = device_id.encode("utf-8")
    signing_key = base64.b64decode(group_key.encode("utf-8"))
    signed_hmac = hmac.HMAC(signing_key, message, hashlib.sha256)
    device_key_encoded = base64.b64encode(signed_hmac.digest())
    return device_key_encoded.decode("utf-8")

provisioning_device_client = ProvisioningDeviceClient.create_from_symmetric_key(
    provisioning_host=provisioning_host,
    registration_id=registration_id,
    id_scope=id_scope,
    symmetric_key=compute_device_key(registration_id, group_symmetric_key)
)

# Use the DPS payload to:
# - specify the device capability model to use.
# - associate the device with a gateway.
provisioning_device_client.provisioning_payload = {"modelId": model_id, "iotcGateway":{"iotcGatewayId": gateway_id}}

registration_result = provisioning_device_client.register()

print("The registration status is:")
print(registration_result.status)

リソースをクリーンアップする

今後 IoT Central のクイックスタートやチュートリアルに取り組む予定がなければ、ここで使用した IoT Central アプリケーションは次の手順で削除してください。

IoT Central アプリケーションで、[アプリケーション] > [管理]に移動します。
[削除] を選択して操作を確定します。

次のステップ

次の学習内容は次のとおりです。

Azure IoT Central アプリケーションで規則を作成して通知を設定する

チュートリアル - Azure IoT Central アプリケーションで新しい種類の IoT ゲートウェイ デバイスを定義する

前提条件

ダウンストリーム デバイス テンプレートを作成する

ゲートウェイ デバイス テンプレートの作成