| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<?xml version="1.0" encoding="utf-8" ?>
<st:StatusReport xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:st="ICDNAV001-StatusReport">
<!-- Canary module being reported as offline -->
<st:ModuleStatus Name="Canary" Reported="2010-04-03T22:05:02.112" Status="Offline" ModuleId="710e8979-effb-4d2d-94d4-205aa4bd0eae" />
<!-- Radar 1 reporting as operational with specific details on packet rate, rotation & temp -->
<st:RadarHealth RadarId="1" Name="Radar 1" Reported="2010-04-03T22:05:02.112" Packets="909" Temp="59" Rotation="1.1" Status="Online"/>
</st:StatusReport> |
Module Status Element
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 tracker has gone offline.
Module Status Attributes
| Info |
|---|
Optional attributes are formatted in italics and highlighted with an asterisk. |
Attribute | Description | Type | Unit |
Name | Name of the module. | String | |
| Reported | Time status was reported. | DateTime | |
Status | Status of module connection – options are:·
| ModuleStatusList |
|
| ModuleId | Unique identifier for the module (optional). | String | |
| 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 |
Radar Health Element
The radar health element provides specific health details for each sensor in the system. If a radar is active and connected then the Witness system will receive regular health updates. The latest health report for each radar is added to the status report. If a recent health update has not been received for any of the radar then there will be no element for that radar.
Radar Health Attributes
Attribute | Description | Type | Unit |
RadarId | ID of the radar | Long | |
Name* | User-friendly name of the radar | 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:
| 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.
There is no status to indicate that any of the values contained within the health data are outside expected parameters. This checking should be performed by the 3rd party based on suitable criteria for their own application.
Be aware that radar health can only be reported if the tracker is active. If a tracker goes offline, then no radar health will be reported for that tracker.
Trackers and their attached radar will always share the same Id (i.e. tracker ID:1 will be connected to radar ID:1).
| Info |
|---|
In situations where Witness is being used with recorded or simulated data then do not expect to receive radar health updates. |
Related information
| Filter by label (Content by label) | ||||
|---|---|---|---|---|
|