Summary states allow summarizing multiple boolean states into a single state by OR-ing them together. This allows, eg., calculating summary alarms from individual alarm states.

Summary states are grouped together into summary blocks that updated together. The states are updated using the following task:

Summary Block Tasks

update Updates all the contained summary states.

Model File JSON Format

Summary Blocks

A JSON object describing a summary block has the following syntax:

{
  "@IOComponent.StateConcentrator.SummaryBlock": {
    "id": "Summary Alarms",
    "uuid": "fb3ba36e-2d88-45aa-a635-c5c13b12f35c",
    "children": [
      ...
    ]
  }
}

Object Members

id A string value containing the ID of the summary block. The ID is used to construct the summary block's primary key.

uuid A string value containing the unique UUID of the summary block.

children

A JSON array containing the summary states contained in the block.

Please remember that each element block requires two layers of {} due to the syntax restrictions of the JSON format.

Summary States

A JSON object describing a summary state has the following syntax:

{
  "@IO.StateConcentrator.SummaryState": {
    "id": "Press 1 Summary Alarm",
    "uuid": "88596be2-3592-44d5-a6b7-3e299171082a",
    "states": [
      "Press 1.Alarm 1",
      "Press 1.Alarm 2",
      "Press 1.Alarm 3",
      "Press 1.Alarm 4"
    ]
  }
}

Object Members

id	A string value containing the ID of the summary state. The ID is used to construct the summary state's primary key.
uuid	A string value containing the unique UUID of the summary state.
states	A JSON array containing the primary keys of the data points and/or I/O points to summarize. The elements must be readable and contain either Booleans or integers as values. For integers, each bit is considered a separate state.