background image

 
 

Real Time Automation, Inc. 

1-800-249-1612 

 

Basics ................................................................................................................................................... 34 

Requesting Data for an Individual Device ........................................................................................... 34 

Requesting a Group of Devices ........................................................................................................... 35 

Filtering Requests by Point Names ..................................................................................................... 35 

Advanced (Optional XML Data Direction Annotation) ........................................................................ 36 

Example Output Format (GET) ................................................................................................................ 37 

Description of Format 

 Both XML and JSON ..................................................................................... 37 

XML Output ......................................................................................................................................... 38 

JSON Output ........................................................................................................................................ 38 

Writing Data to the Gateway ...................................................................................................................... 39 

Which method to use? ........................................................................................................................ 39 

The multipart/form data Method ....................................................................................................... 39 

The application/x-www-form-urlencoded Method ............................................................................ 40 

Example Input Format (POST) ................................................................................................................. 41 

Minimum XML Input ........................................................................................................................... 41 

Expanded XML Input ........................................................................................................................... 41 

Special Note for XML Strings ............................................................................................................... 42 

Minimum JSON Input .......................................................................................................................... 42 

Expanded JSON Input .......................................................................................................................... 42 

Special Note for JSON Strings.............................................................................................................. 43 

Mapping - Transferring Data Between Devices .......................................................................................... 44 

Display Mapping and Values ....................................................................................................................... 45 

Display Data ............................................................................................................................................ 45 

Display String........................................................................................................................................... 47 

Data and String Mapping 

 Auto-Configure................................................................................................ 48 

Data Mapping 

 Explanation ....................................................................................................................... 49 

Data Mapping 

 Adding Diagnostic Information ........................................................................................ 50 

String Mapping 

 Explanation ..................................................................................................................... 53 

Mapping 

 Auto-Configure Mode to Manual Configure Mode .................................................................. 54 

Mapping 

 Manual Configure Mode to Auto-Configure Mode .................................................................. 55 

View as Text ................................................................................................................................................ 56 

Data Mapping .......................................................................................................................................... 56 

String Mapping ........................................................................................................................................ 56 

Summary of Contents for 460MCWI-N2E

Page 1: ...Real Time Automation Inc 1 1 800 249 1612 Firmware Version 6 1 15 460MCWI N2E Protocol Gateway Product User Guide...

Page 2: ...ion or limitation of incidental or consequential damages therefore the limitations set forth in this agreement may not apply to you No patent liability is assumed by Real Time Automation with respect...

Page 3: ...Lines cont 23 Web Interface Configuration 24 Ways to use Web Interface Gateway 24 Automatic Data Transfer to User Host Optional Use when gateway is acting as Web Client 24 Web Interface Data Point Li...

Page 4: ...w form urlencoded Method 40 Example Input Format POST 41 Minimum XML Input 41 Expanded XML Input 41 Special Note for XML Strings 42 Minimum JSON Input 42 Expanded JSON Input 42 Special Note for JSON S...

Page 5: ...64 Change of State COS Configuration 65 Diagnostics Info 66 Diagnostics Data and String Mapping 66 Diagnostics Modbus TCP IP Client 67 Diagnostics Web Interface 71 Diagnostics Web Interface 74 LED Con...

Page 6: ...y for Mapping Configuration buffer too small 2 Update for String Translator Web Display for Mapping Configuration buffer too small 5 2 14 5 4 17 Bug Fixes 1 Completely removed unit id from MS protocol...

Page 7: ...re the 460MCWI N2E 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 If at any ti...

Page 8: ...h 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 2 O...

Page 9: ...Real Time Automation Inc 9 1 800 249 1612 Hardware N2E Powering the Gateway An 8 24 VDC power source to the gateway Red Wire Black Wire a The unit draws a maximum 500mA 12V...

Page 10: ...Port 1 Used AND b Ethernet Port 2 Used Switch Mode Only Ethernet Port 1 is used for protocol communication One Ethernet based protocol on the IP Network layer 2 switch a Ethernet Port 1 Used for dire...

Page 11: ...e under the DIN Rail 3 While pressing the 460MCWI N2E against the rail press up to engage the spring loaded lower clip and rotate the unit parallel to the DIN Rail 4 Release upward pressure Removing F...

Page 12: ...dress to match that of your PC if DHCP has failed i You will know DHCP has failed if the gateway s IP address is AutoIP at 169 254 X Y ii If successful it will say DHCP d at ex 192 168 0 100 or howeve...

Page 13: ...fault Gateway 2 The gateway must be on the same Network Subnet as the PC whether it s setup for DHCP or Static Once you have both devices on the same network you should be able to ping the gateway usi...

Page 14: ...s can be made before a restart but they will not be committed until the gateway is restarted When all desired changes have been made press the Restart Now button The webpage will redirect to our reboo...

Page 15: ...led Configuration cannot be changed during Running Mode If changes are needed click the Configuration Mode button shown in the green box below Configuring Mode Protocol communication is stopped and no...

Page 16: ...ice Configuration The device configuration area is where you assign the device description paramter Changes can only be made when the gateway is in Configuration Mode Once you are done configuring the...

