VG Scienta

EpiSoft - IGC3 Communications Handbook

IGC3 Communications Handbook

Release: 26th November 2006: Software versions up to 2.11

Copyright Notice 2007 by VG Scienta. All rights reserved. Information contained in this handbook is subject to change without notice and does not represent a commitment an the part of VG Scienta. No part of this document may be copied or distributed, transmitted, transcribed, stored in a retrieval system or translated into any human or computer language, in any from or by any means, electronic, mechanical, magnetic, optical, manual or otherwise or disclosed to third parties without the express written permission of VG Scienta, Maunsell Road, Castleham Industrial Estate, St. Leonard-on-Sea, East Sussex, TN38 9NN, UK

Page 1 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

User Handbook EpiSoft - IGC3 Communications Handbook Document Number UI7210 Change Control Issue Date (mm/yy) A 12/06 ECN# Original Issue

Page 2 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

1 2.

Introduction
1.1 2.1 2.2 2.3 2.4 2.5 About this handbook

4
4

Communication Hardware
Introduction to the Communications Hardware Setting up for RS232 or RS485 communications Configuration of the IGC3 Serial Connectors 9- and 25-pin PC RS232 to IGC3 Interface wiring IGC3 Daisy-chaining Why MODBUS? Parameters and Parameter Addresses MODBUS Implementation and Floating Point Data Transfer Digital Parameters Integers, Flags and the VALID flag The Invalid Data Value - FFFFFFFFh MODBUS Message Structure Frame Start Device Address First Byte Function Code 17h Second Byte The Data Package sent from host to the IGC3 Data Package response from the IGC3 Cyclic Redundancy Check: CRC Transmission Termination Error Response Transmission Rates

5
5 5 6 7 7

The MODBUS Interface

3.1 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15

8
8 8 8 9 9 9 9 10 10 10 11 11 13 13 13

4.
4.1 4.2

MODBUS Parameter Address Structure

IGC3 Parameter Address Structure Parameter Grouping

14
14 14

5.
5.1 5.2

IGC3 Parameter Addresses

Introduction Parameter List

15
15 15

Page 3 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

1
1.1

Introduction
About this handbook

This handbook describes serial communications with the IGC3 gauge controller using the MODBUS protocol (also conforms with JBUS protocol). Choice of MODBUS as the standard comms package for the IGC3 was dictated by its wide usage, efficiency of data transfer coupled with low processing overheads and the inherent integrity of data transfer. The key features of the IGC3 communications are:

RS232 and RS485 (3 wire) interfaces are provided as standard. [RS422 (5 wire) was also included in controllers using software version 1.xx.] RS232 interface is multi-drop, i.e. up to 8 devices can be connected to a standard computer RS232 port (though this may vary depending on computer chip set used). Up to 16 devices connected to an RS485 port. 2 RJ45/8 connectors are provided making for simple daisy chaining using industry standard moulded cables. The protocol is a fully compliant MODBUS implementation but incorporating floating point transfer of data. Implementation uses function code 17h, which allows data to be written to and read from the IGC3 within a single message, thus doubling data throughput. Parameters are organised in functional groups to allow optimised transfer of data.

Section Section Section Section Section

2 3 4 5 6

describes the interface hardware and wiring to the IGC3. provides an overview of MODBUS. describes the MODBUS parameter address implementation. lists the IGC3 Parameters provides a few examples.

Page 4 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

2. Communication Hardware
2.1 Introduction to the Communications Hardware

The rear of the IGC3 has 2x screened RJ45/8/8 connectors. These are internally connected in parallel to allow simple daisy chaining of multiple IGC3s. Each RJ45 has 8 pins. These provide everything required to implement RS232 or RS485 interfaces both are provided within the IGC3 as standard. Note:

IGC3 implements a multi-drop RS232 interface; that is a number of IGC3s can be connected to a standard RS232 port, such as that provided on a PC. Both interface types (RS232 and RS485) are active at all times; that is, the receive lines for both types are listened to continually, similarly, data is transmitted from both types. For this reason, it is important that only 1 interface type be connected at the host controller/PC. The following table summarises the main characteristics of the three buses: RS232 Single ended 3 wire: Ground, Transmit, Receive1 RS485 Differential 3 wire Ground, twisted pair shared for Transmit and Receive 1 master, 16 slaves2 1000metres More robust (noise immune) than RS232 Longer cable lengths than RS232 Requires only single twisted pair cable. Care to avoid communications conflicts Messages must be scheduled to avoid more than multiple device transmission

Transmission Signal Connection Scheme

Master/Slave configuration Max cable length Benefits

1 master, up to 8 slaves 12metres Simple, cheap to implement and wire.

Disadvantages

Prone to noise Short cable lengths

Notes: 1 The IGC3 RS232 interface uses only the Receive and Transmit lines (+ 0V). All handshaking must be correctly terminated at the PC. Although RS232 was initially defined for single master, single slave, the IGC3 supports up to 8 slaves per RS232 port, i.e. it should be possible to connect up to 8 IGC3s to a standard PC serial port. 2 RS485 was defined for use by multiple masters, multiple slaves. IGC3 implementation supports up to 16 slaves on an RS485 port but only 1 master (PC or host RS485 device) should be used. The MODBUS protocol operates in half-duplex mode, i.e. simultaneous transmission onto the bus by more than device (master or slave) is not permitted. 2.2 Setting up for RS232 or RS485 communications The following four things must be set prior to communicating with the IGC3 unit: Page 5 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

1. Base address(es). Each device on a bus has a unique address in the range 1 to 99. Addresses can be assigned to units on a bus in any order of daisy-chaining. 2. Bus type. All devices must be wired for the same bus type, RS232 or RS485. Both interfaces are active at all times; selection is implemented by the connections made to the controlling device (e.g. PC). 3. Baud rate. All devices MUST have the same Baud Rate. Scroll through the Setup menu to select. Recommended value: 19200. 4. Parity. All devices MUST ave the same Parity. Scroll through the Setup menu to select. Since the MODBUS protocol provides a high degree of message integrity, no parity is recommended. Note that the IGC3 uses: 1 start bit, 8 data bits, and 1 stop bits (plus parity bit if used). 2.3 Configuration of the IGC3 Serial Connectors

IGC3 provides RS232 and RS485 communications as standard via two parallel wired shielded RJ45 8pin connectors. The connectors are standard telephone types known as shielded RJ45 8/8. These have 8 pins and a shield contact that couples with screen of the cable: Plug and play solution to wiring using industry-standard connectors for data networking/communications Inexpensive, ready-made moulded cable assemblies are readily available from electrical/telecommunications suppliers Cable assemblies are available as UTP (unscreened) and FTP (screened). We strongly recommend use of the screened FPT variety, since they provide significant benefits in terms of noise exclusion. They are generally referred to as SHIELDED, Cat5e COMPLIANT, RJ45 PATCH LEADS.

Page 6 of 26

VG Scienta Pin assignments are as follows:

EpiSoft - IGC3 Communications Handbook

