新しいシミュレートされたデバイスの作成とテスト

[アーティクル]
03/08/2019

リモート監視ソリューションアクセラレータを使用すると、独自のシミュレーションされたデバイスを定義できます。この記事では、新しいシミュレートされた lightbulb デバイスを定義し、それをローカルでテストする方法を説明します。ソリューションアクセラレータには、chiller や truck などのシミュレートされたデバイスがあります。ただし、実際のデバイスを展開する前に、独自のシミュレートされたデバイスを定義して IoT ソリューションをテストすることができます。

注意

この記事では、デバイスシミュレーションサービスでホストされているシミュレートされたデバイスを使用する方法について説明します。実際のデバイスを作成する場合は、「デバイスをリモート監視ソリューションアクセラレータに接続する」を参照してください。

このハウツーガイドでは、デバイスシミュレーションマイクロサービスをカスタマイズする方法について説明します。このマイクロサービスは、リモート監視ソリューションアクセラレータの一部です。デバイスシミュレーション機能を説明するために、このハウツーガイドでは、Contoso IoT アプリケーションの 2 つのシナリオを使用しています。

1 つ目のシナリオでは、新しいテレメトリタイプを Contoso の既存の Chiller デバイスの種類に追加します。

2 つ目のシナリオでは、Contoso がスマート電球の新しいデバイスをテストします。このテストを実行するために、次の特性を備える、新しいシミュレートされたデバイスを作成します。

Properties

名前	値
Color	白、赤、青
Brightness	0 から 100
推定寿命	10,000 時間からカウントダウン

テレメトリ

次の表に、電球がクラウドにデータストリームとしてレポートするデータを示します。

名前	値
Status	"オン"、"オフ"
気温	度 (華氏)
オンライン	true、false

Note

オンライン テレメトリ値は、シミュレートされるすべての種類で必須です。

Methods

次の表に、新しいデバイスがサポートするアクションを示します。

名前
オンにする
オフにする

初期状態

次の表に、デバイスの初期状態を示します。

名前	値
初期の色	White
初期の明るさ	75
初期の寿命	10,000
初期のテレメトリ状態	"オン"
初期のテレメトリ温度	200

このハウツーガイドの手順を完了するには、アクティブな Azure サブスクリプションが必要です。

Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。

Azure Cloud Shell を使用する

Azure では、ブラウザーを介して使用できる対話型のシェル環境、Azure Cloud Shell がホストされています。 Cloud Shell で Bash または PowerShell を使用して、Azure サービスを操作できます。ローカル環境に何もインストールしなくても、Cloud Shell にプレインストールされているコマンドを使用して、この記事のコードを実行できます。

Azure Cloud Shell を開始するには:

オプション	例とリンク
コードブロックの右上隅にある [使ってみる] を選択します。 [使ってみる] を選択しても、コードは Cloud Shell に自動的にコピーされません。
https://shell.azure.com に移動するか、[Cloud Shell を起動する] ボタンを選択して、ブラウザーで Cloud Shell を開きます。
Azure portal の右上にあるメニューバーの [Cloud Shell] ボタンを選択します。

Azure Cloud Shell でこの記事のコードを実行するには:

Cloud Shell を開始します。
[コピー] ボタンを選択して、コードブロックをコードにコピーします。
Windows と Linux では CtrlShiftV キーを選択し、macOS では CmdShiftV キーを選択して、コードを Cloud Shell セッションに貼り付けます。
Enter キーを選択して、コードを実行します。

前提条件

このハウツーガイドに従うには、次のものが必要です。

Visual Studio Code。 Visual Studio Code for Mac、Linux、および Windows をダウンロードできます。
.NET Core。 Mac、Linux、および Windows 用の .NET Core をダウンロードできます。
Visual Studio Code 用 C#
Postman。 Postman for Mac、Windows、または Linux をダウンロードできます。
Azure サブスクリプションにデプロイされた IoT ハブ。このガイドの手順を完了するには、IoT ハブの接続文字列が必要です。この接続文字列は、Azure portal から取得できます。
強力な一貫性を確保するよう構成された、SQL API を使用する Cosmos DB データベース。このガイドの手順を完了するには、Cosmos DB データベースの接続文字列が必要です。この接続文字列は、Azure portal から取得できます。

