APEX Configuration Manual

Transcription

1 APEX Configuration Manual Release 1.6 April, 2000 (prelimary) ARCOM CONTROL SYSTEMS, INC SOUTH OAK STREET KANSAS CITY, MISSOURI PHONE FAX ARCOM CONTROL SYSTEMS, LTD. CLIFTON ROAD CAMBRIDGE CB1 4WH UNITED KINGDOM PHONE FAX

2

3 APEX Configuration Manual Copyright Arcom Control Systems, Inc DISCLAIMER This manual contains information that is correct to the best of Arcom Control Systems' knowledge. It is intended to be a guide and should be used as such. It should not be considered as a sole source of technical instruction, replacing good technical judgement, since all possible situations cannot be anticipated. If there are any doubts as to exact installation, configuration and/or use contact Arcom Control Systems, Inc. ACKNOWLEDGEMENTS APEX is a trademark of Arcom Control Systems, Inc. Microsoft, Windows, Windows 95, and Windows NT and/or other Microsoft products are trademarks or registered trademarks of Microsoft Corporation ISaGRAF is a registered trademark of CJ International PC/104 is a trademark of the PC/104 Consortium HART is a registered trademark of the HART Communication Foundation Modbus is a registered trademark of Schneider Automation, Inc. All other brand or product names are trademarks or registered trademarks of their respective holders. Arcom Control Systems i

4 REVISION HISTORY Release Revisions Date 1.0 Initial release of APEX Configuration Manual October, Revised to include standard libraries for March, 1998 Router object, field unit Modbus32 object and ACE Version 2.02 Release Fully reformatted March, ACE Version 2.02 Release 8 April, Terminal Server & Terminal Client Sept., Slave Instance number information Nov., HART config. changes April, 2000 (preliminary) ii Arcom Control Systems.

5 Table of Contents 1 Introduction Designing Configurations Concepts APEX Configuration Overview APEX System Configuration Icon Adding Configuration Icons Instance Number Requirements Networks Async Port Configuration Virtual Ports SLIP Port Configuration Ether Port Configuration Router Configuration PPP Port Configuration PSTN Dialer PPP Authentication ACE Configuration Layout - Networks Client Services Master Channels Identifier Master Channel Configuration Async Circuit Network Circuit Modbus Field Unit RTDB (Real Time DataBase) Deadband Object SOS (Specific Out Station)Object Internal Channel Configuration Virtual Circuit Configuration ISaGRAF Field Unit Load/Store ISaGRAF Defaults Null Circuit Configuration Status/Control Field Unit Communication Status Registers Virtual Field Unit RTDB (Real Time DataBase) Segment Field Unit Segment RTDB Ambrosia Publish IBM MQ Publish Terminal Client/Server Configuration Terminal Client Arcom Modem Packet Assember Dis-assembler (AMPAD) LCD/Keypad Configuration SNTP Time Sync Page Arcom Control Systems iii

6 4.9 ACE Configuration Layout Client Services Servers HCP RBE Server HCP PR Server Serial MMI Configuration Slave Channels Identifier Icon Async Slave Channel Network Slave Channel Slave Attach List Dial Backup Terminal Server Configuration TS Port UDP Client/Server MC Port ACE Configuration Layout - Servers HART Configuration Philosophy of HART multiplexers HART to Modbus conversion Real-time vs. Static data acquisition ISaGRAF as the Host Application Secondary Master Defining ACE Objects for HART HART Bus Interface (HBI) Port Configuration HART Commands Identifier HART Command Definition Command Definition Data Types Master Channel for HART HART Circuit HART Field Unit RTDB (Real Time DataBase) HART RTU Extra Configuration Checking HART Command Status iv Arcom Control Systems.

7 CHAPTER 1 1 Introduction The Arcom Configuration Environment (ACE) is a utility designed to run under Microsoft Windows 95/98 or NT detailing the configuration required for the APEX product range and associated field units. ACE is based on a concept called 'Templates'. A template is a file detailing the tree structure and object definition required for each product. The following templates are currently available: This manual applies to the configuration for the APEX Configuration Template Version 3.11 and the ACE version 2.02 Release 11. Note: Due to project-specific requirements or on-going product development, some configuration templates may contain more or fewer objects than described in this manual. This manual should be treated as a guide to understanding the basic APEX configuration, but project documentation may contain additional details. Arcom Control Systems 1

8 It is assumed that the user has already installed the ACE program and is familiar with the ACE Configuration tools. Please refer to the ACE Operation Manual for more details on installation and use of ACE. A summary of the chapters in this manual includes: Chapter 2: Designing Configurations gives an overview of the APEX system, with respect to the ACE configuration structure. Chapter 3: Networks describes the software configuration for physical communication ports of the APEX. Chapter 4: Client Services covers the configuration of the APEX connection to slave devices, the poll commands to those devices, and internal database structures. Chapter 5: Servers provides information on APEX connections to host devices. Chapter 6: HART Configuration describes the configuration and use of the APEX with HART protocol devices. 2 Arcom Control Systems

9 CHAPTER 2 2 Designing Configurations 2.1 Concepts The APEX must be configured before it will function. The configuration of a APEX is in a hierarchical format and each component must be configured in succession. If any of these components are omitted or configured incorrectly, then that component and its lower level components will be inoperable. Below is the opening screen that appears when ACE runs. From the Configuration menu, either create a new configuration or open one that has been provided. For a new configuration, choose the Configuration, New. Enter a name and description for the configuration. Select the Configuration type and select OK. The configuration available is described below: APEX Configuration Template - Defines only the highest level configuration objects, and all other objects must be created by the system designer. Arcom Control Systems 3

10 To open an existing configuration, choose the Configuration, Open menu. Select the configuration and click Open. 4 Arcom Control Systems

11 2.2 APEX Configuration Overview Below is shown the first level of a typical APEX configuration structure. Each icon or "object" represents operational properties of various services in the APEX. A configuration will comprise the following components where is the overall configuration which gives the APEX its unique identification are the physical communication connection points on the APEX are the logical communication paths to one or more field units are the logical communication paths to one or more host devices. Before an APEX/Director can begin network operation, a configuration must be made. Once complete, the system configuration is downloaded from the host using these system defaults. Download of new configuration files does not cause the APEX to immediately begin using the new configuration. The host machine responsible for the download must then reset the APEX remotely, via the diagnostic menu, before the new configuration will take effect. The APEX unit can also be power cycled to allow the new configuration to take effect. Arcom Control Systems 5

12 The APEX unit is configured in a hierarchical format such that the parent element on any branch must be configured before any child element can be detailed. It is advisable to make a sketch of the actual physical system before attempting to configure the APEX unit. The elements of a configuration are summarized below for a standard APEX. Project specific elements may be described in a separate Project Specific document.: System Configuration The APEX System Configuration is the overall configuration which gives the APEX its unique identification such as unit address, name and password. The APEX System Configuration is the 'parent' element for the following branches: Networks, Client Services and Servers. Once the above APEX System Configuration has been defined the Networks, or physical communication connections on the unit, are detailed: 6 Arcom Control Systems

13 Networks Networks is the 'parent' element under which the physical communication connection points on the APEX unit are defined. Each 'child' element can be either an Async Port, SLIP, Ethernet, HBIPort, or Router. The Async Port defines the unique identification and operating characteristics of each asynchronous serial communication port to be used on the APEX unit is defined with this element. The asynchronous serial port would be used for external field devices and serial diagnostics ports. The unique identification of each SLIP communication port, for Serial Link IP connections, to be used on the APEX unit is defined with this element. The unique identification of the Ethernet network for TCP/IP connections is defined with this element. The HBIPort object defines the unique identification and operating characteristics of each HART communication port to smart field devices using HART protocol. The unique identification of the Router for the Ethernet network for TCP/IP connections is defined with this element. Once the physical communication connection points on the APEX unit are defined, the Client Services, or logical communication paths to each physical field unit, are constructed: Arcom Control Systems 7

14 Client Services Client Services is the 'parent' element under which the logical communication paths to the field units are defined. The 'child' elements are the Master Channels identifier, LCD/Keypad, and HART Commands Identifier. The Master Channels identifier is a place holder for graphical clarity on the ACE tool, for individual Master Channel definitions. The 'child' elements are Publish, Master Channel, and Internal Channel. The LCD/Keypad defines the characteristics of an external LCD/Keypad interface connected to the APEX. The HART Commands Identifier is a place holder for graphical clarity on the ACE tool, for command definitions used with HART protocol devices. The 'child' element is the HART Command. The Publish object is a link between an ISaGRAF data packet and the Broker. The Terminal Client object converts serial data into IP packets to be sent over an IP network. A matching Terminal Server object in another APEX/Director may be used to convert IP packets back into serial data to be sent out over a local serial port. The Master Channel defines a logical communication link from the APEX unit to the physical field units by defining the timing and polling sequence required to retrieve the data from the physical field units. The 'child' elements are Async Circuit, Network Circuit, and HART Circuit. (See separate HART section further below.) The Async Circuit connects the master channel to one or more field units through a physical connection point on the APEX unit. The 'child' element is Modbus Field Unit. The Network Circuit connects the master channel to one or more field units through a TCP/IP connection point on the APEX unit. The 'child' element is Modbus Binary Field Unit. The Modbus Field Unit defines how data is polled from an external Modbus field unit and placed in the associated RTDB (Real Time Data Base) within the APEX unit. Each field unit linked on a master channel requires a unique address. The 'child' elements are the Modbus RTDB and SOS. The RTDB (Real Time Data Base) defines the size of the database area; i.e., the number of variables of each type, to be reserved within the APEX unit for the parent field unit (Modbus). 8 Arcom Control Systems

15 The Deadband Field Unit specifies the deadband limits to be applied to each of the variables defined in the parent RTDB. The SOS allows one to modify polling without using ISaGRAF programming. Once the logical communication paths to each physical field unit are constructed, the logical communication path to each Internal field unit is defined. Arcom Control Systems 9

16 Note: The format of the following Internal master channel 'branch' is identical to that constructed above for the physical field units, although some of the element properties need not be configured. This is to maintain consistency in both the structure of the file naming and the configuration build. The Internal Channel defines a logical communication link within the APEX unit to the internal field units. The 'child' element are Virtual Circuit and Null Circuit. The Virtual Circuit connects the Internal Channel to an internal ISaGRAF field unit. The 'child' element is the ISaGRAF Field Unit. The Null Circuit connects the Internal Channel to one or more internal field units. The 'child' elements are the Status/Control Field Unit, Virtual Field Unit, and the Segment Field Unit. The ISaGRAF Field Unit details the address of the field unit. The data contained within the ISaGRAF field unit includes physical I/O into the APEX unit and pseudo I/O generated by any ISaGRAF applications that may be operating. Data may be polled from the ISaGRAF field unit and placed in the associated RTDB (Real Time Data Base) within the APEX unit. The 'child' element is Modbus RTDB. The Status/Control Field Unit details the address of the field unit. The data contained in the status/control field unit is the communication status information for the APEX unit. Data is automatically polled from the status/control field unit and placed in the associated RTDB (Real Time Data Base) within the APEX unit. The 'child' element is Modbus RTDB. The Virtual Field Unit details the address of the field unit. Virtual field units are available to increase the flexibility of the APEX unit. Some uses include the ability to pack data from a number of physical field units into one consecutive block of data, map scaled data from the ISaGRAF field unit for retrieval by a host, and act as a 'scratch pad' field unit for data. The 'child' element is Modbus RTDB. The RTDB (Real Time Data Base) defines the size of the database area, ie the number of variables of each type, to be reserved within the APEX unit for the parent field unit. The 'child' element is the Deadband Field Unit. The Deadband Field Unit defines the deadband limits to be applied to each of the variables defined in the parent Modbus RTDB (Real Time Data Base). 10 Arcom Control Systems

17 The Segment Field Unit object sets the unit address of a Segment, which is used for reporting RBE data over the satellite network. The 'child' element is the Segment RTDB. The Segment RTDB defines the size and data type of items within the Segment database area. Arcom Control Systems 11

18 The elements of a configuration that are required for HART protocol operation are summarized below. The HBIPort object defines the unique identification and operating characteristics of each HART communication port to smart field devices using HART protocol. The HART Circuit object is a 'child' of the Master Channel, and connects the Master Channel to one or more HART devices through a HART physical connection. The 'child' element is a HART Field Unit. The HART Field Unit defines how data is polled from an external HART protocol device and placed in the associated RTDB (Real Time Data Base) within the APEX unit. Each device linked on a Master Channel requires a unique address. The 'child' elements are the RTDB and the HART RTU Extra. The HART RTU Extra object defines the Command Register which the host uses to request an additional HART command, and the Result Register in which to put the command result of requested commands. HART Commands Identifier is the 'parent' element under which all the HART Command Definitions are defined. The 'child' element is the HART Command. The HART Command object contains the definition of each HART command to be sent by the APEX to a HART device. Once the logical communication paths between the APEX unit and the field units are defined the Servers, or logical communication paths between the APEX unit and one or more hosts, are constructed: 12 Arcom Control Systems

19 Servers is the 'parent' element under which the logical communication paths to each host is defined. The 'child' elements are the HCP/RBE, P/R, Serial MMI and the Slave Channels Identifier. The HCP RBE (Report By Exception) provides a service to an HCP host to report data upon any values changing beyond the deadband limits. The P/R (Poll/Response) provides a service to an HCP host to allow protocol messages to be sent directly to a field unit. The Serial MMI object defines a logical connection to an external terminal program for diagnostic purposes. The Slave Channels identifier is a place holder for graphical clarity on the ACE tool. The 'child' elements are Async Slave Channel and Network. The Async Slave Channel connects the slave channel to one or more field units through a physical serial connection point on the APEX unit. The 'child' element is Slave Attach List. The Network Slave Channel allows the Slave Attach Lists associated with it to be accessed via both SLIP and Ethernet ports which may have been configured under the Networks object at top of ACE window. The Slave Attach List defines a slave address and the field unit RTDBs (Real Time Data Base) that will respond to the host at this slave address. If more than one field unit is attached to the slave address, the data from the field units shall be concatenated. The Terminal Server converts IP encapsulated data into to be sent out a specified serial port(s). The TS Port is used to specify the serial port(s) over which the serial data are sent after conversion by the Terminal Server above. Arcom Control Systems 13

20 2.3 APEX System Configuration Icon The System Configuration must be defined before any other operation and gives the APEX unit its unique identification. To define the properties of the APEX unit, right click on the icon and select Properties. The defaults displayed are Enabled Enter a 'Yes' to for the object to be enabled and downloaded or 'No' to disable the object. Unit Address Enter a valid and unique unit address between 1 and 255. Address 0 is reserved. Unit address creates a unique identifier for the APEX unit when it is used with an HCP. If an HCP is not used, this parameter is ignored. Unit Name User Name Enter a valid unit name between 1 and 13 characters. Unit name is a NULL terminated character string used to assign an ASCII readable name to the APEX. This is displayed on the diagnostic menu and on the HCP. Enter a valid user name between 1 and 13 characters. User name is a NULL terminated character string used for Telnet/FTP/MMI session login validation. A NULL string value will disable the session. 14 Arcom Control Systems

21 Password Date Format Enter a valid password between 1 and 8 characters. Password is a NULL terminated character string used for Telnet/FTP/MMI session login validation. A NULL string value will disable any password protection for the connection. Select the date format for use in Serial MMI diagnostics. Options are: dd/mm/yy - Military or European date format. mm/dd/yy - American date format. Once configured, select Close. Arcom Control Systems 15

22 2.4 Adding Configuration Icons The remainder of this manual discusses adding and configuring 'child' objects under the three default branches: 'Networks', 'Client Services', and 'Slave Servers'. When adding any 'child' configuration object, click on the 'parent' object in the configuration window. In the ACE toolbar, there will appear one or more icon buttons which are the possible 'child' objects for that 'parent'. When one of those toolbar buttons is selected, the new 'child' object will be created. For instance when the Networks 'parent' object is selected, three buttons appear in the ACE toolbar. Clicking on any of these buttons will bring up a prompt for the Object Name, Instance Number, and Help Text for that 'child' object. Important: Object Names must not contain square brackets [ ], or consist of all numbers. For instance, clicking on the button in the toolbar will display the dialog box for creating a new Async Port. Refer to the appropriate sections in this manual for instruction on setting the Instance Number property for a particular object. 16 Arcom Control Systems

23 Once the information has been entered for this 'child' object, click on the Add button to add the object to the configuration, or click the Cancel button and the object will not be created. ACE does not allow two icons with identical names, so choose an Object Name that is unique within this configuration. If the object name entered is not unique, the following error will be displayed and a different Object Name must be entered. The Instance Number creates a Download File name which must also be unique within this configuration. If the Download File is not unique, the following error will be displayed and a different Instance Number must be entered. Arcom Control Systems 17

24 Some objects contain limitations on the maximum Instance Number that can be created. If an Instance Number is entered outside the allowed range, a prompt will be displayed similar to the following, and a correct Instance Number must be entered. 18 Arcom Control Systems

25 2.5 Instance Number Requirements When adding each object, an Instance Number is required. Instance Numbers will always be whole numbers, greater than or equal to zero. For many of the objects, the Instance number defaults to zero and cannot be changed. Other objects have specific requirements that must be followed so that the configuration operates correctly in the APEX. Each section in this manual lists the Instance Number requirements when adding the object. Below is a summary of the requirements for all objects in the configuration. The following objects do not require an Instance Number to be entered: Networks Client Services Master Channels Identifier LCD/Keypad HART Commands Identifier RBE Poll/Resp Publish (IBM and Ambrosia) RTDB (all types except Segment RTDB) Deadband HART RTU Extra Servers Slave Channels Identifier Serial MMI Terminal Server Port For the following objects, the Instance Number must follow specific requirements: Name Requirements Async Port Must be identical to physical COM port number (0-7) Ethernet Port Must start at 0 and number consecutively. Each must be unique. HBIPort Must be identical to physical HART port number (4-9), maximum of four are allowed Master Channel Must be between 0 and 15, unique from Internal Channel Circuits: Async, SLIP, Network, HART, Router Must start with 0 and be sequential under each channel, unique from each other Field Unit (Modbus RTU) Must be between 0 and 255, unique under a Master Channel (should be identical to the actual field unit device address) Field Unit (Stat/Ctrl, Virtual, Must be between 0 and 255, unique under a Null Circuit Segment) ISaGRAF Field Unit Only one instance allowed under a Virtual Circuit. HART Circuit Must be between 0 and 3, unique under a channel. Usually there should be only one HART Circuit under a channel. HART Command Must be between 0 and 999, unique (Start from zero) HART Field Unit Must be between 0 and 255, unique under a channel (should be identical to the HART unit address) (Table continues below) Arcom Control Systems 19

