IoT Hub を使用したクラウドからデバイスへのメッセージの送信 (Python)

[アーティクル]
05/30/2023

Azure IoT Hub は、何百万ものデバイスとソリューションバックエンドの間に信頼性のある保護された双方向通信を確立するのに役立つ、フルマネージドのサービスです。

この記事で取り上げるテクニック:

ソリューションバックエンドから IoT Hub 経由で単一のデバイスに cloud-to-device (C2D) メッセージを送信する
cloud-to-device メッセージをデバイスで受信する

注意

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

この記事の最後に、次の 2 つの Python コンソールアプリを実行します。

SimulatedDevice.py: IoT ハブに接続し、cloud-to-device メッセージを受信するデバイスをシミュレートします。
SendCloudToDeviceMessage.py: cloud-to-device メッセージを IoT Hub 経由でシミュレートされたデバイスアプリに送信します。

cloud-to-device メッセージの詳細については、「IoT ハブから cloud-to-device メッセージを送信する」を参照してください。

Note

IoT Hub には、Azure IoT device SDK を介して、多数のデバイスプラットフォームと言語 (C、Java、Python、JavaScript) に対する SDK サポートがあります。

前提条件

アクティブな Azure アカウントアカウントがない場合、Azure 試用版にサインアップして、最大 10 件の無料 Mobile Apps を入手できます。 (アカウントがない場合は、無料アカウントを数分で作成できます)。
IoT Hub。 CLI または Azure portal を使って作成します。
登録済みのデバイス。 Azure portal に登録してください。
Python バージョン 3.7 以降をお勧めします。必ず、セットアップに必要な 32 ビットまたは 64 ビットのインストールを使用してください。インストール中に求められた場合は、プラットフォーム固有の環境変数に Python を追加します。
ポート 8883 がファイアウォールで開放されていることを確認してください。この記事のデバイスサンプルでは、ポート 8883 を介して通信する MQTT プロトコルを使用しています。このポートは、企業や教育用のネットワーク環境によってはブロックされている場合があります。この問題の詳細と対処方法については、「IoT Hub への接続 (MQTT)」を参照してください。

シミュレートされたデバイスアプリでメッセージを受信する

このセクションでは、デバイスをシミュレートして、cloud-to-device メッセージを IoT ハブから受信する、Python コンソールアプリを作成します。

作業ディレクトリのコマンドプロンプトから、Azure IoT Hub Device SDK for Python をインストールします。
```
pip install azure-iot-device
```
テキストエディターを使用して、SimulatedDevice.py という名前のファイルを作成します。
SimulatedDevice.py ファイルの先頭に、次の import ステートメントと変数を追加します。
```
import time
from azure.iot.device import IoTHubDeviceClient

RECEIVED_MESSAGES = 0
```
次のコードを SimulatedDevice.py ファイルに追加します。 {deviceConnectionString} プレースホルダーの値を「前提条件」の登録済みデバイスの接続文字列に置き換えます。
```
CONNECTION_STRING = "{deviceConnectionString}"
```

受信したメッセージのコンソール出力に使用される次の関数を定義します:

def message_handler(message):
    global RECEIVED_MESSAGES
    RECEIVED_MESSAGES += 1
    print("")
    print("Message received:")

    # print data from both system and application (custom) properties
    for property in vars(message).items():
        print ("    {}".format(property))

    print("Total calls received: {}".format(RECEIVED_MESSAGES))

クライアントを初期化してクラウドからデバイスへのメッセージの受信を待機する次のコードを追加します。

def main():
    print ("Starting the Python IoT Hub C2D Messaging device sample...")

    # Instantiate the client
    client = IoTHubDeviceClient.create_from_connection_string(CONNECTION_STRING)

    print ("Waiting for C2D messages, press Ctrl-C to exit")
    try:
        # Attach the handler to the client
        client.on_message_received = message_handler

        while True:
            time.sleep(1000)
    except KeyboardInterrupt:
        print("IoT Hub C2D Messaging device sample stopped")
    finally:
        # Graceful exit
        print("Shutting down IoT Hub Client")
        client.shutdown()

次の main 関数を追加します。
```
if __name__ == '__main__':
    main()
```
SimulatedDevice.py ファイルを保存し、閉じます。

cloud-to-device メッセージのライフサイクルと、IoT Hub が cloud-to-device メッセージを処理する方法の詳細については、「IoT ハブから cloud-to-device メッセージを送信する」を参照してください。

