クイック スタート:IoT ハブに接続されたデバイスを制御する (Python)Quickstart: Control a device connected to an IoT hub (Python)

IoT Hub は、クラウドから IoT デバイスを管理し、大量のデバイス テレメトリを格納または処理のためにクラウドに取り込むことができるようにする Azure サービスです。IoT Hub is an Azure service that enables you to manage your IoT devices from the cloud, and ingest high volumes of device telemetry to the cloud for storage or processing. このクイック スタートでは、"ダイレクト メソッド" を使って、IoT ハブに接続されているシミュレートされたデバイスを制御します。In this quickstart, you use a direct method to control a simulated device connected to your IoT hub. ダイレクト メソッドを使うと、IoT ハブに接続されたデバイスの動作をリモートで変更できます。You can use direct methods to remotely change the behavior of a device connected to your IoT hub.

このクイック スタートでは、あらかじめ作成されている次の 2 つの Python アプリケーションを使います。The quickstart uses two pre-written Python applications:

  • シミュレートされたデバイス アプリケーションは、バックエンド アプリケーションから呼び出されたダイレクト メソッドに応答します。A simulated device application that responds to direct methods called from a back-end application. ダイレクト メソッドの呼び出しを受け取るため、このアプリケーションは IoT ハブ上のデバイス固有のエンドポイントに接続します。To receive the direct method calls, this application connects to a device-specific endpoint on your IoT hub.

  • バックエンド アプリケーションは、シミュレートされたデバイスでダイレクト メソッドを呼び出します。A back-end application that calls the direct methods on the simulated device. デバイスでダイレクト メソッドを呼び出すため、このアプリケーションは IoT ハブ上のサービス側エンドポイントに接続します。To call a direct method on a device, this application connects to service-side endpoint on your IoT hub.

Azure Cloud Shell を使用するUse Azure Cloud Shell

Azure では、ブラウザーを介して使用できる対話型のシェル環境、Azure Cloud Shell がホストされています。Azure hosts Azure Cloud Shell, an interactive shell environment that you can use through your browser. Cloud Shell では、bashPowerShell のいずれかを使用して Azure サービスを操作できます。Cloud Shell lets you use either bash or PowerShell to work with Azure services. ローカル環境に何もインストールしなくても、Cloud Shell にプレインストールされているコマンドを使用して、この記事のコードを実行できます。You can use the Cloud Shell pre-installed commands to run the code in this article without having to install anything on your local environment.

Azure Cloud Shell を起動するには:To launch Azure Cloud Shell:

オプションOption 例とリンクExample/Link
コード ブロックの右上隅にある [使ってみる] を選択します。Select Try It in the upper-right corner of a code block. [使ってみる] を選択しても、コードは Cloud Shell に自動的にコピーされません。Selecting Try It doesn't automatically copy the code to Cloud Shell. Azure Cloud Shell の [使ってみる] の例
https://shell.azure.com に移動するか、 [Cloud Shell を起動する] ボタンを選択して、ブラウザーで Cloud Shell を開きます。Go to https://shell.azure.com or select the Launch Cloud Shell button to open Cloud Shell in your browser. 新しいウィンドウで Cloud Shell を起動するLaunch Cloud Shell in a new window
Azure portal の右上にあるメニュー バーの [Cloud Shell] ボタンを選択します。Select the Cloud Shell button on the top-right menu bar in the Azure portal. Azure Portal の [Cloud Shell] ボタン

Azure Cloud Shell でこの記事のコードを実行するには:To run the code in this article in Azure Cloud Shell:

  1. Cloud Shell を起動します。Launch Cloud Shell.

  2. [コピー] ボタンを選択して、コード ブロックをコードにコピーします。Select the Copy button on a code block to copy the code.

  3. Windows と Linux では Ctrl + Shift + V キー、macOS では Cmd + Shift + V キーを使用して、コードを Cloud Shell セッションに貼り付けます。Paste the code into the Cloud Shell session with Ctrl+Shift+V on Windows and Linux, or Cmd+Shift+V on macOS.

  4. Enter キーを押して、コードを実行します。Press Enter to run the code.