26 Internal Channel Virtual & Null Circuits Segment RTDB Slave Channel Circuits: Async & Network Slave Attach List Terminal Client Terminal Server Must be between 0 and 15, unique from Master Channels (only one Internal Channel is allowed) Must be between 0 and 1, unique under an Internal Channel (maximum of one each are allowed) Must be between 1 and 255 and be sequential from 1, unique under a Segment Field Unit Must be between 0 and 15, unique under Slave Channels Identifier Must be between 0 and 99, unique under Async Slave Channel Must be between 0 and 3, unique under Master Channels Must be between 0 and 15, unique under Servers 20 Arcom Control Systems

27 CHAPTER 3 3 Networks The Networks configuration defines the physical communications connections for the APEX unit. The APEX is capable of supporting up to a certain number of serial communication ports with a wide array of operational parameters. The maximum number of ports available depends on the limitations of the individual hardware platform (see Hardware Manual). Note: Configuration of hardware that is not present on the APEX unit may cause errors (such as configuring an Ethernet object but with no Ethernet card installed). To define the properties of the Networks, right click on the Networks icon and select Properties. Enabled Enter a 'Yes' to for the object to be enabled or 'No' to disable the object. Once configured, select Close. Arcom Control Systems 21

28 The network devices currently supported are displayed on the tool bar when the icon is selected. These are is an Async serial communication port. is a SLIP communication port for Serial Link IP connections. or is an Ethernet network for TCP/IP connections on the APEX. is a HBIPort (HART) communications port is an Ethernet network Router for TCP/IP connections. is a PPP communication port for Point to Point protocol IP connections. 22 Arcom Control Systems

29 3.1 Async Port Configuration The Async port configuration defines the physical asynchronous connections for the APEX unit. Note: In some systems, Async ports can be defined as "Virtual Ports" that represent internal links between tasks rather than actual, physical comm ports. See Section To add an Async port to the Networks configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number Displays the parent for this object. Enter a unique name for this port. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number. This instance number must correspond to the physical APEX communication port. For example, when configuring the properties of COM1, the Instance Number must be 1. The following Async port definitions are typical, although specific configurations may vary from project to project: COM0 = SLIP port COM1 = Serial MMI port Arcom Control Systems 23

30 COM2 = Local Modbus slave port / ISaGRAF port COM3 = Host port to poll external third-party device(s) COM4 and higher = Additional host or slave ports (optional) DownLoad File Help Text Displays the download file created for this object as portaaa where aaa = instance number For example: instance number 0 = port000 = COM0 instance number 1 = port001 = COM1 instance number 11 = port011 = COM11 Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the Async communication port and select Add. The example shows a typical configuration for COM1. To define the properties of the Async port, right click on the object icon and select Properties. An example is displayed below. Object Name 24 Arcom Control Systems

31 Enabled Baud Rate Parity Word Length Stop Bits Rx Buffer Size Tx Buffer Size Warm Up Time Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the dropdown menu the operational baud rate of the port Baud rates from 600 to 38,400 are supported on all ports. Ports 0 and 1 also support up to 115.2K baud. Select from the dropdown menu the port parity. Parity options supported are None, Odd and Even. Select from the dropdown menu the word length for use in port operation. Word lengths supported are 7 bit and 8 bit. Select from the dropdown menu the number of stop bits for use in port operation. Number of stop bits supported are 1 bit and 2 bits. Enter the receive buffer size in bytes. This is unused for Modbus protocol, but it may be used by other protocols. Default is 256 bytes. For the Serial MMI port, use Enter the transmit buffer size in bytes. This is unused for Modbus protocol, but it may be used by other protocols. Default is 256 bytes. For the Serial MMI port, use 2048 Enter value for warm up time. This is the amount of time to Arcom Control Systems 25

32 wait before sending data after the RTS handshaking lead has been asserted. An entry of -1 denotes that no handshaking be used. An entry of 0 denotes that RTS/CTS hardware handshaking will be used (no data will be sent until CTS is asserted). A positive value will transmit data after the configured number of milliseconds, independent of CTS. Warm Down Time Enter value for warm down time. This is the amount of time to wait after the entire message packet has been shifted out to keep the RTS handshaking lead asserted. An entry of 1 denotes that no handshaking be used. Once configured, select Close. 26 Arcom Control Systems

33 3.2 Virtual Ports This section describes the "Virtual Port" feature which is available in some systems. Virtual Ports are Async Ports (see Section 3.1) which do not define physical ports, but rather internal comm links. In some applications it is necessary to put a null modem cable from one comm port to another, in order to translate output data (such as from a Terminal Server or Channel/Circuit) to another port (such as into a Terminal Client or Slave Channel). Because of the limitation of comm ports in some applications, the Virtual Port feature was added to make this loopback in software. Several rules must be understood to use Virtual Ports: Virtual Ports use the same object definition as Async Ports. Virtual Ports may be selected in objects (such as Circuits) in the same way that Async Ports are selected. Virtual Ports are always created and used in pairs, and pass data from one the other in the same way as an external null modem cable between physical comm ports. Any Async Port defined in the configuration for which there is no physical comm port will be treated as a Virtual Port, up to the maximum port number allowed. Up to 8 Virtual Ports (4 pairs) may be defined in a configuration. The Virtual Ports must be defined immediately after the physical ports. Arcom Control Systems 27

34 3.3 SLIP Port Configuration The SLIP port configuration defines the physical SLIP connections for the APEX unit. To add a SLIP port to the Networks configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this port Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number. The instance number is the next sequential number, counting from zero, corresponding to the quantity of SLIP ports connected. There is no correlation between SLIP instance number and the physical COM port to which it will be attached. Displays the download file created for this object as netslipa where a = instance number For example: instance number 0 = netslip0 instance number 1 = netslip1 Enter any text describing this object. Text entered here is displayed at the bottom of the ACE 28 Arcom Control Systems

35 configuration screen when the object is selected. Enter the details for the SLIP communication port and select Add. The example shows a typical configuration for APEX COM0. Arcom Control Systems 29

36 To define the properties of the SLIP port, right click on the object icon and select Properties. An example is displayed below. Object Name Enabled SLIP Port Baud Rate Parity Word Length Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the dropdown menu the physical communication port to be available for SLIP. Do not configure this port as an Async port in addition to the SLIP port configuration! Select from the dropdown menu the operational baud rate of the port. Baud rates from 600 to 38,400 are supported on all ports. APEX-PC104 ports 0 and 1 also support up to 115.2K baud. Select from the dropdown menu the port parity. Parity options supported are None, Odd and Even. Select from the dropdown menu the word length for use in port operation. Word lengths supported are 7 bit and 8 bit. 30 Arcom Control Systems

37 Stop Bits Warm Up Time Warm Down Time Domain Name SLIP IP Subnet Mask Select from the dropdown menu the number of stop bits for use in port operation. Number of stop bits supported are 1 bit and 2 bits. Enter value for warm up time. This is the amount of time to wait before sending data after the RTS handshaking lead has been asserted. An entry of -1 denotes that no handshaking be used. An entry of 0 denotes that RTS/CTS hardware handshaking will be used (no data will be sent until CTS is asserted). A positive value will transmit data after the configured number of milliseconds, independent of CTS. Enter value for warm down time. This is the amount of time to wait after the entire message packet has been shifted out to keep the RTS handshaking lead asserted. An entry of 1 denotes that no handshaking be used. Enter the domain name. Name used by TCP/IP host to identify different SLIP connections. Enter the SLIP IP address. This is the address at which other network devices will see this APEX when trying to make a connection via SLIP. Enter the subnet mask. The Subnet Mask should be set according to standard TCP/IP domain and subnet rules. See network administrator before setting the IP or Subnet Mask. Once configured, select Close. Arcom Control Systems 31

38 3.4 Ether Port Configuration The Ethernet port configuration defines the physical Ethernet connections for an APEX unit. To add an Ethernet port to the Networks configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this port. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number. The instance number is the next sequential number, counting from zero, corresponding to the number of Ethernet connections. Displays the download file created for this object as netethra where a = instance number For example: instance number 0 = netethr0 instance number 1 = netethr1 Enter any text describing this object. Text entered here is displayed at the bottom of the ACE 32 Arcom Control Systems

39 configuration screen when the object is selected. Enter the details for the Ethernet communication port and select Add. The example shows a typical configuration. Arcom Control Systems 33

40 To define the properties of the Ethernet port, right click on the object icon and select Properties. An example is displayed below. Object Name Enabled Network Card Type Network Card Address Network Card IRQ Network Card DMA Domain Name Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select PC104 ETHER for APEX PC-104 or Director. Select SETHER for the APEX-STE. Enter the network card address Default address is 576 (240 Hex). Address depends on the configuration of the Ethernet board. Enter the network card IRQ (Interrupt Request). Enter 14 for Director. Enter 5 for APEX PC-104. Enter 11 for the APEX-STE. Enter the network card DMA (Direct Memory Access). Default address is Enter the domain name. Name used by host to identify different Ethernet connections. 34 Arcom Control Systems

41 Network Card IP Subnet Mask Default Gateway Enter the IP address for the card. Default is Enter the subnet mask. Default is Enter the default gateway. Default is which indicates that no default gateway will be used. Once configured, select Close. Arcom Control Systems 35

42 3.5 Router Configuration The router configuration defines the physical routing of Ethernet connections for an APEX unit. To add a router to the Networks configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this port. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number. The instance number is the next sequential number, counting from zero, corresponding to the number of router connections. Displays the download file created for this object as netrouta where a = instance number For example: instance number 0 = netrout0 instance number 1 = netrout1 Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. 36 Arcom Control Systems

43 Enter the details for the Router and select Add. The example shows a typical Router configuration. To define the properties of the router, right click on the object icon and select Properties. Object Name Enabled Domain Name IP Address Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Enter the domain name. Name used to identify different router connections. Enter the IP address for the router. Default is Arcom Control Systems 37

44 Subnet Mask Enter the subnet mask. Default is Once configured, select Close. 38 Arcom Control Systems

45 3.6 PPP Port Configuration The PPP port configuration defines the physical PPP connections for the APEX unit. To add a PPP port to the Networks configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this port Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number. The instance number is the next sequential number, counting from zero, corresponding to the quantity of PPP ports connected. There is no correlation between PPP instance number and the physical COM port to which it will be attached. Displays the download file created for this object as netpppa where a = instance number For example: instance number 0 = netppp0 instance number 1 = netppp1 Enter any text describing this object. Text entered here is displayed at the bottom of the ACE Arcom Control Systems 39

46 configuration screen when the object is selected. Enter the details for the PPP communication port and select Add. The example shows a typical configuration for APEX COM0. To define the properties of the PPP port, right click on the object icon and select Properties. An example is displayed below. Object Name 40 Arcom Control Systems

47 Enabled PPP Port Baud Rate Parity Word Length Stop Bits Warm Up Time Warm Down Time Domain Name SLIP IP Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the dropdown menu the physical communication port to be available for PPP. Do not configure this port as an Async port in addition to the PPP port configuration! Select from the dropdown menu the operational baud rate of the port. Baud rates from 600 to 38,400 are supported on all ports. APEX-PC104 ports 0 and 1 also support up to 115.2K baud. Select from the dropdown menu the port parity. Parity options supported are None, Odd and Even. Select from the dropdown menu the word length for use in port operation. Word lengths supported are 7 bit and 8 bit. Select from the dropdown menu the number of stop bits for use in port operation. Number of stop bits supported are 1 bit and 2 bits. Enter value for warm up time. This is the amount of time to wait before sending data after the RTS handshaking lead has been asserted. An entry of -1 denotes that no handshaking be used. An entry of 0 denotes that RTS/CTS hardware handshaking will be used (no data will be sent until CTS is asserted). A positive value will transmit data after the configured number of milliseconds, independent of CTS. Enter value for warm down time. This is the amount of time to wait after the entire message packet has been shifted out to keep the RTS handshaking lead asserted. An entry of 1 denotes that no handshaking be used. Enter the domain name. Name used by TCP/IP host to identify different network connections. Enter the PPP IP address. This is the address at which other network devices will see this APEX when trying to make a connection via PPP. Arcom Control Systems 41

48 Subnet Mask Connection TimeToDie Enter the subnet mask. The Subnet Mask should be set according to standard TCP/IP domain and subnet rules. See network administrator before setting the IP or Subnet Mask. Number of seconds to operate a PPP session before killing the connection. This time is absolute, based on the time at which the session was initiated. It will be killed regardless if data is still being transferred when the TimeToDie timer expires. Once configured, select Close. Some additional PPP parameters are supported, as displayed on the tool bar when the icon is selected. These are is a PSTN dialer configuration. is a PPP Authentication configuration, necessary for logging into a PPP server using authentication. 42 Arcom Control Systems

49 3.6.1 PSTN Dialer The PSTN Dialer configuration defines how the unit will dial out to the public switch telephone network (PSTN) using a dial-up modem. If the PPP connection is permanent, such as a hard-wired cable to a router, this object is not necessary. To add a PSTN Dialer object to the PPP configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number Displays the parent for this object. Enter a unique name for this port Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number. DownLoad File Help Text Displays the download file created for this object as pstnaa where aa = instance number For example: instance number 0 = pstn00 instance number 1 = pstn01 Enter any text describing this object. Text entered here is displayed at the bottom of the ACE Arcom Control Systems 43

50 configuration screen when the object is selected. Enter the details for the PSTN Dialer object and select Add. The example shows a typical configuration. To define the properties of the PSTN Dialer, right click on the object icon and select Properties. An example is displayed below. Object Name 44 Arcom Control Systems

51 Enabled Initialize String Dial String Reserved Prompt 1 Response 1 Prompt 2 Response 2 Prompt 3 Response 3 Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Enter text for an AT command to be sent to the modem upon initialization. Consult modem manual for initialization parameters. Do not include the phone number to dial here. Multiple AT command strings can be sent if separated by "\r". Enter the AT string with the phone number to dial. Spaces and dashes will have no effect. Use a comma to insert a pause. Be sure to include 9 for an outside line if necessary, and the full number required to dial. Not currently used Enter text that will be returned by the server for an input prompt. Often this will be the word "Login", prompting the user to enter a username. The string is case sensitive, so it is recommended to leave off the initial "L" since some servers will return "login" and others "Login:" etc. Enter text to be sent by the APEX to the server in response to the Prompt 1. This is case sensitive and should be the user name allowed by the server for this APEX. Enter text that will be returned by the server for a second input prompt. Often this will be the word "Password", prompting the user to enter a username. The string is case sensitive. Enter text to be sent by the APEX to the server in response to the Prompt 2. This is case sensitive. Enter text that will be returned by the server for a third input prompt. The string is case sensitive. Any of the Prompt and Response parameters can be left blank if not required by the dial-in server. Enter text to be sent by the APEX to the server in response to the Prompt 3. Arcom Control Systems 45

52 This is case sensitive. Master Network TimeToLive Connect Retry Count Enter the Time to Live (in seconds) for this connection. The Time to Live is the amount to keep the session alive without data traffic before closing the connection. The TimeToLive allows the connection to be closed after a period of silence. However, the PPP object TimeToDie will force the connection closed automatically regardless of data traffic. Enter the number of retry attempts to dial-in to the server. Once configured, select Close. 46 Arcom Control Systems

53 3.6.2 PPP Authentication The PPP Authentication configuration defines the physical PPP connections for the APEX unit. If the PPP Server does not require authentication, this object should be omitted from the configuration. To add a PPP port to the Networks configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this port Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required as only a single PPP Authentication object can be associated to a PPP Port. Displays the download file created for this object as ATHPPPa where a = parent instance number of the PPP Port For example: PPP Port 0 Authentication object = ATHPPP0 Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Arcom Control Systems 47

54 Enter the details for the PPP Authentication object and select Add. The example shows a typical configuration. To define the properties of the PPP Authentication, right click on the object icon and select Properties. An example is displayed below. Object Name Enabled Authentication Type Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the dropdown menu the type of PPP 48 Arcom Control Systems

55 Authentication required by the PPP server. Authentication types are: PAP Authentication CHAP Authentication User Name Password Authentication Tries Authentication Timeout Enter the user name required by the PPP server authentication. This is case sensitive. Enter the password required by the PPP server authentication. This is case sensitive. Enter the number of times to attempt authentication. Enter the timeout (in seconds) that the APEX will wait for confirmation of the authentication request. Once configured, select Close. Arcom Control Systems 49

56 3.7 ACE Configuration Layout - Networks Once the Networks configuration has been completed, the ACE configuration tool will display the configuration as shown below Close the Networks 'tree' by selecting the icon. 50 Arcom Control Systems

57 CHAPTER 4 4 Client Services The Client Services configuration defines the connection between the APEX unit and the associated field units. The APEX unit shall be the master on each of the links. To define the properties of the Client Services, right click on the icon and select Properties. Enabled Enter a 'Yes' to for the object to be enabled or 'No' to disable the object. Once configured, select Close. Arcom Control Systems 51

58 Not all Client services are supported in all APEX systems. The Clients supported are displayed on the tool bar when the icon is selected. These are is a place holder for graphical clarity on the ACE tool, and contains the individual Master Channel definitions. is used to define the local LCD/Keypad interface properties. is a place holder for graphical clarity on the ACE tool, and contains the definition of HART Commands used by APEX. is used to define a Publish object, for publishing data to a broker. Some systems support the Arcom publishing protocol, and some support the MQIpdp publishing protocol, and some do not support publishing at all. is used to define a Terminal Client object. Is used to define an SNTP Time Sync object. 52 Arcom Control Systems

59 4.1 Master Channels Identifier The Master Channels Identifier is a placeholder for graphical clarity on the ACE tool to allow the addition of Master Channels. To add the Master Channels Identifier to the Client Services configuration, select the Client Services icon and click on the following button on the toolbar: The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this port. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. It is recommended that this object be named 'Master Channels'. No instance number is required as no download file is created for the object. Displays 'DataCons'; however, no download file is created for this object. Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. To define the properties of the Master Channels Identifier, right click on the object icon and select Properties. Arcom Control Systems 53

60 Master Channels Enabled Select from the dropdown menu 'YES' for the object to be enabled or 'No' to disable the object. Once configured, select Close. The Master Channels Identifier devices currently supported are displayed on the tool bar when the icon is selected. These are is a Master Channel logical communication link is an Internal Channel (ISaGRAF) logical communication link is a link between ISaGRAF data packet and a Broker. 54 Arcom Control Systems

61 4.2 Master Channel Configuration The Master Channel configuration defines the logical links to the field units that may be over one of the available serial Async connections. Each channel is attached to a previously configured Network port. To add a Master Channel to the Client Services configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this port. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number for this Master Channel between 0 and 15. The Instance Numbers are also used by Internal Channels, and must be unique for all channels. Displays the download file created for this object as MastChanaa where aa = instance number For example: instance number 0 = MastChan00 instance number 1 = MastChan01 Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Arcom Control Systems 55

62 Enter the details for the Master Channel and select Add. To define the properties of the Master Channel, right click on the object icon and select Properties. Object Name Enabled Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. 56 Arcom Control Systems