Page 17: ...Once you are done configuringthe 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 A...

Page 18: ...s Enter the length of time to delay between read and write scan line requests ms 3 Response Timeout Enter the amount of time the gateway should wait before a timeout is issued for a read write request...

Page 19: ...y configured from another server click the Select dropdown and select the Add from Modbus TCP IP X option where X represents the server you wish to copy parameters from Once created you can make any a...

Page 20: ...on 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 If the bytes appear in th...

Page 21: ...may select string as a point type in Modbus With this point type 2 characters will be packed into a single register and the first register will be set aside for the length EX 4x Hold Reg String with a...

Page 22: ...int type in Modbus With this point type 2 characters will be packed into a single register and the first register will be set aside for the length EX 4x Hold Reg String with a Starting Address of 1 fo...

Page 23: ...ameters button Below is the Scan Line Data Limit for each Point Type and the max Length Range associated to them Note If the first address of the Modbus TCP IP Server device starts at 0 Register Coil...

Page 24: ...side of the gateway configure the Automatic Data Transfer to User Host section Then proceed with the rest of the Web Interface Data Point List Configuration section of this manual 2 Server where the g...

Page 25: ...Basic HTTP Authentication is subject to interception by a third party on an improperly secured network 4 Data Format Select whether the file should be in XML or JSON format 5 Update Rate Enter in a t...

Page 26: ...nts total There are three ways to configure this protocol Auto Configure Group by Device Default Auto Configure Group by Data Type Manual Configure NOTE You may go back and forth between modes but whe...

Page 27: ...Bit Int data will be mapped as INT 32 bit Any 64 Bit Int data will be mapped as INT 64 bit Any 8 Bit Unsigned Int data will be mapped as UINT 8 bit Any 16 Bit Unsigned Int data will be mapped as UINT...

Page 28: ...th the first device it will auto configure all the points for the second device if one is configured and so on Group by Data Type Group by Data Type goes through the other protocol on the gateway and...

Page 29: ...to Manual Configure Mode click the dropdown at the top of the Web Interface Configuration page and select Manual Configure a When prompted click OK to confirm mode change or Cancel to remain in Auto...

Page 30: ...pitalization will be maintained in the generated XML JSON as it was originally entered on this page After a name is entered a verification check will run on this page to determine if the entered name...

Page 31: ...en in Auto Configure Mode these fields are not configurable The Group Configuration page allows customization of each Group Name and Device Name The gateway allows 16 possible groups Within each group...

Page 32: ...ce name o No two group names may be the same o No two device names may be the same o Reserved names of DeviceName GroupName dataTimeStamp and Diagnostics may not be used Name must be between 1 16 char...

Page 33: ...ge to determine if the entered name is valid If a name is entered that fails one of the criteria described above the invalid name will be automatically changed back to the last valid name In addition...

Page 34: ...nfig Section The examples in this document will use 192 168 0 1 for the sake of illustration but your IP will likely be different The most basic GET request that can be sent to the 460WI encodes all o...

Page 35: ...for an individual device the red italicized text in brackets indicates the information you need to fill in depending upon your gateway s IP address how you would like the data encoded JSON or XML and...

Page 36: ...encoded data Advanced Optional XML Data Direction Annotation An additional option when requesting all the data from the Gateway in XML format is to include the annotateio true option in the request UR...

Page 37: ...name of name the Device and the Group associated with that element The dataTimeStamp tag indicates the time and date when the data was read from the gateway based upon the time configured in the gatew...

Page 38: ...04T21 06 50 dataTimeStamp Power 237 Power Current 344 Current Device Device GroupName Breaker_Set_A GroupName DeviceName Breaker_2A DeviceName dataTimeStamp 2016 07 04T21 06 50 dataTimeStamp Current_...

Page 39: ...ethod itself the primary functional difference between the two methods is that the multipart form data method may be used to write all the Devices and Data Points configured in the 460WI with a single...

Page 40: ...uests to read data from a device configured in the Gateway the encoding segment of the path JSON or XML is omitted in this case There is no hard limit to the number of points that can be written with...

Page 41: ...At minimum the XML POST is the Devices root element and at least one Device child element containing the matching DeviceName tag of the Device to be written to and finally at least one writable Data P...

Page 42: ...imum JSON Input At minimum a valid JSON post must include the root array one Device Object which must include the DeviceName name value pair member to identify the device followed by at least one writ...

Page 43: ...ert the standard JSON escape sequences to their ASCII equivalents when passing the STRING value to the mating protocol The reverse is also true when reading STRING data from the mating protocol The ex...

Page 44: ...e details Option 2 String Auto Configure The gateway will automatically take the string data type from one protocol and map it into the other See String Auto Configure section for more details Option...

Page 45: ...tocol 1 to Protocol 2 or Protocol 2 to Protocol 1 button correlating to the direction you wish to see the data This page is very useful when verifying that all data is mapped somehow from one protocol...

Page 46: ...m Modbus registers 400001 400005 and therefore can pass the data on to the PLC tag called MC2PLC_INT The 460 gateway has NOT received valid responses from Modbus register 400011 400012 As a result the...

