翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

チュートリアル: Device SDK のインストールと Device Shadows のサンプルアプリケーションの実行

このセクションでは、必要なソフトウェアと AWS IoT Device SDK for Python をインストールし、shadow.py サンプルアプリケーションを実行して Shadow ドキュメントを編集し、Shadow の状態を制御する方法を示します。

このチュートリアルを実行する前に:

AWS アカウント を設定し、Raspberry Pi デバイスを設定し、Device Shadow サービスの MQTT 予約トピックを発行およびサブスクライブするためのアクセス許可をデバイスに与える AWS IoT モノとポリシーを作成しておく必要があります。詳細については、「」を参照してくださいチュートリアル: シャドウアプリケーションを実行するための Raspberry Pi の準備

Git、Python、AWS IoT Device SDK for Python もインストールされている必要があります。このチュートリアルは、チュートリアル Raspberry Pi または他のデバイスを接続する で提示された概念に基づいています。そのチュートリアルをまだ試していない場合は、そのチュートリアルで説明されている手順に従って証明書ファイルと Device SDK をインストールしてから、このチュートリアルに戻って shadow.py サンプルアプリケーションを実行することをお勧めします。

このチュートリアルの完了には 20 分ほどかかります。

ステップ 1: shadow.py サンプルアプリケーションを実行する

shadow.py サンプルアプリケーションを実行する前に、インストールした証明書ファイルの名前と場所に加えて、次の情報が必要です。

値を入力し、Shadow ドキュメントの更新を観察する

ターミナルに desired 値を入力して値を指定すると、reported 値も更新されます。ターミナルで色 yellow を入力するとします。reported 値も色 yellow に更新されます。ターミナルに表示されるメッセージを次に示します。

Enter desired value:
yellow
Changed local shadow value to 'yellow'.
Updating reported shadow value to 'yellow'...
Update request published.
Finished updating reported shadow value to 'yellow'.

この更新リクエストを発行すると、AWS IoT はモノのリソースのデフォルトのクラシックシャドウを作成します。作成したモノのリソース (例: My_light_bulb) の Shadow ドキュメントを参照することで、AWS IoT コンソールの reported および desired 値に発行した更新リクエストを確認できます。Shadow ドキュメントで更新を表示するには、次の操作を行います。

Shadow ドキュメントは次のようになり、色 yellow に設定された reported と desired の値が表示されます。これらの値は、ドキュメントの [Shadow の状態] のセクションに表示されます。

{
"desired": {
  "welcome": "aws-iot",
  "color": "yellow"
},
"reported": {
  "welcome": "aws-iot",
  "color": "yellow"
}
}

リクエストのタイムスタンプ情報とバージョン番号を含む [メタデータ] セクションも表示されます。

状態ドキュメントのバージョンを使用して、デバイスのシャドウのドキュメントの最新バージョンを更新していることを確認できます。別の更新リクエストを送信すると、バージョン番号が 1 ずつ増えます。更新リクエストでバージョンを渡したとき、そのバージョンと状態ドキュメントの現在のバージョンとが一致しない場合、サービスは HTTP 409 conflict レスポンスコードでリクエストを拒否します。

{
"metadata": {
  "desired": {
    "welcome": {
      "timestamp": 1620156892
    },
    "color": {
      "timestamp": 1620156893
    }
  },
  "reported": {
    "welcome": {
      "timestamp": 1620156892
    },
    "color": {
      "timestamp": 1620156893
    }
  }
},
"version": 10
}        

Shadow ドキュメントについてさらに学び、状態情報の変化を観察するには、このチュートリアルの ステップ 4: 結果と次のステップを確認する セクションで説明されている次のチュートリアル チュートリアル: サンプルアプリケーションと MQTT テストクライアントを使用した Device Shadow とのやり取り に進んでください。必要に応じて、次のセクションで shadow.py サンプルコードとそれが MQTT プロトコルを使用する方法について学ぶこともできます。

ステップ 2: shadow.py Device SDK サンプルアプリケーションを確認する