63 Name Channel Type Auto Start Response Timeout Broadcast Delay Interpoll delay Scan Period Network Recovery Scan Table Enter the Master Channel name. This is the name which appears in Serial MMI when viewing diagnostics. Select from the drop down menu the channel type. Channel types supported are: Direct Master. Select from the drop down menu the automatic polling required Automatic polling types supported are 'Yes' polling started automatically, 'No' - polling started manually, and 'Link Based Poll' polling started only once a P/R connection has been made from an HCP. Enter the response timeout in milliseconds. Time in milliseconds to wait for a poll response before declaring the message failed. Enter the broadcast delay in milliseconds. Delay in milliseconds after broadcast command before normal polling resumes. Enter the interpoll delay in milliseconds. Time in milliseconds to wait between each poll. Enter the scan period in seconds. The period in seconds at which the channel will restart the scan table sequence. If the total time for a given channel exceeds the scan period, the next scan shall be scheduled immediately. Time period to wait after an RTU fails, before attempting to re-establish communications with that RTU. Enter the network recovery period in seconds. Select from the dropdown menu the expandable scan table and complete fields. Unit Address - This is the Field Unit Address as configured in each field unit on this Channel. If the list of last Unit Address in a table is -1, the Scan Period will be ignored for the Channel. Poll Record - This is the row number in the Poll Record for each poll defined for each Field Unit on this Channel. The first row in a Poll Table is referenced as record 1. Only those polls which are to be polled continuously by the APEX need to be listed in this Scan Table. Arcom Control Systems 57

64 The field units are polled in accordance with the scan table and scan period configured for the Master Channel. A completed scan table is as follows: In this example, it is assumed that at least two Field Units are configured under the Master Channel (and Circuit definition). These Field Units have addresses 1 and 2, and have at least three and two Poll Records defined, respectively. For instance, the Field Units might be Modbus devices with the following poll records defined: Unit Address Poll Record Poll Table Definition Comment 1 1 Request 10,001-10,020 In this example, this is a highly critical set of digital inputs; therefore, the Scan Table polls these registers every other poll. 2 Request 30,001-30,004 3 Request 40,001-40, Request 30,001-30,004 This is the first poll record for the second Field Unit. 2 Request 41,001-41,003 The polls will be sent out in the following sequence: Unit 1, Record 1 Unit 1, Record 2 Unit 1, Record 1 Unit 1, Record 3 Unit 1, Record 1 Unit 2, Record 1 Unit 1, Record 1 Request 10,001-10,020, followed by Interpoll Delay Request 30,001-30,004, followed by Interpoll Delay Request 10,001-10,020, Interpoll Delay Request 40,001-40,010, Interpoll Delay Request 10,001-10,020, Interpoll Delay Request 30,001-30,004, Interpoll Delay Request 10,001-10,020, Interpoll Delay 58 Arcom Control Systems

65 Unit 2, Record 2 Scan Period delay Unit 1, Record 1 Unit 1, Record 2 etc. Request 41,001-41,003, Interpoll Delay (remainder of Scan Period time, assuming preceding polls occurred within the configured Scan Period) Request 10,001-10,020, followed by Interpoll Delay Request 30,001-30,004, Interpoll Delay Once configured, select Close. The Master Channel devices currently supported are displayed on the tool bar when the icon is selected. These are is an Async circuit to one or more field units from a common Master Channel. is a network circuit to one or more field units from a common Master Channel. is a HART Circuit to one or more HART protocol devices. Arcom Control Systems 59

66 4.2.1 Async Circuit An Async circuit is a unique serial communications path to one or more field units from a common Master Channel. To add an Async circuit to the Master Channel configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Displays the parent for this object. Enter a unique name for this circuit Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number for this Async Circuit. The instance number is next sequential number, starting from zero on each Master Channel, corresponding to the number of circuits on this channel. The Instance Numbers are also used by HART Circuits, and must be unique for all circuits on this Master Channel. Displays the download file created for this object as Ciraabb where aa = parent Master Channel instance number bb = Async Circuit instance number For example: master channel 0 circuit 0 = Cir0000 master channel 2 circuit 1 = Cir Arcom Control Systems

67 Help Text Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the Async circuit and select Add. To define the properties of the Async circuit, right click on the object icon and select Properties. Object Name Enabled Circuit Type Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the drop down menu the circuit type. Arcom Control Systems 61

68 Async circuit types supported are: Direct Circuit. Primary Port Secondary Port Redundancy Select from the drop down menu the primary physical communication port for this circuit. Physical ports COM 0 11 are available. It is typical to reserve COM 0 for the SLIP, COM 1 for Serial MMI, COM 2 for Modbus Slave/ISaGRAF; leaving COM 3 and higher for Master Channels or additional Slave Channels. Select from the drop down menu the secondary physical communication port for this circuit if redundancy is required. Secondary port must be the next sequential port number with respect to the primary port. Select from the drop down menu the redundancy configuration required for the primary and secondary ports. Redundancy configurations supported are: 'Dedicated Line Circuit' primary port only configured, with no redundancy 'Alternating Redundancy' primary and secondary ports configured with polling alternating between the two ports. Once configured, select Close. The Async circuit device currently supported is displayed on the tool bar when the icon is selected. This is is a Modbus field unit 62 Arcom Control Systems

69 4.2.2 Network Circuit A network circuit is a unique Ethernet communications path to one or more field units from a common master channel. To add a network circuit to the master channel configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this circuit. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number. The instance number is the next sequential number, starting from zero, corresponding to the number of circuits on this channel. Displays the download file created for this object as Ciraabb where aa = master channel instance number bb = instance number For example: master channel 0 instance number 0 = Cir0000 master channel 2 instance number 1 = Cir0201 Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Arcom Control Systems 63

70 Enter the details for the network circuit and select Add. To define the properties of the network circuit channel, right click on the object icon and select Properties. Object Name 64 Arcom Control Systems

71 Enabled Circuit Type Master Network IP Master Network Port Master Network Time To Live Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the drop down menu the circuit type. Network circuit types supported are: Network Circuit. Enter the IP address that the APEX unit will connect to. The IP address must be in the same IP network or connected via the default gateway configured in the Ether port configuration.. Enter the port address that the APEX unit will connect to. Enter the inactivity period for the connection before the APEX unit will disconnect. Inactivity period in seconds. Once configured, select Close. The network circuit devices currently supported are displayed on the tool bar when the icon is selected. These are is a Modbus field unit Arcom Control Systems 65

72 4.2.3 Modbus Field Unit A Modbus Field Unit object contains unique information for each Modbus field unit and defines parameters for how data is read and written for each field unit. The object properties allow the APEX database to be configured for 32-bit IEEE and long integer data as well as standard Boolean or 16-bit registers. To add a Modbus Field Unit to the Async circuit, select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Displays the parent for this object. Enter a unique name for this field unit. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number between 0 and 255. By convention, the instance number should be identical to the Field Unit's unit address. The Unit Address (and hence the Instance Number) must be unique for every unit on a Master Channel. Note: Uniqueness for Field Units on two different circuits under one Master Channel is not enforced by ACE, but is required for proper system operation. Displays the download file created for this object as osaabbcccc 66 Arcom Control Systems

73 where aa = parent Master Channel instance bb = parent Circuit instance cccc = Field Unit instance number For example: master channel 0 Circuit 0 instance 0 = os master channel 1 Circuit 2 instance 1 = os master channel 2 Circuit 0 instance 3 = os Help Text Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the Modbus field unit and select Add. To define the properties of the Modbus field unit, right click on the object icon and select Properties. Object Name Arcom Control Systems 67

74 Enabled Unit Name Unit Address Protocol Com Retries 1st Comm Status Holdreg Not Used Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Enter the field unit name. Unit name is displayed in diagnostic menus. Enter the actual field unit address which is configured in the third-party Field Unit. Valid addresses 1 to 255. Select from the drop down menu the field unit protocol type. Protocol types supported are: 'Binary Modbus 32 Unit' -- Modbus RTU (or Modbus Binary) protocol, which supports 16-bit or 32-bit data types. 'ASCII Modbus 32 Unit' -- Modbus ASCII protocol, which supports 16-bit or 32-bit data types. (Note: not all executables support ASCII Modbus) Enter the number of communication retries. If a poll attempt fails, the APEX will issue the poll again up to the configured number of "Com Retries" before the field unit is declared failed. Enter the starting holding register in the Status/Control field unit to contain the communication status for this field unit. Each Comm Status takes 5 registers, beginning at the register configured in this parameter. See Section 4.3.5, Status/Control Field Unit, for a description of the five Comm Status Register contents. This option is unused, and is retained only for compatibility with other systems. 68 Arcom Control Systems

75 Poll Table Select from the dropdown menu the expandable scan table and complete fields. Source Register Enter the source register to begin polling from the field unit. Source Format - Enter the data type of the data being requested. Valid data types are Boolean - Binary (single bit) register 16 bit register (HL) - Big Endian 16-bit register. 32 bit register (hlhl) - Little-Big Endian 32-bit register 16 Bit Pair L/B Endian (hl HL) - Little-Big Endian 16-bit pair of registers. First register contains Leastsignificant Word (LSW), and the second register contains Most-significant Word (MSW), both in Big Endian format The above data types are the standard representations used for storing data in the APEX real-time databases and for standard Modbus protocol. The remainder of the data types may be required for non-standard Modbus devices that store data in different formats. 32 Bit L/L Endian (lhlh) - Little-Little Endian 32-bit register 32 Bit B/L Endian (LHlh) - Big-Little Endian 32-bit register 32 Bit B/B Endian (HLhl) - Big-Big Endian 32-bit register 16 Bit L Endian (LH) - Little Endian 16-bit register 16 Bit Pair L/L Endian (lh LH) - Little-Little Endian 16-bit pair of registers. First register contains LSW, second register contains MSW, both in Little Endian format. 16 Bit Pair B/L Endian (LH lh) - Big-Little Endian 16-bit pair of registers. First register contains MSW, second register contains MSW, both in Little Endian format. 16 Bit Pair B/B Endian (HL hl) - Big-Big Endian 16-bit pair of registers. First register contains MSW, second register contains LSW, both in Big Endian format. Count Enter the number of registers to poll. The maximum number allowed is 2000 Boolean registers, Arcom Control Systems 69

76 125 registers (16-bit), or 62 registers (32-bit). If floating point or long integer values are being requested that occupy 16-bit pairs of registers, the Count must include 2 registers for each register pair. Destination Register Enter the destination register within the field unit RTDB (Real Time Data Base) to start to place the polled data. Booleans must be stored into Boolean RTDB registers. 16-bit values must be stored into 16-bit RTDB registers. Values are stored in Big Endian format. 32-bit values must be stored into 32-bit RTDB registers. Values are stored in Little-Big Endian format. 16-bit pair registers (32-bit values) should usually be stored into 32-bit RTDB registers; however, they may also be stored into 16-bit RTDB registers. Values are stored in Little-Big Endian format. The Poll Table defines the data types of registers to be accessed in the external field unit, both for reading from and writing to the field unit. To configure the APEX to continuously poll a field unit for data, the polls must be defined under the Field Unit Poll Table, and they must also be listed in the Master Channel Scan Table. In some cases a host system may need to write to a register that is not directly read by the APEX. If the registers to be written to are in Standard Modbus format (Boolean or 16-bit big-endian Integer), a Poll Table record does not need to be configured in order to write to registers of the Field Unit. If any other data type is used (32-bit registers, 16-bit register pairs, or 16-bit Little-Endian), a poll record must be defined so that the protocol driver knows what data format to use for writing data to the device. If records are configured in the Poll Table for registers that are Write-Only, those polls need not be configured in the Channel's Scan Table. Once configured, select Close. 70 Arcom Control Systems

77 For example, the following configuration will poll a Modbus field unit with a unit address of 1. The communication status registers for this field unit are 40,101-40,105. The following polls will be sent to the field unit. Source Registers in Field Unit Destination Registers in APEX Explanation 00,011-00,110 00,001-00, Boolean coil registers are read and stored in the Modbus RTDB starting at Coil 00, ,001-10,020 10,001-10, Boolean status registers are read and stored. 30,001-30,015 30,120-30, integers (16-bit Big Endian) are read and stored in the Modbus RTDB starting at register 30, ,002-41,041 41,001-41,020 In this example, assume the source registers contain 20 numeric values that are 32-bit entities (floating point or long integer), and are stored in the field unit as 16-bit register pairs. 40 registers must be read in order to get the 20 values. The Modbus RTDB is defined such that 41,001-41,020 are 32-bit registers, so the data acquired from the field unit occupies only 20 of these destination registers. Arcom Control Systems 71

78 43,001-43,010 41,021-41,030 In this example, the source registers and the destination registers are each 32-bit entities (Little-Big Endian), so the 10 registers are read directly and mapped into the APEX RTDB starting at 41, ,001-47,010 41,031-41,040 In this example, the source registers are 32-bit entities (Big-Big Endian). The poll definition changes the word order of the received data so that data is stored in the Modbus RTDB in the APEX standard format (Little-Big Endian). The Modbus field unit devices currently supported are displayed on the tool bar when the icon is selected. These are is a Modbus RTDB (Real Time Data Base) Is an SOS which allows polling to be modified using ACE instead of ISaGRAF programming 72 Arcom Control Systems

79 4.2.4 RTDB (Real Time DataBase) An RTDB (Real Time DataBase) defines the size of the virtual database reserved for the field unit. The Modbus field unit objects require a child RTDB in order to function properly. To add an RTDB to any of the Field Unit definitions select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this RTDB Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required, as only a single RTDB can be associated to a field unit. Displays the download file created for this object as Rtaabbcccc where aa = parent Master Channel instance bb = parent Circuit instance cccc = parent field unit instance For example: master channel 0 Circuit 0 field unit 1 = Rt master channel 2 Circuit 1 field unit 3 = Rt Enter any text describing this object. Text entered here is displayed at the bottom of the ACE Arcom Control Systems 73

80 configuration screen when the object is selected. Enter the details for the RTDB and select Add. To define the properties of the Real-time Database, right click on the object icon and select Properties. Object Name 74 Arcom Control Systems

81 Enabled Database Definition Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the dropdown menu the expandable database definition and complete fields. Point Count Enter the number of variables for this type to be allocated space in the database. Field Format Enter the variable format BOOL - Boolean UINT8 - Unsigned 8-bit integer (0 to 255) SINT16 - Signed 16-bit integer (-32,768 to 32,767) UINT16 - Unsigned 16-bit integer (0 to 65,535) SINT32 - Signed 32-bit long integer UINT32 - Unsigned 32-bit long integer REAL32 - IEEE floating point (32-bit) Data Address Enter the Modbus address of the initial variable within the RTDB. Note: Items in the RTDB Database definition must be defined with the following constraints: 1) At least one section must be defined; 2) Modbus addresses in the RTDB must not overlap; 3) Booleans may only be defined in the range of 1 to 19,999; 4) Integer and Floating point registers may only be defined in the range of 30,001 to 49,999. Important: The RTDB must contain enough registers of the correct data types to store all the data returned by the command(s) for that Field Unit. Once configured, select Close. Arcom Control Systems 75

82 For example The RTDB (Real Time DataBase) devices currently supported are displayed on the tool bar when the icon is selected. These are is a Deadband object.. 76 Arcom Control Systems

83 4.2.5 Deadband Object A Deadband object defines the deadbands for the variables configured within the RTDB unit. This is only used to reduce the communications traffic on an RBE connection. If no RBE connection is configured, an RTDB does not require a deadband field unit. To add a deadband field unit to the RTDB select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this deadband field unit Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required as only a single deadband field unit can be associated to a RTDB. Displays the download file created for this object as dbaabbcccc where aa = parent master channel instance number bb = parent circuit instance number cccc = parent binary Modbus field unit instance For example: master channel 0 Async circuit 0 field unit 0 = db master channel 1 Async circuit 2 field unit 1 = db master channel 2 network circuit 0 field unit 3 = db Enter any text describing this object. Arcom Control Systems 77

84 Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the RTDB and select Add. To define the properties of the binary Modbus field unit, right click on the object icon and select Properties. Object Name 78 Arcom Control Systems

85 The defaults displayed are Enabled Deadband Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the dropdown menu the expandable deadband definition and complete fields. Field row number, detailed in the RTDB, containing the datapoint. Rows start at 1. Offset offset into data point address referenced in the field. Count number of data points that the deadband limit will be applied to. Value deadband value. Once configured, select Close. Arcom Control Systems 79

86 For example 80 Arcom Control Systems

87 4.2.6 SOS (Specific Out Station)Object The SOS object contains additional features specific to particular Field Unit protocols. This section describes the SOS object for Modbus units. The Modbus SOS object is a powerful, complex tool which allows a user to modify the polling protocol based on results of preceding polls, or based on controls from a Modbus host or ISaGRAF. Criteria can be specified which, if true, cause the polls defined in the Modbus Poll Table to be modified or skipped. This is useful in certain applications, such as reading log data from some Modbus flow computers. This feature is referred to as "self-modifying polls". To add an SOS object, click on the following icon The configuration for this new object will be displayed as Parent New Object Name Instance Number DownLoad File Displays the parent for this object. Enter a unique name for this SOS Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required, as only a single SOS can be associated to a field unit. Displays the download file created for this object as SOSaabbcccc where aa = parent Master Channel instance Arcom Control Systems 81

88 bb = parent Circuit instance cccc = parent field unit instance For example: master channel 0 Circuit 0 field unit 1 = SOS master channel 2 Circuit 1 field unit 3 = SOS Help Text Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter details for the SOS object and select Add. To define the properties of the SOS, right click on the object icon and select Properties. Object Name Double click on the Properties Edit List / Table to bring up the following edit table: 82 Arcom Control Systems

89 The following table explains how to use these parameters. Poll Index Trig. Addrs Trig. Value Tx Start Byte Tx #Bytes Filled Fill from Addrs Fill Control This refers to the poll numbers defined in the Field Unit Poll Table. The poll message whose number appears in this row will be modified as specified in the remainder of this row. If several rows refer to the same poll number, all modifications will be evaluated before modifying this poll transmit message, in case one condition specifies no modification. This is the Modbus address location in this RTU s RTDB which will contain (or not) the exact trigger value as specified in the Trig value parameter field. If the specified trigger value is indeed found in this location, then the modification of this poll message will take place. (Unless another line refers to same poll but results in no modification. If ISaGRAF is not used to put the value in that location, then it is assumed that polling the RTU resulted in the trigger address location containing the trig. value. This is the value which, if found at the Trig Addrs. location, will cause the transmit message modification to take place. This value may be between 0 and inclusive. This specifies which byte in the poll command to be transmitted is the first byte to be modified as specified in the remaining parameters. Valid byte numbers in a Modbus poll command start with 1, which is the address byte. This specifies how many bytes in the poll command are to be modified starting at the Start Byte. This Modbus location in the RTDB should contain the bytes to use when replacing the bytes to be modified in the poll transmit message. Either ISaGRAF or an external host fill the required values in this location(s), or the RTU being polled must be the source of these fill bytes. This parameter allows certain variations when executing the self-modifying poll. Options available for this parameter are: No Conversion - Bytes from the Fill from Addrs registers are used with no conversion, as 16-bit values. NOTE: Because of the Little Endian byte order in the RTDB, when using No Conversion the LSB is used first in the modified Modbus poll. If this byte order need to be reversed, use the Byte Swapping option instead. Byte Swapping - Sometimes the bytes being put from the RTDB into the Arcom Control Systems 83

