You are on page 1of 30

GEI-100165

GE Drive Systems

GEDS STANDARD MESSAGE FORMAT (GSM)

INTRODUCTION

This document defines message formats available to Distributed Control System (DCS) vendors for data collection and
unit control It does not define the message transport mechanism, although, it is presumed to be a Transmission Control
Protocol (TCP) over and Internet Protocol (IP) system.

GEDS (GE Drive Systems) Standard Messages are application level messages Within the following chapter, they will be
collectively referenced as “GSM.”

GSM messages are processed by software via an intervening box or “gateway” (<G>) 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 that provides a consistent external interface-regardless of the internal protocols and data
representations used

In terms of the DCS equipment, the gateway can be viewed as a slave. No data will be emitted from the gateway unless
previously requested by the DCS equipment.

NOTE

The intervening box may not function exclusively as gateway device. However, as the term “gateway” will
be used to denote the device, the remainder of this document will continue to refer to the intervening box
as a gateway.

SYNTAX

Unless otherwise noted, all data contained herein is arranged in “Little Endian” format. For multi-byte data, the least
significant byte is transmitted first while the most significant byte is transmitted last. An example of multi-byte (32 bit
integer value) data is shown below The most significant byte is to the left while the least significant byte is on the right
It should be recognized however, that the transmission sequence of bytes will be right to left
<-------------------------------------- Transmission Sequence

Bit # 31 0
I I I
MSB LSB
I I I

Many GSM messages have “Name” fields contained within them. The format of a Name field is (with the exception of
parameter list entries-see below) a counted-ASCII string The first byte transmitted is treated as an unsigned number
(“n”). The first byte following “n” is the left-most character in the name (note that “n” may be zero) A generic Name
field is shown immediately below
GE&100165 GEDS STANDARD MESSAGE FORMAT (GSM)

I I
MSB LSB
I I
/. ./
In addition to name fields, GSM messages may have “RECORDS” defined within them In these instances, each Record
will be identified by a “Record Identifier” or “Record Type.” This information will in turn be followed by data that
defines the record size Termination of the record is accomplished by record specific information. Note that the “n”
(record size) may be zero A generic example of a record follows:

: ;..;;I
Record specific '
..

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 in turn qualifies its function) These two words are followed by zero
or more bytes (as defined by the second word) Software may skip unknown parameters by adding <Parameter Size> + 4
to the current item entry pointer

Generic records containing parameter lists can be illustrated as follows:

<Record Type>

<Total Size>

Item Code #l

Qual. #l Size

Param #l Qualifier
D . . / /...

;I:1;:;.;:.

Param #n Qualifier
... . ..

A special item code with a value of 0x0000 is the “End-of-list” item code. No interpretation of data beyond “End-of-list”
should be attempted (even if the total record size indicates space for more item list entries)

Software in the DCS should perform a number of integrity checks on parameter lists For example, an item code/qualifier
size pair must begin within at least 4 bytes of the “record” itself, otherwise, software must reject the entry in the record
Also, the entire qualifier must fully fit within the “record” itself. 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 will have the same value as a defined Record Type

Data messages typically have time-tagged data points contained within them All time-tags are represented using GEDS
“Standard Time ” The GEDS standard time representation is a structure consisting of two unsigned long-words (32 bits
each) The first long-word is the number of seconds since l-JAN-1970 00 00 00.000000 GMT (Greenwich Mean Time)

2
GEDS STANDARD MESSAGE FORMAT (GSM) GEI-100165

The second long-word is the number of microseconds within the second; this value having a decimal range of O-999,999.
The latest date and time that can be stored using this representation is 07-FEB-2106 06:28:15 999999 GMT or UTC
(Universal Time Coordinated).

The layout of the time-tag is illustrated immediately below


Byte
Bit # 31 0 Offset
I I I 0
Seconds since l-JAN-1970 0O:OO GMT.
I I
Microseconds 4
I

Within a message format specification, the time-tag will be illustrated in the following manner

8 Byte time-tag

Many of the message formats have fields within them defined as “Reserved” or “Must-Be-Zero” (MBZ) These fields are
intended for use in future versions of the GSM specification. To preserve backward/forward compatability, software
which generates GSM messages must fill in Reserved and MBZ fields with zeros. Software that receives GSM messages
must ignore these fields.