このセクションでは、このチュートリアルで使用されている AWS IoT Device SDK v2 for Python の shadow.py サンプルアプリケーションを確認します。ここでは、MQTT および MQTT over WSS プロトコルを使用して AWS IoT Core に接続する方法を確認します。AWS 共通ランタイム (AWS-CRT) ライブラリは、低レベルの通信プロトコルサポートを提供し、AWS IoT Device SDK v2 for Python に含まれています。

このチュートリアルでは MQTT と MQTT over WSS を使用していますが、AWS IoT は HTTPS リクエストを発行するデバイスをサポートしています。デバイスから HTTP メッセージを送信する Python プログラムの例については、Python の requests ライブラリを使用した HTTPS コード例を参照してください。

デバイス通信に使用するプロトコルについて十分な情報に基づいた決定を行う方法については、デバイス通信用のアプリケーションプロトコルの選択 を確認してください。

MQTT

shadow.py サンプルでは、mqtt_connection_builder の mtls_from_path (ここに表示されています) を呼び出して、MQTT プロトコルを使用して AWS IoT Core との接続を確立します。mtls_from_path は、X.509 証明書と TLS v1.2 を使用してデバイスを認証します。AWS-CRT ライブラリは、その接続の下位レベルの詳細を処理します。

mqtt_connection = mqtt_connection_builder.mtls_from_path(
  endpoint=args.endpoint,
  cert_filepath=args.cert,
  pri_key_filepath=args.key,
  ca_filepath=args.ca_file,
  client_bootstrap=client_bootstrap,
  on_connection_interrupted=on_connection_interrupted,
  on_connection_resumed=on_connection_resumed,
  client_id=args.client_id,
  clean_session=False,
  keep_alive_secs=6
)

この shadow.py サンプルでは、WSS 経由で MQTT プロトコルを使用して AWS IoT Core との接続を確立するために mqtt_connection_builder の websockets_with_default_aws_signing も呼び出します。MQTT over WSS も MQTT と同じパラメータを使用し、次の追加パラメータを受け取ります。

Shadow トピックとイベントをサブスクライブする

shadow.py サンプルは接続の確立を試み、完全に接続されるまで待機します。接続されていない場合、コマンドはキューに入れられます。接続されると、サンプルはデルタイベントをサブスクライブし、メッセージを更新および取得し、サービスの品質 (QoS) レベル 1 (mqtt.QoS.AT_LEAST_ONCE) でメッセージを発行します。

デバイスが QoS レベル 1 のメッセージをサブスクライブすると、メッセージブローカーは、デバイスに送信できるようになるまで、デバイスがサブスクライブしているメッセージを保存します。メッセージブローカーは、デバイスから PUBACK 応答を受信するまでメッセージを再送信します。

MQTT プロトコルの詳細については、MQTT プロトコルを確認する および MQTT を参照してください。

このチュートリアルで使用される MQTT、MQTT over WSS、永続セッション、および QoS レベルの詳細については、「pubsub.py Device SDK サンプルアプリケーションを確認する」を参照してください。

ステップ 3: shadow.py サンプルアプリケーションの問題をトラブルシューティングする

shadow.py サンプルアプリケーションを実行すると、ターミナルにいくつかのメッセージが表示され、desired 値を入力するように求められます。プログラムがエラーをスローした場合、エラーをデバッグするには、まずシステムに対して正しいコマンドを実行したかどうかを確認します。

場合によっては、エラーメッセージは接続の問題を示し、Host name was invalid for dns resolution または Connection was closed unexpectedly のようになることがあります。このような場合、次のことを確認してみてください。

ステップ 4: 結果と次のステップを確認する

次のステップ

これで、shadow.py サンプルアプリケーションを実行し、Device Shadow を使用して状態を制御できます。AWS IoT コンソールで Shadow ドキュメントの更新を観察し、サンプルアプリケーションが応答するデルタイベントを観察できます。MQTT テストクライアントを使用して、予約済みのシャドウトピックにサブスクライブし、サンプルプログラムの実行時にトピックが受信するメッセージを観察できます。このチュートリアルの実行方法の詳細については、チュートリアル: サンプルアプリケーションと MQTT テストクライアントを使用した Device Shadow とのやり取り を参照してください。