IoT ハブ接続文字列を取得する

この記事では、IoT Hub を介して cloud-to-device メッセージを送信するバックエンドサービスを作成します。 cloud-to-device メッセージを送信するサービスには、サービス接続のアクセス許可が必要となります。既定では、どの IoT Hub も、このアクセス許可を付与する service という名前の共有アクセスポリシーがある状態で作成されます。

サービス ポリシーの IoT Hub 接続文字列を取得するには、次の手順を実行します。

Azure portal で、 [リソースグループ] を選択します。ハブが配置されているリソースグループを選択し、リソースの一覧からハブを選択します。
IoT ハブの左側のウィンドウで、 [共有アクセスポリシー] を選択します。
ポリシーの一覧から、サービス ポリシーを選択します。
[プライマリ接続文字列] をコピーし、値を保存します。

IoT Hub の共有アクセスポリシーとアクセス許可の詳細については、「アクセス制御とアクセス許可」を参照してください。

C2D メッセージを送信する

このセクションでは、クラウドからデバイスへのメッセージをシミュレートされたデバイスのアプリに送信する Python コンソールアプリを作成します。デバイスからのデバイス ID と IoT ハブの接続文字列が必要です。

作業ディレクトリでコマンドプロンプトを開き、Azure IoT Hub Service SDK for Python をインストールします。
```
pip install azure-iot-hub
```
テキストエディターを使用して、SendCloudToDeviceMessage.py という名前のファイルを作成します。

SendCloudToDeviceMessage.py ファイルの先頭に、次の import ステートメントと変数を追加します。

import random
import sys
from azure.iot.hub import IoTHubRegistryManager

MESSAGE_COUNT = 2
AVG_WIND_SPEED = 10.0
MSG_TXT = "{\"service client sent a message\": %.2f}"

次のコードを SendCloudToDeviceMessage.py ファイルに追加します。 {iot hub connection string} と {device id} のプレースホルダー値を、前に書き留めた IoT ハブ接続文字列とデバイス ID に置き換えます。
```
CONNECTION_STRING = "{IoTHubConnectionString}"
DEVICE_ID = "{deviceId}"
```

デバイスにメッセージを送信するための次のコードを追加します。

def iothub_messaging_sample_run():
    try:
        # Create IoTHubRegistryManager
        registry_manager = IoTHubRegistryManager(CONNECTION_STRING)

        for i in range(0, MESSAGE_COUNT):
            print ( 'Sending message: {0}'.format(i) )
            data = MSG_TXT % (AVG_WIND_SPEED + (random.random() * 4 + 2))

            props={}
            # optional: assign system properties
            props.update(messageId = "message_%d" % i)
            props.update(correlationId = "correlation_%d" % i)
            props.update(contentType = "application/json")

            # optional: assign application properties
            prop_text = "PropMsg_%d" % i
            props.update(testProperty = prop_text)

            registry_manager.send_c2d_message(DEVICE_ID, data, properties=props)

        try:
            # Try Python 2.xx first
            raw_input("Press Enter to continue...\n")
        except:
            pass
            # Use Python 3.xx in the case of exception
            input("Press Enter to continue...\n")

    except Exception as ex:
        print ( "Unexpected error {0}" % ex )
        return
    except KeyboardInterrupt:
        print ( "IoT Hub C2D Messaging service sample stopped" )

次の main 関数を追加します。

if __name__ == '__main__':
    print ( "Starting the Python IoT Hub C2D Messaging service sample..." )

    iothub_messaging_sample_run()

SendCloudToDeviceMessage.py ファイルを保存して閉じます。

アプリケーションの実行

これで、アプリケーションを実行する準備が整いました。

作業ディレクトリのコマンドプロンプトで、次のコマンドを実行して、クラウドからデバイスへのメッセージをリッスンします。
```
python SimulatedDevice.py
```
作業ディレクトリで新しいコマンドプロンプトを開き、次のコマンドを実行して、クラウドからデバイスへのメッセージを送信します。
```
python SendCloudToDeviceMessage.py
```
デバイスによって受信されたメッセージを確認します。

次の手順

この記事では、クラウドからデバイスへのメッセージを送受信する方法を学習しました。

cloud-to-device メッセージの詳細については、「IoT ハブから cloud-to-device メッセージを送信する」を参照してください。
IoT Hub メッセージ形式の詳細については、「IoT Hub メッセージを作成し、読み取る」を参照してください。