90 transmit message must be swapped high byte for low byte, etc. This parameter allows you to specify this option if desired. Skip MSB - Use this if the Fill from Addrs register contains an 8-bit value rather than a 16-bit value, so that the most-significant byte is omitted. Validate Receive Bytes Received Skip Entire Poll - Selecting this option causes the poll not to be sent, rather than sending it with modified bytes. When selecting this option, the values in this row of the Poll Modification Def must be set to dummy values but will not be used. Indicates whether to check the number of received bytes based on the bytes expected from the Modbus poll. Currently this option is unused. The byte count (3rd byte in receive) is checked for all received messages, and the number of receive bytes can be anything as long as the checksum is correct at the end. Enter the Modbus address into which you want put the byte length of the response. This is very useful if your command is requesting data of unknown length such as all alarms, etc. You will know how many bytes were returned in response to your command by looking at this address for the value stored there. Example Following is an example of the self-modifying poll feature: A Modbus Field Unit is defined with the following polls, which would typically generate the Modbus messages indicated (values in hexadecimal). Poll Source Format Count Destination Generates Poll Message Index Register Register 1 42, bit register 10 42, A + checksum 2 40, bit register 2 40, checksum Next the Modbus SOS object is configured as follows: Poll 1 When the Modbus register 10,100 is set and the Channel tries to send Poll Index 1, the configured poll will be modified. Bytes 5-6 of the Modbus poll are the number of registers to read, which will now be taken from register 40,201 instead of the default count of 10. For this example, consider that register 40,201 contains a value of 8 (0x0008). Because "Byte Swapping" is selected, the 84 Arcom Control Systems

91 modified byte 5 is the MSB (0x00) and the modified byte 6 is the LSB (0x08). The poll number 1 is modified as follows: Original poll: A + checksum Modified to: checksum Poll 2 When the Modbus register 40,001 is set to a value of 20 and the Channel tries to send Poll Index 2, the configured poll will be modified. Bytes 3-6 of the Modbus poll are now modified, with the values taken from register 40,210-40,211. For this example, consider that register 40,210 contains a value of 5637 (0x1605) and register 40,211 contains 2816 (0x0B00). Because "No Conversion" is selected, the LSB of each register is used first. The poll number 2 is modified as follows: Original poll: checksum Modified to: B + checksum Note: More than one condition can be satisfied simultaneously to modify the same poll. If more than one condition are satisfied at the same time so that the same bytes in a poll would be modified, the last condition in the list takes precedence. However, if the "Skip Entire Poll" condition is satisfied, it takes precedence over all other conditions and causes the poll not to be sent. Once configured, select Close. Arcom Control Systems 85

92 4.3 Internal Channel Configuration The Internal Channel configuration defines virtual field units within an APEX that may be an ISaGRAF, Status/Control, Virtual, or Segment field unit. The Internal Channel configuration and its 'child' objects are very similar to the Master Channel and its 'child' objects. To add an Internal Channel to the Master Channels Identifier configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Displays the parent for this object. Enter a unique name for this Internal Channel Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number for the Internal Channel between 0 and 15. Only one Internal Channel is allowed in a configuration. The Instance Numbers are also used by Master Channels, and must be unique for all channels. Displays the download file created for this object as MastChanaa where aa instance number For example: 86 Arcom Control Systems

93 instance number 0 = MastChan00 instance number 1 = MastChan01 Help Text Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the Internal Channel and select Add. To define the properties of the Internal Channel, right click on the object icon and select Properties. Object Name Arcom Control Systems 87

94 Enabled Name Channel Type Auto Start Response Timeout Broadcast Delay Interpoll delay Scan Period Network Recovery Scan Table Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Enter the Internal Channel name. This is the name which appears in Serial MMI when viewing diagnostics. Select from the drop down menu the channel type. Channel types supported are: Internal Channel. Select from the drop down menu the automatic polling required Automatic polling types supported are 'Yes' polling started automatically, 'No' - polling started manually through Serial MMI. Enter the response timeout in milliseconds. This should be for the Internal Channel. Enter the broadcast delay in milliseconds. Delay in milliseconds after broadcast command before normal polling resumes. Enter the interpoll delay in milliseconds. Time in milliseconds to wait between each poll. Enter the scan period in seconds. The period in seconds at which the channel will restart the scan table sequence. If the total polling time for a channel exceeds the scan period, the next scan shall be scheduled immediately. Enter the network recovery period in seconds. Time period in seconds to wait after an entire channel failure before attempting to re-establish communications. Select from the dropdown menu the expandable scan table and complete its fields. The Scan Table determines which of the configured poll records (defined under the ISaGRAF field unit) will be used, and in what order. Unit Address - Enter the Modbus address of the ISaGRAF field unit to be polled. If the list of last Unit Address in a table is -1, the Scan Period will be ignored for the Channel. 88 Arcom Control Systems

95 Poll Record - This is the row number in the Poll Record for each poll defined for the ISaGRAF unit. The first row in a Poll Table is referenced as record 1. Only those polls which are to be polled continuously by the APEX need to be listed in this Scan Table. See Section 4.3.2, ISaGRAF Field Unit. Once configured, select Close. Arcom Control Systems 89

96 The Internal Channel devices currently supported are displayed on the tool bar when the icon is selected. These are is a Virtual Circuit to one ISaGRAF Field Unit from an Internal Channel is a Null Circuit to Status/Control, Virtual, and/or Segment Field Unit from an Internal Channel 90 Arcom Control Systems

97 4.3.1 Virtual Circuit Configuration A Virtual Circuit is a unique communications path to only one ISaGRAF field unit from a common Internal Channel. To add a Virtual Circuit to the Internal Channel configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Displays the parent for this object. Enter a unique name for this circuit Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number between 0 and 1. The instance number is the next sequential number, starting from zero on each Internal Channel, corresponding to the number of circuits on that channel. Instance Number for the Virtual Circuit must be unique from any Null Circuit defined on the channel. Only one Virtual Circuit is allowed in a configuration. Displays the download file created for this object as Ciraabb where aa = parent Internal Channel instance number bb = Virtual Circuit instance number For example: internal channel 0 circuit 0 = Cir0000 internal channel 2 circuit 0 = Cir0200 Arcom Control Systems 91

98 Help Text Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the Virtual Circuit and select Add. To define the properties of the Virtual Circuit, right click on the object icon and select Properties. Object Name Enabled Circuit Type Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the drop down menu the circuit type. Circuit types supported are: Virtual Circuit. 92 Arcom Control Systems

99 Once configured, select Close. Arcom Control Systems 93

100 The Virtual Circuit devices currently supported are displayed on the tool bar when the icon is selected. These are is an ISaGRAF field unit for use with internal programming 94 Arcom Control Systems

101 4.3.2 ISaGRAF Field Unit An ISaGRAF Field Unit object contains unique information for the ISaGRAF logic program running in the APEX and defines parameters for how data is read and written for the ISaGRAF unit. The object properties allow the APEX database to be configured for 32-bit IEEE and long integer data as well as standard Boolean or 16-bit registers. Important: In order for the ISaGRAF Workbench to download and monitor programs, a Slave Channel must be defined with this ISaGRAF unit as an attach list. See Sections and To add an ISaGRAF Field Unit to the Virtual Circuit, select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Displays the parent for this object. Enter a unique name for this field unit. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number (typically zero). Only one ISaGRAF field unit is allowed under a Circuit. Displays the download file created for this object as osaabbcccc where Arcom Control Systems 95

102 aa = parent Internal Channel instance bb = parent Circuit instance cccc = ISaGRAF instance number For example: channel 1 Circuit 0 instance 0 = os Help Text Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the ISaGRAF field unit and select Add. To define the properties of the ISaGRAF field unit, right click on the object icon and select Properties. Object Name 96 Arcom Control Systems

103 Enabled Unit Name Unit Address Protocol Com Retries 1st Comm Status Holdreg Not Used Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Enter the field unit name. Unit name is displayed in diagnostic menus. Enter the actual field unit address which will be used in the ISaGRAF Field Unit. This determines the Modbus slave address at which the ISaGRAF workbench will communicate to the logic program. Valid addresses 1 to 255. Typically address 1 will be used. Select from the drop down menu the field unit protocol type. Protocol types supported are: ISaGRAF Logic Unit. Enter the number of communication retries. If a poll attempt fails, the APEX will issue the poll again up to the configured number of "Com Retries" before the field unit is declared failed. Enter the starting holding register in the Status/Control field unit to contain the communication status for this field unit. Each Comm Status takes 5 registers, beginning at the register configured in this parameter. See Section 4.3.5, Status/Control Field Unit, for a description of the five Comm Status Register contents. This option is unused, and is retained only for compatibility Arcom Control Systems 97

104 with other systems. Leave this at the default 'N/A' value. Poll Table Select from the dropdown menu the expandable poll table and complete fields. Source Register Enter the source register to begin polling from the field unit. Source Format - Enter the data type of the data being requested. Valid data types are Boolean - Binary (single bit) register 16 bit register (HL) - Big Endian 16-bit register. 32 bit register (hlhl) - Little-Big Endian 32-bit register 16 Bit Pair L/B Endian (hl HL) - Little-Big Endian 16-bit pair of registers. First register contains Leastsignificant Word (LSW), and the second register contains Most-significant Word (MSW), both in Big Endian format 32 Bit L/L Endian (lhlh) - Little-Little Endian 32-bit register 32 Bit B/L Endian (LHlh) - Big-Little Endian 32-bit register 32 Bit B/B Endian (HLhl) - Big-Big Endian 32-bit register The 32 Bit B/B Endian (HLhl) is recommended to use with the ISaGRAF RTU because of its byte order, to ensure compatibility with other Modbus types. However, the byte order for polling should be chosen so that the Slave Channel presents data to the Modbus host in its required byte order. 16 Bit L Endian (LH) - Little Endian 16-bit register 16 Bit Pair L/L Endian (lh LH) - Little-Little Endian 16-bit pair of registers. First register contains LSW, second register contains MSW, both in Little Endian format. 16 Bit Pair B/L Endian (LH lh) - Big-Little Endian 16-bit pair of registers. First register contains MSW, second register contains MSW, both in Little Endian format. 16 Bit Pair B/B Endian (HL hl) - Big-Big Endian 16-bit pair of registers. First register contains MSW, second register contains LSW, both in Big Endian format. 98 Arcom Control Systems

105 Count Enter the number of registers to poll. The maximum number allowed is 2000 Boolean registers, 125 registers (16-bit), or 62 registers (32-bit). If floating point or long integer values are being requested that occupy 16-bit pairs of registers, the Count must include 2 registers for each register pair. Destination Register Enter the destination register within the field unit RTDB (Real Time Data Base) to start to place the polled data. Booleans must be stored into Boolean RTDB registers. 16-bit values must be stored into 16-bit RTDB registers. Values are stored in Big Endian format. 32-bit values must be stored into 32-bit RTDB registers. Values are stored in Little-Big Endian format. 16-bit pair registers (32-bit values) should usually be stored into 32-bit RTDB registers; however, they may also be stored into 16-bit RTDB registers. Values are stored in Little-Big Endian format. The Poll Table defines the data types of registers to be accessed in the ISaGRAF field unit, both for reading from and writing to the field unit. To configure the APEX to continuously poll ISaGRAF for data, the polls must be defined under the Field Unit Poll Table, and they must also be listed in the Master Channel Scan Table. In some cases a host system may need to write to a register that is not directly read by the APEX. If the registers to be written to are in Standard Modbus format (Boolean or 16-bit Big-Endian Integer), a Poll Table record does not need to be configured in order to write to registers of the Field Unit. If any other data type is used (32-bit registers, 16-bit register pairs, or 16-bit Little-Endian) such as a FLOAT32 or HOLD32 board, a poll record must be defined so that the protocol driver knows what data format to use for writing data to the device. If records are configured in the Poll Table for registers that are Write-Only, those polls need not be configured in the Channel's Scan Table. Once configured, select Close. Arcom Control Systems 99

106 The ISaGRAF field unit devices currently supported are displayed on the tool bar when the icon is selected. These are is a Modbus RTDB (Real Time Data Base) is a Load/Store object. This defines a separate file with default values for an ISaGRAF Load/Store board. 100 Arcom Control Systems

107 4.3.3 Load/Store ISaGRAF Defaults A Load/Store object defines a separate download file, containing 16 parameters used by the ISaGRAF STORE16 and STORE32 boards. The STORE boards are pseudo boards containing variables that are stored in the APEX Flash file system (see the ISaGRAF OEM Manual for more details on these boards). When a variable in the STORE16 or STORE32 board is written to, ISaGRAF automatically creates a file in the file system with the name lsaabbcccc (first character is the letter "L"), where aabbcccc is identical to the ISaGRAF file isaabbcccc. Sometimes it is desirable to have unit defaults defined in the ACE configuration, so that the ISaGRAF application can be generic and yet operate differently on different individual units. Defining this lsaabbcccc file in ACE accomplishes this requirement. To add a Load/Store object to the ISaGRAF Field Unit select the icon The configuration for this new object shall be defined as Parent New Object Name Instance Number DownLoad File Displays the parent for this object. Enter a unique name for this Load/Store object Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required, as only a single Load/Store object can be associated to an ISaGRAF field unit. Displays the download file created for this object as Arcom Control Systems 101

108 lsaabbcccc where aa = parent Master Channel instance bb = parent Circuit instance cccc = parent field unit instance For example: channel 0 Circuit 0 field unit instance 0 = ls Help Text Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the Load/Store object and select Add. To define the properties of the Load/Store defaults, right click on the object icon and select Properties. Object Name 102 Arcom Control Systems

109 Enabled Parameter Table Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the dropdown menu the expandable database definition and complete fields. Parameter 1 through Parameter 16 Enter the value for each parameter defined in the ISaGRAF STORE16 or STORE32 board. Multiple rows can be defined in the Parameter Table to correspond to multiple instances of the STORE boards (in the order of instances defined in the ISaGRAF application). After saving the configuration, the isaabbcccc file will be created in both the Download directory and the UFF directory for this configuration. Be sure to download this Load/Store file along with configuration file. Once configured, select Close. Arcom Control Systems 103

110 4.3.4 Null Circuit Configuration A Null Circuit is a unique communications path to one or more Status/Control, Virtual, or Segment field units from a common Internal Channel. To add a Null Circuit to the Internal Channel configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Displays the parent for this object. Enter a unique name for this circuit Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number between 0 and 1. The Instance number is the next sequential number, starting from zero on each Internal Channel, corresponding to the number of circuits on that channel Instance Number for Null Circuit must be unique from any Virtual Circuit defined on the channel. Only one Null Circuit is allowed in a configuration. Displays the download file created for this object as Ciraabb where aa = parent Internal Channel instance number bb = Null Circuit instance number For example: internal channel 0 circuit 0 = Cir Arcom Control Systems

111 internal channel 2 circuit 1 = Cir0201 Help Text Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the Null Circuit and select Add. To define the properties of the Null Circuit, right click on the object icon and select Properties. Object Name Enabled Circuit Type Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the drop down menu the circuit type. Circuit types supported are: Null Circuit. Once configured, select Close. Arcom Control Systems 105

112 The Null Circuit devices currently supported are displayed on the tool bar when the icon is selected. These are is a Status/Control field unit for storing communication statuses for other field units. is a Virtual field unit which allows additional internal Real-time Databases to be created in the APEX. is a Segment field unit which is used to set up Segment Real-time Databases for sending RBE data to the satellite network. 106 Arcom Control Systems

113 4.3.5 Status/Control Field Unit A Status/Control Field Unit object contains unique information that is used by the APEX for internal diagnostics. Field units defined under Master Channels and an ISaGRAF field unit contain a parameter for storing communication status. All communication statuses, if configured, are stored in this Status/Control Field Unit. To add a Status/Control Field Unit to the Null Circuit configuration select the icon Important: This object must be included in the APEX configuration if any Field Unit has a valid holding register defined for Comms Status. There should be only one Status/Control Field Unit defined in the configuration. The configuration for this new object shall be displayed as Parent New Object Name Instance Number Displays the parent for this object. Enter a unique name for this field unit. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number for this Field Unit between 0 and 255. The Instance Numbers on a Null Circuit are also used by Virtual and Segment Field Units, and must be unique for all units on the circuit. Arcom Control Systems 107

114 DownLoad File Help Text Displays the download file created for this object as osaabbcccc where aa parent Internal Channel instance bb parent Circuit instance cccc - Status/Control unit instance number For example: channel 1 circuit 1 instance 2 = os Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the Status/Control field unit and select Add. To define the properties of the Status/Control field unit, right click on the object icon and select Properties. Object Name 108 Arcom Control Systems

115 Enabled Unit Name Unit Address Protocol No Comms Not Used No Polls Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Enter the field unit name. Enter the field unit address. This should be a unique address from any other ISaGRAF, Virtual, or Segment field unit addresses on the channel. Typically this is address 2. Select from the drop down menu the field unit protocol type. Protocol types supported are 'System Control & Status Unit'. This parameter is a null field to retain compatibility with other field unit objects. The only option is 'N/A'. This parameter is a null field to retain compatibility with other field unit objects. The only option is 'N/A'. This parameter is a null field to retain compatibility with other field unit objects. The only option is 'N/A'. Once configured, select Close. The Status/Control field unit devices currently supported are displayed on the tool bar when the Arcom Control Systems 109

116 icon is selected. These are is a Modbus RTDB (Real Time Data Base) 110 Arcom Control Systems

