IoT Hub のモジュールツインの理解と使用

[アーティクル]
03/17/2023

この記事は、「IoT Hub のデバイスツインの理解と使用」をすでに読み、理解していることを前提としています。 IoT Hub では、デバイス ID ごとに最大 50 のモジュール ID を作成できます。モジュールの ID ごとに、モジュールツインは暗黙的に生成されます。モジュールツインは、デバイスツインと同様、モジュールの状態に関する情報 (メタデータ、構成、状態など) を格納する JSON ドキュメントです。 Azure IoT Hub は、IoT Hub に接続したモジュールごとにモジュールツインを管理します。

デバイス側では、IoT Hub デバイス SDK を使用して、それぞれが IoT Hub への独立した接続を確立するモジュールを作成できます。この機能により、デバイスのさまざまなコンポーネントごとに個別の名前空間を使用することができます。たとえば、3 つの異なるセンサーが付いた自動販売機があるとします。各センサーは、社内の異なる部署によって管理されています。センサーごとにモジュールを作成することができます。これにより、各部門は、管轄するセンサーにのみジョブを送信したり、メソッドを転送できるため、競合やユーザーエラーを回避できます。

モジュール ID とモジュールツインは、デバイス ID とデバイスツインと同様の機能を、より細かい粒度で提供します。このより細かい粒度により、オペレーティングシステムベースのデバイスやファームウェアデバイスなどの複数のコンポーネントで構成され、この機能をサポートするデバイスの各コンポーネントの構成と状態を特定できます。モジュール形式のソフトウェアコンポーネントを含む IoT デバイスを使用する場合、モジュール ID とモジュールツインを使用することで、コンポーネントの管理を分割できます。マイクロソフトは、モジュールツインの一般可用性により、モジュールツインレベルですべてのデバイスツイン機能をサポートすることを目指しています。

Note

この記事で説明されている機能は、Standard レベルの IoT Hub でのみ使用できます。 Basic および Standard または Free レベルの IoT Hub の詳細については、ソリューションに適した IoT Hub のレベルの選択に関するページを参照してください。

この記事では、次の内容について説明します。

モジュールツインの構造: タグ、必要なプロパティ、報告されるプロパティ。
モジュールとバックエンドがモジュールツイン上で実行できる操作。

報告されるプロパティ、device-to-cloud メッセージ、ファイルのアップロードのどれを使用するべきかの指針については、「device-to-cloud 通信に関するガイダンス」を参照してください。

必要なプロパティ、ダイレクトメソッド、cloud-to-device メッセージの使用に関する指針については、「cloud-to-device 通信に関するガイダンス」を参照してください。

モジュールツイン

モジュールツインには、モジュールに関連する次のような情報が格納されます。

デバイス上のモジュールと IoT Hub がモジュールの状態と構成を同期するために使用できます。
実行時間の長い操作にクエリを行い、ターゲットを設定するために使用するソリューションバックエンド。

モジュールツインのライフサイクルは、対応するモジュール ID にリンクされます。モジュールツインは、IoT Hub でモジュール ID を作成または削除したときに、暗黙的に作成または削除されます。

モジュールツインは、次の情報を含む JSON ドキュメントです。

タグ。ソリューションバックエンドで読み書きできる JSON ドキュメントのセクションです。タグは、デバイス上のモジュールからは認識されません。タグは、クエリの目的で設定されます。
必要なプロパティ。モジュールの構成や状態を同期するために、報告されるプロパティと共に使用します。ソリューションバックエンドは必要なプロパティを設定でき、モジュールアプリはそれらを読み取れます。モジュールアプリでは、必要なプロパティに対する変更を知らせる通知を受け取ることもできます。
報告されるプロパティ。モジュールの構成や状態を同期するために、必要なプロパティと共に使用します。モジュールアプリは報告されるプロパティを設定でき、ソリューションバックエンドはそれらを読み取りクエリを実行できます。
モジュール ID のプロパティ。モジュールツインの JSON ドキュメントのルートには、ID レジストリに格納される対応するモジュール ID の読み取り専用プロパティが含まれます。

Architectural representation of device twin

次の例は、モジュールツインの JSON ドキュメントを示しています。

{
    "deviceId": "devA",
    "moduleId": "moduleA",
    "etag": "AAAAAAAAAAc=", 
    "status": "enabled",
    "statusReason": "provisioned",
    "statusUpdateTime": "0001-01-01T00:00:00",
    "connectionState": "connected",
    "lastActivityTime": "2015-02-30T16:24:48.789Z",
    "cloudToDeviceMessageCount": 0, 
    "authenticationType": "sas",
    "x509Thumbprint": {     
        "primaryThumbprint": null, 
        "secondaryThumbprint": null 
    }, 
    "version": 2, 
    "tags": {
        "deploymentLocation": {
            "building": "43",
            "floor": "1"
        }
    },
    "properties": {
        "desired": {
            "telemetryConfig": {
                "sendFrequency": "5m"
            },
            "$metadata" : {...},
            "$version": 1
        },
        "reported": {
            "telemetryConfig": {
                "sendFrequency": "5m",
                "status": "success"
            },
            "batteryLevel": 55,
            "$metadata" : {...},
            "$version": 4
        }
    }
}

