チュートリアル: Linux または Windows 上で実行されている IoT Plug and Play のサンプルデバイスアプリケーションを IoT Hub に接続する

[アーティクル]
02/06/2024

このチュートリアルでは、IoT プラグアンドプレイデバイスアプリケーションのサンプルをビルドし、それをご利用の IoT ハブに接続し、送信されるテレメトリを Azure IoT エクスプローラーツールを使用して表示する方法を示します。このサンプルアプリケーションは C で記述され、C 対応の Azure IoT device SDK に含められています。ソリューションビルダーは、Azure IoT エクスプローラーツールを使用すれば、デバイスコードを表示しなくても IoT プラグアンドプレイデバイスの機能を理解することができます。

前提条件

続行する前に、IoT ハブを含め、環境が設定されていることを確認してください。

このチュートリアルは Linux または Windows で実行できます。このチュートリアルのシェルコマンドは、パス区切り記号を "/" とする Linux 規則に従っています。Windows 方式に従う場合は、必ずこれらの区切り記号を "\" に置き換えてください。

前提条件は、次のように、オペレーティングシステムによって異なります。

Linux

このチュートリアルは、Ubuntu Linux を使用することを前提としています。このチュートリアルの手順は、Ubuntu 18.04 を使用してテストされました。

このチュートリアルを Linux で完了するには、ご利用のローカルの Linux 環境に以下のソフトウェアをインストールする必要があります。

apt-get コマンドを使用して、GCC、Git、cmake、および必要なすべての依存関係をインストールします。

sudo apt-get update
sudo apt-get install -y git cmake build-essential curl libcurl4-openssl-dev libssl-dev uuid-dev

cmake のバージョンが 2.8.12 より大きく、GCC のバージョンが 4.4.7 より大きいことを確認します。

cmake --version
gcc --version

Windows

Windows でこのチュートリアルを完了するには、ご利用のローカル Windows 環境に次のソフトウェアをインストールします。

Visual Studio (Community、Professional、または Enterprise)。Visual Studio をインストールするときに、 [C++ によるデスクトップ開発] ワークロードを必ず含めてください。
Git.
CMake。

コードのダウンロード

このチュートリアルでは、Azure IoT Hub Device C SDK をクローンしてビルドするために使用できる開発環境を準備します。

任意のディレクトリでコマンドプロンプトを開きます。次のコマンドを実行して、Azure IoT C SDK およびライブラリの GitHub リポジトリをこの場所にクローンします。

git clone https://github.com/Azure/azure-iot-sdk-c.git
cd azure-iot-sdk-c
git submodule update --init

この操作が完了するまで数分かかることが予想されます。

コードのビルド

コードをビルドして実行するには、Visual Studio を使用するか、コマンドラインで cmake を使用します。

Visual Studio を使用する

クローンされたリポジトリのルートフォルダーを開きます。数秒後、プロジェクトを実行してデバッグするのに必要なものがすべて Visual Studio の CMake サポートによって作成されます。
Visual Studio の準備ができたら、ソリューションエクスプローラーで、サンプル iothub_client/samples/pnp/pnp_simple_thermostat/ に移動します。
pnp_simple_thermostat.c ファイルを右クリックし、デバッグ構成の追加を選択します。 [既定値] を選択します。

Visual Studio によって、launch.vs.json ファイルが開かれます。このファイルを、次のスニペットに示すように編集して、必要な環境変数を設定します。「IoT プラグアンドプレイのクイックスタートとチュートリアル用の環境の設定」を完了したときに、スコープ ID と登録プライマリキーを書き留めました。

{
  "version": "0.2.1",
  "defaults": {},
  "configurations": [
    {
      "type": "default",
      "project": "iothub_client\\samples\\pnp\\pnp_simple_thermostat\\pnp_pnp_simple_thermostat.c",
      "projectTarget": "",
      "name": "pnp_simple_thermostat.c",
      "env": {
        "IOTHUB_DEVICE_SECURITY_TYPE": "DPS",
        "IOTHUB_DEVICE_DPS_ID_SCOPE": "<Your ID scope>",
        "IOTHUB_DEVICE_DPS_DEVICE_ID": "my-pnp-device",
        "IOTHUB_DEVICE_DPS_DEVICE_KEY": "<Your enrollment primary key>"
      }
    }
  ]
}

pnp_simple_thermostat.cファイルを右クリックし、スタートアップ項目として設定を選択します。
Visual Studio でのコードの実行をトレースするには、pnp_simple_thermostat.c ファイルの main 関数にブレークポイントを追加します。
これで、 [デバッグ] メニューからサンプルを実行およびデバッグできるようになりました。

これで、デバイスはコマンドとプロパティの更新情報を受信する準備ができ、ハブへのテレメトリデータの送信が開始されました。次の手順を完了するまで、サンプルを実行したままにしておきます。

cmake を使用してコードをビルドする

cmake コマンドラインユーティリティを使用して、コードをビルドします。

