Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »


On this page:

Example Alarm Report
<?xml version="1.0" encoding="utf-8" ?>
<al:AlarmReport xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:al="ICDNAV001-AlarmReport" xmlns:cmn="ICDNAV001-CommonTypes">
  <al:Alarm AlarmId="5" Description="An Alarm" Priority="2" Reported="2010-04-03T22:05:02.112" Category="Rule" Severity="Warning" State="AlarmOn" Acknowledged="False" RuleId="1">
    <al:Payload SectionId="1" LaneId="3" CarriagewayId="2" SubType="Stopped" CarriagewayName="M25-J">
      <cmn:Distance DistanceFromOrigin=”99758”/>
      <cmn:GeoData Latitude="33.860012" Longitude="-1.7891123"/>
    </al: Payload >
  </al:Alarm>
</al: AlarmReport>

Alarm Element

The alarm element represents a generic alarm, either incident or system health. In addition it can contain specialised alarm payloads which contain data specific to certain alarm types. Currently the only documented payload is for the Highways alarm which is covered below.

Optional attributes are formatted in italics and highlighted with an asterisk.

Attribute

Description

Type

Unit

Reported 

Time alarm was reported

DateTime

 

AlarmId

Unique Id of the alarm

Long

 

Category

Alarm category – options are: 

  • Rule        
  • System        
  • Health

AlarmCategoryList


Description

Description of the alarm – normally based on the alarm category or rule message

String

 

Severity

Severity of the alarm – options are: 

  • Threat
  • Warning
  • Friend
  • Unknown

AlarmSeverityTypeList


State

Alarm state - options are: 

  • AlarmOn
  • AlarmOff
  • Dismissed

AlarmStateTypeList


Priority

Indicates the level of priority based on the users requirements

Integer

 

Acknowledged

Indicates if the alarm has been acknowledged

Boolean

 

RuleId*

The id of the rule to which this alarm is associated

Integer

 



Related information

  • No labels