AWS IoT モノ AWS IoT SiteWise から にデータを取り込む

AWS IoT SiteWise コンソールに移動します。

左のナビゲーションペインで [モデル] を選択します。

アセットモデルの作成 を選択します。

[モデルの詳細] で、モデルの名前を入力します。例えば、SiteWise Tutorial Device Model。

[測定定義] で、次の操作を実行します。

1. [名前] に「CPU Usage」と入力します。

2. [単位] に「%」と入力します。

3. [データ型] は [倍精度浮動小数点型] のままにします。

測定プロパティは、デバイスの raw データストリームを表します。詳細については、「機器からのデータストリームを定義する (測定値) 」を参照してください。

2 つ目の測定プロパティを追加する場合は、[新しい測定の追加] を選択します。

[測定定義] の 2 行目で、次の操作を実行します。

1. [名前] に「Memory Usage」と入力します。

2. [単位] に「%」と入力します。

3. [データ型] は [倍精度浮動小数点型] のままにします。

[メトリクス定義] で、次の操作を実行します。

1. [名前] に「Average CPU Usage」と入力します。

2. [計算式] に「avg(CPU Usage)」と入力します。表示されたら、自動入力リストから CPU Usage を選択します。

3. [時間間隔] に「5 minutes」と入力します。

メトリクスプロパティは、ある間隔ですべての入力データポイントを処理し、間隔ごとに 1 つのデータポイントを出力する集計計算を定義します。このメトリクスプロパティは、各デバイスの平均 CPU 使用率を 5 分ごとに計算します。詳細については、「プロパティおよびその他のアセットからのデータを集計する (メトリクス)」を参照してください。

[新しいメトリクスの追加] を選択して、2 つ目のメトリクスプロパティを追加します。

[メトリクス定義] の 2 行目で、次の操作を実行します。

1. [名前] に「Average Memory Usage」と入力します。

2. [計算式] に「avg(Memory Usage)」と入力します。表示されたら、自動入力リストから Memory Usage を選択します。

3. [Time interval (時間間隔) ] に「5 minutes」と入力します。

このメトリクスプロパティは、各デバイスの平均メモリ使用率を 5 分ごとに計算します。

(オプション) デバイスごとのコンピューティングに関心のあるその他のメトリクスを追加します。興味深い関数には、min、max などがあります。詳細については、「数式を使用する」を参照してください。「ステップ 4: デバイスフリートアセットモデルを作成する」では、デバイスのフリート全体のデータを使用してメトリクスを計算できる親アセットを作成します。

[モデルの作成] を選択します。

AWS IoT SiteWise コンソールに移動します。

左のナビゲーションペインで [モデル] を選択します。

アセットモデルの作成 を選択します。

[モデルの詳細] で、モデルの名前を入力します。例えば、SiteWise Tutorial Device Fleet Model。

[階層定義] で、次の操作を実行します。

1. [階層名] に「Device」と入力します。

2. [階層モデル] で、デバイスアセットモデル (SiteWise Tutorial Device Model) を選択します。

階層は、親 (フリート) アセットモデルと子 (デバイス) アセットモデルの間の関係を定義します。親アセットは、子アセットのプロパティデータにアクセスできます。後でアセットを作成する場合は、親アセットモデルの階層定義に従って、子アセットを親アセットに関連付ける必要があります。詳細については、「アセットモデルの階層を定義する」を参照してください。

[Metric definitions (メトリクス定義) ] で、次の操作を実行します。

1. [名前] に「Average CPU Usage」と入力します。

2. [計算式] に「avg(Device | Average CPU Usage)」と入力します。自動入力リストが表示されたら、[Device] を選択して階層を選択し、[Average CPU Usage] を選択して前に作成したデバイスアセットからメトリクスを選択します。

3. [Time interval (時間間隔) ] に「5 minutes」と入力します。

