Page 1
Versa Router 950
User Manual
Revision: 2.4
Revision 2.4 @2019 Control Data System
Page 2
Table of Contents
GENERAL NOTES ....................................................................................................................................... 6
COPYRIGHT ................................................................................................................................................. 6
INDEX OF TABLES ...................................................................................................................................... 7
INDEX OF FIGURES .................................................................................................................................... 7
1 DOCUMENT PURPOSE ..................................................................................................................... 12
2 TERMS AND ABBREVIATIONS ......................................................................................................... 12
3 REFERENCES AND RESOURCES .................................................................................................... 16
4 HARDWARE DESCRIPTION .............................................................................................................. 16
4.1 INTRODUCTION ............................................................................................................................... 16
4.2 BLOCK DIAGRAM ............................................................................................................................ 17
4.3 FEATURES OVERVIEW ..................................................................................................................... 17
4.4 MECHANICAL DIMENSIONS ............................................................................................................... 18
4.5 CONNECTOR INFORMATION ............................................................................................................. 19
4.6 COMPLIANCE INFORMATION ............................................................................................................. 19
4.6.1 Electromagnetic ........................................................................................................................ 19
4.6.2 Safety ....................................................................................................................................... 20
4.6.3 Hazardous area ........................................................................................................................ 20
5 QUICK START NETWORK CONFIGURATION ................................................................................. 21
5.1 VR950 CONFIGURATION ................................................................................................................. 21
5.1.1 Powering the VR950 Gateway ................................................................................................. 21
5.1.2 IP configuration ........................................................................................................................ 21
5.2 CONFIGURING A CDS VS210 FOR ISA100.11A ............................................................................... 23
5.2.1 Provisioning .............................................................................................................................. 25
5.2.2 Publishing ................................................................................................................................. 27
5.3 CONFIGURING A CDS VS210 FOR WIRELESSHART .......................................................................... 30
5.3.1 Provisioning .............................................................................................................................. 32
5.3.2 Joining ...................................................................................................................................... 34
5.3.3 Publishing: ................................................................................................................................ 35
5.4 CONFIGURING A HONEYWELL XYR6000 FOR ISA100.11A ............................................................... 38
5.4.1 Provisioning .............................................................................................................................. 40
5.4.2 Publishing ................................................................................................................................. 42
5.5 CONFIGURING A YOKOGAWA EJX110L FOR ISA100.11A ................................................................. 45
5.5.1 Provisioning .............................................................................................................................. 47
5.5.2 Publishing ................................................................................................................................. 49
5.6 CONFIGURING A EMERSON PT100/2WIRE FOR WIRELESSHART ..................................................... 52
5.6.1 Provisioning .............................................................................................................................. 54
5.6.2 Joining ...................................................................................................................................... 57
5.6.3 Publishing: ................................................................................................................................ 57
6 USING THE MONITORING CONTRO1 SYSTEM (MCS) FOR ISA 100 WIRELESS NETWORK ..... 60
6.1 ACCESS, AUTHENTICATION AND NAVIGATION ................................................................................... 60
6.2 NETWORK ...................................................................................................................................... 61
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 2 | 201
Page 3
6.2.1 Dashboard ................................................................................................................................ 61
6.2.1.1 Adding a Device to the Dashboard ................................................................................................... 62
6.2.1.2 Deleting a device .............................................................................................................................. 63
6.2.2 Topology ................................................................................................................................... 63
6.2.3 Devices ..................................................................................................................................... 68
6.2.3.1 Search devices ................................................................................................................................. 69
6.2.3.2 Device list ......................................................................................................................................... 70
6.2.3.3 Delete a device ................................................................................................................................. 70
6.2.4 Device Details .......................................................................................................................... 71
6.2.4.1 Information ........................................................................................................................................ 71
6.2.4.2 Settings ............................................................................................................................................. 73
6.2.4.3 Registration Log ............................................................................................................................... 75
6.2.4.4 Neighbors Health .............................................................................................................................. 76
6.2.4.5 Schedule Report ............................................................................................................................... 77
6.2.4.6 Channel Statistics ............................................................................................................................. 78
6.2.4.7 Run Commands ................................................................................................................................ 79
6.2.4.7.1 Read Value .................................................................................................................................. 80
6.2.4.7.2 Reset Device ................................................................................................................................ 80
6.2.4.7.3 Read Object Attribute ................................................................................................................... 81
6.2.4.7.4 Write Object Attribute ................................................................................................................... 82
6.2.4.7.5 Execute Object Method ................................................................................................................ 82
6.2.5 Network Health ......................................................................................................................... 83
6.2.6 Readings .................................................................................................................................. 84
6.2.7 Commands Log ........................................................................................................................ 85
6.2.8 Alerts ........................................................................................................................................ 87
6.2.9 Troubleshooting ........................................................................................................................ 89
6.2.9.1 Filters ................................................................................................................................................ 90
6.2.10 Bulk Transfers ...................................................................................................................... 92
6.2.11 Set Country Code ................................................................................................................. 94
6.3 CONFIGURATION ............................................................................................................................. 95
6.3.1 Basic ......................................................................................................................................... 95
6.3.2 Backbone Router ...................................................................................................................... 96
6.3.3 Gateway ................................................................................................................................... 97
6.3.4 System Manager ...................................................................................................................... 98
6.3.5 Device Management .............................................................................................................. 100
6.3.5.1 Configuring Backbones .................................................................................................................. 101
6.3.5.2 Configuring Gateways .................................................................................................................... 102
6.3.5.3 Configuring Devices ....................................................................................................................... 103
6.3.6 Configuring a Subnet .............................................................................................................. 104
6.3.7 Monitoring Host ...................................................................................................................... 104
6.3.7.1 Publishers ....................................................................................................................................... 105
6.3.7.2 Channels ........................................................................................................................................ 106
6.3.7.3 Autodiscover Publishers ................................................................................................................. 107
6.3.8 Modbus ....................................................................................... Error! Bookmark not defined.
6.3.8.1 Mapping Registers .......................................................................................................................... 109
6.3.9 Alert Subscription ................................................................................................................... 112
6.3.10 Advanced Settings .............................................................................................................. 112
6.3.10.1 Sections/variables .......................................................................................................................... 112
6.3.10.2 Restart/Stop .................................................................................................................................... 113
6.3.10.3 VR950 Settings ............................................................................................................................... 113
6.3.11 Bulk Transfers .................................................................................................................... 114
6.3.11.1 Adding a Bulk Transfer ................................................................................................................... 115
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 3 | 201
Page 4
6.3.11.2 Editing a Bulk Transfer ................................................................................................................... 116
6.3.12 System Status .................................................................................................................... 117
6.4 ADMINISTRATION .......................................................................................................................... 118
6.4.1 Device Firmware .................................................................................................................... 118
6.4.1.1 Updating the Firmware ................................................................................................................... 120
6.4.1.2 Canceling a Firmware Update ........................................................................................................ 121
6.4.1.3 Firmware files ................................................................................................................................. 122
6.4.1.3.1 Adding a Firmware file ............................................................................................................... 122
6.4.1.3.2 Editing a Firmware file ............................................................................................................... 123
6.4.2 System Upgrade ..................................................................................................................... 124
6.4.3 Custom Icons ......................................................................................................................... 125
6.4.4 Custom Settings ..................................................................................................................... 127
6.4.4.1 DateTime format ............................................................................................................................. 127
6.4.4.2 Interfaces Configuration ................................................................................................................. 127
6.5 SESSION ...................................................................................................................................... 127
6.5.1 Change Password .................................................................................................................. 127
7 USING THE MONITORING CONTROL SYSTEM (MCS) FOR WIRELESS HART NETWORK ...... 129
7.1 ACCESS, AUTHENTICATION, AND NAVIGATION ................................................................................ 129
7.2 NETWORK .................................................................................................................................... 130
7.2.1 Dashboard .............................................................................................................................. 130
7.2.1.1 Adding a Device to the Dashboard ................................................................................................. 131
7.2.1.2 Deleting a device ............................................................................................................................ 132
7.2.2 Topology ................................................................................................................................. 132
7.2.3 Devices ................................................................................................................................... 135
7.2.3.1 Search Devices .............................................................................................................................. 136
7.2.3.2 Device List ...................................................................................................................................... 137
7.2.3.3 Delete a Device .............................................................................................................................. 137
7.2.4 Device Details ........................................................................................................................ 137
7.2.4.1 Information ...................................................................................................................................... 138
7.2.4.2 Settings ........................................................................................................................................... 139
7.2.4.3 Registration Log ............................................................................................................................. 141
7.2.4.4 Neighbors Health ............................................................................................................................ 141
7.2.4.5 Schedule Report ............................................................................................................................. 142
7.2.4.6 Run Commands .............................................................................................................................. 144
7.2.4.6.1 WH General Command .............................................................................................................. 145
7.2.5 Network Health ....................................................................................................................... 146
7.2.6 Readings ................................................................................................................................ 148
7.2.7 Commands Log ...................................................................................................................... 149
7.2.8 Alerts ...................................................................................................................................... 150
7.3 CONFIGURATION ........................................................................................................................... 151
7.3.1 Access Point ........................................................................................................................... 151
7.3.2 Gateway ................................................................................................................................. 153
7.3.3 Network Manager ................................................................................................................... 154
7.3.4 Device Management .............................................................................................................. 155
7.3.4.1 Configuring Access Points .............................................................................................................. 157
7.3.4.1.1 Multiple Access Points ............................................................................................................... 158
7.3.4.1.2 Redundant Access Points .......................................................................................................... 158
7.3.4.2 Configuring Gateways .................................................................................................................... 158
7.3.4.3 Configuring Devices ....................................................................................................................... 158
7.3.5 Monitoring Host ...................................................................................................................... 159
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 4 | 201
Page 5
7.3.5.1 Burst Messages .............................................................................................................................. 160
7.3.5.2 Variables ......................................................................................................................................... 161
7.3.5.3 Triggers .......................................................................................................................................... 162
7.3.6 Modbus ....................................................................................... Error! Bookmark not defined.
7.3.6.1 Mapping Registers .......................................................................................................................... 164
7.3.7 Advanced Settings ................................................................................................................. 166
7.3.7.1 Sections/variables .......................................................................................................................... 166
7.3.7.2 Restart ............................................................................................................................................ 167
7.3.7.3 VR910 Settings ............................................................................................................................... 168
7.4 STATISTICS .................................................................................................................................. 168
7.5 ADMINISTRATION .......................................................................................................................... 170
7.5.1 System Upgrade ..................................................................................................................... 170
7.5.2 Custom Icons ......................................................................................................................... 171
7.5.3 Custom Settings ..................................................................................................................... 173
7.5.4 Device Codes ......................................................................................................................... 173
7.5.4.1 Adding a Device Code .................................................................................................................... 174
7.5.4.2 Editing a Device Code .................................................................................................................... 175
7.5.4.3 Deleting a Device Code .................................................................................................................. 175
7.6 SESSION ...................................................................................................................................... 176
7.6.1 Change Password .................................................................................................................. 176
8 WEB-BASED ADMINISTRATION /ADMIN/ ...................................................................................... 177
8.1 ACCESS, AUTHENTICATION AND NAVIGATION ................................................................................. 177
8.2 SYSTEM UPGRADE ....................................................................................................................... 178
8.2.1 Versa Router Firmware .......................................................................................................... 179
8.2.2 ISA Transceiver Firmware ...................................................................................................... 180
8.2.3 WHart TR Firmware ............................................................................................................... 181
8.2.4 Versa Router Application Website (Monitoring Control System) ............................................ 183
8.3 CONFIGURATION ........................................................................................................................... 185
8.3.1 Log Files ................................................................................................................................. 185
8.3.2 Reset Profile ........................................................................................................................... 186
8.3.3 Advanced Settings ................................................................................................................. 186
8.3.4 Network .................................................................................................................................. 187
9 COMMAND-LINE CONFIGURATION INTERFACE ......................................................................... 188
9.1 CHANGE VERSA ROUTER IP ADDRESS .......................................................................................... 188
9.2 UDP/TCP PORT CONFIGURATION ................................................................................................. 189
9.3 ACCESSING FILES THROUGH COMMAND-LINE INTERFACE ................................................................. 190
10 VERSA ROUTER CONFIGURATOR ............................................................................................ 190
10.1 CHANGING THE IP USING THE VERSA ROUTER CONFIGURATOR ...................................................... 190
APPENDIX A – COUNTRY CODES ......................................................................................................... 194
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 5 | 201
Page 6
General Notes
CDS offers this information as a service to support its customers with applications and engineering for
the products designed by CDS. The system validation of this product designed by CDS within a larger
electronic system remains the responsibility of the customer or the customer’s system integrator. All
specifications supplied herein are subject to change.
Copyright
This document contains proprietary technical information which is the ownership of Control Data
Systems SRL. The reproduction of this document entirely or partially is prohibited without the written
approval from CDS. All rights are reserved in event of the grant of a patent or the registration of a utility
model or design. All specifications supplied herein are subject to change without notice.
Copyright © Control Data Systems SRL, 2019
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 6 | 201
Page 7
Table
Name
Figure
Name
Index of Tables
Table 2.1 Terms-User Manual
Table 2.2 Abbreviations-User Manual
Table 4.1 General features
Table 4.2 Hardware Interface description
Table 4.3 Electromagnetic Compliance
Table 4.4 Safety Compliance
Table 4.5 Hazardous area
Table 6.1 Signal Quality for Received Signal Quality Indicator (ISA 100)
Table 6.2 Troubleshooting-Details explanations (ISA 100)
Table 6.3 Troubleshooting Alerts-mapping (ISA 100)
Table 6.4 Adding devices-role values and labels (ISA 100)
Table 7.1 Signal level for RSL (HART)
Table 7.2 General GW information (HART)
Index of Figures
Figure 4.1.1 VR950
Figure 4.2.1 VR950 Block Diagram
Figure 4.4.1 VR950 dimensions
Figure 4.5.1 VR950 connection ports
Figure 5.1.1 Default admin website static IP configuration
Figure 5.1.2 IP configuration example using the admin web interface
Figure 5.1.3 VR Configurator Tool
Figure 5.2.1 VS210 scheme
Figure 5.2.2 CDS Field Tool Com Connection
Figure 5.2.3 ISA Field Tool connection to Nivis Field Tool software
Figure 5.2.4 Nivis Field Tool Device Provisioning Settings
Figure 5.2.5 VS210 Radio and Default Reset Buttons
Figure 5.2.6 ISA Publishers Autodiscovery
Figure 5.2.7 Devices Publishers and Channels in Monitoring Host
Figure 5.2.8 Monitoring Host Help Information Figure 5.2.9 Modbus Help Information
Figure 5.3.1 VS210 scheme
Figure 5.3.2 MicroLink Hart Protocol Modern Com Connection
Figure 5.3.3 WirelessHART Provisioning tool COM Connection
Figure 5.3.4 Network ID and Join Key setup example (the Network ID found in MSC will be 2020 – hexadecimal
value)
Figure 5.3.5 Burst Message example
Figure 5.3.6 WirelessHART Provisioning Tool Join Status
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 7 | 201
Page 8
Figure 5.3.7 MCS Monitoring Host for WirelessHART, Burst Message and Variables example
Figure 5.3.8 MCS WirelessHART, Readings for Burst Message 0
Figure 5.3.9 Monitoring Host Help Information Figure 5.3.10 Modbus Help Information
Figure 5.4.1 Honeywell XYR6000
Figure 5.4.2 CDS Field Tool Com Connection
Figure 5.4.3 ISA Field Tool connection to Nivis Field Tool software
Figure 5.4.4 Nivis Field Tool Device Reset To Factory Defaults
Figure 5.4.5 Nivis Field Tool Device Provisioning Settings
Figure 5.4.6 ISA Publishers Autodiscovery
Figure 5.4.7 Devices Publishers and Channels in Monitoring Host
Figure 5.4.8 Monitoring Host Help Information Figure 5.4.9 Modbus Help Information
Figure 5.5.1 Yokogawa EJX110L
Figure 5.5.2 CDS Field Tool Com Connection
Figure 5.5.3 ISA Field Tool connection to Nivis Field Tool software
Figure 5.5.4 Nivis Field Tool Device Provisioning Settings
Figure 5.5.5 Nivis Field Tool connected to device
Figure 5.5.6 Yokogawa device in the process of joining to the Network
Figure 5.5.7 ISA Publishers Autodiscovery
Figure 5.5.8 Devices Publishers and Channels in Monitoring Host
Figure 5.5.9 Monitoring Host Help Information Figure 5.5.10 Modbus Help Information
Figure 5.6.1 Emerson PT100/2WIRE
Figure 5.6.2 MicroLink Hart Protocol Modern Com Connection
Figure 5.6.3 WirelessHART Provisioning tool COM Connection
Figure 5.6.4 Network ID and Join Key setup example (the Network ID found in MSC will be 2020 – hexadecimal
value)
Figure 5.6.5 Burst Message example
Figure 5.6.6 WirelessHART Provisioning Tool Join Status
Figure 5.6.7 MCS Monitoring Host for WirelessHART, Burst Message and Variables example
Figure 5.6.8 MCS WirelessHART, Readings for Burst Message 0
Figure 5.6.9 Monitoring Host Help Information Figure 5.6.10 Modbus Help Information
Figure 6.1.1 Monitoring Control System login window
Figure 6.1.2 Device list (ISA 100)
Figure 6.2.1 Dashboard series of panes (ISA 100)
Figure 6.2.2 Add device to dashboard-dialog window (ISA 100)
Figure 6.2.3 Network Topology graphical representation (ISA 100)
Figure 6.2.4 Contracts graphical representation (ISA 100)
Figure 6.2.5 Devices list and search form for the network (ISA 100)
Figure 6.2.6 Information window (ISA 100)
Figure 6.2.7 Settings window (ISA 100)
Figure 6.2.8 Registration Log-Timestamps window (ISA 100)
Figure 6.2.9 Neighbors Health report window (ISA 100)
Figure 6.2.10 Schedule Report window-Superframes and Links (ISA 100)
Figure 6.2.11 Link's related information window (ISA 100)
Figure 6.2.12 Channel Statistics window (ISA 100)
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 8 | 201
Page 9
Figure 6.2.13 Run Commands window (ISA 100)
Figure 6.2.14 Read Value command window (ISA 100)
Figure 6.2.15 Reset Device window (ISA 100)
Figure 6.2.16 Read Object Attribute window (ISA 100)
Figure 6.2.17 Write Object Attribute window (ISA 100)
Figure 6.2.18 Execute Object Method window (ISA 100)
Figure 6.2.19 Network Health sections (ISA 100)
Figure 6.2.20 Readings window (ISA 100)
Figure 6.2.21 Command Log window (ISA 100)
Figure 6.2.22 Tracking Response window (ISA 100)
Figure 6.2.23 Alerts window (ISA 100)
Figure 6.2.24 Troubleshooting window (ISA 100)
Figure 6.2.25 Edit filters button window (ISA 100)
Figure 6.2.26 Bulk Transfer Status window (ISA 100)
Figure 6.2.27 Transferred data window (ISA 100)
Figure 6.2.28 Country Code settings window
Figure 6.3.1 Basic Config
Figure 6.3.2 Backbone Router configuration sections (ISA 100)
Figure 6.3.3 Gateway configuration window (ISA 100)
Figure 6.3.4 System Manager configuration window (ISA 100)
Figure 6.3.5 Device Management window (ISA 100)
Figure 6.3.6 Monitoring Host window (ISA 100)
Figure 6.3.7 Modbus Server window (ISA 100)
Figure 6.3.8 Alert Subscription window (ISA 100)
Figure 6.3.9 Section/variables window (ISA 100)
Figure 6.3.10 Restart/Stop/Reload window (ISA 100)
Figure 6.3.11 VR950 Settings window (ISA 100)
Figure 6.3.12 Bulk Transfer List window (ISA 100)
Figure 6.3.13 Adding a Bulk Transfer window-UDO option (ISA 100)
Figure 6.3.14 Adding a Bulk Transfer window-BTO option (ISA 100)
Figure 6.3.15 Editing a Bulk Transfer window-UDO option (ISA 100)
Figure 6.3.16 Editing a Bulk Transfer window-BTO option (ISA 100)
Figure 6.3.17 Statistic sections window (ISA 100)
Figure 6.4.1 Device Firmware window (ISA 100)
Figure 6.4.2 Firmware Update window (ISA 100)
Figure 6.4.3 Firmware files window (ISA 100)
Figure 6.4.4 Add Firmware window (ISA 100)
Figure 6.4.5 Edit Firmware window
Figure 6.4.6 System Upgrade window
Figure 6.4.7 System upgrade results window
Figure 6.4.8 Custom icon window (ISA 100)
Figure 6.4.9 Added icon-visibility (ISA 100)
Figure 6.4.10 Interface Configuration window (ISA 100)
Figure 6.5.1 Change password window
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 9 | 201
Page 10
Figure 7.1.1 Monitoring Control System login window
Figure 7.1.2 Device list (HART)
Figure 7.2.1 Dashboard series of panes (HART)
Figure 7.2.2 Add device to dashboard-dialog window (HART)
Figure 7.2.3 Network Topology graphical representation (HART)
Figure 7.2.4 Services graphical representation (HART)
Figure 7.2.5 Devices list and search form for the network (HART)
Figure 7.2.6 Information window (HART)
Figure 7.2.7 Settings window (HART)
Figure 7.2.8 Registration Log-Timestamps window (HART)
Figure 7.2.9 Neighbors Health window (HART)
Figure 7.2.10 Schedule Report window (HART)
Figure 7.2.11 Schedule Report window - individual link (HART)
Figure 7.2.12 Run Commands window (HART)
Figure 7.2.13 WH General Command window (HART)
Figure 7.2.14 Commands Log window (HART)
Figure 7.2.15 Network Health sections (HART)
Figure 7.2.16 Readings window (HART)
Figure 7.2.17 Command Log window (HART)
Figure 7.2.18 Alerts window (HART)
Figure 7.3.1 Access Point configuration sections (HART)
Figure 7.3.2 Gateway configuration window (HART)
Figure 7.3.3 Network Manager configuration window (HART)
Figure 7.3.4 Device Management window (HART)
Figure 7.3.5 Configuration settings window (HART)
Figure 7.3.6 Monitoring Host window (HART)
Figure 7.3.7 Modbus Server window (HART)
Figure 7.3.8 Sections/variables window (HART)
Figure 7.3.9 Restart window (HART)
Figure 7.3.10 VR950 Settings window (HART)
Figure 7.4.1 Statistic sections window (HART)
Figure 7.5.1 System upgrade-firmware window (HART)
Figure 7.5.2 System upgrade results window
Figure 7.5.3 Custom icon window (HART)
Figure 7.5.4 Added icon-visibility (HART)
Figure 7.5.5 Custom Settings window (HART)
Figure 7.5.6 Device Codes window (HART)
Figure 7.5.7 Add Device Code window (HART)
Figure 7.5.8 Edit Device Code window (HART)
Figure 7.6.1 Change password window (HART)
Figure 8.1.1 Login window
Figure 8.1.2 User interface window
Figure 8.2.1 Edge Router Firmware Upgrade window
Figure 8.2.2 Activated Edge Router Firmware window
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 10 | 201
Page 11
Figure 8.2.3 ISA Transceiver Firmware Upgrade window
Figure 8.2.4 Completed operation window for ISA Transceiver Firmware Upgrade
Figure 8.2.5 WHart Transceiver Firmware Upgrade window
Figure 8.2.6 Completed operation window for WHart Transceiver Firmware Upgrade
Figure 8.2.7 Application Website Upgrade window
Figure 8.2.8 Completed operation window for Application Website Upgrade
Figure 8.3.1 Log Files window
Figure 8.3.2 Advanced Settings window
Figure 8.3.3 Variable type window
Figure 8.3.4 Network Configuration section window
Figure 10.1.1 Versa Router Configurator window
Figure 10.1.2 Responses window for Search Network for Versa Routers button
Figure 10.1.3 Properties options window for Set VersaRouter Properties button
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 11 | 201
Page 12
Term
Definition
Backbone
Any data network (e.g. industrial Ethernet, IEEE 802.11, etc.) within a facility interfacing
to the plants network.
Backbone Router
An entity in the ISA100.11a network with routing capability which serves as an interface
between the radio network and the backbone network.
Blacklisted channel
A channel on which transmission is prohibited.
Broadcast
Transmission intended for all the devices in an ISA100.11a network (used for
advertisements with all devices including the BBR, or for receive links for field devices
only).
Bulk Transfer Object
A custom object defined by CDS for enhanced bulk transfers.
CCA backoffs
The count of transmissions on a radio frequencies channel that were aborted due to
1 Document Purpose
The purpose of this document is to offers specific information about Versa Router 950, including
instructions for configuring the device’s various options and for monitoring the status of an ISA100.11a
and/or WirelessHART network.
The document has eight chapters which contains seven main sections, as follows:
• a product overview containing information about the product and its hardware properties
(Section 4);
• a guide for a quick network configuration, from the installation of the VR950 to reading data
from devices in the field (Section 5);
• instructions for using the CDS ISA100.11a Monitoring Control System - access, authentication,
navigation, network related information, configuration settings and administration (Section 6);
• instructions for using the WirelessHART Monitoring Control System - access, authentication,
navigation, network related information, configuration settings and administration (Section 7);
• information about the system upgrade and the configuration of the web-based Versa Router 950
application (Section 8);
• commands regarding the configuration on the VR interface for accessing the Ethernet (Section
9);
• specifications for changing the IP of the VR950 configurator (Section 10).
The terms and abbreviations, and the references and resources used for the purpose of this User Manual
are the subject of the Section 2 and Section 3.
2 Terms and Abbreviations
Certain terms and abbreviations that appear in this User Manual are described in the Table 2.1 and
Table 2.2, as follows:
Table 2.1 Terms-User Manual
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 12 | 201
Page 13
CCA.
Channels
Divisions of radio frequencies supported in a wireless network.
Contract
An agreement between the system manager and a device in the network involving the
allocation of network resources by the system manager to support a communication
need of that device.
Comma Separated
Values
A method to store data that is separated by “comma”, so that it can be easily read and
processed by Win32 and Unix programs.
Device role
Device capabilities that will be accepted by the Security Manager.
DHCP
Dynamic Host Configuration Protocol – a method to automatically configure the IP
settings of a host connected in a LAN.
EUI64, EUI-64
The 64-bit address of a device in the network; it is a unique identifier usually set at the
manufacturing of the device.
Field
The geographic space that contains all the nodes of a wireless network.
Field device
A physical device designed to meet the rigors of plant operation that communicates via
DPDU’s conforming to the ISA100.11a protocol.
Gateway
An entity in the ISA100.11a network that serves as an interface between the ISA100.11a
network and a client.
Graph
(communication)
A collection of unidirectional interconnected devices, which defines a set of
communication paths between a source device and a destination device.
Graph (Topology)
A graphical representation of the network topology.
Input/output
A device with minimum characteristics required to participate in an ISA100.11a network
and which provides or uses data from other devices.
ISA100.11a
A low data rate and low power wireless communication protocol used for industrial
sensing and control applications. The protocol was standardized by the International
Society for Automation (ISA) and certified for compliance to the standard by the
Wireless Compliance Institute (WCI).
Link
A momentary or persistent interconnecting path between two or more devices for the
purpose of transmitting and receiving messaging.
Network Address
The 128-bit address of a device in the network.
Packet Error Rate
The ratio, in percent, of the number of lost packets (DPDU’s) to the total number of
packets sent by the selected device to its parent.
Process value
The quantity being controlled or the measurement value.
Provision
To update settings on an entity in order to prepare it for working in the network.
Revision
The device software revision related to vendor/model.
Router
A device that has data routing capability.
Security Manager
An entity in the ISA100.11a network which assigns the security keys that are required
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 13 | 201
Page 14
for communication between devices.
Superframe
A collection of timeslots with a common repetition period and possibly other common
attributes.
System Manager
An entity in the ISA100.11a network that supervises the various operational aspects of
a network other than security.
UTC
Coordinated Universal Time – A universal timekeeping standard that is based on the
Greenwich Mean Time (GMT). Local time is calculated in UTC and offset by the local
time zone’s value.
Abbreviation
Explanation
AP
Access Point
API
Application Programming Interface
BBR
Backbone Router
BTO
Bulk Transfer Object
CCA
Clear Channel Assessment
CGI
Common Gateway Interface
CSV
Comma Separated Values
DHCP
Dynamic Host Configuration Protocol
DMAP
Device Management Application Process
DPDU
Data link layer Protocol Data Unit
GPDU
Gateway Protocol Data Unit
EUI
Extended Unique Identifier
FW
Firmware
GSAP
Gateway Service Access Point
GW
Gateway
IO
Input/output (with reference to devices)
LAN
Local Area Network
LSB
Least Significant Bit
MCS
Monitoring Control System
MSB
Most Significant Bit
NM
Network Manager
NSDU
Network layer Service Data Unit
Table 2.2 Abbreviations-User Manual
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 14 | 201
Page 15
PER
Packet Error Rate
RSQI
Received Signal Quality Indicator
SAP
Service Access Point
SM
System Manager
SMAP
System Manager Application Process
TSAP
Transport layer Access Point
UAP
User Application Process
VR
Versa Router
UDO
Upload/Download Object
UDP
User Datagram Protocol
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 15 | 201
Page 16
1
3 References and Resources
The previous reference and resource related to the present User Manual is as follows:
• 96-00006-01 ISA100.11a GSAP Interface Specification.pdf.
4 Hardware description
4.1 Introduction
Designed for the global market, the VR950 is a wireless network controller, or Gateway, designed for
mission critical, industrial applications in the oil & gas, mining1 and manufacturing sectors where safety,
security and reliability are a must. The VR950 is an all-in-one, dual-standard infrastructure device
architected to manage ISA100 and WirelessHART networks simultaneously. It contains all the necessary
components for network management and comes with advanced features such as redundancy and
network collocation.
The VR950 Gateway runs a Linux operating system and can be configured via a web application (MCS, or
Monitoring and Control System) or a command line interface. For connectivity to the backend systems
there is 1 GB Ethernet port available. Optionally, a 3G/4G modem or satellite modem (Orbcomm or
Iridium) can be installed. The interface for accessing the data from the network devices can be Modbus
TCP, GCI (for ISA100), Hart IP (for Wireless Hart) or OPC-UA (under development).
Custom applications for local data pre-processing can run in a sandbox accessible via an API that
provides access to the connectivity and data storage functions.
The VR950 is shown in the following picture (Figure 4.1.1):
Figure 4.1.1 VR950
Not to be used in mines susceptible to firedamp, as defined in IEC 60079-0:2011 clause 4.1
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 16 | 201
Page 17
Feature
Implementation
Power supply
• 24V DC nominal
• Voltage range from 20 to 27V DC
• Maximum current draw 1A
CPU
• TI SITARA AM5728
• RAM DDR3 2GB
• Flash 4GB
WSN Radio Modules
• 2xVN210 (one for ISA100 and one for WirelessHART)
• 10 dBm nominal
• 2.4 GHz ISM band
• 16 channels
• 802.15.4 physical layer
WSN antenna connectors
• 2x SMA type RF connectors
Network management
• ISA100 System Manager, Security Manager, Gateway
4.2 Block Diagram
The following block diagram presents the most important subsystems of VR950 (Figure 4.2.1):
4.3 Features Overview
Table 4.1 General features
Figure 4.2.1 VR950 Block Diagram
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 17 | 201
Page 18
software
• WirelessHART Network Manager, Security Manager, Gateway
Connectivity software
• Modbus TCP
• GCI
• HART IP
Redundancy
• Master/Slave configuration
• Hot redundancy with no device re-join
Operating conditions
• Temperature range -40…+70 ⁰C
• Humidity 95% RH non condensing
Physical characteristics
• Size: 159 mm x 130 mm x 40 mm (L x W x H)
• Weight: 400g
• Enclosure material: Powder coated steel.
• Ingress protection: IP20
4.4 Mechanical dimensions
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 18 | 201
Page 19
Name
Description
PWR
Main power connector
LED
Main power LED indicator
ETH1
GB Ethernet connector for backend communication
ETH2
Ethernet connector used for redundancy configuration
Equipment
Compliance Information
VN210
FCC: Part 15C
FCC ID: CDSVN210ISA
RED: EN 301 489-1 v2.1.1
EN 301 489-17 v3.1.1
EN 300 328 v2.1.1
Giteki: ID: 003-130207
4.5 Connector information
Figure 4.4.1 VR950 dimensions
Table 4.2 Hardware Interface description
4.6 Compliance information
4.6.1 Electromagnetic
Table 4.3 Electromagnetic Compliance
Figure 4.5.1 VR950 connection ports
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 19 | 201
Page 20
VR9502
FCC: Part 15, to cover ISED IC-ES003 (products containing FCC/IC Certified Radio Module)
RE: Emissions per EN 55032 (concurrent with FCC)
Immunity per EN 301 489: ESD per EN 61000-4-2
Radiated RF per EN 61000-4-3 and EN 61000-4-4
Conducted RF per EN 61000-4
Equipment
Compliance Information
VR950
2
RE: EN 62368
Equipment
Compliance Information
VR950
2
Certified per ATEX directive according the following standards:
• EN 60079.0:2011 Explosive atmospheres – Part 0: Equipment – General requirements
• EN 60079.7:2015 Explosive atmospheres – Part 7: Equipment protection by increased
safety ''e''
• EN 60079.31:2013 Explosive atmospheres – Part 31: Equipment dust ignition
protection by enclosure "t"
EN 60664-1:2007 Insulation coordination for equipment within low-voltage systems –Part 1:
Principles, requirements and tests
2
4.6.2 Safety
Table 4.4 Safety Compliance
4.6.3 Hazardous area
Table 4.5 Hazardous area
Pending: Certification procedures are ongoing
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 20 | 201
Page 21
5 Quick Start Network Configuration
The aim of this section is to guide the user through a simple and rapid process of configuring the VR950
Gateway, for either ISA100.11a or WirelessHART, and to provision a device to send data and to read it
using the Gateway web interface (Monitoring Control System) as well as Modbus TCP/IP external client.
5.1 VR950 Configuration
5.1.1 Powering the VR950 Gateway
The VR950 Gateway module is powered using a 24V, 1A Terminal Block power supply connector.
The ETH1 connector is used for network connection. The static default IP address is 192.168.0.101. The
VR950 boards can obtain also a dynamic IP address is a DHCP server is active in the network.
The redundancy setup comprises two VR950 modules interconnected via a straight Ethernet cable using
the ETH2 connector.
5.1.2 IP configuration
A new static IP address will be set using the admin web interface accessible at the following address:
192.168.0.101/admin/login.html. The default credentials are:
- Username: admin
- Password: adminadmin
The static IP configuration is available in the website Configuration section under the Network tab as
seen below:
Figure 5.1.1 Default admin website static IP configuration
After changing the IP, press the Hard Restart button underneath to reboot the VR950 and activate the
new settings.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 21 | 201
Page 22
Figure 5.1.2 IP configuration example using the admin web interface
(Optional) The VersaRouter Configurator Tool installed on a PC in the same network with the VR950
Gateway modules will scan the network and list the AN_ID, static IP address and the DHCP (dynamic)
assigned IP address of each VR950 in the network.
Figure 5.1.3 VR Configurator Tool
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 22 | 201
Page 23
5.2 Configuring a CDS VS210 for ISA100.11a
Figure 5.2.1 VS210 scheme
In order to setup a VS210 to join an ISA100.11a network, the following steps must be taken (see Figure
5.2.1):
1. Connect JP203 jumper;
2. Connect JP501 jumper;
3. Switch S202.1 will be set to OFF and S202.2 will be set to ON;
4. If the device was previously configured for either WirelessHART or ISA100.11a, a reset from the
Reset application button.
The software used for provisioning the CDS VS210 ISA100.11a device is the Nivis Field Tool.
1. Go to Windows Start and open “Device Manager”. Roll down the options under “Ports (COM &
LPT)”.
2. Plug into an USB port the CDS ISA100.11a Field Tool. The Field tool should now appear under
“Ports” in the Device Manager as “Silicon Labs CP210x USB to UART Bridge”.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 23 | 201
Page 24
Figure 5.2.2 CDS Field Tool Com Connection
3. Open the Nivis Field Tool software and provide the password. Under “Serial Port” choose the
port to which the Field Tool is connected and set the Field Tool Radio Output Power on High.
4. Press the Connect To Field Tool button and wait until the tool is connected.
Figure 5.2.3 ISA Field Tool connection to Nivis Field Tool software
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 24 | 201
Page 25
5.2.1 Provisioning
1. If the device that is being provisioned is already joined to a running network, it must be reset
to its factory default settings, by pressing the Reset To Default button for 10 seconds (see Figure
5.2.5). After the LEDs have stopped blinking, continue to step 2.
2. If data about the device already exists, go to step 3. Under Device Provisioning, Manage
Provisioning Data tab, add data about the device by clicking on the Add button. In the window
provide the following:
a. EUI-64 Address (found on a label on the device or on a tag attached to the device, e.g.
0022:FF00:0002:BA84)
b. Device Tag (a representative name for the device, e.g. VS210_BA84)
c. Network ID (can be found in the VR950’s MCS website, under Gateway, Subnet ID)
d. Join Key (can be found in the VR950’s MCS website, under Gateway, App Join Key)
e. Check Enable Simple APISupport:
• Data Publication Period (interval between 2 publishes)
• Attribute ID:
- UAP_DATA_ANALOG_2 (provides temperature readings)
- UAP_DATA_ANALOG_3 (provides humidity readings)
f. Press Save.
g. Move to step 3.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 25 | 201
Page 26
Figure 5.2.4 Nivis Field Tool Device Provisioning Settings
3. If data about the device already exists, go to Device Provisioning, Manage Provisioning Data tab,
double click on the device information and check the device’s Network ID. In order for the device
to connect to the network, the ID must be the same as the one found in the VR950’s MCS
website, under Gateway, Subnet ID.
4. Under Device Provisioning, Device Provisioning tab, choose Over the Air (OTA) or Out Of Band
(OOB) and maintain the Field Tool device aimed at the devices Infrared screen (IC301 – see
Figure 5.2.1). Press Start.
5. Tick the line corresponding to the device being provisioned and press Next and Next again. While
the status of the process is Waiting for connection, press the Reset Radio button on the VS210
device.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 26 | 201
Page 27
Figure 5.2.5 VS210 Radio and Default Reset Buttons
6. The status will become In Progress and then Provisioned. Press Next.
7. Press Finish when shown the summary of the process.
8. The device will now start establishing the connection to the VR950’s network. This process can
take up to 5 minutes, depending on the number of devices in the network.
5.2.2 Publishing
1. Open the VR950’s MCS website. The newly provisioned device should appear in the Device Table
as joined.
2. Under Monitoring Host, check the Autodiscover publishers, set Auto Activate to On and press the
Rediscover All Publishers button.
Figure 5.2.6 ISA Publishers Autodiscovery
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 27 | 201
Page 28
Once the device is found, its configuration information will be populated in the Publishers and
Channels fields (the Channels information is specific to each Publishers, so they will appear only
when selecting a Publisher). From this moment forward, the device will start publishing data,
which can be found under Readings.
Figure 5.2.7 Devices Publishers and Channels in Monitoring Host
3. To make the published data accessible through Modbus as well, under Modbus, complete the
Input Registers fields. For a quicker configuration, in a new tab with the VR’s MCS, open the
Monitoring Host page. Use the information under Help in both pages for guidance. Back in the
Modbus fields, each line inserted will be completed as follows:
a. For each device, there will be as least as many lines in the Input Registers as there are
channels in Monitoring Host;
b. Each line will contain 9 values, separated by commas without spaces in between:
- start_address: represents the register address where the data will start to appear;
- word_count: represents the number of registers held for that particular line (in this case 3:
first will represent the status of the data, the next two are hexadecimal values, composing
the actual data from the sensor);
- EUI64: the device EUI, without the colons character (:);
- The values for TSAPID, ObjId, AttrId, Idx1 and Idx2 are found in the Monitoring Host
channel lines of the device;
- MethId: will be 0;
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 28 | 201
Page 29
- Status_byte: will be 2.
Figure 5.2.8 Monitoring Host Help Information Figure 5.2.9 Modbus Help Information
c. After each completed line, press Save;
d. Press Activate after all the lines have been inserted
4. The Modbus values can be read using a Modbus client (recommended ModbusMaster from
Farrellton Solar).
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 29 | 201
Page 30
5.3 Configuring a CDS VS210 for WirelessHart
Figure 5.3.1 VS210 scheme
In order to setup a VS210 to join a WirelessHART network, the following changes steps must be taken
(see Figure 5.3.1):
1. Remove jumper from JP203;
2. Remove jumper from JP501;
3. Switch S202.1 will be set to ON and S202.2 will be set to OFF;
4. Power must be supplied through the USB or J101;
5. If the device was previously configured for either ISA100.11a or WirelessHART, a reset from the
Reset application button.
The software used for provisioning the Emerson WirelessHART device is the WirelessHART Provisioning
Tool. Since the tool used for provisioning is a USB MicroLink Hart Protocol Modem provisioning, a
software for it will also be required.
1. Go to Windows Start and open “Device Manager”. Roll down the options under “Ports (COM &
LPT)”.
2. Plug the MicroLink Modem into an USB port. The Modem’s name should now appear under
“Ports” in the Device Manager.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 30 | 201
Page 31
Figure 5.3.2 MicroLink Hart Protocol Modern Com Connection
3. Connect the MicroLink hooks to the JP501 connectors on the device (see Figure 5.3.1).
Figure 5.3.3 WirelessHART Provisioning tool COM Connection
4. Open the WirelessHART Provisioning Tool software. Go to Settings and under “Com Port” choose
the port to which the MicroLink Modem is connected and press Apply. Under Device
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 31 | 201
Page 32
Information, press Detect Device. Press Start to detect the device and retrieve its current settings
information. Once the fields are populated, the device is ready to be provisioned.
5.3.1 Provisioning
1. Provide the following:
a. Network ID (can be found in the VR950’s MCS website, under WirelessHART, Access Point,
Network ID – here the value is Hexadecimal and must be transformed into a Decimal value
for use in the WirelessHART Provisioning Tool). Press Set.
b. Join Key (can be found in the VR950’s MCS website, under WirelessHART, Access Point, App
Join Key) Press Set.
Figure 5.3.4 Network ID and Join Key setup example (the Network ID found in MSC will be 2020 – hexadecimal value)
2. Press Modify and select and provide the suitable values to produce the desired Burst Message:
a. Command:
- 1 – Read Primary Variable
- 2 – Read Loop Current and Percent of Range
- 3 – Read Dynamic Variables and Loop Current
- 9 – Read Device Variables with Status
- 33 – Read Device Variables
- 48 – Read Additional Device Status
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 32 | 201
Page 33
b. Variables: the application will internally select the variables according to the chosen
Command
c. Update Time: elapsed time between two source value updates (measured in 32.000
microsec, ex: for the update to be 10 seconds apart, the value will be 320.000)
d. Maximum Update Time: maximum elapsed time between two value updates (must be
greater that Update Time)
e. Trigger Mode:
- Continuous – the Burst Message is published continuously at the Update Time
- Window – the Burst Message is triggered when the source value deviates more than the
specified Trigger Value
- Rising – the Burst Message is triggered when source value Rises Above the specified
Trigger Value.
- Falling – the Burst Message is triggered when the source value Falls Below the specified
Trigger Value.
- On-Change – the burst message is triggered when any value in the message changes
(suitable for step signals).
f. Trigger Variable Classification: represents the physical quantity of the source value
(optional)
g. Units: the metric unit of the Trigger Value Classification (optional)
h. Trigger Value: value used as threshold for certain Trigger Modes (Window, Rising, Falling)
i. Press Apply after setting these values;
j. Burst Mode Control:
- Off – the Burst Message will be configured, but it will not be published
- Enable Burst on TDMA Data-Link Layer only – the Burst Message will be published.
k. Press Apply and Close when done;
3. The example in Figure 5.3.5 will produce:
Burst Message 0, with command 9, will contain values for the set variables (Primary Variable, Secondary
Variable, Tertiary Variable and Quaternary Variable) and will be published every 60 seconds.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 33 | 201
Page 34
Figure 5.3.5 Burst Message example
4. As many as 3 burst messages can be set to publish.
5.3.2 Joining
1. To join the device to the specified Network ID, go to Tools and press Start Assisted Join. Updates
on the join status will appear in the table below. When the final status is Normal Operation
Commencing, the device is fully joined to the network.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 34 | 201
Page 35
Figure 5.3.6 WirelessHART Provisioning Tool Join Status
5.3.3 Publishing:
1. Open the VR950’s MCS website. The newly provisioned device should appear in the Device Table
as joined.
2. Under Monitoring Host, the device’s configuration information will automatically be populated
in the Burst Messages and Variables fields (the Variables information is specific to each Burst
Message, so they will appear only when selecting a Message).
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 35 | 201
Page 36
Figure 5.3.7 MCS Monitoring Host for WirelessHART, Burst Message and Variables example
From this moment forward, the device will start publishing data, which can be found under
Readings.
Figure 5.3.8 MCS WirelessHART, Readings for Burst Message 0
3. To make the published data accessible through Modbus as well, under Modbus, complete the
Input Registers fields. For a quicker configuration, in a new tab with the VR’s MCS, open the
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 36 | 201
Page 37
Monitoring Host page. Use the information under Help in both pages for guidance. Back in the
Modbus fields, each line inserted will be completed as follows:
a. For each device, there will be at least as many lines in the Input Registers as there are
variables in Monitoring Host;
b. Each line will contain 6 values, separated by commas without spaces in between:
• start_address: represents the register address where the data will start to appear (if no
Registers have been defined yet, it is recommended that you start from Register 0 or 1);
• word_count: represents the number of registers held for that particular line (in this case
3: first will represent the status of the data, the next two are hexadecimal values,
composing the actual data from the sensor);
• EUI64: the device EUI;
• Register Type: “device_variable”;
• The values for Burst Message and Device Variable Code are found in the Monitoring Host
variable lines of the device;
• Device State: 2.
Figure 5.3.9 Monitoring Host Help Information Figure 5.3.10 Modbus Help Information
c. After each completed line, press Save;
d. Press Activate after all the lines have been inserted.
4. The Modbus values can be read using a Modbus client (recommended ModbusMaster from
Farrellton Solar).
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 37 | 201
Page 38
5.4 Configuring a Honeywell XYR6000 for ISA100.11a
Figure 5.4.1 Honeywell XYR6000
The software used for provisioning the Honeywell XYR6000 device is the Nivis Field Tool.
1. Go to Windows Start and open “Device Manager”. Roll down the options under “Ports (COM &
LPT)”.
2. Plug into an USB port the CDS ISA100.11a Field Tool. The Field tool should now appear under
“Ports” in the Device Manager as “Silicon Labs CP210x USB to UART Bridge”.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 38 | 201
Page 39
Figure 5.4.2 CDS Field Tool Com Connection
3. Open the Nivis Field Tool software and provide the password. Under “Serial Port” choose the
port to which the Field Tool has been connected.
4. Press the Connect To Field Tool button and wait until the tool is connected.
Figure 5.4.3 ISA Field Tool connection to Nivis Field Tool software
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 39 | 201
Page 40
5.4.1 Provisioning
9. If the device that is being provisioned is already joined to a running network, follow the steps
below:
a. Under Configure Device, Reset To Factory Defaults tab, select Out Of Band (OOB) and press
the Reset button, while pointing the Infrared tool (set on USB) towards the infrared screen
on the device. Choose Yes when asked to reset the device.
Figure 5.4.4 Nivis Field Tool Device Reset To Factory Defaults
b. If data about the device already exists, go to step c. Under Device Provisioning, Manage
Provisioning Data tab, add data about the device by clicking on the Add button. In the
window provide the following:
- EUI-64 Address (found on a label on the device or on a tag attached to the device, e.g.
0022:FF00:0002:01B1)
- Device Tag (a representative name for the device, up to 16 characters, e.g.
HW_Temp_01B1)
- Network ID (can be found in the VR950’s MCS website, under Gateway, Subnet ID)
- Join Key (can be found in the VR950’s MCS website, under Gateway, App Join Key)
- Press Save.
- Move to step d.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 40 | 201
Page 41
Figure 5.4.5 Nivis Field Tool Device Provisioning Settings
c. If data about the device already exists, go to Device Provisioning, Manage Provisioning Data
tab, double click on the device information and check the device’s Network ID. In order for
the device to connect to the network, the ID must be the same as the one found in the
VR950’s MCS website, under Gateway, Subnet ID.
d. Under Device Provisioning, Device Provisioning tab, choose Out of Band (OOB) and press
Start while keeping the Infrared tool pointed towards the infrared screen on the device.
e. Once the device has been found, press Yes to continue to provisioning. Press Next when told
that Provisioning information is available and Next when asked to review the Provisioning
information.
f. Keep the infrared tool pointed towards the device while in the process of provisioning, until
the status changes from In Progress to Provisioned. Press Next.
g. Press Finish when shown the summary of the process.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 41 | 201
Page 42
h. The device will now start establishing the connection to the VR950’s network. This process
can take up to 5 minutes, depending on the number of devices in the network.
10. If the device is being provisioned for the first time, follow the steps under point 1, without point
a.
5.4.2 Publishing
1. Open the VR950’s MCS website. The newly provisioned device should appear in the Device Table
as joined.
2. To make the device publish, under Devices, click on the EUI of the device and go to Run
Commands. Depending on the type of Honeywell device, insert the following commands and
values. Press Execute after each command.
a. Read Object Attribute:
• TSAP ID (port): 2
• Object ID: 1
• Attribute ID: 9
b. Write Object Attribute:
• TSAP ID (port): 2
• Object ID: 8
• Attribute ID: 2
• Values (HEX): FE8000000000000000004E7C7F000001F0B2000503003C3201
c. Write Object Attribute:
• TSAP ID (port): 2
• Object ID: 8
• Attribute ID: 6
• Values (HEX): 0003000100000005
d. Write Object Attribute:
• TSAP ID (port): 2
• Object ID: 3
• Attribute ID: 2
• Index1: 1
• Values (HEX): 10
3. Under Monitoring Host, check the Autodiscover publishers, set Auto Activate to On and press the
Rediscover All Publishers button.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 42 | 201
Page 43
Figure 5.4.6 ISA Publishers Autodiscovery
4. Once the device is found, its configuration information will be populated in the Publishers and
Channels fields (the Channels information is specific to each Publishers, so they will appear only
when selecting a Publisher).
Figure 5.4.7 Devices Publishers and Channels in Monitoring Host
5. From this moment forward, the device will start publishing data, which can be found under
Readings.
6. To make the published data accessible through Modbus as well, under Modbus, fill the Input
Registers fields. For a quicker configuration, in a new tab with the VR’s MCS, open the
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 43 | 201
Page 44
Monitoring Host page. Use the information under Help in both pages for guidance. Back in the
Modbus fields, each line inserted will be completed as follows:
a. For each device, there will be as least as many lines in the Input Registers as there are
channels in Monitoring Host;
b. Each line will contain 9 values, separated by commas without spaces in between:
- start_address: represents the register address where the data will start to appear;
- word_count: represents the number of registers held for that particular line (in this
case 3: first will represent the status of the data, the next two are hexadecimal
values, composing the actual data from the sensor);
- EUI64: the device EUI, without the colons character (:);
- The values for TSAPID, ObjId, AttrId, Idx1 and Idx2 are found in the Monitoring Host
channel lines of the device;
- MethId: will be 0;
- Status_byte: will be 2.
Figure 5.4.8 Monitoring Host Help Information Figure 5.4.9 Modbus Help Information
c. After each completed line, press Save;
d. Press Activate after all the lines have been inserted.
7. The Modbus values can be read using a Modbus client (recommended ModbusMaster from
Farrellton Solar).
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 44 | 201
Page 45
5.5 Configuring a Yokogawa EJX110L for ISA100.11a
Figure 5.5.1 Yokogawa EJX110L
The software used for provisioning the Yokogawa EJX110L device is the Nivis Field Tool.
1. Go to Windows Start and open “Device Manager”. Roll down the options under “Ports (COM &
LPT)”.
2. Plug into an USB port the CDS ISA100.11a Field Tool. The Field tool should now appear under
“Ports” in the Device Manager as “Silicon Labs CP210x USB to UART Bridge”.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 45 | 201
Page 46
Figure 5.5.2 CDS Field Tool Com Connection
3. Open the Nivis Field Tool software and provide the password. Under “Serial Port” choose the
port to which the Field Tool has been connected.
4. Press the Connect To Field Tool button and wait until the tool is connected.
Figure 5.5.3 ISA Field Tool connection to Nivis Field Tool software
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 46 | 201
Page 47
5.5.1 Provisioning
1. If data about the device already exists, go to step 2. Under Device Provisioning, Manage
Provisioning Data tab, add data about the device by clicking on the Add button. In the window
provide the following:
Figure 5.5.4 Nivis Field Tool Device Provisioning Settings
a. EUI-64 Address (found on a label on the device or on a tag attached to the device, e.g.
0022:FF00:0002:1F11)
b. Device Tag (a representative name for the device, up to 16 characters, e.g.
YOKO_Temp_1F11)
c. Network ID (can be found in the VR950’s MCS website, under Gateway, Subnet ID)
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 47 | 201
Page 48
d. Join Key (can be found in the VR950’s MCS website, under Gateway, App Join Key)
e. Press Save.
f. Move to step c.
2. If data about the device already exists, go to Device Provisioning, Manage Provisioning Data tab,
double click on the device information and check the device’s Network ID. In order for the device
to connect to the network, the ID must be the same as the one found in the VR950’s MCS
website, under Gateway, Subnet ID.
3. Under Device Provisioning, Device Provisioning tab, choose Out of Band (OOB) and press Start
while keeping the Infrared tool pointed towards the infrared screen on the device (Fig 5).
4. Once the device has been found, press Yes to continue to provisioning. Press Next when told that
Provisioning information is available and Next when asked to review the Provisioning
information.
Figure 5.5.5 Nivis Field Tool connected to device
5. Keep the infrared tool pointed towards the device while in the process of provisioning, until you
will be announced that the device has been provisioned. Press Next.
6. Press Finish when shown the summary of the process.
7. The device will now start establishing the connection to the VR950’s network. It will not start
publishing until the line at the top of its screen is full (in Figure 5.5.6, the device is a joining
state). This process can take up to 5 minutes, depending on the number of devices in the
network.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 48 | 201
Page 49
Figure 5.5.6 Yokogawa device in the process of joining to the Network
5.5.2 Publishing
1. Open the VR950’s MCS website. The newly provisioned device should appear in the Device Table
as joined.
2. Under Monitoring Host, check the Autodiscover publishers, set Auto Activate to On and press the
Rediscover All Publishers button.
Figure 5.5.7 ISA Publishers Autodiscovery
Once the device is found, it’s configuration information will be populated in the Publishers and
Channels fields (the Channels information is specific to each Publishers, so they will appear only
when selecting a Publisher). From this moment forward, the device will start publishing data,
which can be found under Readings.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 49 | 201
Page 50
Figure 5.5.8 Devices Publishers and Channels in Monitoring Host
3. To make the published data accessible through Modbus as well, under Modbus, complete the
Input Registers fields. For a quicker configuration, in a new tab with the VR’s MCS, open the
Monitoring Host page. Use the information under Help in both pages for guidance. Back in the
Modbus fields, each line inserted will be completed as follows:
a. For each device, there will be as least as many lines in the Input Registers as there are
channels in Monitoring Host;
b. Each line will contain 9 values, separated by commas without spaces in between:
- start_address: represents the register address where the data will start to appear;
- word_count: represents the number of registers held for that particular line (in this
case 3: first will represent the status of the data, the next two are hexadecimal
values, composing the actual data from the sensor);
- EUI64: the device EUI, without the colons character (:);
- The values for TSAPID, ObjId, AttrId, Idx1 and Idx2 are found in the Monitoring Host
channel lines of the device (as seen in Figures 7 and 8);
- MethId: will be 0;
- Status_byte: will be 2.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 50 | 201
Page 51
Figure 5.5.9 Monitoring Host Help Information Figure 5.5.10 Modbus Help Information
c. After each completed line, press Save;
d. Press Activate after all the lines have been inserted.
4. The Modbus values can be read using a Modbus client (recommended ModbusMaster from
Farrellton Solar).
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 51 | 201
Page 52
5.6 Configuring a Emerson PT100/2WIRE for WirelessHART
Figure 5.6.1 Emerson PT100/2WIRE
The software used for provisioning the Emerson WirelessHART device is the WirelessHART Provisioning
Tool. Since the tool used for provisioning is a USB MicroLink Hart Protocol Modem provisioning, a
software for it will also be required.
5. Go to Windows Start and open “Device Manager”. Roll down the options under “Ports (COM &
LPT)”.
6. Plug the MicroLink Modem into an USB port. The Modem’s name should now appear under
“Ports” in the Device Manager.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 52 | 201
Page 53
Figure 5.6.2 MicroLink Hart Protocol Modern Com Connection
7. Connect the MicroLink hooks to the COM connectors on the device.
Figure 5.6.3 WirelessHART Provisioning tool COM Connection
8. Open the WirelessHART Provisioning Tool software. Go to Settings and under “Com Port” choose
the port to which the MicroLink Modem is connected and press Apply. Under Device
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 53 | 201
Page 54
Information, press Detect Device. Press Start to detect the device and retrieve its current settings
information. Once the fields are populated, the device is ready to be provisioned.
5.6.1 Provisioning
5. Provide the following:
a. Network ID (can be found in the VR950’s MCS website, under WirelessHART, Access Point,
Network ID – here the value is Hexadecimal and must be transformed into a Decimal value
for use in the WirelessHART Provisioning Tool). Press Set.
b. Join Key (can be found in the VR950’s MCS website, under WirelessHART, Access Point, App
Join Key) Press Set.
Figure 5.6.4 Network ID and Join Key setup example (the Network ID found in MSC will be 2020 – hexadecimal value)
6. Press Modify and select and provide the suitable values to produce the desired Burst Message:
a. Command:
- 1 – Read Primary Variable
- 2 – Read Loop Current and Percent of Range
- 3 – Read Dynamic Variables and Loop Current
- 9 – Read Device Variables with Status
- 33 – Read Device Variables
- 48 – Read Additional Device Status
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 54 | 201
Page 55
b. Variables: the application will internally select the variables according to the chosen
Command
c. Update Time: elapsed time between two source value updates (measured in 32.000
microsec, ex: for the update to be 10 seconds apart, the value will be 320.000)
d. Maximum Update Time: maximum elapsed time between two value updates (must be
greater that Update Time)
e. Trigger Mode:
- Continuous – the Burst Message is published continuously at the Update Time
- Window – the Burst Message is triggered when the source value deviates more than the
specified Trigger Value
- Rising – the Burst Message is triggered when source value Rises Above the specified
Trigger Value.
- Falling – the Burst Message is triggered when the source value Falls Below the specified
Trigger Value.
- On-Change – the burst message is triggered when any value in the message changes
(suitable for step signals).
f. Trigger Variable Classification: represents the physical quantity of the source value
(optional)
g. Units: the metric unit of the Trigger Value Classification (optional)
h. Trigger Value: value used as threshold for certain Trigger Modes (Window, Rising, Falling)
i. Press Apply after setting these values;
j. Burst Mode Control:
- Off – the Burst Message will be configured, but it will not be published
- Enable Burst on TDMA Data-Link Layer only – the Burst Message will be published.
k. Press Apply and Close when done;
7. The example in Figure 5.6.5 will produce:
Burst Message 0, with command 9, will contain values for the set variables (Primary Variable, Battery life,
Percent Range, Secondary Variable and Tertiary Variable) and will be published every 4 seconds.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 55 | 201
Page 56
Figure 5.6.5 Burst Message example
8. As many as 3 burst messages can be set to publish.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 56 | 201
Page 57
5.6.2 Joining
2. To join the device to the specified Network ID, go to Tools and press Start Assisted Join. Updates
on the join status will appear in the table below. When the final status is Normal Operation
Commencing, the device is fully joined to the network.
Figure 5.6.6 WirelessHART Provisioning Tool Join Status
5.6.3 Publishing:
5. Open the VR950’s MCS website. The newly provisioned device should appear in the Device Table
as joined.
6. Under Monitoring Host, the device’s configuration information will automatically be populated
in the Burst Messages and Variables fields (the Variables information is specific to each Burst
Message, so they will appear only when selecting a Message).
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 57 | 201
Page 58
Figure 5.6.7 MCS Monitoring Host for WirelessHART, Burst Message and Variables example
From this moment forward, the device will start publishing data, which can be found under
Readings.
Figure 5.6.8 MCS WirelessHART, Readings for Burst Message 0
7. To make the published data accessible through Modbus as well, under Modbus, complete the
Input Registers fields. For a quicker configuration, in a new tab with the VR’s MCS, open the
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 58 | 201
Page 59
Monitoring Host page. Use the information under Help in both pages for guidance. Back in the
Modbus fields, each line inserted will be completed as follows:
e. For each device, there will be at least as many lines in the Input Registers as there are
variables in Monitoring Host;
f. Each line will contain 6 values, separated by commas without spaces in between:
• start_address: represents the register address where the data will start to appear (if no
Registers have been defined yet, it is recommended that you start from Register 0 or 1);
• word_count: represents the number of registers held for that particular line (in this case
3: first will represent the status of the data, the next two are hexadecimal values,
composing the actual data from the sensor);
• EUI64: the device EUI;
• Register Type: “device_variable”;
• The values for Burst Message and Device Variable Code are found in the Monitoring Host
variable lines of the device;
• Device State: 2.
Figure 5.6.9 Monitoring Host Help Information Figure 5.6.10 Modbus Help Information
g. After each completed line, press Save;
h. Press Activate after all the lines have been inserted.
8. The Modbus values can be read using a Modbus client (recommended ModbusMaster from
Farrellton Solar).
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 59 | 201
Page 60
6 Using the Monitoring Contro1 System (MCS) for ISA 100 wireless network
6.1 Access, Authentication and Navigation
To access the MCS, type http://<VR_IP>/app_isa/login.html in a web browser and replace <VR_IP> with
the IP of the VR that supports the network. If the Gateway runs in standalone ISA100/WirelessHART
mode, the corresponding URL is http://<VR_IP>/app/login.html.
Once the address is accessed, a login screen appears, as shown in the following screen capture
(Figure 6.1.1):
Figure 6.1.1 Monitoring Control System login window
You must log into the MCS with a valid username/password. The default credentials stored on the VR950
are:
• Username: admin
• Password: adminadmin
Once the credentials are entered and the access is granted, the browser will display the Device list by
default as shown in the following screen capture (Figure 6.1.2). For a detailed description of the Device
list, please see the Section 6.2.3.
The Monitoring Control System page with the Device list is shown in the following screen capture
(Figure 6.1.2):
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 60 | 201
Page 61
Figure 6.1.2 Device list (ISA 100)
On a general level, the user interface consists of two sections:
• the menus on the left, which allow you to navigate through the pages of the website;
• the main section, which displays the contents of the selected page.
6.2 Network
6.2.1 Dashboard
The Dashboard page is a report zone that allows you to monitor reading variations for selected devices.
The Dashboard consists in a series of panes added by the user, which provide a visual representation of
the information published by the selected devices in the selected channels.
The information is refreshed automatically at regular intervals (10 seconds, 30 seconds, or 1 minute).
The Dashboard series of panes are shown in the following screen capture (Figure 6.2.1):
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 61 | 201
Page 62
Figure 6.2.1 Dashboard series of panes (ISA 100)
6.2.1.1 Adding a Device to the Dashboard
To add a device to the Dashboard, you must perform the following actions:
1. click on the Add Device button; the Add device to dashboard dialog box will open, as shown in
the following screen capture (Figure 6.2.2):
Figure 6.2.2 Add device to dashboard-dialog window (ISA 100)
2. choose a device from the drop-down list;
3. choose the channel that you wish to monitor, from the drop-down list;
4. type the desired gauge value range for the readings; if the selected values are out of range, a
message on the pane will notify you;
5. optionally, select the slot number (up to the current slot number); if you do not select a slot
number, the system automatically assigns the next available slot;
6. select the desired gauge type, then click OK to add the device to the dashboard.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 62 | 201
Page 63
Notes:
• You can also add a reading to the dashboard from the Device Details page: in the Information
pane, click on the Add to dashboard (ATD) icon , next to a reading.
• Up to 9 devices are supported in the dashboard.
6.2.1.2 Deleting a device
To delete a device from the Dashboard, click in the top right corner of the pane. No confirmation is
required for the system to delete the pane.
6.2.2 Topology
The Topology page displays a graphical representation of the current network topology and also allows
users to view data about contracts and devices.
The graphical representation of the Network Topology is shown in the following screen capture
(Figure 6.2.3):
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 63 | 201
Page 64
Figure 6.2.3 Network Topology graphical representation (ISA 100)
The system performs regular automatic updates of the topology information. When you load the page,
the topology graph is generated based on the latest topology information available. The time of the last
topology information update is indicated at the top of the page. To view the latest topology, press
Refresh – this will generate a Request Topology command and will refresh the page.
In the SubnetID drop-down list located at the top of the topology window, select a subnet to view it.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 64 | 201
Page 65
The registered devices are displayed on multiple levels represented as grey bands. The levels are
numbered from 0 to n. The level number is indicated in the upper left corner of a level. The GW, the SM
and the BBR are found on level 0. The level is given by the preferred clock source. A device is on level
one, if its preferred clock source is a BBR. A device is on level 2 if its preferred clock source is on level 1
and so on.
Communication-wise field devices are linked to the BBR, which is the central device in the network,
either directly or via other devices. The BBR further relays to the GW, while the SM organize the entire
network. The field devices can have various sensors attached: temperature sensors, humidity sensors,
etc.
The devices are identified in the topology by the last four characters of their EUI-64 address. For easier
identification, the backbone router, the gateway and the system manager are identified with the
abbreviations BBR, GW, and SM. The devices are placed within a level in the order of their EUI64
address. They can be moved freely within the range of their level by drag-and-drop to obtain better
legibility of the topology.
In addition, they are represented by suggestive icons and against backgrounds of different colors, to
distinguish their roles (also shown in the Devices legend at the bottom of the page):
• Gateway – purple background;
• Backbone Router – blue;
• System Manager – dark green;
• IO/Router Devices – blue;
• IO Devices – light green;
• Routers – red.
By positioning the cursor on an icon, you can view the tooltip, which includes the following details for a
device:
• the EUI-64 address;
• the device role;
• the subnet ID;
• the device tag;
• the manufacturer;
• the model.
The available Topology page elements and viewing options are described in the following paragraphs.
Adjusting Width and Height
You can adjust the size of the topology representation using the buttons and for height and
width.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 65 | 201
Page 66
You can also adjust the height and width to the size of the Topology pane by clicking , or revert to
the original viewing settings by clicking .
Links
When the page is loaded, the Links option located above the topology graph is selected by default. The
BBR is also selected by default in the topology graph and the Preferred ClockSource links to it are
displayed as green lines.
To view the Preferred ClockSource for a particular device, click on the device in the topology graph, or
select the device in the drop-down list located on top of the Topology window. The MCS will display the
device’s link to its Preferred Clocksource.
To view the Secondary ClockSource links for a selected device, check this option in the Links Legend.
These links are displayed in blue in the topology graph.
To view the transmission links between a selected device and other, check the Links option in the Links
Legend. The regular links are displayed in black in the topology graph.
To view all the other links formed between the network devices, check the Show all links option.
This option is unchecked by default.
To view the RSQI signal value for a device links, check the Show signal quality/PER option. The signal
quality value is displayed next to each link and is colored in the color of the respective link. For more
information about the signal see Section 6.2.4.2.
To view the packet error rate for a device, you must perform the following actions:
1. check the Show signal quality/PER option;
2. in the Links Legend, select the desired ClockSource links to display (Preferred or Secondary, or
both);
3. click the Get PER for selected device button located in the Links legend; the PER is shown as a
percentage next to the respective link.
Contracts
To view the contracts for a selected device, you must perform the following actions:
1. check the Contracts option located at the top of the topology graph;
2. choose a device by clicking on it in the topology graph or by selecting it in the Devices drop-down
list located above the graph;
3. in the Contracts drop-down list you will view the selected device inbound and outbound
contracts with the SM and the GW; to show a contract on the graph, select it in the listthe contract will be represented by a green line if it is periodic or by a blue line if it is aperiodic;
the Contracts legend located at the bottom of the Topology page also indicates how the types of
contracts and links are represented.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 66 | 201
Page 67
Note: A device can have both a periodic and an aperiodic contract with the same SM or GW at the same
time.
The graphical representation of the Contracts for a selected device is shown in the following screen
capture (Figure 6.2.4):
Figure 6.2.4 Contracts graphical representation (ISA 100)
Contract details
In addition, when you select a contract, information about the contract parameters will be shown in the
Contract details section at the bottom of the page.
The contract information includes the following parameters:
• Contract ID – the contract identifier based on the contract owner;
• Service Type – can be periodic or aperiodic;
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 67 | 201
Page 68
• Source/destination device – the EUI64 address of the requester, and the destination device
respectively;
• Source/destination SAP – “0” is the default value for the DMAP on a device; “1” is the default
value of a SMAP on the SM; the other values represent custom SAPs;
• Activation Time – the date and time when the contract was established;
• Expiration Time – the date and time when the contract terminates;
• Priority – indicates the base priority for all messages sent using the contract;
• NSDU Size – the packet size at network layer;
• Reliability – the requested reliability for delivering the transmitted packets to the destination;
• Period – identifies the desired publishing period, for periodic contracts;
• Phase – identifies the desired phase (within the publishing period) of publications, for periodic
contracts;
• Deadline – the maximum end-to-end transport delay desired, in periodic communication;
• Committed Burst – for long-term aperiodic communication; it specifies the bandwidth, as
follows:
o a positive value specifies the packets transmitted per second (e.g. a committed burst of
2 indicates that two packets per second are guaranteed);
o a negative value specifies the number of seconds per packet (e.g. a committed burst of -
15 indicates that a packet transmitted every 15 seconds is guaranteed);
• Excess Burst – for short-term aperiodic communication; it has the same significance as the
Committed Burst, but is only used in exceptional situations where aggressive communication is
needed on a short-term;
• MaxSendWindow – the maximum number of client requests that may be simultaneously
awaiting a response, in the case of an aperiodic communication.
6.2.3 Devices
The Devices page features the list of devices that exist in the network, and a search form that enables
you to search devices based on their EUI-64 address, tag and/or state, as shown in the following screen
capture (Figure 6.2.5):
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 68 | 201
Page 69
Figure 6.2.5 Devices list and search form for the network (ISA 100)
6.2.3.1 Search devices
When the Device page is loaded, the registered devices are displayed by default.
You have the following options to search a device:
1. Search by EUI-64 address
To search a device by its EUI-64 address, you must type the address in the EUI-64 Address input
field and click Search.
For partial search you must perform the following actions:
a. type part of the EUI-64 address in the EUI-64 Address input field;
b. select the desired state from the Show Devices drop-down list and click Search; the system
will retrieve all the devices whose EUI-64 addresses contain the characters provided by the
user.
To delete the search parameters, click Reset.
2. Search by device tag
A tag is a custom description that you can assign to a device in order to facilitate identification of
that device in the plant. One tag can be assigned to a single device.
To search for devices based on their tag, type the tag in the Device Tag input field, and click
Search. Note that the tag field is case sensitive.
To delete the search parameters, click Reset.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 69 | 201
Page 70
3. Search by device state only
To display devices based on their state at a given time, select the desired state from the Show
Devices drop-down list. The device list will update automatically.
A device can be in only one of the following states at a given moment in time:
• Registered – the device has successfully joined the network and is ready to operate;
• Joining process – the device has been provisioned and is attempting to join the network;
• Unregistered – the device has lost connection with its neighbors in the network.
6.2.3.2 Device list
The Device list shows the network devices in a table, one item per line, with main information about
each logical device, as follows:
• EUI-64 Address (the MAC address);
• IPv6 Address;
• Tag – the device tag;
• Revision – the FW version available on the device;
• Role (Gateway, System Manager, Backbone Router, Field Router) and Model (manufacturer
information);
• Status (FULL_ JOIN for registered devices, JOINING for joining devices, NOT_JOINED for
unregistered devices);
• Last Read (the date and time of the last reading from the device) and a link to the Readings
page for the device in question.
In addition, the Device list provides a quick link as the following icon -
to the Run Commands page for
that specific device.
When you load the page, the registered devices are displayed by default. To view unregistered or joining
devices, select the corresponding option in the Show Devices drop-down list.
The total number of items in the table is indicated in the top left corner of the table. Here you can set
the number of items to be displayed per page in the table. The default number of items displayed in a
page is 50. Paging controls in the top right corner of the table also enable you to navigate through the
other pages of the table.
The last time the page of a device was refreshed is also available by clicking on EUI-64 Address of the
device, in the Device Details page. The page does not refresh automatically, therefore you must click
Refresh to update it.
6.2.3.3 Delete a device
In the Devices page you have the option of deleting an unregistered device. When you delete a device, it
will be removed from the network and any related data, including previous readings, will be deleted
from the database.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 70 | 201
Page 71
To delete the device, click the icon located next to the device. The system will require confirmation
to perform the action. Click OK to delete the device or Cancel to abort the action.
6.2.4 Device Details
In this page you can see all the information available for the selected device and perform device-specific
commands. The page is accessed by clicking on the device EUI-64 Address in the device list.
The page is organized into seven tabbed panes by types of information and features a Back button to
allow you to quickly revert to the Devices page, as well as an indication of when the last page was
updated, and a Refresh button (where applicable) that enables you to retrieve up-to-date information in
the specific page.
6.2.4.1 Information
The Information page displays general, as well as specific activity information about the device. When
the page is loaded, it shows the latest information available. To update the information, click Refresh.
The following details are shown in addition to those already indicated in the Device List:
• Manufacturer – the name of the device manufacturer;
• Model – manufacturer information of the device model;
• Revision – the radio FW version;
• Subnet ID – the ID of the subnet that includes the device;
• Power Supply Status – represented as a battery with the following colors:
o green, when the device is line powered;
o blue, when the device is battery powered, and the remaining capacity of the battery
is greater than 75%;
o yellow, when the device is battery powered, and the remaining capacity of the
battery is between 25% and 75%;
o red, when the device is battery powered, and the remaining capacity of the battery
is less than 25%;
• Energy Left – remaining energy measured in days;
• DPDUs – data transmission statistics, the number of transmitted/received packages and the
number of failed transmissions/receptions;
• Process values – the parameters measured by the device.
The Information window for the device is shown in the following screen capture (Figure 6.2.6):
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 71 | 201
Page 72
Figure 6.2.6 Information window (ISA 100)
Process values
The Process values are displayed in the bottom table of the previous screen capture (Figure 6.2.6) with
the following related information:
• Name – the process value name;
• M.U. – the unit of measurement for the process value;
• Format – various formats are possible, defining the value range of the measured parameter:
int8, uint8, int16, uint16, int32, uint32, float32;
• TSAP ID;
• Object ID;
• Attribute ID;
• Two indices.
The total number of items in the table is indicated in the top left corner of the table. Here you can set
the number of items to be displayed per page in the table. The default number of items displayed in a
page is 10. Paging controls in the top right corner of the table also enable you to navigate through the
other pages of the table.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 72 | 201
Page 73
RSQI
Signal Quality
6.2.4.2 Settings
The Settings page reflect the current operation of the CDS ISA100.11a stack on a device.
The type of information displayed in Settings window includes neighbor details, routes and graphs, as
shown in the following screen capture (Figure 6.2.7):
Figure 6.2.7 Settings window (ISA 100)
Neighbors
The Neighbors section lists the registered neighbors of the selected device, as well indicates their signal
quality, and whether they are clock sources for the selected device.
A clock source neighbor can have one of the following roles:
• Preferred clock source – the reference clock source for the selected device;
• Secondary clock source – a backup clock source that becomes preferred, when the reference
clock source is not available.
Multiple neighbors may be designated as clock sources for a selected device.
The Signal Quality column displays the received signal quality indicator (RSQI) values and their associated
labels, as shown in the following table (Table 6.1):
Table 6.1 Signal Quality for Received Signal Quality Indicator (ISA 100)
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 73 | 201
Page 74
1-63
Poor signal
64-127
Fair signal
128-191
Good signal
192-255
Excellent signal
Graphs
The Graphs section lists all the graphs that include the selected device, with the specific Graph ID and
Neighbor Addresses 64 within each graph.
Graph 1 is the inbound graph, while the other graphs are outbound graphs.
Routes
The Routes section lists the routes of which the source is the selected device.
Routes can be classified into:
• Routes based on graphs, established between two field devices or a field device and the BBR;
• Hybrid routes – established between the BBR and a joined device (the destination of the route)
for which an outbound graph has not been created yet; hybrid routes consist of the node’s
parent’s outbound graph and the destination node.
Routes are listed in a table displaying the following information:
• Route ID – route identification data; IDs are given in the order of creation of the routes; route 1
is the default route established between field devices and the BBR;
• Alternative – a number ranging from 0 to 3 that enables you to differentiate between routes
based on their source and destination:
o if the alternative is 0, the route is based on a contract requested by the SM or the GW
(this feature will be available in future releases);
o if the alternative is 1, the route is established between two field devices;
o if the alternative is 2, the BBR is the source of the route and a field device is the
destination;
o if the alternative is 3, this is the device’s default route (Route 1) to the BBR.
• Selector – identifies the destination of the route; the selector varies based on the value of the
alternative, as follows:
o if the alternative is 0, the selector indicates the contract ID and the address of the source
(SM or GW);
o if the alternative is 1, the selector field indicates the contract ID;
o if the alternative is 2, the selector field indicates the address of the destination device;
o if the alternative is 3, the selector is null.
• Forward Limit – the maximum number of nodes that a route can include;
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 74 | 201
Page 75
• Route Element – indicates the ID of the graph that stands at the basis of the route, or the graph
ID and the destination’s address for hybrid routes.
To view the updated device settings, click the Refresh button. The Request Topology and Get Contracts
and Routes commands will be sent to the SM. To view the command status, go the Section 6.2.7.
When the command is generated, a message at the bottom of the Settings page will indicate that the
device information is refreshing.
6.2.4.3 Registration Log
The Registration Log page displays the registration history for the selected device, at different dates and
times, commonly known as timestamps, as shown in the following screen capture (Figure 6.2.8):
Figure 6.2.8 Registration Log-Timestamps window (ISA 100)
Use the Search functionality to view the behavior of the device over a specific period, as follows:
• choose the status you wish to view from the Registration Status drop-down list;
• optionally, fill in the Start Time and the End Time fields, and then click Search.
The results are displayed in a table that indicates the timestamp and the device status at that specific
timestamp. A device can have one of the following statuses at a given moment:
• SEC_JOIN_Req – the security join request was received by the SM;
• SEC_JOIN_Rsp – a security join response was sent to the device;
• NETWORK_Req – the network join request was received by the SM;
• NETWORK_Rsp – the network join response was sent to the device;
• CONTRACT_Req – the join contract request was received by the SM;
• CONTRACT_Rsp – the join contract response was sent to the device;
• SEC_CNFRM_Req – the security join confirmation was received by the SM;
• SEC_CNFRM_Rsp – the security join confirmation response was sent to the device;
• FULL_JOIN – the device is joined and configured and all information about it is available;
• NOT_JOINED – the device is not joined.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 75 | 201
Page 76
The total number of items in the table is indicated in the top left corner of the table. Here you can set
the number of items to be displayed per page in the table. The default number of items displayed in a
page is 10. Paging controls in the top right corner of the table also enable you to navigate through the
other pages of the table.
6.2.4.4 Neighbors Health
This Neighbors Health page provides a communication health report about the selected device’s
neighbors, as shown in the following screen capture (Figure 6.2.9):
Figure 6.2.9 Neighbors Health report window (ISA 100)
The report includes, as follows:
• the EUI-64 Address – neighbor identification information;
• the Timestamp of the report request;
• a general Link Status, which can be:
o Available – if the neighbor is available for communication;
o Unavailable – if the neighbor is unavailable for communication;
• the communication health information:
o the number of DPDU's Transmitted to the neighbor and the number of Failed
transmission attempts;
o the number of DPDU’s received from the neighbor and the number of failed receptions
from the neighbor;
• the neighbor Signal Strength (measured in dBm);
• the Signal Quality (for the RSQI ranges and associated labels, see the Section 6.2.4.2.
The total number of items in the table is indicated in the top left corner of the table. Here you can set
the number of items to be displayed per page in the table. The default number of items displayed in a
page is 10. Paging controls in the top right corner of the table also enable you to navigate through the
other pages of the table.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 76 | 201
Page 77
6.2.4.5 Schedule Report
The Schedule Report page provides information about time slot and channel allocation for the selected
device.
Superframe and links
The active superframes that the device uses for communication are listed in the page along with
information regarding size (the number of time slots), start time, and the number of links allocated on
each superframe, as shown in the following screen capture (Figure 6.2.10):
Figure 6.2.10 Schedule Report window-Superframes and Links (ISA 100)
Clicking on the number of Links will display a new page with link related information for each individual
link allocated on the selected superframe, as shown in the following screen capture (Figure 6.2.11):
Figure 6.2.11 Link's related information window (ISA 100)
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 77 | 201
Page 78
In the previous screen capture (Figure 6.2.11) are shown the following details:
• Neighbor – the EUI-64 address of the neighbor or the broadcast address FFFF:FFFF:FFFF:FFFF
(used only for advertisements and receive links);
• Slot Index – the ID of the slot within the superframe;
• Link Period – the periodicity of a link (measured in number of slots) within a superframe cycle;
• Slot Length – expressed as a multiple of 2
-20
seconds;
• Channel No;
• Direction – reception or transmission;
• Link Type, which can be:
o aperiodic data communication;
o aperiodic management communication;
o periodic data communication;
o periodic management communication;
You can use the Search form on the top of the page to sort links based on:
• neighbor device;
• the link type;
• the direction of the communication.
In addition, in both the Superframe and Links tables you can sort the information by the number of items
listed per page. The default number of records displayed in a page is 10. Paging controls at the bottom of
the table enable you to navigate through the pages of the table.
When the pages are loaded, the latest information available is shown. To update the information, click
Refresh.
Channels
The Channels of the device are represented at the bottom of the pane. The channels that are clear for
communication are highlighted in blue (if in use) or grey (if Idle), while Blacklisted channels are
highlighted in red. Channel 26 has been disabled by default for purposes of compliance in certain
countries.
6.2.4.6 Channel Statistics
The Channel Statistics page displays statistical information about CCA backoffs per channel, as shown in
the following screen capture (Figure 6.2.12):
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 78 | 201
Page 79
Figure 6.2.12 Channel Statistics window (ISA 100)
The information is presented in a table, with the value column expressing the percentage (0% to 100%)
of aborted transmissions for each channel.
To update the information, click Refresh.
6.2.4.7 Run Commands
The Run Commands page enables you to perform device-specific commands.
In the following screen capture (Figure 6.2.13) is displayed the Run Commands window:
Figure 6.2.13 Run Commands window (ISA 100)
To go to a specific command, select it from the Commands drop-down list. After you generate the
command, a message at the bottom of the screen will indicate its status (Command sent successfully,
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 79 | 201
Page 80
Command sent error). The tracking number of the command is also indicated, together with a link to the
Commands Log (please see the Section 6.2.7., where you can view the results of the command.
In the following sections are described the available types of commands.
6.2.4.7.1 Read Value
The command Read Value is available only for field devices and enables you to read a value of a
particular channel of the selected device.
In the following screen capture (Figure 6.2.14) is displayed the Read Value window:
Figure 6.2.14 Read Value command window (ISA 100)
To generate the command, select the process value for which to request a reading and click Execute. The
returned value will be displayed in the Readings page, in engineering units under the Value column as
well as in the Command Log, under the Response column.
Note: When the device is unregistered, the Run Commands page is unavailable.
6.2.4.7.2 Reset Device
The command Reset Device resets the firmware on the specific device.
Three types of resets can be performed on a device, as follows:
• Warm Restart – performs a software reset; therefore, the device will unregister and re-
register;
• Restart as provisioned – resets the device while keeping provisioning information;
• Reset to factory defaults – deletes the provisioning information and resets the device to its
manufacturing settings; the device must be re-provisioned in order to be able to join the
network.
In the following screen capture (Figure 6.2.15) is displayed the Reset Device window with the Restart
Types available:
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 80 | 201
Page 81
Figure 6.2.15 Reset Device window (ISA 100)
This command is available for all network devices with two exceptions:
1. the command cannot be performed on the SM;
2. the Reset to factory defaults option is not available on the GW.
6.2.4.7.3 Read Object Attribute
By using Read Object Attribute command you can read attributes from an object on the selected device.
To read an attribute, type in the UAP specific TSAP ID, the object ID and the ID of the attribute that you
wish to read and click Execute. Note that the values of the two indices are 0 by default and the value of
the Committed Burst field is -15 by default.
In the following screen capture (Figure 6.2.16) is displayed the Read Object Attribute window:
Figure 6.2.16 Read Object Attribute window (ISA 100)
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 81 | 201
Page 82
The command returns the content of the attribute, which will be displayed in hex format in the Response
column of the Commands Log page.
6.2.4.7.4 Write Object Attribute
The Write Object Attribute command enables you to write/edit a value to an object on the selected
device. Only certain attributes are editable.
In the following screen capture (Figure 6.2.17) is displayed the Write Object Attribute window:
Figure 6.2.17 Write Object Attribute window (ISA 100)
To write the attribute, type in the TSAP ID, the associated Object ID and the Attribute ID that you want to
write or edit, then type the desired hex value(s) in the Values input field and click Execute. Note that the
values of the two indices are 0 by default.
6.2.4.7.5 Execute Object Method
The Execute Object Method command is used to execute a network visible method on an object on the
selected device.
In the following screen capture (Figure 6.2.18) is displayed the Execute Object Method window:
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 82 | 201
Page 83
Figure 6.2.18 Execute Object Method window (ISA 100)
To execute the method, type in the TSAP ID, the associated Object ID and the Method ID that you wish to
execute, then provide the method details in hex format in the Details input field and click Execute. Note
that the values of the two indices are 0 and the value of the Committed Burst field is -15 by default.
6.2.5 Network Health
The Network Health page provides a communication health report at network level.
The page consists of two sections containing the network summary statistics and the device-specific
communication health information, respectively, as shown in the following screen capture
(Figure 6.2.19):
Figure 6.2.19 Network Health sections (ISA 100)
In the network summary section, the following information is indicated:
• Network ID and Network Type – network identification data (where applicable);
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 83 | 201
Page 84
• Devices Count – the total number of registered devices, including the BBR;
• Join Count – the total number of joins of all the devices in the network;
• Current Date – the present time;
• Start Date – the date and time the SM application was started;
• DPDUs and GPDU – transmission and reliability statistics, based on the summary report per
device;
• Averaging interval for GPDU statistics, reported in seconds.
The device communication report section consists of a table displaying the following information for
each device:
• EUI-64 Address – the network address of the device;
• Start Date – the date and time of the device’s first join;
• DPDU’s Sent – the total number of packets sent by the device;
• DPDU’s Lost – the total number of packets sent by the device which failed to reach destination;
• GPDU Latency – the percentage of scheduled GPDU's that arrive later than expected;
• GPDU Path Reliability – the percentage of GPDU’s transmitted successfully on a primary path;
• GPDU Data Reliability – the percentage of successful GPDU’s (transmit GPDU’s that are
transferred correctly on the first attempt plus receive GPDU’s that pass integrity checks);
• Join Count – the total number of joins per device.
The total number of items in the table is indicated in the top left corner of the table. Here you can set
the number of items to be displayed per page in the table. The default number of items displayed in a
page is 10. Paging controls in the top right corner of the table also enable you to navigate through the
other pages of the table.
The last time the page was refreshed is also indicated in the page. To update the information, click
Refresh.
6.2.6 Readings
In the Readings page you can view the readings received from devices, which are generated either on
demand by Read Value commands or by automatic Publish/Subscribe commands. The readings can be
filtered by Device, Process Value, or Reading Type (Publish/Subscribe or On Demand), as shown in the
following screen capture (Figure 6.2.20):
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 84 | 201
Page 85
Figure 6.2.20 Readings window (ISA 100)
To search for readings, select the desired Device and Process Value, as shown in the previous screen
capture (Figure 6.2.20), and click Search. The results are displayed in a table that contains the following
information for each reading:
• Device EUI-64 Address – MAC address of the device that reported the reading;
• Timestamp – date and time of the reading;
• Channel Name – the process value name;
• Value – the value received on that particular reading, shown in engineering values;
• Unit of Measurement (if applicable);
• Reading type.
The total number of items in the table is indicated in the top left corner of the table. Here you can set
the number of items to be displayed per page in the table. The default number of items displayed in a
page is 10. Paging controls in the top right corner of the table also enable you to navigate through the
other pages of the table.
From this page you can also save the search results into a Microsoft Excel CSV file, by clicking Export.
6.2.7 Commands Log
In Command Log page you can view all the commands issued on the registered devices in the system.
The commands can be filtered by Device, Command (type), or Command Status (New-command posted
in database, Sent-command sent to device, Responded-device responded successfully to the command,
Failed-command failed to execute). These options are depicted in the following screen capture
(Figure 6.2.21):
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 85 | 201
Page 86
Figure 6.2.21 Command Log window (ISA 100)
To search for commands, select the desired Device, Command and Command Status and click Search.
The results will be displayed in a table, as shown in the previous screen capture (Figure 6.2.21), with the
following information for each command:
• Tracking No. – internal ID of the command;
• EUI-64 Address – MAC address of the command destination device;
• Command – name of the executed command;
• Parameters – description of the parameters chosen for the command, if applicable;
• Status – current status of the command;
• Posted Time – date and time when the command was generated;
• Response Time – date and time when the command was responded successfully or not;
• Response – the response for the issued command if the command was responded successfully
or the error reason if the command failed, which can consist of:
o the measured value expressed in engineering units for the Read Value command;
o the hex value for Read/Execute Object Attribute commands; or
o the mention success for all the other types of commands executed on devices.
If the length of the response exceeds the size of the Response cell, click on the response link to open the
Tracking Response form and view the full response, as shown in the following screen capture
(Figure 6.2.22):
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 86 | 201
Page 87
Figure 6.2.22 Tracking Response window (ISA 100)
Given the large number of commands generated automatically by the system at regular intervals, these
commands are hidden by default. To view them, check the Show system generated commands option in
the Search dialog and click Search.
The total number of items in the table is indicated in the top left corner of the table. Here you can set
the number of items to be displayed per page in the table. The default number of items displayed in a
page is 10. Paging controls in the top right corner of the table also enable you to navigate through the
other pages of the table.
From this page you can also save the search results into a Microsoft Excel CSV file, by clicking Export.
6.2.8 Alerts
The Alerts page enables you to view alarms and events generated by devices.
Alerts consist in application messages that advise or warn the recipient of the presence of an impending
or existing situation of interest.
In the following screen capture (Figure 6.2.23) is shown the Alerts window:
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 87 | 201
Page 88
Figure 6.2.23 Alerts window (ISA 100)
Two types (classes) of alerts are supported in accordance with the ISA100.11a specification:
• Events – indicates that something happened with the device;
• Alarms – indicates that a device has transitioned to an abnormal state or has returned to normal
from an abnormal state; an alert is sent to describe the change of state.
To search for alerts you must perform the following actions:
• select the Device, the alert Category, Priority and Class of alert;
• optionally, fill in the Start Time and the End Time fields, and then click Search.
The results are displayed in a table depicted in the previous screen capture (Figure 6.2.23) that indicates
the following information:
• EUI-64 Address – the MAC address of the device generating the alert;
• TsapID and ObjID – identification of the application process and the associated object that
initiated the alert;
• Time – the date and time when the alert condition was detected;
• Class – the type of alert (alarm or event);
• Direction – with the following values:
o Start/End – only for alarms, it indicates if the report is for an alarm condition, or a return
to normal from an alarm condition;
o N/A – if the alert reports an event;
• Category – device diagnostic, communication-related, security-related, or process related;
• Priority – indicates the importance of the alert, with the following ranges and associated labels,
in compliance with the specification:
o 0 - 2: Journal-only;
o 3 - 5: Low;
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 88 | 201
Page 89
o 6 - 8: Medium;
o 9 - 11: High;
o 12 -15: Urgent.
• Value – indicates the value associated with the alert condition.
You can set the number of records to be displayed per page in the table. The default number of records
displayed in a page is 10. Paging controls at the bottom of the table allow you to navigate through
different pages of the search results.
From this page you can also save the Search results into a Microsoft Excel CSV file, by clicking Export.
6.2.9 Troubleshooting
The Troubleshooting page displays the latest alerts related to various events in the network.
In the following screen capture (Figure 6.2.24) is shown the Troubleshooting window:
Figure 6.2.24 Troubleshooting window (ISA 100)
The alerts are listed in a table as shown in the previous screen capture (Figure 6.2.24), with the following
information:
• EUI-64/IPv6 Address/Device Tag – a drop down list allows you to choose the device identification
information that will be displayed in the first column of the table; the drop-down box is set on
EUI-64 by default;
• Timestamp – the date and time when the alert was generated;
• Event – the alert type (please see the Section 6.2.9.1.).
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 89 | 201
Page 90
Alert Type
Details
Explanations
Device Join
Device IPv6
IPv6 address of the device
Device Type
The tags GW, BB, or SM for field devices, the tag is not displayed
Device Join Failed
Parent
The IPv6 address of the parent device
Phase
Join Phase
Join Phase Description
4
SECURITY_JOIN_Req
5
SECURITY_JOIN_Rsp
6
NETWORK_JOIN_Req
7
NETWORK_JOIN_Rsp
8
JOIN_CONTRACT_Req
9
JOIN_CONTRACT_Rsp
10
SECURITY_CONFIRM_Req
11
SECURITY_CONFIRM_Rsp
Reason
The reason number and description
Device Leave
Reason
The reason number and description
• Details – this column displays the following details, depending on the type of alert, as shown in
the following table (Table 6.2):
Table 6.2 Troubleshooting-Details explanations (ISA 100)
Notes:
The Display last N alerts drop-down list allows you to select the maximum number of alerts to display in
the table. You can choose a value between 50, 100, 150, and 200.
To always view the latest alerts, enable the Autorefresh every N seconds checkbox. You can choose a
value between 5, 10, 15, 30, and 60 seconds.
6.2.9.1 Filters
The Edit filters button allows you to define the filters to apply for displaying the alerts. Click the button to
expand the upper section of the page, as shown in the following screen capture (Figure 6.2.25):
• The time elapsed from the Last alert.
• The Topology Alerts will be implemented in a future version of the MCS.
• For a description of the error reasons, see the Section 6.2.9.1.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 90 | 201
Page 91
Alert
Reason
Severity
Device join/leave alerts
Device Join
-
info
Device Join Failed
1: Timeout (device does not respond to SM queries)
warning
2: Re-join (new join request while joining)
warning
3: Parent left the network during device join
warning
8: Insufficient parent resources - will retry join trough another router
warning
Figure 6.2.25 Edit filters button window (ISA 100)
Under Devices, select the devices for which you want to display alerts. Checking/unchecking the All
checkbox in the table header will check/uncheck all the devices.
Under Alert Class & Types, you will view a hierarchy of application alerts and you can select the desired
alerts combination.
Checking/unchecking an alert class will check/uncheck all the alert types in that class.
Checking/unchecking the All checkbox in the table header will check/uncheck all the alerts.
Pressing Clear Filter will reset the filters to All for both the Devices list and the Alerts list.
Each alert is preceded by an icon indicating the severity of the alert, as follows:
- Information
- Warning
- Error
The Severity Icon is displayed for each Alert in the Troubleshooting table based on the following mapping
(Table 6.3):
Table 6.3 Troubleshooting Alerts-mapping (ISA 100)
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 91 | 201
Page 92
4: Device removed from SM whitelist
error
5: Device not found SM whitelist
error
6: Invalid join key - mismatch with key from SM whitelist
error
7: Invalid challenge - already used in a Security_Join_Request
(possible retry)
error
9: SubnetID mismatch (device provisioning/SM whitelist mismatch)
error
Device Leave
1: Timeout - device does not respond to SM queries
error
2: Re-join (new join request while joined)
error
3: Parent left the network
error
4: Device removed from SM whitelist
error
Contract Alerts
Contract Establish
-
info
Contract Modify
-
info
Contract Refusal
1: Insufficient resources
error
2: Delayed (try again later)
error
3: Device not found
error
4: Contract not found (it applies to modification/renewal)
error
5: Invalid request (requested an operation that cannot be performed,
or the request contains invalid parameters)
error
6: timeout (no response to contract request). This reason can only be
set by the FD.
error
Contract Terminate
1: requested
info
2: expired
3: unjoin
Topology alerts
Parent change
-
info
Backup change
-
info
Note: Topology Alerts will be implemented in a future version of the MCS.
6.2.10 Bulk Transfers
The Bulk Transfers page enables you to monitor the status of configured bulk transfers.
In the following screen capture (Figure 6.2.26) is shown the Bulk Transfers Status window:
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 92 | 201
Page 93
Figure 6.2.26 Bulk Transfer Status window (ISA 100)
Bulk transfers can be filtered by EUI-64 address, Transfer Type and Transfer Status. To filter them, select
the desired filters and/or type the EUI-64 address for the desired device and click Search. To reset all the
filters, click Reset.
The bulk transfers are displayed in a table with the following information:
• EUI-64 Address – the EUI-64 address of the target device;
• Transfer type, as follows:
o UDO (Upload/Download Object) – the ISA-defined transfer method;
o BTO (Bulk Transfer Object) – an enhanced CDS-defined transfer method;
• Transfer Status – indicates the status of the transfer process at the time of viewing; the possible
statuses are: Not Started, In Progress, Failed, and Completed;
• Avg.Speed – the average transmission speed, calculated in packets (messages) per minute since
the beginning of the transfer;
• Remaining – the remaining time to completion;
• Duration – the total duration of the transfer;
• Started On - the date and time the bulk transfer operation started;
• Data – only for a completed transfer, click the View link to see the transferred data in hex
format, as shown in the following screen capture (Figure 6.2.27):
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 93 | 201
Page 94
Figure 6.2.27 Transferred data window (ISA 100)
To refresh regularly the information in the table, check the Refresh every 20 seconds option in the Search
form.
The total number of items in the table is indicated in the top left corner of the table. Here you can set
the number of items to be displayed per page in the table. The default number of items displayed in a
page is 10. Paging controls in the top right corner of the table also enable you to navigate through the
other pages of the table.
6.2.11 Set Country Code
The Set Country Code page allows you to set the country code for the checked devices in the list. The
country code will set the maximum RF output power. In Appendix you can find the correlation between
country code and maximum RF output power.
Notes:
• CDS VN310 is the first radio hardware model that supports variable RF output power.
• Only users with Administrator or Power User role are permitted to use this feature.
To set the country code for one or more devices select the respective check boxes on the right side of
the list, select the Country Code from the dropdown list and click Execute. If necessary, you can filter the
device list by EIU-64 Address, Device Tag or by Revision, as shown in the following screen capture
(Figure 6.2.28):
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 94 | 201
Page 95
Figure 6.2.28 Country Code settings window
6.3 Configuration
The Configuration section enables you to view and edit certain settings for the
configuration/provisioning of the devices and the network, including connection settings, publishers,
alert subscriptions and Modbus register mapping.
This section is intended for users with thorough technical knowledge, and certain configurations
require advanced expertise, therefore they should be carefully planned, as any inconsistencies may
render the devices/network inoperative.
Note that the changes you perform in the settings for each separate entity will also be reflected in the
Advanced Settings page and vice-versa.
6.3.1 Basic
The Basic Config page provides the main configuration of the network Subnet ID and the Join Key. The
user input values are as follows (Figure 6.3.1):
• Subnet ID (a decimal value between 2 and 65535);
• Single Join Key (a hexadecimal value of 32 characters).
After changing either values, a Hardware Restart is needed.
The same join key must be provided to field devices in the provisioning phase (using FieldTool).
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 95 | 201
Page 96
Figure 6.3.1 Basic Config
6.3.2 Backbone Router
The Backbone Router configuration page consists of four sections, as shown in the following screen
capture (Figure 6.3.2):
Figure 6.3.2 Backbone Router configuration sections (ISA 100)
• In the General Settings section, you must perform the following action:
o specify the EUI64 address and the BBR Tag.
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 96 | 201
Page 97
On hover over an edit box, a tooltip will appear indicating the allowed format and range for each
value.
Note: If you change any of these settings, you must restart the BBR in order the new settings to
take effect.
• In the Provision/security section you must perform the following actions:
o specify the Subnet ID, which must be the same for all the devices in a subnet;
o specify the Subnet Mask;
o specify the App Join Key.
On hover over an edit box a tooltip will appear indicating the allowed format and range for each
value.
Note: If you change any of these settings, you must restart the BBR in order the new settings to
take effect.
• In the Logging section you must perform the following action:
o select the application and Stack Logging level; the numbers suggest the degree of detail
provided in the BBR logs, as follows:
- 1 (ERROR) for error messages only;
- 2 (WARN) for error and warning messages;
- 3 (DEBUG) for error, warning and debug messages.
• In the Time Settings section, you must perform the following actions:
o select NTP servers if the VR950 has access to internet;
o in case the VR950 does not have access to the internet, time synchronization can be
performed by using the transceiver clock TR as time source.
When you have finished editing the settings, click Save. As mentioned above, depending on the settings
that you modify, the BBR may need to be restarted for the changes to take effect.
6.3.3 Gateway
The Gateway configuration page consists of 3 sections, as shown is the following screen capture
(Figure 6.3.3):
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 97 | 201
Page 98
Figure 6.3.3 Gateway configuration window (ISA 100)
• In the General Settings section, you must perform the following action:
o specify the EUI64 address and the GW Tag.
On hover over an edit box a tooltip will appear indicating the allowed format and the range for
each value.
Note: If you change any of these settings, you must restart the GW in order the new settings to
take effect.
• In the Provision/security section you must perform the following action:
o specify the Subnet ID and the App Join Key.
On hover over an edit box a tooltip will appear, indicating the allowed format and the range for
each value.
Note: If you change any of these settings, you must restart the GW in order the new settings to
take effect.
• In the Logging section you must perform the following action:
o select the Application Logging level and the Stack Logging level; the numbers suggest the
degree of detail provided in the GW logs, as follows:
- 1 (ERROR) for error messages only;
- 2 (WARN) for error and warning messages;
- 3 (DEBUG) for error, warning and debug messages
When you have finished editing the settings, click Save. As mentioned above, depending on the settings
that you modify, the Gateway may need to be restarted for the changes to take effect.
6.3.4 System Manager
The System Manager configuration page consists of 3 sections, as shown in the following screen capture
(Figure 6.3.4):
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 98 | 201
Page 99
Figure 6.3.4 System Manager configuration window (ISA 100)
• In the General Settings section, you must perform the following action:
o Specify the EUI64 address.
On hover over an edit box a tooltip will appear, indicating the allowed format and range.
Note: If you change this setting, you must restart the SM in order the new setting to take effect.
• In the Operational Settings section, you must perform the following actions:
o fill in the input fields with the desired/appropriate values; the following default values are
used by the System Manager when no value is present in the field:
- Max Device Number – 100 maximum number of devices that are allowed in the system;
- Max Desired Latency (%) – 0 maximum desired latency (percentage of publication
period). Values in percentage of the publication period apply on each periodic contract.
Default value of 0 means that the latency is limited only by the value from contract.
Publication contracts request, with a latency required below this value will not be
allocated with the requested latency (from contract) and will be allocated with the
supplied value from settings. Each contract when is requested can specify a desired
latency. The contract latency will be used by apply minimum between contract specified
latency and Max Desired Latency settings. The Max Desired Latency is a global latency
that can be applied on all contracts;
- Device Timeout Interval (s) – 120 seconds, integer in range [60-65535]; timeout in
seconds used by SM to detect that a device is down;
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 99 | 201
Page 100
- Advertise Period (s) – 10 seconds; represents the period to be used by routers to send
advertisement requests; the possible values for this field are: 1,4,7,8,9,10,11,13,14;
- Join Links Period (s) – 5 seconds; represents the period to be used by routers for the join
links used during join process of other devices through these routers;
- Topology – choose between Mesh and Star topologies;
- Channels – 12,20,24,23,18,25,21; represents the list of IEEE 802.15.4 channels that are
used for data communication in the whole setup;
o enable the desired frequency channels for communication with the network devices.
On hover over an edit box a tooltip will appear, indicating the allowed format, range and a
description (where necessary for disambiguation) for each value.
• In the Logging section, select the Logging level, which indicates the degree of detail provided in
the logs, as follows:
o ERROR for error messages only;
o WARN for error and warning messages;
o INFO for error, warning, and information messages;
o DEBUG for error, warning, information, and debug messages;
When you have finished editing the settings, click Save.
6.3.5 Device Management
This Device Management page enables you to edit the provisioning information in the
system_manager.ini file for existing devices and to add new devices to the network.
WARNING! Do not change these settings unless you were specifically instructed by a CDS Technical
Support representative! Incorrect values may render the devices dysfunctional or may cause difficulty
to trace malfunctions.
Click Help in the upper right corner of the window to view information and examples of the accepted
data formats in all the sections.
In the following screen capture (Figure 6.3.5) is shown the Device Management window:
Ref.no.: 003274/Revision 2.4 @2019 Control Data Systems Page 100 | 201
Loading...