Page 1
460MCQT-N2E Protocol Gateway Product User Guide Firmware Version 8.8.10 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).
AWS IoT Core Service Setup ........................32 AWS IoT Core Service Things Configuration ................... 34 Certificate setup ..........................35 Attach policies to certificate ....................... 37 Testing AWS Communication ........................41 Send data from AWS to RTA gateway (Subscribe Topic) ..............41 Real Time Automation, Inc. 1-800-249-1612...
Page 4
Send data from RTA gateway to AWS (Publish Topics) ..............43 Testing Your MQTT Connections with MQTT Explorer ................45 Send data from RTA gateway to MQTT Explorer (Publish Topic) ............46 Send data from MQTT Explorer to RTA gateway (Subscribe Topic) ........... 46 Mapping - Transferring Data Between Devices ..................
Page 5
LED Configuration ............................84 Configuration Files ............................85 Export Configuration ..........................85 Import Configuration ..........................85 Save and Replace Configuration Using SD Card ..................87 Saving Configuration Using SD Card......................87 Replacing Configuration Using SD Card ....................87 Intelligent Reset Button ..........................88 Utilities ................................
Revision History Version Date Notes 8.4.5 11/18/2019 Features Added 1. Released OPC UA Server (US) Protocol 2. Ability to now Import/Export Template Files with out an FTP session Bug Fixes 3. Updated Profinet Server (PS) on N34 hardware Platform 4. Updated Wi-Fi software 8.6.0 2/28/20 Bug Fixes...
Overview The 460MCQT-N2E gateway connects up to 32 Modbus TCP servers with up to three MQTT brokers or an AWS IoT core service. By following this guide, you will be able to configure the 460MCQT-N2E gateway. Number of ASCII devices is dependent on the Hardware and Product number of the 460 gateway.
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.
Hardware – N2E 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 Screw Terminal’s power connection! 1) Connect a 12-24 VDC power source to the gateway, Red Wire = (+) Black Wire = (-). a) The unit draws 8 VDC 900mA (7.2W) Max b) The unit draws 35 VDC 900mA (31.5W) Max c) The gateway has a voltage operating range from 8-35 VDC, 24 VDC is recommended.
Page 10
Hazardous Environment Power & Installation Instructions This equipment is suitable for use in Class I, Division 2, Groups A, B, C and D, or non-hazardous locations only. WARNING – EXPLOSION HAZARD - Do not disconnect equipment unless power has been removed or the area is known to be non-hazardous.
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. Only 1 mode can be configured for this hardware. Below are the wiring pinouts for each mode. When you have completed your port configuration, click the Save Parameters button.
1) Mount your DIN Rail. 2) Hook the bottom mounting flange under the DIN Rail. 3) While pressing the 460MCQT-N2E against the rail, press up to engage the spring loaded lower clip and rotate the unit parallel to the DIN Rail.
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. For more information on your Operating system network setting refer to the Access Browser Configuration Doc on the CD or download from our support web site.
Page 15
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...
Device Configuration The device configuration area is where you assign the device description parameter. Changes can only be made when the gateway is in Configuration Mode. Once you are done configuring the Description, click the Save Parameters button. Network Configuration The network configuration area is where you assign the IP address and other network parameters.
Page 19
Real Time Automation, Inc. 1-800-249-1612...
Page 20
Network Interface Options The N2E hardware has two different Network Interface options, Independent and Switch Mode. Below, you can find the different use cases that each interface option allows for. Independent Mode 1) Two Ethernet-based protocols on the same IP Network a) Ethernet Port 1 used OR b) Ethernet Port 2 used OR c) Ethernet Port 1 &...
Modbus TCP/IP Client Configuration Click the Modbus TCP/IP Client button to access the configuration page. 1) Select which Network Interface to use for this Modbus TCP/IP connection. If using single port hardware, the Network Interface will default to Ethernet port only. 2) Delay Between Messages: Enter the length of time to delay between read and write scan line requests (ms).
Modbus TCP/IP Client Device Configuration The bottom area of the Modbus TCP/IP Client Configuration page lets you configure up to 32 external Modbus TCP/IP server devices. 1) To add additional server connections, click the -Select- dropdown under Modbus TCP/IP Client Device List and select Add Generic Server option.
Page 23
8) Bit Pack: Select the formatting of the Coil Status/Input Status. Automap will use this packing size to map coils to/from the other protocol. The bit pack selection here should match that of the other protocol. The starting address is considered Bit 0 and is the low-order bit. 9) To enable data swapping, select the required Swap Indicator.
Configuring Read and Write Scan Lines Follow these steps to manually configure Read and Write Scan Lines. 1) Click the View Read Scan Lines or View Write Scan Lines button. 2) Enter a Unit ID for the Client to communicate to. 3) Select a Point Type for each Scan Line.
Page 25
2) Enter the # of consecutive points to read for that point/data type. See the Scan Line Data Limit section at the bottom of the webpage for max values in a scan line. Real Time Automation, Inc. 1-800-249-1612...
MQTT Client Configuration You can configure up to three MQTT connections. 1. Configure up to three MQTT broker devices. 2. Configure up to one Amazon Web Services (AWS) IoT Core connection. 3. Configure up to one Microsoft Azure connection. NOTE: A single AWS OR Azure connection is supported and can co-exist with up to two additional MQTT broker devices.
8) Enter a Client ID which is concatenated onto the Published messages (RTA Publish Topic) to the broker. Ex: If your Client ID is “RTA GW” and one of your topics is RM101/Lights, your RTA gateway will publish the message as RTA GW/RM101/Lights.
8) Enter a Client ID which is concatenating onto the Published messages (RTA Write Topic) to the broker. Ex: If your Client ID is RTA GW and one of your topics is RM101/Lights, your RTA gateway will publish the message as RTA GW/RM101/Lights.
2) Within AWS create a certificate for your RTA gateway. Once AWS has generated a certificate, you’ll be given a private key and certificate to download. 3) Both private key and certificate will need to be FTP’d into the RTA gateway’s Flash File System. How to FTP files into the RTA gateway 1) Save off the private key and certificate files to your desktop, keep these files in a secured location.
Page 30
b. Paste the certificate and private key into this ftp session, close out the session by exiting out. Real Time Automation, Inc. 1-800-249-1612...
Page 31
5) Navigate to the RTA gateway and on the left-hand side, click the OTHER -Select- dropdown and select Utilities. 6) Once on the Utilities page click the File List button. 7) Verify that your certification and private key files appear on this page.
“Thing” and “Policies”. Before you can register your RTA gateway as a “thing,” we need to setup a “policy” for it. This policy will be assigned to our “thing” during the registration process and will grant it the permissions needed to access the MQTT topics that we will use to publish and subscribe messages.
Page 33
From the policy creation page, you add the statements that will dictate what connected devices are allowed to do. Assign a unique name to your policy and add four statements with the information listed below. Notice that when you type in the action, the field labeled “Resource ARN” will be automatically populated.
“Create things.” A new window will open with a number of things to create, chose “Create single thing” and click the Next button. If you have multiple RTA gateways, then you’ll need to select “Create many things”. Real Time Automation, Inc.
The next setting will be the “Specify thing properties”, here you will give your “Thing” a unique name and click the Next button at the bottom. Certificate setup Here you associate your “Thing” with the certificate that will be used to authenticate it with the AWS IoT Core service.
Page 36
Real Time Automation, Inc. 1-800-249-1612...
“Download certificates and keys”. Download the certificate and the private key. Once downloaded, navigate back to this user guide section “how to FTP files into the RTA gateway” to load the certificate and private key into the gateway. Real Time Automation, Inc.
Page 38
Once you have successfully downloaded the files you will be redirected to the Things page. Within the Things page, click on the thing name you setup, in this example it would be RTA_Testing. From this page, you can view if the certificate is active and create a Device Shadow URL. Real Time Automation, Inc.
Page 39
Along with the certificate and private key, your RTA product will need the Device Shadow URL. Click the Device Shadows tab and click “Create Shadow”. Enter in a Device Shadow name and click the Create button. You will be redirected to the Things page where you’ll see your new Device Shadow created.
Page 40
Within the RTA gateway configuration Device Shadow URL, enter in “aabb11224e9ex-ats.iot.us-east- 2.amazonaws.com,” everything else is ignored. Real Time Automation, Inc. 1-800-249-1612...
AWS, the two files have been FTP’d into the RTA gateway, and the Device Shadow URL is configured. Using the AWS MQTT test client, you can Subscribe to a topic (data from the RTA), and you can Publish to a topic (data to the RTA).
Page 42
Within AWS, click the “Publish to a topic” tab. Enter in the topic name that is defined in the RTA gateway “Subscribe Topics” configuration. In the Message payload, after the “:” enter in your value, if using a string be sure your data is in “ “ . For example, “message”: 1234 or “message”: “Hello World.” Once you have your data, click the Publish button.
Send data from RTA gateway to AWS (Publish Topics) This example shows a PLC writing data to the RTA gateway and presenting that data to the Publish topic. Real Time Automation, Inc. 1-800-249-1612...
Page 44
In the topic filter, use a wildcard character of “#” (subscribe to all topics), and click the Subscribe button. You’ll see the subscription once the new Publish data comes in. The “RTA” is the Client ID that is configured in the MQTT device configuration of the RTA. The “Data_From_RTA_2_AWS” is the Publish Topic name configured in the AWS device configuration page of the RTA.
Once you launch the MQTT Explorer tool, setup a new connection. The host will be IP of your MQTT broker. Next, you can configure the RTA gateway. The broker IP address listed below is set up to be “my PC,” this is where our MQTT broker is installed.
Explorer to RTA gateway (Subscribe Topic) The RTA gateway has a topic name of Data_From_Explorer_2_RTA that MQTT Explorer is going to be publishing to. Enter in the topic name to publish, enter in the value (our example is 2328), then click Publish.
Page 47
Real Time Automation, Inc. 1-800-249-1612...
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 50
This page is very useful when verifying that all data is mapped somehow from one protocol to another. If a data point is not mapped, it will display on this page in a yellow highlighted box. The Display Data page will display up to 200 mappings per page, simply navigate to the next page for the additional mapping to display.
Page 51
To view the actual data mappings, click the Edit Mapping button. For more details, see the Data Mapping-Explanation section. To view the data mappings purely as text, click the View as Text button. For more details, see the View Data Mapping as Text section. Real Time Automation, Inc.
Display String Click the Display String button to view what the values of each Parsing and/or Concatenating strings are, you can also click on the Edit Mapping to view the mapping of each string. To view the source or destination groups from a string, click the dropdown menu to generate the information regarding that device.
Page 53
If there are values of “Data Not Valid “on this page, it indicates that the source has not been validated yet and no data is being sent to the destination. NOTE: You can view the whole string data by clicking on Diagnostics Info drop down and navigating to ASCII Diagnostics page.
Display String use case Sending a message of “RTA,Support,Rocks” from an ASCII device to the RTA unit. The ASCII Parsing Configuration would look like my example below. There are more detailed examples of what all the fields represent in the ASCII Parsing section.
Data and String Mapping – Auto-Configure The Auto-Configure function looks at both 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) Group - Select the data group you set up in the protocol config to use for this mapping.
The gateway operates at 200 ticks per second. This equates to one tick every 5ms. Thus, mapping this to a destination will give easy confirmation of data flow without involving one of the two protocols. If data stops on the destination end, then the RTA is offline. Real Time Automation, Inc.
Page 58
4) XY_NetBmpStat a) If a protocol is a Client/Master, there is a Network Bitmap Status that is provided on the Diagnostics Info page under the Variables section. b) Since a Client/Master may be trying to communicate with multiple devices on the network, it may be beneficial to know if a Server/Slave device is down.
Page 59
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: ->...
Note: # is an internal reference to the Server/Slave number you are settings up. ex. RTA Server/Slave products can only be Trigger 1 and Handshake 1 since we are only 1 device. If RTA is a Master/Client, then you can have a Trigger# for each server/slave connected too.
Page 66
3) Within the Data Mapping page manually add 2 additional mappings. 4) The first mapping is going to be the Data Validation Triggering. AO21 will write to the RTA, MC Trigger 1 will mark data invalid. 5) The second mapping, the MC Handshake will increment that all data is validated and write to AI21 “all data is validated”.
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 72
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 Diagnostics page is where you can view both protocols’ diagnostics information, # of Data Mappings, # of String Mapping and # Alarm Mappings. For protocol specific diagnostic information, refer to the next few pages. Diagnostics Mapping This section displays the number of mappings that are enabled, Data Mapping and String Mapping will show the # of Errors and First Errors.
Diagnostics – Modbus TCP/IP Client Select the Modbus TCP/IP Client in the dropdown menu on the Diagnostics Page to view breakdown of the diagnostics and common strings that are displayed on the page. You may also view individual server counters by selecting the device in the All Servers dropdown and clicking View. Additional diagnostic information can be found by clicking the Help button.
Page 78
4) Dependency Protocol Faulted – The dependent protocol is missing causing the communication to go to inactive. 5) Unknown: First Scan Not Complete – Multiple scan lines are set up for the device and the gateway has not completed all the scan lines. LED Status - This is the Status for All Servers or the specific server selected.
Page 79
5) Flashing Red (Empty Scan List) - One or more enabled Modbus TCP servers have no scan lines configured. 6) Flashing Red (Communication not attempted yet) – (Specific server only) No reads are configured and data needed for writes isn’t valid yet. 7) Flashing Red (Dependency Error) - The dependent protocol is missing causing the communication to go to inactive.
Page 80
b) Point Type Used: 3x Input Reg c) # of Points: Any 6) FC05 Force Single Coil: a) Function Code 5: Number of write Coil Status requests sent b) Point Type Used: 0x Coil Status c) # of Points: 1 7) FC06 Preset Holding Register: a) Function Code 6: Number of write Holding Register requests sent b) Point Type Used: 4x Holding Reg...
Page 81
a) Specific to the function code being used for the scan line 4) N (Slave Address): a) Slave address of the slave that the error was received from 5) A (Starting Address): a) Starting address of the register/status that the error was received from 6) L (Length): a) Number of points of the register/status that the error was received from Example:...
Diagnostic – MQTT Client Select the MQTT Client in the dropdown menu on the Diagnostic page to view the breakdown of the diagnostics and common strings that are display on the page. You may also view the individual MQTT device counters by selecting the device in the All Devices drop down and clicking View. NOTE: This page will auto-refresh every five seconds.
Page 83
Solid Green (Connected): • The gateway is connected to all the MQTT devices that are configured and enabled Flashing Green (Not Connected): • No MQTT devices are configured / enabled. Go to the MQTT Client Device Configuration to configure a device Flashing Red (Not Connected): •...
LED Configuration To modify the behavior of the LEDs on the 460 gateway, navigate to Other->Setup LEDs. 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 slave/server device. To select a slave/server device: 1) Select the protocol in the left dropdown menu.
Configuration Files To access the configuration file in the 460 gateway, select the dropdown Other->Export/Import Config. Export Configuration The Export Configuration allows you to save your configuration file for backup or to be imported into another gateway. This file is named rta_cfg.rtax by default. Upon clicking the Save Configuration to File button, you will be prompted to select a location to save the file.
Page 86
If it encountered an error while trying to load the saved configuration, the gateway will indicate the first error it found and a brief description about it under the Load Configuration button. Contact RTA Support with a screenshot of this error to further troubleshoot.
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 web page. If this unit should fail in the future, the last configuration stored on the SD card and can be used for a new gateway to get the application back up and running quickly.
Intelligent Reset Button If the IP Address of the gateway is forgotten or is unknown, there is an easy way to recover the IP Address using a reset button on the hardware. 1) On the front of the gateway below the Power LED, there is a small pinhole. Using a paperclip, press the button through this pinhole and hold the button for at least 5 seconds.
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 460MCQT-N2E and is the answer not in the manual?
Questions and answers