このメトリクスプロパティは、Device 階層を通じてフリートアセットに関連付けられているすべてのデバイスアセットの平均 CPU 使用率を計算します。

[新しいメトリクスの追加] を選択して、2 つ目のメトリクスプロパティを追加します。

[メトリクス定義] の 2 行目で、次の操作を実行します。

1. [名前] に「Average Memory Usage」と入力します。

2. [計算式] に「avg(Device | Average Memory Usage)」と入力します。自動入力リストが表示されたら、[Device] を選択して階層を選択し、[Average Memory Usage] を選択して前に作成したデバイスアセットからメトリクスを選択します。

3. [Time interval (時間間隔) ] に「5 minutes」と入力します。

このメトリクスプロパティは、Device 階層を通じてフリートアセットに関連付けられているすべてのデバイスアセットの平均メモリ使用率を計算します。

(オプション) デバイスのフリート全体のコンピューティングに関心のあるその他のメトリクスを追加します。

[モデルの作成] を選択します。

AWS IoT SiteWise コンソールに移動します。

左側のナビゲーションペインで [アセット] を選択します。

[アセットの作成] を選択します。

[モデル情報] で、デバイスアセットモデル SiteWise Tutorial Device Model を選択します。

[アセット情報] で、アセットの名前を入力します。例えば、SiteWise Tutorial Device 1。

[アセットの作成] を選択します。

新しいデバイスアセットの場合は、 [編集] を選択します。

測定値の下：

1. CPU Usage で、プロパティエイリアスとして /tutorial/device/SiteWiseTutorialDevice1/cpu と入力します。 AWS IoT モノの名前をプロパティエイリアスに含めると、単一の AWS IoT ルールを使用してすべてのデバイスからデータを取り込むことができます。

2. Memory Usage で、プロパティエイリアスとして /tutorial/device/SiteWiseTutorialDevice1/memory と入力します。

[保存] を選択します。

AWS IoT SiteWise コンソールに移動します。

左側のナビゲーションペインで [アセット] を選択します。

[アセットの作成] を選択します。

[モデル情報]で、デバイスフリートアセットモデル SiteWise Tutorial Device Fleet Model を選択します。

[アセット情報] で、アセットの名前を入力します。例えば、SiteWise Tutorial Device Fleet 1。

[アセットの作成] を選択します。

新しいデバイスフリートアセットの場合は、 [編集] を選択します。

[このアセットに関連付けられているアセット] で、[関連付けられたアセットの追加] を選択し、以下を行います。

1. [階層] で、[Device] を選択します。この階層は、デバイスとフリートアセットの間の階層関係を識別します。この階層は、このチュートリアルで前にデバイスフリートアセットモデルで定義しました。

2. [アセット] で、デバイスアセット (SiteWise Tutorial Device 1) を選択します。

(オプション) 以前に複数のデバイスアセットを作成した場合は、作成したデバイスアセットごとにステップ 8～10 を繰り返します。

[保存] を選択します。

これで、デバイスアセットが階層として編成されているのがわかります。

AWS IoT コンソールに移動します。

左側のナビゲーションペインで [メッセージルーティング] を選択し、[ルール] を選択します。

[‬ルールを作成]‭ を選択します。

ルールの名前と説明を入力し、[次へ] を選択します。

次の SQL ステートメントを入力し、[次へ] を選択します。

SELECT
  *
FROM
  '$aws/things/+/shadow/update/accepted'
WHERE
  startsWith(topic(3), "SiteWiseTutorialDevice")

このルールクエリステートメントは、デバイスシャドウサービスがシャドウの更新を $aws/things/thingName/shadow/update/accepted にパブリッシュするため、機能します。デバイスシャドウの詳細については、[AWS IoT Developer Guide] (デベロッパーガイド) の [Device shadow service] (デバイスシャドウサービス) を参照してください。