デバイス SDK のルートフォルダーに cmake サブディレクトリを作成し、そのフォルダーに移動します。
```
cd azure-iot-sdk-c
mkdir cmake
cd cmake
```

次のコマンドを実行して、SDK とサンプルをビルドします。

cmake -Duse_prov_client=ON -Dhsm_type_symm_key=ON -Drun_e2e_tests=OFF ..
cmake --build .

デバイスサンプルを実行する

環境の設定で、Device Provisioning Service (DPS) を使用して IoT ハブに接続するようにサンプルを構成するための 4 つの環境変数を作成しました。

値が DPS の IOTHUB_DEVICE_SECURITY_TYPE
DPS の ID スコープを格納する IOTHUB_DEVICE_DPS_ID_SCOPE。
値 my-pnp-device を格納する IOTHUB_DEVICE_DPS_DEVICE_ID。
登録プライマリキーを格納する IOTHUB_DEVICE_DPS_DEVICE_KEY。
値 global.azure-devices-provisioning.net を格納する IOTHUB_DEVICE_DPS_ENDPOINT。

サンプル構成の詳細については、サンプルの readme を参照してください。

IoT ハブにテレメトリを送信する IoT プラグアンドプレイデバイスをシミュレートする、SDK のサンプルアプリケーションを実行します。

cmake フォルダーから、実行可能ファイルを含むフォルダーに移動し、そのファイルを実行します。

# Bash
cd iothub_client/samples/pnp/pnp_simple_thermostat/
./pnp_simple_thermostat

REM Windows
cd iothub_client\samples\pnp\pnp_simple_thermostat\Debug
.\pnp_simple_thermostat.exe

ヒント

Windows 上の Visual Studio でコードの実行をトレースするには、main ファイルの main 関数にブレークポイントを追加します。

Azure IoT エクスプローラーを使用してコードを確認する

デバイスクライアントのサンプルが開始された後、Azure IoT エクスプローラーツールを使用して、それが動作していることを確認します。

Azure IoT エクスプローラーを開きます。
IoT ハブへの接続をまだ追加していない場合は、 [IoT ハブ] ページで、 [+ 接続の追加] を選択します。先ほど作成した IoT ハブの接続文字列を入力して、 [保存] を選択します。
[IoT プラグアンドプレイの設定] ページで、[+ 追加] > [ローカルフォルダー] の順に選択し、モデルファイルを保存したローカルの [モデル] フォルダーを選択します。
[IoT ハブ] ページで、操作するハブの名前をクリックします。 IoT ハブに登録されたデバイスの一覧が表示されます。
先ほど作成したデバイスのデバイス ID をクリックします。
左側のメニューに、デバイスで利用できるさまざまな種類の情報が表示されます。
[IoT プラグアンドプレイコンポーネント] を選択して、デバイスのモデル情報を表示します。
デバイスのさまざまなコンポーネントを表示できます。既定のコンポーネントと追加のコンポーネント。操作するコンポーネントを選択します。
[テレメトリ] ページを選択し、 [開始] を選択して、デバイスから送信されているこのコンポーネントのテレメトリデータを表示します。
[プロパティ (読み取り専用)] ページを選択して、このコンポーネントについて報告された読み取り専用プロパティを表示します。
[プロパティ (書き込み可能)] ページを選択して、このコンポーネントに対して更新を行うことができる書き込み可能なプロパティを表示します。
名前でプロパティを選択し、新しい値を入力して、 [Update desired value](必要な値の更新) を選択します。
新しい値が表示されるようにするには、[更新] ボタンを選択します。
[コマンド] ページを選択して、このコンポーネントを対象とするすべてのコマンドを表示します。
テストするコマンドを選択します。パラメーターがある場合は、それを設定します。 [コマンドの送信] を選択して、デバイス上でコマンドを呼び出します。サンプルコードが実行されているコマンドプロンプトウィンドウで、デバイスがコマンドに応答していることを確認できます。

コードの確認

このサンプルにより、単純な IoT プラグアンドプレイのサーモスタットデバイスが実装されます。サーモスタットモデルでは、IoT プラグアンドプレイコンポーネントは使用されません。サーモスタットデバイスの DTDL モデルファイルにより、デバイスによって実装されるテレメトリ、プロパティ、およびコマンドが定義されます。

デバイスコードでは、IoT ハブに接続するために標準の関数が使用されます。

deviceHandle = IoTHubDeviceClient_CreateFromConnectionString(connectionString, MQTT_Protocol)

デバイスにより、接続要求で実装される DTDL モデルのモデル ID が送信されます。モデル ID を送信するデバイスは、IoT プラグアンドプレイデバイスです。

static const char g_ModelId[] = "dtmi:com:example:Thermostat;1";

...

IoTHubDeviceClient_SetOption(deviceHandle, OPTION_MODEL_ID, modelId)

プロパティの更新、コマンドの処理、テレメトリの送信を行うコードは、IoT プラグアンドプレイ規則を使用しないデバイスのコードと同じです。

IoT ハブから送信されたペイロード内の JSON オブジェクトを解析するために、このコードでは Parson ライブラリが使用されます。