ルートオブジェクトには、モジュール ID プロパティと、tags のコンテナーオブジェクトと、reported プロパティと desired プロパティの両方があります。 properties コンテナーには、「モジュールツインのメタデータ」と「オプティミスティックコンカレンシー」セクションで説明されているいくつかの読み取り専用の要素 ($metadata と $version) が含まれています。

報告されるプロパティの例

前の例では、デバイスアプリによって報告される batteryLevel プロパティがモジュールツインに含まれています。このプロパティでは、最後に報告されたバッテリレベルに基づいて、モジュール上でクエリや操作を実行できます。別の例には、モジュールアプリにモジュールの報告機能や接続オプションが含まれています。

Note

ソリューションバックエンドにおける関心の対象が、最後に確認されているプロパティの値であるような状況では、報告されたプロパティを使用した方が簡単です。ソリューションバックエンドでタイムスタンプが付けられた連続するイベントの形式でモジュールテレメトリ (時系列など) を処理する必要がある場合は、device-to-cloud メッセージを使用します。

必要なプロパティの例

上記の例では、ソリューションバックエンドとモジュールアプリが telemetryConfig モジュールツインの必要なプロパティと報告されたプロパティを使用して、モジュールのテレメトリ構成を同期しています。次に例を示します。

ソリューションバックエンドでは、必要なプロパティが必要な構成値で設定されます。以下は、ドキュメント内の必要なプロパティセットを使用した部分です。
```
...
"desired": {
    "telemetryConfig": {
        "sendFrequency": "5m"
    },
    ...
},
...
```
モジュールアプリには、モジュールが接続されている場合、変更がすぐに通知されます。接続されていない場合、モジュールアプリは接続時にモジュールの再接続フローに従います。その後、モジュールアプリが更新された構成 (またはエラー条件。status プロパティを使用) を報告します。報告されるプロパティの部分を次に示します。
```
"reported": {
    "telemetryConfig": {
        "sendFrequency": "5m",
        "status": "success"
    }
    ...
}
```
ソリューションバックエンドは、モジュールツインにクエリを実行することによって、複数のモジュールとの間で行われる構成操作の結果を追跡できます。

Note

上記のスニペットは、モジュール構成とその状態をエンコードするための例の 1 つであり、読みやすいように最適化されています。 IoT Hub は、モジュールツインの必要なプロパティや報告されたプロパティに対して、モジュールツイン用の特定のスキーマを強制しません。

重要

IoT プラグアンドプレイでは、いくつかの追加プロパティを使用して、必要なプロパティと報告されるプロパティに対する変更を同期するスキーマを定義します。ソリューションで IoT プラグアンドプレイを使用する場合は、ツインのプロパティを更新するときにプラグアンドプレイ規則に従う必要があります。詳細と例については、IoT プラグアンドプレイの書き込み可能なプロパティをご覧ください。

バックエンドの操作

ソリューションバックエンドは、HTTPS を介して公開される次のアトミック操作を使用して、モジュールツインを操作します。

ID を条件にモジュールを取得する。この操作は、タグ、必要なシステムプロパティ、報告されるシステムプロパティを含むモジュールツインのドキュメントを返します。
モジュールツインを部分的に更新する。この操作では、ソリューションバックエンドがモジュールツインのタグまたは必要なプロパティを部分的に更新できます。部分的な更新は JSON ドキュメントとして表され、プロパティが追加または更新されます。 null に設定されたプロパティが削除されます。次の例では、{"newProperty": "newValue"} の値を持つ新しい必要なプロパティが作成され、existingProperty の既存の値が "otherNewValue" で上書きされ、otherOldProperty が削除されます。それ以外、既にある必要なプロパティまたはタグは変更されません。
```
{
    "properties": {
        "desired": {
            "newProperty": {
                "nestedProperty": "newValue"
            },
            "existingProperty": "otherNewValue",
            "otherOldProperty": null
        }
    }
}
```
必要なプロパティの置換 この操作では、ソリューションバックエンドによって既存の必要なプロパティをすべて完全に上書きし、properties/desired の新しい JSON ドキュメントに置き換えられます。
タグの置換 この操作では、ソリューションバックエンドによって既存のタグをすべて完全に上書きし、tags の新しい JSON ドキュメントに置き換えられます。
ツイン通知の受信 この操作は、ソリューションバックエンドでツインが変更されたときに通知できるようにします。そのためには、IoT ソリューションでルートを作成し、データソースの値を twinChangeEvents に設定する必要があります。既定では、このようなルートは存在しないため、ツイン通知は送信されません。変化率が高すぎる場合、または内部エラーなどの理由のために、IoT Hub はすべての変更を含む 1 つの通知のみを送信する場合があります。そのため、アプリケーションに信頼性の高い監査とすべての中間状態のログ記録が必要な場合は、device-to-cloud メッセージを使用する必要があります。ツイン通知メッセージで返されるプロパティと本文の詳細については、非テレメトリイベントスキーマに関するページを参照してください。

