Edwards and the Edwards logo are trademarks of Edwards Limited.
D397-30-880 Issue H
CAUTION
1Introduction
1.1Scope
This manual provides Operation instructions for serial interface communications to the Edwards Turbo Instrument
Controller product range, part numbers:
DescriptionItem Number
TIC Instrument ControllerD397-00-000
Before using these instructions, ensure that you have a good understanding about the operation of the
controller.
Introduction
1.2Message basics
The communications to the TIC work on a master/slave principle. The TIC is the slave and will only transmit a message
in response to one sent to it. The master, a PC for example, must always start the conversation.
A conversation consists of a message to the TIC and its response b ack. Having sent a message to the TIC, wait for the
reply before continuing.
There are two basic types of message sent to the TIC:
Command sending information to the TIC (!).
Query requesting information from the TIC (?).
All messages end with a carriage return.
In multi-drop mode, the ? and ! are preceded by the addressing information.
Characters not enclosed by start (!?) and end (cr) characters will be ignored. Incomplete messages will be ignored if
a new start character is received.
1.2.1Commands
Commands send information to the TIC. These can be literal commands such as 'turn pump on' or setups to be stored
by the TIC. Setups hold information about how the TIC should behave such as the conditions under which the vent
valve should open.
1.2.2Queries
Queries request information from the TIC. These can be direct queries of the value of a parameter such as pump
speed, or reading the setup value currently in the TIC.
Responses from the TIC contain either the data requested (=) or the status of the command (*). Note that for
commands such as Upload/Download, the action will continue after the response has been received. Also detailed
checking is performed by the objects themselves so a good response only guara ntees that the message was accepted
by the serial communications, correct behaviour must be checked by querying the appropriate attribute. For example
write a setup, read it back and check the updates are as requ ested.
1.2.4Setup
Some objects have more than one setup, for these objects the config type is sent and returned as the first paramete r
in the data field.
1.3DX, nEXT and nXDS pumps
The TIC will pass messages to the DX, nEXT or nXDS pump and return the replies. It limits some of the commands that
can be sent directly as the TIC must take account of setups and inputs connected to it. For example, if SYSI is set
into the fail condition; the turbo pump must not run so on/off commands directly to the DX, nEXT or nXDS are always
ignored, use the TIC turbo object instead.
Under a fault condition the DX and nEXT move through their state machines slightly differently. The TIC adjusts the
information from the nEXT so the TIC’s states move like the DX for both pum p types. On fault the TIC shows both
pumps as fault braking until a stop command is issued. At this point the fault is cleared from the pump object 904
and the front panel.
When not using the TIC the main visible difference is that the DX clears its fault bits and fault LED when a stop
command is issued. The nEXT does not clear them until both a stop and then a start command are issued.
1.4Communications timings
Because of the complexity of the product precise message timings are not defined, however, the following are
provided for guidance:
Basic messagesless than 100 mSecs
Messages to DX, nEXT or nXDS (dependent on DX or nEXT behaviour)less than 200 mSecs
Suggested timeout in master500 mSecs
Upload Turbo (DX/nEXT)less than 2 secs
Download Turbo (DX/nEXT)less than 4 secs
1.5Object IDs
This sub-section summarises the protocol, based on the use of object IDs, to identify sources and destinations in
messages.
Objects can be physical items such as gauges and pumps, or virtual items such as software modules and data records.
Each object is allocated a unique identification number, although two instances of a particular item will both have
the same ID. In a message, the Object ID consists of 1 - 5 ASCII digits representing a number between 1 - 65535, as
shown below:
Data fields contain command codes, parameter values or response codes, and will vary in length and format according
to the message type. If there is more than one item in the data field, each item is separated by a semi colon(;).
Edwards and the Edwards logo are trademarks of Edwards Limited.
D397-30-880 Issue H
A returned response code consists of 1 or 2 characters representing a number between 0_99. A code of '0' always
means 'OK'. Other codes can be used to indicate various error conditions:
Where several items are linked together using multiple RS232 lines radiating from a hub, a 'multi-drop' identifier is
prefixed to each message. It is composed of a '#', followed by a 2 character Destination ID, a colon, and a 2 character
Source ID:
1.6TIC serial protocol messages
GENERAL COMMAND
NORMAL (or ERROR) RESPONSE
Introduction
NORMAL (or ERROR) RESPONSE
1.6.1TIC serial protocol - multi-drop prefix to a message
SETUP COMMAND
QUERY SETUP
ERROR RESPONSE
NORMAL RESPONSE
QUERY VALUE
ERROR RESPONSE
NORMAL RESPONSE
1.6.2PC serial
This covers operations specific to the PC serial link covering control, monit orin g a n d se tup of all sections of the TIC
and the attached pumps.
Objects in the DX, nEXT or nXDS pump can be read via the TIC at their normal object ID and the TIC will pass the
messages on and return the reply, refer to DX, nEXT or nXDS requirements Section 1.3. Wait for the reply before
sending in another message even if the new message is for the TIC or 'other' pump.
911Backing speed ?VValue 0.0 – 100.0%Backing speed - value; alert ID; priority
912Backing power ?VValue 0.0 – 50.0 w
913Gauge 1?VValue – pressure (see
?VV alue - 0-65535 hoursTime period turbo has been on - value; state;
!CTurn pump on/off
?S
!S
?S
!S
!CCommands – see
see pump type listRead pump type
None = 0
On stop = 1
On 50% = 2
(typ)
gauge type) or voltage
0.000 to 11.000 volts.
Master – object ID
gauge 1/2/3 and turbo
speed.
Units type – 59, 66, 81
see snvt list.
Setpoints to suit units
type and master.
volts 0.000 – 9.999,
pressure float, pascals
speed 0 – 99.
Gauge type – see gauge
list
Gas type – see gas list.
Filter 1 = on,
0 = off.
0 = 1000
1 = 2000 mbar
Gauge nameRead user gauge name - 4 characters 0-9, A-Z
command list
Turbo power – value; alert ID; priority
In standby mode
Set standby mode
alert ID; priority
Config type = 3
Read backing sequence options - none/on
stop/50%
Set backing sequence options
Config type = 70
Backing power - value; alert ID; priority
Gauge reading and state – value; units type;
state; alert ID; priority
Read slave setup – master; units type; on
setpoint; off setpoint, enable
Write slave setup – master; units type; on
setpoint; off setpoint, enable
Config type = 4
Read gauge type – e.g. AIMX
Config type = 5
Read gauge setup - gas type (volt); filter on/
off
Set gauge setup - gas type (volt); filter on/off
Config type = 7
Read slave setup – master; units type; on
setpoint; off setpoint, enable
Set slave setup– master; units type; on
setpoint; off setpoint, enable
Config type not needed
Turn relay on/off
Power supply temperature value - value;
alert ID; priority
ID; priority
Read analogue out source
Set analogue out source
Config type not needed
priority
Read vent options – on stop/50%
Set vent options
Config type not needed
Heater band time, state on/off – value;
state; alert ID; priority
Read on time 0-35 hours
Set on time 0-35 hours
Config type not needed
priority
Read permanently on or turbo slaved
Write permanently on or turbo slaved
Config type not needed
Edwards and the Edwards logo are trademarks of Edwards Limited.
Table 1 - Objects accessed via the PC serial comms (continued)
Object ID ObjectOperationsNotes
925Display
contrast
926Configuration
Operations
928Lock?S
929Pressure Units ?S
930PC comms?S
931Default screen ?S
?S
!S
!Csee command listDefault TIC
!S
!S
!S
!S
-5 – 15Read contrast setting
Set contrast setting
Config type not needed
Default Turbo send to DX or nEXT pump
Load config to Turbo (DX or nEXT)
Load config from Turbo (DX or nEXT)
?S-Locked = 1
Released = 0
!S-see config list
?S-Locked = 1
Released = 0
!S-see config list
kPa = 1
mbar = 2
Torr = 3
232 = 0
485 = 1
All = 0
Three gauges = 1
Gauge 1 = 2
Gauge 2 = 3
Gauge 3 = 4
Turbo only = 5
One gauge = 6
Six gauges = 7
Turbo + one gauge = 8
Possible IDs are - 913,
914, 915, 934, 935,
936 and 0 = none
As aboveRead three gauge order
Lock/release config setup
Lock/release front panel
Read display pressure Units – kPascal/mbar/
Torr
Set display pressure Units – kPascal/mbar/
Torr
Config type not needed
Read PC comms to RS232/RS485
Set PC comms to RS232/RS485
Config type not needed
Read default screen
Set default screen
Config type 15
Options 2,3,4 are only available to
D39700640F and earlier.
Options 6,7 are only available to D397 00640G
and later.
TC - option 5 only
TIC - option 0,1,2,3,4,5,6
IC - options 1,6
IC6 - options 1,6,7
Read one gauge order
Set one gauge order
Config type 71
S931 71;Position 1 ID;Pos 2 ID;Pos 3 ID;
Pos 4 ID; Pos 5 ID;Pos 6 ID
Gauge IDs can be in any order and can be
repeated.
0 (zero) ID entry means don’t show this
position.
Set three gauge order
Config type 72
S931 72;Position 1 ID;Pos 2 ID; Pos 3 ID;
Pos 4 ID;Pos 5 ID;Pos 6 ID
Gauge IDs can be in any order and can be
repeated.
0 (zero) ID entry means don’t show this
position but there must be a minimum of
three non-zero entries.
Table 1 - Objects accessed via the PC serial comms (continued)
Object ID ObjectOperationsNotes
932Fixed/Float
ASG
933System (TIC
and TC only)?S!S
?S
!S
Float = 1
Fixed = 0
0 = no
1 = yes
Read Float/fixed display (ASG)
Write Float/fixed display (ASG)
Config type not needed
Read/write System On/Off setup
Config type not needed
The message consists of sections of Object
ID; system on; system off.
Any number of whole sections can be sent up
to the maximum of 12. Invalid object IDs will
be ignored. You can send just the sections
you wish to alter e.g. !S933 915;1;1;910;1;0cr
The actual structures for each kind of unit
are shown below. ?S answers will be in this
order and return all relevant entries.
Edwards and the Edwards logo are trademarks of Edwards Limited.
Table 1 - Objects accessed via the PC serial comms (continued)
Object ID ObjectOperationsNotes
934Gauge 4?VValue - pressure (see
gauge type) or voltage
0.000 to 11.000 volts.
?S
!S
Master - object ID
gauge 1/2/3 and turbo
speed.
Units type - 59, 66, 81
see snvt list. Setpoints
to suit units type and
master.
volts 0.000 - 9.999,
pressure float,
speed 0 - 99.
Gauge type - see gauge
list
Gas type - see gas list.
Filter - 1 = on, 0 = off.
0 = 1000
1 = 2000 mbar
Gauge nameRead user gauge name - 4 characters 0-9,
0 = 0.05
1 = 0.1
2 = 0.2
3 = 1
....
10 = 2000
Gauge reading and state - value; units type;
state; alert ID; priority
Read slave setup - master; units type; on
setpoint; off setpoint, enable
Write slave setup - master; units type; on
setpoint; off setpoint, enable
Config type = 4
Read gauge type - e.g. AIMX
Config type = 5
Read gauge setup - gas type (volt);
filter on/off
Set gauge setup - gas type (volt);
filter on/off
Config type = 7
For each attached gauge
<Position byte>;<Gauge value>;
Examples
Reply for 1 gauge connected at position 2
=V940 2;3.9441e+02;
Reply for 3 gauges connected at p ositions 2, 3
and 5 with gauge 2 in voltage mode and
gauge 5 not ON (e.g. OFF, error, striking etc)
=V940 2;6.546;3;2.7245e-04;5; 9.9000e+09;
Note:The pump shall accept the wildcard multi-drop address 99.
The pump shall accept the wildcard object ID 0 for a ?S and return information from the TIC Status object
902.
The following are examples of abbreviations and codings, with their meanings, which appear in subsequent
paragraphs.
Edwards and the Edwards logo are trademarks of Edwards Limited.
Table 2 - Abbreviations
AbbreviationMeaning
rreturned error code – see Table 3
Stringmay have several ASCII characters
ddecimal ASCII character
hhexadecimal ASCII character
ckchecksum (1 byte)
crcarriage return
1.6.2.1Node object 901
where d is the multi-drop address to be stored in EEPROM.
1.6.2.2Node object 902
D397-30-880 Issue H
Introduction
Query setup returns a data string in the following format:
TIC;Dxxxxxxxx;serial number;PIC s/w ver
where 'TIC' is a fixed string for this pump, Dxxxxxx is the software version number fixed by the software, serial
number is a string loaded during production, PIC s/w ver is the PIC software version.
System state of key items on the TIC, state value from Turbo, backing, gauge 1, gauge 2, gauge 3, relay 1, relay 2,
relay 3, alert ID of object 902 and highest priority on the TIC.
1.6.2.3Turbo pump object 904
where s is the state of the pump, a is the alert ID and p is the priority. Number of characters per parameter is as
required to represent the value.
where 3 is the config type and p is the pump type.
where 4 is the config type, m is the master object, p is pressure '59' or voltage '66', n is the on setpoint, f is the off
setpoint and e is enabled '1' or disabled '0' e.g.
0no error
1Invalid command for object ID
2Invalid query/command
3Missing parameter
4Parameter out of range
5Invalid command in current state - e.g. serial command
6Data checksum error
7EEPROM read or write error
8Operation took too long
9Invalid config ID
Edwards and the Edwards logo are trademarks of Edwards Limited.
Over Range= 3
Under Range= 4
ADC Invalid= 5
No Gauge= 6
Unknown= 7
Not Supported= 8
New ID= 9
Over Range= 10
Under Range= 11
Over Range= 12
Ion Em Timeout= 13
Not Struck= 14
Filament Fail= 15
Mag Fail= 16
Striker Fail= 17
Not Struck= 18
Filament Fail= 19
Cal Error= 20
Initialising= 21
Emission Error= 22
Over Pressure= 23
ASG Cant Zero= 24
D397-30-880 Issue H
Introduction
RampUp Timeout= 25
Droop Timeout= 26
Run Hours High= 27
SC Interlock= 28
ID Volts Error= 29
Serial ID Fail= 30
Upload Active= 31
DX Fault= 32
Temp Alert= 33
SYSI Inhibit= 34
Ext Inhibit= 35
Temp Inhibit= 36
No Reading= 37
No Message= 38
NOV Failure= 39
Upload Timeout= 40
Download Failed= 41
No Tube= 42
Use Gauges 4-6= 43
Degas Inhibited= 44
IGC Inhibited= 45
Brownout/Short= 46
Service due=47
No Pump= 0
EXDC Pump= 1
EXT75DX Pump= 3
EXT255DX= 4
Mains Backing Pump= 8
Serial Pump= 9//temporary until serial comms receives ID from pump
nEXT - 485= 10//TIC only supports this in parallel form
nEXT - 232= 11
nXDS= 12
Not yet identified= 99