// JSON parser
#include "parson.h"

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

クイックスタートとチュートリアルを読み終えたら、「リソースを削除する」を参照してください。

このチュートリアルでは、IoT プラグアンドプレイデバイスアプリケーションのサンプルをビルドし、それをご利用の IoT ハブに接続し、送信されるテレメトリを Azure IoT エクスプローラーツールを使用して表示する方法を示します。このサンプルアプリケーションは C# で記述されており、C# 用 Azure IoT SDK に含まれています。ソリューションビルダーは Azure IoT エクスプローラーツールを使用して、デバイスコードを表示しなくても IoT プラグアンドプレイデバイスの機能を理解することができます。

前提条件

続行する前に、IoT ハブを含め、環境が設定されていることを確認してください。

お使いのプラットフォーム用の最新 .NET SDK。
Git.

コードのダウンロード

このチュートリアルでは、Azure IoT SDK for C# リポジトリをクローンしてビルドするために使用できる開発環境を準備します。

任意のフォルダーでコマンドプロンプトを開きます。次のコマンドを実行して、Microsoft Azure IoT SDK for C# (.NET) GitHub リポジトリをこの場所にクローンします。

git clone  https://github.com/Azure/azure-iot-sdk-csharp

コードのビルド

これで、サンプルをビルドして実行できます。次のコマンドを実行して、サンプルをビルドします。

cd azure-iot-sdk-csharp/iothub/device/samples/solutions/PnpDeviceSamples/Thermostat
dotnet build

デバイスサンプルを実行する

サンプルを実行するには、次のコマンドを実行します。

dotnet run

Azure IoT エクスプローラーを使用してコードを確認する

デバイスクライアントのサンプルが開始された後、Azure IoT エクスプローラーツールを使用して、それが動作していることを確認します。

Azure IoT エクスプローラーを開きます。
IoT ハブへの接続をまだ追加していない場合は、 [IoT ハブ] ページで、 [+ 接続の追加] を選択します。先ほど作成した IoT ハブの接続文字列を入力して、 [保存] を選択します。
[IoT プラグアンドプレイの設定] ページで、[+ 追加] > [ローカルフォルダー] の順に選択し、モデルファイルを保存したローカルの [モデル] フォルダーを選択します。
[IoT ハブ] ページで、操作するハブの名前をクリックします。 IoT ハブに登録されたデバイスの一覧が表示されます。
先ほど作成したデバイスのデバイス ID をクリックします。
左側のメニューに、デバイスで利用できるさまざまな種類の情報が表示されます。
[IoT プラグアンドプレイコンポーネント] を選択して、デバイスのモデル情報を表示します。
デバイスのさまざまなコンポーネントを表示できます。既定のコンポーネントと追加のコンポーネント。操作するコンポーネントを選択します。
[テレメトリ] ページを選択し、 [開始] を選択して、デバイスから送信されているこのコンポーネントのテレメトリデータを表示します。
[プロパティ (読み取り専用)] ページを選択して、このコンポーネントについて報告された読み取り専用プロパティを表示します。
[プロパティ (書き込み可能)] ページを選択して、このコンポーネントに対して更新を行うことができる書き込み可能なプロパティを表示します。
名前でプロパティを選択し、新しい値を入力して、 [Update desired value](必要な値の更新) を選択します。
新しい値が表示されるようにするには、[更新] ボタンを選択します。
[コマンド] ページを選択して、このコンポーネントを対象とするすべてのコマンドを表示します。
テストするコマンドを選択します。パラメーターがある場合は、それを設定します。 [コマンドの送信] を選択して、デバイス上でコマンドを呼び出します。サンプルコードが実行されているコマンドプロンプトウィンドウで、デバイスがコマンドに応答していることを確認できます。

コードの確認

このサンプルにより、単純な IoT プラグアンドプレイのサーモスタットデバイスが実装されます。このサンプルにより実装されるモデルによって、IoT プラグアンドプレイコンポーネントは使用されません。サーモスタットデバイスの Digital Twins Definition Language (DTDL) モデルファイルにより、デバイスによって実装されるテレメトリ、プロパティ、およびコマンドが定義されます。

デバイスコードにより、標準の CreateFromConnectionString メソッドが使用され、IoT ハブに接続されます。デバイスにより、接続要求で実装される DTDL モデルのモデル ID が送信されます。モデル ID を送信するデバイスは、IoT プラグアンドプレイデバイスです。

private static void InitializeDeviceClientAsync()
{
  var options = new ClientOptions
  {
    ModelId = ModelId,
  };
  s_deviceClient = DeviceClient.CreateFromConnectionString(s_deviceConnectionString, TransportType.Mqtt, options);
  s_deviceClient.SetConnectionStatusChangesHandler((status, reason) =>
  {
     s_logger.LogDebug($"Connection status change registered - status={status}, reason={reason}.");
  });
}

モデル ID は、次のスニペットに示すように、コードに格納されます。

private const string ModelId = "dtmi:com:example:Thermostat;1";