Azure サブスクリプションがない場合は、開始する前に無料アカウントを作成してください。If you don’t have an Azure subscription, create a free account before you begin.

前提条件Prerequisites

次のコマンドを実行して、Microsoft Azure IoT Extension for Azure CLI を Cloud Shell インスタンスに追加します。Run the following command to add the Microsoft Azure IoT Extension for Azure CLI to your Cloud Shell instance. IoT Hub、IoT Edge、IoT Device Provisioning Service (DPS) 固有のコマンドが Azure CLI に追加されます。The IOT Extension adds IoT Hub, IoT Edge, and IoT Device Provisioning Service (DPS) specific commands to Azure CLI.

az extension add --name azure-cli-iot-ext

まだ行っていない場合は、 https://github.com/Azure-Samples/azure-iot-samples-python/archive/master.zip からサンプル Python プロジェクトをダウンロードし、ZIP アーカイブを抽出します。If you haven't already done so, download the sample Python project from https://github.com/Azure-Samples/azure-iot-samples-python/archive/master.zip and extract the ZIP archive.

IoT Hub の作成Create an IoT hub

前出のデバイスから IoT ハブへの利用統計情報の送信に関するクイック スタートを完了した場合は、この手順を省略できます。If you completed the previous Quickstart: Send telemetry from a device to an IoT hub, you can skip this step.

ここでは、Azure portal を使用して IoT ハブを作成する方法について説明します。This section describes how to create an IoT hub using the Azure portal.

  1. Azure Portal にサインインします。Sign in to the Azure portal.

  2. [リソースの作成] を選択してから、 [Marketplace を検索] フィールドに IoT Hub を入力します。Choose Create a resource, and then enter IoT Hub in the Search the Marketplace field.

  3. 検索結果の [IoT Hub] を選択し、 [作成] を選択します。Select IoT Hub from the search results, and then select Create.

  4. [基本] タブで、次のように各フィールドに入力します。On the Basics tab, complete the fields as follows:

    • サブスクリプション:ハブで使用するサブスクリプションを選択します。Subscription: Select the subscription to use for your hub.

    • リソース グループ:リソース グループを選択するか、新しく作成します。Resource Group: Select a resource group or create a new one. 新たに作成するには、 [新規作成] を選択して、使用する名前を入力します。To create a new one, select Create new and fill in the name you want to use. 既存のリソース グループを使用するには、そのリソース グループを選択します。To use an existing resource group, select that resource group. 詳しくは、「Manage Azure Resource Manager resource groups (Azure Resource Manager のリソース グループの管理)」をご覧ください。For more information, see Manage Azure Resource Manager resource groups.

    • [リージョン] :ハブを配置するリージョンを選択します。Region: Select the region in which you want your hub to be located. ユーザーに最も近い場所を選択します。Select the location closest to you.

    • [IoT Hub 名] : ハブの名前を入力します。IoT Hub Name: Enter a name for your hub. この名前はグローバルに一意である必要があります。This name must be globally unique. 入力した名前が使用可能な場合は、緑色のチェック マークが表示されます。If the name you enter is available, a green check mark appears.

    重要

    IoT ハブは DNS エンドポイントとして公開されるため、名前を付ける際に機密情報や個人を特定できる情報を入力しないように注意してください。Because the IoT hub will be publicly discoverable as a DNS endpoint, be sure to avoid entering any sensitive or personally identifiable information when you name it.

    Azure portal でハブを作成する

  5. [次へ:Size and scale](次へ: サイズとスケール) を選択して、ハブの作成を続けます。Select Next: Size and scale to continue creating your hub.

    Azure portal を使用して新しいハブのサイズとスケールを設定する

    この画面では、以下の値を設定できます。This screen allows you to set the following values:

    • [価格とスケールティア] : 選択したレベル。Pricing and scale tier: Your selected tier. 必要な機能およびソリューションで 1 日に送信するメッセージの数に応じて、複数のレベルから適切なものを選びます。You can choose from several tiers, depending on how many features you want and how many messages you send through your solution per day. 無料レベルは、テストおよび評価用です。The free tier is intended for testing and evaluation. ハブに接続できるデバイスは 500 個で、1 日に許可されるメッセージ数は最大 8,000 件です。It allows 500 devices to be connected to the hub and up to 8,000 messages per day. Azure サブスクリプションごとに、無料レベルの IoT Hub を 1 つ作成できます。Each Azure subscription can create one IoT Hub in the free tier.

    • [IoT Hub ユニット] : ユニットごとに許可される 1 日あたりのメッセージの数は、ハブの価格レベルによって決まります。IoT Hub units: The number of messages allowed per unit per day depends on your hub's pricing tier. たとえば、ハブで 700,000 件のイングレス メッセージをサポートする場合は、S1 レベルのユニットを 2 つ選択します。For example, if you want the hub to support ingress of 700,000 messages, you choose two S1 tier units. 他のレベルのオプションについて詳しくは、適切な IoT Hub レベルの選択に関するページをご覧ください。For details about the other tier options, see Choosing the right IoT Hub tier.

    • [詳細設定] > [Device-to-cloud パーティション] : このプロパティでは、device-to-cloud メッセージがそのメッセージの同時閲覧者数に関連付けられます。Advanced Settings > Device-to-cloud partitions: This property relates the device-to-cloud messages to the number of simultaneous readers of the messages. ほとんどのハブでは、4 つのパーティションのみが必要となります。Most hubs need only four partitions.

  6. この記事では、既定の選択のままにして、 [確認および作成] を選択して選択内容を確認します。For this article, accept the default choices, and then select Review + create to review your choices. 次の画面のようになります。You see something similar to this screen.

    新しいハブを作成するための情報を確認する

  7. [作成] を選択して、新しいハブを作成します。Select Create to create your new hub. ハブの作成には数分かかります。Creating the hub takes a few minutes.

