デバイスをリモート監視構成済みソリューションに接続する (Node.js)

[アーティクル]
11/02/2017

シナリオの概要

このシナリオでは、次のテレメトリをリモート監視構成済みソリューションに送信するデバイスを作成します。

外部温度
内部温度
湿度

わかりやすくするために、デバイス上のコードではサンプル値を生成しますが、デバイスに実際のセンサーを接続し、実際のテレメトリを送信して、サンプルを拡張することをお勧めします。

このデバイスでは、ソリューションダッシュボードから呼び出されたメソッドと、ソリューションダッシュボードで設定されている必要なプロパティ値に応答することもできます。

このチュートリアルを完了するには、アクティブな Azure アカウントが必要になります。アカウントがない場合は、無料試用アカウントを数分で作成することができます。詳細については、「Azure の無料試用版サイト」を参照してください。

開始する前に

デバイス用のコードを作成する前に、リモート監視構成済みソリューションをプロビジョニングし、そのソリューションに新しいカスタムデバイスをプロビジョニングする必要があります。

リモート監視構成済みソリューションをプロビジョニングする

このチュートリアルで作成するデバイスは、リモート監視構成済みソリューションのインスタンスにデータを送信します。リモート監視構成済みソリューションを Azure アカウントにまだプロビジョニングしていない場合は、次の手順を使用します。

https://www.azureiotsolutions.com/ ページで、 +をクリックしてソリューションを作成します。
[リモート監視] パネルで [選択] をクリックして、ソリューションを作成します。
[Create Remote monitoring solution (リモート監視ソリューションの作成)] ページで任意のソリューション名を入力し、デプロイ先のリージョンを選択したら、使用する Azure サブスクリプションを選択します。その後、 [ソリューションの作成]をクリックします。
プロビジョニングプロセスが完了するまで待機します。

警告

構成済みソリューションでは、課金対象の Azure サービスを使用します。不必要な課金を避けるために、使用が済んだら、必ずサブスクリプションから構成済みソリューションを削除してください。 https://www.azureiotsolutions.com/ ページで、構成済みのソリューションをサブスクリプションから完全に削除できます。

リモート監視ソリューションのプロビジョニングプロセスが完了したら、 [起動] をクリックしてブラウザーでソリューションダッシュボードを開きます。

ソリューションのダッシュボード

リモート監視ソリューションでデバイスをプロビジョニングする

Note

ソリューションにデバイスを既にプロビジョニングしている場合は、この手順を省略して構いません。クライアントアプリケーションを作成するときに、デバイスの資格情報が必要です。

デバイスが構成済みソリューションに接続するには、有効な資格情報を使用して IoT Hub に対してデバイス自身の ID を証明する必要があります。デバイスの資格情報は、ソリューションダッシュボードから取得できます。このチュートリアルの後半で、クライアントアプリケーションにデバイスの資格情報を含めます。

デバイスをリモート監視ソリューションに追加するには、ソリューションダッシュボードで次の手順を実行します。

ダッシュボードの左下隅にある [デバイスの追加]をクリックします。
[カスタムデバイス] パネルで、[新規追加] をクリックします。
[デバイス ID を自分で定義する] を選択します。 mydevice などのデバイス ID を入力します。[ID の確認] をクリックして、その名前がまだ使用されていないことを確認し、[作成] をクリックしてデバイスをプロビジョニングします。
デバイスの資格情報 (デバイス ID、IoT Hub ホスト名、デバイスキー) を書き留めておきます。クライアントアプリケーションがリモート監視ソリューションに接続する際に、この値が必要になります。次に、 [Done] をクリックします。
ソリューションダッシュボードのデバイスの一覧でデバイスを選択します。次に、[デバイスの詳細] パネルで、[デバイスの有効化] をクリックします。現在、デバイスの状態は [実行中] です。リモート監視ソリューションはデバイスからテレメトリを受信し、デバイス上でメソッドを呼び出すことができます。

node.js のサンプルソリューションを作成する

開発コンピューターに Node.js のバージョン 0.11.5x 以降がインストールされていることを確認します。バージョンを確認するには、コマンドラインで node --version を実行します。

開発用コンピューターに RemoteMonitoring という名前のフォルダーを作成します。コマンドライン環境内でこのフォルダーに移動します。
次のコマンドを実行して、サンプルアプリケーションを完成させるために必要なパッケージをダウンロードしてインストールします。
```
npm init
npm install azure-iot-device azure-iot-device-mqtt --save
```
RemoteMonitoring フォルダーで、remote_monitoring.js という名前のファイルを作成します。このファイルをテキストエディターで開きます。

remote_monitoring.js ファイルに次の require ステートメントを追加します。