プロパティの更新、コマンドの処理、テレメトリの送信を行うコードは、IoT プラグアンドプレイ規則を使用しないデバイスのコードと同じです。

IoT ハブから送信されたペイロード内の JSON オブジェクトを解析するために、このサンプルによって JSON ライブラリが使用されます。

using Newtonsoft.Json;

...

DateTime since = JsonConvert.DeserializeObject<DateTime>(request.DataAsJson);

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

クイックスタートとチュートリアルを読み終えたら、「リソースを削除する」を参照してください。

このチュートリアルでは、IoT プラグアンドプレイデバイスアプリケーションのサンプルをビルドし、それをご利用の IoT ハブに接続し、送信されるテレメトリを Azure IoT エクスプローラーツールを使用して表示する方法を示します。このサンプルアプリケーションは Java で記述されており、Java 用 Azure IoT device SDK に含まれています。ソリューションビルダーは Azure IoT エクスプローラーツールを使用して、デバイスコードを表示しなくても IoT プラグアンドプレイデバイスの機能を理解することができます。

前提条件

続行する前に、IoT ハブを含め、環境が設定されていることを確認してください。

このチュートリアルを完了するには、ローカル開発環境に次のソフトウェアをインストールします。

コードのダウンロード

このチュートリアルでは、Azure IoT Hub Device Java SDK をクローンしてビルドするために使用できる開発環境を準備します。

任意のディレクトリでコマンドプロンプトを開きます。次のコマンドを実行して、Azure IoT Java SDK およびライブラリの GitHub リポジトリをこの場所にクローンします。

git clone https://github.com/Azure/azure-iot-sdk-java.git

コードのビルド

複製された Java SDK リポジトリ内のサーモスタットサンプルのルートフォルダーに移動し、ビルドします。

cd azure-iot-sdk-java/device/iot-device-samples/pnp-device-sample/thermostat-device-sample
mvn clean package

デバイスサンプルを実行する

環境の設定で、Device Provisioning Service (DPS) を使用して IoT ハブに接続するようにサンプルを構成するための 4 つの環境変数を作成しました。

値が DPS の IOTHUB_DEVICE_SECURITY_TYPE
DPS の ID スコープを格納する IOTHUB_DEVICE_DPS_ID_SCOPE。
値 my-pnp-device を格納する IOTHUB_DEVICE_DPS_DEVICE_ID。
登録プライマリキーを格納する IOTHUB_DEVICE_DPS_DEVICE_KEY。
値 global.azure-devices-provisioning.net を格納する IOTHUB_DEVICE_DPS_ENDPOINT。

サンプル構成の詳細については、サンプルの readme を参照してください。

/device/iot-device-samples/pnp-device-sample/thermostat-device-sample フォルダーからアプリケーションを実行します。

mvn exec:java -Dexec.mainClass="samples.com.microsoft.azure.sdk.iot.device.Thermostat"

Azure IoT エクスプローラーを使用してコードを確認する

デバイスクライアントのサンプルが開始された後、Azure IoT エクスプローラーツールを使用して、それが動作していることを確認します。

Azure IoT エクスプローラーを開きます。
IoT ハブへの接続をまだ追加していない場合は、 [IoT ハブ] ページで、 [+ 接続の追加] を選択します。先ほど作成した IoT ハブの接続文字列を入力して、 [保存] を選択します。
[IoT プラグアンドプレイの設定] ページで、[+ 追加] > [ローカルフォルダー] の順に選択し、モデルファイルを保存したローカルの [モデル] フォルダーを選択します。
[IoT ハブ] ページで、操作するハブの名前をクリックします。 IoT ハブに登録されたデバイスの一覧が表示されます。
先ほど作成したデバイスのデバイス ID をクリックします。
左側のメニューに、デバイスで利用できるさまざまな種類の情報が表示されます。
[IoT プラグアンドプレイコンポーネント] を選択して、デバイスのモデル情報を表示します。
デバイスのさまざまなコンポーネントを表示できます。既定のコンポーネントと追加のコンポーネント。操作するコンポーネントを選択します。
[テレメトリ] ページを選択し、 [開始] を選択して、デバイスから送信されているこのコンポーネントのテレメトリデータを表示します。
[プロパティ (読み取り専用)] ページを選択して、このコンポーネントについて報告された読み取り専用プロパティを表示します。
[プロパティ (書き込み可能)] ページを選択して、このコンポーネントに対して更新を行うことができる書き込み可能なプロパティを表示します。
名前でプロパティを選択し、新しい値を入力して、 [Update desired value](必要な値の更新) を選択します。
新しい値が表示されるようにするには、[更新] ボタンを選択します。
[コマンド] ページを選択して、このコンポーネントを対象とするすべてのコマンドを表示します。
テストするコマンドを選択します。パラメーターがある場合は、それを設定します。 [コマンドの送信] を選択して、デバイス上でコマンドを呼び出します。サンプルコードが実行されているコマンドプロンプトウィンドウで、デバイスがコマンドに応答していることを確認できます。

コードの確認

