Egd Protocol Manual
Egd Protocol Manual
Egd Protocol Manual
ProLinx Gateway
GE Ethernet Global Data
September 1, 2010
PROTOCOL MANUAL
Your Feedback Please
We always want you to feel that you made the right decision to use our products. If you have suggestions, comments,
compliments or complaints about our products, documentation, or support, please write or call us.
ProSoft Technology
5201 Truxtun Ave., 3rd Floor
Bakersfield, CA 93309
+1 (661) 716-5100
+1 (661) 716-5101 (Fax)
www.prosoft-technology.com
[email protected]
Copyright © 2010 ProSoft Technology, Inc., all rights reserved.
EGD Protocol Manual
September 1, 2010
® ® ® ® ®
ProSoft Technology , ProLinx , inRAx , ProTalk , and RadioLinx are Registered Trademarks of ProSoft
Technology, Inc. All other brand or product names are or may be trademarks of, and are used to identify products
and services of, their respective owners.
Markings
cULus ISA 12.12.01 Class I, Div 2 Groups A, B, C, D
cULus C22.2 No. 213-M1987
183151
CL I Div 2 GPs A, B, C, D
II 3 G
Ex nA nL IIC X
0°C <= Ta <= 60°C
II – Equipment intended for above ground use (not for use in mines).
3 – Category 3 equipment, investigated for normal operation only.
G – Equipment protected against explosive gasses.
Contents
Your Feedback Please ........................................................................................................................ 2
®
ProSoft Technology Product Documentation .................................................................................... 2
Important Installation Instructions ....................................................................................................... 3
®
All ProLinx Products .......................................................................................................................... 3
ProLinx Gateways with Ethernet Ports ............................................................................................... 3
To upgrade a previously purchased Series C model: .................................................................... 3
To order a ProLinx Plus gateway with the -WEB option ................................................................ 3
2 Functional Overview 9
2.1 EGD Command Server ........................................................................................... 11
2.1.1 Retrieve Configuration PDUs Example ................................................................... 12
2.1.2 Capabilities PDUs ................................................................................................... 16
2.1.3 Summary PDUs ....................................................................................................... 18
2.1.4 Statistics PDUs ........................................................................................................ 20
2.1.5 Command NAK PDU ............................................................................................... 22
2.1.6 Read PDUs ............................................................................................................. 23
2.1.7 Write PDUs .............................................................................................................. 25
2.1.8 Masked Write PDUs ................................................................................................ 27
2.2 EGD Data Producer ................................................................................................ 29
2.3 EGD Data Consumer .............................................................................................. 30
2.4 Other Ethernet Services (HTTP/FTP) ..................................................................... 31
5 Error/Status Data 55
5.1 SNTP Status Data .................................................................................................. 56
5.2 EGD Error/Status Data ........................................................................................... 57
5.3 Exchange Configuration Form ................................................................................ 59
Index 69
In This Chapter
Ethernet Global Data Compatible Devices .............................................. 8
Warning: When interfacing with a GE RX3i Controller, all reserved bits within the RX3i
Controller must be set to 0 in order to communicate with the ProLinx module. Also, the use of a
Configuration Server is not supported.
2 Functional Overview
In This Chapter
EGD Command Server.......................................................................... 11
EGD Data Producer .............................................................................. 29
EGD Data Consumer ............................................................................ 30
Other Ethernet Services (HTTP/FTP) .................................................... 31
The Ethernet Global Data (EGD) driver can be used to interface many different
protocols with EGD devices. The EGD driver supports both the
producer/consumer service port (18246) and the command service port (7937)
using the UDP protocol over an IP network. The user defines the data to be
produced and consumed in a configuration file downloaded to the gateway. The
command service is limited to responding to requests from other units. The
gateway will not initiate commands.
The driver interfaces with a common internal database in the gateway. This
permits the sharing of data across many different networks. The following
illustration shows the functionality of the EGD driver running on a ProLinx
gateway:
PDU Type = 3
PDU Type = 4
00 12 3F AE 5C AE 00 0D 8D 00 13 83 08 00 45 00
00 68 00 04 00 00 FE 11 E8 1F 69 66 00 CD 69 66
00 C8 04 01 1F 01 00 54 EC F2 04 00 11 11 01 00
4C 00 69 66 00 C8 E1 2E 00 00 40 06 00 00 00 00
01 00 69 66 00 C8 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 02 00 78 05 00 00 00 00 46 47 00 00 00 00
02 00 00 00 00 00
PDU Type = 9
Capabilities Request
The Capabilities Request PDU command permits an application program to
request the supported capabilities of the EGD implementation on the destination
node. A Capabilities Request sent from a requesting node must be followed by a
Capabilities Response message from the responding node.
Packet Description Data
Info
UDP Source Port: 7937 (0x 1F01)
Destination Port: 7937 (0x 1F01)
Length: xx bytes (0x 00 XX)
Checksum: xxxxx (0x XX XX)
EGD: EGD's PDU Field: Offset Bytes Hex code
PDU Type: 0 1 0x 09
Message Flag: 1 1 0x HH
Request ID: 2 2 0x HH HH
PVN1: 4 1 0x 01
Reserved: 5 1 0x HH
Message Length: 6 2 0x HH HH
PDU Type = 10
Capabilities Response
The Capabilities Response command PDU is sent in response to a Capabilities
Request. This message returns the functional capabilities and limits of the
supported EGD implementation on the responding controller.
Packet Description Data
Info
UDP Source Port: 7937 (0x 1F01)
Destination Port: 7937 (0x 1F01)
Length: xx bytes (0x 00 XX)
Checksum: xxxxx (0x XX XX)
EGD: EGD's PDU Field: Offset Bytes Hex code
PDU Type: 0 1 0x 0A
Message Flag: 1 1 0x HH
Request ID: 2 2 0x HH HH
PVN1: 4 1 0x 01
Status: 5 1 0x HH
Message Length: 6 2 0x HH HH
Producer ID: 8 4 0x HH HH HH HH
PDU Type = 7
Summary Request
The Summary Request PDU command permits an application program to
request a summary of the exchanges configured on a given node. This allows a
user to get a complete list of all exchanges defined. The Index field is normally 0
and is used to request a block of summaries in nodes which contain a large
number of exchanges. A Summary Request sent from a requesting node must be
followed by a Summary Response message from the responding node.
Packet Description Data
Info
UDP Source Port: 7937 (0x 1F01)
Destination Port: 7937 (0x 1F01)
Length: xx bytes (0x 00 XX)
Checksum: xxxxx (0x XX XX)
EGD: EGD’s PDU Field: Offset Bytes Hex code
PDU Type: 0 1 0x 07
Message Flag: 1 1 0x HH
Request ID: 2 2 0x HH HH
PVN1: 4 1 0x 01
Reserved: 5 1 0x HH
Message Length: 6 2 0x HH HH
Index: 8 1 0x HH
Reserved: 9 3 0x 00 00 00
PDU Type = 8
Summary Response
The Summary Response PDU is used to respond to a Summary Request. This
PDU returns a list of exchanges which are currently defined on the responding
node. This message is of variable length; the number of summaries, or cells,
included in the message is returned in the header of the message. If the number
of cells returned is less than the total number of cells, remaining summaries can
be retrieved by subsequent requests with a larger index variable.
Packet Description Data
Info
UDP Source Port: 7937 (0x 1F01)
Destination Port: 7937 (0x 1F01)
Length: xx bytes (0x 00 XX)
Checksum: xxxxx (0x XX XX)
EGD: EGD’s PDU Field: Offset Bytes Hex code
PDU Type: 0 1 0x 08
PDU Type = 15
Statistics Request
The Statistics Request PDU command permits an application program to obtain
the current operating statistics of the specified exchange. The exchange must be
valid on the destination node. A Statistics Request sent from a requesting node
must be followed by a Statistics Response message from the responding node.
Packet Description Data
Info
UDP Source Port: 7937 (0x 1F01)
Destination Port: 7937 (0x 1F01)
Length: xx bytes (0x 00 XX)
Checksum: xxxxx (0x XX XX)
EGD: EGD's PDU Field: Offset Bytes Hex code
PDU Type: 0 1 0x 0F
Message Flag: 1 1 0x HH
Request ID: 2 2 0x HH HH
PVN1: 4 1 0x 01
Reserved: 5 1 0x HH
Message Length: 6 2 0x HH HH
Producer ID: 8 4 0x HH HH HH HH
Exchange ID: 12 4 0x HH HH HH HH
PDU Type = 16
Statistics Response
The Statistics Response PDU command returns the operating statistics for the
Producer and Exchange ID specified in the request message.
Packet Description Data
Info
UDP Source Port: 7937 (0x 1F01)
Destination Port: 7937 (0x 1F01)
Length: xx bytes (0x 00 XX)
Checksum: xxxxx (0x XX XX)
EGD: EGD's PDU Field: Offset Bytes Hex code
PDU Type: 0 1 0x 10
Message Flag: 1 1 0x HH
Request ID: 2 2 0x HH HH
PVN1: 4 1 0x 01
Status: 5 1 0x HH
Message Length: 6 2 0x HH HH
PDU Type = 18
PDU Type = 32
Read Request
The Read Request PDU is used to request the contents of one or more
contiguous groups of memory from a specific peer controller. The header defines
parameters which apply to all of the individual cell references in the message.
Each cell reference specifies an offset into the specified exchange or target-
specific address and the number of bytes to read. Based on the address type,
the Domain ID must contain an Exchange and Producer ID or target-specific
address which is valid on the destination node. A Read Request sent from a
requesting node must be followed by a Read Response message from the
responding node.
Packet Description Data
Info
UDP Source Port: 7937 (0x 1F01)
Destination Port: 7937 (0x 1F01)
Length: xx bytes (0x 00 XX)
Checksum: xxxxx (0x XX XX)
EGD: EGD’s PDU Field: Offset Bytes Hex code
PDU Type: 0 1 0x 20
Message Flag: 1 1 0x HH
Request ID: 2 2 0x HH HH
PVN1: 4 1 0x 01
Option Length: 5 1 0x HH
Message Length: 6 2 0x HH HH
Configuration Signature: 8 2 0x HH HH
Address Type: 10 1 0x HH
Cell Count: 11 1 0x HH
Producer ID: 12 4 0x HH HH HH HH
Exchange ID: 16 4 0x HH HH HH HH
Time Stamp: 20 8 0x HH . . . HH
Reserved: 28 4 0x HH HH HH HH
The following two items are referred to as the exchange Cell. Each Cell
targets one [EGD Exchange] command line present in the EGD gateway’s
configuration file.
Offset: reads the DB Register specified in the Command.
Length: is Bytes count, not Words.
Multiple Cells may be requested dependent on the Cell Count field
specified above.
Offset: 32 2 0x HH HH
Length: 34 2 0x HH HH
PDU Type = 33
Read Response
The Read Response PDU (Read_Resp) is used to return the contents of one or
more contiguous groups of memory from the local node to the requesting
controller. The header defines parameters which apply to the all of the individual
cell references in the message. Each cell reference specifies an offset into the
specified exchange, the number of bytes of data, and the data itself. All data
returned must be padded to the nearest 4-byte boundary.
Packet Description Data
Info
UDP Source Port: 7937 (0x 1F01)
Destination Port: 7937 (0x 1F01)
Length: xx bytes (0x 00 XX)
Checksum: xxxxx (0x XX XX)
EGD: EGD’s PDU Field: Offset Bytes Hex code
PDU Type: 0 1 0x 20
Message Flag: 1 1 0x HH
Request ID: 2 2 0x HH HH
PVN1: 4 1 0x 01
Option Length: 5 1 0x HH
Message Length: 6 2 0x HH HH
Configuration Signature: 8 2 0x HH HH
Address Type: 10 1 0x HH
Cell count: 11 1 0x HH
Producer ID: 12 4 0x HH HH HH HH
Exchange ID: 16 4 0x HH HH HH HH
Time Stamp: 20 8 0x HH . . . HH
Reserved: 28 4 0x HH HH HH HH
The following four items are referred to as the exchange Cell. Each Cell
contains data from one [EGD Exchange] command line present in the EGD
gateway’s configuration file.
Offset: reads the DB Register specified in the [EGD Exchange] command.
Length: is Bytes Qty, not Words.
Multiple Cells may be returned dependent on the Cell Count: field specified
in the requesting PDU.
Offset: 32 2 0x HH HH
Length: 34 2 0x HH HH
Data (depends on length 36 XX 0x HH . . . HH
requested):
Padding (to 32-bit XX XX 0x HH HH
boundary):
PDU Type = 34
Write Request
The Write Request PDU is used to change the contents of one or more
contiguous groups of memory on a specific peer controller. The header defines
parameters which apply to all of the individual cell references in the message.
Each cell reference specifies an offset into the specified exchange or target-
specific address, the number of bytes to write, and the data. Each data field must
be padded to the nearest 4-byte boundary. Based on the address type, the
Domain ID must contain an Exchange and Producer ID or target-specific address
which is valid on the destination node. A Write Request sent from a requesting
node must be followed by a Write Response message from the responding node.
See the discussion in the section entitled Exchange Data Handling for
information about coherency in the write.
Packet Description Data
Info
UDP Source Port: 7937 (0x 1F01)
Destination Port: 7937 (0x 1F01)
Length: xx bytes (0x 00 XX)
Checksum: xxxxx (0x XX XX)
EGD: EGD’s PDU Field: Offset Bytes Hex code
PDU Type: 0 1 0x 22
Message Flag: 1 1 0x HH
Request ID: 2 2 0x HH HH
PVN1: 4 1 0x 01
Option Length: 5 1 0x HH
Message Length: 6 2 0x HH HH
Configuration Signature: 8 2 0x HH HH
Address Type: 10 1 0x HH
Cell Count: 11 1 0x HH
Producer ID: 12 4 0x HH HH HH HH
Exchange ID: 16 4 0x HH HH HH HH
Time Stamp: 20 8 0x HH . . . HH
Reserved: 28 4 0x HH HH HH HH
The following two items are referred to as the exchange Cell. Each Cell
targets one [EGD Exchange] command line present in the EGD gateway’s
configuration file.
Offset: reads the DB Register specified in the Command.
Length: is Bytes count, not Words.
Multiple Cells may be requested dependent on the Cell Count field
specified above.
Offset: 32 2 0x HH HH
Length: 34 2 0x HH HH
PDU Type = 35
Write Response
The Write Response is returned from a destination controller in response to a
Write Request message. It serves as an acknowledgment for the original
request. A positive response indicates that all of the data has been written to the
responding device. An error response indicates that one or more of the transfers
to the responding device failed. Responders shall use all available means to
assure that a write is performed in its entirety or not performed at all. Requesting
applications are advised that if partial failures of the write can cause problems
with the control algorithm, they should include only one cell in each write to
assure complete knowledge of the disposition of the Write Request.
Packet Description Data
Info
UDP Source Port: 7937 (0x 1F01)
Destination Port: 7937 (0x 1F01)
Length: xx bytes (0x 00 XX)
Checksum: xxxxx (0x XX XX)
EGD: EGD’s PDU Field: Offset Bytes Hex code
PDU Type: 0 1 0x 23
Message Flag: 1 1 0x HH
Request ID: 2 2 0x HH HH
PVN1: 4 1 0x 01
Option Length: 5 1 0x HH
Message Length: 6 2 0x HH HH
Configuration 8 2 0x HH HH
Signature:
Address Type: 10 1 0x HH
Cell count: 11 1 0x HH
Producer ID: 12 4 0x HH HH HH HH
Exchange ID: 16 4 0x HH HH HH HH
Time Stamp: 20 8 0x HH . . . HH
Reserved: 28 4 0x HH HH HH HH
PDU Type = 36
PDU Type = 37
Important: The WEB option is an additional hardware component that is installed on the gateway
during manufacturing. If the WEB option is not installed, the following features are not enabled.
The gateway contains an HTTP server to serve Web pages containing database
data and error/status values present in the gateway’s internal database to a Web
browser. The pages presented can be those built into the gateway or custom
designed by the user. Additionally, Web pages can be constructed to alter (write)
the values contained in the gateway’s database.
An FTP server is present to handle file operations controlled from a remote
computer on the network.
The following table describes the capabilities of the WEB option.
Type Specifications
HTML Server (See Key features of the HTML server include:
note below) Max HTML page size: 1MB
Max File Storage: 32MB
Supported context types: jpeg, bmp, css
Supported data types: bit, ASCII, integer, float
Sockets: Up to ten connections. Note that this limits the number of
simultaneous graphic file and frame references per HTML page
FTP Server Permits remote HTML file transfer between the gateway and remote host.
Capabilities of the FTP Server include:
Single socket connection
Non-passive transfers only
WS_FTP or Command Line FTP recommended
CuteFTP, Internet Explorer, Netscape, or NCFTP all support multiple socket
connections and therefore will not support the ProLinx gateway
For detailed information on these services, refer to the WEB Driver Manual.
In This Chapter
Adding a Location.................................................................................. 35
Adding a Project .................................................................................... 36
Adding a Module ................................................................................... 37
Configuring Gateway Parameters ......................................................... 38
Creating Optional Comment Entries ...................................................... 39
Printing a Configuration File .................................................................. 40
Downloading a File from PC to the Gateway ......................................... 41
Ethernet Port Configuration - wattcp.cfg ................................................ 42
Alternative Configuration Method Using a Text File .............................. 43
You must install the ProSoft Configuration Builder (PCB) software to configure
the gateway. You can always get the newest version of ProSoft Configuration
Builder from the ProSoft Technology website.
Installing ProSoft Configuration Builder from the ProSoft website
1 Open your web browser and navigate to http://www.prosoft-
technology.com/pcb
2 Click the DOWNLOAD HERE link to download the latest version of ProSoft
Configuration Builder.
3 Choose SAVE or SAVE FILE when prompted.
4 Save the file to your Windows Desktop, so that you can find it easily when
you have finished downloading.
5 When the download is complete, locate and open the file, and then follow the
instructions on your screen to install the program.
If you do not have access to the Internet, you can install ProSoft Configuration
Builder from the ProSoft Solutions Product CD-ROM, included in the package
with your gateway.
Installing ProSoft Configuration Builder from the Product CD-ROM
1 Insert the ProSoft Solutions Product CD-ROM into the CD-ROM drive of your
PC. Wait for the startup screen to appear.
2 On the startup screen, click PRODUCT DOCUMENTATION. This action opens a
Windows Explorer file tree window.
3 Click to open the UTILITIES folder. This folder contains all of the applications
and files you will need to set up and configure your gateway.
Note: Many of the configuration and maintenance procedures use files and other utilities on the
CD-ROM. You may wish to copy the files from the Utilities folder on the CD-ROM to a convenient
location on your hard drive.
2 On the Choose Module Type dialog box, select the MODULE type.
Or
1 Open the PROJECT menu and choose LOCATION.
2 On the LOCATION menu, choose ADD MODULE.
To add a module to a different location
1 Right-click the LOCATION folder and choose ADD MODULE. A new MODULE
icon appears.
Or
1 Select the LOCATION icon.
2 From the PROJECT menu, select LOCATION, and then select ADD MODULE.
# This section contains the list of multicast group addresses the EGD server
# should process (consumer messages for this server produced on other
units).
# This list may contain up to 32 IP addresses. The reserved group addresses
# for the EGD protocol are 224.0.7.1 to 224.0.7.32. The module will support
# other group addresses than this data set.
[EGD MULTICAST GROUP LIST]
START
224.0.7.1
224.0.7.2
END
In This Chapter
[EGD Network] ...................................................................................... 46
[SNTP Client]......................................................................................... 47
[EGD Exchanges] .................................................................................. 49
[EGD Multicast Group List] .................................................................... 53
This section describes the parameters necessary to configure the EGD protocol
driver on the ProLinx Gateway.
The database register parameter defines a database register where the SNTP
time and date values are copied. It occupies four words as follows:
Word Offset Description
0 and 1 Date and time in Unix format (long integer)
2 and 3 Microseconds (long integer)
Exchange Type
For each entry in the exchange list, the Exchange Type field (Exch Type)
specifies either a producer data exchange or a consumer data exchange. In a
producer exchange, a message is generated by the driver using data from the
gateway's database. In a consumer exchange, data is received from other EGD
devices and placed in the gateway's database.
Cast Type
Cast Type defines which stations should listen for exchanges:
If Exchange Type is P (producer), B=Broadcast (to all nodes), M=Multicast
(to a group of nodes), U=Unicast (to a single node).
If Exchange Type is C (consumer) and communication fails, N=No database
change, M=DB set to -1, Z=DB set to 0, O=DB set to 1.
In the case of the consumer, the database will be set to the specified value or left
unchanged (N option) if the gateway does not receive the message before the
P/C Time set for the exchange.
DB Reg
The DB Reg parameter is the starting gateway database register from which data
is sourced (produced data) or into which data is placed (consumed data). This
parameter can have a value of 0 to 3999. The validity of the entry depends on
the number of registers to be produced or consumed. The sum of the two values
cannot exceed 4000, as this would be outside the range of the gateway's
database.
Reg Count
The Reg Count column defines the number of database registers to
transfer/accept in a message. This parameter has a valid range of 1 to 700. The
sum of this parameter and the DB Reg parameter cannot exceed 4000, as this
would be outside the range of the gateway's database.
Swap Code
The Swap Code column is used to set byte and word swapping of data produced
or consumed. Acceptable values are 0=no swapping, 1=swap words, 2=swap
bytes and words and 3=swap bytes. Swapping of words and/or bytes in the
message may be required for different protocol and operating systems, as their
representation of multi-byte values may not be the same as that of the EGD
P/C Time
protoc ol.
The P/C Time column defines the number of milliseconds between exchanges.
For produced exchanges, it defines how often messages are produced. For
consumed exchanges, it defines the number of milliseconds to wait for a
remotely produced exchange before a timeout error occurs. For consumed
messages, set the value to approximately four times the value of the produced
exchange time of the producer device. This will prevent the exchange from
constantly timing out on a busy network.
A zero P/C Time value for a produced message means the message will not be
produced. A zero value for a consumed message means the exchange will never
time out. The zero value can be used for exchanges that will interface with the
command service port (7937) to handle command read and write requests from
another device. In this mode, when the P/C Time = 0 (zero), the mode becomes
a server responding to a Client on the network that is producing PDUs with
command type messages. For more information, refer to EGD Command Server
(page 11).
IP Address
The IP Address column should be set to the IP address of destination (produced
data) or source (consumed data). If the Cast Type is set to U for a produced
exchange, the address should be set to the IP address of the specific node to
receive the data. If the Cast Type is set to B for produced data, set the IP to
either a network (255.255.255.255) or subnet (192.168.0.255) broadcast
address. If the Cast Type is set to M for produced data, enter a valid multicast IP
address. For consumed messages, this column should be set to the IP address
of the remote producer generating the specific exchange. The combination of the
IP Address and the Exchange ID uniquely identifies the exchange to the system.
Exchange ID
The Exch ID column defines the Exchange ID for the message (1 to 16383), and
must be unique for a produced message. For produced exchanges, the
Exchange ID uniquely defines the exchange message on the network. For
consumed exchanges, the producer's IP Address along with the Exchange ID is
used to determine which messages to consume. The other parameters defined
for the exchange then determine how much data is present in the message and
where to place the data into the gateway's internal database.
Configuration Signature
The Configuration Signature version information is used to determine if the
message can be parsed using the defined exchange message.
If the Major version numbers don't match, the consumer will not accept the data.
If the Major version numbers match, then:
If the Minor version number in a produced message is greater than or equal
to the consumed message's Minor version number, the message is accepted
because it has more data than expected.
OR
If the Minor version number in a produced message is less than the
consumed message's Minor version number, the message is rejected
because it does not have all the data required for a complete message.
Definition Example
Producing Message Consuming Message Definition
Configuration Configuration Signature
Signature
Major Minor Major Minor
0 0 0 0 The consumer command will consume the
producer's message without version
checking.
Y 0 Z 0 The consumer command will NOT consume
the producer's message when Major
numbers do not match.
X 0 X 0 The consumer command will consume the
producer's message only if the consumer's
Major number matches the producer's Major
number.
X 5 X 4 The consumer command will consume the
producer's message when the consumer and
producer's Major numbers match, and the
consumer's Minor number is less than or
equal to the producer's Minor number.
The consumer accepts the message
received because it has more data than
expected.
X 2 X 3 The consumer command will NOT consume
the producer's message when the consumer
and producer's Major numbers match, but
the consumer's Minor number is greater than
the producer's Minor number.
The consumer rejects the message received
because it has less data than expected.
5 Error/Status Data
In This Chapter
SNTP Status Data ................................................................................. 56
EGD Error/Status Data .......................................................................... 57
Exchange Configuration Form ............................................................... 59
The second and most thorough troubleshooting method for debugging the
operation of the EGD driver (and the gateway in general) is the powerful Debug
port on the gateway which provides much more complete access to the internal
operation and status of the gateway. Accessing the Debug capabilities of the
gateway is accomplished easily by connecting a PC to the Debug port and
loading a terminal program.
… …
17386 to 17399 Exchange message 99 in same format as above for 14 registers
The gateway’s data mapping feature can be utilized to move this data into the
gateway’s database area. This way the data can be made available to all drivers
on the gateway for use on any of the connected networks. If it is not mapped into
the gateway’s database, the data will only be available through the
Configuration/Debug Port.
There is a 14-word register data area for each exchange. The following table
describes each value stored for an exchange.
Status value Description
Configuration state This word register defines the configuration state of the exchange as
follows: 0=Invalid, 1=producing/healthy, 2=pending/unhealthy
Production status This word is bit mapped with the following definition of the production
status: bit0=err/invalid, bit1=not time sync
Message count This double-word value counts the number of times the exchange has
been produced or consumed.
Number of times This double-word value counts the number of data production packets
missed missed. This counter is incremented each time the Request ID in the
received produced message is greater than 1 more than the last Request
ID received (adjusted for roll-over).
Number of refresh This double-word value counts the number of refresh errors that have
errors been encountered by the driver. A refresh error occurs when the
produced exchange does not arrive to the consumer within the set P/C
time. This will only be valid for consumer exchanges.
1 2 3 4 5 6 7 8 9 10
Exchange Cast Database Register Swap Prod/Cons IP Exchange Cfg Signature
Type (C/P) Type Address Count Code Time Address ID Version
Major Minor
In This Chapter
How to Contact Us: Technical Support.................................................. 61
Return Material Authorization (RMA) Policies and Conditions............... 63
LIMITED WARRANTY ........................................................................... 65
Note: For technical support calls within the United States, an after-hours answering system allows
24-hour/7-days-a-week pager access to one of our qualified Technical and/or Application Support
Engineers.
Internet Web Site: www.prosoft-technology.com/support
E-mail address: [email protected]
Asia Pacific Tel: +603.7724.2080, E-mail: [email protected]
(location in Malaysia) Languages spoken include: Chinese, English
Asia Pacific Tel: +86.21.5187.7337 x888, E-mail: [email protected]
(location in China) Languages spoken include: Chinese, English
Europe Tel: +33 (0) 5.34.36.87.20,
(location in Toulouse, E-mail: [email protected]
France) Languages spoken include: French, English
Europe Tel: +971-4-214-6911,
(location in Dubai, UAE) E-mail: [email protected]
Languages spoken include: English, Hindi
** Some areas do not allow time limitations on an implied warranty, or allow the exclusion or
limitation of incidental or consequential damages. In such areas, the above limitations may not
apply. This Warranty gives you specific legal rights, and you may also have other rights which vary
from place to place.
I
Important Installation Instructions • 3
Installing and Using ProSoft Configuration Builder • 11,
Index 33
Intellectual Property Indemnity • 67
[ L
[EGD Exchanges] • 49 Limitation of Remedies ** • 68
[EGD Multicast Group List] • 53 LIMITED WARRANTY • 63, 65
[EGD Network] • 46
[SNTP Client] • 47
M
Masked Write PDUs • 11, 27
A
Adding a Location • 35
N
Adding a Module • 37 No Other Warranties • 68
Adding a Project • 36 NTP Server IP Address • 48
All Product Returns: • 63
All ProLinx® Products • 3 O
Allocation of Risks • 68
Other Ethernet Services (HTTP/FTP) • 31
Alternative Configuration Method Using a Text File • 43
ARP Timeout • 46 P
C Pinouts • 3
Printing a Configuration File • 40
Capabilities PDUs • 11, 16
Procedures for Return of Units Out of Warranty: • 64
Command NAK PDU • 11, 22
Procedures for Return of Units Under Warranty: • 64
Configuring Gateway Parameters • 38
ProLinx Gateways with Ethernet Ports • 3
Controlling Law and Severability • 68
ProSoft Technology® Product Documentation • 2
Creating Optional Comment Entries • 39
D R
Read PDUs • 11, 23
Database Register • 48
Retrieve Configuration PDUs Example • 11, 12
Disclaimer of all Other Warranties • 67
Return Material Authorization (RMA) Policies and
Disclaimer Regarding High Risk Activities • 66
Conditions • 63
Downloading a File from PC to the Gateway • 41
E S
SNTP Status Data • 56
EGD Command Server • 11, 51
Statistics PDUs • 11, 20
EGD Configuration Parameters • 45
Summary PDUs • 11, 18
EGD Data Consumer • 30
Support, Service & Warranty • 61
EGD Data Producer • 29
EGD Error/Status Data • 57 T
Error/Status Data • 55
Ethernet Global Data • 7 Time Limit for Bringing Suit • 68
Ethernet Global Data Compatible Devices • 8 Time Zone • 48
Ethernet Port Configuration - wattcp.cfg • 42 To order a ProLinx Plus gateway with the -WEB option
Exchange Configuration Form • 59 •3
Exchange List Entry • 49 To upgrade a previously purchased Series C model: •
Exchange List Overview • 49 3
F U
Functional Overview • 9 Use Daylight Savings Time • 48
H W
How to Contact Us What Is Covered By This Warranty • 65, 67
Technical Support • 61, 63 What Is Not Covered By This Warranty • 66
Write PDUs • 11, 25
Y
Your Feedback Please • 2