Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagexml
<?xml version="1.0" encoding="utf-8"?>
<StatusReport xmlns="ICDNAV001-StatusReport">
  <Sender SenderId="SenderId1" NetworkAddress="127.0.0.1" NetworkPort="6317" />
  <!-- Module Track Engine 1 is offline -->
  <ModuleStatus Name="TE1" Reported="2019-04-03T22:05:02.112" Status="Offline" ModuleId="710e8979-effb-4d2d-94d4-205aa4bd0eae" />
  <ModuleStatus Name="TE2" Reported="2019-04-03T22:05:02.112" Status="Online" ModuleId="C565AE57-95C5-4C17-8CF3-E19609067500" />
  <ModuleStatus Name="Camera Controller" Reported="2019-04-03T22:05:02.112" Status="Online" ModuleId="AF648F4D-3342-406E-888A-F4FAD05B36AA"/>
  <!-- Radar 1 being reported as offline - therefore no health metric can be reported -->
  <RadarHealth RadarId="1" Name="Radar 1" Reported="2019-04-03T22:05:02.112" Packets="0" Temp="0" Rotation="0" Status="Offline" />
  <!-- Radar 2 being reported as online but with a warning status because the temperature is too high -->
  <RadarHealth RadarId="2" Name="Radar 2" Reported="2019-04-03T22:05:02.112" Packets="801" Temp="89" Rotation="2.0" Status="Warning" />
  <RadarHealth RadarId="3" Name="Radar 3" Reported="2019-04-03T22:05:02.112" Packets="8001600" Temp="59" Rotation="24.01" Status="Online" HealthStatus="Warning">
    <Health Type="PacketRate" MinValue="790" MaxValue="810" Value="800" Status="Healthy" xmlns="ICDNAV001-CommonTypes" />
    <Health Type="Temperature" MinValue="-20" MaxValue="90" Value="-22" Status="Warning" xmlns="ICDNAV001-CommonTypes" />
    <Health Type="Rotation" MinValue="3900" MaxValue="4100" Value="4010" Status="Healthy" xmlns="ICDNAV001-CommonTypes" />
  </RadarHealth>
  <!-- The current system profile is the set to the default -->
  <SystemProfileStatus Name="Default" ProfileId="-1" Reported="2019-04-03T22:05:02.112" />
  <AreaSummary Reported="2019-04-03T22:05:02.112">
    <AreaStatus Type="General" Name="Front Gate" AreaId="1" Enabled="Enabled" />
    <AreaStatus Type="Detection" Name="Detection North" AreaId="2" Enabled="Enabled" />
    <AreaStatus Type="Alarm" Name="Alarm Zone A" AreaId="3" Enabled="Disabled" />
  </AreaSummary>
</StatusReport>

...

Attribute 

Description

Type

Unit

Name

Name of the module.

String

 

Reported

Time status was reported.

DateTime

 

Status

Status of module connection – options are:·        

  • Online

  • Warning

  • Offline

ModuleStatusListConnectionStatusTypeList

 

ModuleId*

Unique identifier for the module (optional).

String (representation of a GUID / UUID)


ModuleType*

Module type (optional). This is available in Witness 4.0 and higher.

String


HostIP*

IP of the server hosting the module (optional). This is available in Witness 4.0 and higher.

String


...

Attribute

Description

Type

Unit

RadarId

ID of the radar

Long

 

Name*

User-friendly name of the radar (optional)

String

 

Reported

Time health was reported

DateTime


Packets

Radar packet rate per second. Value will vary depending on the range and mode of the radar

Double


Temp

The current operating temperature of the sensor

Double

 

Rotation

The current rotation rate of the radar. Some models of radar have different rotation speeds but the default is 1Hz.

Double


Status

Status of radar connection – options are:

  • Online

  • Warning

  • Offline

ConnectionStatusTypeList


HealthStatus*

Health Status of Radar - options are:

  • Unknown

  • Healthy

  • Warning

  • Unhealthy

If Status of radar is Offline

ModuleStatusListthen the health status will be unknown

HealthStatusTypeList

Radar Health Status Element (Optional)

Info

Radar health status items will only appear if the Radar has a HealthStatus of Warning or Unhealthy

Attribute

Description

Type

Unit

Type

Type of Health - options are:

  • Temperature

  • PacketRate

  • Rotation

  • RxPacketRate

  • MotorCurrent

  • EncoderErrors

  • ClutterFloor

HealthInfoTypeList

Status

Health Status - options are:

  • Unknown

  • Healthy

  • Warning

  • Unhealthy

HealthStatusTypeList

MinValue

Minimum value can be

Double

MaxValue

Maximum value can be

Double

Value

Value

Double

Info

If the module or radar has been reported as being online, then if the system loses the connection to that application or device the status will change to reflect that. Typically, the application or device will change status from Online -> Warning -> Offline.

If a module or radar is removed from the list, then this would indicate the device has been shut down intentionally (i.e. a user stops a Bloodhound service) and should not be a cause for concern. In this situation the health will stop being reported for the removed device.

...