Page 1
460USAWS-N2EW Protocol Gateway Product User Guide Firmware Version 8.8.37 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).
Page 3
Revision History ............................6 Overview ..............................8 Hardware Platforms ..........................9 Hardware – N2EW ........................... 10 Powering the Gateway ........................10 Port Configuration ..........................12 RS232 pinouts: ............................. 12 RS485 pinouts: ............................. 12 RS422 pinouts: ............................. 13 TTL pinouts: ............................13 Mounting with a DIN Rail .........................
Page 4
Certificate setup ..........................40 Attach policies to certificate ......................42 Testing AWS Communication........................46 Send data from AWS to RTA gateway (Subscribe Topic) ..............47 Send data from RTA gateway to AWS (Publish Topics) ..............48 QT Publish Trigger ........................... 51 Mapping - Transferring Data Between Devices ..................
Page 5
Alarms – Clear ............................79 Change of State (COS) Configuration ....................... 80 Diagnostics Info ............................81 Diagnostics Mapping ..........................81 Diagnostics – OPC UA Server ........................82 Diagnostic – MQTT Client ........................84 LED Configuration ............................ 86 Configuration Files ........................... 87 Export Configuration ..........................
Page 6
Revision History Version Date Notes 8.4.5 11/18/2019 Features Added Released OPC UA Server (US) Protocol Ability to now Import/Export Template Files with out an FTP session Bug Fixes Updated Profinet Server (PS) on N34 hardware Platform Updated Wi-Fi software 8.6.0 2/28/20 Bug Fixes Omron Plc Communication fixes for EtherNet/IP...
Page 7
Version Date Notes 8.9.22 2/5/24 Features Added: Added priority-based reads for client protocols Added improved diagnostic timers for client protocols Reduced minimum delay between messages to zero ms on client protocols Added support for USB serial connections Added support for multiple connections on EtherNet/IP Adapter Added 100ms and 1000ms heartbeat values for diagnostic use Added configurable data size to EtherNet/IP adapter and DeviceNet Slave Added support for TTL communications on N34, NNA1, NNA4, N2E, and N2EW...
Page 8
Overview The 460USAWS-N2EW gateway Connect up to three OPC Clients to Microsoft Azure. By following this guide, you will be able to configure the 460USAWS-N2EW gateway. Number of ASCII devices is dependent on the Hardware and Product number of the 460 gateway.
Page 9
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.
Page 10
Hardware – N2EW 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 Terminals 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 11
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.
Page 12
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.
Page 13
RS422 pinouts: TTL pinouts: Real Time Automation, Inc. 1-800-249-1612...
Page 14
1) Mount your DIN Rail. 2) Hook the bottom mounting flange under the DIN Rail. 3) While pressing the 460USAWS-N2EW against the rail, press up to engage the spring loaded lower clip and rotate the unit parallel to the DIN Rail.
Page 15
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 Accessing Browser Configuration...
Page 16
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.
Page 17
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.
Page 18
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...
Page 19
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. Real Time Automation, Inc. 1-800-249-1612...
Page 20
Network Configuration The network configuration area is where you assign the IP address and other network parameters. Changes can only be made when the gateway is in Configuration Mode. Once you are done configuring 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.
Page 21
Network Interface Options The N2EW hardware has three different Network Interface options, Independent Mode, Switch Mode and Wi-Fi 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) Wi-Fi used OR...
Page 22
OPC UA Server Configuration Click the OPC UA Server button to access the configuration page. 1) Select which Network Interface to use for this OPC UA server connection. If using a single port hardware, the Network Interface will display Switch Mode only. 2) Inactivity Timeout: Enter the amount of time the gateway will wait for a read/write request before issuing a timeout.
Page 23
OPC UA Server Group Configuration-Data Groups There are 3 ways to configure this protocol: • Auto-Configure Group by Device (Default) • Auto-Configure Group by Data Type • Manual Mode NOTE: You may go back and forth between modes, but when reverting from Manual Mode to either of the two Auto-Configure Modes, all changes made in Manual Mode will be discarded.
Page 24
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.
Page 25
OPC UA Server 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.
Page 26
OPC UA Server Data Group Configuration: Manual Configure Mode 1) To transition from either of the two Auto-Configure Modes to Manual Configure Mode, click the dropdown at the top of the OPC UA Server Group List and select Manual Configure. a.
Page 27
1) To add additional server connections, click the -Select- dropdown under OPC UA Server Group List and select Add Generic Server option. a) If you are configuring multiple devices click << or >> to navigate to another device. b) To create a new server with the same parameters already configured from another server, click the -Select- dropdown and select the Add from OPC UA Server X option (where X represents the server you wish to copy parameters from).
Page 28
Configuring Input and Output Data Groups 1) Click the View Input Data Groups or View Output Data Groups button. 2) Enter the # of Nodes and/or # Array length. a. There are 2 node types, individual node and array node Individual Node You would choose the individual nodes if you wanted to be able to give each value a unique name.
Page 29
Real Time Automation, Inc. 1-800-249-1612...
Page 30
OPC UA Server Name Configuration Click the Setup OPC UA Names button at the bottom of the web page. You can navigate by clicking on << and >> buttons to view the server groups to define a unique name for the nodes.
Page 31
Real Time Automation, Inc. 1-800-249-1612...
Page 32
Click the MQTT button to continue configuration. Amazon Web Services (AWS) Configuration You can only configure one AWS IoT Core connection with your RTA product. 1) To add an AWS connection, click the -Select- dropdown menu under MQTT Client Connection List and select Add Generic AWS Connection option.
Page 33
Within the RTA gateway configuration only enter in “aabb11224e9ex-ats.iot.us-east- 2.amazonaws.com” portion of the URL, everything else is ignored. 6) Enter the TCP Port for the MQTT broker to open a connection on. If this value doesn’t match, the gateway will not open a connection.
Page 34
4) The private key, certificate, and root certificate will need to be FTP’d into the RTA gateway’s Flash File System. 5) The time configuration will need to be set to the current date and time to establish a connection.
Page 35
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. 2) Within your Windows Task bar, right click and open a new Windows/File Explorer folder or go into your start menu and type File Explore.
Page 36
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.
Page 37
“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 38
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.
Page 39
“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.
Page 40
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 41
Real Time Automation, Inc. 1-800-249-1612...
Page 42
“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 43
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 44
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 45
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...
Page 46
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 47
Below is how the RTA AWS IoT Core Service is setup to Subscribe data from AWS to the RTA. Within AWS, click the “Publish to a topic” tab. Enter in the topic name that is defined in the RTA gateway “Subscribe Topics”...
Page 48
Navigate to the RTA Display data and refresh the web page. You will see your data being updated. 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.
Page 49
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.
Page 50
Real Time Automation, Inc. 1-800-249-1612...
Page 51
QT Publish Trigger By default, the RTA gateway will publish to the broker based on change of state. This means a new publish to the broker will occur any time a value changes. In an application where the client is being charged per publish, such as with AWS, this is not ideal.
Page 52
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.
Page 53
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 54
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 55
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.
Page 56
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 57
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.
Page 58
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.
Page 59
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.
Page 60
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.
Page 61
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 62
4) Heartbeat 100ms Update a) The Heartbeat 100ms Update variable can be used as a heartbeat that updates once every 100ms. The variable starts at 0 on gateway startup and increments by 1 every 100ms. This can be mapped into a destination on one of the available protocols to monitor the gateways connection status.
Page 63
c) There are multiple ways to map the NetBmpStat. Option 1: Map the whole 32bit value to a destination. Example below shows the NetBmpStat is going to an Analog BACnet object. Using a connection of 5 Modbus Slave devices AI1 will show a value of 31.0000. Open a calculator with programmer mode and type in 31, this will represent bits 0 –...
Page 64
7) 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...
Page 66
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.
Page 67
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.
Page 68
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.
Page 69
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: ->...
Page 70
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 71
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”.
Page 72
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.
Page 73
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.
Page 74
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.
Page 75
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.
Page 76
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 77
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.
Page 78
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.
Page 79
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.
Page 80
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.
Page 81
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.
Page 82
Diagnostics – OPC UA Server Select the OPC UA Server in the dropdown menu on the Diagnostics Page to view 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 five seconds with the latest data.
Page 83
Variables: 1) Read Successful: a) Total number of successful read responses sent by the gateway 2) Write Successful: a) Total number of successful write responses sent by the gateway 3) Write Errors: a) Total number of service level write errors sent by the gateway 4) Browse Successful: a) Total number of successful browse responses sent by the gateway 5) Browse Errors:...
Page 84
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 85
LED Status 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): •...
Page 86
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.
Page 87
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 88
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.
Page 89
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.
Page 90
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.
Page 91
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 460USAWS-N2EW and is the answer not in the manual?
Questions and answers