Page 1
460ESBM-N34 Protocol Gateway Product User Guide Software Build Date: June 7, 2016 Firmware Version 5 Real Time Automation, Inc. 1-800-249-1612...
Page 2
Trademarks CompactLogix, ControlLogix, & PLC-5 are registered trademarks of Rockwell Automation, Inc. EtherNet/IP is a trademark of the ODVA. MicroLogix, RSLogix 500, and SLC are trademarks of Rockwell Automation, Inc. Microsoft, Windows, and Internet Explorer are registered ® trademarks of Microsoft Corporation. BACnet is a registered trademark of American Society of Heating, Refrigerating and Air-Conditioning Engineers (ASHRAE).
Overview ............................... 5 Hardware Platforms ............................6 Hardware – N34 ............................7 Powering The Gateway ..........................8 Port Configuration ............................9 Accessing the Main Page..........................10 Error: Main Page Does Not Launch ......................11 Committing Changes to the Settings ......................12 Main Page ..............................
Page 4
Mapping – Manual Configure Mode to Auto-Configure Mode ..............37 View as Text ..............................38 Data Mapping ............................38 String Mapping ............................38 Security Configuration ..........................39 Security Configuration-Security Levels ....................40 Security - Log In ............................41 Security - Log Out ............................ 41 Email Configuration ............................
Overview The 460ESBM gateway connects an EtherNet/IP Scanner with as many as 32 BACnet MS/TP Slaves. By following this guide, you will be able to configure the 460ESBM gateway. For further customization and advanced use, please reference the appendices located on the CD or online at: http://www.rtaautomation.com/product/460-gateway-support/.
Hardware Platforms The 460 Product Line supports a number of different hardware platforms. There are differences in how they are powered, what serial settings are supported, and some diagnostic features supported (such as LEDs). For these sections, be sure to identify the hardware platform you are using. To find which hardware platform you are using: 1) Look on the front or back label of the unit for the part number.
Powering The Gateway The following steps will allow you to properly and safely power Warning improper wiring will cause unit failure the gateway. Use the Barrel Connector the Screw Terminals power connection, both 1) Connect a 24VDC power source to the gateway. a.
Port Configuration The Port Configuration page is where you set port specific parameters. These settings must match the settings of the device(s) that you are connecting to. When you have completed your port configuration, click the Save Parameters button. The default jumper configurations are setup for the following serial modes: ...
Accessing the Main Page The following steps will help you access the browser based configuration of the gateway. By default, DHCP is enabled. If the gateway fails to obtain an IP address over DHCP it will Auto IP with 169.254.X.Y. 1) Insert the provided CD-ROM into a computer also on the network.
Error: Main Page Does Not Launch If the Main Page does not launch, please verify the following: 1) Check that the PC is set for a valid IP Address a. Open a MS-DOS Command Prompt b. Type “ipconfig” and press enter c.
Committing Changes to the Settings All changes made to the settings of the gateway in Configuration Mode will not take effect until the gateway is restarted via the webpage. Changes will not be stored if the gateway’s power is removed prior to a reboot.
Main Page The main page is where important information about your gateway and its connections are displayed. Mode (orange box below): Running Mode: Protocol communications are enabled Configuration cannot be changed during Running Mode. If changes are needed, click the Configuration Mode button shown in the green box below Configuring Mode:...
Device Configuration The device configuration area is where you assign the device description, IP address, and other network parameters. Changes can only be made when the gateway is in Configuration Mode. Click the Edit button to make these changes. Once you are done configuring the Description and the Network Settings, click the Save Parameters button.
EtherNet/IP Adapter Configuration Click the EIP Adapter button to access the configuration page. 1) Device Label: Enter a label to identify the device within the gateway. Real Time Automation, Inc. 1-800-249-1612...
EtherNet/IP Adapter Data Group Configuration The middle area of the EtherNet/IP Adapter Configuration page lets you configure multiple Input and Output Groups. 1) Data Size is fixed at 32 Bytes per group. 2) Data Format sets the formatting of the data. Automap will use this packing size to map data to/from the other protocol.
EtherNet/IP Adapter Data Group Configuration: Auto-Configure While in either of the two Auto-Configure Modes, the # of data groups and the actual data groups themselves cannot be edited. Auto-Configure Mode looks at the other protocol and then configures the Data Groups to match. The Data Formats will be defined after the other protocol is configured. The data will be configured according to the following rules: ...
Auto-Configure Group by Device vs. Auto-Configure Group by Data Type There are two different methods for Auto-Configure: Group by Device or Group by Data Type. There are a couple of rules to keep in mind when using Auto-Configure Mode: 1) If the other protocol inside the gateway is a Server, Slave, or Adapter protocol, then there are no differences between the Auto-Configure Modes.
EtherNet/IP Adapter Data Group Configuration: Manual Mode 1) To transition from either of the two Auto-Configure Modes to Manual Configure Mode, click the dropdown at the top of the EtherNet/IP Adapter Configuration page and select Manual Configure. a. When prompted, click OK to confirm mode change or Cancel to remain in Auto- Configure Mode.
EtherNet/IP Adapter Data Group Configuration: Using Strings Any String Data Types will be mapped to a String Assembly and will not display in the Input/Output Data Groups. When using a String Data Type, the first byte is set aside for the length. Each String may have 99 characters.
EtherNet/IP Adapter Data Group Configuration-Connection Parameters The lower area of the EtherNet/IP Adapter Configuration page gives a list of parameters to be used to connect to the gateway from your EtherNet/IP Scanner device. After data is configured for the data groups, the applicable connections will display below in the table.
Setting up the PLC- Example Using RSLogix5000 This is how you would set up the example on the previous page using RSLogix5000: 1) Add a “Generic Ethernet Module” under the Ethernet adapter for your PLC. 2) Change the IP address to match the gateway. 3) Make sure the Comm Format matches what you have configured in the Data format field on the EtherNet/IP Adapter Configuration page.
BACNet MS/TP Master Configuration Click the BACnet MSTP Master button to access the configuration page. 1) Serial Port: Select which serial port is being used for communication. This port must be configured on the Port Configuration page. If it has not yet been configured, it will display Disabled after the Port descriptions in this dropdown.
BACnet MS/TP Master Device Configuration The bottom area of the BACnet MS/TP Master Configuration page lets you configure up to 32 external BACnet MS/TP devices. 1) To add additional Slave connections, click the -Select- dropdown menu under BACnet MS/TP Master Device List and select Add Generic Slave option. -To remove a device, navigate to the slave to delete using the <<...
Configuring Read Scan Lines Follow these steps to manually configure Read Scan Lines. 1) Select View Read Scan Lines if not already selected. 2) Select an Object Type for each Scan Line. Options include: Analog Input, Analog Output, Analog Value, Binary Input, Binary Output, Binary Value, and Multi-State Input, Multi-State Output, Multi-State Value, CSV (CharacterString Value).
Mapping - Transferring Data Between Devices There are 5 ways to move data from one protocol to the other. You can combine any of the following options to customize your gateway as needed. Option 1 – Data Auto-Configure Mappings: The gateway will automatically take the data type (excluding strings) from one protocol and look for the same data type defined in the other protocol.
Display Mapping and Values The Display Data and Display String pages are where you can view the actual data for each mapping that is set up. Display Data Click the Display Data button to view how the data is mapped and what the values of each mapping are. Here you will see how each data point (excluding strings) is mapped.
Page 28
If there are values of “- -“ on this page, it indicates that the source has not yet been validated and no data is being sent to the destination. The example below reflects the Modbus to PLC flow of data. The Modbus (right side) is the source and the PLC (left side) is the destination.
Display String Click the Display String button to view how the string data types are mapped and what the values of each string are. Here you will see how each string from each protocol is mapped to the other. To view, select the source or destination group and the String from the dropdown menu to generate the information regarding that device.
Data and String Mapping – Auto-Configure The Auto-Configure function looks at both of the protocols and will map the data between the two protocols as best as it can so that all data is mapped. Inputs of like data types will map to outputs of the other protocols like data types first.
Data Mapping – Explanation Below are the different parts that can be modified to make up a data mapping. 1) Enable (red box above): Check to enable mapping. If not checked, this mapping is skipped. 2) Source Field (yellow box above) : a.
Data Mapping – Adding Diagnostic Information Data Mapping offers 5 different types of information in addition to any scan lines specified for each protocol. IMPORTANT NOTE: Only add Diagnostic Information AFTER both sides of the gateway have been configured. If changes to either protocol are made after diagnostic information has been added to the mapping table, it is necessary to verify all mappings.
Page 33
5) Status_XY a. There are two Statuses provided, one for each protocol. This gives access to the overall status of that Protocol. Each Bit has its own meaning as follows: Common Status: 0x000000FF (bit 0-7)1 byte Hex: Bit Position: Decimal: Explanation: 0x00 if we are a Slave/Server...
String Mapping – Explanation Below are the different parts that can be modified to make up a string mapping. String data types can only be mapped to other string data types. There is no manipulation that can be done on the string. 1) Enable (red box above): Check to enable mapping.
Mapping – Auto-Configure Mode to Manual Configure Mode To transition from Auto-Configure Mapping Mode to Manual Configure Mode, click the dropdown at the top of the Mapping Configuration page and select Manual Configure. After you click this button, you will be prompted to confirm if this is really what you want to do. Click OK to proceed to Manual Configure Mode or click Cancel to remain in Auto-Configure Mappings Mode.
Mapping – Manual Configure Mode to Auto-Configure Mode To transition from Manual Configure Mode to Auto-Configure Mapping Mode, click the dropdown menu at the top of the Mapping Configuration page and select Auto-Configure Mappings. Click OK to proceed to delete all current mappings and go back to Auto-Configure Mappings Mode. Click Cancel to keep all mappings and remain in Manual Configure Mode.
View as Text Data Mapping The View as Text page displays the point to point mapping(s) you set up in the Data Mapping section. This will also display any manipulation(s) that are configured. Each line on this page will read as follows: ->...
Security Configuration To setup security on the 460 gateway, navigate to Other->Security Configuration. You can configure Security for 3 administrators, 5 users, and 1 guest. THIS IS A TOTAL SECURITY FEATURE The security feature offers a way to password protect access to diagnostics and configuration on the network.
Security Configuration-Security Levels Each webpage in the gateway can have a separate security level associated with it for each user. Security Levels: 1) Full Access: Capability to view and configure a web page. 2) View Access: Capability to view a web page, but cannot configure parameters. 3) No Access: No capability of viewing the web page and page will be removed from Navigation.
Security - Log In Username: Name of the user to login. Password: Password of the user to login. Log In: If login is successful, the user will be redirected to the Main Page. Send Password to Email: Sends the specified User’s Password to the email configured for that user. Display Hint: Displays the hint specified for the User if one was set up.
Email Configuration To setup e-mails on the 460 gateway, navigate to Other->Email Configuration. You can configure up to 10 email addresses. 1) SMTP Mail Username: The email address that the SMTP server has set up to use. 2) SMTP Mail Password: If authentication is required, enter the SMTP Server’s password (Optional). 3) SMTP Server: Enter the Name of the SMTP Server or the IP Address of the Server.
Alarm Configuration To setup alarms on the 460 gateway, navigate to Other->Alarm Configuration. 1) Alarm Delay upon Powerup: At Powerup, the gateway will have values of ‘0’ stored for all data. This may cause alarms to trigger before these values are updated by the mating protocols. Set this field to provide needed time to update fields before considering values for alarms.
Page 44
5) In the Clear Error Section: a. Select the Clear Error Operation. Available options are <, >, <=, >=, !=, ==, and Change of State (COS). This is the operation that will be used to compare the Data Point value against the Error Value to determine if the alarm needs to be cleared.
Diagnostics – Alarm Status Alarm Status will only display under the Diagnostic menu tab if at least 1 Alarm is enabled. 1) # Alarms Enabled: This is a count of enabled alarms. 2) # Alarms Active: This is how many alarms are presently active (set). 3) Last Active Alarm: This is the last alarm that the gateway detected.
Alarms – Clear When an alarm is cleared, the following will occur: 1) A one-time notification will be sent to the email associated with the alarm. a. For duplicate emails to occur, the alarm must become active and then be cleared again. 2) Total # Alarms Active will decrement.
Change of State (COS) Configuration To access the configuration files in the 460 gateway, navigate to dropdown Other->COS Configuration. The gateway, by default only writes when data has changed. The gateway also waits to write any data to the destination until the source protocol is successfully connected. Default values should fit most applications.
Diagnostics Info The Diagnostic page is where you can view the gateway’s translations and protocol specific status information. For protocol specific diagnostic information, refer to the next three pages. Diagnostics – Data and String Mapping The Diagnostics->Diagnostic Info->System section displays the number of translations that are enabled, for both Data and String data types, the number of mappings that have an error, and the first mapping that has an error.
Diagnostics – EtherNet/IP Adapter Select the EtherNet/IP Adapter in the dropdown menu on the Diagnostic page to view a breakdown of the diagnostics and common strings that are displayed on the page. Additional diagnostic information can be found by clicking the Help button. NOTE: This page will auto-refresh every 5 seconds with the latest data.
Page 50
LED Status 1) Solid Green (Connected): a. The gateway is connected to an EtherNet/IP Scanner and communicating as expected. 2) Flashing Green (Not Connected): a. The EtherNet/IP Scanner has never attempted to open up communication to the gateway. 3) Flashing Red (I/O Timeout): a.
Page 51
Common Error Strings 1) Connection already in use: a. The gateway already has a connection in use 2) More than one guy configuring: a. Attempting to open up Exclusive Owner/Output Only connection that is already established 3) Connection size mismatch: a.
Diagnostics – BACnet MS/TP Master Select the BACnet MS/TP Master in the dropdown menu on the Diagnostic page to view a breakdown of the diagnostics and common strings that are displayed on the page. You may also view individual slave counters by selecting the device in the All Slaves dropdown and clicking View.
Page 53
LED Status - This is the Status for All Slaves or the specific Slave selected. 1) Solid Green (Connected) – The gateway is connected to all of the BACnet MS/TP Slaves that are configured and enabled. 2) Flashing Green (Not Connected) – The gateway has never been connected to a BACnet MS/TP Slave that is configured and enabled.
Page 54
2) RD Prop Request– Number of Read Property Single requests sent to the BACnet MS/TP Devices. NOTE: Read Property Single Requests are only used if the BACnet MS/TP Device does not support Read Property Multiple (RPM). 3) WR Prop Request– Number of Write Property Single requests sent to the BACnet MS/TP Devices. NOTE: Write Property Single Requests are only used if the BACnet MS/TP Device does not support Write Property Multiple (WPM).
Page 55
g. “Unsupported Object Type” – The gateway tried to access an object type the slave does not support. h. “Value out of range” – BACnet MS/TP message could not be completed because the passed value was not in the valid range. “Write Access Denied”...
LED Configuration To modify the behavior of the LEDs on the 460 gateway, navigate to Other->Setup LEDs. The LED Configuration page lets you configure the LEDs on the gateway. Each LED may be set to Disabled, Protocol 1, or Protocol 2. If either Protocol is a Master/Client, you may set the LED to represent either all Slaves/Servers configured in the gateway or a particular Slave/Server device.
Configuration Files To access the configuration files in the 460 gateway, navigate to dropdown Other->Export/Import Config. Export Configuration The export tool allows you to save your gateway configuration for backup or to be exported into another gateway. This file is named rta_cfg.rtax by default. Network settings will not be saved in this configuration since they must be unique for each gateway.
Save and Replace Configuration Using SD Card Saving Configuration Using SD Card This function saves the gateway’s configuration automatically to an SD Card each time the gateway is rebooted via the Restart Now button on the webpage. If this unit should fail in the future, the last configuration the gateway used is stored on the SD card and can be used for a new gateway to get the application back up and running quickly.
Utilities To access the Utilities page in the 460 gateway, navigate to Other->Utilities. The Utilities screen displays information about the gateway including Operation Time, File System Usage, Memory Usage, and Memory Block Usage. Here you can also: View the full revision of the software. ...
Need help?
Do you have a question about the 460ESBM-N34 and is the answer not in the manual?
Questions and answers