Johnson Controls E-Link Technical Bulletin

Technical Bulletin E-Link Gateway
E-Link Gateway Commissioning and Troubleshooting
Technical Bulletin
Product Code Number
Description
YK-ELNK100-0
Circuit Board with Serial Communications, BACnet MS/TP, Modbus RTU, and N2
YK-ELNK101-0
Circuit Board with LONWORKS FTT10 Communications
YK-ELNKE00-0
YK-ELNK100-0 in an Enclosure
YK-ELNKE01-0
YK-ELNK101-0 in an Enclosure
YK-ELNKOLK-0
OptiView/Latitude Installation Kit
YK-ELNKSTK-0
IPU-II Installation Kit (Installation Kit not available in Europe)
Issue Date May 19, 2011
The Johnson Controls® Equipment Link (E-Link) Gateway is an economical and versatile communications device that provides a connection between YORK® equipment, such as chillers and Remote Terminal Unit (RTUs), and open standard
protocols. Specifically, the E-Link Gateway provides access to BACnet® Multidrop Serial Bus/Token Passing (MS/TP), N2, Modbus® RTU, and LONWORKS® FTT10 Building Automation System (BAS) protocols. The E-Link Gateway has been designed with the same physical dimensions and power requirements as the MicroGateway, which enables it to be used in many instances as a direct replacement part.
IMPORTANT: The E-Link Gateway does not support the ISN, American Standard Code for Information Interchange (ASCII), or YORKTalk I protocols.
The E-Link Gateway has four serial ports, one of which can host an optional LONWORKS FTT10 ProtoCessor module. Ports 1 and 4 are designated for BAS networking, and Port 2 is used to connect to the equipment. Port 3 provides access for auxiliary monitoring and control.
To simplify installation and setup, the E-Link Gateway is pre-configured with a series of chiller and rooftop profiles that you can choose by selecting the correct DIP switch settings.
Table 1: E-Link Gateway Product Code Numbers
The E-Link Gateway consists of two boards. The IPU-II (processor module) is mounted on the System Interface Module (SIM) (interface module). Do not separate these boards in the field.
The circuit board measures 102 x 152 mm (4 x 6 in.) and the dimensions of the enclosure are 152 x 279 x 63 mm (6 x 11 x 2-1/2 in.).
The E-Link Gateway can be powered from these voltage sources:
12 VDC (circuit board) 24 VAC (circuit board)
Functional Overview
The E-Link Gateway is available as a stand-alone circuit board or as a circuit board mounted within a metal enclosure (Table 1).
© 2011 Johnson Controls, Inc. 1
Code No. LIT-12011238 www.johnsoncontrols.com
110 VAC (in an enclosure) 220 VAC (in an enclosure)
User Selections and Indicators
Each communication port is serviced by two Light-Emitting Diodes (LEDs):
The red LED flashes to indicate that the port is transmitting data.
The green LED flashes to indicate that the port is receiving data.
These LEDs are connected to the actual TX and RX signal lines and only indicate electrical activity by the specific port. The LEDs do not indicate error-free data reception or transmission.
Port 1
Port 2
Port 3
Port 4
BACnet MS/TP
YORK Talk III
BACnet MS/TP
LONWORKS FTT10
Modbus RTU Server
YORK Talk II
Modbus RTU Server
N2
BACnet MS/TP
N2
Modbus RTU Client
VT-100
Port 1
Port 2A
Port 2B
Port 3
Port 4
RS-485
RS-485
RS-232
RS-485
TTL/FTT-10A
Type
Description
STD
A standard production Application that is released through the normal process.
CUS
A custom Application that is released and supported by the regional System Integration Services (SIS) or Custom Solutions organizations.
ENG
An engineering Application as used during the development process.
The status and power LED provides information about current operation and the presence of electrical power.
Three DIP switches enable you to set the E-Link Gateway’s MAC address, the desired equipment profile, and the output protocol. Use the momentary push button to activate the chosen selection.
Port 1, Port 2A, and Port 3 have End-of-Line (EOL) switches that allow their respective RS-485 networks to be correctly biased and terminated.
Port Configuration
From a functional perspective, the E-Link Gateway offers four communication ports. Each port is Quick Start configurable to support the protocols listed in Table 2.
Table 2: Port Configuration
Figure 1: Flash Memory Organization
The Firmware file contains the object engine, the operating system, and all the parts required to support the various communication protocols. The Application file contains the preprogrammed Quick Start configurations of the supported field equipment.
The E-Link Gateway’s ports support specific driver technologies as described in Table 3.
Table 3: Port Drivers
Software Revision Control
The E-Link Gateway software consists of two primary parts; the Firmware (ELF) and the Application (CNF). Both of these parts are delivered from the factory as a Johnson Combined File (JCF) shown in Figure 1. A label on the E-Link Gateway defines the version of JCF loaded in the factory.
The JCF is factory loaded and, due to its data format, cannot be reloaded in the field.
Each part of the JCF, with the exception of REDBOOT, can be reloaded individually in the field. The Firmware file uses an ELF extension, whereas the Application uses a CNF extension.
Every time a new Firmware file is built, the file is renamed using the following convention:
FIRMWARE REV: PPPP.FFFF.MMMM.BBBB-CCC, where PPPP is the platform; FFFF is the major functionality; MMMM is the minor functionality; BBBB is the build number; and CCC is the Feature, Section, and Page (FSP) mix.
The Application file, when modified, is also renamed using a 12-character string that adheres to the following convention:
APPLICATION REVISION: TTT.MMMM.BBB, where TTT is the Application type shown in Table 4, MMMM is the major release, and BBB is the build number.
Table 4: Application Types
2 E-Link Gateway Commissioning and Troubleshooting Technical Bulletin
Figure 2 shows an example of the output you see after logging on to an E-Link Gateway and selecting System Diagnostics. The actual Firmware revision and Application revision relate to the current release.
Figure 2: Terminal View of System Diagnostics
Quick Starts
The Quick Start feature provides a simple method of configuring an E-Link Gateway for a specific type of equipment and output protocol. No external devices (laptops) are required because the Quick Start feature is self-contained and is invoked by setting specific addresses on a set of switches. A push button activates the functionality.
When activating a LONWORKS FTT10 Quick Start, cycle the power on the E-Link Gateway to activate the Quick Start and the LONWORKS FTT10 ProtoCessor. (The LONWORKS FTT10 ProtoCessor does not recognize the push button as a trigger to reset and load the correct conversion file.)
Field Maintenance
Implement a field edit if you need to correct an E-Link Gateway’s Quick Start script. Two Quick Starts have been reserved for this purpose, allowing the E-Link Gateway’s Application to be adjusted to address a profile issue, a protocol selection issue, or both.
User Access
Use a computer with a VT-100 interface to view, track, debug, make changes, or access the operation of the E-Link Gateway. To invoke this function, set Way 8 of the MAC address switch to ON and connect a computer with a VT-100 emulation program to Port 3.
User Reports
Certain parameters require adjustments on site. Users that have established a VT-100 interface on Port 3 can edit parameters. Any edits that may have been made are saved to flash memory when you exit the User Report or the User Report has timed out. Only parameters previously defined in a User Report can be edited and saved to flash memory.
Loading New Firmware and Application
If the E-Link Gateway’s Firmware and Application require reloading, the preferred way is to establish a VT-100 terminal session and then use an X-modem utility to transfer the file. When using a Microsoft® Windows® Operating System (OS) based computer, X-modem capabilities already come packaged within the HyperTerminal® Application, so proprietary tools are not required.
Applications
The E-Link Gateway’s Applications are designed to provide connectivity to an established base of YORK chillers that use YORK Talk II and III as their internal protocol. Native BACnet and Modbus RTU protocol speaking equipment can also use the E-Link Gateway to offer N2 and LONWORKS FTT10 communications. An example of this type of equipment is the YPAL rooftop unit.
BAS Networks
An E-Link Gateway can be connected to a BAS network after it has been Quick Started and is then ready to provide data. The E-Link Gateway acts as a server and the BAS system must initiate any requests.
The information required by the BAS is partially dependent on the protocol; but in all cases, the BAS must know the E-Link Gateway’s network address (the address that uniquely identifies it on the network) and which internal data it can access.
MS/TP
The E-Link Gateway supports dynamic device binding. The BAS integrator requires the Device Object address (also known as the Device Object instance or the DE address) for device binding. This literal address allows the BAS system to connect to the E-Link Gateway using an automatic discovery process (a WHO-IS, I-AM exchange) that establishes the E-Link Gateway’s Media Access Control (MAC) address. The MAC address is then used in all future requests.
E-Link Gateway Commissioning and Troubleshooting Technical Bulletin 3
The E-Link Gateway’s Device Object address is generated automatically and is based on adding 5,000 to the MAC address switch setting. Sometimes the integrator may require the E-Link Gateway to have a specific Device Object address (due to site-specific policy); and in these cases, the E-Link Gateway must be site-configured. User Report 1 allows you to enter a specific Device Object address.
N2 and Modbus RTU
In case of both N2 and Modbus RTU, the E-Link Gateway is identified on the network by its MAC address, which you can set to any address between 1 and 127 using switches. Although these protocols have a wider address space, the MAC address switch limits them to 127. You can set the MAC address using software, which is discussed in a later section.
Changes to MAC address switches are updated live, so take care to align any Client Application with the E-Link Gateway’s MAC address.
LONWORKS FTT10
Press the service pin on the ProtoCessor to identify the E-Link Gateway on the LONWORKS FTT10 network, which is the easiest way to determine the Neuron® ID for third-party configuration tools. For Network Automation Engine (NAE)-based systems, the XIF resource file makes it simple to discover the device.
Equipment Point Maps provide the data that a BAS system can access. These maps are available on the Johnson Controls Portal. The Point Maps are presented as spreadsheets, which define the parameters, their associated variable addresses, and a brief description of what the data actually represents for each type of equipment.
Figure 3 shows an example of an OptiView Point Maps spreadsheet. The GPIC Object Type defines the object within the OptiView micro panel that is associated with this parameter.
Figure 3: OptiView Point Maps Spreadsheet
Figure 4 shows an example of an YCAS Point List spreadsheet. The ENG PAGE REF refers to the actual YORK Talk Feature (F54) page reference.
The N2 address is the N2 Open address that is associated with that particular parameter. Columns 1 to 10 of the Points list description indicate if a parameter is standard, optional, or not available and refer to the version of firmware/Erasable Programmable Read Only Memory (EPROM) listed as items 1 to 10 at the top of the spreadsheet.
Each protocol references these variables in different ways. BACnet protocol uses the Multistate Value (MSV), Analog Value (AV), and Binary Value (BV) objects. N2 uses the Analog Data Input (ADI), Analog Data Float (ADF), and Binary Data (BD) objects. Modbus RTU protocol uses registers. LONWORKS FTT10 uses Standard Network Variable Type (SNVT). Each protocol contains different amounts of information. BACnet protocol is the most data-rich and Modbus RTU protocol is the most basic.
Figure 3, Figure 4, and Figure 5 show examples of Point Maps available on the Johnson Controls Portal.
4 E-Link Gateway Commissioning and Troubleshooting Technical Bulletin
Figure 4: YCAS Point List Spreadsheet
Figure 5 shows how a chiller’s Point Map is mapped to provide the required BACnet object ID references and their BACnet object names.
Figure 5: Point Maps and Object ID/References
INPUT
Normalized Data
OUTPUT
YORK Talk Data
AV, MSV, BV
N2, Modbus RTU, BACnet, and LONWORKS FTT10
BACnet Data
AV, MSV, BV
Modbus RTU Data
AV, MSV, BV
Figure 6 shows how a chiller’s Point Map is mapped to provide the required Modbus RTU addresses, supported function codes, and associated scaling.
When applied with BACnet enabled equipment (YPAL), the Acquisition Feature (F65) is used to read the Present Value (PV) of objects resident within the equipment and assign them to AV, MSV, or BV objects. Analog and Digital Transfers (F28 and F29) are used to write data to the equipment.
For Modbus RTU-enabled equipment, the Modbus RTU Feature (F66) polls the equipment to request data from and write data to it. As in previous cases, all the data retrieved from the equipment is assigned to AV, MSV, and BV objects.
Figure 7 shows the three major client features that are used in the E-Link Gateway. Table 5 shows the normalizing variables and the output protocols.
Theory of Operation
The E-Link Gateway is designed to express equipment data from one protocol (typically, YORK Talk, BACnet, or Modbus RTU) into a BAS protocol. To normalize the data received from or sent to the equipment, three standard BACnet object types (AV, BV, and MSV) are used. Although the E-Link Gateway contains more complex objects, these serve no function in a Gateway Application.
The E-Link Gateway is based on the ConneXsys object engine that uses FSP as its programming method.
The E-Link Gateway always serves as a manager with respect to the equipment that it supports. In the case of the YORK Talk Feature (F54), the E-Link Gateway polls the chiller panel to request data f rom and write data to it.
Figure 6: Point Maps and Modbus RTU
Addresses
E-Link Gateway Commissioning and Troubleshooting Technical Bulletin 5
Figure 7: Client Features
Table 5: Normalizing Variables and Output Protocols
Equipment Profiles
These are defined as collections of data points, which provide a BAS system access to certain equipment functionality when exposed on a network.
Feature
Description
F01
MULTI STATE VALUE
F04
ANALOG VALUE
F06
BINARY VALUE
F09
BINARY OUTPUT
F20
NETWORK OBJECTS
F28
ANALOG TRANSFER
F29
DIGITAL TRANSFER
F45
CHANNEL CONFIG
F48
REPORT CONFIG
F49
USER TYPE
F50
SYSTEM DIAG
F54
YORK TALK
F60
SYSTEM STRUCTURE
F65
ACQUISITION
F66
MODBUS RTU
F67
QUICK START PROTOCOL
F68
QUICK START PROFILE
F69
MSV COMPANION
F70
QUICK START CONTINUATION
E-Link Gateway Application
To provide flexibility, the E-Link Gateway does not hardcode the equipment profiles but allows them to be easily configured by factory-designated resources. These profiles are stored as E-Link Gateway Applications that can be restored using a BACnet atomic write service or by an X-modem transfer. The assigned Application revision number reflects the state of the profile.
Principle of Operation
The E-Link Gateway Application links features together to create a predefined behavior that is executed once every system cycle. Figure 8 and Table 6 show the Firmware Features used.
Table 6: Features
Figure 8: Features
Accessing the E-Link Gateway
You must first establish communications with the E-Link Gateway to access the Application. This is done by connecting a computer to Port 3 through a converter that provides an RS-485 interface.
Next, the protocol on Port 3 must be set to Terminal mode. This is accomplished by setting the T-switch (Way 8) of the MAC switch to ON (Figure 9).
Figure 9: MAC Address Switch
Any VT-100 emulation program can be used to access the Applications, but the HyperTerminal software provides a well-proven tool for Windows OS users.
Note: All screen captures in this document were taken via the HyperTerminal software.
6 E-Link Gateway Commissioning and Troubleshooting Technical Bulletin
Password
Access Levels
5555
General access to all FSP functionality. You can make queries into the E-Link Gateway for troubleshooting activities. Any changes are not saved to flash memory.
1111
Gains access to User Report 1
2222
Gains access to User Report 2
3333
Gains access to User Report 3
4444
Gains access to User Report 4
Set the terminal emulation software to the following settings once the computer and E-Link Gateway are connected:
Baud rate = 57,600 Parity = None Data format = 8 bits, 1 stop bit Set terminal for Half Duplex mode of operation Set for a linefeed after a carriage return
System Levels
A system of hierarchical levels offers access to the FSP of an E-Link Gateway. There are four primary system levels:
Advisory Level Feature Level Section Level Page/Data Entry Level
Access all FSP data via a series of key presses from a terminal.
All commands consist of lowercase characters. Uppercase characters are reserved for text entry. Commands are executed by pressing the <CR> key.
Logging On
Once the terminal program has been activated, you can then establish a session with the E-Link Gateway. Send either a logon or login command to initiate the session.
The program prompts you to enter a password upon entering the logon/login command. You can use the general password (default 5555) to investigate the system for general troubleshooting activities.
Additional passwords are available for logon access. Table 7 summarizes the available passwords, access levels, and functionality.
Table 7: Password Access Levels
Advisory Level
The Advisory Level is the default of the E-Link Gateway and consists of the unit name, the current date/time, and one of the following messages:
System Unconfigured System Halted System Monitor
Only these operations may be performed at Advisory Level:
Password Access Alarm review (not applicable for standard E-Link
Gateway operation)
Terminal Command Structure
The E-Link Gateway’s terminal command set is based on two types of commands: base commands and extended commands.
Base commands comprise a single character and provide the basic navigation through the E-Link Gateway. They can also take the form of a string of base command characters.
Extended commands comprise complete words and provide more flexible methods of interrogating the E-Link Gateway. Extended commands cannot be strung together.
Once a session is activated, there are two ways to terminate the session. The first way is simply to execute the logout or logoff command. Invoking either of these results in the following action by the E-Link Gateway:
Link closed Reversing database changes... Restarting system...
The second way to terminate the session is a period of inactivity. If there is no keyboard activity for 20 minutes, the session expires and you must log on again.
Help Command
The help command (Figure 10) accesses the E-Link Gateway’s help screen and is accomplished by typing help at the prompt. Users can invoke the help command any time they are at the prompt.
E-Link Gateway Commissioning and Troubleshooting Technical Bulletin 7
Figure 10: Terminal Commands
General Navigation Commands
The E-Link Gateway’s Terminal interface supports a series of easy-to-use generic commands that allow access to the hierarchically presented data. Data in the E-Link Gateway is addressed by referencing a Feature, a Section, and a Page.
The section cycles back to section 1 upon reaching the maximum section of a particular feature. If you enter a section number beyond the limit of a particular feature, then you are prompted with error 07 – Section number out of range.
Figure 11 and Figure 12 show two basic ways of viewing different Features and Sections.
Figure 11: Features List
Basic FSP commands can be appended to achieve a higher degree of functionality. This guide focuses on the fundamentals, as these are sufficient to enable all functions. As you become more familiar with the navigation, more elaborate sequences can be used.
You can only access the E-Link Gateway’s features after entering a valid password. Although the password can be changed in F60, the E-Link Gateway’s Applications do not allow you to save the password; therefore, the default password 5555 is always valid.
Feature Command
Feature Command (f) – The feature command can be issued in two ways. The first method is to enter fnn, where nn is the specific two-digit feature number.
The second method is to type f, which advances the Application to the next feature in sequence. The feature cycles back to F01 upon reaching F99. You can type a minus symbol at the Feature level to select the previous feature.
Section Command
Section Command (s) – The section command can be issued in two ways. The first is simply to enter the command snnn, where nnn is the specific three-digit section number.
The second method is to type s, which advances the Application to the next section.
Figure 12: Sections List
You can type a minus symbol at the Section level to select the previous section.
Page Command
Page Command (p) – The page command can be issued in two ways. The first is simply entering pnn, where nn is the specific two-digit page number. The number of valid pages per section varies by the particular feature that has been selected.
If you select a page number beyond the limit of a particular section, then you are prompted with error 08 – Page number out of range.
The second method is to type p. The E-Link Gateway advances to the next page in sequence of the currently selected feature and section. Upon reaching the last page for a particular section, the page cycles back to page 1. You can type a minus symbol at the Page level to select the previous page.
8 E-Link Gateway Commissioning and Troubleshooting Technical Bulletin
“t…......t”
Represents an ASCII text entry.
“v……v”
Represents either a Real or an Integer value.
Real Value: 8 digits may be entered. A decimal point or minus sign reduces the effective length by 1.
Integer Values: Only positive values are accepted. If a Real Value is entered, error 02 – Invalid data is returned.
“ssss”
Represents a point address (for example, 4001 or 3064).
“m…m”
Represents a menu selection (for example, ON, OFF, FIR).
Enter Command
Enter Command – The Enter command is issued to begin editing a particular field in a given Feature, Section, and Page. The editing process follows the following steps:
1. Issue the required FSP command to bring the required page into focus.
2. Type e and press Enter. The page is returned as before except that the contents of the user-enterable data field are replaced with an appropriate data entry prompt (see Table 8).
Table 8: Data Entry Prompts
If you need to adjust one of these fields, the m command cycles through all available enumerations.
Next Section Command
Next Section Command (n) – The n command takes you to the next section of the selected feature. The command can be used to examine the same page across multiple sections.
For example, viewing p07 (Defaults and Engineering Units) on all F04 objects could be done by first viewing p07 then typing n and pressing enter for the number of sections that need to be viewed.
Other Commands
Last Command (l) – The l command takes you to the last section of the current feature.
List Command – This command is used to view a list of E-Link Gateway parameters sorted by the way the command is constructed. For example:
list f04 – This command lists all Pages of all
Sections in F04 (Figure 14).
Once you edit a field, type e and press Enter to close it. Some pages have multiple editable fields, which are sequentially opened and closed using e.
Figure 13 illustrates the editing sequence for all data types. It also shows how the e command is used to open an edit session, move through all available editable fields, and close the session.
Figure 13: Editing Sequence
Menu Command
Menu Command (m) – The menu command selects the next selection of the menu enumeration. Certain fields are menu-driven, depending on the feature.
Figure 14: List of All Pages of All Sections
list f04,s001 – This command lists all Pages of
Section 001 in Feature 04 (Figure 15).
Figure 15: List All Pages of Section 001 in
Feature 04
E-Link Gateway Commissioning and Troubleshooting Technical Bulletin 9
Transfer
list f04,p01 – This command lists Page 01 of all
Sections in Feature 04 (Figure 16).
Figure 16: List Page 01 of All Sections in
Feature 04
Note: Enter Control+C (^C) to terminate any List
Command.
Copy Commands
Two commands are used to copy the contents of a given Quick Start section of either F67 or F68 into the last available section supported by that Quick Start feature (Figure 17). (See the Quick Starts section for additional information.)
Figure 18: X-Modem Firmware
The HyperTerminal software has a Transfer selection that allows you to access a Send File window (Figure 19 and Figure 20). The filename (*.ELF) and desired protocol (Xmodem) must be entered in this window.
copy f67snnn is used to copy the contents of
section nnn (where nnn is the three-digit section number) into section 15, the last section of F67.
copy f68snnn is used to copy the contents of
section nnn (where nnn is the three-digit section number) into section 63, the last section of F68.
Figure 17: Copy Commands
X-modem Firmware
The E-Link Gateway Firmware can be re loaded in the field using a VT-100 terminal session. The command for initiating the load is xmodem
firmware.
Figure 19: Transfer Option
Figure 20: Send File Window
Figure 21 shows the progress of transferring data to the E-Link Gateway.
A prompt indicates when the E-Link Gateway is ready to receive the Firmware file (Figure 18).
10 E-Link Gateway Commissioning and Troubleshooting Technical Bulletin
Figure 21: Data Transfer Progress
The system writes the new file to flash memory and then restarts after the E-Link Gateway receives the completed Firmware file. The current session is closed because the E-Link Gateway is going through a warm start.
Figure 21 shows the HyperTerminal software feedback during the process of updating the Firmware. You must wait until RESTARTING appears and the E-Link Gateway has reset to perform any other tasks.
Figure 23: Ready to Receive File Message
The HyperTerminal software has a Transfer selection that allows you to access a Send File window (Figure 24), in which the filename (*.CNF) and desired protocol (Xmodem) must be entered.
Figure 24: Send File Window
Figure 25 shows the progress of transferring data to the E-Link Gateway.
Figure 22: Messages during Firmware Update
X-modem Database
The E-Link Gateway’s Application can be reloaded in the field through a VT-100 terminal interface. The command for initiating the load is xmodem database. You are prompted when the E-Link Gateway is ready to receive the Application file (Figure 23).
E-Link Gateway Commissioning and Troubleshooting Technical Bulletin 11
Figure 25: Data Transfer Progress
The system writes the new file to flash memory and then restarts after the E-Link Gateway receives the completed Application file. The current session is closed because the E-Link Gateway is going through a warm start.
Loading...
+ 25 hidden pages