Manual

ManualsBrandsNordson ASYMTEK ManualsSoftwareSECS-GEM for Fluidmove for Windows NT

1/00

The part number for this manual is 78-0019-00, Revision B

Or 78-0019-002, Revision B for the CD version.

To reorder this manual, please contact Asymtek, 1-760-431-1919.

Summary of content (212 pages)

PAGE 1
The part number for this manual is 78-0019-00, Revision B Or 78-0019-002, Revision B for the CD version. To reorder this manual, please contact Asymtek, 1-760-431-1919.
PAGE 2
PAGE 3
SECS/GEM Interface Option for Fluidmove for Windows NT Reference Manual P/N 76-0022-00, Revision A 1/00
PAGE 4
NOTICE This document describes preliminary information for the GES-1993 SECS interface, and it is subject to change without notice. Asymtek acknowledges that this document is derived from the GW Associates SECS/GEM Interface document. Asymtek owns the right to modify and distribute that document to support the Millennium line of dispensing machines. All information contained in or disclosed by this document is considered proprietary by Asymtek.
PAGE 5
TABLE OF CONTENTS 1. Introduction................................................................... 1-1 1.1 SECS Standard .......................................................... 1-2 1.1.1 SECS-I Clarifications ............................................... 1-2 1.1.2 Physical Connection ................................................ 1-3 1.1.3 SECS-I Blocks Transmitted ..................................... 1-3 1.1.4 SECS-I Blocks Received ......................................... 1-4 1.1.
PAGE 6
2. Message Summary ...................................................... 2-1 2.1 Host to Equipment...................................................... 2-1 2.2 Equipment to Host...................................................... 2-3 3. Operating Characteristics............................................. 3-1 3.1 Communications States ............................................. 3-1 3.1.1 Communications Finite State Description ............... 3-2 3.1.1.1 State Transitions ............................
PAGE 7
3.4.10 Related Variables .................................................. 3-27 3.4.11 Related Events ...................................................... 3-27 3.5 Alarm Management .................................................... 3-28 3.5.1 Alarm States ............................................................ 3-28 3.5.2 Reporting ................................................................. 3-28 3.5.3 Enable/Disable ........................................................ 3-29 3.5.
PAGE 8
4.5 S1F3 - Selected Status Request ................................ 4-4 4.6 S1F4 - Selected Status Data...................................... 4-5 4.7 S1F11 - Status Variable Namelist Request................ 4-5 4.8 S1F12 - Status Variable Namelist Reply .................... 4-6 4.9 S1F13 - Connect Request.......................................... 4-6 4.10 S1F14 - Connect Request Acknowledge ................. 4-7 4.11 S1F15 - Request Off-Line ........................................ 4-7 4.
PAGE 9
4.48 S2F48 - Variable Limit Attributes Send .................... 4-37 4.49 S5F1 - Alarm Report................................................. 4-38 4.50 S5F2 - Alarm Acknowledge ...................................... 4-39 4.51 S5F3 - Enable/Disable Alarm Send.......................... 4-39 4.52 S5F4 - Enable/Disable Alarm Acknowledge............. 4-40 4.53 S5F5 - List Alarms Request...................................... 4-40 4.54 S5F6 - List Alarm Data ............................................. 4-41 4.
PAGE 10
4.91 S7F19 - Process Program Directory Request .......... 4-64 4.92 S7F20 - Process Program Directory ........................ 4-64 4.93 S9F1 - Unrecognized Device ID............................... 4-64 4.94 S9F3 - Unrecognized Stream................................... 4-64 4.95 S9F5 - Unrecognized Function................................. 4-64 4.96 S9F7 Invalid Data..................................................... 4-65 4.97 S9F9 Transaction Timer Timeout............................. 4-65 4.
PAGE 11
5.3.4 Alarm Report (GEM, Ver 3.1 Compatibility)............. 5-11 5.3.5 Alarm Report (GEM, Ver 1.7 Compatibility)............. 5-11 5.4 Control State............................................................... 5-12 5.4.1 Host Sends On-Line Command............................... 5-12 5.4.2 Host Sends Off-Line Command............................... 5-12 5.4.3 Host Sends Remote Command............................... 5-13 5.4.4 Equipment Rejects Host Command ........................ 5-13 5.4.
PAGE 12
Table of Figures Figure 3-1 Communication Finite State Diagram ........................... 3-3 Figure 3-2 Equipment Control State Diagram ................................ 3-8 Figure 3-3 E10 State Diagram........................................................ 3-15 Figure 3-4 GES Equipment Process States ................................... 3-18 Figure 3-5 Limits Events Signaling ................................................. 3-24 Figure 3-6 Limits State Diagram.............................................
PAGE 13
Table 3-18 Material Movement Variables........................................3-42 Table 3-19 Spooling Activity ............................................................3-44 Table 3-20 Spooling State Transitions ............................................3-47 Table 3-21 Spooling Variables ........................................................3-49 Table 3-22 Spooling CEIDS.............................................................3-49 Table 4-1 On-Line Acknowledge ....................................
PAGE 14
Table 5-1 SECS Messages Equipment Establishes Communications ............................................................................... 5-1 Table 5-2 SECS Messages Host Establishes Communications ..... 5-2 Table 5-3 SECS Messages Simultaneous Establish Communications ............................................................................... 5-2 Table 5-4 SECS Messages Losing Connection, Re-Connecting.... 5-3 Table 5-5 SECS Messages Heartbeat ............................................
PAGE 15
Table 5-34 SECS Messages Unformatted, Host-Initiated Download ..........................................................................................5-15 Table 5-35 SECS Messages Unformatted, Host-Initiated Upload ..5-15 Table 5-36 SECS Messages Unformatted, Equipment-Initiated Download ..........................................................................................5-16 Table 5-37 SECS Messages Unformatted, Equipment-Initiated Upload..............................................................
PAGE 16
PAGE 17
1. Introduction This document describes the SECS interface provided on the GES-1993. This document is a modification of the GW Associates GES-1993 SECS/GEM Interface document. It has been especially prepared in support for Fluidmove for Windows NT (FmNT). The content and structure of this document follows the original [RefGWGEM] document. User information and GEM interface with FmNT were added. FmNT supports the GW Associates GEM subset of the SECS communication standard.
PAGE 18
1.1 SECS Standard The SEMI Equipment Communication Standard (SECS) is published by Semiconductor Equipment and Materials International (SEMI). It defines a computer to computer communications interface between a unit of factory Equipment and a Host Computer. This Equipment complies to the complete SECS-I standard (excluding the physical RS-232 hardware connection) and to the generic portions of the SECS-II standard. The equipment implements an appropriate subset of the SECS-II standard messages.
PAGE 19
1.1.2 Physical Connection The GEM hardware interface must be a TCP/IP network card connection through a Ten-Base-T connector or BNC jack (SECS-II interface). The following documentation is provided only as a reference for RS-232 connections (SECS-I interface) and is currently not implemented by FmNT. The RS-232 connector on the Equipment deviates from the standard SECS-I DB25F connector. The GES-1993 provides a male 25-pin RS-232 "DB25M" connector on its backpanel as the SECS port.
PAGE 20
1.1.4 SECS-I Blocks Received Blocks received by the Equipment should be formatted as described above (except with the R-bit set to "0"), although the rules are more relaxed:  If a message consists of a single block, the Block Number may be zero (0x0000) or one (0x0001).  The Equipment is indifferent to the R-bit setting. 1.1.5 Interleaved Blocks The GES-1993 never sends interleaved blocks to the Host.
PAGE 21
1.2 SECS-II Clarifications The GES-1993 uses the following SECS-II conventions: 1.2.1 Data Format Types Where the Standards permit a choice of data item types, the choice has been made as described in section "Message Detail". For outgoing messages, the Equipment always sends Data Items of the exact format shown. For some incoming messages, the Equipment "forgives" minor host errors. For example, the Equipment may accept a U1 Data Item where a U2 format was expected.
PAGE 22
1.2.5 Function Zero The Equipment sends a Reply Message using Function zero (F0) according to the requirements of the GEM Control State. Wherever this Equipment expects a Reply message from the Host, the Host can send F0. The Equipment will instantly abort the outstanding transaction. The Equipment will not take any additional action.
PAGE 23
1.3 GEM Standard The SEMI Generic Equipment Model for Effective Factory Automation (GEM) is another document published by SEMI. The GEM standard defines some useful conventions for designing the communications interface on a unit of factory Equipment to improve operations with a Host Computer. The GES-1993 complies to the following GEM document:  E30-1993 1.4 GEM Compliance This section clarifies which GEM functions are implemented in this Equipment. See "GEM Compliance Statement" on page 7.
PAGE 24
Table 1-2 FUNDAMENTAL GEM REQUIREMENTS GEM Compliance Statement IMPLEMENTED COMPLIANT State Models Yes No Yes No Equipment Processing States Yes No Yes No S1,F13/F14 Auto Connection Scenario Yes No Yes No Event Notification Yes No Yes No On-line Identification Yes No Yes No Error Messages Yes No Yes No Control (Operator Initiated) Yes No Yes No Documentation Yes No Yes No IMPLEMENTED COMPLIANT Establish Communicatio
PAGE 25
1.5 SEMI E10 Standard The SEMI E10 Standard is another document published by SEMI. It provides a guideline for definition and measurement of equipment reliability, availability, and maintainability (RAM). This document defines six basic Equipment States which define how equipment time is categorized. The SECS Interface on the GES-1993 will reflect the current E10 state.
PAGE 26
1.6.1 SECS-I Parameters This section provides hardware settings that apply only to the RS-232 hardware interface. NOTE FmNT currently does NOT support this interface. Table 1-3 SECS Installation Parameters Parameter Default Description Device ID 1 Baud Rate 9600 Allowable speeds are 110, 150, 300, 600, 1200, 2400, 4800, 9600, and 19200 Baud. T1 0.5 Sec Inter-character timeout. Range allowed is 0.1 to 10.0 seconds, at increments of 0.1 seconds. T2 10.0 Sec Protocol timeout.
PAGE 27
1. Equipment Constant "CONFIGALARMS" (VID 18) selects the message the Equipment will send for Alarm Reports. "ConfigAlarms" may be 0, 1, or 2, selection S5F1, S5F71, or S5F73, respectively. 2. Equipment Constant "CONFIGCONNECT" (VID 19) selects the message the Equipment will send for Connect Request. "ConfigConnect" may be 0, 1, or 2, selecting S1F1, S1F65, or S1F13, respectively. 3. Equipment Constant "CONFIGEVENTS" (VID 20) selects which message the Equipment will send for Event Reports.
PAGE 28
The following table shows the recommended settings for compatibility with various types of Hosts. Factory (Default) settings are shown in bold. Table 1-5 1-12 Compatibility Settings Equipment Constant E30-93 GEM 3.1 GEM 3.0 GEM 2.0 GEM 1.
PAGE 29
1.7 Terminology The following terms are used throughout the document to refer to the various entities interfacing with the GES-1993: Table 1-6 Equipment Terminology The GES-1993. Operator The person who physically has access to the equipment's material port(s) and control panel. This is the person who is operating the GES-1993.
PAGE 30
The following are the major characteristics of this notation as it is used in this document: 1-14 A. Each state is represented by a rectangle with rounded corners. B. A collection of sub-states may be grouped into a super-state. C. The entity described by the diagrams will be in one and only one of the substates at all times. D. Variables representing the current state of an entity do not contain values for super-states, only the lowest sub-state is represented. E.
PAGE 31
1.9 Machine Operation and the GEM Interface 1.9.1 Connecting to the Host FmNT loads the GEM communications driver immediately upon startup. Once connection to the driver is established, the device enters its default communication state as set by the operator. This default state can be set via the GEM property page. The recommended selection is “Enabled”.
PAGE 32
1.9.3 Clock The Host updates the GEM TIME structure periodically using the Date and Time Send message (S2F31 ). FmNT will update its system clock to reflect the data presented by the Host. Current values of the system time are used extensively in event logging and will be required to synchronize with comparable events logged by the Host. 1.9.4 Loss of Communications Link: Spooling Communications may be temporarily lost with the Host from time to time.
PAGE 33
The operator will need to correct the alarm condition and guide the machine through the Paused state to the Idle State. When the machine is prepared to enter the Running state again, the operator can open the GEM control screen and send the Proceed event message to the Host to resume REMOTE operations. The Host may poll the Equipment to receive lists of enabled or existing alarms. When the Host sends a List Alarm Data message (S5F6) the Equipment replies with a list of the current active alarms.
PAGE 34
PAUSE This command is successful when the Control State is OnLine - REMOTE and the Process State is Running. It causes a halt in dispensing following completion of the current instruction. The board and the process program are retained without change. The Process State changes to Paused. Diagnostics and status checks may be performed at this time. The substrate processing may be continued in the Running State by delivering the RESUME command.
PAGE 35
1.9.6.4 Terminal Message Notification After a terminal message has been received from the host, the GEM status bar will start blinking. GEM status bar is displayed in the lower part of the screen and displays the current communication, control, and spooling state. If the user has selected the beeping option (through GEM property page/Setup page) a 1/2 second interval beep is also provided to catch the user’s attention.
PAGE 36
DISABLED: FmNT will not attempt to establish communication link upon startup. ENABLED is recommended for this option. 1.9.7.3.3 Default Control State This option allows the user define the default control state upon FmNT’s startup. The valid choices are: OFFLINE/ATTEMPT ONLINE, OFFLINE/EQUIPMENT OFFLINE, OFFLINE/HOST OFFLINE, ONLINE/LOCAL, ONLINE/REMOTE ONLINE/REMOTE is recommended for this option. Refer to Control State section for description of these states. 1.9.7.3.
PAGE 37
2. Message Summary Another entry has been added to the Notes column of the following indicating FmNT application involvement. See [RefGWGEMUser] Table 14 and Table 15 Host/Equipment Primary Messages. Key for Notes Column: * First line indicates FmNT application requirements. * E = GEM extensions. * N = non-GEM or older GEM compatibility 2.1 Host to Equipment This section describes primary SECS messages sent by the Host, and the associated reply messages from the Equipment.
PAGE 38
In the column headed "Notes", those messages marked with "E" are extensions beyond GEM. Those messages marked with "N" are provided for non-GEM or older GEM compatibility.
PAGE 39
Primary Reply CState Description S6F19 S6F20 4,5 Request Report S6F21 S6F22 4,5 Request Annotated Report S6F23 S6F24 4,5 Request Spooled Data S7F1 S7F2 4,5 Process Program Inquire/Grant S7F3 S7F4 4,5 Unformatted Process Program Send S7F5 S7F6 4,5 Unformatted Process Program Request S7F17 S7F18 4,5 Process Program Delete S7F19 S7F20 4,5 Process Program Directory S10F3 S10F4 4,5 Terminal Display, Single S10F5 S10F6 4,5 Terminal Display, Multiple S10F9 S10F10 4,5
PAGE 40
2-4 Primary Reply Description S6F1 S6F2 Trace Data Send S6F3 S6F4 Annotated Event Report Send S6F5 S6F6 Multi-Block Data Send Inquire/Grant S6F9 S6F10 Event Report Send S6F11 S6F12 Event Report Send S6F13 S6F14 Annotated Event Report Send S7F1 S7F2 Process Program Inquire/Grant S7F3 S7F4 Unformatted Process Program Send S7F5 S7F6 Unformatted Process Program Request S9F1 -- Error, Device ID S9F3 -- Error, Stream S9F5 -- Error, Function S9F7 -- Error, Data S9F9 --
PAGE 41
3. Operating Characteristics This section describes the working characteristics of the GES-1993. It is divided into sections, and each of these sections describes a particular aspect of the GES1993's operating characteristics. 3.1 Communications States The GES-1993 represents the current state of its SECS link using a Communication Finite State Machine diagram. The purpose is to make clear how this link is initiated and terminated.
PAGE 42
3.1.1 Communications Finite State Description The diagram on the following page explains the Communications Finite State Machine that the GES-1993 maintains.
PAGE 43
Figure 3-1 Communication Finite State Diagram Communications State Diagram 1. Disabled C 2. 3. Enabled 4. Not Communicating 5. 6.
PAGE 44
3.1.1.1 State Transitions The following transitions can occur. Transitions of the Communication Finite State Machine diagram do not cause the GES-1993 to signal any Collection Event ID (CEID), nor to send Event Reports to the Host. Table 3-1 State Transitions # From Trigger To 1 Unknown Power-Up Conditional Equipment will initialize itself to either the Disabled or Enabled state, depending on the configuration of the EC INITCOMMSTATE (VID 7). 2 Disabled Operator enables SECS link.
PAGE 45
3.1.1.2 Communications States The current Communication State will be one of the following values. There is no Variable indicating the Communication State. The communication State is presented to the Operator on the main Operator Interface screen. 3.1.1.2.1 DISABLED The SECS link to the Host is disabled at the GES-1993. The Equipment will send no messages to the Host. The Equipment will not respond to a Host-initiated ENQ. 3.1.1.2.
PAGE 46
The Host can also attempt to establish communications by sending S1F13. The Equipment will accept the message and respond with S1F14 and the Communication State will change to COMMUNICATING. In ENABLED state, the GES-1993 will accept messages from the Host, but will ignore any messages except S1F13 and S1F14. The GES-1993 will respond to the S1F13 while the Communication State is ENABLED or COMMUNICATING, but it will not send S1F13 once communications have been established. 3.1.
PAGE 47
Table 3-3 Value Control States State 1 Off-Line/Equipment Off-Line 2 Off-Line/Attempt On-Line 3 Off-Line/Host Off-Line 4 On-Line/Local 5 On-Line/Remote GWGEM SW maintains the GEM Control State finite state machine ([RefGWGEMUser] p. 93 Remote Control). FmNT is responsible for the following ([ RefGWGEMUser] p 99 ‘Other Control State Considerations’):  Providing a Process Control State Change extension routine ([RefGWGEMRef] NoteControlState).  GUI display of the current State.
PAGE 48
Figure 3-2 Equipment Control State Diagram Equipment Control States Off-Line 14. 1. 2. C Equipment Off-Line C 3. 5. 7. C 4. 6. Attempt On-Line Host Off-Line 10. 9. 8. On-Line C Local 3-8 12. 13. 11.
PAGE 49
3.2.1.1 Control State Transitions Certain state transitions will cause a collection event to be signaled. If the event is enabled, this event will be sent to the Host along with the appropriate reports if appropriate. This table lists the state transitions and notes when events will be sent to the Host. Table 3-4 # From 1 Unknown Power-Up Conditional This transition is made to either the Off-Line or On-Line state, depending on the EC INITCONTROLSTATE (VID 8).
PAGE 50
# From 10 Host Off-Line Successful completion of S1F17 / S1F18 transaction, with ONLACK = 0x00. On-Line The Equipment is now On-Line. 11 Unknown Entry into On-Line super-state. Conditional (Local or Remote) EVENT: GemControlStateLOCAL (CEID 4) or GemControlStateREMOTE (CEID 5). The GES-1993 will transition to whichever state is specified in the EC ONLINE- SUBSTATE (VID 51). 12 Local Operator or Host requests to go Remote. Remote EVENT: GemControlStateREMOTE (CEID 5).
PAGE 51
3.2.1.2 Control States The variable CONTROLSTATE (VID 4) represents the current control state, and will be one of the following values: 3.2.1.2.1 Off-Line/EQUIPMENT OFF-LINE The Operator has put the GES-1993 Off-Line. In this state, the Host may not put the Equipment On-Line, only the operator can attempt this from this state. Any Hostinitiated primary message (except S1F13 and S1F17) will be replied to with an SnF0 ABORT message by the Equipment.
PAGE 52
3.2.1.2.5 On-Line/REMOTE The remote Host Computer has control of the GES-1993 using S2F41 (Remote Command). For details see "Remote Commands” section. The Operator may issue the PAUSE, STOP, and ABORT commands while in Remote. These commands will generate an OperatorCommand event (CEID 4) as well as other messages attached to these activities. Refer to appendix B for further detail. 3.2.
PAGE 53
3.2.3 Related Variables The following table lists the variables (SV's, EC's, or DVVALS) which are relevant to the Control State. For a more complete description of these variables, see "Appendix A -- Data Dictionary Variables". Table 3-5 Control State Variables Variable Name VID INITCONTROLSTATE 9 OFFLINESUBSTATE 42 ONLINEFAILED 43 ONLINESUBSTATE 44 CONTROLSTATE 28 PREVIOUSCONTROLSTATE 35 3.2.
PAGE 54
See the Process State Diagram for a description of FmNT processing state model. FmNT controls Process State machine changes in response to either operator or Host command inputs. Change of Control State from Local to Remote or vice versa is only allowed in the Idle Process State. This prevents loss of command synchronization. The Host may command Start, Stop, Pause, Resume, Local, Remote, and Abort. The operator may command Start, Stop, Pause, Resume, Local, Remote, and Abort. 3.3.
PAGE 55
Figure 3-3 E10 State Diagram E10 State Diagram 3. Non-Productive 1. C 2. NonScheduled Time Unscheduled Downtime Scheduled Downtime Engineering Standby 4. 5.
PAGE 56
3.3.1.1 E10 STATE TRANSITIONS Table 3-7 E10 State Transitions # From Trigger To Description 1 Unknown Power-Up NonScheduled Time Upon Power-Up, the Equipment defaults to this state. 2 Unknown Operator Request Conditional The Operator changes states from the previous state to the new state. The conditional depends on the Operator's intentions. 3 NonProductive Operator Request NonProductive 4 Standby Processing of material begins. Productive Equipment is processing material.
PAGE 57
3.3.1.2.4 Non-Productive/Engineering The Equipment may be actively running boards, but these are not intended to be used in normal production. This state signifies that Engineering data is being gathered from the Equipment separate from an actual productive run. 3.3.1.2.5 Non-Productive/Standby The Equipment is ready for production, but is awaiting resources. These resources may be in the form of physical material (boards) or in the form of information (process program, and START command). 3.3.1.2.
PAGE 58
Figure 3-4 GES Equipment Process States 1 Idle (1) 7 2 5 Error (5) 10 9 Active 6 Aborting (4) 3-18 8 Running (2) 3 4 Paused (3) Operating Characteristics
PAGE 59
3.3.3 GES Process State Transitions Table 3-8 # From 1 Unknown 2 Idle 3 Process State Transitions Trigger To Description Power-Up Idle At power-up, the Equipment defaults to the IDLE state. Run Command Running Either the Host or Operator issues a run command. This command can be issued by a remote command from the Host or by local Operator. Running Pause Command Paused Either the Host or Operator issues a pause command.
PAGE 60
3.3.4 GES Process States 3.3.4.1 Idle The Equipment is initialized to this state. This state indicates that the Equipment is not dispensing on a board nor is it waiting for a board to arrive at the dispense station. 3.3.4.2 Active 3.3.4.2.1 Running While in this state, the Equipment is either currently waiting for a board to arrive at the dispense station, processing a board, or unloading a processed board out of the dispense station. 3.3.4.2.
PAGE 61
3.3.6 Related Collection Events Many of the GES-1993's collection events relate to process state changes. For a complete listing of these, see "Appendix B -- Collection Events". 3.4 Data Collection Note the three types of variables: Status Variable (SV), Data Variable (DV), and Equipment Constants (EC). The Host sets only ECs. DVs are time stamped by being associated with Collection Events Ids (CEID), and will be reported by FmNT in Event Reports ([RefGWGEMUser] p 77 ‘Data Collection’).
PAGE 62
3.4.3 Host Requests Status The Host can send S1F3 when the Equipment is On-Line to read Equipment Constants from the GES-1993. The Host can send S2F13 when the Equipment is On-Line to read Equipment Constants from the GES-1993. For this Equipment, S1F3 and S2F13 with a list of VIDs are essentially the same. That is, either message can return Variables of any type. However, S1F3 with a zero-length list will return only VIDs of type SV, and S2F13 with a zero-length list will return only VIDs of type EC. 3.4.
PAGE 63
S6F21 ID. Host requests an Annotated Event Report associated with a Report GWGEM automatically processes Event Report related messages. FmNT indicates to GWGEM that an event has occurred, using GemNoteEvent. GWGEM handles Event Reports, and may invoke FmNT Variable access functions ([RefGWGEMUser] p 85 ‘Event Reporting’). The GEM configuration file maintains the name of the event report file in the GemReportFileName Equipment Constant. 3.4.
PAGE 64
GWGEM automatically handles Limits Monitoring. Configuration data ( limits, CEIDs, etc. ) must be set in the GCD file ( [ RefGWGEMUser ] ) p 165 ‘Limits Monitoring’ ). 3.4.7.1 Event Signaling For any event that exists on the equipment, the event message will be sent to the Host only if the reporting for that particular event has been enabled. In this "EVENT SIGNALING" section, assume that the Host has enabled the proper reporting so that these events will be sent to the Host.
PAGE 65
Figure 3-6 Limits State Diagram Limits States Disabled 2. 1. Enabled C Below Limit 5. Operating Characteristics 3. 4. No Zone Above Limit 6.
PAGE 66
3.4.8 Limits State Transitions Table 3-10 Trigger Limits State Transitions # From To Description 1 Enabled Host undefines limits attributes. Disabled Host sends S2F45 to undefine limits. 2 Disabled Host defines limits. Conditional Host sends S2F45 to define limits. 3 Below Limit Variable changes to greater than or equal to UPPERDB. Above Limit Limit transition event is signaled to Host if enabled. 4 Above Limit Variable changes to less than or equal to LOWERDB.
PAGE 67
3.4.8.1.4 Below Limit The value of the variable is less than or equal to LOWERDB. 3.4.8.1.5 Above Limit The value of the variable is greater than or equal to UPPERDB. 3.4.9 Disk Files The GES-1993 maintains a disk file which contains the current Equipment Constant settings. The file is updated each time the Operator or Host changes an Equipment Constant. The most recent settings for some of the Equipment Constants are read from the file when the Equipment is powered-on.
PAGE 68
3.5 Alarm Management The GES-1993 has a fixed set of alarm conditions which can occur. Each alarm is identified by a unique Alarm ID (ALID), and has an associated severity code (ALCD) and alarm text (ALTX). The possible alarms are shown in "Appendix C -Alarms". GWGEM automatically handles Alarm management. FmNT configures Alarms in the GCD file, and signals alarm state changes using GemNoteAlarmEvent ([ RefGWGEMUser ] p 89 ‘Alarm Management’). FmNT supports all alarms defined in Appendix C.
PAGE 69
3.5.3 Enable/Disable The Host can use S5F3 (Enable/Disable Alarms) to control which alarms the GES1993 should report. Using S5F3, the Host can specify for each ALID whether the Equipment should report that alarm when it occurs. When an alarm transition occurs, if that ALID is enabled the Equipment will send an alarm report message to the Host. If the ALID is disabled, the Equipment will not send the alarm message. The Host can use S2F37 to enable or disable the CEIDs associated with these alarm transitions.
PAGE 70
3.5.6 Related Variables The following table lists the variables (SV's, EC's, or DVVALS) which are relevant to alarm management. For a more complete description of these variables, see "Appendix A -- Data Dictionary Variables". Table 3-13 Alarm Management Variables Variable Name VID CONFIGALARMS 1 WBITS5 19 ALARMID 22 ALARMSENABLED 23 ALARMSSET 24 ALARMSTATE 25 ALARMSERIAL 26 3.5.
PAGE 71
3.6 Process Program Management Processing on the GES-1993 is controlled by Process Programs. The Equipment requires selection of a Process Program for each process. The GES-1993 supports the use of unformatted process programs. See [RefGWGEMUser]] p 111 ‘Process Program Management’). FmNT uses proprietary ASCII and binary image files to define process programs (recipes). GWGEM only supports Unformatted Process Programs. FmNT uses its own Process Program management vs the GWGEM’s librarian. 3.6.
PAGE 72
The Host can download a Process Program to the GES-1993 library by using S7F3 (Process Program Send). The Host may send S7F1 (Multi-block Inquire) to the equipment before sending a multi-block Process Program. The equipment operator can also initiate a Process Program Download through the GES-1993's user interface. The Host can delete one or more Process Programs from the GES-1993 library by using S7F17 (Process Program Delete).
PAGE 73
3.6.4 Related Events The following lists the collection events (CEIDs) which are relevant to process program management. For a more complete description of these events, see "Appendix B -- Collection Events" or the description in this chapter.
PAGE 74
3.7 Remote Commands Setup and processing at the GES-1993 can be guided by either a local operator or by a Host computer. This section describes the remote commands available to the Host. Much of the behavior of the GES-1993 and its acceptance of remote commands is directed by requirements of the Control State. For a complete description of the Control State, please see section "Control States". The GES-1993 will accept remote commands only when the Control State is Remote.
PAGE 75
3.7.1 S2F41 Commands The general format for remote commands using the S2F41 message is: S2F41 [W] > ... > > . * H->E * Remote command string * Command Parameter Name * Command Parameter Value The following commands may be sent by the Host to the GES-1993. START This command starts processing on the GES-1993 assuming all proper initialization has taken place and material is present. S2F41 [W] > .
PAGE 76
PAUSE The PAUSE command will cause the GES-1993 to complete the processing of boards currently in process, but not to start any new boards until the RESUME command has been given. S2F41 [W] > . RESUME After a PAUSE command has been given, the RESUME command will continue to process new boards according to the recipe. S2F41 [W] > . LOCAL While the Equipment is in Remote state, the Host can put the GES-1993 into Local state by sending the LOCAL command.
PAGE 77
ABORT The Host can abort processing at the next safe stopping point by sending the ABORT command with the AbortLevel parameter as follows. S2F41 [W] > > > .
PAGE 78
3.7.2 Related Variables The following table lists the variables (SV's, EC's, or DVVALS) which are relevant to remote control. For a more complete description of these variables, see "Appendix A -- Variables". Table 3-16 Remote Control Variable Variable Name VID ABORTLEVEL 21 PREVIOUSCOMMAND 34 3.7.3 Related Events The following lists the collection events (CEIDs) which are relevant to remote control.
PAGE 79
3.8 Material Movement Material movement on the GES-1993 consists of three board holding areas: 1) The pre-processing area; 2) the post-processing area; and 3) the dispensing area. In order for processing to begin, a board must arrive from the upstream machine on the pre-processing area. The GES-1993 then takes boards pre-processing area, sends them to the dispensing area, processes them and then places them in the postprocessing area.
PAGE 80
The message text will be displayed on the Equipment's CRT. Collection Event S10Ack (CEID 21) occurs once the operator has acknowledged the message and an Event Report will be sent to the Host (if enabled). The S10F3 and S10F9 are restricted to a single TEXT data item, but S10F5 can contain multiple TEXT data items. Each TEXT data item is limited to 160 characters.
PAGE 81
3.10 Error Messages The GES-1993 provides standard Stream 9 messages to report SECS-I errors. See 5.7 SECS Error Messages on page 5-19 for detailed description of these messages: S9F1 Unrecognized Device ID S9F3 Unrecognized Stream S9F5 Unrecognized Function S9F7 Invalid Data S9F9 Transaction Timeout S9F11 Data Too Long GWGEM together with GW SDR perform error handling.
PAGE 82
3.11.1 Related Variables The following table lists the variables (SV's, EC's, or DVVALS) which are relevant to material movement. For a more complete description of these variables, see "Appendix A -- Variables". Table 3-18 Material Movement Variables Variable Name VID CLOCK 27 GWGEM provides automated handling of synchronization of Equipment to Host Date and Time ([RefGWGEMUser] p 163 ‘Clock’). FmNT can synchronize with the Host using GemHostTimeReq.
PAGE 83
Spooling configuration is done in the GCD file. GWGEM provides variables, events, and a log file for spooling. The device is informed of Spooling State changes by the NoteSpoolState() function in the extension DLL. 3.12.1 A Word of Caution If the Host does not intend to use the spooling features of the Equipment, the Equipment Constant ConfigSpool should be set to zero. Setting this EC to zero disables the spooling feature.
PAGE 84
3.12.2.1 Spooling Starts When a transmission failure occurs, the first message sent to the spool is the event message GemSpoolingActivated. The next message sent to the spool is the message which caused the communications failure. The following table depicts the activity at the GES-1993 when spooling starts.
PAGE 85
3.12.2.3 Host Reads Spooled Data The Host can read spooled messages by sending the S6F23 message. Upon receipt of this message, the Equipment will reply and attempt to send spooled messages. Messages are sent in order of oldest to newest, with no priority given to a particular kind of message. The EC MAXSPOOLTRANSMIT determines the maximum number of spooled messages which are sent per S6F23 message received from the Host.
PAGE 86
Figure 3-7 Spooling State Diagram Spooling State Diagram Power Off 2. 1. Power On 10. Spool Inactive Spool Active H* 3. 4. No Spool Output Spool Output 9. Purge Spool 3-46 5. Spool Not Full 8. 7. 6.
PAGE 87
3.12.3 Spooling State Transitions Table 3-20 Spooling State Transitions # From Trigger To Description 1 Power On Equipment shutdown Power Off The Equipment may power off at any time. 2 Power Off Equipment Startup History* (Power On) Equipment re-boots after a shutdown. Spooling will continue according to its state when the equipment was powered off. 3 Spool Inactive GES-1993 experiences a transmission failure and the variable GemConfigSpool (VID 66) is set to "1" (enabled).
PAGE 88
3.12.4 Spool States 3.12.4.1 Power Off The GES-1993 is completely shut down. 3.12.4.2 Power On The GES-1993 is "on" and in a stable state. 3.12.4.2.1 Spool Inactive Spooling is not activated. This is either because GemConfigSpool is "0" (disabled) in which case, spooling will never be active, or because while GemConfigSpool is enabled ("1"), a RTY error has not occurred. In this state, no messages are sent to the spool.
PAGE 89
3.12.5 Related Variables The following table lists the variables (SV's, EC's, or DVVALS) which are relevant to spooling. For a more complete description of these variables, see "Appendix A -Variables". Table 3-21 Spooling Variables Variable Name VID MAXSPOOLTRANSMIT 46 SPOOLCOUNTACTUAL 48 SPOOLCOUNTTOTAL 49 SPOOLFULLTIME 50 SPOOLLOADSUBSTATE 51 SPOOLSTARTTIME 52 SPOOLSTATE 53 SPOOLUNLOADSUBSTATE 54 OVERWRITESPOOL 62 CONFIGSPOOL 63 3.12.
PAGE 90
PAGE 91
4. SECS Message Detail This section describes each message sent or understood by the Equipment. 4.1 SML Notation Message descriptions are shown using "SECS Message Language" (SML) notation. SML is a general notation developed by GW Associates for describing SECS messages. SML is similar to the notation used in the SECS Standards documents, but SML is a more precise and regular notation. In SML, the format for a data item is as follows: < type [ count ] value > The components are: <> Angle Brackets.
PAGE 92
If "count" is omitted, then the length of the Data Item is implied by the value which follows. The "count" can range between known limits. It may be specified as minimum and maximum "counts", separated by two dots. (For example, [0..40]). value Value of a single item element. Values are shown in a notation that depends on the item type. For example, ASCII values are shown as characters enclosed in quotes, Unspecified Binary values are shown in hexadecimal. ... Ellipsis (...
PAGE 93
The components are: SnFn The Stream and Function Codes, S1F1 for example. W The W-Bit, if set. Omitted if not set. If the W-Bit is optional, it is coded within brackets "[W]". item An item that is formatted as described above. . A period (.) ends the message definition. For example, the S1F3 message might be described in SML as follows: S1F3 W > . 4.2 S1F1 - Are You There S1F1 W. * H<->E The Host may send this message to the Equipment at any time.
PAGE 94
4.5 S1F3 - Selected Status Request S1F3 W * H-> E ... > . * Variable ID The Host requests status from the GES-1993. The Host sends the VIDs of interest. Several VIDs can be specified if desired. Normally, only VIDs of class SV (i.e. Status Variables) are used in this message. However, the GES-1993 allows the Host to use any VID of class DV, EC, or SV. If S1F3 contains a zero-length list, then the GES-1993 will report all variables of class SV, in order by VID.
PAGE 95
4.6 S1F4 - Selected Status Data S1F4 W * H<-E ... > . * Status Variable Value The Equipment returns the Variable Values in the order requested by S1F3. If any VID specified in S1F3 is invalid, the corresponding V in S1F4 has the following error format: * V for Invalid VID 4.7 S1F11 - Status Variable Namelist Request S1F11 W * H->E ... >. * Status Variable ID The Host format descriptions for the specified Variables. Several VIDs can be specified if desired.
PAGE 96
4.8 S1F12 - Status Variable Namelist Reply S1F12 * H<-E ... > . * Variable ID * Status Variable Name * Units of Measure The Equipment returns the Variable descriptions in order requested in S1F11. If any VID specified in S1F11 is invalid, the corresponding List in S1F12 has the following error format: * Instead of L [3] 4.9 S1F13 - Connect Request The Equipment sends this message using the following format. S1F13 W * H<-E > .
PAGE 97
4.10 S1F14 - Connect Request Acknowledge The Equipment sends this message using the following format: S1F14 > > . * COMMACK The Host sends this message using the following format: S1F14 * H->E > . * COMMACK The Equipment always sends the value 0x00 for COMMACK. In messages received from the Host, COMMACK value 0x00 indicates acceptance of the connect request. Any other value indicates refusal. 4.11 S1F15 - Request Off-Line S1F15 W .
PAGE 98
4.12 S1F16 - Off-Line Acknowledge S1F16 * H <- E . * OFLACK Equipment Control State transits to Host Off-Line and sends this message in response to S1F15 primary. OFLACK is always zero. 4.13 S1F17 - Request On-Line S1F17 W . * H -> E Host requests the Equipment to go On-Line. 4.14 S1F18 - On-Line Acknowledge S1F18 * H <- E . Equipment responds to S1F17 primary in an attempt to go On-Line. Data item ONLACK indicates the success or failure of the attempt.
PAGE 99
4.15 S1F65 - Connect Request NOTE This message is provided only for compatibility with Host computers which support an older version of GEM. The Equipment Constant ConfigConnect can be set to cause the Equipment to send S1F65 instead of S1F13 for Connect Request. The Equipment sends this message using the following format: S1F65 W * H<-E > . Format 1: The Host sends this message using the following format: S1F65 W * H->E .
PAGE 100
4.16 S1F66 - Connect Request Acknowledge NOTE This message is provided only for compatibility with Host computers which support an older version of GEM. If the Host sends S1F65, Format 1, the Equipment replies S1F66 using the following format. S1F66 * H<-E > > . * COMMACK If the Host sends S1F65, format 2, the Equipment replies S1F66 using the following format. S1F66 . * H<-E * COMMACK The Host sends this message using the following format.
PAGE 101
4.17 S2F13 - Equipment Constant Request S2F13 W * H->E ... > . * Equipment Constant ID The Host requests the VIDs of interest. Several VIDs can be specified if desired. Normally, only VIDs of class EC (i.e. Equipment Constants) are used in this message. However, any VID of class DV, EC, or SV can be used. If S2F13 contains a zero-length list, then the Equipment will report all variables of class EC, in order by VID.
PAGE 102
4.19 S2F15 - New Equipment Constant Send S2F15 W * H->E > ... > . * Equipment Constant ID The Host sends new values for desired Equipment Constants. Several Equipment Constants can be specified if desired. Only VIDs of class EC can be used in this message. 4.20 S2F16 - Equipment Constant Send Acknowledge S2F16 . * H<-E * Equipment Acknowledge Code Normal completion returns a zero (0) in EAC.
PAGE 103
4.21 S2F17 - Date and Time Request S2F17 W . * H<->E The Host may send this message at any time to determine the Date and Time base that the GES-1993 is currently using. The GES-1993 sends this message at the request of the operator. 4.22 S2F18 - Date and Time Data S2F18 * H<->E * TIME - Date and Time . - * If TIMEFORMAT = 0 OR – . * If TIMEFORMAT = 1 This message contains the current Date and Time.
PAGE 104
4.23 S2F23 - Trace Initialize Send S2F23 W * H->E ... > > . * * * * Trace ID DSPER - Data Sample Period Total Number of Samples Reporting Group Size * Status Variable ID The Host requests the Equipment to initiate a time driven trace operation. The Equipment will send trace data using S6F1. If TRID in S2F23 matches TRID of an existing trace, the existing trace operation is canceled, and replaced by the new one.
PAGE 105
For compatibility with older Host implementations, the Equipment allows the following alternative form for this message, using an array format: S2F23 W * H->E * Trace ID * DSPER - Data Sample > . * Total Number of Samples * Reporting Group Size * Status Variable ID array Period 4.24 S2F24 - Trace Initialize Acknowledge S2F24 * H<-E . * TIAACK - Trace Init. Ack.
PAGE 106
4.25 S2F25 - Diagnostic Loopback Request S2F25 W . * H->E * ABS - Any Binary String The Host sends an arbitrary binary string to test operation of the link. The Equipment never sends this message to the Host. 4.26 S2F26 - Diagnostic Loopback Data S2F26 . * H<-E * ABS - Any Binary String The Equipment "echoes" back the binary data from the Host's S2F25. 4.27 S2F27 - Initiate Process Request S2F27 [W] > > .
PAGE 107
4.28 S2F28 - Initiate Process Acknowledge S2F28 . * H<-E * Command Ack. Code Normal completion returns a zero (0) in CMDA. A non-zero value for CMDA indicates that the Equipment has rejected the Remote Command. Table 4-4 CMDA SECS Message Detail CMDA Values Description 0x00 OK. All normal. 0x01 Invalid command. Equipment rejects command 0x02 Cannot perform now. Equipment rejects command. 0x40 Control State is Local. Equipment rejects command.
PAGE 108
4.29 S2F29 - Equipment Constant Namelist Request S2F29 W * H->E ... > . * Equipment Constant ID The Host requests format descriptions for the specified Equipment Constants. Several VIDs can be specified if desired. Only VIDs of class EC (i.e. Equipment Constants) can be used in this message. If S2F29 contains a zero-length list, then the Equipment will report all variables of class EC, in order by VID. 4.
PAGE 109
4.31 S2F31 - Date and Time Send S2F31 W * H->E * TIME - Date and Time . * If TIMEFORMAT = 0 - OR . * If TIMEFORMAT = 1 The Host commands the Equipment to set its Date and Time base to the specified value. When the Equipment receives a good S2F31, it sets its internal clock/calendar. When receiving S2F31, the Equipment will discard an invalid date or time. For example, if the date is good but the time is bad, the Equipment sets its date but not its time. 4.
PAGE 110
4.33 S2F33 - Define Report S2F33 W * H->E, Multiblock ... > > ... > > . * DATAID * Report ID * Variable ID The Host specifies one or more Report IDs, and defines which Variables should be included in each report. If S2F33 is multi-block, the Host may optionally send the S2F39/S2F40 Inquire/Grant Transaction before sending S2F33, but this Equipment does not require it. The Equipment ignores DATAID.
PAGE 111
The Host can delete all report definitions and associated links in the Equipment by using the following special format: S2F33 W * H->E > . * DATAID 4.34 S2F34 - Define Report Acknowledge S2F34 * H<-E . * DRACK - Acknowledge Code Normally, DRACK is zero. Any non-zero DRACK indicates the Equipment has rejected the entire S2F33 message. Table 4-6 DRACK SECS Message Detail DRACK Values Description 0x00 OK 0x02 Denied. Invalid format. 0x03 Denied.
PAGE 112
4.35 S2F35 - Link Event Report S2F35 W * H->E, Multiblock * DATAID * Collection Event ID * Report ID ... > > ... > > . The Host links Report Ids to selected Collection Event Ids. The Specified CEIDs are initialized to "disabled". See S2F37 for enabling CEIDs. If S2F35 is multi-block, the Host may optionally send the S2F39/S2F40 Inquire/Grant transaction before sending S2F35, but the GES-1993 does not require it. The Equipment ignores DATAID.
PAGE 113
4.36 S2F36 - Link Event Report Acknowledge S2F36 * H<-E . * LRACK - Acknowledge Code Normally, LRACK is zero. Any non-zero LRACK indicates the Equipment has rejected the entire S2F35 message. Table 4-7 LRACK SECS Message Detail LRACK Values Description 0x00 OK 0x02 Denied. Invalid format. 0x03 Denied. At least one CEID link already defined 0x04 Denied. At least one CEID does not exist. 0x05 Denied. At least one RPTID does not exist.
PAGE 114
4.37 S2F37 - Enable/Disable Event Report S2F37 W * H<-E ... > > . * Coll. Event Enable * Collection Event ID The Host enables reporting for a list of Collection Event IDs, or disables reporting for the list. CEED is "True" to indicate Enabling, or "False" to indicate Disabling reporting for the specified CEIDs. The Host can enable or disable all CEIDs by using the following special format: S2F37 W * H->E > . * Coll. Event Enable 4.
PAGE 115
4.39 S2F39 - Multi-Block Inquire S2F39 W * H->E > . * DATAID The Host may send this Inquire/Grant transaction preceding any multiblock S2F33 or S2F35. For this Equipment, this Inquire/Grant is optional. The Equipment accepts it, but ignores it, commits no resources, and initiates no Conversation Timeout. The Equipment accepts multiblock S2F33 or S2F35 even if not preceded by the Inquire/Grant. 4.40 S2F40 - Multi-Block Grant S2F40 .
PAGE 116
4.41 S2F41 - Remote Command with Parameters S2F41 [W] * H->E > ... > * Remote command string * Command Parameter Name * Command Parameter Value > . The Host sends a command with parameters to the Equipment. If a command has no parameters, S2F41 has the following format: S2F41 [W] * H->E > . * Remote Command String The GES-1993 ignores case when performing validity checks on the RCMD and CPNAME strings.
PAGE 117
4.42 S2F42 - Remote Command Acknowledge S2F42 * H<-E > ... > * Host Command Ack. Code * name of parameter * Cmd Param Ack Code > . Normal completion returns a zero (0) in HCACK. The number of erroneous parameters "N" in S2F42 will be zero. A non-zero value for HCACK indicates that the Equipment has rejected the Remote Command. The number of erroneous parameters "n" can be zero or greater.
PAGE 118
Table 4-10 4-28 CPACK Values CPACK Description 0x01 Invalid parameter name (CPNAME). The CPNAME is not a valid parameter for this command. 0x02 Illegal parameter value (CPVAL). The parameter value is out of range. 0x03 Illegal format for parameter (CPVAL). The value for this parameter does not use the correct SECS-II data item type. 0x40 Duplicate parameter name. This parameter name occurred at least twice in the S2F41 command.
PAGE 119
4.43 S2F43 - Reset Spooling Streams and Functions S2F43 W * H -> E ... > > ... * Message Stream * Message Function > . The Host sends message to specify which messages the Equipment should spool in the event of a communications loss. When this message is received by the Equipment, all previous definitions of messages to spool are replaced.
PAGE 120
4.44 S2F44 - Reset Spooling Acknowledge The S2F44 message has two forms, depending on the return code in RSPACK. If there are no errors in S2F43, the format of S2F44 is as follows. S2F44 * H <- E * RSPACK > . If S2F43 contains any errors, the Equipment will discard the entire S2F43, and return error information is S2F44, as follows: S2F44 * H <- E * RSPACK * Msg String * Stream Ack Code * Msg Function ... > > ...
PAGE 121
When errors exist in the request to set some messages as spool-able, the Equipment will return codes explaining the nature of the error. These codes are found in the STRACK data item. Table 4-12 STRACK Values STRACK Description 0x01 Spooling not allowed for this stream. Spooling is never allowed for stream one. 0x04 Requested message is a secondary message and therefore ineligible for spooling 4.
PAGE 122
UPPERDB and LOWERDB must match the value format of the specified variable The Host may undefine all limits for all VIDs: S2F45 W * H -> E > . The Host may undefine all limits for a specific VID: S2F45 W * H -> E > ... > > .
PAGE 123
The Host may undefine a specific limit for a specific VID: S2F45 W * H -> E > > ... > ... > > .
PAGE 124
4.46 S2F46 - Variable Limit Attribute Acknowledge This message acknowledges the successful setting of limits as defined in the Hostgenerated S2F45. S4F46 * H <- E * VLAACK > . If any of the limits proposed in S4F45 are invalid, all limits for all variables in this message are rejected. The following message is sent in the event of an error: S4F46 * H <- E * LVACK > > ... > > .
PAGE 125
The LVACK data item gives information to the Host about the status of setting a specific variable when the request to set it is unsuccessful. Table 4-14 LIMIT-ACK LVACK Values Description 0x01 Requested variable does not exist. 0x02 Variable is not eligible for limits definition. 0x03 Requested variable was repeated in request message. 0x04 Error in setting limit due to reason specified in LIMITACK.
PAGE 126
4.47 S2F47 - Variable Limit Attribute Request S2F47 W * H -> E ... * Requested Variable ID > . The Host sends this message to the Equipment to request the limits attributes for specific variables. The Host may request the limits attributes for all defined variables with the following message. S2F47 W * H -> E . In response to this message, the Equipment reports all limits attributes for all variables.
PAGE 127
4.48 S2F48 - Variable Limit Attributes Send S2F48 * H <- E * Variable ID * Units of Measure * Minimum Limit * Maximum Limit * Limit ID * Upper Deadband * Lower Deadband > ... > > > ... > . The Equipment sends this message in response to a Host S2F47 and reports the characteristics of limits for specified variables.
PAGE 128
If the Host requests the limits for a specific variable which is eligible for limits monitoring but does not have any limits defined, this variable will be reported as follows: S2F48 * H <- E > > ... * Variable ID * * * * Units of Measure Minimum Limit Maximum Limit No Limits Defined > . 4.49 S5F1 - Alarm Report S5F1 [W] * H<-E * ALCD - Alarm On/Off and > .
PAGE 129
Equipment Constant "WBitS5" controls whether the Equipment sends S5F1 with WBit "1" (Reply Expected) or "0" (No Reply Expected). 4.50 S5F2 - Alarm Acknowledge S5F2 * H->E . * ACK5 - Alarm Acknowledge The Host acknowledges the Alarm Report. This Equipment ignores the ACKC5. 4.51 S5F3 - Enable/Disable Alarm Send S5F3 [W] * H->E * ALED - Alarm Enable/Disable > .
PAGE 130
The following special format can be used to enable or disable all ALIDs. S5F3 [W] * H->E * ALED - Alarm Enable/Disable > . * ALID - Alarm ID Code The Host may optionally set the W-Bit to "1" in S5F3. If so, the GES-1993 replies with S5F4. 4.52 S5F4 - Enable/Disable Alarm Acknowledge S5F4 * H<-E . * ACKC5 - Acknowledge Code Table 4-17 ACKC5 ACKC5 Values Description 0x00 Normal. Everything Correct 0x01 Invalid ALID. 4.
PAGE 131
4.54 S5F6 - List Alarm Data S5F6 * H<-E, Multiblock * ALCD - Alarm On/Off and Code * Alarm ID * ALTX - Alarm Text > Severity ... > . The high-order bit of ALCD will be "1" if this alarm is currently On (Unsafe), or "0" if it is currently Off (Safe). The low-order seven bits of ALCD contain the severity code for this alarm.
PAGE 132
4.56 S5F8 - List Enabled Alarm Data S5F8 * H<-E, Multiblock * ALCD - Alarm On/Off and Code * Alarm ID * ALTX - Alarm Text > Severity ... > . The high-order bit of ALCD will be "1" if this alarm is currently On (Unsafe), or "0" if it is currently Off (Safe). The low-order seven bits of ALCD contain the severity code for this alarm. S5F8 contains only those ALIDs which are currently enabled for reporting (See S5F3). S5F8 reports alarms in order by Alarm ID.
PAGE 133
4.57 S5F71 - Alarm Report Block Send S5F71 [W] * H<-E * ALPY Alarm Priority * ALID - Alarm ID * T = Alarm On F = Alarm Off * ASER Alarm Serial Number * CLOCK > > > . NOTE This message is provided only for compatibility with Host computers which support an older version of GEM. If the Equipment Constant "ConfigAlarms" is set to "1", the Equipment sends S5F71 instead of the normal S5F1 Alarm Notification Send.
PAGE 134
4.58 S5F72 - Alarm Report Block Acknowledge S5F72 * H->E . The Host acknowledges Alarm Report. This Equipment ignores the data portion of S5F72. 4.59 S5F73 - Alarm Report Block Acknowledge S5F73 [W] * H<-E * ALID - Alarm ID * T = Alarm On, F = Alarm Off. * TIMESTAMP > . NOTE This message is provided only for compatibility with older Host computers which support GEM 3.1. (See section 2.7.2, "Gem Configuration".
PAGE 135
4.61 S6F1 - Trace Data Send S6F1 [W] * H<-E * Trace ID * Sample Number * STIME - Sample Date/Time * If TIMEFORMAT = 0 - OR * If TIMEFORMAT = 1 ... > * Variable Value >. The Equipment sends time driven trace data, as previously requested by the Host using S2F23. TRID is the Trace ID as initiated by the Host. SMPLN is the sample number. The first sample is "1", the next "2", and so on.
PAGE 136
4.63 S6F3 - Annotated Event Report S6F3 [W] * H<-E, Multiblock * DATAID * Collection Event ID * DSID=RPTID Report ID * Variable ID * Variable Value > ... > > ... > > . NOTE This message is provided only for compatibility with older Host computers which do not support GEM. (See section 2.7.2, "Gem Configuration".
PAGE 137
If the CEID is enabled, but no Reports are linked to this CEID, S6F3 has the following special format: S6F3 [W] * H<-E > . * DATAID * Collection Event ID Equipment Constant "Wbits6" controls whether the Equipment sends S6F3 with WBit "1" (Reply Expected) or "0" (No Reply Expected). 4.64 S6F4 - Annotated Event Report Acknowledge S6F4 * H->E . * ACKC6 The Host acknowledges the Event Report. The Equipment ignores ACKC6. 4.
PAGE 138
4.66 S6F6 - Multi-Block Grant S6F6 * H->E . * GRANT6 The Host grants permission for the Equipment to send a multi-block event report.. Table 4-18 GRANT6 4-48 Multi-Block Event Values Description 0x00 Normal. Permission granted. Other Permission not granted. The Equipment will not send the following S6F3, S6F9, S6F11, or S6F13, and will discard the data.
PAGE 139
4.67 S6F9 - Event Report S6F9 [W] ... > > ... > > . NOTE * PFCD * DATAID * Collection Event ID * DSID=RPTID Report ID * Variable Value This message is provided only for compatibility with older Host computers which do not support GEM. (See section 2.7.2, "Gem Configuration".) If the Equipment Constant "ConfigEvents" is set to "0", the Equipment sends S6F9 instead of the normal S6F11 Event Report.
PAGE 140
If the CEID is enabled, but no Reports are linked to this CEID, S6F9 has the following special format: S6F9 [W] > . * H<-E * PFCD * DATAID * Collection Event ID Equipment Constant "WBitS6" controls whether the Equipment sends S6F9 with WBit "1" (Reply Expected) or "0" (No Reply Expected). 4.68 S6F10 - Event Report Acknowledge S6F10 . * H->E * ACKC6 The Host acknowledges the Event Report. The Equipment ignores ACKC6.
PAGE 141
4.69 S6F11 - Event Report Send S6F11 W ... > > ... > > . * H<-E * DATAID * Collection Event ID * Report ID * Variable Value This message is the "normal" message that the Equipment uses to report events. In order for this message to be used, the Equipment Constant "ConfigEvents" must be set to "1". A Collection Event has occurred at the Equipment. The Host has enabled event reporting for this CEID (see S2F37).
PAGE 142
4.70 S6F12 - Event Report Acknowledge S6F12 . * H->E * ACKC6 The Host acknowledges the Event Report. The Equipment ignores ACKC6. 4.71 S6F13 - Annotated Event Report Send S6F13 W * H<-E, Multiblock * DATAID * Collection Event ID * Report ID * Variable ID * Variable Value > ... > > ... > > . NOTE This message is provided only for compatibility with older Host computers which support older versions of GEM.
PAGE 143
If the CEID is enabled, but no Reports are linked to this CEID, S6F11 has the following special format: S6F13 W > . * H<-E * DATAID * Collection Event ID 4.72 S6F14 - Annotated Event Report Acknowledge S6F14 . * H->E * ACKC6 The Host acknowledges the Event Report. The Equipment ignore ACKC6. 4.73 S6F15 - Event Report Request S6F15 W . * H->E * Collection Event ID The Host sends the CEID of interest, requesting normal format reports.
PAGE 144
4.74 S6F16 - Event Report Data S6F16 ... > > ... > > . * DATAID * Collection Event ID * Report ID * Variable Value The Equipment sends one or more Event Reports which the Host has previously linked to that CEID (see S2F35). Each report contains specific Variables which the Host has previously defined for that Report (see S2F33).
PAGE 145
4.75 S6F17 - Annotated Event Report Request S6F17 W . * H->E * Collection Event ID The Host sends the CEID of interest, requesting annotated format reports. 4.76 S6F18 - Annotated Event Report Data S6F18 . * H<-E * DATAID * Collection Event ID * Report ID * Variable ID * Variable Value > ... > > ... > The Equipment sends one or more Event Reports which the Host has previously linked to that CEID (see S2F35).
PAGE 146
If the CEID specified in S6F17 is invalid, or if no reports are linked to this CEID, this message has the following format: S6F18 > . * DATAID * Collection Event ID 4.77 S6F19 - Request Report Request S6F19 W . * H->E * Report ID The Host requests a Report for the specified RPTID. 4.78 S6F20 - Request Report Data S6F20 ... > . The Equipment sends the Report.
PAGE 147
4.79 S6F21 - Request Annotated Report Request S6F21 W . * H->E * Report ID The Host requests an Annotated Report for the specified RPTID. 4.80 S6F22 - Request Annotated Report Data S6F22 > ... > . * VID - Variable ID The Equipment sends the Annotated Report. If no Report is defined for the RPTID in S6F21, S6F22 has the following special error format: S6F22 * H<-E .
PAGE 148
4.81 S6F23 - Request Spooled Data S6F23 W * H -> E . The Host sends this message to start the transfer of spooled messages from the Equipment to the Host, or to delete the contents of the spool file, depending on the value of RSDC. When the Host requests the spooled messages (RSDC is zero), the Equipment will send messages according to EC "MaxSpoolTransmit". All messages are sent from oldest to newest, and once the message is successfully sent, it is removed from the spool.
PAGE 149
4.82 S6F24 - Request Spooled Data Acknowledge S6F24 * H <- E . Equipment acknowledges the Host's request to either purge spooled messages or send spooled messages to the Host. Table 4-20 RSDA RSDA Values Description 0x00 Normal. Equipment will start to send spooled data or optionally purge the spool. Action performed will depend on value for RSDC in S6F23. 0x02 Denied. Spooled data does not exist. 4.83 S7F1 - Process Program Load Inquire S7F1 W E > .
PAGE 150
4.84 S7F2 - Process Program Load Grant S7F2 * H<->E . * PPGNT The Receiver grants permission to send a Process Program. The Receiver sends PPGNT value 0x00 to indicate it will accept the Process Program, and the Sender should send S7F3. If the Receiver sends any other value in S7F2, it refuses the Grant, and the Sender should not send S7F3. The Process Program may be either a Load Recipe, Process Recipe, or Parameter Table.
PAGE 151
4.85 S7F3 - Process Program Send S7F3 W * H<->E, Multiblock * PPID - Process Program ID * PPBODY - Process Program Body PPID should be in DOS 8.3 file name format and should include the extension RCP. Send an Unformatted Process Program. Before sending a multi-block S7F3, the Equipment always first sends the S7F1/S7F2 Inquire/Grant transaction. The Host may send S7F1/S7F2 before sending S7F3. The Equipment accepts it, but does not require it. 4.
PAGE 152
When the Host sends S7F4, the Equipment interprets ACKC7 as follows: Table 4-24 ACKC7 S7F4 ACKC7 Interpretations Description 0x00 Normal. Other Refusal. The upload operation fails. 4.87 S7F5 - Process Program Request S7F5 W * H<->E . * Process Program ID PPID should be in DOS 8.3 file name format and should include the extension RCP. Request the other end of the link to send a specified Process Program from its library. 4.
PAGE 153
4.89 S7F17 - Process Program Delete S7F17 W * H->E ... > . * Process Program ID PPID should be in DOS 8.3 file name format and should include the extension RCP. The Host deletes one or more Process Programs from the Equipment library. If S7F17 contains a zero-length List, the entire library is deleted. 4.90 S7F18 - Process Program Delete Acknowledge S7F18 * H<-E . * ACKC7 - Acknowledge Code The Equipment acknowledges the Process Program delete.
PAGE 154
4.91 S7F19 - Process Program Directory Request S7F19 W . * H->E PPIDs returned to host will be in DOS 8.3 file name format and will include the extension RCP. The Host requests a directory of the Process Programs currently in the Equipment library. 4.92 S7F20 - Process Program Directory S7F20 * H<-E ... > . * Process Program ID The Equipment sends a directory of its Process Program library. If the library is empty, the list will be zero length. 4.
PAGE 155
4.96 S9F7 Invalid Data S9F7 . * H<-E * MHEAD - Header of bad msg 4.97 S9F9 Transaction Timer Timeout S9F9 . * H<-E * SHEAD - Stored Header 4.98 S9F11 - Data Too Long S9F11 . * H<-E * MHEAD - Header of bad msg 4.99 S10F1 - Terminal Request S10F1 [W] * H<-E > . * Terminal ID * Message Text The Equipment sends text to the Host.
PAGE 156
4.100 S10F2 - Terminal Request Acknowledge S10F2 . * H->E * Acknowledge Code The Host may send the following values for ACKC10: Table 4-27 ACKC10 S10F2 ACKC10 Values Description 0x00 Normal. Host accepts the S10F1. Other Host rejects the S10F1. 4.101 S10F3 - Terminal Display, Single S10F3 [W] * H->E > . * Terminal ID * Message Text The Host sends to the Equipment.
PAGE 157
4.102 S10F4 - Terminal Display Single Acknowledge S10F4 * H<-E . * Acknowledge Code This Equipment may send the following values for ACKC10: Table 4-29 ACKC10 0x00 S10F4 ACKC10 Values Description Normal. 4.103 S10F5 - Terminal Display, Multiblock S10F5 [W] * H->E, Multiblock * Terminal ID * Message Text ... > > . S10F5 can contain multiple TEXT data items. Each TEXT data item is limited to 160 characters.
PAGE 158
4.104 S10F6 - Terminal Display Multiblock Acknowledge S10F6 * H<-E . * Acknowledge Code This Equipment may send the following values for ACKC10: Table 4-31 ACKC10 0x00 S10F6 ACKC10 Values Description Normal. 4.105 S10F9 - Broadcast S10F9 [W] * H->E . * Message Text The Host sends text to the Equipment. The Equipment displays the text on its CRT. The Host may optionally set the W-Bit to "1" in S10F9. If so, the Equipment replies with S10F10. 4.
PAGE 159
5. SECS Scenarios Unless otherwise noted in this section, the Communications State is "Communicating" and the Control state is either "On-Line/Local" or "OnLine/Remote". 5.1 Equipment Communications 5.1.1 Equipment Establishes Communications Assumption: Equipment's Communication state is "Enabled/Not Communicating". Table 5-1 SECS Messages Equipment Establishes Communications Step SECS Message Description 1. H <- E S1F13 W Equipment attempts to send Establish Communications Request. 2. 3.
PAGE 160
5.1.2 Host Establishes Communications Assumption: Equipment's Communication state is either "Enabled/Not Communicating" or "Enabled/Communicating". Table 5-2 Step SECS Message 1. H -> E S1F13 W 2. H <- E S1F14 SECS Messages Host Establishes Communications Description Host sends Establish Communications Request. The Equipment responds with Establish Communications Acknowledge, with COMMACK set to zero. After this message is successfully sent, communications is established.
PAGE 161
5.1.4 Losing Connection, Re-Connecting Table 5-4 SECS Messages Losing Connection, Re-Connecting Step SECS Message Description 1. H <- E SxFy Any Message. The Equipment encounters SECS block transmission errors while attempting to send a message to the Host., and reaches its Retry Limit (RTY). The Equipment considers the SECS link as disconnected. Spooling will become Active if enabled. 2. H <-E S1F13 W 3. 4. Connect Request. The Equipment attempts to re-establish the link.
PAGE 162
5.2 Data Collection 5.2.1 Host Initializes Event Reporting Table 5-6 Step SECS Message 1. H -> E S2F37 W 2. H <- E S2F38 3. H ->E S2F33 W 4. H <- E S2F34 5. H -> E S2F33 W 6. H <-E S2F34 7. H -> E S2F35 W 8. H <- E S2F36 9. H -> E S2F15 W 10. H <- E S2F16 11. H -> E S2F37 W 12. H <- E S2F38 5-4 SECS Messages Host Initializes Event Reporting Description Disable Event Reports. The Host disables reporting for all Collection Events. S2F37 W >.
PAGE 163
5.2.2 Equipment Reports Event Table 5-7 Step SECS Messages Equipment Reports Event SECS Message 1. Description The Equipment recognizes that an event has occurred. The Host has enabled reporting for the CEID, and possibly has defined one or more Reports and linked them to the CEID. The Equipment Constant RpType is set to "False", requesting normal reports. 2. H <- E S6F5 W Inquire. If S6F13 will be multi-block, the Equipment first sends this Inquire to request permission.
PAGE 164
5.2.4 Host Initiates Trace Table 5-9 Step SECS Message 1. H -> E S2F23 W 2. H <- E S2F24 3. SECS Messages Host Initiates Trace Description The Host initiates a trace. The Equipment acknowledges the trace request. If the data in S2F23 is not valid, the acknowledge code in this message is nonzero and the scenario ends. Otherwise, the following steps are done "TOTSMP" times, where TOTSMP is the total number of samples to be done. The Equipment waits "DSPER" (data sample period).
PAGE 165
5.2.6 Host Requests Status Table 5-11 Step SECS Message 1. H -> E S1F3 W 2. H <- E S1F4 SECS Messages Host Requests Status Description Discrete Variable Request. The Host requests the VIDs of interest. The Equipment sends the Variable values. 5.2.7 Host Defines Limits Table 5-12 Step SECS Message 1. H -> E S2F45 W 2. H <- E S2F46 SECS Messages Host Defines Limits Description Host defines new variable limits attributes. Equipment accepts new limits definitions, and responds with VLAACK = 0x00.
PAGE 166
5.2.10 Host Requests Annotated Report by CEID Table 5-15 Step SECS Message 1. H -> E S6F17 W 2. H <- E S6F18 SECS Messages Host Requests Annotated Report by CEID Description Request Annotated Event Report. The Host requests a report for the specified CEID. In this way, the host requests the Equipment to "pretend" that the specified CEID has occurred. The Equipment sends annotated reports linked to that CEID. 5.2.11 Host Requests Report by RPTID Table 5-16 Step SECS Message 1. H -> E S6F19 W 2.
PAGE 167
5.2.14 Host Reads Equipment Constants Table 5-19 SECS Messages Host Reads Equipment Constants Step SECS Message Description 1. H -> E S2F13 W Host requests the values of one or more Equipment Constants. 2. H <- E S2F14 The Equipment responds with the values of the requested Equipment Constants. 5.2.15 Host Sets Equipment Constants Table 5-20 SECS Messages Host Sets Equipment Constants Step SECS Message 1. H -> E S2F15 W Host sends new values for one or more Equipment Constants. 2.
PAGE 168
5.3 Alarms 5.3.1 Equipment Reports Alarm Table 5-21 SECS Messages Equipment Reports Alarm Step SECS Message Description 1. H <- E S5F1 [W] If reporting for this alarm ID is disabled, skip this and the following step. Otherwise send the alarm. The Equipment Constant WBitS5 determines whether the W-bit is 0 or 1 in this message. 2. H -> E S5F2 3. H <- E S6F11 W 4. H -> E S6F12 If the W-bit in S5F1 is 1, the Host acknowledges the alarm report. Otherwise, skip this step.
PAGE 169
5.3.4 Alarm Report (GEM, Ver 3.1 Compatibility) NOTE This scenario is provided only for compatibility with Host computers which support GEM, Ver 3.1. Table 5-24 Step SECS Message 1. SECS Messages Alarm Report (GEM, Ver 3.1 Compatibility) Description The Equipment Constant ConfigAlarms is set to 2 for non-GEM compatibility. The Equipment recognizes that an alarm condition has gone "on" (i.e. has become Unsafe). 2. H <- E S5F73 [W] 3. H -> E S5F74 4. The Equipment reports the Alarm going on.
PAGE 170
5.4 Control State 5.4.1 Host Sends On-Line Command Assumption: Control State is "Host Off-Line". Variable GemControlState = 3. Table 5-26 Step SECS Message 1. H -> E S1F17 W 2. H <- E S1F18 3. H <- E S6F11 W SECS Messages Host Sends On-Line Command Description Host instructs the Equipment to go "On-Line". Equipment responds to successful On-Line transition with ONLACK=0. Control state transits to either Local or Remonte as guided by EC GemOnlineSubstate.
PAGE 171
5.4.3 Host Sends Remote Command Assumption: Control State is On-Line and Remote. Table 5-28 SECS Messages Host Sends Remote Command Step SECS Message Description 1. H -> E S2F41 [W] The Host sends the command. The W-bit in this message bay be either 0 or 1. 2. H <- E S2F42 If the W-bit was 1, the Equipment acknowledges the command. If the Equipment cannot perform the command, the acknowledge code in this message is non-zero.
PAGE 172
5.4.5 Go Remote, Operator-Initiated Table 5-30 Step SECS Messages Go Remote, Operator-Initiated SECS Message 1. Description ControlState is Local. The Equipment operator switches the Equipment to Remote Control. 2. H <- E S6F11 W 3. H -> E S6F12 The Equipment signals CEID GemControlState REMOTE. Event Reports as appropriate. The Host acknowledges the report. 5.4.6 Go Local, Operator-Initiated Table 5-31 Step SECS Messages Go Local, Operator-Initiated SECS Message 1.
PAGE 173
5.4.8 Operator Command, Successful Table 5-33 Step SECS Messages Operator Command, Successful SECS Message 1. Description ControlState is Local. The operator issues a front-panel INITIATE PROCESS command. The Equipment performs the command. 2. H <- E S6F11 W 3. H -> E S6F12 The Equipment signals CEID LotStart. Event Reports as appropriate. The Host acknowledges the report. 5.5 Process Program Management 5.5.1 Unformatted, Host-Initiated Download Table 5-34 Step SECS Message 1. H -> E S7F1 W 2.
PAGE 174
5.5.3 Unformatted, Equipment-Initiated Download Table 5-36 Step SECS Message 1. H <- E S7F5 W 2. H -> E S7F6 3. H <- E S6F11 W 4. H -> E S6F12 SECS Messages Unformatted, Equipment-Initiated Download Description Equipment requests a Process Program. The Host sends the Process Program. If the Process Program is valid, the Equipment stores the Process Program in its library, and the scenario ends.
PAGE 175
5.5.5 Host Deletes Process Program Table 5-38 SECS Messages Host Deletes Process Program Step SECS Message Description 1. H -> E S7F17 W Host sends a request to delete one or more Process Programs from the Equipment's library of Process Programs. 2. H <- E S7F18 The Equipment replies with an acknowledge code. If all specified Process Program(s) were deleted successfully, the acknowledge code is 0.
PAGE 176
5.6 Equipment Terminal Communications 5.6.1 Host to Equipment, Single Line Table 5-41 Step SECS Messages Host to Equipment, Single Line SECS Message 1. Description The Host has data to display at the Equipment's front panel. 2. H -> E S10F3 [W] Terminal Display. The Host sends text. The Equipment displays the text on its front panel. 3. H <- E S10F4 If the W-bit in S10F3 is 1, the Equipment acknowledges. 4. The Operator acknowledges that he/she has read the message. 5. H <- E S6F11 W 6.
PAGE 177
5.6.3 Equipment Sends Text to Host Table 5-43 Step SECS Messages Equipment Sends Text to Host SECS Message 1. Description The Equipment operator enters data to send to the Host. 2. H <- E S10F1 [W] 3. H -> E S10F2 Equipment sends text to Host. The W-bit in this message may be either 0 or 1. The Host displays the message for the operator. If the W-bit in S10F1 is 1, the Host acknowledges the text message. 5.7 Error Messages 5.7.1 Unrecognized Device ID Table 5-44 Step SECS Message 1.
PAGE 178
5.7.3 Unrecognized Function Table 5-46 SECS Messages Unrecognized Function Step SECS Message Description 1. H -> E SnFn [W] Host sends a primary message with a stream number for which the Equipment recognizes some messages, but with a function number that the Equipment does not support for that stream. The W-bit can be either 0 or 1. 2. H <- E S9F5 Equipment replies with "Unrecognized Function". 5.7.4 Illegal Data Format Table 5-47 Step SECS Message 1. H -> E SnFn [W] 2.
PAGE 179
5.8 Clock 5.8.1 Host Sets Date and Time Table 5-49 SECS Messages Host Sets Date and Time Step SECS Message Description 1. H -> E S2F31 W Date and Time Send. The Host sends a new Date and Time to the Equipment. 2. H <- E S2F32 The Equipment sets its Clock/Calendar hardware and acknowledges the command. 5.8.2 Host Requests Date and Time Table 5-50 Step SECS Message 1. H -> E S2F17 W 2. H <- E S2F18 SECS Messages Host Requests Date and Time Description Date and Time Request.
PAGE 180
5.9 Spooling For all of the spooling scenarios, spooling is meaningful only when Control State (CONTROLSTATE = 4 or 5) is "On-Line". When CONTROLSTATE is "Off-Line" (CONTROLSTATE = 1, 2, or 3), Equipment sends only stream one primaries and SnF0 secondaries, neither of which are eligible for spooling. 5.9.1 Host Enables Spooling of Messages Table 5-52 Step SECS Message 1.
PAGE 181
5.9.2 Messages Spooled and Transmitted Assumption: Spool State is "Spool Inactive". Table 5-53 Step SECS Message 1. H <- E SnFn 2. SECS Messages Spooled and Transmitted Description Equipment attempts to send any message to the Host. After failure to deliver message, the Equipment assumes that the link is down, and will start to spool all messages marked for spooling. The first message spooled is the collection event "SpoolActivated". 3. H <- E S1F13 W Equipment attempts to establish communications.
PAGE 182
Step SECS Message 11. H -> E S6F23 W 12. H <- E S6F24 13. H <- E S6F11 W 14. H -> E S6F12 Description The Host requests that the Equipment continue de-spooling messages. Equipment indicates that it will start to send spooled messages with return code RSDA = 0x00. Go to step 10. Equipment notifies the Host that sending of spooled messages has been completed by sending CEID GemSpooling Deactivated. Host acknowledges that the spool has been cleared and is deactivated. 5.9.
PAGE 183
6. Machine Variable Definitions The following data variables are collected by the Host to support intelligent communications with the Equipment. There are three categories of data variables listed here. Status Variables Data Variables Equipment Constants Each variable is given a header line with its associated ID value and its name. The storage type and the definition of the variable are listed below in smaller type. Variables listed in the header in capital letters are GEM standards.
PAGE 184
Variable Name ID Storage Type CameraYFieldMils 701 U2 CLOCK 27 A[16] Description The size in mils of the Y coordinate axis field of view seen by the camera. The current value of the clock accurate to hundredths of a second. The format is: YYYYMMDDHHmmsscc. This format is always the same, regardless of TIMEFORMAT. CONTROLSTATE 28 U1 This is the value indicating the current Control State Machine state.
PAGE 185
Variable Name ID Storage Type Description PREVIOUSCONTROLSTATE 35 U1 The previous Control State for the Equipment. The values are: 1 Off-Line / Equipment Off-Line 2 Off-Line /Attempt On-Line 3 Off-Line/Host Off-Line 4 On-Line Local, 5 On-Line Remote. PREVIOUSPROCESSSTATE 36 U1 The previous Process State for the Equipment. The values for this state can be found in Appendix A. PROCESSSTATE 37 U1 The current Process State for the Equipment. The values for this state can be found in Appendix A.
PAGE 186
Variable Name ID Storage Type Description SPOOLUNLOADSUBSTATE 54 U4 The current Spool State within the SPOOLUNLOAD super-state. 6 - Spool not full 7 - Spool full. TempNeedleCurrent 207 U2 This is the temperature at the needle heater. TempCurrent 205 List The actual temperatures for each heater zone in deg. C. See Appendix A for this list format. TempTimeOut 204 U2 The warning time limit in seconds for the heaters to heat the substrate to the desired temperature band.
PAGE 187
Data Variables Table 6-2 Variable Name Data Variables ID Storage Type ALARMTEXT 1000 A[0..40] ALARMSEVERITYCODE 1001 B[1] The Severity Code (the low order seven bits ) of the most recent alarm transition. BoardCycleTime 114 U2 The number of seconds required to complete dispensing an entire board of substrates. ConveyorSpeed 500 F4 The conveyor belt speed during board transfer between dispensing positions. The units are in./sec.
PAGE 188
Equipment Constants Table 6-3 Variable Name Equipment Constants ID Storage Type CONFIGALARMS 1 U1 This EC determines the type of alarm message which is sent following an alarm. 0 - S5F1, 1 S5F71, 2 - S5F73. CONFIGCONNECT 2 U1 The EC which determines which message type the Equipment uses for Connection Request.0 - S1F1, 1 - S1F65, 2 - S1F13 CONFIGEVENTS 3 U1 The EC which determines the choice of event report message. 0 - S6F9 or S6F3, 1 - S6F11 or S6F13.
PAGE 189
Variable Name ID Storage Type Description OFFLINESUBSTATE 42 U1 This variable determines the Control State that the Equipment enters when it enters the OffLine superstate. The allowable values are: 1 - Equipment Offline, 2 - Attempt Online, 3 - Host Offline. ONLINEFAILED 43 U1 This variable controls the entry state resulting from a failed attempt to go Online. The two values are: 1 - Equipment Offline, 3 - Host Offline.
PAGE 190
PAGE 191
7. Host to Equipment Messages The ** signifies FmNT primary message handlers. The * signifies FmNT secondary message handlers.
PAGE 192
Primary Reply Cstate S2F35 S2F36 4,5 Link Event Report None. Disk write occurs S2F37 S2F38 4,5 Enable/Disable Event Report None.
PAGE 193
Primary Reply Cstate S7F19 S7F20* 4,5 Description Process Program Directory Notes None Disk read occurs S10F3** S10F4 4,5 Terminal Display, Single Terminal display S10F5** S10F6 4,5 Terminal Display, Multiple Terminal display S10F9** S10F10 4,5 Broadcast Terminal display E Host to Equipment Messages 7-3
PAGE 194
PAGE 195
8. Equipment to Host Messages The ** signifies FmNT primary message handlers. The * signifies FmNT secondary message handlers.
PAGE 196
Primary Reply S6F13 S6F14 Description Annotated Event Report Send Notes GemNoteEvent Possible variable access routines N S7F1 S7F2 Process Program Inquire/Grant GemUFPPSend or GEMFPPSend S7F3 S7F4* Unformatted Process Program Send GemUFPPSend Disk Read occurs S7F5 S7F6 Unformatted Process Program Request GemUFPPLoad UFPPVerify Disk write occurs 8-2 S9F1 -- Error, Device ID None S9F3 -- Error, Stream None S9F5 -- Error, Function None S9F7 -- Error, Data None S9F9 -- Error
PAGE 197
9. Appendix A -- Data Dictionary Variables This is a summary explanation of the machine variables of section 7 sorted by ID number and containing details of the content of each variable. The data formats are as follows: A[nn] ASCII text of length nn. Where two numbers are indicated, they specify a range of acceptable lengths. Bool F4,F8 A boolean flag indicating TRUE or FALSE. A floating point number in four bytes. I1,I2,I4,I8 Signed integers of the indicated length in bytes.
PAGE 198
VID Class Format Name and Description 6 EC U2 ESTABLISHCOMMUNICATIONSTIMER. Time in seconds of how long the equipment will delay after an unsuccessful Connect Request before sending another. Valid values are 0-32000. 8 EC U1 INITCOMMSTATE. Initial (power-up) Communications State. 0 = Disabled 1 = Enabled 9 EC U1 INITCONTROLSTATE. Initial (power-up) control super-state. 1 = Off-Line 2 = On-Line 10 EC U2 HEARTBEAT.
PAGE 199
VID Class 24 SV Format List Name and Description ALARMSSET. A list of all Alarms which are currently in the SET (on) state. Format as follows: ... n. > 25 SV U1 ALARMSTATE. The Alarm State now in effect for the most recently transitioned alarm. 0 = Alarm transitioned OFF 1 = Alarm transitioned ON 26 SV U4 ALARMSERIAL. The sequence number of the most recent alarm change (going on or going off).
PAGE 200
VID Class Format Name and Description 34 SV A[0..9] PREVIOUSCOMMAND. The name of the most recent command. 35 SV U1 PREVIOUSCONTROLSTATE. The Control State in effect before the most recent transition to the current Control State. 1 = Off-Line/Equipment Off-Line 2 = Off-Line/Attempt On-Line 3 = Off-Line/Host Off-Line 4 = On-Line/Local 5 = On-Line/Remote 36 SV U1 PREVIOUSPROCESSSTATE. The Process State in effect before the most recent transition to the current Process State.
PAGE 201
VID Class Format Name and Description 40 DV A[0..12] PPCHANGENAME. PPID of the Process Program most recently created, changed, or deleted. This variable is the DOS 8.3 file name of the recipe changed. It includes the extension RCP. 41 DV U1 PPCHANGESTATUS. The action (create, change, delete) taken on a Process Program 1 = Created 2 = Changed 3 = Deleted 42 EC U1 OFFLINESUBSTATE. The default (power-up) offline substate of the Control State Model.
PAGE 202
VID Class 51 SV Format U4 Name and Description SPOOLLOADSUBSTATE. The current state within the SPOOL LOAD super-state. 6 = Spool Not Full 7 = Spool Full 52 SV A[16] SPOOLSTARTTIME. The date and time at which the first message was written to the current spool file. Format is: YYYYMMDDhhmmsscc. See description of CLOCK variable above for format details. 53 SV U4 SPOOLSTATE. The current spool state within the POWER ON super-state.
PAGE 203
VID Class Format Name and Description 102 SV A[30] MachineID. The machines Model number and Serial number. The MachineID format is: “Model SNXXXXX “. The Model field is fixed at twenty characters. The Serial Number field is fixed at ten characters and contains up to five characters in the serial number. Spaces pack any remaining space to the right of both fields. 103 SV A[30] PPDirectory. The directory path holding the Process Programs. The format is: “vol:\dir1[\dir2[\dir3]]”.
PAGE 204
VID Class Format Name and Description 300 SV A[12] FluidFileName1. This is the name of the file containing the dispensing fluid data for Valve1. The file extension is “.flu”. The DOS 8.3 file name format is used. There are up to eight characters reserved for the name and up to three characters for the extension. The name and extension are thus separated by a period: “name.ext”.
PAGE 205
VID Class 501 DV F4 ConveyorSpeed2. This is the Conveyor 2 belt speed in in./sec. when it is moving a board to the next dispensing position. 600 EC Bool PurgeEnabled1. This Boolean flag indicates whether periodic purging operations are enabled for Valve 1. 601 EC Bool MeasFlowEnabled1. This Boolean flag indicates whether periodic flow rate calibration operations are enabled for Valve 1. 602 EC Bool PurgeEnabled2.
PAGE 206
PAGE 207
10. Appendix B -- Collection Events The following collection events exist at the Equipment. Table 10-1 CEID Name CEID Description Note: 1 65 are standard GEM 1 ControlStateChange This event is triggered when there is a change in control state. 2 ProcessStateChange This event is triggered when there is a change in process state. 3 GemPPChangeEvent This event is triggered when the operator creates, changes, or deletes a process program.
PAGE 208
CEID Name Description 20 EqConstChange Sent to the Host when the operator changes an Equipment Constant. 21 S10Ack Sent to acknowledge the reception of a Host text message. 22 GemEquipmentOFFLINE Sent when Control State changes to Off-Line. 23 GemSpoolingActivated Sent when Equipment attempts to send a primary message to the Host and gets a transmit failure while Spooling is enabled. 24 GemSpoolingDeactivated Sent after the entire spool file has been read by the Host.
PAGE 209
CEID 3012 Name ConveyorCodeDownloaded2 Description A new conveyor control code has been downloaded into the Conveyor 2 controller. Setup 4001 PromptedSetupStarted An operator has initiated the Prompted Setup process. 4002 PromptedSetupCompleted The Prompted Setup Process is completed. 4003 FindNeedleXYZ An automatic needle XYZ calibration has been performed. 4004 ManualMeasureFlowRate1 A flow rate measurement for Valve 1 has been initiated by an operator.
PAGE 210
CEID Name Description 5010 PeriodicPurge2 A periodical purging of the needle for Valve 2 has been performed. 5011 PeriodicFlowrateMeasurement2 A periodical flow rate measurement for Valve 2 has been performed. 5012 PotLifeWarning2 The pot life of the dispensing material for Valve 2 has reached a warning level. 5013 PotLifeExpire2 The pot life of the dispensing material for Valve 2 has expired. Errors 9000 FmNTError An FmNT Error has occurred.
PAGE 211
11. Appendix C -- Alarms Table 11-1 ALID ALCD 2 3 3 ALTX Alarms Description ON CEID OFF CEID Temperature Low Current Temp < setpoint - band 63 62 3 Temperature High Current Temp > setpoint + band. 65 64 101 7 Interlock Open The Equipment door is open creating a safety hazard. 101 100 103 15 Dispenser Empty The adhesive dispenser needs refilling. 103 102 105 30 AC Power Loss The Equipment is stopped and the computer will fail in a few minutes if power is not restored.
PAGE 212