このサンプルにより、単純な IoT プラグアンドプレイのサーモスタットデバイスが実装されます。このサンプルにより実装されるモデルによって、IoT プラグアンドプレイコンポーネントは使用されません。サーモスタットデバイスの DTDL モデルファイルにより、デバイスによって実装されるテレメトリ、プロパティ、およびコマンドが定義されます。

デバイスコードによって、IoT ハブに接続するために標準の DeviceClient クラスが使用されます。デバイスにより、接続要求で実装される DTDL モデルのモデル ID が送信されます。モデル ID を送信するデバイスは、IoT プラグアンドプレイデバイスです。

private static void initializeDeviceClient() throws URISyntaxException, IOException {
    ClientOptions options = new ClientOptions();
    options.setModelId(MODEL_ID);
    deviceClient = new DeviceClient(deviceConnectionString, protocol, options);

    deviceClient.registerConnectionStatusChangeCallback((status, statusChangeReason, throwable, callbackContext) -> {
        log.debug("Connection status change registered: status={}, reason={}", status, statusChangeReason);

        if (throwable != null) {
            log.debug("The connection status change was caused by the following Throwable: {}", throwable.getMessage());
            throwable.printStackTrace();
        }
    }, deviceClient);

    deviceClient.open();
}

モデル ID は、次のスニペットに示すように、コードに格納されます。

private static final String MODEL_ID = "dtmi:com:example:Thermostat;1";

プロパティの更新、コマンドの処理、テレメトリの送信を行うコードは、IoT プラグアンドプレイ規則を使用しないデバイスのコードと同じです。

IoT ハブから送信されたペイロード内の JSON オブジェクトを解析するために、このサンプルによって JSON ライブラリが使用されます。

import com.google.gson.Gson;

...

Date since = new Gson().fromJson(jsonRequest, Date.class);

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

クイックスタートとチュートリアルを読み終えたら、「リソースを削除する」を参照してください。

このチュートリアルでは、IoT プラグアンドプレイデバイスアプリケーションのサンプルをビルドし、それをご利用の IoT ハブに接続し、送信されるテレメトリを Azure IoT エクスプローラーツールを使用して表示する方法を示します。このサンプルアプリケーションは Node.js で記述されており、Node.js 用 Azure IoT device SDK に含まれています。ソリューションビルダーは Azure IoT エクスプローラーツールを使用して、デバイスコードを表示しなくても IoT プラグアンドプレイデバイスの機能を理解することができます。

前提条件

続行する前に、IoT ハブを含め、環境が設定されていることを確認してください。

このチュートリアルを完了するには、開発用コンピューターに Node.js が必要です。 nodejs.org から、複数のプラットフォームに対応した最新の推奨バージョンをダウンロードできます。

開発コンピューターに現在インストールされている Node.js のバージョンは、次のコマンドを使って確認できます。

node --version

コードのダウンロード

このチュートリアルでは、Node.js 用 Azure IoT Hub Device SDK をクローンしてビルドするために使用できる開発環境を準備します。

任意のディレクトリでコマンドプロンプトを開きます。次のコマンドを実行して、Node.js 用 Microsoft Azure IoT SDK GitHub リポジトリをこの場所にクローンします。

git clone https://github.com/Azure/azure-iot-sdk-node

必要なライブラリをインストールする

デバイス SDK を使用して、含まれているサンプルコードをビルドします。ビルドしたアプリケーションでは、IoT ハブに接続するデバイスのシミュレーションが行われます。アプリケーションによりテレメトリとプロパティが送信され、コマンドが受け取られます。

ローカルターミナルウィンドウで、クローンしたリポジトリのフォルダーに移動し、 /azure-iot-sdk-node/device/samples/javascript フォルダーに移動します。次に、次のコマンドを実行して、必要なライブラリをインストールします。
```
npm install
```

サンプルデバイスを実行する

pnp_simple_thermostat.js ファイルを開きます。このファイルでは、以下の方法を確認できます。

必要なインターフェイスをインポートする。
プロパティ更新ハンドラーとコマンドハンドラーを記述する。
必要なプロパティの修正プログラムを処理し、テレメトリを送信する。
必要に応じて、Azure Device Provisioning Service (DPS) を使用して、デバイスをプロビジョニングする。

main 関数では、すべてがどのようにまとめられているかを確認できます。

接続文字列からデバイスを作成するか、DPS を使用してデバイスをプロビジョニングします。
IoT プラグアンドプレイのデバイスモデルを指定するには、modelID オプションを使用します。
コマンドハンドラーを有効にします。
デバイスからハブにテレメトリを送信します。
デバイスツインを取得し、レポートされたプロパティを更新します。
必要なプロパティ更新ハンドラーを有効にします。

環境の設定で、Device Provisioning Service (DPS) を使用して IoT ハブに接続するようにサンプルを構成するための 4 つの環境変数を作成しました。

