Ping Device Driver Help

© 2009 Schneider Electric

 1 Ping Device Driver Help

Table of Contents
1 Getting Started
................................................................................................................................... 2
Help Contents .......................................................................................................................................................... 2
Overview .......................................................................................................................................................... 2
2 Device Setup................................................................................................................................... 2
Device Setup .......................................................................................................................................................... 2
3 Automatic Tag
...................................................................................................................................
Database Generation 2
Automatic Tag..........................................................................................................................................................
Database Generation 2
4 Data Types Description
................................................................................................................................... 3
Data Types Description
.......................................................................................................................................................... 3
5 Address Descriptions
................................................................................................................................... 3
Address Descriptions
.......................................................................................................................................................... 3
6 Error Descriptions
................................................................................................................................... 3
Error Descriptions
.......................................................................................................................................................... 3
Device '<address>'
..........................................................................................................................................................
is not responding 3
Required functionality
..........................................................................................................................................................
of icmp.dll is not found 4
The Device ID for
..........................................................................................................................................................
'<address>' could not be resolved 4
Unable to bind..........................................................................................................................................................
to adapter: '<adapter>'. Connect failed 4

Unable to generate
..........................................................................................................................................................
a tag database for device '<device name>'. Reason: Could not generate tags due to 4
low system
Unable resources
to load ..........................................................................................................................................................
required file '<file>'. This driver will not be operational 4
Winsock initialization
..........................................................................................................................................................
failed (OS Error = <error>) 5
Winsock shut down
..........................................................................................................................................................
failed (OS Error = <error>) 5
Winsock V1.1 or..........................................................................................................................................................
higher must be installed to use the PingDriver 5

Index 6
 Ping Device Driver Help 2

Ping Device Driver Help

Help version 1.005

CONTENTS

Overview
What is the Ping Device Driver?

Device Setup
How do I configure a device for use with this driver?

Automatic Tag Database Generation

How can I easily configure tags for the Ping Device driver?

Data Types Description

What data types can be used with the Ping driver?

Address Descriptions
How do I specify an address with the Ping driver?

Error Descriptions
What error messages does the Ping driver produce?

Overview
The Ping Device Driver is provided for monitoring network devices via the ICMP protocol (Ping). The Ping driver was
designed specifically for use with 32 bit OPC Server products. For more information on Operating System requirements,
refer to the OPC Server Help Documentation.

The Ping driver provides the ability not only to monitor the Status of a network device but also the time that it takes for
the ICMP message to reach its destination and return a response (the RoundTripTime).

Device Setup
A device represents a single computer or device that can communicate via TCP/IP.

Connection Timeout
This parameter specifies the amount of time the driver will wait for a connection to be made with a device. Depending
on the network load, the connect time may vary with each connection attempt. The default setting is 3 seconds with a
valid range from 1 to 30 seconds.

Request Timeout
This parameter specifies the amount of time the driver will wait on a response from the device before giving up and
going on to the next request. Longer timeouts only affect performance if a device is not responding. The default setting
is 1000 milliseconds with a valid range from 100 to 30000 milliseconds.

Retry Attempts
This parameter specifies the number of times the driver will attempt to get a response from the device before giving up
and moving on to the next device. The default setting is 3 retries with a valid range from 1 to 10.

Device IDs
The Ping driver supports any IPv4 IP address as its Device ID. Domain names can also be used as a Device ID, since
these will be converted to an IP Address by the Ping Driver automatically. When using a domain name, do not include
the http:// prefix.

Automatic Tag Database Generation

The Ping driver automatically generates tags for Status and RoundTripTime when a new device is created. Tags will not
be automatically generated for devices that already have tags in them.

www.apc.com
 3 Ping Device Driver Help

Data Types Description

Each address that can be accessed must be assigned a data type. The Ping Driver supports two data types: DWord and
Long.

Data Type Description

DWord Unsigned 32 bit value

bit 0 is the low bit

bit 31 is the high bit
Long Signed 32 bit value

bit 0 is the low bit

bit 30 is the high but
bit 31 is the sign bit

Address Descriptions
The Ping Driver supports two types of addresses: Status and RoundTripTime. Both addresses are Read Only and
supply different information about the device. The Status address indicates 1 if the device can be reached or 0 if the
Ping driver could not reach the device. The RoundTripTime indicates the amount of time in milliseconds that it took the
request to reach its destination and to reply back to the Ping Driver.