上述の操作はすべてオプティミスティックコンカレンシーをサポートしており、「IoT Hub へのアクセスの制御」の記事で定義されているとおり、ServiceConnect アクセス許可を必要とします。

これらの操作に加えて、ソリューションバックエンドでは SQL に似た IoT Hub クエリ言語を使用してモジュールツインのクエリを実行できます。

モジュールの操作

モジュールアプリは、次のアトミック操作を使用して、モジュールツインを操作します。

モジュールツインを取得する この操作は、必要なシステムプロパティ、報告されるシステムプロパティを含む、現在接続されているモジュールのモジュールツインのドキュメントを返します。
報告されるプロパティの部分的な更新 この操作では、現在接続されているモジュールの報告されるプロパティを部分的に更新できます。この操作には、必要なプロパティを部分的に更新する際にソリューションバックエンドで使用されるものと同じ JSON 更新フォーマットが使用されます。
必要なプロパティの監視 現在接続されているモジュールでは、必要なプロパティの更新が行われたときに通知をするように設定できます。モジュールは、ソリューションバックエンドによって実行される更新 (部分的または完全な置換) と同じフォームを受け取ります。

「IoT Hub へのアクセスの制御」の記事に定義されているように、上述の操作にはすべて DeviceConnect アクセス許可が必要です。

Azure IoT device SDK を使用すると、多数の言語とプラットフォームで上述の操作を簡単に使用できます。

タグやプロパティの形式

タグ、必要なプロパティ、報告されるプロパティは JSON オブジェクトであり、次のような制限があります。

キー: JSON オブジェクト内のすべてのキーは UTF-8 でエンコードされ、大文字と小文字が区別され、最大 1 KB の長さです。 UNICODE 制御文字列 (セグメント C0 と C1)、.、$、SP は使用できません。
値:JSON オブジェクトのすべての値には、ブール値、数値、文字列、オブジェクトの JSON 型を使用できます。配列もサポートされています。
- 使用できる整数の範囲は、-4503599627370496 (最小値) から 4503599627370495 (最大値) までです。
- 文字列値は UTF-8 でエンコードされ、最大長は 4 KB です。

深さ: タグ、必要なプロパティ、およびレポートされるプロパティにおける JSON オブジェクトの深さは最大で 10 です。たとえば、次のオブジェクトは有効です。

{
     ...
     "tags": {
         "one": {
             "two": {
                 "three": {
                     "four": {
                         "five": {
                             "six": {
                                 "seven": {
                                     "eight": {
                                         "nine": {
                                             "ten": {
                                                 "property": "value"
                                             }
                                         }
                                     }
                                 }
                             }
                         }
                     }
                 }
             }
         }
     },
     ...
}

モジュールツインのサイズ

IoT Hub では tags の値に 8 KB のサイズ制限が適用され、properties/desired と properties/reported の値にそれぞれ 32 KB のサイズ制限が適用されます。これらの合計には、$version や $metadata/$lastUpdated などの読み取り専用の要素は含まれません。

ツインのサイズは、次のように計算されます。

IoT Hub では、JSON ドキュメント内のプロパティごとに、プロパティのキーと値の長さを累積的に計算して追加します。
プロパティキーは、UTF8 でエンコードされた文字列と見なされます。
単純なプロパティ値は、UTF8 でエンコードされた文字列、数値 (8 バイト)、またはブール値 (4 バイト) と見なされます。
UTF8 でエンコードされた文字列のサイズは、UNICODE 制御文字 (セグメント C0 と C1) を除くすべての文字をカウントして計算されます。
複合プロパティ値 (入れ子になったオブジェクト) は、プロパティキーの合計サイズと、そこに含まれるプロパティ値に基づいて計算されます。

ドキュメントのサイズが上述の制限を超えると、IoT Hub はすべての操作を拒否して、エラーを返します。

モジュールツインのメタデータ