GSM allows data acquisition/control of multiple process controllers As a consequence, generic GSM messages are
equipped with a small message header that consists of three parts. 1. a 16 bit message code, 2 a 16 bit “sequence
number,” and 3. an ASCIIC processor controller name The message code identifies the requested function (data
acquisition, command etc ) The “sequence number” is an arbitrary value generated by the data/command requestor to
uniquely identify a given request, all responses to a given request message will have this sequence number echoed back
allowing “stale” data to be thrown away The ASCIIC controller name defines the controller with which the request is
being directed

A GSM message has the following generic form


Message
Offset

. Message .
. Specific .

TIME-TAG CONSIDERATIONS

The resolution of the GEDS standard time-tag is 1 microsecond All time-tagged data is stamped at its source using the
resolution available in the local processor controller The resolution of time-stamps in the local unit is usually less than 1
microsecond (i.e., it is more coarse)

Scan rates constitute another time-tagging consideration For example, certain control functions may only scan inputs at
an 8 Hz. rate. This means that consecutive data samples collected will be time-tagged in multiples of 125 milliseconds
Other controllers (such as the Mark V Sequence of Events [SOE] scanner) run at a much higher rate (every 122
microseconds).
GEI-100165 GEDS STANDARD MESSAGE FORMAT (GSM)

Time-tag accuracy or coherency across different units is the subject of time-setting and time-synchronization GSM does
not permit time-setting or time-synching of units via messages over a network Where required, time-setting/time-
synching of unit will be handled by external equipment utilizing a common time reference Time-tag coherency in these
cases will be achieved to an accuracy as demanded by system requirements

High resolution time-tagged data does not necessarily imply rapid reporting of data For example, some process
controllers 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, various pieces of data may not be delivered in their
chronologic order

GSM MESSAGE TYPE SUMMARY

GSM supports the following types of request messages

. Administrative requests
. Requests for “event-driven” data
. Requests for “periodic” data
. Command requests

Administrative requests are not associated with a single process controller. They are DCS-to-gateway messages that are
used mainly to interrogate the capability of the gateway

“Event-driven” data messages are signals sent as a result of a change in state There are several classes of event-driven
data These include the following:

. Changes in process alarm state


. Changes in digital input
. Software detected changes in pre-defined boolean variables

“Periodic” data consists of sets of data requested to be transmitted back to the requestor-either singly, or on a periodic
basis (at rates up to once-per-second) This type of data is typically used for updating status displays

Command requests fall into 2 generic classes These include:

1. Process alarm command requests


2 Process command requests either in the form of momentary contact “push-buttons,”
or in the form of analog setpoints.

NOTE

It should be noted that command requests may be rejected by the local controller or blocked by the
gateway as directed by system requirements.

ADMlNlSTRATlVE MESSAGE FORMATS

Supported Unit Request

This request is issued by the DCS to the gateway, which in response sends back information defining its communication
status (i e , the controllers it has been set-up to communicate with-as well as the controllers with which it is actually
communicating) Note that as a DCS-to-gateway message, the “Controller Name” field is inappropriate The gateway will
ignore this field, however, the DCS should still fill it in as a zero length name

4
GEDS STANDARD MESSAGE FORMAT (GSM) GEI-100165

The format of the Unit Request message is shown immediately below


Message
Offset Notes

Supported Unit Response

When the DCS initiates a unit request, the gateway will respond with a list of supported units, controller types, and its
current communication status This response will be in the form of a list of parameter lists-where each parameter list
will define information about a single unit The format of the response is shone below

Identified by a Record Type value of 0x8000, the above response contains a list of parameter lists Each parameter list
(also denoted by “1) corresponds to a supported unit controller.

Messaae
Offs& Notes

0 Message Code

2 From request

4 ASCIIZ Unit Name

Reserved 5
I
0x8000 7 Record Type *l
I
-Gizel> 9 Size of Response
!
I
0x8100 11 First Unit Info. "2

<Size
I 2> 13 Size of Unit Info
!
I
First Unit Information 15 Parameter List *3

15+Size2 *2

Ij!Es$q Parameter List "3

"2

Parameter List *3
GEI-100165 GEDS STANDARD MESSAGE FORMAT (GSM)

Possible parameters (denoted by *3 above) are shown immediately below

0x1600 Param ID = Unit Name


I
<Size n> Size of unit name

Unit Name II
II
. . . //

The parameter below defines the number of communication links that are currently active between the gateway and an
individual unit controller (communication between the gateway and the process controller may have multiple paths). A
value of zero indicates that the gateway supports the unit controller, but cannot currently communicate with it.

Param ID = Active Cmm Links

Parameter size

Number of Active Links

The following parameter defines the unit controller type