117 The first 100 holding registers in the Status/Control Field Unit are reserved for internal diagnostic storage. When defining the RTDB attached to the Status/Control Field Unit, it should be made at least large enough to include the first 100 holding registers, plus 5 registers for every field unit in the APEX configuration. Communication Status Registers The five communication status registers contain the following data: 1st Register Bit 0 Bit 1 Bit 2 2nd Register 3rd Register 4th Register 5th Register Communication status to field unit. 1 indicates good communication via any redundant circuit, 0 indicates no communication. Channel A link good (1) or bad (0). This indicates communication health over the first redundant Circuit. Channel B link good (1) or bad (0). This indicates communication health over the second redundant Circuit, if one exists on this Master Channel. Percent (%) Communication throughput to field unit. Throughput = (Total Polls - # Timeouts - # Bad Data polls) / Total Polls. Range is scaled, so that a value of 987 = 98.7 %. If a value greater than 1000 is written into the Percent Throughput register for a given field unit, the 2nd, 3rd, 4th, and 5th status registers are reset to zero for that unit. Communication statistics for all field units can be reset simultaneously by using the CLRCOMS function in ISaGRAF. Total Polls. Total number of polls sent since last restart. When this register reaches 65,000 it rolls over to zero, and the 2nd, 4th, and 5th status bytes are also reset to zero. # Timeouts. Number of polls receiving no response since last reset. # Bad Data polls. Number of CRC or data errors to polls since last reset. The RTDB for the Status/Control field unit must include an adequate number of holding registers to contain all the Comm Status registers for all field units in the APEX, and these Comm Status registers must not overlap Arcom Control Systems 111

118 4.3.6 Virtual Field Unit A Virtual Field Unit object allows additional Real-time Databases to be defined for internal storage of data used by the APEX through ISaGRAF functions. To add a Virtual Field Unit to the Null Circuit configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Displays the parent for this object. Enter a unique name for this field unit. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number for this Field Unit between 0 and 255. The Instance Numbers on a Null Circuit are also used by Status/Control and Segment Field Units, and must be unique for all units on the circuit. Displays the download file created for this object as osaabbcccc where aa parent Internal Channel instance bb parent Circuit instance cccc - Virtual unit instance number For example: 112 Arcom Control Systems

119 channel 1 circuit 1 instance 3 = os Help Text Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the Virtual field unit and select Add. To define the properties of the Virtual field unit, right click on the object icon and select Properties. Object Name Arcom Control Systems 113

120 Enabled Unit Name Unit Address Protocol No Comms Not Used No Polls Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Enter the field unit name. Enter the field unit address. This should be a unique address from any other ISaGRAF, Status/Control, or Segment field unit addresses on the channel. The default address is 3. Select from the drop down menu the field unit protocol type. Protocol types supported are 'Repository Database Unit'. This parameter is a null field to retain compatibility with other field unit objects. The only option is 'N/A'. This parameter is a null field to retain compatibility with other field unit objects. The only option is 'N/A'. This parameter is a null field to retain compatibility with other field unit objects. The only option is 'N/A'. Once configured, select Close. The Virtual field unit devices currently supported are displayed on the tool bar when the icon is selected. These are is a Modbus RTDB (Real Time Data Base) 114 Arcom Control Systems

121 4.3.7 RTDB (Real Time DataBase) An RTDB (Real Time DataBase) defines the size of the virtual database reserved for the field unit. The ISaGRAF, Status/Control, and Virtual field units require a child RTDB in order to function properly. To add a RTDB to any of the Field Unit definitions select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this RTDB Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required, as only a single RTDB can be associated to a field unit. Displays the download file created for this object as Rtaabbcccc where aa = parent Master Channel instance bb = parent Circuit instance cccc = parent field unit instance For example: channel 0 Circuit 0 field unit 1 = Rt channel 2 Circuit 1 field unit 3 = Rt Enter any text describing this object. Text entered here is displayed at the bottom of the ACE Arcom Control Systems 115

122 configuration screen when the object is selected. Enter the details for the RTDB and select Add. To define the properties of the Realtime Database, right click on the object icon and select Properties. Object Name 116 Arcom Control Systems

123 Enabled Database Definition Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the dropdown menu the expandable database definition and complete fields. Point Count Enter the number of variables for this type to be allocated space in the database. Field Format Enter the variable format BOOL - Boolean UINT8 - Unsigned 8-bit integer (0 to 255) SINT16 - Signed 16-bit integer (-32,768 to 32,767) UINT16 - Unsigned 16-bit integer (0 to 65,535) SINT32 - Signed 32-bit long integer UINT32 - Unsigned 32-bit long integer REAL32 - IEEE floating point (32-bit) Data Address Enter the Modbus address of the initial variable within the RTDB. Usually there should not be items defined in the RTDB with Point Count of zero. If items with zero Point Count exist in the default object that are not used in a particular configuration, those rows may be deleted. Note: Items in the RTDB Database definition must be defined with the following constraints: 1) At least one section must be defined; 2) Modbus addresses in the RTDB must not overlap; 3) Booleans may only be defined in the range of 1 to 19,999; 4) Integers may only be defined in the range of 30,001 to 49,999; 5) Avoid using rows with Point Count of zero. Once configured, select Close. For example Arcom Control Systems 117

124 The RTDB (Real Time DataBase) devices currently supported are displayed on the tool bar when the icon is selected. These are is a Deadband object. 118 Arcom Control Systems

125 4.3.8 Segment Field Unit A Segment Field Unit object allows Segment databases to be defined for reporting data over the satellite network. To add a Segment Field Unit to the Null Circuit configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this field unit. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number for the Segment Field Unit between 0 and 255. The Instance Numbers on a Null Circuit are also used by Status/Control and Virtual Field Units, and must be unique for all units on the circuit. Displays the download file created for this object as osaabbcccc where aa parent Internal Channel instance bb parent Null Circuit instance cccc - Segment Field Unit instance number For example: channel 1 circuit 1 instance 3 = os Enter any text describing this object. Arcom Control Systems 119

126 Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the Segment field unit and select Add. To define the properties of the Segment field unit, right click on the object icon and select Properties. Object Name Enabled Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. 120 Arcom Control Systems

127 Unit Name Unit Address Protocol No Comms Not Used No Polls Enter the field unit name. Enter the field unit address. This should be a unique address from any other ISaGRAF, Status/Control, or Virtual field unit addresses on the channel. The default address is 4. Select from the drop down menu the field unit protocol type. Protocol types supported are 'Segment Database Unit'. This parameter is a null field to retain compatibility with other field unit objects. The only option is 'N/A'. This parameter is a null field to retain compatibility with other field unit objects. The only option is 'N/A'. This parameter is a null field to retain compatibility with other field unit objects. The only option is 'N/A'. Once configured, select Close. The Segment field unit devices currently supported are displayed on the tool bar when the icon is selected. These are is a Segment RTDB (Real Time Data Base) Arcom Control Systems 121

128 4.3.9 Segment RTDB A Segment RTDB (Real Time DataBase) defines the size of a virtual database reserved for the Segment field unit. The Segment RTDB contains some significant differences from other RTDB objects. It is more flexible in size and construction, and multiple Segment RTDBs may be configured under a single Segment Field Unit. It also allows deadbands per point to be configured in the RTDB, To add a Segment RTDB to the Segment Field Unit select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Displays the parent for this object. Enter a unique name for this Segment RTDB Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number for this Segment RTDB between 1 and 255. The instance number is the next sequential number starting from one (1) on each Segment Field Unit, corresponding to the number of Segment RTDB's on that unit. Displays the download file created for this object as Saabbccccddd where aa = parent Internal Channel instance bb = parent Null Circuit instance 122 Arcom Control Systems

129 cccc = parent Field Unit instance ddd = Segment RTDB Instance Number For example: channel 1 Circuit 2 field unit 3 segment 4 = S Help Text Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the Segment RTDB and select Add. To define the properties of the Segment RTDB, right click on the object icon and select Properties. Object Name Arcom Control Systems 123

130 Enabled Database Definition Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the dropdown menu the expandable database definition and complete fields. Point Count Enter the number of points for this type to be allocated database space, between 1 and 255 points. Point Format Enter the variable format UINT8 - Unsigned 8-bit integer (0 to 255) SINT16 - Signed 16-bit integer (-32,768 to 32,767) UINT16 - Unsigned 16-bit integer (0 to 65,535) SINT32 - Signed 32-bit integer UINT32 - Unsigned 32-bit integer REAL32 - IEEE floating point (32-bit) Deadband Enter the Deadband for the set of points defined on each row of the RTDB table. Values must be integer, between 0 and Note: Items in each Segment RTDB definition must be defined with the following constraints: 1) At least one section in the Database Definition must be configured; 2) Do not configure rows with Point Count of zero. Once configured, select Close. 124 Arcom Control Systems

131 For example, the following diagram shows the definition of a single RTDB Segment. This segment corresponds to a single row (field) in a standard RTDB. Note that in a standard RTDB field, all items must be of the same data type (for instance, UINT16). In this Segment field, there are 38 points defined with four different data types. Arcom Control Systems 125

132 4.4 Ambrosia Publish The Ambrosia Publish object defines some of the properties of a service which allows the APEX to send an unsolicited data packet to a Broker system using the Ambrosia protocol. This service is used in conjunction with ISaGRAF to publish data from an RTDB to the data broker using TCP/IP. The third party broker may then distribute this data. Note: Not all systems support the Ambrosia Publish protocol. To configure an IBM Publish object, see Section 4.5, IBM MQ Publish. To add a Publish object to the Master Channel object, select the icon: The configuration for this new object shall be displayed as: Parent New Object Name Instance Number Help Text Displays the parent for this object. Enter a unique name for this LCD/Keypad object. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. We have entered a typical name here. No instance number is required, as only a single Publish definition can be included in a configuration. Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. 126 Arcom Control Systems

133 Enter the details for the Publish object and select Add. To define the properties of the Publish object, right click on the object icon and select Properties. Enabled Time To Live Receive Timeout Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Time in seconds for the socket to stay alive. Default value of 120 may be used. Maximum time in milliseconds to wait for a protocol response from the broker. Default 10,000 totals ten seconds. If used over a slow link such as VSAT, this should be set longer, such as 30,000. Arcom Control Systems 127

134 4.5 IBM MQ Publish The IBM MQ Publish object defines some of the properties of a service which allows the APEX to send an unsolicited data packet to a Broker system using the IBM MQ protocol. This service is used in conjunction with ISaGRAF to publish data from an RTDB to the data broker using TCP/IP. The third party broker may then distribute this data. Note: Not all systems support the IBM MQ Publish protocol. To configure an Ambrosia Publish object, see Section 4.4, Ambrosia Publish. To add a Publish object to the Master Channel object, select the icon: The configuration for this new object shall be displayed as: Parent New Object Name Instance Number Help Text Displays the parent for this object. Enter a unique name for this LCD/Keypad object. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. We have entered a typical name here. No instance number is required, as only a single Publish definition can be included in a configuration. Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. 128 Arcom Control Systems

135 Enter the details for the Publish object and select Add. To define the properties of the Publish object, right click on the object icon and select Properties. Enabled Time To Live Receive Timeout Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Time in seconds for the socket to stay alive Default value of 120 may be used. Maximum time in milliseconds to wait for a response. Default totals ten seconds. Arcom Control Systems 129

136 4.6 Terminal Client/Server Configuration Terminal Client and Terminal Server objects allow serial data to be encapsulated in IP packets by an APEX/Director and sent over an IP Network. The Terminal Client object takes data from a serial port and sends it to an IP address. The Terminal Server object waits for incoming data on TCP/IP, and sends it out the serial port. These two may be used independently, or they may be used together to provide pass-through data over an IP network. For example, a PC running a Modbus application (such as Modload) could be connected to a serial port on the Terminal Client APEX and communicate with a device connected to a serial port on the Terminal Server APEX. Even though the two end devices are talking serial Modbus protocol, the messages travel over the IP Network in IP formatted packets. See picture below for graphical depiction of this scheme. See Section 4.6.1, Terminal Client, for a description of the Terminal Client object. See Section 5.6, Terminal Server Configuration, for a description of the Terminal Server object. It is possible to include a Terminal Server and Terminal Client in the same APEX/Director. IP Network (e.g. Ethernet) IP Packeted Modbus Commands Serial APEX with Terminal Client IP Packeted Modbus Responses APEX with Terminal Server Serial PC Running host Modbus Application Initiates Modbus Commands RTU Expecting Modbus Commands Responds to Modbus Commands 130 Arcom Control Systems

137 4.6.1 Terminal Client The Terminal Client object takes serial data and sends it within an IP packet over a network. The Terminal Client must be configured in the APEX/Director where the source of the data is serial, such as Modbus commands. This is similar to the "Reverse Telnet" option available in many routers. To add a Terminal Client object, click on the Terminal Client icon The configuration for this new object shall be displayed as: Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this Terminal Client object. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter an instance number between 0 and 3. Instance numbers must be unique. Displays the download file called RevTneta, where a = Terminal Client instance Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Arcom Control Systems 131

138 Enter the details for the Terminal Client object and select Add. To define the properties of the Terminal Client object, right click on its object icon Terminal Client and select Properties. The following box will be displayed: Enabled Serial Port Remote IP Address Remote IP Port Serial Buff Size Select from the dropdown menu YES for the object to be used and downloaded or NO to not use this object. From the dropdown menu, select the serial port which should be monitored for incoming data. Make sure the Async port is defined under networks. Enter the IP Address of the APEX/Director at the other end of the IP network to which the data will be sent. This will typically be the APEX/Director that has a Terminal Server object configured in it. Enter the IP Port number to which the Terminal Server object is assigned at the receiving APEX/Director. Be sure to use this identical port number when configuring the Terminal Server in the destination APEX/Director. Maximum number of bytes which will be put into an IP packet to be sent to receiving APEX/Director. Actual amount may be less if the Demark Timer (below) times out before the Serial Buffer is full. 132 Arcom Control Systems

139 Demark Timer Client Reconnect Delay Maximum msec the APEX/Director will wait before creating and sending a packet regardless of how few bytes. This may cause packets to be sent of less than Serial Buff Size. How long the Terminal Client will wait before attempting to reestablish a lost connection with the Terminal Server. Regardless of the original cause of the loss of connection.. Once configured, select Close. The Terminal Client devices currently supported are displayed on the tool bar when the icon is selected. These are is the Arcom Modem Packet Assembler Dis-assembler (AMPAD) See Section 5.6, Terminal Server Configuration, for information on configuring the associated Terminal Server object. Arcom Control Systems 133

140 4.6.2 Arcom Modem Packet Assember Dis-assembler (AMPAD) The AMPAD object is sometimes used in conjunction with the Terminal Client to allow an ATDT modem string to "call" different IP addresses. This is optional, and should not be included unless this capability is required. To add an AMPAD object, click on the AMPAD icon The configuration for this new object shall be displayed as: Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this Terminal Client object. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required, as only a single RTDB can be associated with a Terminal Client. Displays the download file called AmPada, where a = Terminal Client instance Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the AMPAD object and select Add. To define the properties of the AMPAD object, right click on its object icon 134 Arcom Control Systems

141 Terminal Client and select Properties. The following box will be displayed: Enabled Stop if DCD Low OK all AT Commands Echo Commands Dialing Lookup Select from the dropdown menu YES for the object to be used and downloaded or NO to not use this object. Select whether the connection should be dropped on loss of DCD. This is for use with a modem connection. Select "No" if hardware handshaking is not being provided by an external device. Select whether to echo AT commands. Select whether to echo all comands. Select from the dropdown menu the expandable database definition and complete fields. Dial String - Enter a string which will trigger a Terminal Client IP connection using the "Server IP Addr" address. Connect Msg - Enter a string to echo back to the host when connected to the "Server IP Addr". This will be echoed, regardless of the "Echo Commands" setting above. Fail Message - Enter a string to echo back to the host if the connection cannot be established. Server IP Addr - IP address for the Terminal Client to Arcom Control Systems 135

142 Once configured, select Close. connect to. If the "Dial String" is seen on the COM port, then this IP address overrides the one defined in the Terminal Client object. Server IP Port - Port number for the Terminal Client to connect to, if the "Dial String is seen on the COM port. 136 Arcom Control Systems

143 4.7 LCD/Keypad Configuration An LCD/Keypad object defines the properties of the Man-Machine Interface (MMI) connected to the APEX. The LCD/Keypad is a hardware option for the APEX and also requires ISaGRAF logic to define operation of the keypad and LCD handling (see the ISaGRAF OEM Manual). To add an LCD/Keypad object to the Client Services object, select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this LCD/Keypad object. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required, as only a single LCD/Keypad definition can be included in a configuration. Displays the download file called 'lcdkp'. Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the LCD/Keypad object and select Add. Arcom Control Systems 137

144 To define the properties of the LCD/Keypad, right click on the object icon and select Properties. Object Name Enabled Board Address Display Size Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Enter the board address used by the APEX to communicate with the LCD/Keypad board. Default value of 384 should be used. Select the size (type) of LCD display connected to the APEX unit. Options include: 138 Arcom Control Systems

145 1 Line x 8 Characters 1 Line x 16 Characters 1 Line x 20 Characters 1 Line x 32 Characters 1 Line x 40 Characters 2 Line x 16 Characters 2 Line x 20 Characters 2 Line x 24 Characters 2 Line x 32 Characters 2 Line x 40 Characters 4 Line x 16 Characters 4 Line x 20 Characters 4 Line x 40 Characters Keypad Size Key Table Select the size (type) of keypad connected to the APEX unit. Options include: 4 Row x 1 Column 4 Row x 3 Column 4 Row x 4 Column 4 Row x 5 Column 5 Row x 5 Column 8 Row x 1 Column (2 Keypads) 8 Row x 3 Column (2 Keypads) 8 Row x 4 Column (2 Keypads) 8 Row x 5 Column (2 Keypads) 8 Row x 10 Column (QWERTY) The Key Table defines the desired key designations for the keypad used with this APEX. Select from the dropdown menu the expandable database definition and complete fields. Row Identifies the row of the keypad, with the top row as 1. Column Identifies the column of the keypad, with the leftmost column as 1. Default Enum This is the key enumeration that will be sent to APEX when the key identified by "Row, Column" is pressed. Alt1 Enum This is the key enumeration that will be sent to APEX when the key identified by "Row, Column" is pressed in conjunction with the "Alt 1" key. Note that there must be an "Alt 1" key defined in the Default Enum column in order for this feature to work properly. Alt2 Enum This is the key enumeration that will be sent to APEX when the key identified by "Row, Column" is pressed in conjunction with the "Alt 2" key. Note that there must be an "Alt 2" key defined in the Default Enum column in order for this feature to work properly. Following is a list of the available key enumerations: Arcom Control Systems 139

146 Default Sends a value to ISaGRAF indicating the Alt condition, and the Row/Column of the key being pressed. Example 1: When a value of 1013 is sent to ISaGRAF, the 1000 indicates a Default value, 0 in the 100's place indicates no Alt key is being pressed, and the 13 indicates that the key in the 1st row and 3rd column is being pressed. Example 2: When a value of 1234 is sent to ISaGRAF, the 1000 indicates a Default value, 200 indicates the Alt 2 key is being pressed, and the 34 indicates that the key (other than Alt) in the 3rd row and 4th column is being pressed. 0-9 Numeric values Decimal Decimal point (.) - Dash character Enter Enter key Cancel Cancel key Back Space Backspace key (destructive). Clears character to the left of the cursor. Up Arrow + Back Space Scrolls up one line on the display or clears character to the left of cursor, depending on context of the menu. Down Arrow + Back Space Scrolls down one line on the display or clears character to the left of cursor, depending on context of the menu. Up Arrow Scrolls up one line on the display. Down Arrow Scrolls down one line on the display. Screen Up Scrolls up 1 screen on the display. Screen Down Scrolls down 1 screen on the display. Up 10 Lines Scrolls up 10 lines. Down 10 Lines Scrolls down 10 lines. Top Scrolls to the top of a display. Bottom Scrolls to the bottom of a display Alt1 Function Used in conjunction with other keys to produce an alternate function. Alt2 Function Used in conjunction with other keys to produce an alternate function. Alt1 Locked Function Turn on the "Alt 1" mode, used in conjunction with other keys to produce an alternate function. Alt2 Locked Function Turn on the "Alt 2" mode, used in conjunction with other keys to produce an alternate function. Alt Function Unlock Turn off the "Alt 1" or the "Alt 2" mode. Note that if an "Alt 1 Locked" or "Alt 2 Locked" Function is configured, there must also be configured an "Alt Function Unlock" key. 140 Arcom Control Systems