'use strict';

var Protocol = require('azure-iot-device-mqtt').Mqtt;
var Client = require('azure-iot-device').Client;
var ConnectionString = require('azure-iot-device').ConnectionString;
var Message = require('azure-iot-device').Message;

require ステートメントの後に次の変数宣言を追加します。リモート監視ソリューションダッシュボードで、プレースホルダー [Device Id] と [Device Key] の値を、書き留めておいたデバイス用の値に置き換えます。ソリューションダッシュボードの IoT Hub ホスト名を使用して、[IoTHub Name] を置き換えます。たとえば、IoT Hub ホスト名が contoso.azure-devices.net である場合は、[IoTHub Name] を contoso に置き換えます。
```
var connectionString = 'HostName=[IoTHub Name].azure-devices.net;DeviceId=[Device Id];SharedAccessKey=[Device Key]';
var deviceId = ConnectionString.parse(connectionString).DeviceId;
```
基本のテレメトリデータをいくつか定義するために、次の変数を追加します。
```
var temperature = 50;
var humidity = 50;
var externalTemperature = 55;
```

操作結果を出力するために、次のヘルパー関数を追加します。

function printErrorFor(op) {
    return function printError(err) {
        if (err) console.log(op + ' error: ' + err.toString());
    };
}

テレメトリの値をランダム化するために使用する次のヘルパー関数を追加します。
```
function generateRandomIncrement() {
    return ((Math.random() * 2) - 1);
}
```

起動時にデバイスから送信する DeviceInfo オブジェクトについて、次の定義を追加します。

var deviceMetaData = {
    'ObjectType': 'DeviceInfo',
    'IsSimulatedDevice': 0,
    'Version': '1.0',
    'DeviceProperties': {
        'DeviceID': deviceId,
        'HubEnabledState': 1
    }
};

デバイスツインの報告される値について、次の定義を追加します。この定義には、デバイスでサポートされるダイレクトメソッドの説明が含まれます。

var reportedProperties = {
    "Device": {
        "DeviceState": "normal",
        "Location": {
            "Latitude": 47.642877,
            "Longitude": -122.125497
        }
    },
    "Config": {
        "TemperatureMeanValue": 56.7,
        "TelemetryInterval": 45
    },
    "System": {
        "Manufacturer": "Contoso Inc.",
        "FirmwareVersion": "2.22",
        "InstalledRAM": "8 MB",
        "ModelNumber": "DB-14",
        "Platform": "Plat 9.75",
        "Processor": "i3-9",
        "SerialNumber": "SER99"
    },
    "Location": {
        "Latitude": 47.642877,
        "Longitude": -122.125497
    },
    "SupportedMethods": {
        "Reboot": "Reboot the device",
        "InitiateFirmwareUpdate--FwPackageURI-string": "Updates device Firmware. Use parameter FwPackageURI to specifiy the URI of the firmware file"
    },
}

Reboot ダイレクトメソッドの呼び出しを処理する次の関数を追加します。

function onReboot(request, response) {
    // Implement actual logic here.
    console.log('Simulated reboot...');

    // Complete the response
    response.send(200, "Rebooting device", function(err) {
        if(!!err) {
            console.error('An error occurred when sending a method response:\n' + err.toString());
        } else {
            console.log('Response to method \'' + request.methodName + '\' sent successfully.' );
        }
    });
}

InitiateFirmwareUpdate ダイレクトメソッドの呼び出しを処理する次の関数を追加します。このダイレクトメソッドは、パラメーターを使用して、ダウンロードするファームウェアイメージの場所を指定し、デバイスでファームウェアの更新を非同期に開始します。

function onInitiateFirmwareUpdate(request, response) {
    console.log('Simulated firmware update initiated, using: ' + request.payload.FwPackageURI);

    // Complete the response
    response.send(200, "Firmware update initiated", function(err) {
        if(!!err) {
            console.error('An error occurred when sending a method response:\n' + err.toString());
        } else {
            console.log('Response to method \'' + request.methodName + '\' sent successfully.' );
        }
    });

    // Add logic here to perform the firmware update asynchronously
}

クライアントインスタンスを作成するために次のコードを追加します。
```
var client = Client.fromConnectionString(connectionString, Protocol);
```

次の処理を行うために、以下のコードを追加します。

接続を開きます。
DeviceInfo オブジェクトを送信します。
必要なプロパティのハンドラーを設定します。
報告されたプロパティを送信します。
ダイレクトメソッドのハンドラーを登録します。
テレメトリの送信を開始します。