Address Data Type Access

Status DWord Read Only
comStatus DWord Read Only
RoundTripTime Long Read Only
comTime Long Read Only

Note: The 'comStatus' and 'comTime' addresses behave exactly as the Status and RoundTripTime addresses with the
exception that they will not be auto generated.

Error Descriptions
The following error/warning messages may be generated. The messages are listed here in alphabetical order.

Device '<address>' is not responding

Required functionality of icmp.dll is not found
The Device ID for '<address>' could not be resolved
Unable to bind to adapter: '<adapter>'. Connect failed
Unable to generate a tag database for device '<device name>'. Reason: Could not generate tags due to low
system resources
Unable to load required file '<file>'. This driver will not be operational
Winsock initialization failed (OS Error = <error>)
Winsock shut down failed (OS Error = <error>)
Winsock V1.1 or higher must be installed to use the Ping Driver

Device '<address>' is not responding

Error Type:
Warning

Possible Cause:
Device may not be connected or the device cannot be reached.

Solution:
1. Ensure that the Ethernet cable is connected properly.
2. Ensure that the Device ID is correct.

www.apc.com
 Ping Device Driver Help 4

Required functionality of icmp.dll is not found

Error Type:
Fatal

Possible Cause:
icmp.dll is corrupted or out of sync with the operating system.

Solution:
Check that the proper version of icmp.dll is in the system folder of the particular operating system.

The Device ID for '<address>' could not be resolved

Error Type:
Warning

Possible Cause:
The host name entered does not exist or is not currently in use.

Solution:
Check that the host name is spelled correctly and that all network cables are properly connected. If using web based
addresses, make sure that the http:// prefix is not included.

Unable to bind to adapter: '<adapter>'. Connect failed

Error Type:
Fatal

Possible Cause:
The reason for this error message is that some other device in the driver has already been bound to this adapter/port
combination.

Solution:
Wait a few seconds and restart the driver.

Unable to generate a tag database for device '<device name>'. Reason: Could not
generate tags due to low system resources
Error Type:
Warning

Possible Cause:
Memory required for database generation could not be allocated. The process is aborted.

Solution:
Close any unused applications and/or increase the amount of virtual memory. Then, try again.

Unable to load required file '<file>'. This driver will not be operational
Error Type:
Fatal

Possible Cause:
The required file is not found.

Solution:

www.apc.com
 5 Ping Device Driver Help

Ensure that the file is in the proper location specified in '<file>'.

Winsock initialization failed (OS Error = <error>)

Error Type:
Fatal

OS Error Indication Possible Solution

10091 Indicates that the underlying Wait a few seconds and restart
network subsystem is not ready for the driver.
network communication.
10067 Limit on the number of tasks Close one or more applications
supported by the Windows Sockets that may be using Winsock and
implementation has been reached. restart the driver.

Winsock shut down failed (OS Error = <error>)

Error Type:
Fatal

OS Error Indication Possible Solution

10091 This indicates that there is a Check to make sure that the
problem in the underlying network version of Winsock installed is 1.1
subsystem that is preventing the or higher.
Winsock Library from shutting
down correctly.

Winsock V1.1 or higher must be installed to use the Ping Driver

Error Type:
Fatal

Possible Cause:
The version number of the Winsock DLL found on the system is less than 1.1.

Solution:
Upgrade Winsock to version 1.1 or higher.

www.apc.com
 Index 6

Index -W-
Winsock initialization failed (OS Error = <error>)
-A- 5
Winsock shut down failed (OS Error = <error>) 5
Address Descriptions 3 Winsock V1.1 or higher must be installed to use
the PingDriver 5
Automatic Tag Database Generation 2

-D-
Data Types Description 3
Device '<address>' is not responding 3
Device Setup 2

-E-
Error Descriptions 3

-H-
Help Contents 2

-O-
Overview 2

-R-
Required functionality of icmp.dll is not found 4

-T-
The address '<address>' could not be resolved 4

-U-
Unable to bind to adapter: '<adapter>'. Connect
failed 4
Unable to generate a tag database for device
'<device name>'. Reason: Could not generate tags
due to low system resources 4
Unable to load required file '<file>'. This driver will
not be operational 4

www.apc.com