147 YES Enters a "Yes" value to a prompt. NO Enters a "No" value to a prompt. A-Z Alphabetical characters (uppercase) 0xa - 0xf Numeric Hexadecimal values A through F. Space Insert space character. Clear Erase all characters entered at a menu prompt. LCD Init Initializes the LCD display if it has been unplugged and reattached or has been plugged in after power is applied to the APEX. If the LCD is plugged in at startup of the APEX, the LCD will be initialized automatically without requiring this key to be defined. Once configured, select Close. For example, Arcom Control Systems 141

148 4.8 SNTP Time Sync The SNTP Time Sync function allows the APEX to synchronize its clock by connection over IP to a Standard Network Time Protocol (SNTP) server. In order for the APEX to use SNTP, it must be included in the configuration and in the executable firmware (not all systems include the SNTP protocol). To add the SNTP Time Sync to the Clients configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this SNTP Time Sync object Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number between 0 and 9. Instance number is the next sequential number, starting from zero. Displays the download file created for this object as sntpa, Where a = SNTP instance number For example: instance number 0 = sntp0 Enter any text describing this object. Text entered here is displayed at the bottom of the ACE 142 Arcom Control Systems

149 configuration screen when the object is selected. Enter the details for the SNTP Time Sync object and select Add. To define the properties of SNTP, right click on the object icon and select Properties. Object Name Enabled SNTP Server Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Enter the IP address of the SNTP server to which to connect. Arcom Control Systems 143

150 SNTP Server Version Refresh Period GMT Difference Enter the version of the SNTP Server. Enter the time interval (in minutes) which defines how often the APEX will update its real-time clock. Number of hours difference between the local time and GMT time. A negative number indicates that local time is behind GMT time, positive indicates that local time is ahead of GMT. Once configured, select Close. 144 Arcom Control Systems

151 4.9 ACE Configuration Layout Client Services Once the Clients Services configuration has been completed, the ACE configuration tool will display the configuration as shown below. (The Terminal Client is not shown in this example.) Close the Client Services 'tree' by selecting the icon. Arcom Control Systems 145

152 CHAPTER 5 5 Servers The Servers configuration defines the connection between the APEX unit and the local host units. The APEX is the slave on each of the links. To define the properties of the Servers, right click on the icon and select Properties. Enabled Enter a 'Yes' to for the object to be enabled or 'No' to disable the object. Once configured, select Close. Not all Servers are supported in all APEX systems. The Server devices supported are displayed on the tool bar when the icon is selected. The Servers are 146 Arcom Control Systems

153 is a Slave Channels Identifier is a Serial MMI connection is a RBE (Report By Exception) service to an HCP host is a P/R (Poll/Response) service to an HCP host is a Dial Backup service for dial-in connection to channels and UDP is a Terminal Server service for IP to serial data transfer is a UDP Client/Server for translating multicast or unicast UDP protocol from/to serial Arcom Control Systems 147

154 5.1 HCP RBE Server The HCP RBE server allows an RBE (Report By Exception) connection from an HCP to accept database changes. RBE messages are generated by any Field Unit configured to produces RBEs. To add the HCP RBE server to the Server configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this HCP RBE server Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required as only a single HCP_RBE server can be supported. Displays the download file created for this object as HCP_RBE. Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. 148 Arcom Control Systems

155 Enter the details for the HCP RBE channel and select Add. Arcom Control Systems 149

156 To define the properties of the HCP RBE, right click on the object icon and select Properties. Object Name Enabled Service Network Port Network Time To Live RBE Pacing Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the drop down menu the service type. RBE services supported are Network RBE Service to HCP. Enter the port address that the HCP will use to connect to the APEX unit. Enter the inactivity period for the connection before the APEX unit will disconnect. Inactivity period in seconds. Milliseconds to wait before sending RBE Once configured, select Close. 150 Arcom Control Systems

157 5.2 HCP PR Server The HCP PR server allows a poll/response connection to an HCP to accept database changes. To add the HCP PR server to the Server configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this HCP PR server Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required as only a single HCP_PR server can be supported. Displays the download file created for this object as HCP_PR. Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Arcom Control Systems 151

158 Enter the details for the HCP PR channel and select Add. 152 Arcom Control Systems

159 To define the properties of the HCP PR, right click on the object icon and select Properties. Object Name Enabled Service Network Port HealthCheck Time Network Time To Live Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the drop down menu the service type. PR services supported are Network Poll/Response Service to HCP. Enter the port address that the HCP will use to connect to the APEX unit. Number of seconds to wait for a Health Check message from the HCP. Enter the inactivity period for the connection before the APEX unit will disconnect. Inactivity period in seconds. Once configured, select Close. Arcom Control Systems 153

160 5.3 Serial MMI Configuration The Serial MMI object is a logical connection to allow system diagnostics via a terminal program. A Serial MMI must be configured to use a physical COM port, and therefore the COM port definition must also be included under 'Networks'. To add a Serial MMI object to the Slave Channels Identifier configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this Async slave channel. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required, as only a single Serial MMI definition can be included in a configuration. Displays the download file name 'SerialMMI' Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the Serial MMI object and select Add. 154 Arcom Control Systems

161 To define the properties of the Serial MMI, right click on the object icon and select Properties. Object Name Enabled Com Port STDERR Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the drop down menu the COM port on which the Serial MMI will run. Typically the APEX will use COM1 for Serial MMI. Enter 'Yes' to turn on display of diagnostic messages after startup. Arcom Control Systems 155

162 Inactivity Timeout MMI Echo The Inactivity Timeout determines the time between the last keypad activity until the APEX will automatically log out the diagnostic menu session. Enter the timeout period in minutes. Enter 'Yes' for the APEX to echo typed characters to the terminal, 'No' to disable the echo. Default option is 'Yes'. Note: The COM port definition used for Serial MMI must be defined in order for Serial MMI to work. The RX and TX buffers on the COM port definition should be set to 2048 bytes on this port. See Section 3.1, Async Port Configuration. Once configured, select Close. 156 Arcom Control Systems

163 5.4 Slave Channels Identifier Icon The Slave Channels Identifier is a place holder for graphical clarity on the ACE tool to allow the addition of slave channels. To add the Slave Channels Identifier to the Servers configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this slave channel Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required as no download file is created for the object. Displays 'SlaveChans' as no download file is created. Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Arcom Control Systems 157

164 Enter the details for the Slave Channels Identifier and select Add. To define the properties of the Slave Channels Identifier, right click on the object icon and select Properties. Object Name Enabled Select from the dropdown menu 'YES' for the object to be enabled or 'No' to disable the object. Once configured, select Close. 158 Arcom Control Systems

165 The Slave Channels Identifier devices currently supported are displayed on the tool bar when the icon is selected. These are is an Async slave communication link is a Network Slave communication link Arcom Control Systems 159

166 5.4.1 Async Slave Channel An Async slave channel is a logical reference to one or more field units. An Async slave channel must be attached to a physical COM port and have single or multiple addresses configured to respond. To add an Async slave channel to the Slave Channels Identifier configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Displays the parent for this object. Enter a unique name for this Async slave channel. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter an instance number between 0 and 15. The first instance number used must be a 0 and the next instance numbers used must follow consecutively, (i.e. not skipping any numbers). The Async and Network Slaves share the one set of instance numbers so don t repeat the same number between the two types of slaves. Displays the download file created for this object as ComSlaveaa aa slave channel instance number For example: instance number 0 = ComSlave Arcom Control Systems

167 instance number 1 = ComSlave01 Help Text Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the Async slave channel and select Add. To define the properties of the Async slave channel, right click on the object icon and select Properties. Object Name Enabled Service Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the drop down menu the slave type. Arcom Control Systems 161

168 Async slave types supported are: Binary Modbus 32 Slave Service The Modbus 32 service supports the standard Modbus register types as well as 32-bit registers. Binary Modbus Slave Service (16 Bit Pair) The Modbus 16-Bit Pair service supports only standard Modbus register types. If an attached Field Unit includes 32-bit registers, the Modbus service will map these into 16-bit register pairs for the host communication. See below for example. Port Select from the drop down menu the physical communication port for this slave channel. Physical ports 0 11 are available. Once configured, select Close. Example of Modbus Slave Protocols For instance, a Modbus Field Unit has an RTDB containing 20 UINT32 registers (starting at 41,001) and 20 REAL32 registers (starting at 42,001). This Field Unit is attached under a Slave Channel. If the Slave channel has the "Binary Modbus Slave Service" protocol selected, the Slave attach RTU as seen by the Modbus host will contain all 32-bit registers. Requesting register 41,020 will return a single register (4 bytes) from the RTDB register 41,020. However, if the Slave Channel has the "Binary Modbus Slave Service (16-Bit Pair)" protocol selected, the Slave attach RTU as seen by the Modbus host will contain only 16-bit registers. When the Modbus Host requests registers 42,001-42,002, the APEX will return the RTDB register 42,001. When the Modbus Host requests registers 42,039-42,040, the APEX will return the RTDB register 42,020. All 32-bit values must be requested in multiples of 2 without splitting word pairs, or else the APEX will return an exception response. The Async slave devices currently supported are displayed on the tool bar when the icon is selected. These are 162 Arcom Control Systems

169 is a Slave Attach List Arcom Control Systems 163

170 5.4.2 Network Slave Channel A Network Slave channel is a logical reference to one or more field units. A Network Slave channel requires that an IP port (SLIP and/or Ethernet) be configured under Networks and have single or multiple attached slave addresses configured to respond. To add a Network Slave channel to the slave channel identifier configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Displays the parent for this object. Enter a unique name for this network slave channel. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number. The instance number is the next sequential number, counting from zero, but without duplicating an instance number already used by a previous Network or Async Slave. Displays the download file created for this object as Netslaveaa Where aa slave channel instance number For example: instance number 0 = NetSlave Arcom Control Systems

171 instance number 1 = NetSlave01 Help Text Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the network slave channel and select Add. To define the properties of the network slave channel, right click on the object icon and select Properties. Object Name Arcom Control Systems 165

172 Enabled Service Network Port Network Time To Live Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the drop down menu the slave type. Network slave types supported are: Network Binary Modbus Slave Service The Modbus Slave service supports the standard Modbus register types as well as 32-bit registers. Network Binary Modbus Slave (16 Bit Pair) The Modbus 16-Bit Pair service supports only standard Modbus register types. If an attached Field Unit includes 32-bit registers, the Modbus service will map these into 16-bit register pairs for the host communication. See below for example. Enter the port address that the host will use to connect to the APEX unit. The IP address used for host connection is defined under the SLIP or Ethernet object for this unit. Enter the inactivity period for the connection before the APEX unit will disconnect. Inactivity period in seconds. Once configured, select Close. 166 Arcom Control Systems

173 Example of Modbus Slave Protocols For instance, a Modbus Field Unit has an RTDB containing 20 UINT32 registers (starting at 41,001) and 20 REAL32 registers (starting at 42,001). This Field Unit is attached under a Slave Channel. If the Slave channel has the "Network Binary Modbus Slave Service" protocol selected, the Slave attach RTU as seen by the Modbus host will contain all 32-bit registers. Requesting register 41,020 will return a single register (4 bytes) from the RTDB register 41,020. However, if the Slave Channel has the "Network Binary Modbus Slave (16-Bit Pair)" protocol selected, the Slave attach RTU as seen by the Modbus host will contain only 16-bit registers. When the Modbus Host requests registers 42,001-42,002, the APEX will return the RTDB register 42,001. When the Modbus Host requests registers 42,039-42,040, the APEX will return the RTDB register 42,020. All 32-bit values must be requested in multiples of 2 without splitting word pairs, or else the APEX will return an exception response. The network slave devices currently supported are displayed on the tool bar when the icon is selected. These are is a slave attach list Arcom Control Systems 167

174 5.4.3 Slave Attach List A Slave Attach List defines the field unit databases that will respond to the defined slave address on a slave channel. The Slave Attach List can concatenate the field unit databases defined to appear as a single Modbus slave at the defined address. Multiple Slave Attach List objects may be configured under a single Slave Channel object, appearing to a host device as multiple RTUs or Field Units on a single COM port. To add a Slave Attach List to the Slave Channel configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Displays the parent for this object. Enter a unique name for this slave attach list. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter an instance number between 0 and 99. Instance numbers must be unique under each Slave Channel. Displays the download file created for this object as Sattaabb where aa Slave Channel instance number bb Slave Attach List instance number For example: slave channel 0 instance number 0 = Satt0000 slave channel 2 instance number 1 = Satt Arcom Control Systems

175 Help Text Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. To define the properties of the slave attach list, right click on the object icon and select Properties. Object Name Enabled Select from the dropdown menu 'YES' for the object to be Arcom Control Systems 169

176 enabled and downloaded or 'No' to disable the object. Slave Address Attach List Enter the Modbus slave address that will respond on this slave channel The Slave Address must be a valid Modbus address (1 to 255), and must be unique for all Slave Attach Lists on this Slave Channel. Select from the drop down menu the expandable database definition and complete fields. Channel Master Channel instance as configured under the Client Services in a Master Channel or Internal Channel. Field Unit Address Field Unit address as configured in the properties of the field unit definition for any of the Field Units on the channel. Once configured, select Close. Example 1: In this example, slave Address 1 will appear as a Modbus field unit containing data from the RTDB under Master Channel 0, Field Unit 1. All register addresses in the slave unit will correspond exactly to the register addresses in the RTDB. Example 2: In this example, Slave address 10 will appear as a single Modbus field unit containing data from the RTDBs for field units 1 and 2 on Master Channel 0, field units 5 and 6 on Master Channel 1, field unit 1 on Master Channel 2 and field units 1, 2 and 3 on Master Channel Arcom Control Systems

177 The individual RTDB for each "attached" field unit is concatenated sequentially to create the complete memory map which appears to the SCADA host as a slave unit with address 10. If each of the field unit RTDBs comprises 8 coils, 8 status, 16 status inputs and 16 holding registers, the data will be polled from slave address 10 as shown in the table on the following page: Arcom Control Systems 171

178 Slave address Master Field Field unit RTDB address Coils Status Status inputs Holding regs channel unit Coils Status Status inputs Holding regs : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : Arcom Control Systems

179 5.5 Dial Backup The Dial Backup object is designed to allow a dial-in modem connection in the event of network failure, such as a satellite link going down. The Dial Backup allows a host system to poll external RTUs connected to Master Channels. It also allows a feature to allow data sent from a UDP Server to be sent directly to a COM port without going through the Master Channel. Refer to Section 5.7, UDP Client/Server, for more information on the UDP Server. To add a Dial Backup object, click on the Servers icon and then click on the Dial Backup icon at the top of the screen. The configuration object will appear as below: Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this Dial Backup object. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required. Displays the download file created for this object as 'DialBackup'. Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the Dial Backup object and select Add. Arcom Control Systems 173

180 To define the properties of the Dial Backup object, right click on its object icon Terminal Client and select Properties. The following box will be displayed. Note: The word "multicasting" as used in this section refers to sending data to multiple channels, and has nothing to do with multicast UDP. The "Route Packet to COM?" parameter and subsequent parameters do refer to UDP (see Section 5.7, UDP Client/Server, for more details). Enabled Service Modem Comm Port Max Message Select from the dropdown menu YES for the object to be used and downloaded or NO to not use this object. From the dropdown menu, select the "Dial Backup Pass Through Polling" option. Select from the dropdown menu the COM port which will be receiving data from a host. Enter the maximum message length in bytes to be sent to 174 Arcom Control Systems

181 channels. Maximum should be no more than 512 if multicasting data to channels. Min Message Demarcation Time Demarcation Byte 1 Demarcation Byte 2 Multicast Channels Route Packet to COM? TCP/UDP Header Text CR/LF Included? Packet Count Included Enter the minimum message length (in bytes) to send to channels. Enter the timeout between packet bytes (in milliseconds) to determine the end of a packet. Enter the decimal (ASCII) value of a character to determine the end of packet. Use this if the incoming data is always terminated by (for instance) a carriage return/line feed, set the Demarcation Time to a sufficiently long time. Use -1 to disable this feature. Enter the decimal (ASCII) value of a second sequential character to determine the end of packet. Use this if the incoming data is always terminated by (for instance) a carriage return/line feed. Use -1 to disable this feature. Select from the dropdown menu the channels to which to broadcast data received on the "Modem Comm Port". Note that these must be Master Channels that are defined under Client Services. This option and the subsequent parameters are used to capture certain packets sent by a UDP Server, and to redirect them straight to a COM port instead of multicasting to Channels. Select "[none]" if this option is unused, or select a COM port. The COM port can be either an Async Port or a Virtual Port. Enter the header text used to identify an incoming UDP packet to route. This should match the Header Text added by the UDP Server. Select whether the incoming Header Text will be followed by an extra CR/LF added by the UDP Server. This should match the corresponding option in the UDP Server. Select whether the incoming data is preceded by a UINT16 byte count or not. This should match the corresponding option in the UDP Arcom Control Systems 175

182 Server. Packet CRC16 Attached Reserved Select whether the incoming data is followed by a CRC16 checksum. This should match the corresponding option in the UDP Server. Unused. Once configured, select Close. 176 Arcom Control Systems

183 5.6 Terminal Server Configuration The Terminal Server object receives serial data on an IP connection, removes the IP headers from the packet, and sends it out an Async Port(s). It also requires the TS Port object below. Refer to Section 4.6, Terminal Client/Server Configuration, for a descriptive diagram of how the Terminal Client and Terminal Server objects relate to each other and information on configuring the Terminal Client. To add a Terminal Server object, click on the Servers icon and then click on the Terminal Server icon at the top of the screen. The configuration object will appear as below: Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this Terminal Server object. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter an instance number between 0 and 15. Instance numbers must be unique. Displays the download file created for this object as TermServaa where aa = Terminal Server instance number Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the Terminal Server object and select Add. Arcom Control Systems 177

184 To define the properties of the Terminal Server object, right click on its object icon Terminal Client and select Properties. The following box will be displayed: Enabled Service Network Port Network TimeToLive Select from the dropdown menu YES for the object to be used and downloaded or NO to not use this object. From the dropdown menu, select the Terminal Service.. The default is Terminal Service. Enter the IP Port number to which this object is assigned. This port number is the port number to which an IP client must connect to send serial data. The IP address is the address configured in this unit's SLIP or Ethernet object. Enter the time to live for the connection in secs. This is the maximum connection time allowed in the absence of any communication. Once configured, select Close. Now add and configure the TS Port object below. 178 Arcom Control Systems

