...
The Integration Simulator is a standalone software that allows the end user or integrator you to test and develop connections to integration plugins Integration Plugins. Please contact your sales manager if you wish to obtain a copy of the Integration Simulation software.
The simulator is able to simulate the majority of the Witness system output and enables testing of the system integration without having to spend days commissioning a full radar system beforehand.
| Info |
|---|
For customers and integrators intending to use the Integration Simulator, the documents assume a reasonable working knowledge of network communication. They are targeted at technical teams, typically with software development skills, who are integrating the output from Witness into external systems. |
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
User Interface
...
Plugin Tree: Lists all the integration and simulation plugins. The Start and Stop buttons will start and stop any enabled integration plugins.
Plugin Configuration Panel: This panels displays the configuration for the currently selected plugin, either integration or simulator.
Log Panel: Shows all the log output from the application and plugins.
Integration simulator will load up two distinctly different types of plugins - integration plugins and simulation plugins.
Integration plugins are the Navtech Witness system plugins that integrate with external systems. The purpose of the integration simulator application is to enable testing these integrations without having to fully deploy a Navtech system.
Simulation plugins are specifically for the integration simulator. They simulate the rest of the Navtech system and provide output to the integration plugins, such as alarms or carriageway statistics. Selecting a plugin, whether integration plugin or simulation plugin, will display the plugin's configuration on the Plugin Configuration Panel.
Configuring Integration Plugins
To configure an integration plugin, we can select an integration plugin from the tree and click edit. This will give us the same configuration editor as we would get in the Witness 4 Client.
Saving the configuration will have the same effect as on an actual Witness system - plugins that are enabled will try to automatically start themselves.
Like Witness, on first launching the Integration Simulator, enabled plugins will automatically start. However they can be controlled using the Start and Stop buttons if required.
A plugin that is not enabled cannot be started.
...
Please see the details for each integration plugin:
Configuring Simulation Plugins
The simulation plugins are specific to the product, so ClearWay and AdvanceGuard have their own. These plugins simulate the Witness functionality associated with these products, such as raising alarms or generating tracks.
System Simulator
The System Simulator handles common system level settings, including System Profiles and Areas.
Profiles
...
System Profiles: This simulates the Witness System profile. It shows the currently selected profile and allows you to change the profile. The profile can be changed by selecting the required profile and selecting the Set System Profile button. This can trigger outgoing profile status reports (e.g. ICD-001) and also respond to incoming profile change requests.
Selected - checkbox to select a system profile
Profile Id - numeric Id of the profile
Profile Name - the name of the profile
Areas
...
Areas: This simulates a fixed list of areas. Each area has a different type and displays the state. The state can be changed by highlighting an area and selecting the Set State button. In addition, if an area state is changed through an integration plugin then the modified state will be displayed here.
Id - the area user Id
Name - area name
Type - the area type
Enabled - the current state of the area
Disarm Mode - the current mode of the area
System Health Simulator
The health simulator enables you to generate health status reports and alarms with details of radar and modules. You can adjust the status of the radar and the modules using the plugin configuration, for example you can change a radar’s health or connection health to unhealthy, and then you can generate a status report or an alarm to report this change.
...
Radars: This is a list of pre-configured radar showing their health and connection status. Both can be changed for testing purposes:
Include - option to include or exclude the radar within the health reporting
Name - name of the radar
Id - User Id of the radar
Health - health status of the radar
Connection Health - health status of the radar connection
| Info |
|---|
The number of radars listed is based on the number of radars configured in the Security or Highways Simulator plugin. Both these plugins allow you to change the number of available radar. They will always provide 5 radar by default. |
Modules: This is a list of pre-configured modules and active integration plugins showing their connection health status. The Management Server also has an additional status that simulates the database health. All available health states can be changed for testing purposes.
Include - option to include or exclude the radar within the health reporting
Module Name - name of the module
Connection Health - current module health status
Database Health - current database health
To trigger a topology update, which is usually translated to a status report by the integration plugins, select the Send Topology button. To trigger one or more health alarms based on any radars or modules that have health status set to anything other than Healthy, select the Send Alarms button.
| Info |
|---|
To clear a health alarm, set the health status on the radar or the module back to Healthy and resend the alarms using Send Alarms. |
Security Simulator
...
Configure Simulation
These buttons provide options to manage the simulator configuration:
Configure Radars - allows you to change the number of radars to simulate - both for alarms and health.
Save Configuration - enables you to force the configuration to be saved.
Reset Configuration - resets and reloads the configuration. This option honours the configured number of radar but it will also reset the data to the last saved state. This enables configs to be saved and moved to a different PC if required.
Security Alarms
Allows you to create, publish and clear security alarms:
Add Alarms - select this button to create a new alarm. Once clicked the alarm form will become enabled so you can populate the alarm details
Send Alarms - select this to publish all alarms to the plugins. The plugins will receive the alarms have send out messages based on the current alarm states.
Clear Alarms - select this to clear all selected alarms in the active alarms list
Acknowledge Alarms - select this to acknowledge the selected alarms. This will clear the alarms from the list
Adding Alarms
To add a new alarm:
...
Select Add Alarms.
Edit the alarm details.
Repeat steps 1 & 2 as required.
Once ready, select Send Alarms to publish the configured alarm list.
| Info |
|---|
You can add several alarms at the same time. Once added, you will be able to edit any of these alarms by selecting them in the active list. However as soon as you select Send Alarms you will only be able to edit the alarm severity. Once you have sent the alarm list, the clear and acknowledge alarms options will become available. |
To update an existing alarm
Select the alarm you wish to update.
Change the severity (this is the only property available to change after you have published the alarms at least once).
Select the Send Alarms.
Clearing Active Alarms
To clear active alarms:
...
Select the required alarms from the active list.
Select the Clear Alarms button.
Alarms will be marked as cleared in the list and alarm updates will be automatically published.
...
| Info |
|---|
Alarms must have been sent before they can be cleared. |
Acknowledging Alarms
To acknowledge a cleared alarm:
...
Select the cleared alarms you wish to acknowledge.
Select Acknowledge Alarms.
The alarm will be acknowledged and automatically removed from the list. Alarm updates will be automatically published.
...
| Info |
|---|
Alarms must have been cleared before they can be acknowledged. |
Camera Commands
Allows you to create and publish camera movement commands. The simulator provides 3 default cameras for testing.
...
Send Camera Command - sends a camera command for the selected camera
To send a camera control:
Select a camera from the list.
Enter a movement type and relay Id, if required.
Select the Send Camera Command button.
Tracks
Allows you to create and publish tracks. Tracks can include the normal position and movement data as well as broken rule information.
...
Add Track - allows you to enter new track details
Send Tracks - select this to publish the active list of tracks
Clear Tracks - select this to clear the selected tracks
To add tracks:
...
Select Add Track.
The track will be added to the active track list with default data.
Edit the settings to suit your testing.
Repeat these steps to add more tracks if required.
To send the active tracks, select the Send Tracks button.
To include rule Ids in the track broken rule data, select the required rules from the rule list before sending the tracks.
| Info |
|---|
Once you have added a track, you can easily change the track attributes by selecting it in the list and then changing the attributes in the Tracks form. This allows you to add multiple tracks with the ability to update them as required. The tracks will remain editable even after you have selected Send Tracks. Each time you select Send Tracks the same tracks will be sent but with whatever values have been set in the Tracks form. This gives you the ability to simulate a moving track. |
To remove a track:
Select one or more tracks from the active tracks list by using the Remove checkbox column
Select the Clear Tracks button.
Highways Simulator
The included Highways Simulator simulation plugin can be used to set up Carriageway and Radar entities and can also be used to create carriageway statistics and highway alarm messages.
Configuration
...
By default, the Highways Simulator creates 2 carriageways with 10 sections each and 5 radars.
Use "Configure Radars" to change the number of Radars. This will delete all existing radars and create news one until the number is reached. Any integration plugin tied directly to radar or radar entity updates will be affected by this.
Use "Configure Carriageways" to change the number of carriageways and / or the number of sections per carriageway. This will recreate carriageways to meet input. All carriageways will be created with the 6 default rules (debris, ERA, person, queue, reversing and slow) plus an additional stopped vehicle rule and with 4 lanes.
| Info |
|---|
Carriageway ConfigurationsCarriageways are generated with default settings. This includes 11 m/s queue threshold, 16 m/s heavy traffic density and track density queue as 4. In some integration plugins that are able to output section queue and heavy traffic flags, these criteria will need to be met. |
On restarting the system, we will have the same radars and carriageways as last usage.
Select "Save Configuration" to save the current configuration to file. You will receive a log message indicating a successful save and where the configuration file has been saved to. It should look something like "C:\ProgramData\Navtech\Integration Simulator\HighwaysSimulatorConfig.xml". C:\ProgramData will be different depending on where your window's application data folder is located.
To load the configuration file from your application data folder, click Load Configuration. If the relevant file is not found, a new configuration will be generated based on defaults.
| Tip |
|---|
You can pass configuration from one computer to another using save and load. |
Sending Statistics
We can use the commands available in the Carriageway Statistics section to send statistics or traffic analysis reports.
"Send Statistics" will send random statistics for each section of the selected carriageway. You can change the selected carriageway from the Carriageway dropdown.
"Clear Traffic" will send stats for every section of the selected carriageway with 0 traffic and 0 speed. This will also raise the flag that the entire carriageway is clear of traffic.
If any section is selected, you can also send out Traffic Analysis messages from "Send Section TA". This will send out a randomized traffic analysis message with reports for the selected sections.
Similarly, you can use "Send Clear TA" to send a traffic analysis message with 0 traffic and 0 speed for all selected sections.
| Tip |
|---|
Need to verify if you have received the data correctly? Check what statistics were sent out from the log output. |
Sending Alarms
To send alarms against carriageway rules, we first select the sections and rules we want to raise the alarm against. Optionally, we can select a lane for the alarms as well. We can then Add Alarms to include the selected alarms in the local alarm list. Note that the alarm simulator contains the same limitations as the actual Witness 4 system in that only one alarm can be raised for each rule and section combination and does not generate separate alarms for different lanes.
To remove an alarm, tick the checkbox for the alarm under "Clear" and click "Clear Alarms". You can select all alarms by selecting the checkbox in the column header.
The alarms are only send to the integration plugins on clicking the "Send Alarms" button.
Related information
...
| Note |
|---|
If the AdvanceGuard® or Sea360® Integration Simulator software won't start then you will need to delete the Security Integration Simulator folder. It should be located here: %ProgramData%\Navtech\Security Integration Simulator. If the ClearWay™ Integration Simulator software won't start then you will need to delete the Highways Integration Simulator folder. It should be located here: %ProgramData%\Navtech\Highways Integration Simulator. The Integration Simulator should then start and create a new default config. |
Contents
...
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
...
User Interface
...
Plugin Tree: Lists all the Integration and Simulation Plugins. The Start and Stop buttons will start and stop any enabled Integration Plugins.
Plugin Configuration Panel: This panel displays the configuration for the currently selected plugin, either integration or simulator, including the Active Alarms List and the Active Tracks List.
Log Panel: Shows all the log output from the application and plugins.
The Integration Simulator will load up two distinctly different types of plugins - Integration Plugins and Simulation Plugins.
Integration Plugins are the Navtech Witness system plugins that integrate with external systems. The purpose of the integration simulator application is to enable testing these integrations without having to fully deploy a Navtech system.
Simulation Plugins are specifically for the Integration Simulator. They simulate the rest of the Navtech system and provide output to the integration plugins, such as alarms or carriageway statistics. Selecting a plugin, whether Integration Plugin or Simulation Plugin, will display the plugin's configuration on the Plugin Configuration Panel.
Configuring Integration Plugins
To configure an integration plugin, you can select an integration plugin from the tree and click Edit. This will display the same configuration editor as you would see in the Witness client.
Saving the configuration will have the same effect as on an actual Witness system - plugins that are enabled will try to automatically start themselves.
Like Witness, on first launching the Integration Simulator, enabled plugins will automatically start. However they can be controlled using the Start and Stop buttons if required.
| Info |
|---|
A plugin that is not enabled cannot be started. |
...
Please see the details for the supported Integration Plugins here: Integration Configuration.
Configuring Simulation Plugins
The simulation plugins are specific to the product, so ClearWay™, AdvanceGuard® and Sea360® have their own. These plugins simulate the Witness functionality associated with these products, such as raising alarms or generating tracks.
System Simulator
The System Simulator handles common system level settings, including System Profiles and Areas.
Profiles
...
System Profiles: This simulates the Witness system profile. It shows the currently selected profile and allows you to change the profile. The profile can be changed by selecting the required profile and selecting the Set System Profile button. This can trigger outgoing profile status reports (e.g. Navtech ICD-001 Protocol) and also respond to incoming profile change requests.
Selected: Checkbox to select a system profile.
Profile Id: Numeric Id of the profile.
Profile Name: The name of the profile.
Areas
...
Areas: This simulates a fixed list of areas. Each area has a different type and the system will show its mode and if it is enabled. The state can be changed by highlighting an area and selecting the Set State button. In addition, if an area state is changed through an integration plugin then the modified state will be displayed here.
Id: The area user Id.
Name: Area name.
Type: The area type.
Enabled: The current state of the area.
Disarm Mode: The current mode of the area.
System Health Simulator
The health simulator enables you to generate health status reports and alarms with details of the radar and modules. You can adjust the status of the radar and the modules using the plugin configuration. For example, you can change a radar’s health or connection health to unhealthy, and then you can generate a status report or an alarm to report this change.
...
Radars: This is a list of pre-configured radar showing their health and connection status. Both can be changed for testing purposes.
Include: Option to include or exclude the radar within the health reporting.
Name: Name of the radar.
Id: User Id of the radar.
Health: Health status of the radar.
Connection Health: Health status of the radar connection.
| Info |
|---|
The number of radars listed is based on the number of radars configured in the Security or Highways Simulator plugin. Both these plugins allow you to change the number of available radar. They will always provide 5 radar by default. |
Modules: This is a list of pre-configured modules and active integration plugins showing their connection health status. The Management Server also has an additional status that simulates the database health. All available health states can be changed for testing purposes.
Include: Option to include or exclude the radar within the health reporting.
Module Name: Name of the module.
Connection Health: Current module health status.
Database Health: Current database health.
To trigger a topology update, which is usually translated to a status report by the integration plugins, select the Send Topology button. To trigger one or more health alarms based on any radars or modules that have health status set to anything other than Healthy, select the Send Alarms button.
| Info |
|---|
To clear a health alarm, set the health status on the radar or the module back to Healthy and resend the alarms using Send Alarms. |
Security Simulator
...
Configure Simulation
These buttons provide options to manage the simulator configuration:
Configure Radars: Allows you to change the number of radars to simulate - both for alarms and health.
Save Configuration: Enables you to force the configuration to be saved.
Reset Configuration: Resets and reloads the configuration. This option honours the configured number of radar but it will also reset the data to the last saved state. This enables configs to be saved and moved to a different PC if required.
Security Alarms
Allows you to create, publish, clear and delete security alarms:
Add Alarms: Select this button to create a new alarm. Once clicked the alarm form will be enabled so you can populate the alarm details.
Send Alarms: Select this to publish all alarms to the plugins. The plugins will receive the alarms and send out messages based on the current alarm states.
Clear Alarms: Select this to clear all selected alarms in the Active Alarms List.
Acknowledge Alarms: Select this to acknowledge the selected alarms. This will clear the alarms from the Active Alarms List.
Delete Alarms: Select this to delete all selected alarms in the Active Alarms List.
Auto Acknowledge: Select this check box to automatically acknowledge the selected alarms when the alarms have been cleared. This will clear the alarms from the Active Alarms List.
The following fields are automatically populated when you add an alarm, however, they can be edited:
Description: The description of the alarm which you can edit.
Severity: Defines how a target should be marked when it breaks a rule:
Unknown
Friend
Warning
Threat
Priority: Allows you to optionally apply a ‘weighting’ to any rules that invoke an action using comparative values.
Lowest
Low
Medium
High
Highest
Alarm Type: Select from the list of alarm types:
None
Follow
Alarm
Alarm And Follow
Radar: Select from the list of radars.
Rule Id: Auto populated with 1 but this can be edited during configuration.
Relay Id: Auto populated with 0 but this can be edited during configuration.
Area: Select from the list of areas.
Adding Alarms
To add a new alarm:
Click the Add Alarms button:
The alarm details field will be enabled so you can edit the alarm details in the Security Alarms section, which will then populate the Live Alarms List beneath it (both highlighted):
You can then add more alarms by repeating steps 1 to 2.
Next, select Send Alarms to publish the configured Active Alarms List:
Once you have sent the alarms, there is an alarms sent message displayed in the Log Panel, highlighted above.
| Info |
|---|
You can add several alarms at the same time. Once added, you will be able to edit any of these alarms by selecting them in the Active Alarms List. However as soon as you select Send Alarms you will only be able to edit the alarm severity. Once you have sent the Active Alarms List the Clear and Acknowledge Alarms options will become available. |
Update Existing Alarm
To update an existing alarm:
Select the alarm you wish to update; you can select all alarms by selecting the checkbox in the column header or select individual alarms:
Change the severity (this is the only property available to change after you have sent an alarm):
Click Send Alarms.
Clearing Active Alarms
To clear active alarms:
Select the required alarms from the Active Alarms List:
Select the Clear Alarms button:
Alarms will be marked as cleared in the list and alarm updates will be automatically published:
| Info |
|---|
Alarms must have been sent before they can be cleared. |
Acknowledging Alarms
To acknowledge a cleared alarm:
Select the cleared alarms you wish to acknowledge.
Select Acknowledge Alarms.
The alarm will be acknowledged. Alarm updates will be automatically published:
| Info |
|---|
Alarms must have been cleared before they can be acknowledged. |
Delete Alarms
To delete a cleared alarm:
Select the alarms that wish to delete and click the Delete Alarms button:
The system will delete the selected alarms, and remove them from the Active Alarms List.
| Info |
|---|
Alarms must be acknowledged before they can be deleted. |
Camera Commands
Allows you to create and publish camera movement commands. The simulator provides 3 default cameras for testing.
...
Send Camera Command: Sends a camera command for the selected camera.
To send a camera control:
Select a camera from the list.
Enter a movement type - Automatic or Manual, and Track Id, if required.
Select the Send Camera Command button.
Tracks
Allows you to create and publish tracks. Tracks can include the normal position and movement data as well as broken rule information.
...
Add Track: Allows you to enter new track details.
Send Tracks: Select this to publish the active list of tracks.
Clear Tracks: Select this to clear the selected tracks.
The following fields are automatically populated when you add a track, however, these fields can be edited:
X/Y/Z: These are the location coordinates of the track.
Severity: Defines how a target should be marked when it breaks a rule, e.g. Warning.
Speed (m/s): The speed of the track.
Direction (degs): The direction in which the track is travelling.
Size in Range: The size of the Track along the range.
Size in Azimuth: The size of the Track along the azimuth.
Classification: Allows you to select one of the entities from the drop-down list; e.g. Large Vehicle.
Probability (%): Allows you to define a confidence level which must be matched or exceeded for a given track before it can be considered within the rule.
Radar: Select the radar from the radar list.
To Add Tracks
...
To add a track:
Select Add Track.
The track will be added to the active track list with default data.
Edit the settings to suit your testing.
Repeat these steps to add more tracks if required.
To send the active tracks, select the Send Tracks button.
To include Rule Ids in the track broken rule data, select the required rules from the Rule List before sending the tracks.
| Info |
|---|
Once you have added a track, you can easily change the track attributes by selecting it in the list and then changing the attributes in the Tracks form. This allows you to add multiple tracks with the ability to update them as required. The tracks will remain editable even after you have selected Send Tracks. Each time you select Send Tracks the same tracks will be sent but with values that have been set in the Tracks form. This gives you the ability to simulate a moving track. |
To Remove a Track
Select one or more tracks from the active tracks list by using the Remove checkbox column. You can also select all of the tracks by selecting the Remove checkbox in the column header.
Select the Clear Tracks button.
The tracks will be removed from the Active Tracks List.
Highways Simulator
The included Highways Simulator simulation plugin can be used to set up carriageways and radars and can also be used to create carriageway statistics and highway alarm messages.
...
| Info |
|---|
By default, the Highways Simulator creates 2 carriageways with 10 sections each and 5 radars. |
Configure Radars
To change the number of radars:
Select Configure Radars to open the Configure Radars dialogue. Here you can choose the number of radars you need:
Click OK.
This will delete all existing radars and create new ones until the desired number is reached. Any Integration Plugin tied directly to radar or radar entity updates will be affected by this.
Configure Carriageways
To change the number of carriageways and, or the number of sections per carriageway:
Select Configure Carriageways to to open the Configure Carriageways dialogue. Here you can change the number of carriageways and sections per carriageway:
Click OK.
This will recreate the carriageways as required. All carriageways will be created with 4 lanes and with the default rules; Debris, ERA, Person, Queue, Reversing Vehicle, Slow Vehicle and Stopped Vehicle.
| Info |
|---|
By default, carriageways are generated with settings that include an 11 m/s queue threshold, 16 m/s heavy traffic density and a track density queue of 4. For Integration Plugins that are able to output section queue and heavy traffic flags, these criteria will need to be met. |
| Note |
|---|
When restarting the system, the last saved configuration will be loaded. |
Save Configuration
Select Save Configuration to save the current configuration to file:
You will receive a log message indicating a successful save and where the configuration file has been saved to. For example; %ProgramData%\Navtech\Highways Integration Simulator\HighwaysSimulatorConfig.xml
Section and Rules
You can now administer the Sections and the Rules for your carriageways to send alarms against carriageway rules by selecting the sections and rules you want to raise the alarm against. Optionally, you can select a lane for the alarms as well. To do this:
Ensure the Sections and Rules tab is open:
There will be a list of the sections you have configured with the rules.
You can select sections and the rules that you wish to apply by selecting their check boxes:
In the example above, Section 1 of Lane 1 has been chosen with a variety of rules. The Auto Acknowledge check box has been selected by default.
Add Alarms
You can now add your selection to the Live Alarm List.
Click the Add Alarms button:
This will add each of the rules for the section to the Live Alarms List as highted above.
Selecting the check box on the Live Alarms List toolbar will select or deselect all of the checkboxes below it:
Alternatively, you can select individual rows in the list.
Send Alarms
| Info |
|---|
The alarms are only sent to the enabled integration plugins. |
To send an alarm:
Click the Send Alarms button:
In this example, the ICD-100 XML Plugin has been enabled and the Log Panel shows that the 6 alarms have been sent (highlighted in pink).
The alarm simulator contains the same limitations as the actual Witness 4 system in that only one alarm can be raised for each rule and section combination and does not generate separate alarms for different lanes.
Clear Alarms
To clear the alarms:
Click the Clear Alarms button; you can select all alarms by selecting the checkbox in the column header or select individual alarms:
As the Auto Acknowledge check box has been selected then clearing the alarms will also acknowledge them as in the example above.
If the Auto Acknowledge check box has not been selected:
Clicking on the Clear Alarms button will clear the alarms but not auto acknowledge them:
Acknowledge Alarms
To manually acknowledge the alarms:
Select the alarms you wish to acknowledge which will enable the Acknowledge Alarms button:
This will then acknowledge the alarms on the list:
Delete Alarms
You can delete all alarms by selecting the checkbox in the column header or select individual alarms:
Select the alarm or alarms from the list and click the Delete Alarms button:
The selected alarms will be removed:
Reset Configuration
To reset the Section and Rules configuration back to default:
Click the Reset Configuration button:
This will clear the sections, rules, Alarm Lane and Live Alarm List, and will select the Auto Acknowledge check box.
Send Statistics
You can use the commands available in the Carriageway Statistics section to Send Statistics or Traffic Analysis reports.
Click Send Statistics: this will will send randomly generated statistics for each section of the selected carriageway. You can change the selected carriageway from the Carriageway dropdown:
These statistics will be displayed within the Log Panel, as above.
Clear Traffic
To send zero traffic stats for every section of the selected carriageway:
Click the Clear Traffic button. This will also raise the flag that the entire carriageway is clear of traffic.
Send Section TA
If any section has been selected in the Section and Rules tab you can send out Traffic Analysis messages:
Click the Send Section TA button:
This will send out a randomized traffic analysis message with reports for the selected sections. In the above example it has sent out messages for Section 1.
Send Clear TA
To see a message showing that there is no traffic within a section:
Click Send Clear TA to send a traffic analysis message for all of the selected sections in the Section and Rules tab:
...
Related Information
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|
...