client.open(function (err) {
    if (err) {
        printErrorFor('open')(err);
    } else {
        console.log('Sending device metadata:\n' + JSON.stringify(deviceMetaData));
        client.sendEvent(new Message(JSON.stringify(deviceMetaData)), printErrorFor('send metadata'));

        // Create device twin
        client.getTwin(function(err, twin) {
            if (err) {
                console.error('Could not get device twin');
            } else {
                console.log('Device twin created');

                twin.on('properties.desired', function(delta) {
                    console.log('Received new desired properties:');
                    console.log(JSON.stringify(delta));
                });

                // Send reported properties
                twin.properties.reported.update(reportedProperties, function(err) {
                    if (err) throw err;
                    console.log('twin state reported');
                });

                // Register handlers for direct methods
                client.onDeviceMethod('Reboot', onReboot);
                client.onDeviceMethod('InitiateFirmwareUpdate', onInitiateFirmwareUpdate);
            }
        });

        // Start sending telemetry
        var sendInterval = setInterval(function () {
            temperature += generateRandomIncrement();
            externalTemperature += generateRandomIncrement();
            humidity += generateRandomIncrement();

            var data = JSON.stringify({
                'DeviceID': deviceId,
                'Temperature': temperature,
                'Humidity': humidity,
                'ExternalTemperature': externalTemperature
            });

            console.log('Sending device event data:\n' + data);
            client.sendEvent(new Message(data), printErrorFor('send event'));
        }, 5000);

        client.on('error', function (err) {
            printErrorFor('client')(err);
            if (sendInterval) clearInterval(sendInterval);
            client.close(printErrorFor('client.close'));
        });
    }
});

変更を remote_monitoring.js ファイルに保存します。
コマンドプロンプトで次のコマンドを実行して、サンプルアプリケーションを起動します。
```
node remote_monitoring.js
```

デバイスのテレメトリをダッシュボードに表示する

リモート監視ソリューションのダッシュボードでは、デバイスが IoT Hub に送信するテレメトリを表示できます。

ブラウザーでリモート監視ソリューションのダッシュボードに戻り、左側のパネルの [デバイス] をクリックし、[デバイスの一覧] に移動します。
[デバイスの一覧] で、デバイスの状態が [実行中] であることを確認してください。実行中でない場合は、[デバイスの詳細] パネルで [デバイスの有効化] をクリックします。
[ダッシュボード] をクリックしてダッシュボードに戻り、[表示するデバイス] ボックスの一覧からテレメトリを表示するデバイスを選択します。サンプルアプリケーションから送信されるテレメトリは、内部温度では 50 単位、外部温度では 55 単位、湿度では 50 単位です。

デバイスでメソッドを呼び出す

リモート監視ソリューションのダッシュボードでは、IoT Hub を介してデバイスでメソッドを呼び出すことができます。たとえば、リモート監視ソリューションで、デバイスの再起動をシミュレートするメソッドを呼び出すことができます。

リモート監視ソリューションのダッシュボードで、左側のパネルの [デバイス] をクリックし、[デバイスの一覧] に移動します。
[デバイスの一覧] で、デバイスの [デバイス ID] をクリックします。
[デバイスの詳細] パネルで、[メソッド] をクリックします。
[メソッド] ドロップダウンで [InitiateFirmwareUpdate] を選択し、[FWPACKAGEURI] にダミーの URL を入力します。 [メソッドの呼び出し] をクリックして、デバイスでメソッドを呼び出します。
デバイスがメソッドを処理しているとき、デバイスコードを実行しているコンソールにメッセージが表示されます。メソッドの結果は、ソリューションポータルの履歴に追加されます。

次のステップ

「構成済みソリューションのカスタマイズ」では、このサンプルを拡張する方法をいくつか確認できます。可能な拡張には、実際のセンサーの使用やその他のコマンドの実装などがあります。

azureiotsuite.com サイトでのアクセス許可の詳細について確認できます。

次の方法で共有

デバイスをリモート監視構成済みソリューションに接続する (Node.js)

シナリオの概要

開始する前に

リモート監視構成済みソリューションをプロビジョニングする

リモート監視ソリューションでデバイスをプロビジョニングする

node.js のサンプルソリューションを作成する

デバイスのテレメトリをダッシュボードに表示する

デバイスでメソッドを呼び出す

次のステップ

その他のリソース

次の方法で共有

デバイスをリモート監視構成済みソリューションに接続する (Node.js)

シナリオの概要

開始する前に

リモート監視構成済みソリューションをプロビジョニングする

リモート監視ソリューションでデバイスをプロビジョニングする

node.js のサンプル ソリューションを作成する

デバイスのテレメトリをダッシュボードに表示する

デバイスでメソッドを呼び出す

次のステップ

その他のリソース

node.js のサンプルソリューションを作成する