開発環境を準備する

開発環境を準備するには、次のタスクを実行します。

デバイスシミュレーションマイクロサービスのソースをダウンロードします。
ストレージアダプターマイクロサービスのソースをダウンロードします。
ストレージアダプターマイクロサービスをローカルで実行します。

この記事の手順では、Windows の使用を想定しています。別のオペレーティングシステムを使用している場合は、環境に合わせてファイルパスとコマンドの一部を調整することが必要になる場合があります。

マイクロサービスをダウンロードする

リモート監視マイクロサービスを GitHub からローカルコンピューター上の適切な場所にダウンロードして解凍します。この記事では、このフォルダーの名前は remote-monitoring-services-dotnet-master であることを前提としています。

デバイスシミュレーションマイクロサービスを GitHub からローカルコンピューター上の適切な場所にダウンロードし、解凍します。この記事では、このフォルダーの名前は device-simulation-dotnet-master であることを前提としています。

ストレージアダプターマイクロサービスを実行する

Visual Studio Code で remote-monitoring-services-dotnet-master\storage-adapter フォルダーを開きます。未解決の依存関係がある場合は、 [復元] ボタンをクリックして修正します。

storage-adapter/WebService/appsettings.ini ファイルを開き、Cosmos DB 接続文字列を documentDBConnectionString 変数に割り当てます。

マイクロサービスをローカルで実行するために、 [デバッグ] > [デバッグの開始] をクリックします。