値が DPS の IOTHUB_DEVICE_SECURITY_TYPE
DPS の ID スコープを格納する IOTHUB_DEVICE_DPS_ID_SCOPE。
値 my-pnp-device を格納する IOTHUB_DEVICE_DPS_DEVICE_ID。
登録プライマリキーを格納する IOTHUB_DEVICE_DPS_DEVICE_KEY。
値 global.azure-devices-provisioning.net を格納する IOTHUB_DEVICE_DPS_ENDPOINT。

サンプル構成の詳細については、サンプルの readme を参照してください。

サンプルアプリケーションを実行して、IoT ハブにテレメトリを送信する IoT プラグアンドプレイデバイスをシミュレートします。サンプルアプリケーションを実行するには、次のコマンドを使用します。

node pnp_simple_thermostat.js

次の出力が表示されます。これは、デバイスがハブへの利用統計情報の送信を開始し、コマンドとプロパティの更新情報を受信する準備ができたことを示します。

デバイス確認メッセージ

次の手順を完了するまで、サンプルを実行したままにしておきます。

Azure IoT エクスプローラーを使用してコードを確認する

デバイスクライアントのサンプルが開始された後、Azure IoT エクスプローラーツールを使用して、それが動作していることを確認します。

Azure IoT エクスプローラーを開きます。
IoT ハブへの接続をまだ追加していない場合は、 [IoT ハブ] ページで、 [+ 接続の追加] を選択します。先ほど作成した IoT ハブの接続文字列を入力して、 [保存] を選択します。
[IoT プラグアンドプレイの設定] ページで、[+ 追加] > [ローカルフォルダー] の順に選択し、モデルファイルを保存したローカルの [モデル] フォルダーを選択します。
[IoT ハブ] ページで、操作するハブの名前をクリックします。 IoT ハブに登録されたデバイスの一覧が表示されます。
先ほど作成したデバイスのデバイス ID をクリックします。
左側のメニューに、デバイスで利用できるさまざまな種類の情報が表示されます。
[IoT プラグアンドプレイコンポーネント] を選択して、デバイスのモデル情報を表示します。
デバイスのさまざまなコンポーネントを表示できます。既定のコンポーネントと追加のコンポーネント。操作するコンポーネントを選択します。
[テレメトリ] ページを選択し、 [開始] を選択して、デバイスから送信されているこのコンポーネントのテレメトリデータを表示します。
[プロパティ (読み取り専用)] ページを選択して、このコンポーネントについて報告された読み取り専用プロパティを表示します。
[プロパティ (書き込み可能)] ページを選択して、このコンポーネントに対して更新を行うことができる書き込み可能なプロパティを表示します。
名前でプロパティを選択し、新しい値を入力して、 [Update desired value](必要な値の更新) を選択します。
新しい値が表示されるようにするには、[更新] ボタンを選択します。
[コマンド] ページを選択して、このコンポーネントを対象とするすべてのコマンドを表示します。
テストするコマンドを選択します。パラメーターがある場合は、それを設定します。 [コマンドの送信] を選択して、デバイス上でコマンドを呼び出します。サンプルコードが実行されているコマンドプロンプトウィンドウで、デバイスがコマンドに応答していることを確認できます。

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

クイックスタートとチュートリアルを読み終えたら、「リソースを削除する」を参照してください。

このチュートリアルでは、IoT プラグアンドプレイデバイスアプリケーションのサンプルをビルドし、それをご利用の IoT ハブに接続し、送信されるテレメトリを Azure IoT エクスプローラーツールを使用して表示する方法を示します。このサンプルアプリケーションは Python 用に記述されており、Python 用 Azure IoT Hub デバイス SDK に含まれています。ソリューションビルダーは Azure IoT エクスプローラーツールを使用して、デバイスコードを表示しなくても IoT プラグアンドプレイデバイスの機能を理解することができます。

前提条件

続行する前に、IoT ハブを含め、環境が設定されていることを確認してください。

このチュートリアルを完了するには、開発用コンピューターに Python をインストールする必要があります。現在の Python バージョンの要件については、Azure IoT Python SDK を確認してください。次のコマンドを使用して、ご利用の Python のバージョンを確認できます。

python --version

python.org から、複数のプラットフォームに対応した最新の推奨バージョンをダウンロードできます。

ローカルの Python 環境で、次のようにパッケージをインストールします。

pip install azure-iot-device

Python SDK IoT リポジトリをクローンします。

git clone --branch v2 https://github.com/Azure/azure-iot-sdk-python

サンプルデバイスを実行する

azure-iot-sdk-python/samples/pnp フォルダーには、IoT プラグアンドプレイデバイスのサンプルコードが含まれています。このチュートリアルでは、simple_thermostat.py ファイルを使用します。このサンプルコードでは、IoT プラグアンドプレイ互換デバイスを実装し、Azure IoT Python デバイスクライアントライブラリを使用します。

テキストエディターで simple_thermostat.py ファイルを開きます。次の点に注意してください。