WHERE 句では、このルールクエリステートメントは topic(3) 関数を使用して、トピックの 3 番目のセグメントからモノの名前を取得します。次に、このステートメントは、名前がチュートリアルのデバイス名と一致しないデバイスを除外します。 AWS IoT SQL の詳細については、「 AWS IoT デベロッパーガイド」のAWS IoT 「SQL リファレンス」を参照してください。

[ルールのアクション] で、[ AWS IoT SiteWiseのアセットプロパティにメッセージデータを送信する] を選択し、次の操作を行います。

1. [プロパティエイリアスによる] を選択します。

2. [Pプロパティエイリアス] に「/tutorial/device/${topic(3)}/cpu」と入力します。

   ${...} 構文は置換テンプレートです。 は中括弧内のコンテンツ AWS IoT を評価します。この置換テンプレートは、トピックからモノの名前を取得し、モノごとに固有のエイリアスを作成します。詳細については、[AWS IoT Developer Guide] (デベロッパーガイド) の[Substitution templates] (置換テンプレート) を参照してください。

   注記

   置換テンプレート内の式は SELECT ステートメントとは別に評価されるため、AS 句を使用して作成されたエイリアスは置換テンプレートを使用して参照することはできません。サポートされている関数と演算子に加えて、元のペイロードに存在する情報のみを参照できます。

3. [エントリ ID - オプション] に ${concat(topic(3), "-cpu-", floor(state.reported.timestamp))} と入力します。

   エントリ ID は、各値エントリの試行を一意に識別します。エントリがエラーを返す場合は、エラーの出力でエントリ ID を検索して、問題をトラブルシューティングすることができます。このエントリ ID の置換テンプレートは、モノの名前とデバイスの報告されたタイムスタンプを組み合わせたものです。たとえば、結果のエントリ ID は SiteWiseTutorialDevice1-cpu-1579808494 のようになります。

4. [時間 (秒)] に「${floor(state.reported.timestamp)}」と入力します。

   この置換テンプレートは、デバイスの報告されたタイムスタンプから秒単位で時間を計算します。このチュートリアルでは、デバイスは Unix エポック時間でタイムスタンプ (秒) を浮動小数点数として報告します。

5. [オフセット (ナノ秒) - オプション] に ${floor((state.reported.timestamp % 1) * 1E9)} と入力します。

   この置換テンプレートは、デバイスの報告されたタイムスタンプの小数部分を変換して、秒単位の時間からのナノ秒オフセットを計算します。

   注記

   AWS IoT SiteWise では、データが Unix エポック時間で現在のタイムスタンプを持っている必要があります。デバイスが正確に時間を報告しない場合、[timestamp () ] (タイムスタンプ) を使って AWS IoT ルールエンジンから現在の時間を取得することができます。この関数は、時刻をミリ秒単位で報告するため、ルールアクションの時間パラメータを次の値に更新する必要があります。

   • [Time in seconds (時間 (秒)) ] に「${floor(timestamp() / 1E3)}」と入力します。

   • [オフセット (ナノ秒)] に「${(timestamp() % 1E3) * 1E6}と入力します。

6. [データ型] で、[Double (倍精度浮動小数点型) ] を選択します。

   このデータ型は、アセットモデルで定義したアセットプロパティのデータ型と一致する必要があります。

7. [値] には「${state.reported.cpu}」と入力します。置換テンプレートでは、. 演算子を使用して JSON 構造内から値を取得します。

8. [エントリの追加] を選択して、メモリ使用率プロパティに新しいエントリを追加し、そのプロパティに対して次の手順を再度実行します。

   1. [プロパティエイリアスによる] を選択します。

   2. [Pプロパティエイリアス] に「/tutorial/device/${topic(3)}/memory」と入力します。

   3. [エントリ ID - オプション] に ${concat(topic(3), "-memory-", floor(state.reported.timestamp))} と入力します。

   4. [時間 (秒)] に「${floor(state.reported.timestamp)}」と入力します。

   5. [オフセット (ナノ秒) - オプション] に ${floor((state.reported.timestamp % 1) * 1E9)} と入力します。

   6. [データ型] で、[倍精度浮動小数点型] を選択します。

   7. [値] には「${state.reported.memory}」と入力します。

