ICD-001 Alarm Report

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

Highways Source Payload Attributes

Attribute	Description	Type	Unit
SubType	Highways Rule SubType – options are: Person Stopped Slow Debris Reversing Queue ERA Enforcement	RuleSubTypeList
SectionId	Section Id in which alarm happened (note : this is the user entered Id not the system Id)	Integer
LaneId	Lane Id in which alarm happened (note : this is the user entered Id not the system Id)	Integer
CarriagewayId	Carriageway Id in which alarm happened	Integer
CarriagewayName	Carriageway Name in which alarm happened	String

Distance Attributes

Attribute	Description	Type	Unit
DistanceFromOrigin	Linear distance to centre of section in alarm from the carriageway origin	Integer	Metres

GeoData Attributes

Attribute	Description	Type	Unit
Latitude	WGS 84 Coordinate	String	Decimal Degrees
Longitude	WGS 84 Coordinate	String	Decimal Degrees

Related information

Page:

ICD-001 Track Filter Command (Witness 4.0)
Page:

ICD-001 Acknowledge Alarm Command (Witness 4.0)
Page:

ICD-001 Request Status Command (Witness 4.0)
Page:

ICD-001 Detection Command (Witness 4.0)
Page:

ICD-001 Update Entity Command (Witness 4.0)
Page:

ICD-001 System Profile Command (Witness 4.0)
Page:

ICD-001 External Trigger Command (Witness 4.0)
Page:

ICD-001 Plugin (Witness 4.0)
Page:

ICD-001 Command Reply (Witness 4.0)
Page:

ICD-001 Camera Command (Witness 4.0)
Page:

ICD-001 Track Command (Witness 4.0)
Page:

ICD-001 Tracker Command (Witness 4.0)
Page:

ICD-001 Commands (Witness 4.0)
Page:

ICD-001 Change Log (Witness 4.0)
Page:

ICD-001 Classification Report (Witness 4.0)