サーモスタットを一意に表す単一のデバイスツインモデル識別子 (DTMI) を定義しています。 DTMI は、ユーザーに認識されている必要があり、デバイス実装のシナリオによって異なります。現在のサンプルでは、モデルは、温度の監視に関連付けられたテレメトリ、プロパティ、およびコマンドを持つサーモスタットを表します。
コマンドハンドラーの実装を定義するための関数があります。これらのハンドラーを記述して、コマンド要求に対してデバイスがどのように応答するかを定義します。
コマンド応答を定義するための関数があります。コマンド応答関数を作成して、IoT ハブに応答を返送します。
アプリケーションを終了するための入力キーボードリスナー関数を定義しています。
main 関数があります。 main 関数は、以下のことを行います。
1. デバイス SDK を使用してデバイスクライアントを作成し、IoT ハブに接続します。
2. プロパティを更新します。 Thermostat モデルでは、Thermostatの 2 つのプロパティとしてtargetTemperatureとmaxTempSinceLastRebootが定義されています。プロパティは、device_client で定義されている patch_twin_reported_properties メソッドを使用して更新されます。
3. execute_command_listener 関数を使用して、コマンド要求のリッスンが開始されます。この関数により、サービスからのコマンドをリッスンするように "リスナー" が設定されます。リスナーを設定するときに、method_name、user_command_handler、create_user_response_handler を指定します。
  - user_command_handler 関数により、コマンドを受信したときにデバイスによって行われる必要がある内容が定義されます。
  - create_user_response_handler 関数により、コマンドが正常に実行されたときに IoT ハブに送信される応答が作成されます。この応答はポータルで確認できます。
4. テレメトリの送信が開始されます。 pnp_methods.py ファイルには、pnp_send_telemetry が定義されています。サンプルコードでは、ループを使用して、8 秒ごとにこの関数を呼び出しています。
5. ユーザーが Q または q キーを押したら、すべてのリスナーとタスクを無効にし、ループを終了します。

環境の設定で、Device Provisioning Service (DPS) を使用して IoT ハブに接続するようにサンプルを構成するための 4 つの環境変数を作成しました。

値が DPS の IOTHUB_DEVICE_SECURITY_TYPE
DPS の ID スコープを格納する IOTHUB_DEVICE_DPS_ID_SCOPE。
値 my-pnp-device を格納する IOTHUB_DEVICE_DPS_DEVICE_ID。
登録プライマリキーを格納する IOTHUB_DEVICE_DPS_DEVICE_KEY。
値 global.azure-devices-provisioning.net を格納する IOTHUB_DEVICE_DPS_ENDPOINT。

サンプル構成の詳細については、サンプルの readme を参照してください。

これでコードを見終えたので、次のコマンドを使用してサンプルを実行します。

python simple_thermostat.py

次の出力が表示されます。これは、デバイスによってハブにテレメトリデータが送信され、コマンドとプロパティの更新情報を受信する準備ができたことを示します。

Listening for command requests and property updates
Press Q to quit
Sending telemetry for temperature
Sent message

次の手順を完了するまで、サンプルを実行したままにしておきます。

Azure IoT エクスプローラーを使用してコードを確認する

デバイスクライアントのサンプルが開始された後、Azure IoT エクスプローラーツールを使用して、それが動作していることを確認します。

Azure IoT エクスプローラーを開きます。
IoT ハブへの接続をまだ追加していない場合は、 [IoT ハブ] ページで、 [+ 接続の追加] を選択します。先ほど作成した IoT ハブの接続文字列を入力して、 [保存] を選択します。
[IoT プラグアンドプレイの設定] ページで、[+ 追加] > [ローカルフォルダー] の順に選択し、モデルファイルを保存したローカルの [モデル] フォルダーを選択します。
[IoT ハブ] ページで、操作するハブの名前をクリックします。 IoT ハブに登録されたデバイスの一覧が表示されます。
先ほど作成したデバイスのデバイス ID をクリックします。
左側のメニューに、デバイスで利用できるさまざまな種類の情報が表示されます。
[IoT プラグアンドプレイコンポーネント] を選択して、デバイスのモデル情報を表示します。
デバイスのさまざまなコンポーネントを表示できます。既定のコンポーネントと追加のコンポーネント。操作するコンポーネントを選択します。
[テレメトリ] ページを選択し、 [開始] を選択して、デバイスから送信されているこのコンポーネントのテレメトリデータを表示します。
[プロパティ (読み取り専用)] ページを選択して、このコンポーネントについて報告された読み取り専用プロパティを表示します。
[プロパティ (書き込み可能)] ページを選択して、このコンポーネントに対して更新を行うことができる書き込み可能なプロパティを表示します。
名前でプロパティを選択し、新しい値を入力して、 [Update desired value](必要な値の更新) を選択します。
新しい値が表示されるようにするには、[更新] ボタンを選択します。
[コマンド] ページを選択して、このコンポーネントを対象とするすべてのコマンドを表示します。
テストするコマンドを選択します。パラメーターがある場合は、それを設定します。 [コマンドの送信] を選択して、デバイス上でコマンドを呼び出します。サンプルコードが実行されているコマンドプロンプトウィンドウで、デバイスがコマンドに応答していることを確認できます。

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

クイックスタートとチュートリアルを読み終えたら、「リソースを削除する」を参照してください。