デバイスの登録Register a device

前出のデバイスから IoT ハブへの利用統計情報の送信に関するクイック スタートを完了した場合は、この手順を省略できます。If you completed the previous Quickstart: Send telemetry from a device to an IoT hub, you can skip this step.

デバイスを IoT Hub に接続するには、あらかじめ IoT Hub に登録しておく必要があります。A device must be registered with your IoT hub before it can connect. このクイック スタートでは、Azure Cloud Shell を使用して、シミュレートされたデバイスを登録します。In this quickstart, you use the Azure Cloud Shell to register a simulated device.

  1. Azure Cloud Shell で次のコマンドを実行してデバイス ID を作成します。Run the following command in Azure Cloud Shell to create the device identity.

    YourIoTHubName: このプレースホルダーは、実際の IoT ハブに対して選んだ名前に置き換えてください。YourIoTHubName: Replace this placeholder below with the name you chose for your IoT hub.

    MyPythonDevice: これは、登録するデバイスの名前です。MyPythonDevice: This is the name of the device you're registering. 示されているように、MyPythonDevice を使用することをお勧めします。It's recommended to use MyPythonDevice as shown. デバイスに別の名前を選択した場合は、この記事全体でその名前を使用する必要があります。また、サンプル アプリケーションを実行する前に、アプリケーション内のデバイス名を更新してください。If you choose a different name for your device, you also need to use that name throughout this article, and update the device name in the sample applications before you run them.

    az iot hub device-identity create --hub-name {YourIoTHubName} --device-id MyPythonDevice
    
  2. Azure Cloud Shell で次のコマンドを実行して、登録したデバイスの "デバイス接続文字列" を取得します。Run the following commands in Azure Cloud Shell to get the device connection string for the device you just registered:

    YourIoTHubName: このプレースホルダーは、実際の IoT ハブに対して選んだ名前に置き換えてください。YourIoTHubName: Replace this placeholder below with the name you chose for your IoT hub.

    az iot hub device-identity show-connection-string --hub-name {YourIoTHubName} --device-id MyPythonDevice --output table
    

    次のようなデバイス接続文字列をメモしておきます。Make a note of the device connection string, which looks like:

    HostName={YourIoTHubName}.azure-devices.net;DeviceId=MyNodeDevice;SharedAccessKey={YourSharedAccessKey}

    この値は、このクイック スタートの後の方で使います。You use this value later in the quickstart.

  3. また、バックエンド アプリケーションが IoT ハブに接続してメッセージを取得できるようにするには、"サービス接続文字列" が必要です。You also need a service connection string to enable the back-end application to connect to your IoT hub and retrieve the messages. 次のコマンドを実行すると、IoT ハブのサービス接続文字列が取得されます。The following command retrieves the service connection string for your IoT hub:

    YourIoTHubName: このプレースホルダーは、実際の IoT ハブに対して選んだ名前に置き換えてください。YourIoTHubName: Replace this placeholder below with the name you choose for your IoT hub.

    az iot hub show-connection-string \
      --policy-name service \
      --name {YourIoTHubName} \
      --output table
    

    次のようなサービス接続文字列をメモしておきます。Make a note of the service connection string, which looks like:

    HostName={YourIoTHubName}.azure-devices.net;SharedAccessKeyName=service;SharedAccessKey={YourSharedAccessKey}

    この値は、このクイック スタートの後の方で使います。You use this value later in the quickstart. このサービス接続文字列は、前の手順でメモしたデバイス接続文字列とは異なります。This service connection string is different from the device connection string you noted in the previous step.

