Introduction
This page covers the installation and configuration of the ICD-005 plugin for ClearWay™.
For customers and integrators intending to use the ICD-005 plugin, 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.
Contents
Overview
Witness supports integration with many different types of external systems through the use of plugins.
The ICD-005 Plugin enables ClearWay™ to transmit alarm and health data and receive highway configuration messages from the tunnel management system.
The plugin can be selected during setup and will automatically be installed in the correct location.
Prerequisites
The ICD-005 plugin requires a serial interface. We recommend an appropriate industrial serial adapter that is optically isolated.
Installing the ICD-005 Plugin
When installing ClearWay™, in the Choose Components page of the ClearWay™ Setup wizard, open Integration Plugin options and select ICD00.
Configuring the ICD-005 Plugin in ClearWay™
When the plugin is installed and licensed, a plugin configuration with default settings is automatically generated. The settings can be viewed and edited by enabling the Config Function, then selecting the plugin in Integration Configurations, within the Configuration Tree. Configuration settings will then be available in the Configuration Panel.
ICD-005 Plugin Fields
Plugin Enabled: Select to enable the ICD-005 Plugin.
Plugin Name: Name of the plugin within the ClearWay™ UI.
Com Port: The serial port to which the plugin will connect to send/receive messages.
System Id: The ID of the system sending the alarm and health data messages.
Baud Rate: The configured communication speed of the serial port. This must match the configured speed of the SCADA serial interface.
Alarm Repeat Interval (s): The period, in seconds, between a repeat of the alarm message being sent.
Alarm Check Interval (s): This setting specifies how often the system checks the alarm messages.
SCADA Send Delay (s): The SCADA send delay is the minimum period to wait between sending messages to the SCADA system.
SCADA Max Message Size: The maximum size of a message sent to the SCADA system.
Heartbeat Interval (s): The period, in seconds, between each heartbeat being sent.
ICD-005 Protocol
Amends the ‘System’ and ‘Radar’ status messages to integers as follows:-
Alarm Type 7 ( Radar Status) | Alarm Type 8 (System Status) |
1 = Sensor Failure/Offline | 1 = Alarm Module Loses Connection to HighBase |
2 = Radar rotation Problem | 2 = HighBase Loses Connection to a Tracker |
3 = Temperature Threshold exceeded | 3 = Tracker is Switched Off |
Amend the ‘System’ and ‘Radar” status messages to allow only one status per message.
Reduce the protocol size to the minimum, even if the output is not human readable.
Alarm Message
A | B | C | DD | E | FFFF |
A: HighBase ID
B: Contraflow Status
C: Alarm Type
D: Section
E: Lane
F: Spare (Distance along tunnel)
Total fixed size: 10 ASCII characters + message terminator.
Status Message
A | B | C | DD | E |
A: HighBase ID
B: Contraflow Status
C: Alarm Type (Type 7 or 8)
D: Head / Tracker ID
E: Status Message ID
Total fixed size: 6 ASCII characters + message terminator.
Heartbeat Message
A | B |
A: HighBase ID
B: Contraflow Status
Total fixed size: 2 ASCII characters + message terminator.
Terminating Characters
All outgoing messages will be terminated using the character ‘$’. This will provide a delimiter between messages being sent within the same transmission string. All complete transmissions are terminated with a character return and must never exceed a total of 127 characters.
Incoming Command Message
A | B | C |
A: Command Type (1 = Contraflow change)
B: Command switch (1 = Contraflow on / 0 = Contraflow off)
C: Command data (Bore number – 1 or 2)
Total fixed size: 3 ASCII characters.
Incoming messages are only ever sent as a single transmission. All transmissions are terminated with a character return. There are no message terminators on incoming messages.
Examples
Alarm Message:
1 | 0 | 1 | 04 | 1 | 0000 | $ |
HighBase ID: 1, No Contraflow, Alarm Type: Person detected, Section: 4, Lane: 1
Status Message
2 | 0 | 7 | 12 | 1 | $ |
HighBase ID: 2, No Contraflow, Alarm Type: Radar Status, Radar: 12, Status Msg: 1 (Sensor Offline)
Heartbeat Message
4 | 1 | $ |
HighBase ID: 4, Contraflow is on.
Incoming Alarm Messages
1 | 1 | 1 |
Msg Type: Contraflow switch, Command: Contraflow on (1), Data: Bore 1
Note: No terminating character – these are not used for incoming messages