g
GE Industrial Systems
GEI-100516
GE Industrial Systems Standard Messages (GSM)
Document: GEI-100516 Issued: 2001-12-10
GE Industrial Systems Standard Messages (GSM)
© 2001 General Electric Company, USA. All rights reserved.
Printed in the United States of America.
GE provides the following document and the information included therein as is and without warranty of any kind, express or implied, including but not limited to any implied statutory warranty of merchantability or fitness for particular purpose.
These instructions do not purport to cover all details or variations in equipment, nor to provide for every possible contingency to be met during installation, operation, and maintenance. The information is supplied for informational purposes only, and GE makes no warranty as to the accuracy of the information included herein. Changes, modifications and/or improvements to equipment and specifications are made periodically and these changes may or may not be reflected herein. It is understood that GE may make changes,
modifications, or improvements to the equipment referenced herein or to the document itself at any time. This document is intended for trained personnel familiar with the GE products referenced herein. GE may have patents or pending patent applications covering subject matter in this document. The furnishing of this document does not provide any license whatsoever to any of these patents. All license inquiries should be directed to the address below. If further information is desired, or if particular problems arise that are not covered sufficiently for the purchaser’s purpose, the matter should be referred to:
GE Industrial Systems Post Sales Service 1501 Roanoke Blvd.
Salem, VA 24153-6492 USA
Phone: + 1 888 GE4 SERV (888 434 7378, United States) + 1 540 378 3280 (International)
Fax: + 1 540 387 8606 (All)
(“+” indicates the international access code required when calling from outside the USA)
This document contains proprietary information of General Electric Company, USA and is furnished to its customer solely to assist that customer in the installation, testing, operation, and/or maintenance of the equipment described. This document shall not be reproduced in whole or in part nor shall its contents be disclosed to any third party without the written approval of GE Industrial Systems.
Document Identification: GEI-100516 Technical Writer/Editor: Paul Blaiklock Technical Responsibility: Dave O'Connor
ARCNET is a registered trademark of Datapoint Corporation. Ethernet is a trademark of Xerox Corporation.
SPEEDTRONIC is a trademark of General Electric Company, USA. Windows® is a registered trademark of Microsoft Corporation.
GEI-100516 GSM for HMI Applications Safety Symbol Legend •••• a
Safety Symbol Legend
Indicates a procedure, condition, or statement that, if not strictly observed, could result in personal injury or death.
Indicates a procedure, condition, or statement that, if not strictly observed, could result in damage to or destruction of equipment.
Indicates a procedure, condition, or statement that should be strictly followed in order to optimize these applications.
b •••• Safety Symbol Legend GSM for HMI Applicationsl GEI-100516
To prevent personal injury or equipment damage caused by equipment malfunction, only adequately trained personnel should modify any
programmable machine.
The example and setup screens in this manual do not reflect the actual application configurations. Be sure to follow the correct setup procedures for your application.
We welcome comments and suggestions to make this publication more useful.
Your Name Today’s Date
Your Company’s Name and Address Job Site
GE Requisition No. Publication No. Your Job Function / How You Use This Publication
Publication Issue/Revision Date
If needed, how can we contact you? Fax No.
Phone No. E-mail Address
General Rating
Excellent Good Fair Poor Additional Comments
Contents ¡ ¡ ¡ ¡ _____________________________________________________________ Organization ¡ ¡ ¡ ¡ _____________________________________________________________ Technical Accuracy ¡ ¡ ¡ ¡ _____________________________________________________________ Clarity ¡ ¡ ¡ ¡ _____________________________________________________________ Completeness ¡ ¡ ¡ ¡ _____________________________________________________________ Drawings / Figures ¡ ¡ ¡ ¡ _____________________________________________________________ Tables ¡ ¡ ¡ ¡ _____________________________________________________________ Referencing ¡ ¡ ¡ ¡ _____________________________________________________________ Readability ¡ ¡ ¡ ¡ _____________________________________________________________
Specific Suggestions (Corrections, information that could be expanded on, and such.)
Page No. Comments
______
__________________________________________________________________________________
______
__________________________________________________________________________________
______
__________________________________________________________________________________
______
__________________________________________________________________________________
______
__________________________________________________________________________________
______
__________________________________________________________________________________
Other Comments (What you like, what could be added, how to improve, and such.)________________________________________________
___________________________________________________________________________________________
___________________________________________________________________________________________
___________________________________________________________________________________________
___________________________________________________________________________________________
___________________________________________________________________________________________
___________________________________________________________________________________________
Overall grade (Compared to publications from other manufacturers of similar products, how do you rate this publication?)
¡ Superior ¡ Comparable ¡ Inferior ¡ Do not know Comment ____________________________________________
Detach and fax or mail to the address noted above.
g
Reader Comments
General Electric Company
g
Reader Comments
General Electric Company
g
Reader Comments
General Electric Company
To: GE Industrial Systems Documentation Design, Rm. 291 1501 Roanoke Blvd. Salem, VA 24153-6492 USA Fax: 1-540-387-8651 (GE Internal DC 8-278-8651)
g
Reader Comments
...
Fold here and close with staple or tape...
____________________________
____________________________
____________________________
GE Industrial Systems
Documentation Design, Rm. 291
1501 Roanoke Blvd.
Salem, VA 24153-6492 USA
...
Fold here first...
Place stamp here.GEI-100516 GSM for SPEEDTRONIC Turbine Control Contents •••• i
Contents
Chapter 1 Overview 1-1
Introduction ...1-1 GE Industrial Systems Standard Messages...1-1 GSM Message Types...1-2 Notation...1-3 Timetag Considerations...1-5 Summary of Messages...1-6
Chapter 2 Administrative Requests 2-1
Introduction ...2-1 Supported Controller Request ...2-1 Supported Controller Response...2-1 Heartbeat Message...2-4
Chapter 3 Event Driven Requests 3-1
Introduction ...3-1 Alarm Record Establish Request...3-1 Alarm Record Establish ACK/NAK Response ...3-2 Alarm Data Messages...3-2 Digital Input Record Establish Request...3-6 Digital Input Record Establish ACK/NAK Response ...3-7 Digital Input Data Messages ...3-7 Software Event Record Establish Request ...3-9 Software Event Data Messages ...3-11
Chapter 4 Periodic Data Messages 4-1
Introduction ...4-1 Periodic Data Request ...4-1 Periodic Data ACK/NAK Response...4-2 Periodic Data Message ...4-4 Periodic Data from Mark VI...4-5
Chapter 5 Command Messages 5-1
Introduction ...5-1 Alarm Command Request ...5-1 Alarm Dump Messages ...5-3 Alarm Dump Message Structure ...5-3 Process Control Command Requests:...5-7 Process Control Command ACK/NAK Response...5-8
ii •••• Content GEI-100516 GSM for HMI Applications
Chapter 6 Application Notes 6-1
Introduction ...6-1 Sample Program – Alarms...6-1 Sample Program – View Data Lists...6-17 Networking...6-26 TCP communications ...6-26 Telnet Interface...6-26 Point ID Hint Parameter ...6-28 EGD...6-28
Glossary of Terms G-1
GEI-100516 GSM for HMI Applications Chapter 1 Overview •••• 1-1
Chapter 1 Overview
Introduction
The manual does not define the network although this is usually Ethernet with TCP/IP.
This manual defines message formats for communication between the turbine control system and the plant Distributed Control System (DCS). These formats are available to the DCS vendor for data collection and process control using the Mark IV, Mark V, Mark V LM, and Mark VI controllers.
The gateway is usually the HMI Server
GE Industrial Systems (GEIS) Standard Messages (GSM) are application level messages processed by software in an intervening box or gateway to the DCS. These gateways, in turn, can communicate directly with potentially several process
controllers. The general function of the gateway is to act as a protocol translator yielding a consistent external interface regardless of internal protocols and data representations used. No data is emitted from the gateway unless previously requested by the DCS equipment.
Note The gateway is usually an HMI server, and may or may not be only a gateway in function.
1-2 •••• Chapter 1 Overview GEI-100516 GSM for HMI Applications
GSM data flow from the controller over the data highway to the gateway and then to the DCS, and the flow of commands from the operator to the controller is shown in Figure 1.
Distributed Control System
DCS
Controller Network
Plant Data Highway
GSM data flow HMI Viewer HMI Viewer HMI Viewer
Controller Controller Controller
Gateway (HMI Server)
Figure 1. Gateway as used in a Turbine Control System
GSM Message Types
GSM supports the following types of request messages from the DCS:
• Administrative
• Event-driven data
• Periodic data
• Command
Administrative requests are not associated with a single process controller. These requests are messages from the DCS to the gateway, mainly to interrogate the capability of the gateway.
Sequence of events data and
alarms are available Event-driven data messages are spontaneously sent messages, sent as a result of achange in state. There are several classes of event driven data including the following:
• Changes in process alarm state
• Changes in digital input
• Software detected changes in pre-defined Boolean variables
• Deadband crossings detected in pre-defined analog variables
• Changes in controller alarm (diagnostic) state
Periodic data consists of sets of data requested to be transmitted back to the requester either once, or periodically at rates up to once per second. This data is used for updating status displays on the DCS console.
GEI-100516 GSM for HMI Applications Chapter 1 Overview •••• 1-3
Command requests fall into two generic classes:
• Process alarm command requests.
Command requests may be rejected by the controller or blocked by the gateway.
• Process command requests, either in the form of a momentary contact
pushbutton or in the form of an analog setpoint.
Notation
Unless otherwise noted all data is specified in little endian format. This is the byte order for Intel processors. For multi-byte data, the least significant byte is
transmitted first while the most significant byte is transmitted last.
For notational convenience, multi-byte data is shown below with the most significant byte to the left and the least significant byte on the right, but the transmission sequence of bytes is right to left. For example, a 32-bit integer value is shown as follows: <---TRANSMISSION SEQUENCE Bit # 31 0 ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º M.S.B. L.S.B. º ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍͼ
The number n may be zero.
Many messages have Name fields within them. The format of a Name field is in all cases, except parameter list entries (see below), a counted-ASCII string, where the first byte transmitted is treated an unsigned number n followed by the name itself. The first byte following n is the leftmost character in the name. For notational illustration, Name fields are shown generically as follows:
ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º (ASCIIC) <n> º ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍͼ
n, the record size, may be zero.
Similar to Name fields, many messages have records defined. In these instances, each record is identified by a Record Identifier or Record Type, followed by the record size, followed by the record specific information. For notational illustration, records are shown generically as follows: ÉÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º <Record Type> º ÌÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º <Size> º ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹ º <Record specific illustration> º ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍͼ
Most records within GSM messages are made up of groups of sub-records, which are implemented as parameter lists. Each item in a parameter list consists of at least two 16-bit words. The first word identifies the parameter. The second word identifies the number of bytes to follow which qualify the parameter. These two words are then followed by zero or more bytes (as defined by the second word). Software may use the parameter size to skip unknown parameters.
1-4 •••• Chapter 1 Overview GEI-100516 GSM for HMI Applications
Generic records containing parameter lists can be illustrated as follows:
ÉÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º <Record Type> º ÌÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º <Total Size> º ÌÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º Item Code #1 º ÌÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º Qual. #1 Size º ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹ Param #1 Qualifier º .../ /... ÍÍÍÍÍÍÍÍÍͼ . . ÉÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º Item Code #n º ÌÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º Qual. #n Size º ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹ Param #n Qualifier º .../ /... ÍÍÍÍÍÍÍÍÍͼ
A special item code with a value of 0x0000 is the End-of-list item code. Even if the total record size indicates space for more item list entries, no interpretation of data beyond End-of-list should be attempted. Software that scans item lists must simply bypass unknown or previously undefined item code entries.
Item Codes and Record Types have unique values. No item code has the same value as a defined record type.
Time tag accuracy depends on the controller scan, and is less than the time tag resolution.
Most data messages have time tagged data points within them. All time tags are represented using GEIS Standard Time. This is a structure consisting of two unsigned longwords (32-bits each). The first longword is the number of seconds since 1-JAN-1970 00:00:00.000000 GMT (Greenwich Mean Time). The second longword is the number of microseconds within the second, having a decimal range of 0-999,999. The latest date and time that can be stored is 07-FEB-2106
06:28:15.999999 GMT.
The layout of a time tag is as follows:
Byte Bit # 31 0 Offset ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º Seconds since 1-JAN-1970 00:00 GMT. º 0 ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º Microseconds º 4 ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
Within a message format specification, the time tag is as follows:
ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º 8 Byte Timetag º ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
Many of the message formats have RESERVED or MBZ fields. These fields are for use in future versions of the GSM specification. To preserve backward/forward compatibility, software, that generates GSM messages, must insert zeros in these fields. Software that receives GSM messages must ignore these fields.
GEI-100516 GSM for HMI Applications Chapter 1 Overview •••• 1-5
GSM allows data acquisition and control of multiple process controllers. Part of the generic GSM messages is a small message header consisting of three parts:
• A 16-bit message code that identifies the requested function, for example data
acquisition, or command.
• A 16-bit sequence number which is an arbitrary number generated by the
data/command requester to uniquely identify a given request; all responses to a given request message have this sequence number echoed back allowing stale data to be thrown away.
• An ASCIIC process controller name that defines the controller within a
multi-controller site to which the request is directed. A GSM message has a generic form as follows:
Message Offset ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º Message Code º 0 ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º Sequence Number º 2 ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º Controller Name (ASCIIC) <n> º 4 ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍËÍÍÍÍÍÍÍÍ͹ . Message . . Specific.
Time Tag Considerations
As shown above, the resolution of the GEIS standard time tag is one microsecond. All time tagged data is stamped at the source of the data, using the resolution available in the local process controller. The resolution of time stamps in the local process controller depends on the frame rate (control execution rate).
The Mark VI controller time-tags SOE data to within 1 ms.
Time tagging considerations include the I/O scan rates used. For example, certain control functions may only scan inputs at an eight Hz rate. This means that
consecutive data samples collected are time tagged in multiples of 125 milliseconds. The Mark VI controller typically runs at 25 Hz, and periodic data, alarms, and events are time tagged at this frame rate. Discrete Sequence of Events (SOE) data is tagged faster than this.
Time tag accuracy or coherency across different process controllers is the subject of time setting and time synchronization. GSM does not define the capability of time setting using messages over a network, nor does it allow the concept of time synchronizing process controllers over a network. Where required, time setting and time synching of process controllers can be handled by external equipment utilizing a common time reference. Time tag coherency in these cases is achieved to an accuracy as demanded by system requirements.
High-resolution time tagged data does not necessarily imply speedy reporting of data. Some process controllers, for example, may buffer multiple pieces of time tagged data into envelopes, which are delivered at a later time. Due to the
asynchronous nature of delivering buffered time-tagged data, it is both possible and likely that different pieces of data will not be delivered in chronological order.
1-6 •••• Chapter 1 Overview GEI-100516 GSM for HMI Applications
Summary of Messages
A summary of the GSM message types and the associated parameters are shown in the following three tables.
Table 1-1. Message Code Summary
Message
Code Message Type Sent By
0x0100 Supported Controller Request DCS 0x0101 Supported Controller Response Gateway 0x0200 Heartbeat Message DCS 0x0300 Alarm Establish Request DCS 0x0301 List Establish ACK/NAK Gateway 0x0302 Alarm Data Message Gateway 0x0400 Digital Input Record Establish Request DCS 0x0402 Digital Input Record Data Message Gateway 0x0500 Software Event Record Establish Request DCS 0x0502 Software Event Data Message Gateway 0x0600 Periodic Data Request DCS 0x0601 Periodic Data ACK/NAK Response Gateway 0x0602 Periodic Data Message Gateway 0x0700 Alarm Command Request DCS 0x0701 Alarm Command ACK/NAK Gateway 0x0702 Alarm Dump Message Gateway 0x0800 Process Control Command Request DCS 0x0801 Process Control ACK/NAK Response Gateway
Table 1-2. Record Identification Summary
Record ID Record Type
0x8000 List of sub-records
0x8100 Controller Information parameter list 0x8300 Alarm Information parameter list 0x8400 Digital Input Information parameter list 0x8500 Software Event Information parameter list
GEI-100516 GSM for HMI Applications Chapter 1 Overview •••• 1-7
Param ID Parameter Type
0x0000 End of parameter list 0x1000 Process controller name
0x1010 Number of communication links to process controller 0x1020 Process controller type
0x1030 Point name (short name) 0x1040 Time tag
0x1050 Alarm drop number 0x1060 Point value 0x1070 Alarm locked state 0x1080 Alarm reason code 0x1090 Point text (long name) 0x10A0 Alarm sequence number 0x10B0 Process control setpoint value 0x10C0 Alarm ACK state
1-8 •••• Chapter 1 Overview GEI-100516 GSM for HMI Applications
GEI-100516 GSM for HMI Applications Chapter 2 Administrative Requests •••• 2-1
Chapter 2 Administrative Requests
Introduction
This chapter defines messages from the DCS to the gateway that request the identity of the connected controllers, and periodically inform the gateway that the DCS is functioning.
Supported Controller Request
The DCS issues a supported controller request to the gateway to determine which process controllers the gateway can communicate with, along with the current communication status. This request is a DCS-to-gateway message, and as such the Controller Name field is inappropriate. The gateway ignores this field, but the DCS should still insert a zero length name.
The format of the message is as follows:
Message Offset NOTES ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º 0x0100 º 0 Message Code ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º Sequence Number º 2 ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Controller Name (ASCIIC) <n> º 4 Field Ignored ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
Supported Controller Response
The gateway responds to the request with a list of supported controllers, the controller type, and current communication status. The response is a series of parameter lists where each parameter list defines information about a single controller.
2-2 •••• Chapter 2 Administrative Requests GEI-100516 GSM for HMI Applications
The format of the supported controller response is as follows:
Message Offset Notes ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º 0x0101 º 0 Message Code ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Sequence Number º 2 From request ÈÍÍÍÍÍÍÍÍÍËÍÍÍÍÍÍÍÍ͹
º 0 º 4 ASCIIZ Controller Name ÉÍÍÍÍÍÍÍÍÍÊÍÍÍÍÍÍÍÍ͹
º Reserved º 5 ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 0x8000 º 7 Record Type *1 ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º <Size 1> º 9 Size of Response ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 0x8100 º 11 First Controller Info ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º <Size 2> º 13 Size of Controller Info ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
First Controller Information º 15 Parameter List ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º 0x8100 º 15+Size2 ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º <Size 3> º ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
Second Controller Information º Parameter List ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ . . . ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º 0x8100 º ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º <Size n> º ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
Last Controller Information º Parameter List ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
This response contains a list of parameter lists (denoted by *1), and is identified by a record type value of 0x8000. Each parameter list corresponds to a supported
controller. Possible parameters are defined here. The controller name is defined as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1000 º Param ID = Controller Name ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º <Size n> º Size of controller name. ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
Controller Name º ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
The number of communication links that are currently active between the gateway and the controller is defined as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1010 º Param ID = Active Comm Links ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 2 º Parameter size. ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º º Number of active links. ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
A value of zero indicates that the gateway supports the controller, but cannot currently communicate with it.
GEI-100516 GSM for HMI Applications Chapter 2 Administrative Requests •••• 2-3
The interface type is defined as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1020 º Param ID = Interface type ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 2 º Parameter size. ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º º Controller type.. ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
The currently defined interface types are as follows:
• 0001 – Turbine Controller
• 0002 – CIMPLICITY
• 0003 - EGD
Other interface types may be defined in the future.
2-4 •••• Chapter 2 Administrative Requests GEI-100516 GSM for HMI Applications
Heartbeat Message
The DCS requests to be on various distribution lists as defined in Chapters 3 and 4. The Heartbeat message is a status message in a DCS-to-gateway administrative message that should be transmitted by the DCS approximately every 20 seconds. If the gateway does not receive a heartbeat message from the DCS for a period of 60 seconds, any data lists currently defined on behalf of the DCS are automatically canceled and the connection to the DCS is terminated. The gateway does not respond to heartbeat messages.
The format of the Heartbeat message is shown below:
Message Offset Notes ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x0200 º 0 Message Code ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Sequence Number º 2 Field Ignored ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Controller Name (ASCIIC) <n> º 4 Field Ignored ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
GEI-100516 GSM for HMI Applications Chapter 3 Event Driven Requests •••• 3-1
Chapter 3 Event Driven Requests
Introduction
This chapter describes how alarms are communicated from the controllers to the DCS. The handling of alarms and discrete sequence of events data are covered.
Alarm Record Establish Request
This message requests that the gateway place the DCS on, or remove it from the distribution list for process alarm messages. Process alarm messages defined below are container messages issued spontaneously any time a process alarm changes state. State changes include transitions in alarm value, alarm lock/unlock transitions, and removal of an alarm from the process controller's alarm queue (if supported in the controller). For CIMPLICITY alarms, a resource ID may be substituted for the controller name and only alarms for that resource are forwarded to the DCS. The format of the alarm establish request is as follows:
ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x0300 º 0 Message Code ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Sequence Number º 2 ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Controller Name (ASCIIC) <n> º 4 Controller Name ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Alarm Function º 5+n ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º Options º 7+n ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
Alarm Function has two defined values:
0x0000 requests that the DCS be added to the alarm distribution list for the specified controller.
0xFFFF requests that the DCS be removed from the alarm distribution list. All other values are reserved.
Options request that other information be included in spontaneously sent alarm messages:
Bit 0 = 1 requests that alarm text be included in alarm messages; otherwise alarm text will be omitted.
3-2 •••• Chapter 3 Event Driven Requests GEI-100516 GSM for HMI Applications
Alarm Record Establish ACK/NAK Response
The gateway responds to an alarm record establish request with an establish ACK/NAK response. The format of the establish ACK/NAK response is:
ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x0301 º 0 Message Code ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Sequence Number º 2 (Echoed) ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Controller Name (ASCIIC) <n> º 4 Controller Name ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 0x0300 º 5+n Establish Code ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Alarm Function º 7+n (Echoed) ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Estab. Status º 9+n ACK/NAK Code ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
The Sequence Number, Controller Name, and Alarm Function are echoed from the alarm establish request. The establish code is 0x0300 for an alarm ACK/NAK response.
Table 3-1. Alarm Record Establish ACK/NAK Response Codes
Code Description
0 Success
+1 DCS is on the gateway's distribution list. Communication with the process controller is not currently possible
-1 Unknown controller name
-2 Function not supported by process controller -3 Gateway distribution list table is full
-4 Malformed request
Alarm Data Messages
Alarm data messages are sent spontaneously to any DCS on the gateway's distribution list for alarm messages. Alarm data messages are container messages with one or more alarms that have changed state. These messages do not provide the current status of all alarms.
The Mark V alarm queue can contain up to 64 entries. All of the Mark V alarm points are available as periodic data.
Alarms in the Mark VI work the same as the Mark V, however, the Mark VI alarm queue can contain up to 128 entries. Not all Mark VI alarm points are available as periodic data, therefore the point names returned in alarm data messages should not be used in periodic data requests.
The alarm data message contains parameter lists that define information about a single alarm. Not all controllers support all possible parameters. Information not relevant to a given controller is not included.
GEI-100516 GSM for HMI Applications Chapter 3 Event Driven Requests •••• 3-3
The alarm data message is as follows:
Message
Offset NOTES ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x0302 º 0 Message Code ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Sequence Number º 2 From Estab. Request ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Controller Name (ASCIIC) <n> º 4 Controller Name ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Request Status º 5 ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 0x8000 º 7 Record Type *1 ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º <Size 1> º 9 Size of Response ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 0x8300 º 11 First Alarm Info ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º <Size 2> º 13 Size of Alarm Info ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
First Alarm Information º 15 Parameter List ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º 0x8300 º 15+Size2 ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º <Size 3> º ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
Second Alarm Information º Parameter List ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ . . ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º 0x8300 º ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º <Size n> º ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
Last Alarm Information º Parameter List ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
These messages contain a list of parameter lists (denoted by *1), and identified by a record type value of 0x8000. Each parameter list corresponds to a single alarm, which has changed state. The possible parameters are defined here.
The format of the short name of the alarm is as follows. This parameter is not included if the gateway cannot translate the alarm drop into its short name form.
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1030 º Param ID = Point Name ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º <Size n> º Size of point name. ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
Point Name º ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
The format of the time tag associated with the alarm record is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1040 º Param ID = Time tag ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 8 º Parameter size. ÉÍÍÍÍÍÍÍÍÍ..//..ÈÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 8 Byte Timetag º Alarm Queue Time ÈÍÍÍÍÍÍÍÍÍ..//..ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
3-4 •••• Chapter 3 Event Driven Requests GEI-100516 GSM for HMI Applications
The alarm drop number format is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1050 º Param ID = Alarm Drop Number ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 2 º Parameter size. ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º º Drop Number ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
The alarm state format is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1060 º Param ID = Alarm State ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 1 º Parameter size. ÈÍÍÍÍÍÍÍÍËÍÍÍÍÍÍÍÍ͹
º º Alarm State ÈÍÍÍÍÍÍÍÍͼ
Bit 0 defines the current state of the alarm. Bit 0 = 0 if out of alarm.
Bit 0 = 1 if in alarm. All other bits are reserved. The alarm lock state is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1070 º Param ID = Alarm Lock State ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 1 º Parameter size. ÈÍÍÍÍÍÍÍÍËÍÍÍÍÍÍÍÍ͹
º º Alarm Lock State ÈÍÍÍÍÍÍÍÍͼ
Bit 0 defines the current lock state of the alarm. Bit 0 = 0 if alarm is not locked.
Bit 0 = 1 if alarm is locked. All other bits are reserved.
The reason code parameter defines why the alarm record is being sent. It is used for remote alarm queue management.
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1080 º Param ID = Reason Code ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 1 º Parameter size. ÈÍÍÍÍÍÍÍÍËÍÍÍÍÍÍÍÍ͹
º º Reason Code ÈÍÍÍÍÍÍÍÍͼ
GEI-100516 GSM for HMI Applications Chapter 3 Event Driven Requests •••• 3-5
Table 3-2. Alarm Data Reason Codes
Code Description
0x00 Not used
0x01 Alarm state just transitioned 0x02 Alarm just locked
0x03 Alarm just unlocked 0x04 Reserved
0x05 Alarm just re-triggered. Reset time tag in the alarm queue 0x06 Reserved
0x07 Alarm just acknowledged
0x08 Alarm reset. Remove alarm from alarm queue 0x09 Alarm Dump Record
0xFE End of Alarm Dump
0xFF Clear Alarm Queue to prepare for alarm dump All other values are reserved
The long name (text) format is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1090 º Param ID = Long Name ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º <Size n> º Size of long name. ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
Long Name º ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
This information is not sent if it is not requested in the alarm establish message. The text size is zero if the gateway cannot provide the associated text.
The alarm record sequence number format is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x10A0 º Param ID = Alarm Seq. Number ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 2 º Parameter size. ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º º Alarm Sequence Number ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
Refer to Chapter 5 for the alarm dump message.
Each alarm queue has a sequence number, which is incremented for every alarm record. The alarm sequence number is provided for remote alarm queue
management. If the remote alarm queue sequence number (plus 1) does not equal this sequence number, then the remote alarm queue is out-of-sync with the process controller's alarm queue. In this event, the DCS should request an alarm dump to re-synchronize. This value is a two-byte unsigned integer and will rollover after 0xFFFF.
3-6 •••• Chapter 3 Event Driven Requests GEI-100516 GSM for HMI Applications
The alarm ACK state parameter is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x10C0 º Param ID = Alarm ACK State ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 1 º Parameter size. ÈÍÍÍÍÍÍÍÍËÍÍÍÍÍÍÍÍ͹
º º Alarm ACK State Value ÈÍÍÍÍÍÍÍÍͼ
Bit 0 defines the Acknowledged state of the alarm. Bit 0 = 0 if the alarm has not been acknowledged.
Bit 0 = 1 if the alarm has been acknowledged. All other bits are reserved. The point ID hint parameter is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x10D0 º Param ID = Point ID Hint ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 2 º Parameter size. ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º º Point ID Hint Value ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
The gateway sends this parameter if it cannot translate the alarm drop number into its short name form. Reception of this parameter indicates incomplete translation tables in the gateway.
The end of the list parameter is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x0000 º Param ID = END-OF-LIST ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 0x0000 º Parameter size. ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
No more information about this alarm follows.
Digital Input Record Establish Request
This message requests that the gateway place the DCS on, or remove it from, the distribution list for digital input messages. Digital input messages defined below are container messages issued spontaneously any time a digital input in the process controller changes state (if supported in the controller). The gateway always responds to this request with an establish ACK/NAK message.
The format of the digital input establish request is as follows:
ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x0400 º 0 Message Code ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Sequence Number º 2 ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Controller Name (ASCIIC) <n> º 4 Controller Name ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Estab. Function º 5+n ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º Options º 7+n ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
Establish Function has two defined values:
0x0000 requests that the DCS be added to the digital input distribution list for the specified controller.
0xFFFF requests that the DCS be removed from the distribution list. All other values are reserved.
GEI-100516 GSM for HMI Applications Chapter 3 Event Driven Requests •••• 3-7
Options request other information be included in spontaneously sent digital input messages:
Bit 0 = 1 requests that longname descriptive text be included in any generated digital input messages; otherwise longname text will be omitted.
Bits 1-15 are reserved and must be zero.
Digital Input Record Establish ACK/NAK Response
The gateway responds to a digital input establish request with an establish ACK/NAK response.
The establish ACK/NAK response format is as follows:
ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x0301 º 0 Message Code ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Sequence Number º 2 (Echoed) ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Controller Name (ASCIIC) <n> º 4 Controller Name ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 0x0400 º 5+n Establish Code ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Estab. Function º 7+n (Echoed) ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Estab. Status º 9+n ACK/NAK Code ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
The Sequence Number, Controller Name, and Establish Function are echoed from the digital input establish request. The establish code = 0x0400 for a digital input ACK/NAK response.
Table 3-3. Digital Input Record ACK/NAK Code Description
0 Success
+1 The DCS is on the Gateway's distribution list. Communication
with the process controller is not currently possible
-1 Unknown Controller Name
-2 Function not supported by process controller
-3 Gateway distribution list table is full
-4 Malformed request
Digital Input Data Messages
Digital input data messages are sent spontaneously to any DCS on the gateway's distribution list for digital input messages. Digital input data messages are container messages with one or more inputs that have changed state, such as sequence of events data.
This message contains parameter lists that define information about a single digital input. Not all process controllers support all possible parameters. Information not relevant to a given process controller is not included.
3-8 •••• Chapter 3 Event Driven Requests GEI-100516 GSM for HMI Applications Message Offset NOTES ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º 0x0402 º 0 Message Code ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Sequence Number º 2 From Estab. Request ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Controller Name (ASCIIC) <n> º 4 Controller Name ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Request Status º 5+n ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 0x8000 º 7+n Record Type *1 ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º <Size 1> º 9+n Size of Response ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 0x8400 º 11+n First Digin Info ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º <Size 2> º 13+n Size of Digin Info ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
First Digital Input Information º 15+n Parameter List ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º 0x8400 º 15+Size2 ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º <Size 3> º ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
Second Digital Input Information º Parameter List ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ . . ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º 0x8400 º ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º <Size n> º ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
Last Digital Input Information º Parameter List ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
These messages contain a list of parameter lists (denoted by *1), identified by a record type value of 0x8000. Each parameter list corresponds to a single digital input, which has changed state. Possible parameters are shown below:
The point name parameter is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1030 º Param ID = Point Name ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º <Size n> º Size of point name. ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
Point Name º ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
This parameter defines the short name (point name) of the digital input. This parameter is not included if the gateway is incapable of translating the digital input number into its short name form.
The time tag parameter is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1040 º Param ID = Timetag ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 8 º Parameter size. ÉÍÍÍÍÍÍÍÍÍ..//..ÈÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 8 Byte Timetag º Alarm Queue Time ÈÍÍÍÍÍÍÍÍÍ..//..ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
The time digital input changed state parameter is as follows. Bit 0 defines the current state; all other bits are reserved.
GEI-100516 GSM for HMI Applications Chapter 3 Event Driven Requests •••• 3-9
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1060 º Param ID = Digin State ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 1 º Parameter size. ÈÍÍÍÍÍÍÍÍËÍÍÍÍÍÍÍÍ͹
º º Digital Input State ÈÍÍÍÍÍÍÍÍͼ
The long name (text) associated with the digital input is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1090 º Param ID = Long Name ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º <Size n> º Size of long name. ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
Long Name º ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
The above information is not sent if it was not requested in the digital input establish message. Text size will be zero if the gateway cannot provide the associated text. The point ID hint parameter is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x10D0 º Param ID = Point ID Hint ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 2 º Parameter size. ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º º Point ID Hint Value ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
The gateway sends the above parameter if it cannot translate the digital input number into its short name form. Reception of this parameter indicates incomplete translation tables in the gateway.
The end of list parameter is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x0000 º Param ID = END-OF-LIST ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 0x0000 º Parameter size. ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
This indicates there is no more information about this digital input.
Software Event Record Establish Request
This message requests that the gateway place the DCS on, or remove it from, the distribution list for software event messages. Software events are usually caused by a step in a sequence or a change in the status of a device, such as breaker position. Event messages defined here are container messages issued spontaneously any time a logic variable in the controller changes state (if supported in the controller). The logic variables to be change-detected by software are predefined in the controller. The gateway always responds to this request with an establish ACK/NAK message.
3-10 •••• Chapter 3 Event Driven Requests GEI-100516 GSM for HMI Applications
The software generated event establish request format is as follows:
ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x0500 º 0 Message Code ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Sequence Number º 2 ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Controller Name (ASCIIC) <n> º 4 Controller Name ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Estab. Function º 5+n ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º Options º 7+n ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
Establish Function has two defined values:
0x0000 requests that the DCS be added to the event message distribution list for the specified controller.
0xFFFF requests that the DCS be removed from the distribution list. All other values are reserved.
Options request other information be included in spontaneously sent event messages. Bit 0 = 1 requests that longname descriptive text be included in any generated software event messages; otherwise the longname text is omitted.
Bits 1-15 are reserved and must be zero.
Software Event Record Establish ACK/NAK Response
The gateway responds to an event establish request with an establish ACK/NAK response.The establish ACK/NAK response format is as follows:
ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x0301 º 0 Message Code ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Sequence Number º 2 (Echoed) ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Controller Name (ASCIIC) <n> º 4 Controller Name ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 0x0500 º 5+n Establish Code ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Estab. Function º 7+n (Echoed) ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Estab. Status º 9+n ACK/NAK Code ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
The Sequence Number, Controller Name, and Establish Function are echoed from the event establish request. The establish code is 0x0500 for an event ACK/NAK response.
Table 3-4. Software Event Record Establish ACK/NAK Codes Code Description
0 Success
+1 The DCS is on the gateway's distribution list. Communication with the process controller is not currently possible.
-1 Unknown controller name
-2 Function not supported by the process controller -3 Gateway distribution list table is full
GEI-100516 GSM for HMI Applications Chapter 3 Event Driven Requests •••• 3-11
Software Event Data Messages
Software event data messages are sent spontaneously to any DCS, which has been placed on the gateway's distribution list for event messages. Event data messages are container messages containing one or more logic points, which have changed state. This message contains parameter lists that define information about a single logic variable. Not all controllers support all possible parameters. Information not relevant to a given controller is not included.
Message
Offset NOTES ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x0502 º 0 Message Code ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Sequence Number º 2 From Estab. Request ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Controller Name (ASCIIC) <n> º 4 Controller Name ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Request Status º 5 ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 0x8000 º 7 Record Type *1 ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º <Size 1> º 9 Size of Response ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 0x8500 º 11 First Event Info ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º <Size 2> º 13 Size of Event Info ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
First Event Information º 15 Parameter List ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º 0x8500 º 15+Size2 ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º <Size 3> º ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
Second Event Information º Parameter List ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ . . ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º 0x8500 º ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º <Size n> º ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
Last Event Information º Parameter List ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
These messages contain a list of parameter lists (denoted by *1), and identified by a record type value of 0x8000. Each parameter list corresponds to a single logic value, which has changed state. Possible parameters are shown below.
The short name of the event is as follows. This parameter is not included if the gateway is incapable of translating the event number into its short name form.
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1030 º Param ID = Point Name ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º <Size n> º Size of point name. ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
Point Name º ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
3-12 •••• Chapter 3 Event Driven Requests GEI-100516 GSM for HMI Applications
The time logic variable changed state parameter is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1040 º Param ID = Timetag ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 8 º Parameter size. ÉÍÍÍÍÍÍÍÍÍ..//..ÈÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 8 Byte Timetag º Alarm Queue Time ÈÍÍÍÍÍÍÍÍÍ..//..ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
The event state parameter is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1060 º Param ID = Event State ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 1 º Parameter size. ÈÍÍÍÍÍÍÍÍËÍÍÍÍÍÍÍÍ͹
º º Event State ÈÍÍÍÍÍÍÍÍͼ
Bit 0 below defines the current state of the logic variable. All other bits are reserved. The long name (text) associated with the event is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x1090 º Param ID = Long Name ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º <Size n> º Size of long name. ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
Long Name º ...// ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
This information is not sent if it was not requested in the software event establish message. Text size will be zero if the gateway cannot provide the associated text. The point ID hint parameter is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x10D0 º Param ID = Point ID Hint ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 2 º Parameter size. ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º º Point ID Hint Value ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
The gateway sends this parameter if it cannot translate the event number into its short name form. Reception of this parameter indicates incomplete translation tables in the gateway.
The end of the list parameter is as follows:
ÉÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x0000 º Param ID = END-OF-LIST ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 0x0000 º Parameter size. ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
GEI-100516 GSM for HMI Applications Chapter 4 Periodic Data Messages •••• 4-1
Chapter 4 Periodic Data Messages
Introduction
This chapter describes how data is requested and sent to the DCS on a continuing basis. The data request, acknowledgement, and data messages are also defined.
Periodic Data Request
The DCS operator interface requires data on a regular basis (periodic data).
The DCS can define lists of data to be returned on a periodic basis. This is typically used to maintain real-time databases for display purposes. Using this method, any data point defined in the process controller (and also defined in the gateway's database) can be returned to the DCS. Multiple data lists may be defined by the DCS. Limitations are placed on list definitions based on the controller as shown in the following table.
Table 4-1. Data List Limitation
Controller Maximum Points per List
Max Number of Lists Mark V 96 32 Mark V LM 50 64 Mark VI 300 none CIMPLICITY 300 none
As shown in the table, the Mark VI list holds up to 300 points of typical length. However, the GSM 0600 message, that defines the periodic data list, is 4096 bytes in length. Therefore, if the point names are long, all 300 might not fit in the message. Mark VI always uses CIMPLICITY point names.
4-2 •••• Chapter 4 Periodic Data Messages GEI-100516 GSM for HMI Applications
The gateway responds to a periodic data request with a periodic data ACK/NAK message.
The periodic data list definition is as follows:
ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x0600 º 0 Message Code ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Sequence Number º 2 ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Controller Name (ASCIIC) <n> º 4 Controller Name ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º Estab. Function º 5+n ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º List Name º 7+n ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º Period Code º 9+n ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º 0x1030 º11+n Pointname Param ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ List º <Size m> º ÈÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ First Point Name º ..//..ÍÍÍËÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º 0x1030 º ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º <Size x> º ÈÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ Second Point Name º ..//..ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ . . ÉÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ» º 0x1030 º ÌÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ º <Size z> º ÈÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹ Last Point Name º ..//..ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
List Name combined with Controller Name defines a unique set of data points to be returned. If the request contains a List Name/Controller Name that is identical to a previously defined set, the new request supersedes the previous definition. List Name may be any value.
Establish Function has two defined values.
0x0000 requests that the data points specified in the request be returned to the DCS according to the Period Code.
0xFFFF-requests cancellation of any previously defined list corresponding to the List Name/Controller Name.
Period Code defines the number of seconds between data transmissions. It is ignored on list cancellation requests. A Period Code with a value of zero requests the data to be transmitted only once.
The Point Name parameter list is ignored on list cancellations resulting from the Establish Function. The Point Name parameter is an ASCII string and must match the point name defined in the controller configuration.
Periodic Data ACK/NAK Response
The gateway responds to a periodic data request with a periodic data ACK/NAK response.
GEI-100516 GSM for HMI Applications Chapter 4 Periodic Data Messages •••• 4-3
The periodic data ACK/NAK response is as follows:
ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍÍ»
º 0x0601 º 0 Message Code ÌÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Sequence Number º 2 (Echoed) ÉÍÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Controller Name (ASCIIC) <n> º 4 Controller Name ÈÍÍÍÍÍÍÍÍÍÏÍÍÍÍÍÍÍÍ/../ÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º 0x0600 º 5+n Establish Code ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º List Name º 7+n (Echoed) ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Estab. Function º 9+n (Echoed) ÌÍÍÍÍÍÍÍÍÑÍÍÍÍÍÍÍÍ͹
º Estab. Status º 11+n ACK/NAK Code ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
The Sequence Number, Controller Name, List Name, and Establish Function are echoed from the event establish request. The establish code is 0x0600 for a periodic data ACK/NAK response.
Table 4-2. Periodic Data ACK/NAK Codes
Codes Description
0 Success
+1 DCS on gateway's distribution list. Communication with the process controller is not currently possible -1 Unknown controller name
-2 Function not supported by the process controller -3 Gateway periodic list definition table is full -4 Malformed request
-5 Internal gateway error
-6 All points requested are undefined -7 Too many data points defined in request