RTA 460ETCWI-N2E Product User Manual Download Page 47

Page: 47 / 97

Real Time Automation, Inc.

1-800-249-1612

Note that the string of data point names to filter by begins with a question-

mark (‘?’) after the

group

name and each name is separated by an ampersand (‘&’). The ordering of the points’ names does not

matter.

Summary of Contents for 460ETCWI-N2E

Page 1: ...Real Time Automation Inc 1 1 800 249 1612 Firmware Version 8 7 22 460ETCWI 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: ...s Auto Configure Group by Data Type 22 Group by Device Default Method 22 Group by Data Type 22 External PLC Configuration Manual Configure Mode 23 Configuring Read and Write Scan Lines 25 Access Progr...

Page 4: ...ription of Format Both XML and JSON 49 XML Output 50 JSON Output 50 Writing Data to the Gateway 51 Which method to use 51 The multipart form data Method 51 The application x www form urlencoded Method...

Page 5: ...il Configuration 79 Alarm Configuration 80 Diagnostics Alarm Status 82 Alarms Active 82 Alarms Clear 83 Change of State COS Configuration 84 Diagnostics Info 85 Diagnostics Mapping 85 Diagnostics Alle...

Page 6: ...7 4 9 1 20 Features Added 1 BMS BM DFM DS DM TCP USB PBS have been ported to the latest base software 2 TCP BMS BM now Available on N2E and N2EW hardware Platform 3 New ASCII Mode Available on TCP A U...

Page 7: ...gure the 460ETCWI N2E gateway For further customization and advanced use please reference the appendices located on the CD or online at http www rtautomation com product 460 gateway support If at any...

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: ...er the gateway 1 2 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 opera...

Page 10: ...max Supervised The unit is certified to be operated at 40 C to 50 C Instructions d alimentation et d installation pour environnement dangereux Cet quipement est con u pour tre utilis uniquement dans d...

Page 11: ...e under the DIN Rail 3 While pressing the 460ETCWI 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...

Page 12: ...ogram from the CD ROM 3 Find unit under Select a Unit a Change Gateway s IP address 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...

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: ...ed after every change Multiple changes 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 T...

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 parameter Changes can only be made when the gateway is in Configuration Mode Once you are done configuring th...

Page 17: ...twork 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 Addre...

Page 18: ...col communication 3 One Ethernet based protocol on the IP Network layer 2 switch a Ethernet Port 1 used for direct protocol communication b Ethernet Port 2 available for daisy chaining devices togethe...

Page 19: ...ernet port only 1 Delay Between Messages Enter the length of time to delay between read and write scan line requests ms 2 Response Timeout Enter the amount of time the gateway should wait before a tim...

Page 20: ...l Mode will be discarded 1 To add additional PLCs click the Select dropdown under Allen Bradley PLC Device List and select Add Generic PLC option a To remove a device navigate to the server to delete...

Page 21: ...y 32 bit 7 Any String Data Types will be mapped as String If the PLC is a MicroLogix SLC or PLC5E the data will be configured according to the following rules 1 Any 8 Bit Signed Unsigned and 16 Bit Si...

Page 22: ...he other protocol on the gateway and auto configures the data groups on the Allen Bradley PLC for all the data points within the other protocol Another way to view this option is to say that the data...

Page 23: ...r you want to modify the scan line s that already exist 4 To delete the scan lines that are already there and start over press Cancel 5 To add additional PLCs click the Select dropdown under Allen Bra...

Page 24: ...ly maintain a connection when there is data needed to be transferred then Unconnected UCMM will work best if you are only writing to the PLC Connected Class 3 Explicit messaging relies on reserved res...

Page 25: ...e and close the connection until a Change of State Leaving it at Connected messaging once we receive data the RTA gateway will constantly be writing to the PLC to maintain that connection a If you wis...

Page 26: ...to the gateway See the Scan Line Data Limit section at the bottom of the page for the given max values a If using a CompactLogix or ControlLogix below are the scan line data limits b If using a Contr...

Page 27: ...Real Time Automation Inc 27 1 800 249 1612 d If using a SLC 5 05 or PLC5E below are the scan line limits 5 Click the Save Parameters button 6 Repeat for the other direction if needed...

