460MSBS - Protocol Gateway Product User Guide Software Build Date: January 15th, 2015 Revision 3 Real Time Automation, Inc.
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 Required Tools and Data ............................................................................................................................... 6 Powering The Gateway ................................................................................................................................. 7 Accessing the Main Page...................
Security - Log Out ........................................................................................................................................ 42 Email Configuration .................................................................................................................................... 43 Alarm Configuration.................................................................................................................................... 44 Diagnostics – Alarm Status................
Overview The 460MSBS gateway connects a Modbus TCP Client device to a BACnet/IP Client. By following this guide, you will be able to configure the 460MSBS. You will set the gateway’s network settings, configure device specific parameters for initial operation, and integrate the device into your application. For further customization and advanced use, please reference the appendices located on the CD. If at any time you need further assistance do not hesitate to call Real Time Automation support.
Required Tools and Data You will need the following tools: The gateway The provided CD-ROM o IPSetup.exe can also be downloaded: http://www.rtaautomation.com/product/460-gateway-support/ A PC with an internet browser o Browser configuration is Firefox / Internet Explorer / Google Chrome compatible The supplied Ethernet crossover cable A 7-30 VDC power source Real Time Automation, Inc.
Powering The Gateway The following steps will allow you to properly and safely power the gateway. Warning improper wiring will cause unit failure Use the Barrel Connector OR the Screw Terminals power connection, NOT both 1. Connect a 24VDC power source to the gateway. a. The unit draws 125 mA at 24VDC b. The gateway has a voltage operating range from 8-30VDC, 24VDC is recommended.
Accessing the Main Page The following steps will allow you to connect to the browser based configuration of the gateway. 1. Using the supplied crossover cable, connect the gateway to your PC. 2. Insert the provided CD-ROM. 3. Run the IPSetup.exe program from the CD-ROM. 4. Configure the IP Settings of the gateway to be on the same subnet as your PC. 5. Click Launch Webpage. The Main page should appear. Default IP Address is 192.168.0.100. Default Subnet is 255.255.255.0. Real Time Automation, Inc.
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 Static IP Address a. Open a MS-DOS Command Prompt b. Type “ipconfig” and press enter c. Note the PC’s IP Address, Subnet, and Default Gateway i. An invalid IP Address would be: 169.254.x.x 2. The gateway must be on the same Network/Subnet as the PC Once you have both devices on the same network, you should be able to ping the gateway using a MSDOS Command Prompt.
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.
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. If you are changing the IP Address of the gateway, the change will not take effect until the unit has been rebooted.
Modbus TCP/IP Server Configuration Click the Modbus TCP/IP Server button to access the configuration page. 1) Enter a Device Label to identify the device within the gateway. 2) TCP Port: Enter in a TCP Port for the Modbus TCP Server to listen on. Default for Modbus TCP/IP is 502. 3) Unit ID: This Unit ID must be unique for all Modbus TCP Server devices on the TCP network. 4) Inactivity Timeout: Amount of time the gateway will wait for a read/write request before issuing a timeout.
Modbus TCP/IP Server Configuration-Data Groups The bottom area of the Modbus TCP/IP Server Configuration page lets you configure up to 100 Data Groups for both the Read/Write. There are two ways to configure this protocol: • Auto-Server Mode(Default) • Manual Mode NOTE: You may go back and forth between modes, but when reverting from Manual Mode to AutoServer Mode, all changes made in Manual Mode will be discarded. Real Time Automation, Inc.
Modbus TCP/IP Server Data Group Configuration: Auto-Server Mode (Default) While in Auto-Server mode the # of data groups and the actual data groups themselves cannot be edited. Auto- Server 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: • Any Coils, 8 Bit Signed/Unsigned, or 1/8/16/32 Bit Binary Packs data will be mapped as 0x Coil Status.
Modbus TCP/IP Server Data Group Configuration: Manual Mode 1. Click the Edit Data Groups button to switch from Auto-Server Mode to Manual Mode. Once clicked the button will read Auto-Configure Server. The fields under the Data Groups can now be edited. a. When prompted, click OK to confirm mode change or Cancel to remain in Auto Mode. b. Click OK again to keep current Data Group settings or click Cancel to discard the current configuration. 2. Enter the number of Read Data Groups and Write Data groups. 3.
This means that Register 1 will hold the length of the string and Registers 2-5 will hold the string contents. This string can contain a max of 8 characters. c. Enter a Starting Address (1-based). d. Enter the # of Points to write. This will allocate the number of the data type selected. Real Time Automation, Inc.
BACnet/IP Server Configuration Click the BACnet/IP Server button to access the primary configuration page for this device. 1) Enter a Device Label. This is an internal device alias used during data mapping. 2) Enter the decimal value of the UDP Port that the gateway will communicate on (Default is 47808 (0xBAC0)). 3) Enter a unique Instance identifier for the gateway. This Instance must be unique on the BACnet/IP network.
BACnet/IP Server Configuration-Data Groups The bottom area of the BACnet/IP Server Configuration page lets you configure multiple objects for Read and Write Groups. There are two ways to configure this protocol: • Auto-Server Mode(Default) • Manual Mode NOTE: You may go back and forth between modes, but when reverting from Manual Mode to AutoServer Mode, all changes made in Manual Mode will be discarded.
BACnet/IP Server Configuration: Auto-Server Mode (Default) While in Auto-Server mode no fields under the Data Groups can be edited. Auto-Server Mode looks at the other protocol and then configures the Data Groups below to match. BACnet/IP points and will be defined after the other protocol is configured.
BACnet/IP Server Object Configuration – Analog Objects Click the Set Up BACnet Names, Units, and COV button at the bottom of the BACnet/IP Server Configuration page to access the Object Configuration page. When in Auto-Server Mode, these fields are not configurable. Follow these steps to customize Analog Inputs or Outputs in Manual Mode. 1) Select Analog Input or Analog Output from the upper left dropdown menu. 2) Select a Group to use.
BACnet/IP Server Object Configuration – Binary Objects Click the Set Up BACnet Names, Units, and COV button at the bottom of the BACnet/IP Server Configuration page to access the Object Configuration page for this device. When in Auto-Server Mode, these fields are not configurable. Follow these steps to configure Binary Input or Outputs in Manual Mode. 1) Select Binary Input or Binary Output from the upper left dropdown menu. 2) Select a Group to use.
BACnet/IP Server Object Configuration – CharacterString Value Objects Click the Set Up BACnet Names, Units, and COV button at the bottom of the BACnet/IP Server Configuration page to access the Object Configuration page for this device. When in Auto-Server Mode, these fields are not configurable. Follow these steps to configure Binary Inputs or Outputs in Manual Mode. 1) Select CharacterString Value Read or CharacterString Value Write from the upper left dropdown menu. 2) Select a Group to use.
BACnet/IP Server Object Configuration – Group Names Click the Set Up BACnet Names, Units, and COV button at the bottom of the Advanced BACnet/IP Server Configuration page. When in Auto-Server Mode, these fields are not configurable. The Group Name is designed to be used when there are multiple BACnet/IP objects that have the same name. This is useful when you have multiple, identical devices connected on the other protocol. Follow these steps to configure the Groups in Manual Mode.
BACnet/IP Server Routing Configuration Click the Set Up Static Device Binding and Foreign Device registration button at the bottom of the BACnet/IP Server Configuration page to access the Routing Configuration page for this device. These settings are used when connecting to a BACnet/IP Client on a different subnet.
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-Map: 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. If there isn’t a matching data type, the gateway will map the data to the largest available data type. See Data Auto-Map section for more details.
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. To view, select the device from the dropdown menu and click View to generate the information regarding that device.
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. • The 460 gateway has received valid responses from Modbus registers 400001-400005 and therefore can pass the data on to the PLC tag called MC2PLC_INT.
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. The string data will be displayed in both hex and ASCII.
Data and String Mapping – Auto-Map The Auto-Map 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. If a matching data type cannot be found, then the largest available data type will be used. Only when there is no other option is data truncated and mapped into a smaller data type.
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. Group - Select the data group you set up in the protocol config to use for this mapping. b. Start - This is the starting point for this mapping. c. End - This is the final point to be included for this mapping. 3. Manipulation Area (green 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. Remapping may be necessary. 1. Temporary Ram (Int 64) a.
may be beneficial to know if a Server/Slave device is down. By using this Network Bitmap Status you can expose the connection statuses of individual devices. b. 0x00000002 shows that only device 2 is connected c. 0x00000003 shows that only devices 1 and 2 are connected d. 0x00000004 shows that only device 3 is connected 5. Status_XY a. There are two Statuses provided, one for each protocol. This gives access to the overall status of that Protocol.
Recoverable Faults: Hex: 0x01 0x02 0x00FF0000 (bit 16-23)3rd byte Bit Position: 16 17 Non-Recoverable Faults Hex: Bit Position: Decimal: Explanation: 65,536 131,072 recoverable fault - timed out recoverable fault - Slave err 0xFF000000 (bit 24-31)4th byte Decimal: 0x01 24 16,777,216 0x02 25 33,554,432 0x04 26 67,108,864 0x08 27 134,217,728 0x10 0x20 28 29 268,435,456 536,870,912 Explanation: nonrecoverable fault – task fatal err nonrecoverable fault – config missing nonrecoverable f
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. If not checked, this mapping is skipped. 2. Source Field (yellow box above) : a. Group - Select the string data group you set up in the protocol config to use for this mapping. b.
Mapping – Auto-Map Mode to Manual-Map Mode To transition from Auto-Map mode to Manual-Map mode, click the Edit Mapping button. 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 Map mode or click Cancel to remain in Auto-Map mode. There are 2 options on how to proceed from here. 1) To keep the mappings that are already configured press OK. a.
Mapping – Manual-Map Mode to Auto-Map Mode To transition from Manual-Map mode to Auto-Map mode, click the Auto Map Mode button. 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 delete all current mappings and go to Auto-Map mode. Click Cancel to keep all mappings and remain in Manual-Map mode. NOTE: Once you revert back to Auto-Map mode there is no way to recover the mappings you lost. Any mappings you added will be deleted as well.
View Data Mapping as Text 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: Mapping number: source point Len: Number of points mapped -> manipulation (if blank then no manipulation) -> destination point If you are looking for a specific point to see if it is mapped, you can do a find in this text box for your point in question.
View String Mapping as Text The View as Text page displays the string mapping(s) you set up in the String Mapping section. Each line on this page will read as follows: Mapping number: source point -> Copy -> destination point If you are looking for a specific point to see if it is mapped, you can do a find in this text box for your point in question. Example: you defined 20 String Tags in the PLC and want to see if “Test_String” in the Logix PLC is mapped.
Security Configuration You can configure Security for 3 administrators, 5 users, and 1 guest. THIS IS NOT A TOTAL SECURITY FEATURE The security feature offers a way to password protect access to diagnostics and configuration on the network. The security feature does not protect against “Air Gap” threats. If the gateway can be physically accessed, security can be reset. All security can be disabled if physical contact can be made.
Security Configuration-Security Levels Each webpage in our 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. Real Time Automation, Inc.
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. Reset Password: This is used to reset security settings. Confirm reset password must be selected to confirm this action.
Security - Log Out Once a user is done with a session they may click logout at the top of any page. The user may also be logged out for inactivity based off of the Log Out Timer specified during the configuration. Closing the browser is not sufficient to log out. Real Time Automation, Inc.
Email Configuration You can configure up to 10 email addresses. 1. 2. 3. 4. 5. 6. SMTP Mail Username: The email address that the smtp server has set up to use. SMTP Mail Password: If authentication is required, enter the smtp Server’s password (Optional). SMTP Server: Enter the Name of the SMTP Server or the IP Address of the Server. From E-mail: Enter the e-mail that will show up as the sender. To E-mail: Enter the e-mail that is to receive the e-mail. E-mail Group: Choose a group for the user.
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. 2. Enter the number of alarms to configure and click Set Max # Alarms to generate those lines. 3. In the Data Point Section: a. Top dropdown: select the Data Group.
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. b. Select the Clear Error Value. -Ex: Ticks Since Powerup >= 5000. This will clear the alarm after 5000 ticks have elapsed since the unit powered up. 6. Enter an Alarm Name.
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. 4. Clear # of Times Active: This will reset all alarms ‘# of Times Active’ to 0. 5. Alarm #: The reference number to the given alarm on the alarm setup page. 6. Name: The name of the alarm. 7.
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. Last Active Alarm will not be changed. 3. Status of the Individual Alarm will be reset to OK. Real Time Automation, Inc.
Change of State (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. Change these values with caution as they affect performance. 1. Stale Data Timer: If the data has not changed within the time allocated in this Stale Data Timer, the data will be marked as stale within the gateway and will force a write request to occur.
Diagnostics Info The Diagnostic page is where you will be able 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 – Modbus TCP/IP Server Select the Modbus TCP/IP Server in the dropdown menu on the Diagnostic. Additional diagnostic information can be found by clicking on the Help button. Clear All Values - This will only affect Displayed Values. 1. This will return all values displayed to 0 and clear the status string. 2. If Viewing Modbus TCP/IP Server, this will only clear the values for the Modbus TCP/IP Server section of the gateway. Device Status 1.
Diagnostics – Modbus TCP/IP Server LED Status: 1. Good Communication (Solid Green) – The gateway is connected to a Modbus TCP/IP Client and communicating as expected. 2. Not Connected (Flashing Green) – The Modbus TCP/IP Client has never attempted to open up communication to the gateway. 3. Connection Timeout (Flashing Red) - The gateway has lost a connection to the Modbus TCP/IP Client. 4. Off: a. No Power. b. No Ethernet cable plugged in. Variables: 1.
Diagnostics – BACnet/IP Server Select the BACnet/IP Server in the drop down menu on the Diagnostic page. Additional diagnostic information can be found by clicking on the Help button. Additional diagnostic information can be found by clicking on the Help button. Device Status: 1. Connected – The gateway is connected to a BACnet/IP Client. 2. Not Connected – The gateway is not connected to a BACnet/IP Clients. 3.
Variables: 1. Total Msg Request Count – Total Number of Messages Received from the BACnet/IP Client. 2. Read Property Request Received – Number of Read Property requests received from the BACnet/IP Client. 3. Read Multiple Property Request Received – Number of Read Property Multiple requests received from the BACnet/IP Client. 4. Write Property Request Received – Number of Write Property requests received from the BACnet/IP Client. 5.
c. “Invalid Tag” – BACnet/IP message is not how the gateway expects the message. d. “Parameter Out of Range” – The BACnet/IP Client is asking for information outside of the gateway's defined range. 4. BS: Message Error “XXXXX”- The gateway is sending an error a message due to the listed explanation: a. “Inconsistent parameters” i. BACnet/IP Client tried to write a priority that was out of range or reserved (Priority 6) and was rejected. ii.
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 our gateway or a particular Slave/Server device. To select a particular Slave/Server device: a) Select the protocol in the left dropdown menu.
Configuration Files To access the configuration files in the 460 gateway, navigate to 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. Upon clicking the Save Configuration to File button, you will be prompted to select a location to save the file.
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 Revisions of the Software for each Stack. View all of the Flash Files within the gateway. Identify your device by clicking the Start Flashing LED’s button. By clicking this button, the two diagnostic LED’s will flash red and green.
Completing the Installation You have now set up your gateway for communication and are ready to place the device in your application. Support for your device is available any time. Toll free: 800-249-1612 Email: support@rtaautomation.com Real Time Automation, Inc.
