アセットモデルにおけるアラームの定義

アセットモデルは、産業用データとアラームの標準化を推進します。アセットモデルにアラーム定義を行うことで、アセットモデルに基づくすべてのアセットのアラームを標準化することができます。

アセットモデルにアラームを定義するには、[composite asset model] (複合アセットモデル) を使用します。複合アセットモデルとは、他のアセットモデルに特定のプロパティのセットを標準化したアセットモデルです。複合アセットモデルは、アセットモデルに特定のプロパティが存在することを保証します。アラームは型、ステート、および (オプションの) 出典プロパティを持つため、アラーム複合モデルはこれらのプロパティの存在を強制する。

各複合アセットモデルには、その複合モデルのプロパティを定義する型があります。アラーム複合モデルは、アラーム型、アラーム状態、および (オプションの) アラーム出典のプロパティを定義します。複合モデルを使ってアセットモデルからアセットを作成すると、アセットモデルで指定したプロパティに加えて、複合モデルのプロパティもアセットに含まれます。

複合モデル内の各プロパティは、その複合モデルの型に応じて識別できる名前を持つ必要があります。複合モデルプロパティは、複雑なデータ型を持つプロパティに対応しています。これらのプロパティは、STRUCT データ型と、プロパティの複合データ型を指定する dataTypeSpec 特性を持つ。複合データ型プロパティは、文字列としてシリアライズされた JSON データを含む。

アラーム複合モデルは次のような特性を持ちます。各プロパティは、この型の複合モデル用に識別するための名前を持つ必要があります。

アラーム型

アラームの型。次のいずれかを指定します。

• IOT_EVENTS – AWS IoT Events alarm. AWS IoT SiteWise sends data to AWS IoT Events は、このアラームの状態を評価します。このアラーム定義の AWS IoT Events アラームモデルを定義するには、アラームソースプロパティを指定する必要があります。

• EXTERNAL - 外部アラーム アラームの状態を測定値として取り込みます。

プロパティ名: AWS/ALARM_TYPE

プロパティ型: [attribute] (属性)

データ型: STRING

[Alarm state] (アラームの状態)

アラームの状態を表す時系列データです。これは文字列としてシリアライズされたオブジェクトであり、アラームの状態やその他の情報を含む。詳細については、「アラーム状態のプロパティ」を参照してください。

プロパティ名: AWS/ALARM_STATE

プロパティの種類: [measurement] (測定)

データ型: STRUCT

データ構造型:AWS/ALARM_STATE

[Alarm source] (アラーム出典)

(オプション) アラームの状態を評価するリソースの Amazon リソースネーム (ARN) です。 AWS IoT Events アラームの場合、これはアラームモデルの ARN です。

プロパティ名: AWS/ALARM_SOURCE

プロパティ型: [attribute] (属性)

データ型: STRING

例 アラーム複合モデルの例

次のアセットモデルは、温度をモニタリングするアラームがあるボイラーを表します。 は温度データを AWS IoT SiteWise に送信 AWS IoT Events してアラームを検出します。

{
  "assetModelName": "Boiler",
  "assetModelDescription": "A boiler that alarms when its temperature exceeds its limit.",
  "assetModelProperties": [
    {
      "name": "Temperature",
      "dataType": "DOUBLE",
      "unit": "Celsius",
      "type": {
        "measurement": {}
      }
    },
    {
      "name": "High Temperature",
      "dataType": "DOUBLE",
      "unit": "Celsius",
      "type": {
        "attribute": {
          "defaultValue": "105.0"
        }
      }
    }
  ],
  "assetModelCompositeModels": [
    {
      "name": "BoilerTemperatureHighAlarm",
      "type": "AWS/ALARM",
      "properties": [
        {
          "name": "AWS/ALARM_TYPE",
          "dataType": "STRING",
          "type": {
            "attribute": {
              "defaultValue": "IOT_EVENTS"
            }
          }
        },
        {
          "name": "AWS/ALARM_STATE",
          "dataType": "STRUCT",
          "dataTypeSpec": "AWS/ALARM_STATE",
          "type": {
            "measurement": {}
          }
        },
        {
          "name": "AWS/ALARM_SOURCE",
          "dataType": "STRING",
          "type": {
            "attribute": {}
          }
        }
      ]
    }
  ]
}

トピック

• AWS IoT Events アラームの定義
• 外部アラームの定義