Pin Colour** 1 White/orange 2 Orange 3 White/Green 4 Blue 5 White/blue 6 Green 7 White/brown 8 Brown Shield ** May vary between cable manufacturers

Function RS232 0V (Earth) RS232 receive RS232 transmit RS485 0V return RS485 0V return RS485 0V return RS485 transmit A RS485 transmit B Earth

When daisy-chaining IGC3s, use standard SHIELDED, Cat5e COMPLIANT, RJ45 PATCH LEADS. Selection of which communications bus type (RS232 or RS485) is used depends on which wires are connected to the host PC/PLC. For example, if you are to drive several IGC3s from a standard PC port, only wires corresponding to pins 1, 2 and 3 will need to be connected at the PC see subsequent sections for more detail. Note that the RS485 0V return signal at pins 4, 5 and 6 are internally connected to earth via a 100 resistor to reduce the likelihood of earth loops when using the RS485 interface. 2.4 9- and 25-pin PC RS232 to IGC3 Interface wiring PC 9 pin Female DB9 pin 5 2 3 Link 7 and 8 Link 1, 4 and 6 Function Cable Function IGC3

PC 25 pin Female DB25 7 3 2 Link 4 and 5 Link 6, 8 and 20 NOTES: 1

Ground RxD TxD Disable handshaking Disable handshaking

Orange/White Green/White Orange -

Ground TxD RxD Disable Handshaking. -

1 3 2 Link 4 and 5 -

ALL UNUSED WIRES (INCLUDING THE SCREEN BRAID) NEED TO BE CAREFULLY

TERMINATED AND INSULATED WITHIN THE DB25 OR DB9 CONNECTOR. THE WIRES MUST NOT TOUCH EACH OTHER OR THE SCREEN, AND SHOULD BE INSULATED FROM THE COVER

2 3

THE CABLE SCREEN IS CONNECTED TO GROUND VIA THE RJ45 CONNECTOR HANDSHAKING MUST BE DISABLED BY LINKING AS INDICATED ABOVE

Suitable 3 metre cables for 9-pin and 25-pin PC serial ports is available from VG Scienta (part numbers ZIGDBC09 for 9-pin and ZIGDBC25 for 25-pin). 2.5 IGC3 Daisy-chaining

Provision of two RJ45 connectors provides for simple daisy chaining. Standard RJ45 8/8 cables of length 1m and 3m are available from VG Scienta (part numbers ZIGDCC01 for 1 metre and ZIGDCC03 for 3 metre). Alternatively, they are available from many computer stores see section 2.3 for specification and type.

Page 7 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

The MODBUS Interface