Page 47: ...ex and ASCII 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 In the example below this page refl...

Page 48: ...r data type If the Auto Configure function does not map the data as you want or you want to add modify the mappings you may do so by going into Manual Configure mode The following are examples of the...

Page 49: ...then only 1 operation is allowed c Select the Operation s to perform i Math Operations are performed in the order they are selected ii If more than one point is selected on the source the Math Operat...

Page 50: ...except manipulations will be conducted against the 64bit floating point to allow for large data 3 Ticks Per Second a The gateway operates at 200 ticks per second This equates to one tick every 5ms Th...

Page 51: ...ult 0x80 7 128 nonrecoverable fault For this example the ETC Status is mapped to a PLC tag called PLC_Status Example ETC Status is 0x00000013 19 decimal here is the break down Hex Bit Decimal Explanat...

Page 52: ...e fault config err 0x10 28 268 435 456 Configuration Mode 0x20 29 536 870 912 No Ethernet Cable Plugged In For this example the MC Status is mapped to a PLC tag called MC_Status Example MC Status is 0...

Page 53: ...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...

Page 54: ...ed to Manual Configure Mode or click Cancel to remain in Auto Configure Mappings Mode Once OK is clicked there are 2 options on how to proceed from here 1 To keep the mappings that are already configu...

Page 55: ...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 an...

Page 56: ...at register 1 and want to see if 400011 is mapped If it is not in this text box then it is not mapped and no data will be transferred This is the text display for the example shown under the Data Mapp...

Page 57: ...ax of 32 characters case sensitive a Re enter the Password 4 E mail In case the password was forgotten a user can have their password e mailed to them if e mail was configured 5 Hint A helpful reminde...

Page 58: ...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 co...

Page 59: ...word This is used to reset security settings Confirm reset password must be selected to confirm this action Once confirmed there is a 15 minute window to do a hard reset of the gateway by physically r...

Page 60: ...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 4 From E mail Enter th...

Page 61: ...ction a Top dropdown select the Data Group This dropdown menu will contain all groups that go from the gateway to the network b Lower dropdown select the Data Point s Specific Point This is used to se...

Page 62: ...he 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 This will make the alarm unique and will be ava...

Page 63: ...either OK or ALARM 8 of Times Active This count represents the number of times this alarm has become active If an alarm is triggered this count will increment Alarms Active While one or more alarms a...

Page 64: ...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 d...

Page 65: ...his is to be used to prevent jitter Default value is 0ms This timer takes priority over the Stale Data Timer There is a separate timer per data mapping This timer is active only after the first write...

Page 66: ...t are enabled Error The number of mappings that are enabled that have an error First Error This is a detailed description of the first mapping that has an error Common Errors 1 Destination or Source P...

Page 67: ...will return all values displayed to zero and clear the Status Strings Example If viewing Modbus TCP IP Client MC02 10 1 100 17 this will only clear the values for that specific device This will reduc...

Page 68: ...n 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...

Page 69: ...se messages not received by the gateway Status Strings These are the values for All Servers or the specific server selected 1 Last Error Code a Last read request error that the gateway received Error...

Page 70: ...1 trying to read a single coil for any number of points IP 10 1 50 27 is the address that sent the error N 1 from device 1 This was setup as Unit ID in Modbus TCP IP Client page A 1 Starting address o...

Page 71: ...to zero and clear the Status Strings 2 If the view is set to Web Interface this will only clear the values for the Web Interface section of the gateway Device Status 1 Connected and Running The gatewa...

Page 72: ...o Device or data point referenced does not exist in the gateway o Invalid data type for data point referenced Failed GET 403 Forbidden Number of times a GET request came from an unauthorized IP addre...

Page 73: ...r Overflow iii Internal POST Error 500 c HTTP Errors i Error 404 URL Invalid d URL Encoded POSTs Will show Invalid Post Attempt followed by one of the following i POST to invalid Device Device Name ii...

Page 74: ...ction of the gateway Device Status 5 Connected The gateway is successfully servicing HTTP GET or HTTP POST operations 6 Not Connected The gateway has never serviced any HTTP GET or HTTP POST operation...

Page 75: ...on successfully connected to the configured remote server and received an HTTP status code Client Connection Errors Number of times the Automatic Data Transfer to User Host gateway function failed to...

Page 76: ...a HTTP Client Post rejected by server Responded xxx xxx is an HTTP status other than 200 b HTTP Client Invalid Socket c HTTP Client Socket Closed d HTTP Client Socket Read Failed e HTTP Client Socket...

Page 77: ...otocol 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 To select a particular Slave Ser...

Page 78: ...onfiguration file or a configuration file from another device into the 460 gateway whenever it is in Configuration Mode Upon clicking the Choose File button you will be prompted to select a location f...

Page 79: ...m gateway you wish to copy the configuration from 2 Power up the gateway you wish to copy the configuration to DO NOT INSERT SD CARD YET 3 Navigate to the webpage inside the unit 4 Navigate to the dro...

Page 80: ...rdware 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 2 After 5 seconds t...

Page 81: ...red in the Flash File System 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 Once you have...

Reviews: