Alarm Report
An alarm report contains alarm data triggered as a result of track movement or behaviour which breaks one or more predefined rules. An alarm report differs from a track report in that it is only sent when an alarm occurs and although it can be initiated by multiple tracks only one instance of the alarm is generated. Alarm reports are typically associated with a specific area thereby alerting subscribers to one or more events happening in that area.
Alarm reports are transmitted as and when they occur. An alarm report is issued when an alarm is activated and once again when it deactivates. The report carries the same data, including unique id, for both, but an active flag indicates whether it is an alarm on or off message.
In addition, all active alarms are sent whenever a client connects or reconnects. This ensures that a client connecting after an alarm has already been triggered will still have access to all the relevant messages.
Alarm reports would not normally be associated with any camera move commands because there could be more than one track responsible. However, subscribers can utilise the alarm data to activate their own visual monitoring such as pre-sets for the specified alarm area.
Status Report
A status report contains health and operating information about the system sensors and software. Summary status data is sent automatically at regular intervals.
Basic status data is sent at regular intervals. The duration of the interval can be configured. Status data would normally be consolidated over the interval, thereby reducing unnecessary duplication of data. Where there is no specific status data to send then a simple heartbeat message will be sent instead.
Camera Report
A camera report contains information about camera movement. Normally the Navtech systems will pass commands to a PTZ camera directly, however these commands can be passed to consumers each time a camera is instructed to move in order to follow a target.
Camera reports are issued every time a camera is required to move. Camera commands are issued at regular intervals based on the speed at which the system receives target location updates from the tracking software and the Cyclops configuration.
These reports are typically used as an event message so 3rd party systems know when we are automatically moving PTZ cameras.
Heartbeat Report
A heart beat consists of only the message header with the correct message type set and no other content. The heartbeat is sent at regular intervals from Canary to all connected clients. This serves two purposes; firstly, it informs the clients that Canary is still alive and functioning and secondly it helps monitor the state of the client TCP connections. In the event of a client disconnecting the heartbeat message will fail and Canary will clean up the connection and dispose of any unused resources.
In a situation where a client connection fails, the client is responsible for attempting to re-establish the link.
| Info |
|---|
The heartbeat message can be used both by the server and the client. It is recommended that the client sends heartbeats to the Witness server but this is not mandatory. If the client does send heartbeats then the Witness system can be configured to raise an alarm if the client becomes disconnected. This will alert the Witness operator. |
Size Classification Report
A size classification report contains information about track size classifications within configured highway sections. This report is unique to the Witness ClearWay application.
These reports contain information about the location, classification, average size, average speed and quantity of tracks passing through a specified section within the configurable report period. If no tracks have been processed the report will still be generated but will contain no classification data.
Summary
Ser | Report Type | Contents | Transmission Schedule |
1 | Track Report | Track data including geo details if available | Regular transmission based on the frequency of track reports from the tracking software. |
2 | Alarm Report | Alarm data, including type and trigger details | Transmitted on activation and deactivation of alarm. All active alarms are transmitted when a subscriber connects / re-connects. |
3 | Status Report | Status data about sensors, hardware and software, including the active system profile and all area status | Basic data and heartbeats are sent regularly whilst the system is operable. More complex status data is sent on connection, periodically based on a configured schedule and available on request. |
4 | Heartbeat Report | None | Used to indicate that Canary is still communicating and also to check that the TCP client connections are alive. |
5 | Camera Report | Camera and camera move commands | Transmitted whenever a camera is instructed to move. Camera movement intervals are controlled by Cyclops. |
6 | Size Classification Report | Size Classification data including classification, average size, average speed, total tracks and location | Regular transmission based on the frequency specified in Size Classification plugin. |
System Profile Status Report | Details of currently active system profile | Sent as part of the primary status report and also when the profile changes and available on request. | |
Area Status Report | Provides state information for all areas in Witness | Sent as part of the primary status report and also when an area state changes and available on request. |
Related information
| Filter by label (Content by label) | ||||
|---|---|---|---|---|
|