Param ID = Controller types

Parameter size

Controller Type

Currently defined “Controller Types” are

0001 - Turbine Controller

Other values will be defined in the future

Heartbeat Message

The “Heartbeat” message is a keep-alive message that is incorporated within a DCS-to-Gateway administrative
communication Its purpose is to maintain the status of the DCS in the gateway distribution list. If the gateway does not
receive a heartbeat message from the DCS after 60 seconds, any data lists currently defined on behalf of the DCS will
automatically be cancelled In normal operation, a heartbeat message should be transmitted by the DCS approximately
every twenty (20) seconds (The gateway does not respond to heartbeat messages )

The format of the Heartbeat message is shown below:

Message
Offset Notes

6
GEDS STANDARD MESSAGE FORMAT (GSM) GEI-100165

EVENT DRIVEN DATA MESSAGES

Alarm Record Establish Request

This message requests the gateway to add/remove the DCS to/from the distribution list for process alarm messages The
process alarm messages defined below are container messages (messages that may contain multiple communications) that
are issued any time a process alarm changes state. State changes include transitions in an alarm value, alarm lock/unlock
transitions, and removal of an alarm from a unit’s alarm queue (if supported in the controller)

The gateway always responds to this request with an establish acknowledge/negative acknowledge (ACWNAK) message.

The format of the alarm establish request is as follows.

Message
Offset Notes

0 Message Code

4 Unit Name

5+n

7+n

For the above message, “Alarm Function” has two defined values 0x0000 requests that the DCS be added to the alarm
distribution list for the specified unit OxFFFF requests that the DCS be removed from the alarm distribution list. All
other values are reserved

The “Options” parameter requests other information be included in alarm messages Bit 0 = 1 requests that alarm text be
included in alarm messages (otherwise, alarm text will be omitted) Bits 1-15 are reserved and must therefore be zero.

Alarm Record Establish ACKINAK Response

The gateway responds to an alarm establish request with a generic establish ACKLNAK response

The format of the establish ACWNAK response is as follows

Message Notes
Offset
0 Message Code

2 (Echoed)

Controiler Name (ASCIIC) 4 Unit Name

0x0300 5+n Establish Code

Alarm Function 7+n (Echoed)

Estab. Status 9+n ACK/NAK Code


GEI-100165 GEDS STANDARD MESSAGE FORMAT (GSM)

The sequence number, unit name, and alarm function are echoed from the alarm establish request The establish code,
0x0300, identifies the alarm ACWNAK response (See other ACK/NAK messages for consistency)

Possible ACKLNAK codes are

0 - Success
+l - DCS on Gateway’s distribution list
Communication with 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

This message contains a list of parameter lists, where each parameter list defines information about a single alarm that
has changed state Alarm data messages are sent to any DCS that has been placed on the gateway’s distribution list for
alarm messages. It should be noted that these messages do not provide the current status of all alarms. Also, there is a
possibility that not all processor controllers will support all possible alarm parameters defined for the gateway
Information not relevant to a given unit will be missing

Alarm data messages are container messages that entail one or more alarms which have changed state.

Identified by a Record Type value of 0x8000, the messages below contain a list of parameter lists (denoted by “1) Each
parameter list (denoted by “2) corresponds to a single alarm that has changed state

Message
Offset Notes

0 Message Code

2 From Estab. Request

4 Unit Name
I
Reserved 5
I
0x8000 7 Record Type *l
1
<Sizel> 9 Size of Response
I
I
0x8300 11 First Alarm Info. *2

<Size
I 2> 13 Size of Alarm Info
I
I
First Alarm Information 15 Parameter List *3

15+Size2 *2

Parameter List *3

8
GEDS STANDARD MESSAGE FORMAT (GSM) GEI-100165

*2

Parameter List *3

Possible parameters (denoted by “3 above) are shown below:

Param ID = Point Name

Size of point name

The above parameter defines the short-Name of the alarm; it is not included if the gateway is incapable of translating the
alarm drop into its short-name form

The following parameter represents the time-tag associated with the alarm record

oxio40 Param ID = Time Tag


I
8 Parameter size

I) .. ;; . . 8 Byte Time-tag Alarm Queue Time

The parameter below identifies the alarm drop number

Param ID = Alarm Drop Num.

Parameter size
.--,,~~ Drop number

Bit 0 defines the current state of the alarm Bit 0 = 0 if the alarm is inactive (out of alarm) Bit 0 = 1 if the alarm is
active (in alarm) All other bits are reserved

r--
Param ID = Alarm State

