A Sierra Monitor Company Utility User Manual Ruinet APPLICABILITY & EFFECTIVITY Effective for all systems manufactured after May 1, 2001 Version: 1.10 Rev.
Ruinet Utility User Manual Table of Contents TABLE OF CONTENTS 1. GENERAL OVERVIEW .....................................................................................................4 1.1. PC Requirements ...........................................................................................................4 1.1.1. Hardware.................................................................................................................4 1.1.2. Software ................................................
Ruinet Utility User Manual Table of Contents Appendix B.2. Appendix B.3. Appendix B.4. Appendix B.5. Appendix B.6. Appendix B.7. Appendix B.8. Appendix B.9. Appendix B.10. Appendix B.11. Appendix B.12. Appendix B.13. Appendix B.14. Appendix B.15. Appendix B.16. Appendix B.17. Appendix B.18. Appendix B.19. Appendix B.20. Appendix B.21. Appendix B.22. Connecting to a FieldServer using Name -y..................................................37 Broadcast Mode -ib .............................................
Ruinet Utility User Manual Page 4 of 46 1. General Overview The Ruinet Utility is used to: • Transfer files (configuration, firmware, etc ) to and from a FieldServer • Monitor a working FieldServer’s internal data and parameters • Change or update a FieldServer’s internal data and parameters • Delete files on a FieldServer • Restart a FieldServer 1.1. 1.1.1. PC Requirements Hardware Ruinet works over an Ethernet network so a TCP/IP enabled PC with a network card is required.
Ruinet Utility User Manual Page 5 of 46 2. Remote User Interface (RuiNet) The notes in this section explain how to navigate the menu system provided by RuiNet and provide information on the contents of the various screens. 2.1. A – Connecting to a FieldServer Since RuiNet can only work with one FieldServer at a time, it is necessary to target the FieldServer of interest. (Note that it is possible to run multiple instances of RuiNet at the same time).
Ruinet Utility User Manual Page 6 of 46 FieldServer Name. (Specified in ‘FieldServer, Title’ section of the CSV file). Press one of these keys to select the option. List of other action keys. Some of these keys only work in Expert Mode. Read the Advanced Notes on Tiers. Figure 2.2 2.2. B - FieldServer Information FieldServers were previously known as bridges, hence the use of the B key to access the screen displaying general information about a FieldServer.
Ruinet Utility User Manual Page 7 of 46 2.2.1. FieldServer Information – Settings Aspect Parameter Tier FieldServer_Name N1 IP Address N1 Netmask N1 Gateway 1 N2 IP Address N2 Netmask N2 Gateway 1 Cache_Age_Limit Cache_Time_To_Live Cache_Size System_Node_ID Network_number Hot_Standby_Mode Port_Expander_Mode Cache_Map_Descriptor_ Scan_Interval Hot_Standby_Designation Hot_Standby_Pair_Name Description FieldServers have the ability to run as “multiple” FieldServers on one platform.
Ruinet Utility User Manual Page 8 of 46 2.2.2. FieldServer Information – Status Aspect Parameter Description FieldServers have the ability to run as “multiple” FieldServers on one Tier platform. To differentiate between the different running applications, each of the applications is referred to as a Tier with a specific name. The part of the FieldServer firmware that contains the drivers ordered. Driver Configuration Each combination of drivers is known as a DCC.
Ruinet Utility User Manual Page 9 of 46 Parameter 2.3. Description shipped without the time or date set and hence the value shown here is meaningless until the FieldServer time is synchronized with the computer’s. O - Connection Overview This is one of the most important information screens provided by RuiNet. It supplies information on communication between the FieldServer and remote devices. A number of aspect screens are available, and some of the aspect screens have more than one page.
Ruinet Utility User Manual Page 10 of 46 This is the aspect name “Settings”. An aspect is a collection of related information. To view next connection, use the arrow keys. See a filtered list of nodes which displays only those nodes which are using the connection currently displayed on the screen. Figure 2.5 – Connection Overview – Settings aspect – Page 1 FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.
Ruinet Utility User Manual Page 11 of 46 2.3.1. Connection Overview – Settings Aspect. Parameter Connection Adapter Description The current connection out of the total number of connections. An adapter ID is displayed if the driver is an adapter driver. The minimum amount of time that must pass between one Client Map Poll_Delay Descriptor completing its task and the next Client Map Descriptor being serviced. Refer to Driver Manuals.
Ruinet Utility User Manual Page 12 of 46 Parameter Application 2.3.2. Parameter Connection Timer Description Connection Overview - Status Aspect Description The current connection being displayed out of the total number. The use of this variable to determine timeouts is driver dependent and has no consistent meaning. In passive drivers this variable may not have been used at all. In simple poll response drivers this variable should decrease from its maximum (equal timeout value) to zero.
Ruinet Utility User Manual Page 13 of 46 2.3.3. Connection Overview - Statistics Aspect Connection statistics are a roll-up of all the statistics maintained by the Nodes and Map Descriptors using the connection. For example: If three Map Descriptors use a single connection then each time a message is sent for each Map Descriptor, the Map Descriptor, Node and connection statistics are all updated. Thus response time statistics are more meaningful when viewing individual nodes and Map Descriptors.
Ruinet Utility User Manual Page 14 of 46 Parameter Cache - Created Cache - Bumped Pex Write Thru Server Response Max Server Response Avg Link Control Who-Is-Router-To-Network I-Am-Router-To-Network Reject-Msg-To-Network Messages Reconstructed Unsupported Property Unsolicited Messages Recd Single Write Single Item Read Block Write Block Read Sequence Error Data Object Startup Expedite Read Expedite Write Fasttrack Read Fasttrack Write Fasttrack Overrun Read Fasttrack Overrun Write Max Read Response Time
Ruinet Utility User Manual Page 15 of 46 Parameter Avg Passthru Response Time TCP Conn Lost TCP Send Failed Description Number of times a TCP connection was lost or interrupted. Number of times a message sent on TCP connections failed. FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.
Ruinet Utility User Manual Page 16 of 46 2.3.4. Connection Overview - Error Statistics Aspect Parameter Connection PEX No slave Server Overruns Server Hold Timeouts Timeouts Checksum Errors Protocol Errors Noise Bad Length Bad Node Bad Function No Start PLC exception NAK Streaming Premature Preamble IC Timeouts Address Errors Data Object offline Node Offline Description The current connection being displayed out of the total number.
Ruinet Utility User Manual Page 17 of 46 Parameter Description external device trying to access it. Messages received but unable to be processed - normally Msg Ignored because the driver has not implemented functionality for that message. The number of times that Data Arrays were cleared after a Sys Cleared system-normal type message was received from a device (e.g. fire alarm panel) The number of bytes received during the squelch timing period 2 Squelch TX started when RTS is asserted.
Ruinet Utility User Manual Page 18 of 46 Parameter Connection TX bytes TX packets TX dropped TX errors RX IP fragments Collisions TX abort errors TX carrier errors TX heartbeat errors TX window errors Max TX buffers used Tx buffers in use Tx broadcast RX bytes RX pkts total RX pkts for us RX pkts NOT for us RX dropped RX errors RX length errors RX overflow errors RX crc errors RX frame errors RX frame errors RX buffer full RX ring buffer error RX IP type RX ARP type RX BACNET type RX 802_3 type RX UNKNOWN
Ruinet Utility User Manual Page 19 of 46 Parameter RX IP not for us Max RX buffers used Rx buffers in use 2.4. Description The number of received IP packets not meant for the FieldServer. The maximum number of receive buffers used since restart. The number of receive buffers currently in use. N - Node Overview Node number - type number to go to detail for that node, e.g.
Ruinet Utility User Manual Page 20 of 46 2.4.1. Node Overview - Settings Aspect Parameter Node Adapter Node_Name Description The current node being displayed out of the total. The adapter name where a node is connected to an adapter. The node name specified in the CSV file. The station number or address of the node. The actual meaning is Node_ID dependent on the driver and protocol – refer to the Driver Manual. The protocol being used to update the data for that node.
Ruinet Utility User Manual Page 21 of 46 Parameter 2.4.2. Description PLC to poll. Node Overview - Status Aspect Parameter Node Description The current node being displayed out of the total. For a client node. Online, offline, disabled or probation. Probation means that the node is in transition from offline to online. The node was offline, a poll has succeeded but the probation timeout has not expired so the node has not been returned to online yet.
Ruinet Utility User Manual Page 22 of 46 Parameter Node Client Read Msg sent Client Read Msg recd Client Write Msg sent Client Write Msg recd Client Passthru Msg sent Client Passthru Msg recd Client Broadcast msg Client Bytes Sent Client Bytes Recd Server Msg recd Server Msg sent Server Bytes Sent Server Bytes Recd Cache - Hits Cache - Misses Cache - Created Cache - Bumped PEX Write thru Server Response Max Server Response Avg Link Control Messages Reconstructed Unsupported Property Unsolicited Messages Re
Ruinet Utility User Manual Page 23 of 46 Parameter TCP Send Failed 2.4.4.
Ruinet Utility User Manual Page 24 of 46 2.5. M – Map Descriptor Overview Type number to go to detail for that Map Descriptor - e.g. Type 02 to navigate to detail for the Map Descriptor called “MapDesc2” Push the R key to set all stats for all Map Descriptors to zero. This doesn’t affect the operation of the FieldServer, drivers or communications to remote devices. Every attempt is made to standardize the way in which drivers report stats but in some drivers unavoidable differences exist.
Ruinet Utility User Manual Page 25 of 46 2.5.1. Map Descriptor Overview - Settings Aspect Parameter Map Descriptor Node_ID Protocol Map_Descriptor_Name User_Address Length Block_Type Data_Array_Name Data_Array_Offset Function Scan_Interval Description The current Map Descriptor being displayed out of the total The Node ID used by this Map Descriptor when the driver builds read or write messages.. The protocol used by this Map Descriptor. Used to identify a Map Descriptor by name.
Ruinet Utility User Manual Page 26 of 46 2.5.3.
Ruinet Utility User Manual Page 27 of 46 Parameter TCP Conn lost TCP Send Failed 2.5.4.
Ruinet Utility User Manual Page 28 of 46 2.6. A – Data Array Overview Type number to go to detail for that array. E.g. Type 02 to navigate to detail for array DA_AI_02 Time elapsed since any element of array was last updated. If the list is longer than one page use PgDn/Up keys. Format used when accessing data in the Data Array. ESC key returns you to the main menu. Number of elements in the Data Array. Figure 2.10 – Data Array Overview Screen 2.6.1.
Ruinet Utility User Manual Page 29 of 46 2.7. E – Error Messages The error screen contains messages printed by the FieldServer kernel as well as messages from many drivers. Starting late in 2002, drivers started sending their messages to the F Screen. The error screen is a circular buffer which can hold a limited number of lines of information. Once full, as each new line is added to the bottom of the buffer, the top line is removed.
Ruinet Utility User Manual Page 30 of 46 2.9. D – Download Configuration to FieldServer Press D to enter the file download screen. Download means to transfer a file from your PC to the FieldServer. Figure 2.14 Update firmware. Push the F key and the file fserver.img will be downloaded from the config folder. Path names are allowed when you type in the local file name. Path names are not allowed when you type in the remote file name. Use the O key to enable the downloading of ‘other’ files.
Ruinet Utility User Manual Page 31 of 46 2.10. U - Upload Configuration from FieldServer Press U to enter the file upload screen. Upload means to transfer a file from the FieldServer to your PC. Figure 2.16 Use the O key to enable the uploading of ‘other’ files. When enabled you can upload files other than .csv from the FieldServer. Please exercise caution with this option. Figure 2.17 2.10.1.
Ruinet Utility User Manual Page 32 of 46 2.11. I - Change IP Address From the main menu, press “I” to enter the Edit IP Address Settings menu. 2.11.1. • • • • Procedure to Change a FieldServer’s IP Address Press “1” to modify the IP address of the N1 Ethernet adapter or “6” to modify the IP address of the N2 Ethernet adapter (if available on the FieldServer). Type in a new IP address such as 192.168.0.35 and press . If necessary, press“2” or “7” and change the netmask. Restart the FieldServer.
Ruinet Utility User Manual Page 33 of 46 If the FieldServer cannot contact a DHCP Server, the FieldServer will use the last good IP address it was configured with. 2.11.3. Obtain the IP address using the FieldServer’s DHCP Server The FieldServer can be used as a DHCP Server to allocate an IP address to a PC or Laptop that you want to use to connect with RuiNet to the FieldServer. Enable the DHCP Server on the FieldServer.
Ruinet Utility User Manual Page 34 of 46 ipconfig /release * ipconfig /renew * The FieldServer checks every few minutes for the existence of other DHCP Servers and will disable itself if any are detected. A message on the RuiNet E screen will indicate when the DHCP Server has been disabled. 2.12. K - Change UI Display Mode Press one of these keys O, N or E to change to the indicated User Interface Display mode. Figure 2.20 The Expert Mode allows viewing of the different FieldServer tiers.
Ruinet Utility User Manual Page 35 of 46 RuiNet will display the main interactive menu again after the FieldServer has restarted. FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldserver.
Ruinet Utility User Manual Page 36 of 46 Appendix A. Troubleshooting Appendix A.1. Connection to a FieldServer The following situations can prevent Ruinet from connecting to a FieldServer: • Bad or incorrect Ethernet cable. In this case the connection lights on the FieldServer and/or PC will not be illuminated either • Incorrect Ethernet card and/or protocol setup. In this case Ruiping probably won’t work either. Contact the Systems Administrator to have an Ethernet port set up correctly.
Ruinet Utility User Manual Page 37 of 46 Appendix B. Advanced Command Line Option Switches Appendix B.1. Connecting to a FieldServer using IP Address -i Specify the IP address using the -i switch. RuiNet –i192.168.0.45 RuiNet will only connect to the FieldServer with IP address 192.168.0.45 Appendix B.2. Connecting to a FieldServer using Name -y Specify a FieldServer’s name with the -y switch RuiNet –yModbus_Test RuiNet will connect to the FieldServer with the specified name. Appendix B.3.
Ruinet Utility User Manual Page 38 of 46 previously connected FieldServer, RuiNet connects to the first FieldServer in the list after 10 seconds. This behavior can be overridden by using the –m0 switch. When specifying this switch on the command line then RuiNet does not auto connect to any FieldServer. RuiNet –m0 Ensures presentation of a list and auto connection does not occur. Appendix B.6. Restart a FieldServer -b Tells RuiNet to restart a FieldServer. No confirmation to restart is requested.
Ruinet Utility User Manual Page 39 of 46 Appendix B.9. Downloading Files –u0 This command is used to transfer files from a PC to a FieldServer. In the following examples the target FieldServer is not specified. If there is a single FieldServer on the network then the files will be transferred to that FieldServer. If more than one FieldServer is connected to the network then RuiNet will provide a list and the transfer will begin once a FieldServer is selected from the list. RuiNet –ldelivery.
Ruinet Utility User Manual Page 40 of 46 Transfers the file config.csv from the FieldServer to the host computer where it will be saved as config.csv. It will be saved in the folder from which RuiNet was executed. Appendix B.11. Forcing a Download -o When downloading a file that already exists on the FieldServer, RuiNet checks if the file to be downloaded is identical to the file already on the FieldServer. If the files are identical, RuiNet responds that a download is not necessary.
Ruinet Utility User Manual Page 41 of 46 Appendix B.15. Help -h Prints a list of command line switches. If this command line switch is used then all others are ignored. RuiNet –h RuiNet prints out all options and exits. Appendix B.16. Create a Log File -a Instructs RuiNet to make a log file containing progress information. RuiNet –lconfig.csv –u0 –alog.txt RuiNet creates a log file called log.txt on host PC and logs the progress and results of the config.csv file download to the log file.
Ruinet Utility User Manual Page 42 of 46 Appendix B.19. Delete a File -z Delete a file on the FieldServer. Use this switch with extreme caution as no opportunity for confirmation to delete is provided. If RuiNet connects, the file will be deleted. RuiNet –zdefault.htm Deletes the file default.htm on the FieldServer that RuiNet connects to. RuiNet –i192.168.1.81 –zdefault.htm Deletes the file default.htm on a specifically targeted FieldServer. Appendix B.20.
Ruinet Utility User Manual Page 43 of 46 Appendix C. Advanced Topics Appendix C.1. The Ruinet Log File The Ruinet log file is created when the –a switch has been specified on the Ruinet command line. The log file contains time and date stamped entries that describe the actions performed by Ruinet. The log file is used by FieldServer technical support and developers for debugging purposes.
Ruinet Utility User Manual Page 44 of 46 Appendix C.3. Connecting to a FieldServer over the Internet The diagram below shows how this is typically done. LAN Interface WAN Interface WAN Interface LAN Interface PC Ethernet INTERNET FieldServer IP = 165.165.124.33 4) Ruinet -i165.165.124.
Ruinet Utility User Manual Page 45 of 46 Appendix D.