IoT Hub は、各 JSON オブジェクトが最後に更新されたときのタイムスタンプを、モジュールツインの必要なプロパティと報告されるプロパティに保持します。タイムスタンプは UTC であり、ISO8601 形式の YYYY-MM-DDTHH:MM:SS.mmmZ でエンコードされます。次に例を示します。

{
    ...
    "properties": {
        "desired": {
            "telemetryConfig": {
                "sendFrequency": "5m"
            },
            "$metadata": {
                "telemetryConfig": {
                    "sendFrequency": {
                        "$lastUpdated": "2016-03-30T16:24:48.789Z"
                    },
                    "$lastUpdated": "2016-03-30T16:24:48.789Z"
                },
                "$lastUpdated": "2016-03-30T16:24:48.789Z"
            },
            "$version": 23
        },
        "reported": {
            "telemetryConfig": {
                "sendFrequency": "5m",
                "status": "success"
            },
            "batteryLevel": "55%",
            "$metadata": {
                "telemetryConfig": {
                    "sendFrequency": "5m",
                    "status": {
                        "$lastUpdated": "2016-03-31T16:35:48.789Z"
                    },
                    "$lastUpdated": "2016-03-31T16:35:48.789Z"
                },
                "batteryLevel": {
                    "$lastUpdated": "2016-04-01T16:35:48.789Z"
                },
                "$lastUpdated": "2016-04-01T16:24:48.789Z"
            },
            "$version": 123
        }
    }
    ...
}

この情報は、オブジェクトのキーによって削除される更新を保持するために、JSON の構造のリーフだけでなくすべてのレベルで保持されます。

オプティミスティックコンカレンシー

タグ、必要なプロパティ、報告されたプロパティはすべて、オプティミスティックコンカレンシーをサポートします。ツインプロパティの更新の順序を保証する必要がある場合は、次の更新を送信する前に、報告されたプロパティのコールバックを待って、アプリケーションレベルで同期を実装することを検討してください。

モジュールツインには、RFC7232 に従って、ツインの JSON 表現を表す ETag (etag プロパティ) があります。ソリューションバックエンドからの条件付き更新操作で etag プロパティを使用すると、一貫性を保持できます。これは、tags コンテナーを含む操作の一貫性を確保するための唯一のオプションです。

モジュールツインが必要とする、および報告されるプロパティにも、増分が保証された $version の値があります。 ETag と同様、更新側がバージョンを使用することで更新プログラムの一貫性を確保することができます。たとえば、報告されたプロパティ用のモジュールアプリ、または目的のプロパティのソリューションバックエンドです。

バージョンは、監視エージェント (必要なプロパティを監視するモジュールアプリなど) が取得操作に関する結果と更新の通知の間の競合を調整する場合に便利です。詳細については、「モジュールの再接続フロー」セクションを参照してください。

モジュールの再接続フロー

IoT Hub では、必要なプロパティの更新通知は接続されていないモジュール用に保持されません。つまり、接続しているモジュールは必要なプロパティの完全なドキュメントを取得し、さらに更新通知にサブスクライブする必要があります。更新通知と完全取得で競合が発生する場合、次のフローを実行する必要があります。

モジュールアプリを IoT hub に接続する。
モジュールアプリを、必要なプロパティの更新通知にサブスクライブする。
モジュールアプリで、必要なプロパティの完全なドキュメントを取得する。

$version が取得した完全なドキュメントのバージョン以下の場合、モジュールアプリではすべての通知を無視できます。 IoT Hub ではバージョンが常に増分されるため、このようなアプローチが可能になります。

次のステップ

この記事で説明した概念を試すには、次の IoT Hub のチュートリアルをご覧ください。

.NET バックエンドおよび .NET デバイスを使用した Azure IoT Hub モジュール ID とモジュールツインの概要

次の方法で共有

IoT Hub のモジュールツインの理解と使用

モジュールツイン

報告されるプロパティの例

必要なプロパティの例

バックエンドの操作

モジュールの操作

タグやプロパティの形式

モジュールツインのサイズ

モジュールツインのメタデータ

オプティミスティックコンカレンシー

モジュールの再接続フロー

次のステップ

フィードバック

その他のリソース

次の方法で共有

IoT Hub のモジュール ツインの理解と使用

モジュール ツイン

報告されるプロパティの例

必要なプロパティの例

バック エンドの操作

モジュールの操作

タグやプロパティの形式

モジュール ツインのサイズ

モジュール ツインのメタデータ

オプティミスティック コンカレンシー

モジュールの再接続フロー

次のステップ

フィードバック

その他のリソース

IoT Hub のモジュールツインの理解と使用

モジュールツイン

バックエンドの操作

モジュールツインのサイズ

モジュールツインのメタデータ

オプティミスティックコンカレンシー