Parameter size

Alarm State

For the parameter below (Alarm Lock State), bit 0 defines the current “lock” state of the alarm. Bit 0 = 0 if the alarm is
unlocked Bit 0 = 1 if the alarm is locked. All other bits are reserved.
GEI-100165 GEDS STANDARD MESSAGE FORMAT (GSM)

Param ID = Alarm Lock State

The parameter below is used for remote alarm queue management It defines why the alarm record is being sent.

Param ID = Reason Code

Parameter size
11 Reason Code

The following lists define reason codes

0x00 = Note used


0x01 = Alarm state just toggled
0x02 = Alarm just locked
0x03 = Alarm just unlocked
0x04 = Reserved
0x05 = This alarm just re-triggered (e g , diagnostic alarm)
Reset time-tag in alarm queue
0x06 = Reserved
0x07 = Alarm just acknowledged
0x08 = Alarm reset Remove alarm from alarm queue
0x09 = Alarm Dump Record
OxFE = End of Alarm Dump
OxFF = Clear Alarm Queue to prepare for alarm dump

All other values are reserved

The following parameter defines the long-name (text) associated with the alarm This information is not sent if it is not
requested in the alarm establish message Text size will be zero if the gateway cannot provide the associated text

Param ID = Long Name

Size of long name

The parameter below identifies the alarm record sequence number 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, the remote alarm queue is out-of-
sync with the unit’s alarm queue In this event, the DCS should request an alarm dump to re-synchronize (see alarm
commands defined later in this document).

Param ID = Alarm Seq. Num.

Parameter size

Alarm Sequence Number

10
GEDS STANDARD MESSAGE FORMAT (GSM) GEI-100165

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.

Param ID = Alarm ACK State

Parameter size

Alarm ACK State Value

The gateway will send the (Hint) parameter shown below if it cannot translate the alarm drop number into its short name
form Reception of this parameter indicates incomplete translation tables in the gateway.

OxlODO Param ID = Point ID Hint


I
2 Parameter size

I Point ID Hint Value

The following parameter defines the end of an individual parameter list.

c Param

Parameter
ID = End Of List

size

DIGITAL INPUT RECORD ESTABLISH REQUEST

This message requests the gateway to place/remove the DCS on/from the distribution list with regard to digital input
messages. The digital input messages defined below are container messages that are issued any time a digital input in the
unit changes state (if supported in the controller)

The gateway always responds to this request with an establish ACKLNAK message

The format of the digital input establish request is as follows

Message
Offset Notes

“Establish Function” has two defined values 0x0000 requests that the DCS be added to the digital input distribution list
for the specified unit; OxFFFF requests that the DCS be removed from the distribution list. All other values are reserved

11
GEI-100165 GEDS STANDARD MESSAGE FORMAT (GSM)

The “Options” parameter requests that additional information be included in digital input messages Bit 0 = 1 requests that
long-name descriptive text be included in any generated digital input messages, otherwise, the long-name text will be
omitted Bits l-15 are reserved and must be zero

Digital Input Record Establish ACK/NAK Response

The gateway responds to a digital input establish request with a generic establish ACK/NAK response (see below):

Message
Offset Notes

Estab. Status 9+n ACK/NAK Code

The Sequence Number, Controller Name and Establish Function are echoed in response to the digital input establish
request The establish code, 0x400, identifies a digital input ACK/NAK response

Possible ACK/NAK codes are

0 - Success
+l - DCS on Gateway’s distribution list
Communication with process controller is not currently possible

-1 - Unknown Controller Name


-2 - Function not supported by process controller
-3 - Gateway distribution Iist table is full
-4 - Malformed request

Digital Input Data Messages

Digital data messages are sent to any DCS which has been placed on the gateway’s distribution list for digital input
messages Digital input messages are container messages that accommodate one or more changed state inputs

This message contains a list of parameter lists where each parameter list defines information about a single digital input.
There is a possibility that certain digital input parameters defined for the gateway will not be supported by all units
Information not relevant to a given unit will be missing

Identified by a record type value of 0x8000, the message below contains a list of parameter lists (denoted by *l) Each
parameter list (denoted by “2) corresponds to a single digital input which has changed state.

12
GEDS STANDARD MESSAGE FORMAT (GSM) GEI-100165

Message
Offset Notes

,, , ,r;, Controller
/. ./
Name (ASCIIC)
I
<n>
0

4
Message

From

Unit
Estab.

Name
Code

Request

I
Reserved
I
0x8000
5+n
7+n Record Type *l