"制約のあるデバイス" 向けの開発を行っている場合、IoT プラグアンドプレイを以下と共に使用できます。

この記事には、これらの制約のあるシナリオに向けたリンクとリソースが含まれています。

必須コンポーネント

以下のサンプルの多くは、特定のハードウェアデバイスが必要であり、前提条件はサンプルごとに異なります。詳細な前提条件、構成、ビルド手順については、関連するサンプルへのリンクをたどってください。

埋め込み C 用の Azure SDK を使用する

埋め込み C 用の SDK には、IoT プラグアンドプレイ規則の使用を含め、制約のあるデバイスを Azure IoT サービスに接続するための軽量ソリューションが用意されています。下記のリンク先には、MCU ベースのデバイス用のサンプルと、教育およびデバッグ目的のサンプルが含まれます。

MCU ベースのデバイスを使用する

埋め込み C 用の SDK、Device Provisioning Service、IoT プラグアンドプレイを MCU で使用する完全なエンドツーエンドのチュートリアルについては、IoT Hub Device Provisioning Service を介して Azure に接続するための PIC-IoT Wx 開発ボードの用途変更に関するページをご覧ください。

導入用サンプル

埋め込み C 用の SDK のリポジトリには、IoT プラグアンドプレイの使用方法を示すいくつかのサンプルが含まれています。

Note

これらのサンプルでは、教育およびデバッグの目的で、Windows および Linux での実行が示されます。運用環境のシナリオでは、サンプルは制約のあるデバイスのみを対象としています。

Eclipse ThreadX の使用

Eclipse ThreadX には、Azure IoT クラウドサービスにネイティブ接続を追加する軽量なレイヤーが含まれています。このレイヤーでは、Eclipse ThreadX の高度な機能を使用しながら、制約のあるデバイスを Azure IoT に接続するための簡単なメカニズムが提供されます。詳細については、「Eclipse ThreadX の概要」を参照してください。

ツールチェーン

Eclipse ThreadX のサンプルは、さまざまな種類の IDE とツールチェーンの組み合わせで提供されています。次に例を示します。

IAR:IAR の Embedded Workbench IDE
GCC/CMake: オープンソースの CMake ビルドシステムと GNU Arm Embedded toolchain の上に構築されています。
MCUExpresso:NXP の MCUXpresso IDE
STM32Cube: STMicroelectronics の STM32Cube IDE
MPLAB:Microchip の MPLAB X IDE

サンプル

Eclipse ThreadX と IoT プラグアンドプレイによってさまざまなデバイスの使用を開始する方法を示すサンプルを次の表に示します。

メーカー	Device	サンプル
Microchip	ATSAME54-XPRO	GCC/CMake • IAR • MPLAB
MXCHIP	AZ3166	GCC/CMake
NXP	MIMXRT1060-EVK	GCC/CMake • IAR • MCUXpresso
STMicroelectronics	32F746GDISCOVERY	IAR • STM32Cube
STMicroelectronics	B-L475E-IOT01	GCC/CMake • IAR • STM32Cube
STMicroelectronics	B-L4S5I-IOT01	GCC/CMake • IAR • STM32Cube

次のステップ

このチュートリアルでは、IoT Plug and Play デバイスを IoT ハブに接続する方法を学習しました。ご利用の IoT プラグアンドプレイデバイスとやりとりするソリューションを構築する方法の詳細については、次を参照してください。

方法: デバイスに接続してやりとりする

次の方法で共有

チュートリアル: Linux または Windows 上で実行されている IoT Plug and Play のサンプル デバイス アプリケーションを IoT Hub に接続する

前提条件

Linux

Windows

コードのダウンロード

コードのビルド

Visual Studio を使用する

cmake を使用してコードをビルドする

デバイス サンプルを実行する

Azure IoT エクスプローラーを使用してコードを確認する

コードの確認

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

前提条件

コードのダウンロード

コードのビルド

デバイス サンプルを実行する

Azure IoT エクスプローラーを使用してコードを確認する

コードの確認

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

前提条件

コードのダウンロード

コードのビルド

デバイス サンプルを実行する

Azure IoT エクスプローラーを使用してコードを確認する

コードの確認

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

前提条件

コードのダウンロード

必要なライブラリをインストールする

サンプル デバイスを実行する

Azure IoT エクスプローラーを使用してコードを確認する

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

前提条件

サンプル デバイスを実行する

Azure IoT エクスプローラーを使用してコードを確認する

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

必須コンポーネント

埋め込み C 用の Azure SDK を使用する

MCU ベースのデバイスを使用する

導入用サンプル

Eclipse ThreadX の使用

ツールチェーン

サンプル

次のステップ

フィードバック

その他のリソース

チュートリアル: Linux または Windows 上で実行されている IoT Plug and Play のサンプルデバイスアプリケーションを IoT Hub に接続する

デバイスサンプルを実行する

デバイスサンプルを実行する

デバイスサンプルを実行する

サンプルデバイスを実行する

サンプルデバイスを実行する