ダイレクト メソッドの呼び出しをリッスンするListen for direct method calls

シミュレートされたデバイス アプリケーションは、IoT ハブ上のデバイス固有エンドポイントに接続し、シミュレートされた利用統計情報を送信して、ハブからのダイレクト メソッド呼び出しをリッスンします。The simulated device application connects to a device-specific endpoint on your IoT hub, sends simulated telemetry, and listens for direct method calls from your hub. このクイック スタートでは、ハブからのダイレクト メソッド呼び出しは、利用統計情報の送信間隔を変更するようデバイスに指示します。In this quickstart, the direct method call from the hub tells the device to change the interval at which it sends telemetry. シミュレートされたデバイスでは、ダイレクト メソッドを実行した後、ハブに受信確認が返送されます。The simulated device sends an acknowledgment back to your hub after it executes the direct method.

  1. ローカル ターミナル ウィンドウで、サンプルの Python プロジェクトのルート フォルダーに移動します。In a local terminal window, navigate to the root folder of the sample Python project. 次に、iot-hub\Quickstarts\simulated-device-2 フォルダーに移動します。Then navigate to the iot-hub\Quickstarts\simulated-device-2 folder.

  2. 適当なテキスト エディターで SimulatedDevice.py ファイルを開きます。Open the SimulatedDevice.py file in a text editor of your choice.

    CONNECTION_STRING 変数の値を、前にメモしたデバイス接続文字列に置き換えます。Replace the value of the CONNECTION_STRING variable with the device connection string you made a note of earlier. その後、変更を SimulatedDevice.py に保存します。Then save your changes to SimulatedDevice.py.

  3. ローカル ターミナル ウィンドウで次のコマンドを実行して、シミュレートされたデバイス アプリケーションに必要なライブラリをインストールします。In the local terminal window, run the following commands to install the required libraries for the simulated device application:

    pip install azure-iothub-device-client
    
  4. ローカル ターミナル ウィンドウで次のコマンドを実行して、シミュレートされたデバイス アプリケーションを実行します。In the local terminal window, run the following commands to run the simulated device application:

    python SimulatedDevice.py
    

    次のスクリーンショットは、シミュレートされたデバイス アプリケーションが IoT Hub にテレメトリを送信したときの出力を示しています。The following screenshot shows the output as the simulated device application sends telemetry to your IoT hub:

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

ダイレクト メソッドを呼び出すCall the direct method