9. [ロール] で、[ロールの作成] を選択して、このルールアクションに対する IAM ロールを作成します。このロールにより、 AWS IoT はデバイスフリートアセットとそのアセット階層のプロパティにデータをプッシュできます。

10. ロール名を入力し、[作成] を選択します。

(オプション) ルールのトラブルシューティングに使用できるエラーアクションを設定します。詳細については、「ルールをトラブルシューティング (AWS IoT SiteWise)」を参照してください。

[次へ] を選択します。

設定を確認し、[作成] を選択してルールを作成します。

AWS IoT コンソールに移動します。

左側のナビゲーションペインの下部にある [設定] を選択します。

デバイスクライアントスクリプトで使用するためにカスタムエンドポイントを保存します。このエンドポイントを使用して、モノのシャドウとやり取りします。このエンドポイントは、現在のリージョンのアカウントに固有です。

カスタムエンドポイントは、次の例のようになります。

identifier.iot.region.amazonaws.com

コマンドラインを開き、次のコマンドを実行して、先ほど作成したチュートリアル用のディレクトリに移動します。

cd iot-sitewise-rule-tutorial

以下のコマンドを実行して、 AWS IoT Device SDK for Pythonをインストールします。

pip3 install AWSIoTPythonSDK

詳細については、[AWS IoT Developer Guide] (デベロッパーガイド) の[AWS IoT Device SDK for Python]を参照してください。

次のコマンドを実行して、psutil をインストールします。psutil は、クロスプラットフォームプロセスおよびシステムユーティリティライブラリです。

pip3 install psutil

詳細については、[Python Package Index] (パッケージインデックス) の[psutil]を参照してください。

iot-sitewise-rule-tutorial ディレクトリ thing_performance.py にというファイルを作成し、次の Python コードをファイルにコピーします。

import AWSIoTPythonSDK.MQTTLib as AWSIoTPyMQTT

import json
import psutil
import argparse
import logging
import time


# Configures the argument parser for this program.
def configureParser():
    parser = argparse.ArgumentParser()
    parser.add_argument(
        "-e",
        "--endpoint",
        action="store",
        required=True,
        dest="host",
        help="Your AWS IoT custom endpoint",
    )
    parser.add_argument(
        "-r",
        "--rootCA",
        action="store",
        required=True,
        dest="rootCAPath",
        help="Root CA file path",
    )
    parser.add_argument(
        "-c",
        "--cert",
        action="store",
        required=True,
        dest="certificatePath",
        help="Certificate file path",
    )
    parser.add_argument(
        "-k",
        "--key",
        action="store",
        required=True,
        dest="privateKeyPath",
        help="Private key file path",
    )
    parser.add_argument(
        "-p",
        "--port",
        action="store",
        dest="port",
        type=int,
        default=8883,
        help="Port number override",
    )
    parser.add_argument(
        "-n",
        "--thingName",
        action="store",
        required=True,
        dest="thingName",
        help="Targeted thing name",
    )
    parser.add_argument(
        "-d",
        "--requestDelay",
        action="store",
        dest="requestDelay",
        type=float,
        default=1,
        help="Time between requests (in seconds)",
    )
    parser.add_argument(
        "-v",
        "--enableLogging",
        action="store_true",
        dest="enableLogging",
        help="Enable logging for the AWS IoT Device SDK for Python",
    )
    return parser


