IoTCoreのRuleActionでAWS IoT SiteWiseのデータを更新する

概要

MQTTメッセージを介してAWS IoT SiteWiseのデータを更新する方法について確認してみました。

目次

• 1.はじめに
  • 1-1.本エントリーを読むために必要なSiteWiseに関する知識
• 2.やってみる
  • 2-1.構成
  • 2-2.SiteWise
  • 2-3.IoT Core(Rule Action)
  • 2-4.SiteWiseの測定値を更新できることの確認
• 3.まとめ

1.はじめに

本エントリーではSiteWiseへの理解を深めることを目的として「できるだけ最低限の解説&作業」に着目します。

1-1.本エントリーを読むために必要なSiteWiseに関する知識

SiteWiseでは、まず「Asset Model」、「Asset Model Properties」を定義します。その後に具体的に特定のデバイス（Asset）を定義します。他にも理解すべき事項はありますが、まずはこの点を理解しておく必要があります。

2.やってみる

2-1.構成

今回の構成は以下の通りです。

SiteWise⇨IoT Coreの順にリソースを作成してみます。
（この順番はどちらが先でも構いません）

2-2.SiteWise

「Asset Model」、「Asset Model Properties」の作成

create-asset-modelを参考にしました。

aws iotsitewise create-asset-model \
--cli-input-json file://create-wind-turbine-model.json

{
    "assetModelName": "Wind Turbine Model",
    "assetModelDescription": "Represents a wind turbine",
    "assetModelProperties": [
        {
            "name": "Serial Number",
            "dataType": "STRING",
            "type": {
                "attribute": {}
            }
        },
        {
            "name": "Generated Power",
            "dataType": "DOUBLE",
            "unit": "kW",
            "type": {
                "measurement": {}
            }
        },
        {
            "name": "Temperature C",
            "dataType": "DOUBLE",
            "unit": "Celsius",
            "type": {
                "measurement": {}
            }
        },
        {
            "name": "Temperature F",
            "dataType": "DOUBLE",
            "unit": "Fahrenheit",
            "type": {
                "transform": {
                    "expression": "temp_c * 9 / 5 + 32",
                    "variables": [
                        {
                            "name": "temp_c",
                            "value": {
                                "propertyId": "Temperature C"
                            }
                        }
                    ]
                }
            }
        },
        {
            "name": "Total Generated Power",
            "dataType": "DOUBLE",
            "unit": "kW",
            "type": {
                "metric": {
                    "expression": "sum(power)",
                    "variables": [
                        {
                            "name": "power",
                            "value": {
                                "propertyId": "Generated Power"
                            }
                        }
                    ],
                    "window": {
                        "tumbling": {
                            "interval": "1h"
                        }
                    }
                }
            }
        }
    ]
}

「Asset Model」、「Asset Model Properties」についてもう少し詳しく知りたい方は以下をご確認ください。

Assetの作成

aws iotsitewise create-asset \
--asset-model-id ${先ほど作成したModelのModelID} \
--asset-name "Wind Turbine 1"

エイリアスの作成

先ほど作成したAssetの「GeneratedPower」プロパティを更新する際のエイリアスを作成しておきます。

aws iotsitewise update-asset-property \
--asset-id ${先ほど作成したassetのassetId} \
--property-id ${「Wind Turbine Model」モデル作成時に発行された「Generated Power」measurementのID} \
--property-alias /windTurbine1/generatedPower

上記の「property-alias」で指定した「windTurbine1」には、イメージとしては対象デバイスのthingNameを入れるケースが多いのではないかと思います。
（今回は「SiteWiseにデータを溜め込むために必要な最低限の作業」ということでThingの作成は省略していますが、実際に「SiteWise」を利用する際はIoTCoreでThingを作成し、Thing単位でデータを管理したいはずなので）

「Temperature C」プロパティを更新するためのエイリアスも同様の手順で作成しておきます。

aws iotsitewise update-asset-property \
--asset-id ${assetId} \
--property-id ${「Wind Turbine Model」モデル作成時に発行された「Temperature C」measurementのID} \
--property-alias /windTurbine1/temperatureC