バックエンド アプリケーションは、IoT ハブ上のサービス側エンドポイントに接続します。The back-end application connects to a service-side endpoint on your IoT Hub. アプリケーションにより、IoT ハブを通してデバイスへのダイレクト メソッド呼び出しが行われた後、受信確認がリッスンされます。The application makes direct method calls to a device through your IoT hub and listens for acknowledgments. 通常、IoT Hub のバックエンド アプリケーションはクラウドで実行されます。An IoT Hub back-end application typically runs in the cloud.

  1. 別のローカル ターミナル ウィンドウで、サンプルの Python プロジェクトのルート フォルダーに移動します。In another local terminal window, navigate to the root folder of the sample Python project. その後、iot-hub\Quickstarts\back-end-application フォルダーに移動します。Then navigate to the iot-hub\Quickstarts\back-end-application folder.

  2. 適当なテキスト エディターで BackEndApplication.py ファイルを開きます。Open the BackEndApplication.py file in a text editor of your choice.

    CONNECTION_STRING 変数の値を、前にメモしたサービス接続文字列に置き換えます。Replace the value of the CONNECTION_STRING variable with the service connection string you made a note of earlier. 変更を BackEndApplication.py に保存します。Then save your changes to BackEndApplication.py.

  3. ローカル ターミナル ウィンドウで次のコマンドを実行して、シミュレートされたデバイス アプリケーションに必要なライブラリをインストールします。In the local terminal window, run the following commands to install the required libraries for the simulated device application:

    pip install azure-iothub-service-client future
    
  4. ローカル ターミナル ウィンドウで次のコマンドを実行して、バックエンド アプリケーションを実行します。In the local terminal window, run the following commands to run the back-end application:

    python BackEndApplication.py
    

    次のスクリーンショットは、アプリケーションによりデバイスに対してダイレクト メソッド呼び出しが行われ、受信確認が受診されたときの出力を示します。The following screenshot shows the output as the application makes a direct method call to the device and receives an acknowledgment:

    バックエンド アプリケーションを実行する

    バックエンド アプリケーションを実行した後、シミュレートされたデバイスを実行しているコンソール ウィンドウにメッセージが表示され、メッセージの送信速度が変わります。After you run the back-end application, you see a message in the console window running the simulated device, and the rate at which it sends messages changes:

    シミュレートされたクライアントでの変更

リソースのクリーンアップClean up resources

次の推奨記事に進む場合は、既に作成したリソースを維持して、再利用することができます。If you will be continuing to the next recommended article, you can keep the resources you've already created and reuse them.

それ以外の場合は、課金されないようにするために、この記事で作成した Azure リソースを削除してもかまいません。Otherwise, you can delete the Azure resources created in this article to avoid charges.

重要

リソース グループを削除すると、元に戻すことができません。Deleting a resource group is irreversible. リソース グループとそこに含まれるすべてのリソースは完全に削除されます。The resource group and all the resources contained in it are permanently deleted. 間違ったリソース グループやリソースをうっかり削除しないようにしてください。Make sure that you do not accidentally delete the wrong resource group or resources. IoT ハブを、保持したいリソースが含まれている既存のリソース グループ内に作成した場合は、リソース グループを削除するのではなく、IoT Hub リソースだけを削除してください。If you created the IoT Hub inside an existing resource group that contains resources you want to keep, only delete the IoT Hub resource itself instead of deleting the resource group.

名前でリソース グループを削除するには、以下の手順を実行します。To delete a resource group by name:

  1. Azure portal にサインインし、 [リソース グループ] を選択します。Sign in to the Azure portal and select Resource groups.

  2. [名前でフィルター処理してください] テキスト ボックスに、IoT ハブが含まれているリソース グループの名前を入力します。In the Filter by name textbox, type the name of the resource group containing your IoT Hub.

  3. 結果一覧のリソース グループの右側で、 [...][リソース グループの削除] の順に選択します。To the right of your resource group in the result list, select ... then Delete resource group.

    削除

  4. リソース グループの削除の確認を求めるメッセージが表示されます。You will be asked to confirm the deletion of the resource group. 確認のためにもう一度リソース グループの名前を入力し、 [削除] を選択します。Type the name of your resource group again to confirm, and then select Delete. しばらくすると、リソース グループとそこに含まれているすべてのリソースが削除されます。After a few moments, the resource group and all of its contained resources are deleted.

次の手順Next steps

このクイック スタートでは、バックエンド アプリケーションからデバイス上のダイレクト メソッドを呼び出し、シミュレートされたデバイス アプリケーションでダイレクト メソッド呼び出しに応答しました。In this quickstart, you've called a direct method on a device from a back-end application, and responded to the direct method call in a simulated device application.

デバイスからクラウドへのメッセージをクラウド内の異なる宛先にルーティングする方法を学習するには、次のチュートリアルに進んでください。To learn how to route device-to-cloud messages to different destinations in the cloud, continue to the next tutorial.