185 5.6.1 TS Port The Terminal Server object above requires this TS Port object to be configured. The TS Port object specifies the serial port or ports to which the serial data will be sent after being received from an IP client. To add a TS Port object, click on the Terminal Server just configured above and then click on the TS Port icon at the top of the screen. The configuration object will appear as below but with empty blanks: Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this TS Port object. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required, as only a single TS Port definition may be included under a Terminal Server object. Displays the download file created for this object as TSPORTaa where aa = parent Terminal Server instance number Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the TS Port object and select Add. Arcom Control Systems 179

186 To define the properties of the TS Port object, right click on its object icon TS Port and select Properties. The following box will be displayed: Enabled Buffer Size Demark Response TimeOut Port Table Select from the dropdown menu YES for the object to be used and downloaded or NO to not use this object. Maximum number of bytes which will be put into an IP packet response to the sending APEX/Director. Actual amount may be less if the Demark Timer (below) times out before the Serial Buffer is full Maximum msec the APEX/Director will wait before creating and sending a response packet regardless of how few bytes. This may cause packets to be sent of less than max size. Enter the response time out in secs. This is the maximum time allowed for a response from the serial device, such as a Modbus RTU. From the drop down menu shown below, pick one or more serial ports to which the Modbus commands are sent. Once configured, select Close. 180 Arcom Control Systems

187 5.7 UDP Client/Server The UDP Client/Server object is designed to operate as either a UDP Server or a UDP Client. As a Server, the UDP task receives UDP data on an IP connection, removes the IP headers from the packet, and sends it out an Async Port(s). This is similar to the Terminal Server object, except that the UDP server handles the UDP transport protocol layer, and can also support multicast packets. When data is sent out the serial port, additional headers and a checksum can be added to ensure data integrity over radio or modem links. As a Client, the UDP task receives data from serial (from UDP server or other source) and sends it to IP. This is similar to the Terminal Client object, except that the UDP Client can multicast data as well as send it in unicast UDP. The headers added by the UDP Server are not currently stripped off by the UDP Client -- for this you need to use the Dial Backup server. In either case, the UDP Client/Server appears under the Servers icon, and also requires the MC Port object described in Section To add a UDP Client/Server object, click on the Servers icon and then click on the icon at the top of the screen. The configuration object will appear as below: Parent New Object Name Instance Number DownLoad File Displays the parent for this object. Enter a unique name for this Terminal Server object. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter an instance number between 0 and 15. Instance numbers must be unique. Displays the download file created for this object as Arcom Control Systems 181

188 UdpServaa where aa = UDP Client/Server instance number Help Text Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the UDP Client/Server object and select Add. To define the properties of the Terminal Server object, right click on its object icon and select Properties. The following box will be displayed: 182 Arcom Control Systems

189 The properties are the same, but the configuration details for the object are slightly different when configured for a UDP Server versus configuring a UDP Client. Enabled Service Data Path Select from the dropdown menu YES for the object to be used and downloaded or NO to not use this object. From the dropdown menu, select the "UDP IP Server/Client" service. From the dropdown menu, select the direction of data flow. UDP Server: Select "UDP Port to Async Port" for receiving data on IP and sending out serial. UDP Client: Select "Async Port to UDP Port for receiving data on serial and sending to IP. Multicast IP Address Enter the IP address used for UDP UDP Server: Address on which to listen for UDP data, which may be a multicast address. This may be a different IP address than the APEX IP address and Subnet Mask would otherwise allow. UDP Client: Address on which to broadcast UDP data after receiving over serial connection. UDP Port Enter the IP port to use for UDP. UDP Server: Port on which to listen for UDP data. UDP Client: IP Port to which to send UDP data. Arcom Control Systems 183

190 Text Header Unique text header associated with this UDP data. UDP Server: This is a text string added to the front of UDP data when sending out the serial port, to identify it to the receiving end as UDP (i.e. the Dial Backup server). UDP Client: This and the remaining options are unused for UDP Client. CR/LF after header UINT16 Packet Count Append CRC-16 Check UDP Reserved Select whether to add a carriage return and line feed after the Text Header. UDP Server: Select either "None" or "Add CR/LF to Text Header". Select whether to add a byte count after the Text Header. UDP Server: Select either "No" or "Put UINT16 Byte Count before Packet". This adds a 2-byte count of the bytes contained in the following data packet so the receiving service can verify data integrity. Select whether to add a CRC-16 checksum to the end of the data packet. UDP Server: Select either "No" or "Attach CRC16 to End of Packet". This adds a 2-byte CRC-16 on the end of the packet to ensure data integrity. unused Once configured, select Close. 184 Arcom Control Systems

191 5.7.1 MC Port The UDP Client/Server object above requires this MC Port object to be configured. The MC Port object specifies the serial port or ports to which the serial data will be sent after being received from UDP (UDP Server); or it specifies the serial port from which to receive serial data (UDP Client). To add a MC Port object, click on the UDP Client/Server just configured above and then click on the TS Port icon at the top of the screen. The configuration object will appear as below but with empty blanks: Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this MC Port object. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required, as only a single MC Port definition may be included under a UDP Client/Server object. Displays the download file created for this object as McPortaa where aa = parent UDP Client/Server instance number Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Arcom Control Systems 185

192 Enter the details for the TS Port object and select Add. 186 Arcom Control Systems

193 To define the properties of the MC Port object, right click on its object icon MC Port and select Properties. The following box will be displayed: Enabled Buffer Size Demark Mask Packet Size Select from the dropdown menu YES for the object to be used and downloaded or NO to not use this object. Maximum number of bytes which will be used for the data transfer to/from UDP. This should not be greater than Actual amount of data sent in a packet may be less if the Demark Timer (below) times out before the Serial Buffer is full. Maximum time (in milliseconds) the APEX/Director will wait before creating and sending a response packet regardless of how few bytes. This may cause packets to be sent of less than max size. The UDP Server has a feature that allows packets of a certain size to be filtered out. This is useful if there is a UDP "keep alive" signal that shouldn't be sent to the serial port. This packet size is the actual data portion of the UDP message, not the full packet with IP headers. This option is unused for the UDP Client. Arcom Control Systems 187

194 Port Table From the drop down menu shown below, pick one or more serial ports to which the UDP data is sent (Server) or received from (Client). Once configured, select Close. 188 Arcom Control Systems

195 5.8 ACE Configuration Layout - Servers Once the Servers configuration has been completed, the ACE configuration tool will display the configuration as shown below. (Terminal Server and TS Port are not shown in this example.) Close the Servers 'tree' by selecting the icon. Arcom Control Systems 189

196 CHAPTER 6 6 HART Configuration This chapter details the configuration and operation of the APEX when using HART protocol devices. When configured appropriately, the APEX acts as a gateway multiplexer for interfacing HART compatible devices with a host system. Configuration features provide optimum set-up for many different control schemes and system requirements. 6.1 Philosophy of HART multiplexers The primary function of the APEX HART multiplexer is to poll Hart devices, and provide Real Time Process Variables in their original IEEE floating point format or in scaled integer format. A Host device may be configured to read the process variables using standard Modbus or other protocol commands. Upon power up, the acquisition of the Process Variables (PV s) from each of the connected HART devices is done in REAL TIME. HART channels are fully HART conformant with regards to Primary and Secondary master network timing parameters. The secondary function of the APEX HART multiplexer is to provide an interface to the non-realtime or static database information that may be of use in the control, data acquisition, or maintenance scheme. Command Definitions may be configured to access to any definable data item in any of the HART devices in the system. The Host machine or an ISaGRAF program may select any Command Definition in the APEX to run at any time, in addition to the real-time variables which are acquired continuously. 190 Arcom Control Systems

197 Although this manual will cover all technical aspects pertaining to the operation and setup of these devices, it is not a tutorial on the HART protocol nor is it a technical reference on the physical specifications for interfacing HART devices in a network. Please refer to the manufacturer specifications on a particular HART device, and for further technical information contact the Hart Communication Foundation: HART Communication Foundation 9390 Research Blvd. Suite I-350 Austin, TX, , USA Phone: Fax: Web: HART to Modbus conversion The primary function of the APEX's HART channel is to convert between HART protocol of the field devices and the Modbus RTDB. Data retrieved from the HART devices is parsed out based on the command definitions in the APEX, and the result is stored in Modbus registers. For instance, if one data item within a HART response message is a 16-bit integer, the APEX will read in two 8-bit bytes and store them into a 16-bit Modbus register. Data sent to the HART device, such as configuration data, is taken out of Modbus registers and embedded within the HART protocol poll request. Command definitions in the APEX determine how the data is converted from the Modbus registers Real-time vs. Static data acquisition The APEX uses two methods of data acquisition from the HART field devices. Real-time Data Acquisition The APEX executes one or more real-time HART commands continuously to each of the devices connected to a channel. A different real-time command may be configured for each device on the HART channel. This command will generally be one of the Universal commands (1, 2, or 3) of the HART protocol which retrieves the process variables from any HART compatible device. However, through proper configuration the APEX can be configured to send another HART command in real-time mode to the connected devices on a channel. The APEX configuration defines an RTDB with enough holding registers sufficient for storing all the HART real-time data. Arcom Control Systems 191

198 The update rate depends on the HART protocol timing, but is roughly 2-3 updates per second per channel. For example, if 6 devices are connected to a HART channel of the APEX, the total scan time for real-time variables on the channel will be approximately 2 seconds. Static Data Acquisition In this chapter the term "static data acquisition" refers to data retrieved by the APEX from a HART device only upon request from the host device, as opposed to the real-time variables which are automatically and continuously updated. The static data is retrieved using a Command Definition which defines how a HART command should send data to and/or receive data from a HART device; and it defines how that data should be stored into Modbus registers. Some examples of static data are reading/writing the range values and ASCII tags in a HART device, setting PID parameters, etc. The APEX can store numerous commands, allowing a wide range of HART devices from different manufacturers to be interfaced by a single APEX. Each device on an APEX HART channel has a Poll Table, which defines the commands available to that device. To use HART commands for static data acquisition, the Modbus host writes the Poll Index value into a Modbus holding register that is the Command Register for each device. Upon writing the Poll Index number to its register, the APEX automatically executes the HART command defined by the Command Definition. These HART commands are sent out the proper HART channel to the end device, and are interleaved with the real-time poll commands. Once the Command Definition has been executed and the response is received, the real-time poll commands continue ISaGRAF as the Host Application In many applications, ISaGRAF may be used as the host application to control which static data commands are executed. ISaGRAF must write the Poll Index number into the device's Command Register using the ISAWRITE or MBWRITE functions, just like an external Modbus host would do. The command Result Register can be monitored so the ISaGRAF application knows when the function is completed, and if completed successfully. (Note that a DMOV or ISAMOV function to write the Poll Index number will not cause the HART command to be executed.) See the ISaGRAF OEM Manual for more details on programming with ISaGRAF Secondary Master The HART protocol allows up to two HART masters to co-exist simultaneously on the circuit at the same time. The APEX acts as a primary master, and includes timing to avoid collision with a 192 Arcom Control Systems

199 secondary master. According to the HART protocol, the each master must allow sufficient quiet time on the HART loop to allow the other master the opportunity to communicate. NOTE: If data enters the HART loop due to a secondary master or spurious noise sources, the APEX master channel will delay sending its polls until the incoming data ceases. Arcom Control Systems 193

200 6.2 Defining ACE Objects for HART The APEX may have up to 2 HART channels, allowing data from up to 30 HART devices (or 2 point-to-point devices) to be brought into a Modbus RTDB (Real-time Database). Along with the hardware, objects must be included in the software configuration to support the acquisition of data from HART devices. HART devices are treated much the same as other types of Field Units. Each device requires a Master Channel configuration, a Circuit, a Field Unit definition, and an RTDB. The Circuit definition points to a COM port defined under 'Networks', which may be an HBIPort or an Async port connected to an external serial HART interface. If a Modbus host (other than ISaGRAF) needs to gain access to the RTDB, a Slave Channel and Slave Attach List are also required. Additionally, a configuration for HART devices requires one or more HART Command Definitions to be included in order to correctly send a poll to HART devices and parse the response into specific registers of the RTDB. These objects specific to a HART configuration are discussed in the following sections HART Bus Interface (HBI) Port Configuration HART (Highway Addressable Remote Transducer) protocol is a de facto standard for smart instrumentation networks. HART protocol devices may be connected to the APEX via a PC/104 hardware module that provides two (2) ports. The HART Bus Interface (HBI) port configuration in ACE defines the physical connections from the APEX unit to a network of HART protocol device(s). To add an HBI port to the Networks configuration select the icon The configuration for this new object shall be displayed as 194 Arcom Control Systems

201 Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this port. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number. This instance number must correspond to the physical port number. The instance numbers must be unique from each other and other asynch COM port definitions, since APEX treats these ports the same as Async ports. The APEX comes with a number of on-board COM ports, and may be configured for additional asynch COM ports through I/O expansion. The HBI Port should use instance numbers higher than the configured asynch serial ports. Displays the download file created for this object as portaaa where aaa = instance number Note that this is the same file name as the Async port. For example: instance number 4 = port004 = 1st HBI Port instance number 5 = port005 = 2nd HBI Port Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the HBI Port and select Add. The example shows the configuration for the first HART Port. Arcom Control Systems 195

202 To define the properties of the HBI Port, right click on the object icon and select Properties. None of the object properties currently need to be changed from their default configuration. It is only required that the icon be included in the configuration. An example is displayed below. Object Name Enabled Baud Rate Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the dropdown menu the operational baud rate of 196 Arcom Control Systems

203 the port. Only 1200 baud is currently supported, as defined by the HART Protocol specification. Parity Word Length Stop Bits Rx Buffer Size Tx Buffer Size Warm Up Time Warm Down Time Select from the dropdown menu the port parity. Only Odd protocol is currently supported, as defined by the HART Protocol specification. Select from the dropdown menu the word length for use in port operation. Only 8 bit word lengths are supported, as defined by the HART Protocol specification. Select from the dropdown menu the number of stop bits for use in port operation. Only the option for 1 stop bit is supported, as defined by the HART Protocol specification. Enter the receive buffer size in bytes. This is unused for HART protocol, but is retained for compatibility with the Async port definition. Default is 256 bytes. Enter the transmit buffer size in bytes. This is unused for HART protocol, but is retained for compatibility with the Async port definition. Default is 256 bytes. Enter value for warm up time. This is the amount of time to wait before sending data after the RTS handshaking lead has been asserted. The default entry of 0 should be configured to denote that RTS/CTS hardware handshaking will be used (no data will be sent until CTS is asserted). This is required to correctly key up the HART modem on the HBI board. Enter value for warm down time. This is the amount of time to wait after the entire message packet has been shifted out to keep the RTS handshaking lead asserted. The default entry of 0 should be configured to denote that RTS/CTS hardware handshaking will be used (no data will be sent until CTS is asserted). This is required to correctly key up the HART modem on the HART I/O card. Once configured, select Close. Arcom Control Systems 197

204 6.2.2 HART Commands Identifier The HART Commands Identifier is a placeholder for graphical clarity on the ACE tool to allow the addition of HART Command Definitions. To add the HART Commands Identifier to the Client Services configuration, select the Client Services icon and click on the following button on the toolbar: The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this port. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. It is recommended to use "HART Commands" for the name. No instance number is required as no download file is created for the object. Displays 'Commands'; however, no download file is created for this object. Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the HART Commands Identifier and select Add. 198 Arcom Control Systems

205 To define the properties of the HART Commands Identifier, right click on the object icon and select Properties. Object Name Enabled Select from the dropdown menu 'YES' for the object to be enabled or 'No' to disable the object. Once configured, select Close. Arcom Control Systems 199

206 The HART Commands Identifier devices currently supported are displayed on the tool bar when the icon is selected. These are is a HART Command Definition object 200 Arcom Control Systems

207 6.2.3 HART Command Definition A HART Command Definition object describes the data types to be written to and read from the HART device, and which Real-time Database registers are used for the command. To add a HART Command Definition to the HART Commands Identifier, select the icon The configuration for this new object shall be displayed as Parent New Object Name Displays the parent for this object. Enter a unique name for this field unit. It is recommended that the following naming convention is used for the HART Command Definitions: CMD xx - name where, xx name is the HART protocol command number (actual protocol command sent to device) is a description of what the command does, including device name for device specific commands Instance Number Enter a unique instance number between 0 and 999. Instance numbers will typically start from zero and increment sequentially. Large gaps in instance numbers should be avoided because of memory constraints. Arcom Control Systems 201

208 DownLoad File Displays the download file created for this object as cmdaaa where aaa = command instance number For example: instance 0 = cmd000 instance 2 = cmd002 Help Text Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the Command Definition and select Add. An example will be given below for a Command Definition to request HART command 3 (read all dynamic variables) and store the data as IEEE floating point format. To define the properties of the HART Command Definition, right click on the object icon and select Properties. Object Name 202 Arcom Control Systems

209 Enabled Hart Command Definition Table Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Enter the actual HART Command to be used by the Command Definition. This is specified in HART protocol documentation. For example, HART Command 3 reads up to four dynamic process variables. Command 13 reads the Tag, Descriptor, and Date from the device. Command 18 writes the Tag, Descriptor, and Date to the device. Select from the dropdown menu the expandable scan table and complete fields. Data Type Enter the data type of HART data to be read or written. This can be found in HART protocol documentation for the command. See Section 6.2.4, Command Definition Data Types, for a description of data types. Action - Select the action to perform on the data specified by the Data Type. Valid actions are 'Read & Store', 'Read & Discard', and 'Write Data'. See Section for a list of the Data Type / Action combinations that may be used. Count Enter the number of items of "Data Type" to read Arcom Control Systems 203