Page 28: ...additional syntax If you are using a tag that is defined within Program Scope then the tag name inside of the RTA gateway needs additional syntax for it to successfully communicate Example AnotherTag...

Page 29: ...ore setting the Handshake value equal to Trigger value How does this work 1 Read ETC Optimized Trigger tag until Change of State a Value 0 Enabled but Not valid value b Value 65535 Disabled 2 Map the...

Page 30: ...date the RTA_Opt_Trigger PLC tag to 1 7 Now your ASCII device will be updated with the data 8 Increment the RTA_Opt_Trigger PLC tag 9 Your ASCII device will get update again regardless if data is new...

Page 31: ...te Scan line that updates the PLC with the Handshake from the RTAgateway Handshake tag can be unique to your PLC program 3 Within the ETC configuration setup a PLC tag that you can identify as your Op...

Page 32: ...date your Read Scan Line tag with new data 12 Increment the RTA_Opt_Trigger PLC tag again 13 Now your ASCII device will be updated with the new data 14 In a working application the Handshake tag in yo...

Page 33: ...es in which the Web Interface may operate in the gateway a Sever Mode b Client Mode Web Interface Gateway Server Configuration 1 Server Mode where the gateway acts as a web server and responds to HTTP...

Page 34: ...pload php b http 192 168 100 1 8080 if special port 8080 is to be used c http yourserver yourdomain 8080 upload asp if special port 8080 is to be used 2 Username Password If the Destination URL entere...

Page 35: ...t over to the web sever Next time the operator sends the same data HelloWorld The WI side gathers the data but the data didn t change so it will not be sent over to the WI portion of the RTA gateway T...

Page 36: ...h direction in the web interface may be configured for up to 1000 data points there is an overall limit between the read and write direction of 1000 data points total There are three ways to configure...

Page 37: ...Int data will be mapped as INT 32 bit 8 Any 64 Bit Int data will be mapped as INT 64 bit 9 Any 8 Bit Unsigned Int data will be mapped as UINT 8 bit 10 Any 16 Bit Unsigned Int data will be mapped as U...

Page 38: ...s two devices with the following setup Device_1 has 1 integer scan line 1 float scan line 1 integer scan line each for 1 point of data Device_2 has 1 integer scan line 1 float scan line each for 2 poi...

Page 39: ...ant to modify the data point s that already exist 4 To delete the data points that are already there and start over press Cancel Configuring Read and Write Data Points Follow these steps to manually c...

Page 40: ...teway 3 Enter a Name for the data point This name will be used in the XML JSON and must follow the following rules a Consist only of alphanumeric characters and the underscore character no spaces b Le...

Page 41: ...ify the name please see the Web Interface Group Configuration page i If the other protocol is a client master with multiple slaves servers typically this device field is used to represent each of thos...

Page 42: ...shows how you would configure the data points Since we want to monitor 4 points on each floor you ll need a total of 12 points Once the Groups and Devices have been defined come back to this page to a...

Page 43: ...must not start with a number 5 Name must not start with the string XML NOTE Although the names are case insensitive the original capitalization will be maintained and used in the XML JSON 6 After a n...

Page 44: ...Real Time Automation Inc 44 1 800 249 1612 8 When done making changes click the Save Parameters button...

Page 45: ...ing enter Basics To begin you will need to know the IP address of your 460WI Gateway If you do not know the IP address refer to Accessing the Main Page Section The examples in this document will use 1...

Page 46: ...questing an individual device For example to request data encoded as XML for a group of devices named Breakers_West the URL would be http 192 168 0 1 gateway xml group Breakers_West The format is http...

Page 47: ...n Inc 47 1 800 249 1612 Note that the string of data point names to filter by begins with a question mark after the group name and each name is separated by an ampersand The ordering of the points nam...

Page 48: ...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 49: ...as shown below Description of Format Both XML and JSON 1 The GroupName and DeviceName tags contain the name of name the gevice and the group associated with that element 2 The dataTimeStamp tag indica...

Page 50: ...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 51: ...ON is inconvenient Aside from the encoding method 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...

Page 52: ...on Inc 52 1 800 249 1612 your data the name attribute you should use is WI460XMLData and if you are using JSON the name attribute you should use is WI460JSONData Your application scripting language or...

