Versions Compared

Key

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

...

The module status is essentially a heartbeat. Each module typically sends a heartbeat message every 5 seconds. For each module, assuming a heartbeat has been received, a status element will be added to the status report. If a status element is not present, then either the heartbeat has been delayed or the module has gone offline. When requesting a status report using a Command Message, the report can be filtered to only include the Module and Radar Health Status.

Module Status Attributes

Info

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

...

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

ModuleStatusList


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.

...

Info

In situations where Witness is being used with recorded or simulated data then do not expect to receive radar health updates will be simulated to ensure the system remains healthy. Detailed health data, such as temperature, will not be available.

System Profile Status Element

The system status element shows which system profile is currently active. The Id is the UserId of the profile and the name is also included to make the data more readable. When requesting a status report using a Command Message, the report can be filtered to only include the System Profile Status.

System Profile Status Attributes

...

The area summary element contains a list of Area Status elements. Each status element contains details on the area, including the user Id, name current state. When requesting a status report using a Command Message, the report can be filtered to only include the Area Summary Status.

Attribute

Description

Type

Unit

Reported

Time and date that the status was last reported

DateTime

 

...