All aspects of IGC3 operation can be controlled from a host computer/PLC. The default communications protocol employed is MODBUS, conforming to class 0 of the Open MODBUS/TCP Specification (available from http://www.modicon.com/openmbus/standards/openmbus.htm). IGC3 uses function code 17h for enhanced data throughput and floating point transfer for data. 3.1

Why MODBUS? Industry standard and well documented Robust, reliable and compact. High reliability using CRC error detection Low computing/processing overheads Up to 16 parameters can be read and/or written within each message Implementation allows floating point data transfer for full resolution using simple casting, dramatically reduces programming overheads Enhancements for double speed throughput of data Implied length philosophy allows host and slave to verify message completion Parameters and Parameter Addresses

3.2

Data is held in a series of registers which have addresses starting at 0. These are referenced in hexadecimal notation with suffix h e.g. 000Ah (for address 10). Each register is a 16 bit quantity (a WORD comprising of two 8 bit BYTES). A WORD can therefore have a value between 0 and 216 (this corresponds to unipolar 0 65536, or bipolar 32767). Data values within the IGC3 (known as Parameters) are 32 bit in size, thus 2 registers are required to hold each Parameter value (complying with Appendix B.2 of the Open MODBUS/TCP Specification). This is because a WORD provides insufficient resolution to convey floating point numbers. To conform with the standard MODBUS protocol, IGC3 parameter addresses start at 0000h and have even values (0002h, 0004h, 0006h). IGC3 has 120 parameters, starting at address 0000h, ending with 00EEh. Note that the IGC3 checks that parameter addresses are within this range and are even. There are 3 types of IGC3 Parameters: Floating Point Parameters. Parameters at addresses 0090h to 00EEh are 32 bit floating point types see section 3.3. Integer Parameters. Parameters at addresses 0000h to 008Eh and 00EEh are 32 bit integer types. Flag Parameters. These are 32 bit integer types that are used to store flags or combinations of flags, for example, to indicate the status of a device. MODBUS Implementation and Floating Point Data Transfer

3.3

IGC3 relies for its data transfer on Multi-word Quantities (as defined in Appendix B.2 of the Open MODBUS/TCP Specification) in which any data structure is transmitted by casting it to an array of 16-bit WORDs. In the case of floating point data, this is transferred as a 32-bit floating point value i.e. as 2 WORDS or 4 BYTES per parameter. This approach: Allows the host computer to access data at high resolution Speeds communication. All parameter values take up just 4 BYTES irrespective of required resolution, offering significant advantages over ASCII data transfer Reduces processing overheads since casting is much faster and simpler conversion to and from ASCII

Page 8 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

The floating point data format used is the standard 32 bit floating point IEEE format, as employed in most high level languages such as C, BASIC, Pascal, SCADA etc. with the following bit allocations: SIGN Bit 31 EXPONENT Bit 30 to Bit 23 27 to 20 FRACTION Bit 22 to Bit 0 2-1 to 2-23

Conversion from the byte string to the floating point value is implemented by placing the string in memory and casting to the 32-bit float type. Note, some compilers may need the bytes to be swapped from low to high. 3.4 Digital Parameters Integers, Flags and the VALID flag

Digital parameters fall into 2 types. The first type store integer numerical data as a 32 bit number, for example, the degas time in minutes. The second type store status information, where groups of bits indicate the condition of a device (e.g. the ion gauge status parameter). To allow maximum rate of data transfer, some parameters hold several related pieces of information. To avoid problems where only one piece of information needs to be written to change it without the need to have read all information, for each group of bits associated with a status condition, the uppermost bit is used as a validation bit i.e. it is always set during a read operation to indicate that it is valid, and must be set if the specific set of flags are to be changed during a write operation. This approach means that only the setting required for the particular piece of information needs be transmitted (with its validation bit set). For example, to change the emission for the ion gauge to 1mA without affecting any of the other status information for the ion gauge setting parameter, set the IGS_EM_VALID bit (00000080h) and the IGS_EM_1mA bit (00000004h); thus the value sent to this parameter is 00000084h. 3.5 The Invalid Data Value - FFFFFFFFh

As discussed, MODBUS allows multiple parameters to be read/written within a single message. However, it is often useful when sending data for configuous parameters to instruct IGC3 to ignore one or more parameter values, i.e. not change them. Setting the parameter value to FFFFFFFFh within the message is interpreted by IGC3 that the parameter value is not to be modified. This avoids the need for prior knowledge of the value. Note therefore that no parameter can have a value of FFFFFFFFh. 3.6 MODBUS Message Structure

A standard MODBUS message (often referred to as a Frame) comprises the following components:

Frame start
(3.5 bytes)

Device Address
1 byte Range 1-99

Function Code
1 byte 17h

Data Package n bytes

CRC
2 bytes

End Indicator
(3.5 bytes)

The host initialises communications by sending a frame setting and/or requesting data. The IGC3 responds; the IGC3 CANNOT initialise a message. 3.7 Frame Start

Page 9 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

Frame Start is a period of bus inactivity of at least 3.5 times the time needed to transmit a single character. For example, at 9600 baud, and character transfer comprising 1 start bit, 8 data bits, 2 stop bits, the Frame Start period would be >=3.5ms.
3.8 Device Address First Byte

Since several devices share the bus, each device MUST have a unique identifying address. The Device Address is a one BYTE value and has a range between 1 and 99. The IGC3 does NOT implement or use the broadcast address (0) when all units must perform a given action. 3.9 Function Code 17h Second Byte

IGC3 only uses function code 17h which allows the host to write AND read up to 16 parameters within a single communication exchange. Data does not have to be transferred at every communications exchange. All other function codes are ignored by IGC3. 3.10 The Data Package sent from host to the IGC3

The first 4 BYTES of the data package related to function code 17h indicates the address of the first parameter to be read (2 BYTES where the first BYTE is always 00h) followed by the number of WORDS to read. Since up to 16 parameters can be read at a time, and each parameter is 32 bits (2 WORDS), the 3rd BYTE is always 00h and the 4th BYTE is always even and has a value between 0 and 32. To summarise:

Parameter Address of first WORD

MSB LSB

Number of WORDs to read

MSB LSB

The next 5 BYTES specify what data is to be written, and these are followed by the data. BYTES 5 and 6 set the parameter address of the first parameter to be written (BYTE 5 is always 00h), and BYTES 7 and 8 the number of WORDS to be written. Since up to 16 parameters can be written at a time, and each parameter is 32 bit (2 WORDS), the 7th BYTE is always 00h and the 8th BYTE is always even and has a value between 0 and 32. The 9th BYTE is the number of BYTES to be written and is thus always twice the value of the 8th BYTE. Finally, the data bytes to be written are appended to the data package. To summarise:

Parameter Address of first WORD

MSB LSB

Number of WORDs to write

MSB LSB

Number of data BYTES (n)

1 BYTE

Data

n BYTES

Note that this structure provides for simple diagnostics of the data package length which will always be: 9 + (4xnumber of parameters to be written). Example 1: Read 3 parameters starting at parameter 003Eh from the IGC3: The data package would comprise the following sequence: 00h 3Eh 2 bytes indicating the address of the first parameter to be read 00h 06h 2 bytes indicating the number of WORDS to read (2 WORDS per parameter therefore 6 WORDS) 00h 00h 00h 00h 00h 10 bytes indicating that there are NO parameters to be written The data package comprises 9 BYTES and the message is 13 BYTES. Example 2: Write 1 parameter starting at parameter 0004h to the IGC3:

Page 10 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

The data package comprises the following sequence: 00h 00h 00h 00h 4 BYTES indicating that no WORDS to read 00h 01h 2 BYTES indicating the address of the first parameter that will be written to 00h 02h 2 BYTES indicating the number of WORDS to write (1 parameter, therefore 2 WORDS) 04h 1 BYTE indicating that 4 bytes (i.e. 1 parameter == 2 WORDS == 4 BYTES) 02h 82h 84h 42h 4 BYTES of data The data package comprises 9+(4x1)=13 BYTES and the message is 17 BYTES. Example 3: Read 3 parameters starting at parameter 003Eh from the IGC3 AND Write 1 parameter starting at parameter 0004h to the IGC3: The data package would comprise the following sequence: 00h 3Eh 2 bytes indicating the address of the first parameter to be read 00h 06h 2 bytes indicating the number of WORDS to read (2 WORDS per parameter therefore 6 WORDS) 00h 01h 2 BYTES indicating the address of the first parameter that will be written to 00h 02h 2 BYTES indicating the number of WORDS to write (1 parameter, therefore 2 WORDS) 04h 1 BYTE indicating that 4 bytes (i.e. 1 parameter == 2 WORDS == 4 BYTES) 02h 82h 84h 42h 4 BYTES of data The data package length is 9+(4x1)=13 BYTES and the message is 17 BYTES. 3.11 Data Package response from the IGC3

On receipt of a valid message requesting data, the IGC3 responds with a frame containing a data package comprising of:

Number of data BYTES read (n)

1 BYTE

Data

n BYTES

Since parameters require 4 BYTES, the number of BYTES read will have a value of 0 (if no data requested), 4, 8 64; the data package size will be 1 (no data), 5, 9. 65 BYTES. 3.12 Cyclic Redundancy Check: CRC

The CRC detects transmission errors, offering 100% detection for single-, double- and odd-numbered bit errors, 100% on burst errors of 16 bits or less and >>99.9969% detection on burst errors in excess of 16 bits. The 2 byte CRC is appended to the end a frame. If a IGC3 fails to verify a CRC, no reply is sent. The CRC is performed on all bytes of the messages, namely the address, function code and all data bytes. The sequence is: 1. 2. 3. 4. 5. 6. 7. 8. Create a 16 bit CRC register and load with FFFFh. Exclusive OR the first byte with the CRC register. Shift the CRC register one bit to the right. If the over-flow bit is set, exclusive OR the CRC register with A001h. If not, no operation. Repeat 3 and 4 until 8 shifts have been performed. Repeat steps 2 to 6 until all bytes have been exclusive ORed and shifted 8 times. Append the lower BYTE of the CRC register to the message Append the upper BYTE of the CRC register to the message. The following shows a C code function for generating the CRC: // Generates crc check bytes and places these in lpCRC Page 11 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

// The initial message is pointed to by lpMess and the total message // length (including address and function code bytes) are indicated // in nMessLen int zet_calc_modbuscrc (unsigned char* lpMess, int nMessLen, unsigned char* lpCRC) { int j; unsigned int wCarry, wNext, wCRC; // Initialise the CRC register wCRC = 0xFFFF; while (nMessLen--) { // Cast the byte to a 16 bit value wNext = (unsigned short)lpMess; // Exclusive OR it with the CRC register wCRC ^= wNext; // Shift loop 8 times for (j=0; j<8; j++) { // Save bottom bit wCarry = wCRC & 0x0001; // Shift CRC register to the right by 1 bit wCRC >>= 1; // If the saved bottom bit was set, EXOR with A001h if (wCarry) wCRC ^= 0xA001; } // Next byte lpMess++; } // Set upper byte of CRC register to second CRC byte lpCRC[1] = (unsigned char)(wCRC >> 8); // Set the low byte of the CRC register to the first CRC byte lpCRC[0] = (unsigned char)(wCRC); // Return the number of extra bytes return 2; } As an example of using such a function, to append the CRC to a message: unsigned char int sMess[128]; // buffer for the message nMessLen; // Stores the message length so far

Code to generate the message nMessLen += zet_calc_modbuscrc(sMess, nMessLen, &sMess[nMessLen]); // The nMessLen parameter will have been extended by 2 to indicate // addition of 2 bytes Send the message To use the function to verify a CRC message unsigned char unsigned char int sMess[128]; // buffer for sCRC[2]; // buffer for nMessLen; // Stores the // (including the message the CRC message length received the returned CRC)

Read the message/ Perform any checks (such as function code, length etc.) Page 12 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

zet_calc_modbuscrc(sMess, nMessLen-2, sCRC); // Note use of nMessLen-2 since we do not want to include // received back CRC in the CRC generation process if ((sMess[nMessLen-2] == sCRC[0]) && (sMess[nMessLen-1] == sCRC[1])) { // SUCCESS!!!! } else { // ERROR PROCESSING!!!! } 3.13 Transmission Termination

A message is terminated by inactivity on the bus for a period >3.5 times the time taken to transmit 1 character (i.e. the frame start delay) after which the slave interprets the message. The structure of the MODBUS protocol allows the number of BYTES in a response to be predicted; this serves to receipt of a correct or error response. The frame start/end delay also tells the slave that the next BYTE to arrive will be an address commencing the next frame. 3.14 Error Response

A device will only respond if its address and a valid function code are received after the frame start period, and the CRC value is verified, otherwise no response is given. If an error is detected in the data section, it will respond with an error code:

Device Address
1 BYTE

Function Code + 80h

97h

Error Code
01h or 02h MSB

CRC
LSB

As an indication that an error response is arriving, the most significant bit in the function code byte is set making 17h into 97h. The error code values are:

Code
01h 02h 3.15

Description
Invalid Function Code, i.e. function code BYTE was NOT 17h Invalid Parameter Address or Value Transmission Rates

A number of factors influence the rates at which messages can be transmitted: The Latency Time is the period taken by the slave to respond to a message and depends on the level of processor activity at the time of termination of the incoming message. For the IGC3, this time is typically 25ms, but may extend up to 300ms The time it takes to transmit the message, which depends on the baud rate, and the length of the master and slave frames. For example, to read 1 parameter will require a 13 BYTE message from the master and a 9 BYTE response - at 9600 baud = ~29msecs. The above implies that continuous polling of data is not required to read the message and because of the MODBUS structure, the response length can be predicted. In addition, a time-out period needs to be established to determine a noresponse condition. A period of no less than 300ms is recommended.

Page 13 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

4. MODBUS Parameter Address Structure

4.1

IGC3 Parameter Address Structure ALL IGC3 PARAMETERS, BOTH FLOATING POINT AND INTEGER, ARE 32 BIT; 2 WORDS (4 BYTES) ARE REQUIRED FOR TRANSMISSION OF EACH PARAMETER ALL PARAMETER ADDRESSES ARE EVEN FLOATING POINT PARAMETERS START AT ADDRESS 0090h INTEGER PARAMETERS ARE LOCATED BELOW ADDRESS 0090h Parameter Grouping

4.2

IGC3 stores related parameters at adjacent addresses so that data relating to a functional group can be accessed within a single message. When writing parameter values to the IGC3, if one or more of the values is not to be changed, then the parameter values that are not to be changed can be set to the Invalid Data Value FFFFFFFFh. For example, to change only the bake-out temperatures at steps 1 and 4 whilst sending a parameter sequence covering temperatures 1 to 4, the parameter values for steps 2 and 3 should be set to FFFFFFFFh.

Page 14 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

5. IGC3 Parameter Addresses

5.1 Introduction This section lists the complete parameter address list for the IGC3. Note: There are 120 parameters with address of 00h, 02h, 04h EEh. Note that not all parameters are used. The parameters are treated as 15 groups of 8 parameters. Each group represents either related parameters, or a functional group. Parameters 00h to 8Eh inclusive are 32 bit (4 BYTE) integer parameters. Parameters 90h to EEh inclusive are 32 bit floating point parameters. The most frequently required parameters have intentionally been grouped together (starting at 0x80 and finishing at 9Eh) so that they can be read within a single message. Parameter List The following table lists and describes the parameters in detail: Parameter Address gives the decimal and hexadecimal value of the parameter address; e.g. 42 2Ah means that the parameter at address 42 (2Ah) is the measured value. Parameter Name relates the parameter to the internal function see IGC3 Handbook for details. Type indicates whether the parameter is a 32 bit integer or a 32 bit floating point value. R/W indicates the Read and Write status. Parameters marked R can be read only. Parameters marked as R/W can be read from AND written to. Note that unassigned parameters can be used by the programmer to store temporary data. Description provides a detailed breakdown of the parameter function. Please refer to the IGC3 Operators Handbook for detailed information.

5.2

Page 15 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

Parameter Address GROUP 1 0 00h 2 02h 4 04h 6 06h 8 08h 10 0Ah 12 0Ch 14 0Eh GROUP 2 16 10h

Parameter Name Unit ID Software Version [Unassigned] [Unassigned] Communications [Internal] [Unassigned] [Unassigned] Unit Name

Type

R/W

Description

32 bit integer 32 bit integer 32 32 32 32 32 32 bit bit bit bit bit bit integer integer integer integer integer integer

R R R R R R R R R/W

Returns a value of 69435650h. [ASCII representation of IGC3]. Returns a value of 0x4544xxyyh, where xx is major version, and yy is sub-version; e.g. 45440206h indicates version 2.06

For internal use only. Holds information about comms address, settings, protocol etc.

32 bit integer
representing 4 ASCII characters

18 12h 20 14h 22 16h 24 18h 26 1Ah 28 1Ch

User ID [Unassigned] [Unassigned] Degas Ramp Time Degas Time Degas Power

32 32 32 32

bit bit bit bit

integer integer integer integer

R/W R/W R/W R/W R/W R/W

A name of up to 4 characters can be assigned to each channel. The order of the characters is DDCCBBAAh where AA is the first character in the name, BB the next etc. Valid characters are in the range 20h (space) to 7Ah (z) inclusive. Any characters outside this range will be changed to 20h (space). Any spaces at the start of the name are removed so that the name starts with a character in the range 21h to 7Ah. Example: the name Si would be 20206953h. User defined identifier. Can be used, for example, to automatically configure or identify specific units with a software object.

0 to 999 minutes. Duration of Degas power rise 0 to 999 minutes. Duration of Degas. Ultimate degas power reached at end of degas ramp time; power applied during the degas time or if Quick degas is initialised. Values are: IGS_EM_1W (08h), IGS_EM_2W (09h), IGS_EM_3W (0Ah), IGS_EM_6W (0Bh), IGS_EM_12W (0Ch), IGS_EM_20W (0Dh), IGS_EM_30W (0Eh).

32 bit integer 32 bit integer

30 1E GROUP 3 32 20h 34 22h 36 24h 38 26h

[Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned]

32 bit integer 32 32 32 32 bit bit bit bit integer integer integer integer

R/W R/W R/W R/W R/W

Page 16 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

Parameter Address 40 28h 42 2Ah 44 2Ch 46 2Eh GROUP 4 48 30h 50 32h 52 34h 54 36h 56 38h 58 3Ah 60 3Ch 62 3Eh GROUP 5 64 40h

Parameter Name [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] Global Settings

Type 32 32 32 32 32 32 32 32 32 32 32 32 bit bit bit bit bit bit bit bit bit bit bit bit integer integer integer integer integer integer integer integer integer integer integer integer

R/W
R/W R/W R/W R/W R/W R/W R/W R/W R/W R/W R/W R/W

Description

32 bit integer

R/W

R/W

R/W

R/W

R/W

66 42h

Slot A

32 bit integer

GLOBAL FLAGS Bits F0000000h Display setting. Selects what IGC3 display shows on front panel. GS_DISPLAY_VALID (80000000h). Must be set to write value. Bits 30000000h indicate the display type: GS_DISPLAY_SUMMARY (00000000h) default ion gauge display, GS_DISPLAY _SLOTS (10000000h) summary value for the 2 slots, GS_DISPLAY _BAKEOUT (20000000h) bake-out status, GS_DISPLAY _TIMER (30000000h) timer status Bits 00F00000h Display Brightness GS_BRIGHTNESS_VALID (00800000h) Must be set to write value. Bits 00300000h indicate the brightness level: GS_BRIGHTNESS _25 (00000000h) default 25%, GS_BRIGHTNESS _50 (00100000h) 50%, GS_BRIGHTNESS _75 (00200000h) 75%, GS_BRIGHTNESS _100 (00300000h) 100% Bits 00000F00h Ion gauge degas start-up protection GS_IGDEGAS_VALID (00000800h) Must be set to write value. Bit 00000100h indicates whether protection is on or off: GS_IGDEGAS _ON (00000100h) protect is on Bits 000000F0h Pressure Units GS_UNITS_VALID (00000080h) Must be set to write value. Bits 00000030h select units: GS_UNITS _MBAR (00000000h) default mBar, GS_UNITS _TORR (00000010h) Torr, GS_UNITS _PASCAL (00000020h) Pascal Bits 0000000Fh Ion gauge pressure display resolution GS_IGDPS_VALID (00000008h) Must be set to write value Bit 00000001h selects number of decimal places: _1 (00000000h) default 1 decimal place, _2 (00000001h) 2 decimal places TYPE OF MODULE IN SLOT A Bits 000000FFh Module type

Page 17 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

Parameter Address

Parameter Name

Type

R/W

Description
TYPE_VALID (00000080h) TYPE _EMPTY (00000000h) default no module fitted, TYPE _PIRANI (00000001h) VG Pirani gauge head, TYPE _TC (00000002h) thermocouple module TYPE OF MODULE IN SLOT B See Slot A PUMP-DOWN SETTINGS Bits 00F00000h Start/Stop Pump Down PDF_SS_VALID (00800000h) Must be set to write value. PDF_SS_START (00100000h) start pump down PDF_SS_STOP (00200000h) stops pump down Bits 0000F000h Digital Inputs assignment PDF_DI_VALID (00008000h) Must be set to write value. Bits 00003000h set which digital inputs interlock Pump-down: PDF_DI_1 (00001000h) digital input 1 interlocks pump down, PDF_DI_2 (00002000h) digital input 2 interlocks pump down (Note: both can be set) Bits 00000FF0h Internally used for status indication PDF_VALID (00000800h) always set Remaining bits are set in combination as pump-down progresses: PDF_PUMPDOWN (00000010h) pump down started, PDF_INITED (00000020) initialisation flag, PDF_INDELAY (00000040h) in delay time, PDF_IGSTART (00000080h) attempting to start the ion gauge, PDF_DIINHIBITED (00000100h) pump down inhibited by one or both digital inputs Bits 0000000Fh Attempt count The number of attempts made to start the ion gauge (value between 0 and 9)

68 44h 70 46h

Slot B PDFlags

32 bit integer 32 bit integer

R/W

R/W

[see also PD IG Start Pressure, PD IG Delay, PD IG Attempts]

72 48h

BO Flags

32 bit integer

R/W

R/W

R/W

R/W

BAKE-OUT FLAGS Bits 0F000000h Auto-degas at end of bake-out BOF_DG_VALID (08000000h) Must be set to write value BOF_DG_ON (01000000h) auto-degas on at end of bake-out Bits 00F00000h Action of assigned digital inputs on Bake-out BOF_DIS_VALID (00800000h) Must be set to write value Bits 00300000h select action: BOF_DIS_NORMAL (00000000h) default: output is off if assigned digital inputs fail, BOF_DIS_SUSPEND (00100000h) as normal but bake-out timer also stops, BOF_DIS_TERMINATE (00200000h) bake-out terminates if assigned digital inputs fail. Bits 000F0000h Action of ion gauge pressure on Bake-out BOF_IGS_VALID (00080000h) Must be set to write value Bits 00030000h select action: BOF_IGS_NORMAL (00000000h) default: output is off if ion gauge pressures rises above Pressure Limit parameter value, BOF_IGS_SUSPEND (00010000h) as normal but bake-out timer also stops, BOF_IGS_TERMINATE (00020000h) bake-out terminates if pressure rises above Pressure Limit parameter value. Bits 0000F000h Digital Input assignment BOF_DI_VALID (00008000h) Must be set to write value BOF_DI_1 (00001000h) assigns digital input 1, BOF_DI_2 (00002000h) assigns digital input 2. [Both can be assigned].

Page 18 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

Parameter Address

Parameter Name

Type

R/W

Description
Bits 00000F00 Start/Stop Bake-Out BOF_SS_VALID (00000800h) Must be set to write value BOF_SS_START (00000100h) starts bake-out, BOF_SS_STOP (00000200h) stops bake-out Bits 000000FFh Status Information BOF_VALID (00000080h) Always set Remaining bits are set in combinations to reflect status: BOF_BAKE_OUT (00000001h) bake-out started, BOF_DIINHIBITED (00000002h) bake-out is inhibited by assigned digital inputs, BOF_IGINHIBITED (00000004h) bake-out is inhibited by ion gauge pressure, BOF_SUSPENDED (00000008h) bakeout is suspended, BOF_ON (00000010h) bake-out output is on.

R/W

[See also BO Step temperatures 1-6, BO Step times 1-6, BO IG Pressure Limit, BO Hysteresis]

74 4Ah

Timer Flags

32 bit integer

R/W

R/W

TIMER FLAGS Bits F0000000h Restart Start/Stop Periods TMR_START_VALID (80000000h) Must be set to write value TMR_START_OFF (10000000h) Restart timer at beginning of OFF period, TMR_START_ON (20000000h) Restart timer at beginning of ON period Bits 0000F000h Digital Input assignment TMR_DI_VALID (00008000h) Must be set to write value. Bits 00003000h set which digital inputs interlock timer operation: TMR_DI_1 (00001000h) digital input 1 interlocks timer, TMR_DI_2 (00002000h) digital input 2 interlocks timer (Note: both can be set) Bits 0000000Fh Timer Status TMR_VALID (00000008h) always set Remaining bits are set in combinations to reflect status: TMR_ON (00000001h) timer is in ON period, TMR_DIINHIBITED (00000002h) timer is inhibited by assigned digital inputs, TMR_IGINHIBITED (00000004h) timer is inhibited by ion gauge pressure

[See also Timer OFF Duration, Timer ON Duration, Timer IG Pressure Limit]

76 4Ch

Digital Input 1 Flags

32 bit integer

R/W

DIGITAL INPUT 1 FLAGS Bits 0000000Fh DI_STATUS_VALID (00000008h) Must be set to write value DI_STATUS_ON (00000001h) Digital input 1 is on (read only bit), DI_STATUS_INHIBIT (00000002h) Inhibit digital input 1, DI_STATUS_OVERRIDE (00000004h) Override Digital input 1

[See also Digital Input 1-2 Status Summary]

78 4Eh GROUP 6 80 50h

Digital Input 2 Flags Trip1 Flags

32 bit integer

R/W

DIGITAL INPUT 2 FLAGS See Digital Input 1 flags for bit assignments

32 bit integer

R/W

TRIP 1 FLAGS Bits 000F0000h Operation of Trip 1 during Degas (version 2.0 and above only) DO_DEGAS_VALID (00080000h) Must be set to write value DO_DEGAS_TRIP (00010000h) Trip 1 operates during degas in same way as for normal emission operation. If this flag is set, trip 0 fails when degas is started

Page 19 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

Parameter Address

Parameter Name

Type

R/W
R/W

Description
Bits 0000F000h Trip 1 assignment DO_ASSIGN_VALID (00008000h) Must be set to write value The remaining 3 bits indicate what trip 1 is assigned to: DO_ASSIGN_NONE (00000000h) no assignment, DO_ASSIGN_IG (00001000h) ion gauge, DO_ASSIGN_SLOT A (00002000h) Slot A value, DO_ASSIGN_SLOTB (00003000h) Slot B value, DO_ASSIGN_PUMPDOWN (00004000h) trip 1 is set whilst pump down is operating, DO_ASSIGN_BAKE_OUT (00005000h) trip 1 operates with the on/off state of the bake-out, DO_ASSIGN_TIMER (00006000h) trip 1 state is determined by the on/off status of the timer, DO_ASSIGN_DEGAS (00007000h) trip 1 is set to on during degas. Bits 00000F00h Trip 1 direction DO_ACTION_VALID (00000800h) Must be set to write value. DO_ACTION_GREATERTHAN (00000100h) Trip 1 is on when the controlling value exceeds the Trip 1 Level parameter value. If this bit is not set, Trip 1 is on when the controlling value is less than the Trip 1 Level parameter value. Bits 0000000Fh Trip 1 state DO_STATUS_VALID (00000008h) Must be set to write value DO_STATUS_ON (00000001h) Trip 1 is on (read only bit), DO_STATUS_INHIBIT (00000002h) Inhibit trip 1, DO_STATUS_OVERRIDE (00000004h) Override Trip 1

R/W

R/W

[See also Global Settings (for ion gauge degas protect), Trip 1 Level, Trip Hysteresis, Trip 1-7 Status Summary]

82 52h 84 54h 86 56h 88 58h 90 5A 92 5C 94 5E

Trip 2 Flags Trip 3 Flags Trip 4 Flags Trip 5 Flags Trip 6 Flags Trip 7 Flags D/A Flags

32 bit integer 32 bit integer 32 bit integer 32 bit integer 32 bit integer 32 bit integer 32 bit integer

R/W R/W R/W R/W R/W R/W R/W

TRIP 2 FLAGS See Trip 1 Flags for all bit assignments TRIP 3 FLAGS See Trip 1 Flags for all bit assignments TRIP 4 FLAGS See Trip 1 Flags for all bit assignments TRIP 5 FLAGS See Trip 1 Flags for all bit assignments TRIP 6 FLAGS See Trip 1 Flags for all bit assignments TRIP 7 FLAGS See Trip 1 Flags for all bit assignments DIGITAL/ANALOGUE CONVERTER SETTINGS Bits 00000F00h Linear/logarithmic response DA_FUNC_VALID (00000800h) Must be set to write DA_FUNC_LIN (00000100h) sets output to linear relationship. Default is logarithmic (as generally used with pressure assignment) Bits 0000000Fh D/A Assignment DA_SET_VALID (00000008h) Must be set to write Remaining 3 bits select one of the following assignments: DA_SET_MIN (00000000h) output is permanently at D/A Min value parameter, DA_SET_IG (00000001h) assigned to ion gauge, DA_SET_SLOTA (00000002h) assigned to slot A, AD_SET_SLOTB (00000003h) assigned to slot B, AD_SET_IGSLOTA (00000004h) assignment moves from ion gauge when

Page 20 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

Parameter Address

Parameter Name

Type

R/W

Description
ion gauge is on to module in Slot A (usually Pirani) when ion gauge is off thus potentially providing coverage from atmosphere to UHV, DA_SET_EXTERNAL (00000005) output corresponds to value set over comms to parameter D/A output, DA_SET_HZ (00000006) output toggles between D/A min and D/A max value at frequency of ~2Hz, DA_SET_MAX (00000007) output fixed at D/A max value

GROUP 7 96 60h

Minimum IG Emission

32 bit integer

R/W

98 62h

Maximum IG Emission

32 bit integer

R/W

MINIMUM ION GAUGE EMISSION Bits 000000FFh IGS_EM_VALID (00000080h) Must be set to write Possible values are: IGS_EM_100uA (00000001h), IGS_EM_200uA (00000002h), IGS_EM_500uA (00000003h), IGS_EM_1mA (00000004h), IGS_EM_2mA (00000005h), IGS_EM_5mA (00000006h), IGS_EM_10mA (00000007h). Range is IGS_EM_100uA to the Maximum IG emission MAXIMUM ION GAUGE EMISSION Bits 000000FFh IGS_EM_VALID (00000080h) Must be set to write Possible values are: IGS_EM_100uA (00000001h), IGS_EM_200uA (00000002h), IGS_EM_500uA (00000003h), IGS_EM_1mA (00000004h), IGS_EM_2mA (00000005h), IGS_EM_5mA (00000006h), IGS_EM_10mA (00000007h). Range is Minimum IG emission to IGS_EM_10mA

100 64h 102 66h 104 68h 106 6Ah 108 6Ch 110 6Eh GROUP 8 112 70h 114 72h 116 74h 118 76h 120 78h 122 7Ah 124 7Ch 126 7Eh GROUP 9 128 80h

[Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] [Unassigned] Trip 1-7 Status

32 32 32 32 32 32 32 32 32 32 32 32 32 32

bit bit bit bit bit bit bit bit bit bit bit bit bit bit

integer integer integer integer integer integer integer integer integer integer integer integer integer integer

R/W R/W R/W R/W R/W R/W R/W R/W R/W R/W R/W R/W R/W R/W R SUMMARY OF STATUS OF ALL 7 TRIPS

32 bit integer

Page 21 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

Parameter Address

Parameter Name Summary

Type

R/W

Description
Each group of 4 bits summarises the status of one of the trips. 0000000Fh for trip 1, 000000F0h for trip 2 etc In each case: DOx_VALID (8h) always set, DOx_ON (1h) set when the trip is on, DOx_INHIBIT (2h) set in inhibit, DOx_OVERRIDE (4h) set in override. (Note: DOx_ON always set if DOx_OVERRIDE is set.)

[See also Global Settings (for ion gauge degas protect), Trip 1 Level, Trip Hysteresis, Trip 1 Flags Trip 7 Flags]

130 82h

Digital Input 1-2 Status Summary

32 bit integer

SUMMARY OF STATUS OF BOTH DIGITAL INPUTS Bottom 2 groups of 4 bits indicate the status of the digital inputs. 0000000Fh for DI 1 and 000000F0h for DI 2 In each case: DIx_VALID (8h) always set, DIx_ON (1h) set when input is on, DIx_INHIBIT (2h) set to inhibit, DIx_OVERRIDE (4h) set in override. (Note: DIx_ON always set if DIx_OVERRIDE is set.)

[See also Digital Input 1 and Digital Input 2 Flags]

132 84h 134 86h 136 88h

Slot A Status Slot B Status Ion Gauge Status

32 bit integer 32 bit integer 32 bit integer

R/W R/W

Reserved for future implementation Reserved for future implementation STATUS OF ION GAUGE This parameter reports status of ion gauge. Note that parameters that can be

changed are written to through the Ion Gauge Settings parameter (8Eh).
R Bits FF000000h Ion Gauge Operating Status/Failure Mode IGS_OP_VALID (80000000h) Remaining bits indicate the failure mode: IGS_OP_DIFAIL (20000000h) digital input fail, IGS_OP_OVERP (10000000h) overpressure fail, IGS_OP_EMFAIL (08000000h) emission failed, IGS_OP _INTERLOCKTRIP (04000000h) ion gauge lead interlock not made, IGS_OP _EMTRIP (02000000h) emission tripped, IGS_OP _FILTRIP (01000000h), filament over-current trip Bits 00F00000h Filament Type IGS_FILTYPE_VALID (00800000h). Must be set to write the value. [Cannot be set if ion gauge is on]. IGS_FILTYPE _W (00100000h) Tungsten. If this bit is not set, Iridium Bits 000F0000 Filament Number IGS_FILNUM_VALID (00080000h). Must be set to write the value. [Cannot be set if ion gauge is on]. IGS_FILNUM _2 (00010000h) Filament 2. If this bit is not set, filament 1 Bits 0000F000 Measurement error IGS_IND_VALID (00008000) IGS_IND_MINLIMIT (00004000h) if electrometer input below measurement limit (e.g. collector lead disconnected) Bits 00000F00 Ion gauge pressure trend IGS_TREND_VALID (00000800) IGS_TREND_UP (00000100) pressure is rising. IGS_TREND_DOWN (00000200) pressure is falling Bits 000000FF Current ion gauge emission/degas setting IGS_EM_VALID (000000FFh). Always set The emission/degas status of the ion gauge is set via one of the following: IGS_EM_OFF (00000000h), IGS_EM_100uA (00000001h), IGS_EM_200uA (00000002h), IGS_EM_500uA (00000003h), IGS_EM_1mA (00000004h), IGS_EM_2mA (00000005h) , IGS_EM_5mA (00000006h), IGS_EM_10mA (00000007h),

Page 22 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

Parameter Address

Parameter Name

Type

R/W

Description
IGS_EM_1W (00000008h), IGS_EM_2W (00000009h), IGS_EM_3W (0000000Ah) , IGS_EM_6W (0000000Bh) , IGS_EM_12W (0000000Ch), IGS_EM_20W (0000000Dh), IGS_EM_30W (0000000Eh). The above values are ORed with: IGS_EM_AUTO (00000040h) if the ion gauge is being run in auto-emission mode where the value indicates the current emission value, or IGS_EM_QUICKDEGAS (00000010h) during quick degas where the value indicates the power.

[See also Ion Gauge Settings: 8Eh]

138 8Ah

Fan Status

32 bit integer

R/W

140 8Ch

Ion Gauge Settings Extended

32 bit integer

R/W

142 8Eh

Ion Gauge Settings

32 bit integer
R/W

FAN STATUS Bits 0000000Fh Fan Status FAN_VALID (00000008h) always set FAN_ERROR (00000001h) Fan error has occured FAN_ON (00000002h) Fan is running EXTENDED ION GAUGE SETTINGS Bits 0000000Fh Digital Input 1 action on ion gauge operation IGSX_DI1_VALID (00000008h) Must be set to write value The remaining 3 bits set the action: IGSX_DI1_NONE (00000000h) no assignment, IGSX_DI1_INTERLOCK (00000001h) gauge trips if DI1 fails, IGSX_DI1_EMON (00000002h) ion gauge is on whilst DI1 is on, IGSX_DI1_EMTOGGLE (00000003h) ion gauge turns on/off in response to a short pulse applied to DI1, IGSX_DI1_DEGASON (00000004h) ion gauge degas operates whilst the digital input is on, IGSX_DI1_DEGAS (00000005h) degas starts/stops in response to a short pulse applied to DI1. Bits 000000F0h Digital Input 2 action on ion gauge operation These bits mirror the above operation but for digital input 2. Flags are IGSX_DI2_xxxxx and bits are shifted up 4 ION GAUGE SETTINGS This parameter sets changes to the ion gauge. To obtain latest status information

about the ion gauge, use the Ion Gauge Status Parameter (88h)
Bits 00F00000h Filament Type IGS_FILTYPE_VALID (00800000h). Must be set to write the value. [Cannot be set if ion gauge is on]. IGS_FILTYPE _W (00100000h) Tungsten. If this bit is not set, Iridium. This parameter cannot be changed when the ion gauge is on. Bits 000F0000 Filament Number IGS_FILNUM_VALID (00080000h). Must be set to write the value. [Cannot be set if ion gauge is on]. IGS_FILNUM _2 (00010000h) Filament 2. If this bit is not set, filament 1. This parameter cannot be changed when the ion gauge is on. Bits 000000FF Ion gauge emission/degas setting IGS_EM_VALID (000000FFh). Must be set to write the value. Please see the relevant corresponding section in the Ion Gauge Status parameter for bit/value settings. To change emission, select the desired value, ORing with IGS_EM_AUTO if auto emission is required. To start degas, set to any of the degas values, ORed with IGS_EM_QUICKDEGAS if quick degas is required. Whether the degas starts also depends on the setting for the Degas protection parameter or pressure.

R/W

R/W

[See also Ion Gauge Status 88h]

GROUP 10 144 90h

Slot A value 1

32 bit float

SLOT A MEASURED VALUE 1 The main measured value for module in Slot A. For example, for Pirani module the pressure, for thermocouple module, the temperature

Page 23 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

Parameter Address 146 92h 148 94h 150 96h 152 98h 154 9Ah 156 9Ch 158 9Eh GROUP 11 160 A0h 162 A2h 164 A4h 166 A6h 168 A8h 170 AAh 172 ACh 174 AEh GROUP 12 176 B0h

Parameter Name Slot A value 2 Slot B value 1 Slot B value 2 Heatsink temperature Ion gauge pressure Ion gauge sensitivity factor Ion gauge low pass filter Trip 1 Level Trip 2 Level Trip 3 Level Trip 4 Level Trip 5 Level Trip 6 Level Trip 7 Level Trip Hysteresis Level D/A Output Min value

Type 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float

R/W
R R

Description
SLOT A MEASURED VALUE 2 This is reserved for future implementation SLOT B MEASURED VALUE 1 The main measured value for module in Slot A. For example, for Pirani module the pressure, for thermocouple module, the temperature SLOT B MEASURED VALUE 2 This is reserved for future implementation HEATSINK TEMPERATURE Used to control the fan ION GAUGE PRESSURE Range 1x10-14 to 1x10+3. 1x10+3 returned when ion gauge is off. The values are corrected for the sensitivity factor and are returned in the selected display units ION GAUGE SENSITIVITY FACTOR Range: 1.0 to 99.9. IGC3 rounds the value to closest 0.1. Default = 19 ION GAUGE LOW PASS FILTER Range: 0.0 (OFF) to 9.9 seconds. IGC3 rounds value to closest 0.1. Default = 1.5

R R R

R/W R/W

32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float

R/W R/W R/W R/W R/W R/W R/W R/W

TRIP 1 LEVEL Range: 1x10-13 to 1x10+6. Units to suit device that trip is allocated to. TRIP 2 LEVEL Range: 1x10-13 to 1x10+6. Units to suit device that trip is allocated to. TRIP 3 LEVEL Range: 1x10-13 to 1x10+6. Units to suit device that trip is allocated to. TRIP 4 LEVEL Range: 1x10-13 to 1x10+6. Units to suit device that trip is allocated to. TRIP 5 LEVEL Range: 1x10-13 to 1x10+6. Units to suit device that trip is allocated to. TRIP 6 LEVEL Range: 1x10-13 to 1x10+6. Units to suit device that trip is allocated to. TRIP 7 LEVEL Range: 1x10-13 to 1x10+6. Units to suit device that trip is allocated to. TRIP HYSTERESIS Range: 1.0 to 99.0. IGC3 round value to closest 0.1. Default = 1.1x

32 bit float

R/W

MINIMUM D/A SETTING Range 0 to 4095. Usually set to correspond to 0V output (=~ 20). However, can be made larger than D/A Output Max value if reverse D/A output action required.

Page 24 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

Parameter Address 178 B2h 180 B4h 182 B6h 184 B8h 186 BAh 188 BCh 190 BEh GROUP 13 192 C0h 194 C2h 196 C4h 198 C6h 200 C8h 202 - CAh 204 CCh 206 CEh GROUP 14 208 D0h 210 D2h 212 D4h

Parameter Name D/A Output Max value D/A Min Pressure value D/A Max Pressure value D/A Output [Unassigned] [Unassigned] Internal Pump Down Start Pressure Pump Down Delay Pump Down num. attempts [Unassigned] [Unassigned] Timer pressure Limit Timer OFF Time Timer ON Time Bake-out Temp 1 Bake-out Temp 2 Bake-out Temp 3

Type 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float

R/W
R/W

Description
MAXIMUM D/A SETTING Range 0 to 4095. Usually set to correspond to 10V output (=~ 4026). However, can be made smaller than D/A Output Min value if reverse D/A output action required. D/A MINIMUM Parameter value (pressure or temperature) Range: 1x10-13 to 1x10+6. Units set to the device that D/A is allocated to. Note can be D/A MAXIMUM Parameter value (pressure or temperature) Range: 1x10-13 to 1x10+6. Units set to the device that D/A is allocated to. D/A OUTPUT VALUE Range 0 to 4095. Although this parameter can be written to, it should only be written to if the D/A Flags Parameter(5Eh) is set to DA_SET_EXTERNAL.

R/W R/W R/W

R R/W R/W R/W

[Reserved for internal use]

PUMP DOWN START PRESSURE Range: 1x10-13 to 1x10+6. Units to suit device in slot A. PUMP DOWN DELAY TIME Range: 0 to 999 seconds NUMBER OF ATTEMPTS TO MAKE TO PUMP DOWN Range: 1 to 9

R/W R/W R/W

PRESSURE LIMIT FOR OPERATION OF ON TIME Range: 1x10-13 to 1x10+6 in currently selected pressure units TIMER OFF TIME Range: 0 to 1440 minutes TIMER ON TIME Range: 0 to 1440 minutes BAKE-OUT TEMPERATURE FOR STEP 1 Range: 0 to 600C BAKE-OUT TEMPERATURE FOR STEP 2 Range: 0 to 600C BAKE-OUT TEMPERATURE FOR STEP 3

R/W R/W R/W

Page 25 of 26

VG Scienta

EpiSoft - IGC3 Communications Handbook

Parameter Address 214 D6h 216 D8h 218 - DAh 220 DCh 222 DEh GROUP 15 224 E0h 226 E2h 228 E4h 230 E6h 232 E8h 234 - EAh 236 ECh

Parameter Name Bake-out Temp 4 Bake-out Temp 5 Bake-out Temp 6 Bake-out Temp Hysteresis Bake-out Pressure Limit Bake-out Time 1 Bake-out Time 2 Bake-out Time 3 Bake-out Time 4 Bake-out Time 5 Bake-out Time 6 Bake-out Setpoint Remaining bakeout time

Type

R/W
R/W R/W R/W R/W R/W

Description
Range: 0 to 600C BAKE-OUT TEMPERATURE FOR STEP 4 Range: 0 to 600C BAKE-OUT TEMPERATURE FOR STEP 5 Range: 0 to 600C BAKE-OUT TEMPERATURE FOR STEP 6 Range: 0 to 600C HYSTERESIS APPLIED TO BAKE-OUT TEMPERATURE Range: 0 to 99C BAKE-OUT PRESSURE LIMIT Range: 1x10-13 to 1x10+6 in currently selected pressure units

32 bit float 32 bit float 32 bit float 32 bit float 32 bit float

32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float 32 bit float

R/W R/W R/W R/W R/W R/W R

238 EEh

32 bit float

BAKE-OUT TIME FOR STEP 1 Range: 0 to 99.9 hours BAKE-OUT TIME FOR STEP 2 Range: 0 to 99.9 hours BAKE-OUT TIME FOR STEP 3 Range: 0 to 99.9 hours BAKE-OUT TIME FOR STEP 4 Range: 0 to 99.9 hours BAKE-OUT TIME FOR STEP 5 Range: 0 to 99.9 hours BAKE-OUT TIME FOR STEP 6 Range: 0 to 99.9 hours CURRENT BAKE-OUT TEMPERATURE SET-POINT Range: 0 to 600C. Note this is the required temperature. The actual measured temperature is available from Parameter Slot B Measured 1 (i.e. the thermocouple module in Slot B) TOTAL REMAINING BAKE-OUT TIME Range: 0 to 599.4 hours

Page 26 of 26