First Digital
I
I

I
<Sizel>

0x8400

<Size 2>
I
I
Input. Information
9+n
ll+n

13in

15+n
Size

First

Size

Parameter
of

Digin

of
Response

Digin

List
Info.

Info

*3
*2

15+Size2 +2

Parameter List *3

*2

Parameter List *3

Possible parameters (denoted by *3 above) are shown below:

Param ID = Point Name


Size of point name

The preceding parameter defines the short-name of the digital input. This parameter is not included if the gateways is
incapable of translating the digital input number into its short-name form

13
GEI-100165 GEDS STANDARD MESSAGE FORMAT (GSM)

The parameter below is the time-digital input changed state

Param ID = Time Tag

Parameter size

Alarm Queue Time


.. ..

For the parameter below, bit 0 defines the current state of the digital input All other bits are reserved

Param ID = Digin State

Parameter size
11 Digital Inpit State

The following parameter defines the long-name (text) associated with the digital input This 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.

I
ox;090 Param ID = Long Name

,..,+--sg+ Size of long name

The gateway will send the following 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.

OxlODO Param ID = Point ID Hint


I
2 Parameter size

Point ID Hint Value

The following parameter defines the end of an individual parameter list

Param ID = END OF LIST


Parameter size

Software Event Record Establish Request

This message requests the gateway to add/remove the DCS to/from the distribution list for software event messages.
Event messages defined below are container messages that are issued any time a logic variable in the unit changes state
(if supported in the unit controller) The logic variables to be software change detected are pre-defined in the unit The
number of events that are software change detected are limited

The gateway always responds to this request with an establish ACKLNAK message.

14
GEDS STANDARD MESSAGE FORMAT (GSM) GEI-100165

The format of the software generated event establish request is as follows

Message
Offset Notes

The “Establish Function” has two defined values. 0x0000 requests that the DCS be added to the event message
distribution list for the specified unit: OxFFFF requests that the DCS be removed from the distribution list. All other
values are reserved

When the “Options” parameter bit 0 = 1, the request specifies that long-name descriptive text should be included in any
generated digital input messages (otherwise long-name text will be omitted). Bits 1-15 are reserved and therefore must be
zero

Software Event record Establish ACK/NAK Response

The gateway responds to an event establish request with a generic establish ACK/NAK response

The format of the establish ACKINAK is as follows

Message
Offset Notes

Message Code

(Echoed)

Unit Name

Establish Code

