Modbus Alarm Addresses

The Address for the alarms is following:

Address	Description	Data Type
OEMAlarmEvent:0	System Alarm and operator message reader.	TAlarmEvent[]

Messages are not acknowledged by the HumanOS® IoT Runtime. Typically, this is done by the machine component when its associated reset action is activated.

Alarm Item

See the Operation Manual for the containing fields.

Alarm Tasks and Mapping

The driver supports device alarms by mapping source. It is possible to declare multiple alarm sources (tasks) for one alarm address (pool).

This example shows three alarm sources with a mapping file:

{
 ...
  "AlarmEventPool": {
    "Id": "FA1611AB-B6C9-4FF4-B34D-BF35E6A44232",
    "Name": "AlarmEventPool",
    "Tasks": [
      {
        "Id": "10077ca2-4e2e-493c-a531-279df6c10cc8",
        "Name": "Report Messages",
        "Address": "OEMAlarmEvent:0",
        "Properties": [
          {
            "Name": "MessageMappingFile",
            "Value": "Messages.json"
          },
          {
            "Name": "MessageCount",
            "Value": 20,
            "DataType": "System.Int32"
          },
          {
            "Name": "StartAddress",
            "Value": "HoldingRegister.ByteArray:972.48"
          },
          {
            "Name": "MessageFormat",
            "Value": "BitMessage"
          },
          {
            "Name": "Message:Type",
            "Value": "Standard"
          }
        ]
      }
    ]
  }
}

Accessor	Description
Id	Unique Id for each task
Name	A name for the task
Address	Alarm address (pool)
Property MessageMappingFile	The mapping file to load (JSON)
Property MessageCount	Amount of messages which are mapped
Property Startaddress	The corresponding source address with offset and length
Property MessageFormat	Is always BitMessage
Property Message:Type	Type of each message that occurs from this source

A property which starts with Message: is attached as property to the alarm item (e.g. message) which means additional fields are added with this data.

Mapping means, the alarms and events are defined by the data given and not the data that the alarm source provides. The mapping source must be of type JSON must be structured like this example:

{
  "Messages": [
    {
      "Id": 0,
      "AlarmType": "Alarm",
      "OemId": "Alarm 1",
      "Text": "Test message; CPU Error",
      "Properties": [
        {
          "Name": "Property1",
          "Value": "Value1"
        }
      ]
    }
  ]
}

Accessor	Description
Id	Specifies the bit number (absolute)
AlarmType	Specifies the Alarm type, see Alarm Types in Alarm and Event Source
OemId	The Condition name of the alarm or event
Text	Specifies the message
Properties	Specify properties which are attached to this alarm or event and can later be accessed
Properties:Name	Property name
Properties:Value	Property value