Visual Studio Code のターミナル ウィンドウに、実行中のマイクロサービスからの出力が表示されます。これに、Web サービスの正常性チェック用の URL (http://127.0.0.1:9022/v1/status) が含まれます。このアドレスに移動すると、状態が "OK: Alive and well" と表示されます。

ストレージアダプターマイクロサービスは、次の手順を実行している間もこの Visual Studio Code のインスタンスで実行したままにしておきます。

冷却装置を変更する

このセクションでは、新しい内部温度テレメトリの種類を既存の Chiller デバイスの種類に追加します。

ローカルコンピューター上に新しいフォルダー C:\temp\devicemodels を作成します。

ダウンロードしたデバイスシミュレーションマイクロサービスのコピーから、次のファイルを新しいフォルダーにコピーします。

source	到着地
Services\data\devicemodels\chiller-01.json	C:\temp\devicemodels\chiller-01.json
Services\data\devicemodels\scripts\chiller-01-state.js	C:\temp\devicemodels\scripts\chiller-01-state.js
Services\data\devicemodels\scripts\Reboot-method.js	C:\temp\devicemodels\scripts\Reboot-method.js
Services\data\devicemodels\scripts\FirmwareUpdate-method.js	C:\temp\devicemodels\scripts\FirmwareUpdate-method.js
Services\data\devicemodels\scripts\EmergencyValveRelease-method.js	C:\temp\devicemodels\scripts\EmergencyValveRelease-method.js
Services\data\devicemodels\scripts\IncreasePressure-method.js	C:\temp\devicemodels\scripts\IncreasePressure-method.js

C:\temp\devicemodels\chiller-01.json ファイルを開きます。
InitialState セクションに、次の 2 つの定義を追加します。
```
"internal_temperature": 65.0,
"internal_temperature_unit": "F",
```

Telemetry 配列に、次の定義を追加します。

{
  "Interval": "00:00:05",
  "MessageTemplate": "{\"internal_temperature\":${internal_temperature},\"internal_temperature_unit\":\"${internal_temperature_unit}\"}",
  "MessageSchema": {
    "Name": "chiller-internal-temperature;v1",
    "Format": "JSON",
    "Fields": {
      "temperature": "double",
      "temperature_unit": "text"
    }
  }
},

C:\temp\devicemodels\chiller-01.json ファイルを保存します。
C:\temp\devicemodels\scripts\chiller-01-state.js ファイルを開きます。

state 変数に次のフィールドを追加します。

internal_temperature: 65.0,
internal_temperature_unit: "F",

main 関数を次のように更新します。

function main(context, previousState, previousProperties) {

    // Restore the global state before generating the new telemetry, so that
    // the telemetry can apply changes using the previous function state.
    restoreSimulation(previousState, previousProperties);

    // 75F +/- 5%,  Min 25F, Max 100F
    state.temperature = vary(75, 5, 25, 100);

    // 70% +/- 5%,  Min 2%, Max 99%
    state.humidity = vary(70, 5, 2, 99);

    // 65F +/- 2%,  Min 15F, Max 125F
    state.internal_temperature = vary(65, 2, 15, 125);

    log("Simulation state: " + state.simulation_state);
    if (state.simulation_state === "high_pressure") {
        // 250 psig +/- 25%,  Min 50 psig, Max 300 psig
        state.pressure = vary(250, 25, 50, 300);
    } else {
        // 150 psig +/- 10%,  Min 50 psig, Max 300 psig
        state.pressure = vary(150, 10, 50, 300);
    }

    updateState(state);
    return state;
}

C:\temp\devicemodels\scripts\chiller-01-state.js ファイルを保存します。

lightbulb を作成する

このセクションでは、新しい Lightbulb デバイスの種類を定義します。

ファイル C:\temp\devicemodels\lightbulb-01.json を作成し、次のコンテンツを追加します。

{
  "SchemaVersion": "1.0.0",
  "Id": "lightbulb-01",
  "Version": "0.0.1",
  "Name": "Lightbulb",
  "Description": "Smart lightbulb device.",
  "Protocol": "MQTT",
  "Simulation": {
    "InitialState": {
      "online": true,
      "temperature": 200.0,
      "temperature_unit": "F",
      "status": "on"
    },
    "Interval": "00:00:20",
    "Scripts": [
      {
        "Type": "javascript",
        "Path": "lightbulb-01-state.js"
      }
    ]
  },
  "Properties": {
    "Type": "Lightbulb",
    "Color": "White",
    "Brightness": 75,
    "EstimatedRemainingLife": 10000
  },
  "Tags": {
    "Location": "Building 2",
    "Floor": "2",
    "Campus": "Redmond"
  },
  "Telemetry": [
    {
      "Interval": "00:00:20",
      "MessageTemplate": "{\"temperature\":${temperature},\"temperature_unit\":\"${temperature_unit}\",\"status\":\"${status}\"}",
      "MessageSchema": {
        "Name": "lightbulb-status;v1",
        "Format": "JSON",
        "Fields": {
          "temperature": "double",
          "temperature_unit": "text",
          "status": "text"
        }
      }
    }
  ],
  "CloudToDeviceMethods": {
    "SwitchOn": {
      "Type": "javascript",
      "Path": "SwitchOn-method.js"
    },
    "SwitchOff": {
      "Type": "javascript",
      "Path": "SwitchOff-method.js"
    }
  }
}

変更を C:\temp\devicemodels\lightbulb-01.json に保存します。

ファイル C:\temp\devicemodels\scripts\lightbulb-01-state.js を作成し、次のコンテンツを追加します。

"use strict";

// Default state
var state = {
  online: true,
  temperature: 200.0,
  temperature_unit: "F",
  status: "on"
};

// Default device properties
var properties = {};

/**
 * Restore the global state using data from the previous iteration.
 *
 * @param previousState device state from the previous iteration
 * @param previousProperties device properties from the previous iteration
 */
function restoreSimulation(previousState, previousProperties) {
  // If the previous state is null, force a default state
  if (previousState) {
    state = previousState;
  } else {
    log("Using default state");
  }

  if (previousProperties) {
    properties = previousProperties;
  } else {
    log("Using default properties");
  }
}

/**
 * Simple formula generating a random value around the average
 * in between min and max
 *
 * @returns random value with given parameters
 */
function vary(avg, percentage, min, max) {
  var value = avg * (1 + ((percentage / 100) * (2 * Math.random() - 1)));
  value = Math.max(value, min);
  value = Math.min(value, max);
  return value;
}

/**
 * Simple formula that sometimes flips the status of the lightbulb
 */
function flip(value) {
  if (Math.random() < 0.2) {
    return (value == "on") ? "off" : "on"
  }
  return value;
}

/**
 * Entry point function called by the simulation engine.
 * Returns updated simulation state.
 * Device property updates must call updateProperties() to persist.
 *
 * @param context             The context contains current time, device model and id
 * @param previousState       The device state since the last iteration
 * @param previousProperties  The device properties since the last iteration
 */
function main(context, previousState, previousProperties) {

  // Restore the global device properties and the global state before
  // generating the new telemetry, so that the telemetry can apply changes
  // using the previous function state.
  restoreSimulation(previousState, previousProperties);

  state.temperature = vary(200, 5, 150, 250);

  // Make this flip every so often
  state.status = flip(state.status);

  updateState(state);

  return state;
}

変更を C:\temp\devicemodels\scripts\lightbulb-01-state.js に保存します。

ファイル C:\temp\devicemodels\scripts\SwitchOn-method.js を作成し、次のコンテンツを追加します。

"use strict";

// Default state
var state = {
  status: "on"
};

/**
 * Entry point function called by the method.
 *
 * @param context        The context contains current time, device model and id
 * @param previousState  The device state since the last iteration
 * @param previousProperties  The device properties since the last iteration
 */
function main(context, previousState) {
  log("Executing lightbulb Switch On method.");
  state.status = "on";
  updateState(state);
}

変更を C:\temp\devicemodels\scripts\SwitchOn-method.js に保存します。

ファイル C:\temp\devicemodels\scripts\SwitchOff-method.js を作成し、次のコンテンツを追加します。

"use strict";

// Default state
var state = {
  status: "on"
};

/**
 * Entry point function called by the method.
 *
 * @param context        The context contains current time, device model and id
 * @param previousState  The device state since the last iteration
 * @param previousProperties  The device properties since the last iteration
 */
function main(context, previousState) {
  log("Executing lightbulb Switch Off method.");
  state.status = "off";
  updateState(state);
}

変更を C:\temp\devicemodels\scripts\SwitchOff-method.js に保存します。

これで、Chiller デバイスの種類のカスタマイズされたバージョンが作成され、新しい Lightbulb デバイスの種類が作成されました。

デバイスをテストする

このセクションでは、前のセクションで作成したデバイスの種類をローカルでテストします。

デバイスシミュレーションマイクロサービスを実行する

Visual Studio Code の新しいインスタンスで、GitHub からダウンロードした device-simulation-dotnet-master フォルダーを開きます。未解決の依存関係がある場合は、 [復元] ボタンをクリックして修正します。

WebService/appsettings.ini ファイルを開き、Cosmos DB 接続文字列を documentdb_connstring 変数に割り当て、次のように設定を変更します。

device_models_folder = C:\temp\devicemodels\

device_models_scripts_folder = C:\temp\devicemodels\scripts\

マイクロサービスをローカルで実行するために、 [デバッグ] > [デバッグの開始] をクリックします。

Visual Studio Code のターミナル ウィンドウに、実行中のマイクロサービスからの出力が表示されます。

デバイスシミュレーションマイクロサービスは、次の手順を実行している間もこの Visual Studio Code のインスタンスで実行したままにしておきます。

デバイスイベントのモニターを設定する

このセクションでは、Azure CLI を使用して、IoT ハブに接続されたデバイスから送信されたテレメトリを表示するイベントモニターを設定します。

次のスクリプトでは、IoT ハブの名前を device-simulation-test と想定しています。

# Install the IoT extension if it's not already installed
az extension add --name azure-iot

# Monitor telemetry sent to your hub
az iot hub monitor-events --hub-name device-simulation-test

イベントモニターは、シミュレートされたデバイスをテストしている間も実行したままにしておきます。

更新された chiller デバイスの種類を使用してシミュレーションを作成する

このセクションでは、Postman ツールを使用して、更新された chiller デバイスの種類を使ってシミュレーションを実行するようデバイスシミュレーションマイクロサービスに要求します。 Postman は、Web サービスに REST 要求を送信するためのツールです。必要な Postman 構成ファイルは、device-simulation-dotnet リポジトリのローカルコピーに含まれています。

Postman を設定するには:

ローカルコンピューターで Postman を開きます。
[File]\(ファイル\) > [Import]\(インポート\) をクリックします。次に、 [Choose Files]\(ファイルの選択\) をクリックします。
device-simulation-dotnet-master/docs/postman フォルダーに移動します。 [Azure IoT デバイスシミュレーションソリューション accelerator.postman_collection] と [Azure IoT デバイスシミュレーションソリューション] accelerator.postman_environment選択し、[開く] をクリックします。
[Azure IoT Device Simulation solution accelerator]\(Azure IoT デバイスシミュレーションソリューションアクセラレータ\) を、送信可能な要求に展開します。
[ 環境なし ] をクリックし、[ Azure IoT デバイスシミュレーションソリューションアクセラレータ] を選択します。

これで、デバイスシミュレーションマイクロサービスとやり取りするためのコレクションと環境が Postman ワークスペースに読み込まれました。

シミュレーションを構成および実行するには:

Postman コレクション内で、[Create modified chiller simulation]\(変更された chiller シミュレーションの作成\) を選択し、[Send]\(送信\) をクリックします。この要求により、シミュレートされた chiller デバイスの種類のインスタンスが 4 つ作成されます。
Azure CLI ウィンドウのイベントモニター出力に、新しい internal_temperature 値を含む、シミュレートされたデバイスからのテレメトリが表示されます。

シミュレーションを停止するには、Postman で [Stop simulation]\(シミュレーションの停止\) 要求を選択し、 [Send]\(送信\) をクリックします。

lightbulb デバイスの種類を使用してシミュレーションを作成する

このセクションでは、Postman ツールを使用して、lightbulb デバイスの種類を使ってシミュレーションを実行するようデバイスシミュレーションマイクロサービスに要求します。 Postman は、Web サービスに REST 要求を送信するためのツールです。

シミュレーションを構成および実行するには:

Postman コレクション内で、[Create lightbulb simulation]\(lightbulb シミュレーションの作成\) を選択し、[Send]\(送信\) をクリックします。この要求により、シミュレートされた lightbulb デバイスの種類のインスタンスが 2 つ作成されます。
Azure CLI ウィンドウのイベントモニター出力に、シミュレートされた lightbulb からのテレメトリが表示されます。

シミュレーションを停止するには、Postman で [Stop simulation]\(シミュレーションの停止\) 要求を選択し、 [Send]\(送信\) をクリックします。

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

ローカルで実行されている 2 つのマイクロサービスを Visual Studio Code インスタンスで停止することができます ( [デバッグ] > [デバッグの停止] )。

IoT Hub および Cosmos DB のインスタンスが必要でなくなった場合は、不必要な課金を回避するために、Azure サブスクリプションからそれらを削除します。

次のステップ

このガイドでは、カスタムのシミュレートされたデバイスの種類を作成し、デバイスシミュレーションマイクロサービスをローカルで実行してテストする方法について説明しました。

推奨される次の手順は、カスタムのシミュレートされたデバイスの種類をリモート監視ソリューションアクセラレータに展開する方法を学習することです。