AlarmEventPools

HumanOS® Runtime implements an Alarm and Event Handling based on messaging publisher and subscriber.

• AlarmSource: The alarm source provides alarms and events.
• Alarm & Event Services: Services consume alarms and events.
• AlarmEventPool: message space

The underlying system is built as a publisher and subscriber system. Internal communication directly communicates through these messaging ports.

Attribute	Description	Data Type
Id	Id of the alarm event pool	System.Guid
Name	Alarm event pool	System.String
HistoryMode	Historization mode of the alarm event pool. The history mode declares how to historize the messages in the database.

Example of an alarm event pool:

{
  "AlarmEventPools": [
    {
      "Name": "AlarmPool",
      "Id": "FA1611AB-B6C9-4FF4-B34D-BF35E6A44232"
    }
  ]
}

Alarm Message

Field Name	Description	Data Type
EventId	Id of the event	System.Int32
Message	Event text	System.String
Severity	Severity of the event	System.Int32
SourceNodeId	GlobalId of the source node	System.Guid
SourceName	Name or path of the source	System.String
Active	Flag is the alarm is active (=true) or gone (=false)	System.Boolean
AlarmType	Alarm type (Unknown; Information; Warning; Alarm; Emergency)	EAlarmType
ConditionName	Condition name, e. g. Alarm 1029	System.String
Occurrence	Occurrence timestamp	System.DateTime
Disappearance	Disappearance timestamp (valid only if Active = false)	System.DateTime
Properties	Custom specific properties of an alarm. Key-value pairs	Dictionary<string, string>

Event Messages

Field Name	Description	Data Type
EventId	Id of the event	System.Int32
Message	Event text	System.String
Severity	Severity of the event	System.Int32
SourceNodeId	GlobalId of the source node	System.Guid
SourceName	Name or path of the source	System.String
Time	Time of event occurrence	System.DataTime

AlarmEventPool Extension for UHAL Plugins

On the UHAL, alarm event pools are used to collect messages and alarms from hardware systems.

Attribute	Description	Data Type
Tasks	List of tasks to read alarm and events from hardware systems	TAlarmEventTaskInfo[]

Attributes from TAlarmEventTaskInfo:

Attribute	Description	Data Type
Address	Native address to access alarm and events	System.String

NOTE

UHAL device information support only one alarm event pool per connection.

Example:

"AlarmEventPool": {
  "Id": "81c47f51-1961-4c2b-b544-63e72163195a",
  "Name": "Alarming",
  "Tasks": [
    {
      "Id": "6D88F8D0-622D-42F1-A7E3-EFB51715A727",
      "Name": "StandardAlarms",
      "Address": "Nc1.NcAlarmEvent:0"
    }
  ],
  "HistoryMode": {
    "SamplingRate": 1000,
    "Retention": 0
  },
  "Properties": [
    {
      "Name": "PortMatchId",
      "Value": "CNCAlarmEvent"
    }
  ]
}