# An MQTT shadow client that uploads device performance data to AWS IoT at a regular interval.
class PerformanceShadowClient:
    def __init__(
        self,
        thingName,
        host,
        port,
        rootCAPath,
        privateKeyPath,
        certificatePath,
        requestDelay,
    ):
        self.thingName = thingName
        self.host = host
        self.port = port
        self.rootCAPath = rootCAPath
        self.privateKeyPath = privateKeyPath
        self.certificatePath = certificatePath
        self.requestDelay = requestDelay

    # Updates this thing's shadow with system performance data at a regular interval.
    def run(self):
        print("Connecting MQTT client for {}...".format(self.thingName))
        mqttClient = self.configureMQTTClient()
        mqttClient.connect()
        print("MQTT client for {} connected".format(self.thingName))
        deviceShadowHandler = mqttClient.createShadowHandlerWithName(
            self.thingName, True
        )

        print("Running performance shadow client for {}...\n".format(self.thingName))
        while True:
            performance = self.readPerformance()
            print("[{}]".format(self.thingName))
            print("CPU:\t{}%".format(performance["cpu"]))
            print("Memory:\t{}%\n".format(performance["memory"]))
            payload = {"state": {"reported": performance}}
            deviceShadowHandler.shadowUpdate(
                json.dumps(payload), self.shadowUpdateCallback, 5
            )
            time.sleep(args.requestDelay)

    # Configures the MQTT shadow client for this thing.
    def configureMQTTClient(self):
        mqttClient = AWSIoTPyMQTT.AWSIoTMQTTShadowClient(self.thingName)
        mqttClient.configureEndpoint(self.host, self.port)
        mqttClient.configureCredentials(
            self.rootCAPath, self.privateKeyPath, self.certificatePath
        )
        mqttClient.configureAutoReconnectBackoffTime(1, 32, 20)
        mqttClient.configureConnectDisconnectTimeout(10)
        mqttClient.configureMQTTOperationTimeout(5)
        return mqttClient

    # Returns the local device's CPU usage, memory usage, and timestamp.
    def readPerformance(self):
        cpu = psutil.cpu_percent()
        memory = psutil.virtual_memory().percent
        timestamp = time.time()
        return {"cpu": cpu, "memory": memory, "timestamp": timestamp}

    # Prints the result of a shadow update call.
    def shadowUpdateCallback(self, payload, responseStatus, token):
        print("[{}]".format(self.thingName))
        print("Update request {} {}\n".format(token, responseStatus))


# Configures debug logging for the AWS IoT Device SDK for Python.
def configureLogging():
    logger = logging.getLogger("AWSIoTPythonSDK.core")
    logger.setLevel(logging.DEBUG)
    streamHandler = logging.StreamHandler()
    formatter = logging.Formatter(
        "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
    )
    streamHandler.setFormatter(formatter)
    logger.addHandler(streamHandler)


# Runs the performance shadow client with user arguments.
if __name__ == "__main__":
    parser = configureParser()
    args = parser.parse_args()
    if args.enableLogging:
        configureLogging()
    thingClient = PerformanceShadowClient(
        args.thingName,
        args.host,
        args.port,
        args.rootCAPath,
        args.privateKeyPath,
        args.certificatePath,
        args.requestDelay,
    )
    thingClient.run()

以下のパラメータを使用して、コマンドラインから thing_performance.py を実行します。

コマンドは、次の例のようになります。

python3 thing_performance.py \
  --thingName SiteWiseTutorialDevice1 \
  --endpoint identifier.iot.region.amazonaws.com \
  --rootCA AmazonRootCA1.pem \
  --cert device1/thing-id-certificate.pem.crt \
  --key device1/thing-id-private.pem.key

追加の AWS IoT モノのためにスクリプトを実行している場合は、それに応じてモノの名前と証明書ディレクトリを更新します。

デバイスでプログラムを開いたり閉じたりして、CPU およびメモリ使用率がどのように変化するかを確認します。スクリプトにより、各 CPU およびメモリ使用率の読み取りが出力されます。スクリプトがデータをデバイスシャドウサービスに正常にアップロードする場合、スクリプトの出力は次の例のようになります。

[SiteWiseTutorialDevice1]
CPU:    24.6%
Memory: 85.2%

[SiteWiseTutorialDevice1]
Update request e6686e44-fca0-44db-aa48-3ca81726f3e3 accepted

スクリプトがデバイスシャドウを更新していることを確認するには、次の手順を実行します。

1. AWS IoT コンソールに移動します。

2. 左側のナビゲーションペインで、[すべてのデバイス] を選択し、[モノ] を選択します。

3. モノの SiteWiseTutorialDevice1 を選択します。

4. [デバイスシャドウ] タブを選択し、[クラシックシャドウ] を選択して、シャドウの状態が次の例のようになっていることを確認します。

   {
     "reported": {
       "cpu": 24.6,
       "memory": 85.2,
       "timestamp": 1579567542.2835066
     }
   }

   モノのシャドウの状態が空であるか、前の例のようになります。スクリプトが実行され、正常に接続されていることを確認します AWS IoT。への接続時にスクリプトが引き続きタイムアウトする場合は AWS IoT、このチュートリアルに従ってモノのポリシーが設定されていることを確認します。

ルールアクションが AWS IoT SiteWiseにデータを送信していることを確認するには、次の手順を実行します。

1. AWS IoT SiteWise コンソールに移動します。

2. 左側のナビゲーションペインで [アセット] を選択します。

3. デバイスフリートアセット (SiteWise Tutorial Device Fleet 1) の横にある矢印を選択してアセット階層を展開し、デバイスアセット ( SiteWise Tutorial Device1) を選択します。

4. [測定] を選択します。

5. 最新値 セルに、CPU Usage および Memory Usage プロパティの値があることを確認します。

   

6. CPU Usage プロパティと Memory Usage プロパティ に最新の値がない場合は、ページを更新します。数分経過しても値が表示されない場合は、「ルールをトラブルシューティング (AWS IoT SiteWise)」を参照してください。

[AWS IoT SiteWise console] (コンソール) に移動します。

左側のナビゲーションペインで [Assets (アセット) ] を選択します。

でアセットを削除するときは AWS IoT SiteWise、まずアセットの関連付けを解除する必要があります。

デバイスフリートアセットからデバイスアセットの関連付けを解除するには、次の手順を実行します。

1. デバイスフリートアセット () を選択しますSiteWise Tutorial Device Fleet 1。

2. [編集] を選択します。

3. [このアセットに関連付けられているアセット] で、このデバイスフリートアセットに関連付けられている各デバイスアセットに対して [関連付け解除] を選択します。

4. [保存] を選択します。

   これで、デバイスアセットが階層として編成されなくなったことがわかります。

デバイスアセット (SiteWise Tutorial Device 1) を選択します。

[削除] をクリックします。

確認フィールドに「Delete」と入力し、[削除] を選択します。

デバイスアセットとデバイスフリートアセット (SiteWise Tutorial Device Fleet 1) ごとに、ステップ 4～6 を繰り返します。

AWS IoT SiteWise コンソールに移動します。

デバイスおよびデバイスフリートアセットを削除していない場合は、削除します。詳細については、前述の手順を参照してください。モデルから作成されたアセットがある場合は、そのモデルを削除できません。

左のナビゲーションペインで [モデル] を選択します。

デバイスフリートアセット (SiteWise Tutorial Device Fleet Model 1) を選択します。

階層アセットモデルを削除する場合は、最初に親アセットモデルを削除する必要があります。

[削除] を選択します。

確認フィールドに「Delete」と入力し、[削除] を選択します。

デバイスのアセットモデル (SiteWise Tutorial Device Model) について、ステップ 4～6 を繰り返します。

AWS IoT コンソールに移動します。

左側のナビゲーションペインで [メッセージルーティング] を選択し、[ルール] を選択します。

ルールを選択し、[削除] を選択します。

確認ダイアログボックスでルール名を入力し、[削除] を選択します。