Utility Manual RuiNet
Utility Manual RuiNet
Ruinet
Version: 1.10
Rev. 10
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 ..................................................................................................................4
1.2. Installation and Setup .....................................................................................................4
2. REMOTE USER INTERFACE (RUINET) ..........................................................................5
2.1. A – Connecting to a FieldServer.....................................................................................5
2.2. B - FieldServer Information.............................................................................................6
2.2.1. FieldServer Information – Settings Aspect ..............................................................7
2.2.2. FieldServer Information – Status Aspect .................................................................8
2.3. O - Connection Overview ...............................................................................................9
2.3.1. Connection Overview – Settings Aspect. ..............................................................11
2.3.2. Connection Overview - Status Aspect...................................................................12
2.3.3. Connection Overview - Statistics Aspect...............................................................13
2.3.4. Connection Overview - Error Statistics Aspect......................................................16
2.3.5. Connection Overview - API Aspect .......................................................................17
2.4. N - Node Overview .......................................................................................................19
2.4.1. Node Overview - Settings Aspect..........................................................................20
2.4.2. Node Overview - Status Aspect ............................................................................21
2.4.3. Node Overview - Operating Statistics Aspect........................................................21
2.4.4. Node Overview - Error Statistics Aspect ...............................................................23
2.5. M – Map Descriptor Overview ......................................................................................24
2.5.1. Map Descriptor Overview - Settings Aspect ..........................................................25
2.5.2. Map Descriptor Overview – Status Aspect ............................................................25
2.5.3. Map Descriptor Overview - Operating Statistics Aspect........................................26
2.5.4. Map Descriptor Overview - Error Statistics Aspect................................................27
2.6. A – Data Array Overview ..............................................................................................28
2.6.1. Data Array Detail Screen.......................................................................................28
2.7. E – Error Messages......................................................................................................29
2.8. F – Driver Messages ....................................................................................................29
2.9. D – Download Configuration to FieldServer .................................................................30
2.9.1. Procedure for Downloading a File from a PC to a FieldServer..............................30
2.10. U - Upload Configuration from FieldServer ...............................................................31
2.10.1. Procedure to Upload a File from a FieldServer to a PC ........................................31
2.11. I - Change IP Address...............................................................................................32
2.11.1. Procedure to Change a FieldServer’s IP Address.................................................32
2.11.2. Obtain the IP address using the DHCP Client.......................................................32
2.11.3. Obtain the IP address using the FieldServer’s DHCP Server ...............................33
2.12. K - Change UI Display Mode ....................................................................................34
2.13. Restart FieldServer ...................................................................................................34
APPENDIX A. TROUBLESHOOTING...................................................................................36
Appendix A.1. Connection to a FieldServer..........................................................................36
Appendix A.2. File Download................................................................................................36
APPENDIX B. ADVANCED COMMAND LINE OPTION SWITCHES...................................37
Appendix B.1. Connecting to a FieldServer using IP Address -i...........................................37
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: [email protected]
Ruinet Utility User Manual
Table of Contents
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: [email protected]
Ruinet Utility User Manual
Page 4 of 46
1. General Overview
1.1. PC Requirements
1.1.1. Hardware
Ruinet works over an Ethernet network so a TCP/IP enabled PC with a network card is
required. The network card must support 10Mbit/s Ethernet.
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: [email protected]
Ruinet Utility User Manual
Page 5 of 46
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.
Figure 2.1
If a FieldServer is not selected, RuiNet will automatically connect to the FieldServer last
connected to after about 10seconds.
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: [email protected]
Ruinet Utility User Manual
Page 6 of 46
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. The B Screen consists of two
aspects (settings and status). Use the spacebar to toggle between the two aspects. The
settings screen is depicted below. The various parameters are described more fully in the
tables that follow.
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: [email protected]
Ruinet Utility User Manual
Page 7 of 46
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: [email protected]
Ruinet Utility User Manual
Page 8 of 46
1
Cache blocks are temporary Map Descriptors created by the FieldServer to achieve certain objectives
such as a write through or port expansion. Because they are temporary this number rise and fall is not
visible. The read cache blocks persist until they expire after the cache_age_to_live time has expired.
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: [email protected]
Ruinet Utility User Manual
Page 9 of 46
Parameter 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.
2.3. 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.
Use the space bar to toggle between aspects and the PgUp, PgDn keys to toggle between
pages of the same aspect. The Connection Overview and Settings Aspect screens are
depicted below. The various parameters are described more fully in the tables that follow.
Push the R key to set all stats for all connections to zero. This doesn’t affect the
operation of the FieldServer, drivers or communications to remote devices.
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: [email protected]
Ruinet Utility User Manual
Page 10 of 46
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: [email protected]
Ruinet Utility User Manual
Page 11 of 46
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: [email protected]
Ruinet Utility User Manual
Page 12 of 46
Parameter Description
Application
2.3.2. Connection Overview - Status Aspect
Parameter Description
Connection 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
Timer
at all. In simple poll response drivers this variable should decrease from its
maximum (equal timeout value) to zero.
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: [email protected]
Ruinet Utility User Manual
Page 13 of 46
Parameter Description
Connection The current connection being displayed out of the total number
The number of read messages sent by a driver acting as a Client.
Client Read Msg sent
May include messages sent to connect to the Server.
The number of responses received to read messages sent by a
Client Read Msg recd driver acting as a Client. For most drivers this statistic quals the
number of messages sent.
The number of write messages sent by a driver acting as a Client.
Client Write Msg sent
May include messages sent to connect to the Server.
The number of responses received to write messages sent by a
Client Write Msg recd driver acting as a Client. For most drivers this statistic equals the
number of messages sent.
This statistic relates to port expansion. Messages that are
Client Passthru messages unrecognized (unsupported) are passed through the FieldServer
without the contents being considered.
The number of unrecognized messages passed through the
Client Passthru Msg sent
FieldServer.
The number responses to unrecognized messages passed
Client Passthru Msg recd
through the FieldServer.
Client Broadcast msg The number of broadcast messages sent.
Number of bytes contained in messages sent by the driver acting
Client Bytes Sent as a Client. May include bytes of messages used to connect or
login to the remote device.
Number of bytes contained in messages received by the driver
when acting as a Client - typically responses to messages sent.
Client Bytes Recd
May include bytes of messages used to connect or login to the
remote device.
The number of messages received by a driver acting as a Server.
Server Msg recd May include non-data messages such as connection or login
requests and port supervision messages.
The number of messages sent by a driver acting as a server -
Server Msg sent typically responses to messages received. May include
responses to non-data messages as above.
A count of the bytes sent by the driver when acting as a Server in
Server Bytes Sent response polls. May include bytes contained in non-data
messages.
A count of the bytes received by the driver when acting as a
Server Bytes Recd
server. May include bytes contained in non-data messages.
The number of times a cache Map Descriptor containing current
Cache - Hits
data has been polled. See Error! Reference source not found.
The number of times a cache Map Descriptor containing outdated
Cache - Misses
data has been polled. See Error! Reference source not found.
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: [email protected]
Ruinet Utility User Manual
Page 14 of 46
Parameter Description
The number of times a cache Map Descriptor containing outdated
Cache - Created data has been polled resulting in the creation of a new cache Map
Descriptor. See Error! Reference source not found.
The number of expired cache blocks. See Error! Reference
Cache - Bumped
source not found.
Writes are never cached - the external device is put on hold while
the FieldServer resends the message to the PLC and waits for the
Pex Write Thru response. When the FieldServer receives the response from the
PLC it in turn responds to the external device. This operation is
counted as a PEX Write thru.
The maximum time that the FieldServer has taken since the last
reset to receive a message from an external device, poll the PLC
Server Response Max
and respond to the external device. The SCADA Hold Timeout
parameter should be set higher than this limit
This is the average time that the FieldServer has taken since the
last reset to receive a message from an external device, poll the
Server Response Avg
PLC and respond to the external device. Reconfigure if response
times are slow.
Link Control
Who-Is-Router-To-Network
BACnet specific – see Driver Manual.
I-Am-Router-To-Network
Reject-Msg-To-Network
Messages Reconstructed Metasys Specific – see Driver Manual.
Unsupported Property The driver encountered an unsupported property in a message.
Unsolicited Messages Recd A message was received without the driver polling for it.
Single Write A write data message containing a single data element.
Single Item Read A read data message requesting a single data element.
Block Write A write message containing a block of data elements.
Block Read A read message requesting a block of data elements.
Messages containing sequence numbers received out of
Sequence Error
sequence.
Data Object Startup Data requested from a node in start-up mode.
Expedite Read The number of Map Descriptors given the highest priority to
Expedite Write complete a read/write first.
Fasttrack Read The number of Map Descriptors given a higher priority to complete
Fasttrack Write a read/write as soon as possible.
Fasttrack Overrun Read The number of times the buffer holding fasttrack read/write Map
Fasttrack Overrun Write Descriptors overflowed.
Max Read Response Time Maximum/Minimum/Average time in seconds that passed before a
Min Read Response Time response was received to a read message sent by a driver acting
Avg Read Response Time as a Client.
Max Write Response Time Maximum/Minimum/Average time in seconds that passed before a
Min Write Response Time response was received to a write message sent by a driver acting
Avg Write Response Time as a client.
Max Passthru Response Time Maximum/Minimum/Average time in seconds to receive a
Min Passthru Response Time response to a poll sent using the Passthru mechanism.
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: [email protected]
Ruinet Utility User Manual
Page 15 of 46
Parameter Description
Avg Passthru Response Time
TCP Conn Lost Number of times a TCP connection was lost or interrupted.
TCP Send Failed 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: [email protected]
Ruinet Utility User Manual
Page 16 of 46
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: [email protected]
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)
2 The number of bytes received during the squelch timing period
Squelch TX
started when RTS is asserted.
1 The number of bytes received during the squelch timing period
Squelch RX
started when RTS is de-asserted.
FieldServer unable to create a cache block due to memory
Cache Failed
shortage or inability to find a downstream node.
The received message was segmented but the driver does not
Segmentation Not Supported
support re-assembling segmented messages.
3 Produced when a Passthru poll is busy on the downstream side,
Passthru Retries
and an identical poll (retry) is received on the upstream side.
2 Produced when a Passthru poll is busy on the downstream side
Passthru Overruns
and a different poll (not a retry) is received on the upstream side.
A Passthru Retry, which occurs when the upstream retry is
Passthru Early Retries
received before the 1st downstream Passthru poll has been sent.
A Passthru Retry, which occurs when the upstream retry is
Passthru Normal Retries
received after the 1st downstream Passthru poll has been sent.
A Passthru Overrun, which occurs when the upstream retry is
Passthru Early Overruns
received before the 1st downstream Passthru poll has been sent.
A Passthru Overrun, which occurs when the upstream retry is
Passthru Normal Overruns
received after the 1st downstream Passthru poll has been sent.
Passthru Early Overruns Fails
Passthru Normal Overruns This statistic is currently not used.
Fails
The Passthru Window Timer expired before the downstream
PWT Expired
Passthru poll could be sent.
Press the 1 key or the 2 key to change the filter on these stats.
1 = TCP API
2 = Ethernet API (Default)
2
Information is available in ENOTE19. Enotes are available on the Web at www.fieldserver.com.
3
Currently only produced by the Metasys driver
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: [email protected]
Ruinet Utility User Manual
Page 18 of 46
Parameter Description
Connection The current connection being displayed out of the total number
TX bytes Number of bytes sent.
TX packets Number of packets sent.
Number of packets not sent for reasons that include the transmit buffers
TX dropped
being full.
TX errors Errors during transmission such as hardware errors.
RX IP fragments The number of IP fragmented packets received.
Collisions Number of collisions - the network is too busy.
TX abort errors
TX carrier errors
The NIC layer reports this error. Should be zero.
TX heartbeat errors
TX window errors
The highest value for the used transmit buffer count since the
Max TX buffers used FieldServer was restarted. An extremely busy network may have a max
of 7 or 8 but values this high are generally not expected.
Tx buffers in use Current transmit buffers in use.
Tx broadcast The number of broadcast messages sent.
RX bytes Number of bytes received by the API.
RX pkts total Number of packets received by the API.
RX pkts for us The number of received packets destined for transmission.
The number of received packets destined for transmission not meant for
RX pkts NOT for us
the API.
The number of received packets which were dropped for reasons such
RX dropped
as the Ethernet queue being full.
RX errors
RX length errors
RX overflow errors
RX crc errors
The NIC layer reports this error. Should be zero.
RX frame errors
RX frame errors
RX buffer full
RX ring buffer error
RX IP type Number of messages using IP protocol received.
RX ARP type Number of messages using ARP protocol received.
RX BACNET type Number of messages using BACnet protocol received.
RX 802_3 type Number of messages using 802_3 Ethernet protocol received.
RX UNKNOWN type Number of messages using other Ethernet protocol received.
Frag buf overrun IP defrag on the receive side. The buffer is (about 80kb) is full.
RX Broadcast Number of packets received in broadcast.
Exception 1 The Ethernet packet type could not be identified
An Ethernet packet received (i.e. addressed to the FieldServer Ethernet
address) was addressed to another IP address - either an Ethernet
Exception 2
broadcast was sent with a specific IP address, or another device has an
incorrect ARP table.
A UDP packet of length >1500 was received which cannot be handled
Exception 3
by the FieldServer.
Exception 4 The Ethernet TX interrupt handler was kick started.
RX global timeout
This statisticis currently not used.
RX local timeout
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: [email protected]
Ruinet Utility User Manual
Page 19 of 46
Parameter Description
RX IP not for us The number of received IP packets not meant for the FieldServer.
Max RX buffers used The maximum number of receive buffers used since restart.
Rx buffers in use The number of receive buffers currently in use.
2.4. N - Node Overview
Node number - type number to go to Every attempt is made to standardize the way
detail for that node, e.g. type 02 to in which drivers report stats but in some drivers
navigate to detail for the node called unavoidable differences exist.
“MB_Node1”
Displays the number of errors for a node. Occasional errors may indicate noise but also
may indicate a systematic error. Refer to the FieldServer Troubleshooting Guide for more
information. This does not affect the operation of the FieldServer, drivers or
communications to remote devices.
Push the R key to set all statistics for all nodes to zero. This doesn’t affect
the operation of the FieldServer, drivers or communication to remote
d i
Press the G key and type the node number to
view the details for a particular node.
Figure 2.6 – Node Overview Screen.
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: [email protected]
Ruinet Utility User Manual
Page 20 of 46
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: [email protected]
Ruinet Utility User Manual
Page 21 of 46
Parameter Description
PLC to poll.
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: [email protected]
Ruinet Utility User Manual
Page 22 of 46
Parameter Description
The current node being displayed out of the total
Node
number of nodes.
Client Read Msg sent Refer to Section 2.3.1 for a description. On this screen
Client Read Msg recd the statistic count applies to the node only.
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 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
Min Read Response Time
Avg Read Response Time
Max Write Response Time
Min Write Response Time
Avg Write Response Time
Max Passthru Response Time
Min Passthru Response Time
Avg Passthru Response Time
TCP Conn Lost
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: [email protected]
Ruinet Utility User Manual
Page 23 of 46
Parameter Description
TCP Send 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: [email protected]
Ruinet Utility User Manual
Page 24 of 46
To view next or
previous Map
Descriptor use the
arrow keys.
To view more of the same aspect
use the PgDn or PgUp keys.
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: [email protected]
Ruinet Utility User Manual
Page 25 of 46
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: [email protected]
Ruinet Utility User Manual
Page 26 of 46
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: [email protected]
Ruinet Utility User Manual
Page 27 of 46
Parameter Description
TCP Conn lost
TCP Send Failed
2.5.4. Map Descriptor Overview - Error Statistics Aspect
Parameter Description
The current Map Descriptor being displayed out of the
Map Descriptor
total number of Map Descriptors.
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 Refer to Section 2.3.3 for a description. On this screen
Address Errors the statistic count applies to the Map Descriptor only.
Data Object offline
Node Offline
Msg Ignored
Sys Cleared
Squelch TX
Squelch RX
Segmentation Not Supported
Passthru Retries
Passthru Overruns
Passthru Early Retries
Passthru Normal Retries
Passthru Early Overruns
Passthru Normal Overruns
Passthru Early Overruns Fails
Passthru Normal Overruns Fails
PWT Expired
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: [email protected]
Ruinet Utility User Manual
Page 28 of 46
To change the display format use the H, D, U, o, y, B, S keys. Not all data values can be
converted to other display formats.
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: [email protected]
Ruinet Utility User Manual
Page 29 of 46
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.
To clear the error screen push the R key. This doesn’t affect the operation of
the FieldServer, drivers or communications to remote devices.
Figure 2.12
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: [email protected]
Ruinet Utility User Manual
Page 30 of 46
Figure 2.14
Figure 2.15
2.9.1. Procedure for Downloading a File from a PC to a FieldServer
• From the main menu select “D” to go to the download screen.
• Specify the local file name by selecting “L”, type the file name and press <Enter>
• If the remote filename is incorrect, select “R”, type the file name and press <Enter>.
• Begin the download by selecting “D”.
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: [email protected]
Ruinet Utility User Manual
Page 31 of 46
Figure 2.16
When enabled you can upload files other than .csv from
the FieldServer. Please exercise caution with this option.
Figure 2.17
2.10.1. Procedure to Upload a File from a FieldServer to a PC
• From the main menu, select “U” to go to the Upload screen.
• Select “R”, type in the remote file name (File on the FieldServer) and press <Enter>
• If the local file name is incorrect, select “L”, type the name and press <Enter>.
• Begin the upload by pressing “U”.
• When the upload is completed, the uploaded file may be opened with one of the
listed editors. Note that the editors are not supplied with RuiNet and must be loaded
on your machine to work effectively.
• See Appendix B.10 for more information
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: [email protected]
Ruinet Utility User Manual
Page 32 of 46
Figure 2.18
Do not use broadcast IP address ending on 255. This IP address is reserved as a target
IP address when a device wants to send a message to all other devices on the network.
2.11.2. Obtain the IP address using the DHCP Client
The FieldServer can obtain its IP address from a DHCP Server using the built-in DHCP
Client. Note that the network’s DHCP Server must be setup correctly for this to work.
Please contact your network administrator for assistance.
• Enable the DHCP Client on Ethernet port N1 and/or N2 by pressing “4” or “9”
• Press “Y” <Enter> to enable or “Esc” to escape. “N” will disable the DHCP
client
• Press any key to continue and escape back to the main menu. Press”!” to
restart the FieldServer
• Press “Q” twice to quit from RuiNet and the discovery screen
• Run RuiNet again to connect to the FieldServer
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: [email protected]
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.
• Enable the DHCP Server on Ethernet port N1 and / or N2 by pressing “5” or “A”
• Press “Y” <Enter> to enable or “Esc” to escape. “N” will disable the DHCP
client
• Press any key to continue and escape back to the main menu. Press”!” to
restart the FieldServer
When connecting a PC or Laptop to the FieldServer on port N1 (or N2 for X40), be sure
to enable the DHCP Client function on the PC or Laptop. The following screen-shot from
the Network Connection’s properties on a Windows XP PC shows the TCP/IP settings
needed to enable the PC’s DHCP Client:
Figure 2.19
Simply restart the PC while connected to the FieldServer and it will obtain an IP address
from the FieldServer.
NOTE: Some implementations of the Microsoft DHCP Client will not use an IP address
lease offered by the FieldServer until its previous lease has been released. The way to
release and renew a lease on a PC is to open a command prompt window and use the
following commands (syntax may be different on Windows other than XP):
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: [email protected]
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
Figure 2.20
The Expert Mode allows viewing of the different FieldServer tiers. The Novice and Normal
modes currently have the same functionality in that it prevents viewing the FieldServer tiers.
NOTE: Normal and Expert modes are intended for the use of FieldServer personnel only.
They provide no improved application functionality, and the added functions in these modes
are neither documented, nor supported by FieldServer Technical Support. Consequently, it
is strongly advised that these modes are not enabled.
2.13. Restart FieldServer
Figure 2.21
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: [email protected]
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: [email protected]
Ruinet Utility User Manual
Page 36 of 46
Appendix A. Troubleshooting
Adapters
Adapter, Protocol
N2, SMT
• Unless a path is specified for the local file name then Ruinet expects to find the local file
in the same folder as that in which Ruinet was launched or in the folder set as the
working directory (as specified in the Windows shortcut). If the file cannot be found then
an error is reported.
• The local and remote file names must meet the DOS 8.3 file name format requirements.
• There must be sufficient flash disk space on the FieldServer.
• If the download of files like fserver.img (the firmware file) or config.csv (the configuration
file ) fails before completion then the next time the FieldServer is restarted the
FieldServer will try and run with corrupt firmware or a corrupt configuration. If the
firmware is corrupt then future downloads may not work at all and the user may need to
follow a recovery procedure. The procedure is available on the FieldServer website as
an application note.
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: [email protected]
Ruinet Utility User Manual
Page 37 of 46
RuiNet can be used in broadcast mode to poll all IP addresses on a network. This feature is
not recommended under normal operating conditions and should only be used when there is
just one FieldServer on the network.
RuiNet –ib
RuiNet will use broadcasting to connect to a FieldServer.
Use the -p command line switch and RuiNet will connect to the same FieldServer that was
connected previously. The most recently connected to FieldServer will be shown on top of
the list of “Recently connected to FieldServers” on the RuiNet list of FieldServers screen.
This command line switch is useful in batch files.
RuiNet –p
RuiNet will connect to the FieldServer it connected to previously.
Sample batch file: No FieldServer targeted and no auto connect so user must
select a FieldServer even if there is only one on the network.
RuiNet –zdefault.htm –m0
RuiNet –p –zzone1.htm No FieldServer targeted but –p ensures that the
RuiNet –p –zzone2.htm FieldServer selected by the user when the previous
RuiNet –p –zzone3.htm command was executed is the FieldServer that is
RuiNet –p –zzone4.htm connected to with this command.
If the target FieldServer is not specified with the –i switch then RuiNet either auto connects
to the only FieldServer found if there is only one, or presents a list of FieldServers and auto
connects to the most recently connected to FieldServer after 10 seconds. If there was no
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: [email protected]
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
RuiNet –b
Restarts the FieldServer that RuiNet auto connects to.
RuiNet –i192.168.1.81 –b
Restarts a specific FieldServer.
RuiNet –x3
When RuiNet connects the connection overview screen will be displayed.
When a file is transferred, its local file name (on host computer) and its FieldServer-side file
name must be known for RuiNet to work correctly. The local file name is always specified
with the –l switch whereas the remote or FieldServer-side file name is always specified with
the –f switch. RuiNet will fill in the default target file name if possible and thus one of the file
name switches may be omitted in some circumstances.
If transferring a file with the extension .CSV from a host computer to a FieldServer then
RuiNet will assume that the FieldServer-side file name is config.csv unless using the –f
command line switch to specify a different target file name.
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: [email protected]
Ruinet Utility User Manual
Page 39 of 46
Wildcards are allowed on download filenames. RuiNet will present a list of the files marked
for download and a list of the files already on the FieldServer for you to decide whether to
proceed with the download. The “list download files” prompt can be overridden with a –c
switch.
This command is used to transfer a file from the FieldServer to the PC. In the following
example the target FieldServer is not specified. If there is a single FieldServer on the
network then the files will be transferred with that FieldServer. If more than one FieldServer
is connected to the network then RuiNet will provide a list and the transfer will begin once
the required FieldServer is selected.
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: [email protected]
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.
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.
This behavior can be overridden and the download forced to happen by using the –o
command line switch.
If a file is not transferred correctly then RuiNet will retry the transfer. RuiNet continues to
retry until the transfer is successful. This can be avoided by specifying the maximum
number of retries that may be attempted.
If transferring a file with the same name from host computer to a FieldServer, omit this
switch. RuiNet will always use the FieldServer file name of config.csv for any CSV file
downloaded unless an altenate file name is specified using this switch. If a file is
downloaded with the name ”fserver.img”, RuiNet will automatically convert this to
“cb8menu.exe” on the FieldServer.
A path in the FieldServer Side file name cannot be set.
If transferring a file with the same name from host computer to a FieldServer, omit this
switch. If the file is to have a different name or if the file is to be saved to a specific drive
and/or folder then use this switch.
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: [email protected]
Ruinet Utility User Manual
Page 41 of 46
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
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. An excerpt from a typical log file is shown below:
RuiNet –v
RuiNet prints version information and exits.
RuiNet –ve
RuiNet prints extended version information and exits.
If the system date and time of the machine running RuiNet differs by more than 5 minutes
from that of the FieldServer you will be prompted to update the FieldServer. This behavior
can be overridden using the –m1 switch.
RuiNet –m1
Ensures update FieldServer date and time prompt does not occur.
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: [email protected]
Ruinet Utility User Manual
Page 42 of 46
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.
The FieldServer’s real time clock is maintained with a super-capacitor. The longest that the
time can be maintained for is about 30 days before the capacitor completely discharges. A
consequence of this is that often when a user first receives their FieldServer the time is not
correctly set.
The FieldServer date and time can be synchronized with host computer’s date and time by
using the –g switch.
RuiNet –g
Sets a FieldServer’s date and time to that of the host computer.
Sets the timeout in milliseconds. This is the time RuiNet waits for a response before
deciding that 1) a FieldServer connection has been lost or 2) A FieldServer cannot be
connected to.
Normally the default timeout never needs to be changed but when connecting to
FieldServers on remote networks or over the internet it might be necessary to make the
timeout longer. The default timeout value is currently 2 seconds.
This option is for FieldServer testing purposes only. It activates various test actions when
RuiNet is used. It currently causes checksum errors during a file download to test if retries
are working.
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: [email protected]
Ruinet Utility User Manual
Page 43 of 46
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. An excerpt from a typical log file is shown below:
A tier is a virtual FieldServer – a software construction on which the various drivers are
executed. Most applications only use one tier (called “Tier 2” or “Tier B” or “The Pex Tier”)
but some emulations and complex configurations use multiple tiers.
When Ruinet connects to a FieldServer it will always connect to the Pex Tier (Tier 2). The
arrow keys allow the user to change tier but only if in the expert mode. If not in expert mode
then the arrow keys have no effect.
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: [email protected]
Ruinet Utility User Manual
Page 44 of 46
IP = FieldServer
165.165.124.33
4) Ruinet -i165.165.124.33 -k10000 Company Company
Firewall / Firewall /
Router Router
1024 1024
1) Port 1024 2) Port 1024 3) Incoming Packets on
must be opened must be opened Port 1024 must be
to allow a UDP to allow a UDP redirected to the
connection to connection from FieldServer’s IP
the Internet the Internet address
Firewall Firewall
Ports Ports
Note that the –k switch sets the timeout to 10 seconds or 10,000 ms. This is a timeout value
that should work well over the Internet, but it might be necessary to increase this further on
a very slow connection if timeouts keep occuring.
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: [email protected]
Ruinet Utility User Manual
Page 45 of 46
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: [email protected]