(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, 0x0500, identifies the software event ACK/NAK response

15
GEI-100165 GEDS STANDARD MESSAGE FORMAT (GSM)

Possible ACKLNAK codes are

0 - Success
+l - DCS on Gateway’s distribution list
Communication with 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

Software Event Data Messages

Software event data messages are sent 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

An Event Data message contains a list of parameter lists, where each parameter list defines information about a single
logic variable. All units may not support all possible parameters Information not relevant to a given unit will be missing

Message
Offset Notes

0 Message Code

2 From Estab. Request

4 Unit Name
I
Reserved 5

I
0x8000

<Sizel>
7

9
Record

Size of
Type

Response
*l

!
I
0x8500 11 First Event Info. *2
I
<Size 2> 13 Size of Event Info
I
I
First Event Information 15 Parameter List *3

15+Size2 *2

Parameter List *3

*2

Parameter List *3

Identified by a record type value of 0x800, Software Event Data messages contain a list of parameter lists (denoted by *l
above) Each parameter list (denoted by *2 above) corresponds to a single logic value which has changed state Possible

16
GEDS STANDARD MESSAGE FORMAT (GSM) GEI-100165

parameters (denoted by *3 above) are shown below

Param ID = Point Name

Size of point name


, ,gi
..

This first parameter defines the short-name of the event. It will not be included if the gateway is incapable of translating
the event number into its short-name form.

Shown below is the time logic variable changed state

Param ID = Time Tag

Parameter size

Alarm Queue Time

Bit 0 defines the current state of the logic variable. All other bits are reserved

Param ID = Event State

Parameter size

Event State

The following parameter defines the long-name text associated with the event 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.

Param ID = Long Name

Size of long-name
,

The gateway will send the next parameter if it cannot translate the event number into its short-name form Reception of
this parameter indicates incomplete translation tables in the gateway.

Param ID = Point ID Hint

Parameter size

Point ID Hint Value

17
GEI-100165 GEDS STANDARD MESSAGE FORMAT (GSM)

The following parameter defines the end of an individual parameter list.

Param ID = END OF LIST

Parameter size

PERIODIC DATA MESSAGES

Periodic Data Request

The DCS can define lists of data to be returned on a periodic basis This type of data is typically used to maintain real-
time databases for display purposes. Using this method, any data point defined in the unit (that is also defined in the
gateway’s database) can be returned to the DCS. Multiple data lists may be defined by the DCS

The gateway will respond to a periodic data definition with a periodic data ACWNAK message.

The format of a periodic data list definition is shown below

Message
Offset Notes
I
0x0600 0 Message Code
1
Sequence Number

viAi$r Name (ASCIIC; <n> 1 Unit Name


.. I
Estab. Function 5+n
I
List Name 7+n
I
Period Code 9+n

0x1030 ll+n Pointname Param list

Second Point Name

~.,,
Last Point Name
. .

18
GEDS STANDARD MESSAGE FORMAT (GSM) GEI-100165

The “List Name” and “Controller Name” parameters together define 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 will supersede
the previous definition. The “List Name” parameter may be any value.

The “Establish Function” word has two defined values 0x0000 specifies that the data points in the request are to be
returned to the DCS according to the “Period Code;” OxFFFF requests cancellation of any previously defined list
corresponding to the List Name/Controller Name parameters

The “Period Code” word defines the number of seconds between data transmissions (it is ignored on list cancellation
requests) A period code with a value of zero requests that the data be transmitted only once

The Point Name parameter list is also ignored on list cancellations.

Periodic Data ACK/NAK Response

The gateway responds to a periodic data request with periodic data ACKINAK response.

The format of the periodic data ACWNAK response is as follows.

Message
Offset Notes

Message Code

(Echoed)

Unit Name
I
0x0600 5+n Establish Code
I
List Name 7+n (Echoed)
I
Estab. Function 9+n (Echoed)
!
I
Estab. Status ll+n ACK/NAK Code

The Sequence Number, Controller Name, List Name and Establish Function parameters are echoed from the periodic data
event establish request. The establish code, 0x600, identifies a periodic data ACWNAK response.

Possible ACK/NAK codes are

0 - Success
+l - DCS on Gateway’s distribution list
Communication with process controller is not currently possible
-1 - Unknown Controller Name
-2 - Function not supported by processor controller
-3 - Gateway distribution list table is full
-4 - Malformed request
-5 - Internal Gateway Error
-6 - All points requested are undefined
-7 - Too many data points defined in request

19
GEI-100165 GEDS STANDARD MESSAGE FORMAT (GSM)

Periodic Data Message

Periodic data messages are sent to the DCS following the transmission of the periodic data ACK/NAK message The rate
at which periodic messages are sent is defined in the periodic code of the establish request

Periodic messages consist of two parts: the first is a header that identifies which data list is contained in the message; the
second is a parameter list that contains a time-tag and a point value. The point value list is transmitted in the same order
as defined in the periodic data request If a requested point is undefined, the returned list entry will show a size of zero.
The format of the periodic data message is illustrated immediately below

Message
Offset Netes
I
0x0602 0 Message Code
I
Sequence Number 2 From Estab. Request

4 Unit Name
I
List Name 5 *1

7 PARAM = Time-tag

9 Size of Time-tag

11

19 PARAM = Point Value

21 Size of Point Value

23 First Data Value

PARAM = Point Value

PARAM = Point Value

"1 - The "List Name" is used by the DCS to determine which set of
data values are being returned if the DCS has defined multiple lists.

NOTE

If the gateway loses communications with the unit, periodic transmission of these messages will cease.
Message transmission will resume automatically when the gateway regains communication with the unit,

20
GEDS STANDARD MESSAGE FORMAT (GSM) GEI-100165

Alarm command Request

This message is used for remote control of the unit’s alarm queue The alarm command request can be used to
acknowledge, reset, lock/unlock alarms, or request an alarm dump Note that not all units will accept all alarm commands

The gateway always responds to this request with an alarm command ACK/NAK message.

The format of the alarm command request is as follows.

Message
Offset Netes

The “Options” word is specified to qualify the alarm command Available alarm command values and the option
meanings are shown below.

Alarm Command Value Alarm Command Function Options Meaning


2 Lock Single Alarm Alarm Drop Number
3 Unlock Single Alarm Alarm Drop Number
4 Acknowledge Alarms Number of alarms “1
6 Reset All Alarms <Ignored>
7 Acknowledge 1 Alarm Alarm Drop Number
8 Reset 1 Alarm Alarm Drop Number
10 Alarm Silence <Ignored>
255 Request Alarm Dump Include Alarm Text Flag *2

All other values for alarm commands are reserved.

*1 - A value of OxFFFF for options will acknowledge all alarms


*2 - Options bit 0 = 1 requests alarm dump include alarm text,
otherwise, the text is omitted Bits 1-15 are reserved

Alarm Command ACWNAK Response

The gateway responds to an alarm command request with an ACWNAK response

21
GEI-100165 GEDS STANDARD MESSAGE FORMAT (GSM)

The format of the alarm command ACK/NAK response is as follows.

Message
Offset. Notes

0 Message Code

2 (Echoed)

4 Unit Name

5+n (Echoed)

7+n (Echoed)

9+n ACK/NAK Code

The Sequence Number, Controller Name, Alarm Command and Options are echoed from the alarm command request.

Possible ACK/NAK codes are:

0 - Success
+l - DCS on Gateway’s distribution list
Communication with process controller is not currently possible
-1 - Unknown Controller Name
-2 - Function not supported by unit
-3 - Invalid Command
-4 - Malformed request
-5 - Internal Gateway Error

Alarm Dump Messages

Alarm dump messages are sent following the alarm command ACK/NAK message when an alarm dump is requested (this
supposes that the function is supported by the unit) AlaIm dump messages provide current status for all unit alarms. Due
to the potential size of the alarm queue information, this message may be broken up into several GSM messages (these
messages will however have the same alarm sequence number) The DCS can use the alarm sequence number to
synchronize its own alarm queue Note that the alarm sequence number in an alarm dump is the latest alarm sequence
number used in the unit.

A GSM alarm dump message contains a list of parameter lists where each parameter list defines information about a
single alarm Not all units support all possible parameters Information not relevant to a given unit will be missing.

22
GEDS STANDARD MESSAGE FORMAT (GSM) GEI-100165

Message
Offset Notes
I
0x0702 0 Message Code
I
Sequence Number 2 From Estab. Request

vini$r Name (ASCIIC; <nr 4 Unit Name


.. I
Reserved 5
I
0x8000 7 Record Type *l
I
<Size l> 9 Size of Response
I
0x8300 11 First Alarm Info. *2
I
<Size 2> 13 Size of Alarm Info
!
I
First Alarm Information 15 Parameter List *3

15+Size2 *2

<Size 3>

Parameter List *3

\
0x8300 *2
I
<Size n>

Last Alarm Information Parameter List *3


. . . //

Identified by a record type value of 0x8000, alarm dump messages contain a list of parameter lists (as denoted by *l
above) Each parameter list (denoted by *2 above) corresponds to a single alarm which is in the alarm queue If the alarm
queue is empty, there will be one parameter list containing only the End-of-List parameter

Possible parameters (denoted above by *3) are shown below

,,31
Param ID = Point Name

.. Size of Point

The above parameter defines the short-name of the alarm This parameter is not included if the gateway is incapable of
Name

translating the alarm drop into its short-name form

23
GEI-100165 GEDS STANDARD MESSAGE FORMAT (GSM)

The parameter below is the time-tag associated with the alarm record:

PARAM = Time-tag
Parameter Size

Alarm Queue Time

The following parameter identifies the alarm drop number

PARAM = Alarm Drop Number

Parameter size

Drop Number

For the parameter below, bit 0 defines the current state of the alarm. Bit 0 = 0 if the alarm is inactive (out of alarm) Bit
0 - 1 if the alarm is active (in alarm) All other bits are reserved

I
Param ID = Alarm State

Parameter size

Alarm State

For the Alarm Lock State parameter (see below), bit 0 defines the current lock sate of the alarm Bit 0 = 0 if alarm is not
locked Bit 0 = 1 if alarm is locked. All other bits are reserved

Param ID = Alarm Lock State

Parameter size

Alarm Lock State

The parameter below is used for remote alarm queue management It defines why the alarm record is being sent.

Param ID = Reason Code

Parameter size

11 Reason Code

The following lists defined reason codes

0x00 = Not used


0x01 = Alarm state just toggled
0x02 = Alarm just locked
0x03 = Alarm just unlocked
0x04 = Reserved
0x05 = This alarm just re-triggered (e g , diagnostic alarm)

24
GEDS STANDARD MESSAGE FORMAT (GSM) GEI-100165

Reset time-tag in alarm queue


0x06 = Reserved
0x07 = Alarm just acknowledged
0x08 = Alarm reset Remove alarm from alarm queue
0x09 = Alarm Dump Record
OxFE = End of Alarm Dump
OxFF = Clear Alarm Queue to prepare for alarm dump

All other values are reserved

The parameter shown below defines the long-name (text) associated with the alarm This information is not sent if it is
not requested in the dump request message. Text size will be zero if the gateway cannot provide the associated text.

Param ID = Long Name

Size of Long Name

For the following parameter, 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

Param ID = Alarm ACK State

I Parameter

Alarm
size

ACK State Value

The gateway will send the following 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:

Param ID = Point ID Hint

Parameter size

Point ID Hint Value

The following parameter defines the end of the individual parameter list

Param ID = END OF LIST

Parameter size

Process Control Command Requests

Process control messages fall into two categories the first consists of “Push-button” commands (i e., Start/Stop,
Raise/Lower, etc ); the second entails “Setpoint Target” commands (i e , Speed target/Load Target, etc ) Both of these

25
GEI-100165 GEDS STANDARD MESSAGE FORMAT (GSM)

The gateway will respond to a process control command request by a control request ACWNAK response message

The format of the process control command is as follows:

Message
Offset Notes
I
0x0800 0 Message Code

Sequence Number 2

4 Unit Name

5+n Command Name

6+n+m

8+n+m

lO+n+m

The format of a “Push Button” command parameter is as follows:

6+n+m PARAM = END OF LIST

8+n+m Value not required

The format of a “Setpoint Target” command parameter is shown below

Process Control Command ACK/NAK Response

The gateway responds to a process control command request with a command request ACK/NAK response

The format of the process control command request ACK/NAK response is shown below:

Message
Offset Notes
I
0x0801 0 Message Code
I
Sequence Number 2 (Echoed)
I
Name (ASCIIC) <n> 4 Unit Name
I
Name (ASCIIC) cm> 5+n (Echoed)
I
Command Status 6+n+m

26
GEDS STANDARD MESSAGE FORMAT (GSM) GEI-100165

The Sequence Number, Controller Name and Process Command Name are echoed in response to the process control
command request.

Possible ACWNAK codes are

0 - Success Requested commands sent to unit


+l - Request received by gateway, however, communication with process controller is not currently possible

-1 - Unknown Controller Name


-2 - Function not supported by process controller
-3 - Invalid process command name.
-4 - Invalid parameter (i e , Value for “Push Button,” or no value for a setpoint target
-5 - Internal Gateway error

27
GEI-100165 GEDS STANDARD MESSAGE FORMAT (GSM)

MESSAGE CODE SUMMARY

Message Message type Sent By


@c&
0x0100 Supported Unit Request DCS
0x0101 Supported Unit 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 Est. Request DCS


0x0402 Digital Input Data Message Gateway

0x0500 Software Event Est. Request DCS


0x0502 Software Event Data Message Gateway

0x600 Periodic Data Definition DCS


0x601 Periodic Data ACK/NAK Gateway
0x602 Periodic Data Message Gateway

0x700 Alarm Command Request DCS


0x701 Alarm Command ACWNAK Gateway
0x702 Alarm Dump Data Message Gateway

0x800 Process Control Command Request DCS


0x801 Process Control ACWNAK Response Gateway

NOTE

Any message received by the gateway that does not have a “sent by DCS” message code (as defined
above) is treated as an echo request. As such, the gateway simply echoes the request to the DCS unaltered.

28
GEDS STANDARD MESSAGE FORMAT (GSM) GEI-100165

RECORD/PARAMETER IDENTIFICATION SUMMARY

Record ID Record Type


0x8000 List of sub-records
0x8100 Unit Information parameter
0x8300 Alarm Information parameter list
0x8400 Digital Input Information parameter list
0x8500 Software Event Information parameter list

Param ID Parameter Type


0x0000 End of parameter list
0x1000 Process controller name
0x1010 Number of active communication links to unit
0x1020 Process controller type
0x1030 Point name (short name)
ox 1040 Time-tag
0x1050 Alarm drop number
0x1060 Point value
0x1070 Alarm locked state
0x1080 Alarm reason code
0x1090 Point text (long name)
OxlOAO Alarm sequence number
OxlOBO Process control setpoint value
oxloco Alarm ACKnowledge state
OxlODO Point Identifier Hint

29
GEI-100165 GEDS STANDARD MESSAGE FORMAT (GSM)

GE Drive Systems

GeneralElectricCompany
1501RoanokeBoulevard
Salem,Virginia24 153

llssue Date: June 1994

You might also like