Page 53: ...eway 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 a single urlencoded post but the urlencoded string sho...

Page 54: ...put 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 da...

Page 55: ...uivalent characters before writing the STRING data to the other protocol The reverse is also true when reading STRING data from the other protocol Minimum JSON Input At minimum a valid JSON post must...

Page 56: ...gle JSON write Special Note for JSON Strings There is an additional consideration when writing STRING data types The gateway recognizes and will convert the standard JSON escape sequences to their ASC...

Page 57: ...eway 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 3 Manual Configure Mappings If you don t want to...

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

Page 59: ...3 on BACnet NOTE If a data point is mapped twice only the first instance of it will show here EX If Modbus 400001 400040 from Slave 1 are both mapped to AI1 only 400001 will show as being mapped to AI...

Page 60: ...iew 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 det...

Page 61: ...ps from a string click the dropdown menu to generate the information regarding that device The string data will be displayed in both Hex and ASCII only the ASCII data is sent The example below shows d...

Page 62: ...Info drop down and navigating to ASCII Diagnostics page You will also have to select the port you want to view in the dropdown below ASCII To view the string mappings click the Edit Mapping button Fo...

Page 63: ...on would look like my example below There are more detailed examples of what all the fields represent in the ASCII Parsing section The message is broken up into 3 Groups or Parsing fields To view the...

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

Page 65: ...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 66: ...ase In this example Ram0 is scaled into Ram1 Ram1 is then increased by 5 and stored into Ram2 Ram0 and Ram2 could be considered a source or destination group 2 Temporary Ram Double a This is like the...

Page 67: ...ys 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 wil...

Page 68: ...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 69: ...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 70: ...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 71: ...ual 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 configured press...

Page 72: ...op 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...

Page 73: ...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 74: ...ake value is set equal to Trigger value 5 Map Handshake to reference data point Note is an internal reference to the Server Slave number you are settings up ex RTA Server Slave products can only be Tr...

Page 75: ...ppings 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 da...

Page 76: ...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 77: ...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 78: ...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 79: ...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 80: ...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 81: ...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 82: ...m 7 Status The current status of the alarm 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 incremen...

Page 83: ...hen 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...

Page 84: ...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 85: ...larm that was active Common Errors 1 Destination or Source Point does not exist a Solution Re map the mapping 2 Source or Destination Pointer too small a There is not enough space on either the Source...

Page 86: ...lear All Values This will only affect displayed values 1 This will reset all displayed values back to zero and clear the Status Strings Example If viewing Allen Bradley PLC ETC01 10 1 100 18 this will...

Page 87: ...ng connection can be determined from the Network Bitmap Status value 4 Communication not attempted yet Flashing Red Specific Server Only No reads are configured and data needed for writes isn t valid...

Page 88: ...C to the gateway Common Error Strings These are the values for All PLCs or the specific PLC selected 1 IP xxx xxx xxx xxx tagname 04 Path Segment Error The tag name is wrong or the tag is not defined...

Page 89: ...T operations and the inactivity timeout if configured has not expired 2 Connected Idle The gateway is servicing HTTP GET or HTTP POST operations and the inactivity timeout has expired 3 Not Connected...

Page 90: ...e for data point referenced 8 Failed GET 403 Forbidden a Number of times a GET request came from an unauthorized IP address or an IP address without enough READ privileges 9 Failed POST 403 Forbidden...

Page 91: ...File Post Procedure b Internal Errors Should rarely see and indicated a major problem in the gateway i XML JSON Output I O Failure ii XML JSON Output Buffer Overflow iii Internal POST Error 500 c HTT...

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

Page 93: ...her 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 from which to load the saved file Once the location...

Page 94: ...tered 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...

Page 95: ...y 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 dropdown Ot...

Page 96: ...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 97: ...tored in the Flash File System within the gateway Identify your device by clicking the Start Flashing LEDs button By clicking this button the two diagnostic LEDs will flash red and green Once you have...

Search results

Summary of Contents for 460ETCWI-N2E

Reviews:

Related manuals for 460ETCWI-N2E

Brands by name

Popular brands

RTA 460ETCWI-N2E, Product User Manual

Search results

Summary of Contents for 460ETCWI-N2E

Reviews:

Related manuals for 460ETCWI-N2E

Brands by name

Popular brands