以下の通り、対象のアセットにエイリアスを作成することができました。

2-3.IoT Core(Rule Action)

デバイスからのMQTTプロトコルのメッセージをトリガーに、指定した「Asset」の「Asset Model Properties」を更新するRuleActionを作成します。IAM RoleはRuleActionが実行できる程度の権限を設定してください。

aws iot create-topic-rule \
--rule-name "WindTurbineUpdateGeneratedPowerPropRule" \
--topic-rule-payload file://WindTurbineUpdateGeneratedPowerPropRule.json

{
  "sql": "SELECT generatedPower, timeInSeconds, propertyAlias FROM 'things/+/props/generatedPower/update'",
  "description": "Update props.",
  "ruleDisabled": false,
  "awsIotSqlVersion": "2016-03-23",
  "actions": [
    {
      "iotSiteWise": {
        "putAssetPropertyValueEntries": [
          {
            "propertyAlias": "${propertyAlias}",
            "propertyValues": [
              {
                "value": {
                  "doubleValue": "${generatedPower}"
                },
                "timestamp": {
                  "timeInSeconds": "${timeInSeconds}"
                }
              }
            ]
          }
        ],
        "roleArn": ${RuleActionを実行するために用意したIAM RoleのARN}
      }
    }
  ]
}

ほぼほぼ同じような内容で以下のRuleも作成しました。 （関係箇所をgeneratedPowerをTemperatureCに置き換えただけ）

aws iot create-topic-rule \
--rule-name "WindTurbinUpdateTemperatureCRule" \
--topic-rule-payload file://WindTurbinUpdateTemperatureCRule.json

2-4.SiteWiseの測定値を更新できることの確認

さて、ここまでで対象のAsset ModelのPropertyを更新できるようになりましたので、実際に更新処理を試してみます。
まずは、変更前を確認しておきます。

変更前

以下の通り「測定値」には値がまだ入っていません。

では、AWSのマネコンから以下の内容でMQTTプロトコルでメッセージを送信することで、値を更新してみます。 (トピックは「things/windTurbine1/props/generatedPower/update」)

{
  "propertyAlias": "/windTurbine1/generatedPower",
  "generatedPower": 111.111,
  "timeInSeconds": 1649307600
}

変更後

「Generated Power」測定値を更新できました。「Generated Power」測定値を参照しているメトリクスも更新できています。

今度は「Temperature C」測定値を更新してみます。

(トピックは「things/windTurbine1/props/temperatureC/update」)

{
  "propertyAlias": "/windTurbine1/temperatureC",
  "temperatureC": 999.999,
  "timeInSeconds": 1649308000
}

更新できました。

「TemperatureF」への変換もできてます。
（適当な値入れたので、とんでもない温度になってるけど...）

3.まとめ

今回のようにMQTTメッセージでmeasurementを更新する場合は以下を気にすると良さそうです。

• propertyAliasはデバイスが知っている情報だけ（ex.thingName、更新対象の属性名）で構成する
  • IoTCoreのSQL内でAS句を使用したエイリアスは利用不可能なため
• IoTCoreRuleを作成するトピックパスにはデバイスを特定する情報（ex.thingName）を入れ、デバイス証明書にアタッチするIoTPolicyにてそのデバイスに関するトピックにしかメッセージを送信できないように権限を絞り込む
  • まあ、これはSiteWiseに限らずIoTCoreでMQTT使う場合の基本的な考え方とも思いますが
• 更新対象のmeasurementごとに別々のIoTCoreRuleを作成する

SiteWiseのmeasurementを更新する方法は他にも色々ありますので、そちらも検討して実運用に最適な方法を検討したいですね。

参照

• AWS IoT SiteWise
• 産業用アセットのモデリング
• アセットモデルを作成する
• create-asset-model
• update-asset-property
• AWS IoT によるデバイスの管理
• [AWS IoT] ポリシー変数で複数のモノをセキュアに管理してみた
• 置換テンプレート
• AWS IoT SiteWise ワークショップ