210 or write sequentially. Address Enter the destination register within the field unit RTDB (Real Time Data Base) to start to place the polled data. If the count is greater than 1, sequential items will be written from or read into sequential registers starting at "Address". Certain "Data Types" must use Addresses of specific type, as defined in the RTDB. See Section for the restrictions on the Data Types. Once configured, select Close. Example The protocol structure of HART command 03 is summarized below, with the item highlighted which we wish to store. For the real-time poll command in this example, we wish to store the process variables but discard the units codes (since these don't change frequently). HART Protocol Data Structure for Command 03 REQUEST DATA BYTES: None RESPONSE DATA BYTES: Bytes 0-3 PV1 millamps, IEEE 754 Byte 4 PV1 Units Code, 8-bit integer Bytes 5-8 PV1 value, IEEE 754 Byte 9 PV2 Units Code, 8-bit integer Bytes PV2 value, IEEE 754 Byte 14 PV3 Units Code, 8-bit integer Bytes PV3 value, IEEE 754 Byte 19 PV4 Units Code, 8-bit integer Bytes PV4 value, IEEE 754 The following APEX command configuration will poll a HART device using HART Command 3 and store its process variables as IEEE floating point, as outlined in the above table. 204 Arcom Control Systems

211 The resulting data will appear in the RTDB for the field unit as follows. The first IEEE value is stored into the 32-bit register 42,001. The data type "IEEE w/ discarded units code" discards one byte and then stores the next four bytes as IEEE. Because the Count is 4, four sets of IEEE values are stored (PV1 through PV4), starting at 42,002 42,001 PV1 ma ( floating point) 42,002 PV1 IEEE (floating point) 42,003 PV2 IEEE (floating point) 42,004 PV3 IEEE (floating point) 42,005 PV4 IEEE (floating point) Important: The RTDB for the HART device must contain enough registers of the correct data types to store all the data returned by the command(s) for that device. If any register doesn t exist in the RTDB, or if a register is the incorrect format for the data type, the command will not be executed! Arcom Control Systems 205

212 6.2.4 Command Definition Data Types The data types available in the HART Command Definition Table are described in this section. The basic principle of operating HART commands is that certain data is written to the HART device, and the response message is parsed out and stored into Modbus registers. A general rule of thumb will help explain the "Action" of these commands: WRITE commands take data from an RTDB register defined by the Command Definition and send it to a device. READ commands take data from a device's response message, and process the data. Below is a list of data types used by the APEX to define how HART commands operate. These data types allow data to be sent from the APEX to a HART device (WRITE commands) and response data to be received from a device and stored into the APEX (READ commands). The Register Type listed is the type of RTDB field that must be used for the commands. NOTE: If any register in a Command Definition does not exist in the RTDB or if the Register Type is incorrect, the HART command will not be sent to the device! Table of Command Definition Data Types Data Type Register Type Action Description Byte Value UINT16 Write Takes the lower 8 bits of a UINT16 register and sends it to the HART device as a single byte. Read & Store Reads one byte of response from the device and stores into a register. Read & Discard Reads one byte of response and discards it. Integer Value UINT16 Write Takes a UINT16 register and sends it to the device as two bytes. Read & Store Reads two bytes of response from the device and stores it into a register. Read & Discard Reads two bytes of response and Unsigned 24 bit Integer discards them. UINT32 Write Takes the least-significant 24 bits of a UINT32 register, and sends the 3-byte integer to the device. Read & Store Reads three bytes from device response (MSB first) and stores into a 206 Arcom Control Systems

213 UINT32 register. Read & Discard Reads three bytes of device response and discards them. Unsigned 32 bit Integer UINT32 Write Takes the contents of a UINT32 register and sends the 4-byte (32-bit) integer to the device. Read & Store Reads four bytes from device response (MSB first) and stores into a UINT32 register. Read & Discard Reads four bytes of device response and discards them. IEEE Floating Point REAL32 Write Takes the contents of a REAL32 register, and sends that value to the device as an IEEE 754 floating point number. Read & Store Reads four bytes from device response in IEEE 754 floating point format and stores into a REAL32 register. Read & Discard Reads four bytes of device response and discards them. IEEE w/ REAL32 Write N/A. Do not use. discarded units code (5bytes) Read & Store Reads a byte from device response and discards it (typically used for the units code). Then reads the next four bytes as IEEE 754 floating point and stores into a REAL32 register. Read & Discard Reads five bytes from device response 4 Character packed ASCII (3 bytes of HART data) and discards them. UINT32 Write Takes the contents of a UINT32 register and sends the data to the device as 4 packed ASCII characters (3 bytes). The MSB is the first ASCII character. See diagram below for illustration of packed ASCII. Read & Store Read & Discard If the HART device uses unpacked ASCII format (one 8-bit byte per character) then the Byte Value, 16-, 24- or 32-bit Integer Value data types must be used to read the ASCII data. Reads three bytes from device response as 4 packed ASCII characters, and stores them into a UINT32 register. See diagram below for illustration of packed ASCII. Reads three bytes and discards them. Arcom Control Systems 207

214 The packed ASCII data type uses three bytes to represent four ASCII characters. This is accomplished by using only 6 bits per character, as illustrated below. This data type requires a UINT32 RTDB register, and corresponds to the HART protocol message as follows: Diagram of HART Packed ASCII Stored in UINT32 register MSB LSB HART data stream: (3 bytes) 1st ASCII 2nd ASCII 3rd ASCII 4th ASCII character character character character UINT32 RTDB Register: (upper 2 bits of each byte filled with zeros) 32-bit register 208 Arcom Control Systems

215 6.2.5 Master Channel for HART The Master Channel configuration object for HART is identical to the Master Channel for other serial devices, as described in Section 4.2, Master Channel Configuration. This section describes only the unique characteristics for configuring a Master Channel to operate as a HART master. At least one unique Master Channel must be defined for HART devices, in addition to other Master Channels that are used for field units such as Modbus. In order to achieve maximum update rates from HART devices, a different HART Master Channel must be defined for every HART Port, and each Master Channel will contain only one Circuit that links to that port definition. The fastest update possible from a loop of HART devices is approximately three updates per device per channel. For instance, if a HART loop contains three devices in multidrop mode, it will take at least one second to receive process variables from all three devices. To add a Master Channel to the Client Services configuration select the icon Enter the details for the Master Channel and select Add. To define the properties of the Master Channel, right click on the object icon and select Properties. Object Name Arcom Control Systems 209

216 Enabled Name Channel Type Auto Start Response Timeout Broadcast Delay Interpoll delay Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Enter the Master Channel name. This is the name which appears in Serial MMI when viewing diagnostics. Select from the drop down menu the channel type. Channel types supported are: Direct Master. Select from the drop down menu the automatic polling required Automatic polling types supported are 'Yes' polling started automatically, 'No' - polling started manually, and 'Link Based Poll' polling started only once a P/R connection has been made from an HCP. Enter the response timeout in milliseconds. Time in milliseconds to wait for a poll response before declaring the message failed. For strict HART timing according to the protocol spec, this should be set to 0. Enter the broadcast delay in milliseconds. Delay in milliseconds after broadcast command before normal polling resumes. For HART, this should normally be left at the default of 0. Enter the interpoll delay in milliseconds. 210 Arcom Control Systems

217 Time in milliseconds to wait between each poll. For maximum update rate, this should be left at the default 0. Scan Period Network Recovery Scan Table Enter the scan period in seconds. The period in seconds at which the channel will restart the scan table sequence. If the total time for a given channel exceeds the scan period, the next scan shall be scheduled immediately. For maximum update rate, this should be left at the default of 0. Enter the network recovery period in seconds. Time period in seconds to wait after an entire channel failure before attempting to re-establish communications. Select from the dropdown menu the expandable scan table and complete fields. Unit Address - This is the device Unit Address as configured in each field unit on this Channel. If the list of last Unit Address in a table is -1, the Scan Period will be ignored for the Channel. Poll Record - This is the row number in the Poll Record for each poll defined for each Field Unit on this Channel. The first row in a Poll Table is referenced as record 1. Only those polls which are to be polled continuously by the APEX need to be listed in this Scan Table. The HART devices are polled in accordance with the Scan Table and Scan Period configured for the Master Channel. A completed scan table is as follows: Arcom Control Systems 211

218 In this example, it is assumed that at least two HART devices (Field Unit objects) are configured under the Master Channel (and HART Circuit definition). These Field Units have addresses 1 and 2, respectively, and each have at least one Poll Record defined. For instance, the HART Field Units have the following poll records defined: Unit Address Poll Record Poll Table Definition Comment 1 1 Command 3 This "Command 3" definition must be configured under the HART Channels Identifier object. 2 1 Command 1 This "Command 1" definition must be configured under the HART Channels Identifier object. Unit 1, Record 1 Unit 2, Record 1 Scan Period delay Unit 1, Record 1 etc. Command 3, followed by Interpoll Delay Command 1, Interpoll Delay (as defined in Channel) Command 3, followed by Interpoll Delay Note: Often the same Poll definition will be used for all devices on the Channel. This example uses a different Poll definition to show that they don't have to be the same. It is also possible to include two or more real-time poll commands for each HART Unit. Once configured, select Close. The Master Channel devices currently supported are displayed on the tool bar when the icon is selected. These are is an Async circuit to one or more field units from a common Master Channel. is a HART Circuit to one or more HART protocol devices. 212 Arcom Control Systems

219 Arcom Control Systems 213

220 6.2.6 HART Circuit An HART circuit is a unique serial communications path to one or more HART devices from a common master channel. The structure of the HART Circuit is similar to an Async Circuit, but it will contain properties unique to the HART protocol requirements. In order to achieve maximum update rates from HART devices, a different HART Master Channel must be defined for every HART Port, and each Master Channel will contain only one Circuit that links the protocol to that port definition. The fastest update possible from a loop of HART devices is approximately three updates per device per channel. For instance, if a HART loop contains three devices in multidrop mode, it will take at least one second to receive process variables from all three devices. To add a HART circuit to the master channel configuration select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number Displays the parent for this object. Enter a unique name for this circuit Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number. The instance number is the next sequential number, starting from zero on each Master Channel, corresponding to the number of circuits on that channel. Normally there should be only one HART circuit under a 214 Arcom Control Systems

221 Master Channel, and therefore its instance will be 0. DownLoad File Help Text Displays the download file created for this object as Ciraabb where aa = parent Master Channel instance number bb = HART Circuit instance number For example: master channel 0 circuit 0 = Cir0000 master channel 2 circuit 1 = Cir0201 Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the HART circuit and select Add. To define the properties of the HART circuit, right click on the object icon and select Properties. Object Name Arcom Control Systems 215

222 Enabled Circuit Type Primary Port Reserved 1 Reserved 2 Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the drop down menu the circuit type. Circuit types supported are: HART Circuit. Select from the drop down menu the primary physical communication port for this circuit. The port must also be configured correctly under Networks for baud rate and handshaking options. The HART Circuit may be associated with a 2-wire HART circuit (HBI board), or a standard Async port if an external RS-232 HART modem is used. See Section for configuration of the HBI port, and Section 3.1 for configuration of an Asynch port. When using an Async port with an external HART modem, it may be necessary to configure a 5-10 ms Warm-down delay in the port configuration. These options are included for compatibility with other circuit objects, but are unused for the HART Circuit. Once configured, select Close. The HART circuit devices currently supported are displayed on the tool bar when the icon is selected. These are 216 Arcom Control Systems

223 is a HART field unit Arcom Control Systems 217

224 6.2.7 HART Field Unit A HART Field Unit object contains unique information for each HART device and defines parameters for which data is read and written for each field unit. The APEX allows devices to be identified using their short address (0-15), or they may be polled by tag (HART command 11). The HART Field Unit object defines the polling characteristics for each unit. To add a HART Field Unit to the HART circuit, select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Displays the parent for this object. Enter a unique name for this field unit. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. Enter a unique instance number for the HART unit. By convention, the instance number should be identical to the Field Unit's unit address unless Poll by Tag is implemented. The Instance Number must be unique for every unit on a Master Channel. Note: If two different circuits are configured under one Master Channel, uniqueness is not enforced by ACE, but is required for proper system operation. Displays the download file created for this object as osaabbcccc where 218 Arcom Control Systems

225 aa = parent Master Channel instance bb = parent Circuit instance cccc = HART field unit instance number For example: master channel 0 Circuit 0 instance 0 = os master channel 1 Circuit 2 instance 1 = os master channel 2 Circuit 0 instance 3 = os Help Text Enter any text describing this object. Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the HART field unit and select Add. To define the properties of the HART field unit, right click on the object icon and select Properties. Object Name Arcom Control Systems 219

226 Enabled Unit Name Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Enter the field unit name. Unit name is displayed in Serial MMI diagnostic menus. If Poll by Tag is required, this MUST be limited to 8 alpha-numeric characters (uppercase only). All devices on the HART circuit must have unique tags for Poll by Tag to operate correctly. ACE does not allow leading spaces, but assumes trailing spaces for tags less than 8 characters. Unit Address Enter the actual field unit address which is configured in the third-party Field Unit. For non-poll by tag applications, valid addresses are 0 to 15 corresponding to the short HART address. A device in point-to-point mode will use address 0. Devices in multidrop mode will use addresses 1 to 15. All devices must have unique short addresses unless Poll by Tag is used. For Poll by Tag, the unit address configured in ACE must be greater than 15. In this case, the Unit Name configured above will be used to identify the HART device. Protocol Com Retries Select from the drop down menu the field unit protocol type. Protocol type supported is 'HART Unit'. Enter the number of communication retries. If a poll attempt fails, the APEX will issue the poll again 220 Arcom Control Systems

227 up to the configured number of "Com Retries" before the field unit is declared failed. 1st Comm Status Holdreg Not Used Poll Table Enter the starting holding register in the Status/Control field unit to contain the communication status for this field unit. Each Comm Status takes 5 registers, beginning at the register configured in this parameter. See Section 4.3.5, Status/Control Field Unit, for a description of the five Comm Status Register contents. This option is unused, and is retained only for compatibility with other systems. Select from the dropdown menu the expandable scan table and complete fields. Before selecting this menu, you must first have added HART Command objects to the ACE configuration. Command Index - This is the HART Command Definition (index) that will be used to poll this HART device for real-time data. The Command Definitions are described in Section 6.2.3, HART Command Definition. Note that multiple Command Definitions can be defined for a HART device by inserting additional rows in the Poll Table. All commands intended for each HART device must be included in that device's Poll Table. Only the commands listed in the Master Channel Scan Table are polled in real-time. Once configured, select Close. For example, the following configuration will poll a multidrop HART device with a unit address of 1. The communication status registers for this field unit are 40,126-40,130. The real-time poll sent to the field unit will be as defined by the Command Definition labeled "CMD03 Read PVs as floating point" (see Section 6.2.3, HART Command Definition). Arcom Control Systems 221

228 The following example is the same as above, except that the HART unit is now polled by tag for identification (Unit Address configured greater than 15). The HART device being polled must be configured with a tag of "HART01 " (2 trailing spaces) using a handheld configurator. The device's short address can be anything, 0 through Arcom Control Systems

229 The HART field unit devices currently supported are displayed on the tool bar when the icon is selected. These are is a Modbus RTDB (Real Time Data Base) is the HART RTU Extra object Arcom Control Systems 223

230 6.2.8 RTDB (Real Time DataBase) An RTDB (Real Time DataBase) defines the size of the virtual database reserved for the field unit. The HART field unit object requires a child RTDB in order to function properly. To add an RTDB to any of the HART Field Unit definitions select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for this RTDB Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required, as only a single RTDB can be associated to a field unit. Displays the download file created for this object as Rtaabbcccc where aa = parent Master Channel instance bb = parent Circuit instance cccc = parent HART field unit instance For example: master channel 0 Circuit 0 field unit 1 = Rt master channel 2 Circuit 1 field unit 3 = Rt Enter any text describing this object. Text entered here is displayed at the bottom of the ACE 224 Arcom Control Systems

231 configuration screen when the object is selected. Enter the details for the RTDB and select Add. To define the properties of the Realtime Database, right click on the object icon and select Properties. Object Name Enabled Database Definition Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Select from the dropdown menu the expandable database definition and complete fields. Point Count Enter the number of variables for this type to be allocated space in the database. Field Format Enter the variable format Arcom Control Systems 225

232 UINT16 - Unsigned 16-bit integer (0 to 65,535) UINT32 - Unsigned 32-bit long integer REAL32 - IEEE floating point (32-bit) Data Address Enter the Modbus address of the initial variable within the RTDB. Usually there should not be items defined in the RTDB with Point Count of zero. If items with zero Point Count exist in the default object that are not used in a particular configuration, those rows should be deleted. Note: Items in the RTDB Database definition must be defined with the following constraints: 1) At least one section must be defined; 2) Modbus addresses in the RTDB must not overlap; 3) Integer and Floating point registers may only be defined in the range of 30,001 to 49,999, and 4) Avoid using rows with Point Count of zero. Important: The RTDB for the HART device must contain enough registers of the correct data types to store all the data returned by the command(s) for that device. If any register doesn t exist in the RTDB, or if a register is the incorrect format for the data type, the command will not be executed! Once configured, select Close. For example 226 Arcom Control Systems

233 The RTDB (Real Time DataBase) devices currently supported are displayed on the tool bar when the icon is selected. These are is a Deadband object. Deadbands on RTDBs are currently unused for the APEX, and need not be configured. All deadbands for Report by Exception are done through the Segment field unit. Arcom Control Systems 227

234 6.2.9 HART RTU Extra Configuration The HART RTU Extra configuration defines a few additional parameters sometimes used for HART devices. If the parameters in this object are not required for a particular system application, the object does not need to be added. To add a HART RTU Extra object to the HART device, select the icon The configuration for this new object shall be displayed as Parent New Object Name Instance Number DownLoad File Help Text Displays the parent for this object. Enter a unique name for HART RTU Extra object. Object Name is what appears next to the icon in the ACE window after it is added to the configuration. No instance number is required as only a single object of this type can be associated to a HART device. Displays the download file created for this object as sosaabbcccc where aa = parent Master Channel instance number bb = parent Circuit instance number cccc = parent HART field unit instance For example: master channel 0 Circuit 0 field unit 1 = sos master channel 2 Circuit 1 field unit 3 = sos Enter any text describing this object. 228 Arcom Control Systems

235 Text entered here is displayed at the bottom of the ACE configuration screen when the object is selected. Enter the details for the HART RTU Extra object and select Add. To define the properties of the HART RTU Extra object, right click on the object icon and select Properties. Object Name Enabled Command Register Select from the dropdown menu 'YES' for the object to be enabled and downloaded or 'No' to disable the object. Enter the Modbus register used to request static HART commands to operate. Poll commands must be defined in the HART device's Poll Table (but not necessarily the Scan Table) in order for this feature to work for a particular device. Arcom Control Systems 229

236 The host device or ISaGRAF application will write the Command Index for the desired command into the Command Register to execute a command one time. The Command Index is the row number in this device's Poll Table for the command definition (see Section 6.2.3, HART Command Definition). Commands requested through the Command Register only execute once, with no retries. After a requested command has been completed, this register can be read to determine the success or failure of the command. See Section , Checking HART Command Status. Response Register Enter the Modbus register in which the two bytes of HART response will be stored. The two bytes of HART response are stored in this register, which tell certain information about the device or command status. See Section , Checking HART Command Status. Once configured, select Close. For example, the HART Field Unit object may have the following Poll Table defined (see Section 6.2.7, HART Field Unit). This means that three poll commands may be used for this device: HART Commands 3, 13, and 18. Only one of these commands (Command 3, for real-time data) is contained in the Scan Table for continuous updates. The Scan Table is shown below: 230 Arcom Control Systems

237 The host, or an ISaGRAF program, may force the APEX to send a HART Command 13 to the HART device to read its Tag, Descriptor, and Date. This is done by writing a value of 2 into register 40,001 of the RTDB, which is the Command Register defined in the HART RTU Extra device. The value 2 is the Command Index, and corresponds to the row number in the device's Poll Table for the command. The HART command 13 will execute, returning its data into the appropriate registers defined in the Command Definition (Section 6.2.3), and then real-time polling will continue using Command 3. Important: If ISaGRAF is used to set the Command Register, the ISAWRITE or MBWRITE functions must be used. The DMOV and ISAMOV functions will not work! This is because DMOV and ISAMOV send data directly into the RTDB instead of to the HART channel/protocol driver. Arcom Control Systems 231