Hardware User'S Manual Versapump 6 Syringe Dispenser Module: For The
Hardware User'S Manual Versapump 6 Syringe Dispenser Module: For The
for the
VersaPump 6
SYRINGE DISPENSER MODULE
Kloehn Ltd.
10000 Banburry Cross Drive
Las Vegas, NV 89144
U.S.A.
The Kloehn Company has a policy of making every effort to ensure all upgrades are fully
backwards-compatible with earlier versions. We have been successful in nearly all
respects, producing better and more capable versions of our standard products which
can be seamlessly integrated into existing system designs without increasing prices.
However, differences may exist in internal parts and materials, and rarely, in firmware
commands.
If such differences may impact your product certifications, or if a unique configuration must
be maintained over long production runs, contact Kloehn Customer Service to inquire
about assigning a unique part identification for your application. Alternatively, you may
request to add your name to the list of customers to be notified of changes prior to release
of standard product upgrades.
1.0 INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.1 GENERAL DESCRIPTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2 OPTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.3 Supporting Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3.1 KSerial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3.2 Kcom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3.3 Kloehn Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3.4 WinPump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
6.0 COMMUNICATIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
6.1 INDIVIDUAL DEVICE ADDRESSING . . . . . . . . . . . . . . . . . . . . . . . . . . 59
6.2 MULTIPLE DEVICE ADDRESSING . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
9.0 POWER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
9.1 POWER SUPPLY SELECTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
9.1.1 Capacity Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
9.1.2 Type Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
9.2 SYSTEM WIRING PRACTICES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
9.3 LOW VOLTAGE CONDITION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
11.0 SPECIFICATIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
11.1 ENVIRONMENTAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
11.2 PHYSICAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
11.3 POWER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
11.4 SYRINGE AXIS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
11.4.1 Resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
11.4.2 Accuracy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
11.4.3 Speed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
11.4.4 Syringe Thrust and Pressure . . . . . . . . . . . . . . . . . . . . . . 95
11.5 VALVE AXIS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
11.6 COMMUNICATIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
11.7 I/O INTERFACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
11.7.1 Digital Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
11.7.2 Digital Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
11.7.3 Digital Voltmeter Input . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
11.7.4 Serial I/O Expansion Port . . . . . . . . . . . . . . . . . . . . . . . . 97
11.8 USER PROGRAM MEMORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
APPENDIX A: COMMAND SET SUMMARY . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
A.1 COMMANDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
A.2 VARIABLES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Two-way, serial communications between the V6 and a controlling host is done via
an RS485 or RS232 interface. Up to 15 addressable pumps or other devices can
share a single, standard, bidirectional RS485 communications bus, controlled from
a single PC serial port at baud rates from 1200 to 38,400 baud. Two protocols, DT
and OEM, are supported, both of which are fully compatible with the Cavro
protocols. The unit may be interrogated for status or operating parameter values
at any time. Individual commands or groups of commands may be sent for
immediate or later execution by the pump.
Command strings, or programs, can be executed from RAM or may be stored into
and executed from the non-volatile memory (NVM). Up to 10 programs may be
stored in the standard NVM. An expanded NVM increases this to 99 programs.
A program in the NVM can be set to self-start when power is first applied to the
pump and immediately after a Reset input. Program retention in the NVM is
typically greater than 15 years without batteries. Program looping and if-then
program flow control is supported.
Three external logic inputs and three outputs permit interfacing to a variety of other
devices. One input can be used to halt a dispense in progress. A built-in digital
voltmeter (DVM) is included. For applications which require more I/O, an I/O
expander card is available to provide 16 more inputs and 16 more outputs.
The V6 interface is located on a single card edge connector at the rear of the pump.
This permits simple wiring connections and the use of modular, plug-in mounting.
1.2 OPTIONS
The VersaPump 6 series can be ordered in 48,000 or 24,000 step resolutions, with
or without valves and with or without electronic controllers and motor drivers.
Versions without controllers and motor drivers include an interface board with the
electromechanical interfaces, signal conditioning, and a convenient card edge
connector.
A starter kit is also available from Kloehn Company. The kit includes cables, power
supply, manuals, and software.
1.3.1 KSerial
1.3.2 Kcom
• You need to write programs that are lengthy, parameterized, or frequently modified
such as an assay method.
• You need computer automation of pumps and valves without investing the time to
learn programming or write software.
1.3.4 WinPump
2.1 INPUTS
[Link] Connection
Power for the pump is input on 33 through 36 of the card edge connector. The
positive power lead is duplicated on pins 35 and 36. The power ground is
duplicated on pins 33 and 34. This permits two solid, straight wires to be passed
through the edge connector in-line for a multi-pump system with plug-in pump
modules.
When the pump supply voltage drops below an internal reference minimum (20V),
a "Low Voltage" error message is generated. This message is generated only once
for each drop in voltage. Continued low voltage is not reported in an error message;
the voltage should be monitored, if necessary, by repeated queries of the supply
voltage. Another low voltage error message will be generated only if the voltage
should rise above the reference minimum and then drop below it again. If
continuous low voltage error messages occur, the most likely causes are low-
frequency noise or ripple on the power supply.
While the voltage remains below the minimum, valve and syringe moves are
inhibited. However, unless the supply voltage drops below about 8 Vdc, the internal
control electronics and memory are not affected and all other instructions, such as
I/O operations and queries, will still operate normally after the low voltage error
message has been reported or cleared.
Some power supplies will turn on gradually. If the rise time of the supply is slow
enough, the internal computer may report a "Low Voltage" error when the pump is
initially queried. This will not cause any operational problems after the message
has been reported or cleared.
The power supply capacity should be consistent with the specifications of Section
10.3 of this manual both with regard to dc requirements and ac transient capability.
If a Kloehn power supply is used, these specifications will be met.
syringe and valve moves, with a derating for reliability. The ac transient currents
during syringe and valve moves are negligible. During valve moves, the ac current
is about 100 mA rms around the average DC current.
For multiple pumps on one supply, the overall system operation should be
considered. If there are N pumps, of which only M units will be making a syringe or
valve move at the same time, then the power capacity of the supply should be at
least 40M + 11(N-M) watts. If the syringes do not have to hold position against
a back pressure, then the syringe motors can be turned off between moves,
reducing the idle power per pump from 9 watts to 2 watts. There is no need to have
the valve motor turned on when a valve move is not in progress. The pump
automatically turns on the valve motor for moves and then turns it off when not
moving.
The unregulated supply is the cheapest and simplest. Due to its unregulated
nature, it is not recommended.
The linear regulator supply usually has a protective current limiting. This limit value
must be set to at least 2.5 A to allow for the start-up in-rush current.
A switching power supply is the preferred choice. It offers higher efficiency, lower
heat generation, and a well-filtered output. Note that some switching power
supplies have a minimum load current requirement. Since the pump can idle as low
as 70 milliamps, the supply should be rated for a minimum load current equal to the
minimum total system idle current. A ballast resistor may be added across the
supply output to guarantee the minimum load requirement of the supply.
Battery operation from 24 V battery systems is feasible. The wide operating range
makes this possible. In most cases, a standby battery voltage of 28 Vdc is seen in
automotive and aircraft systems. This is acceptable for normal operation. Mobile
systems should provide overvoltage clamping for transients exceeding 34 Vdc.
In a system with multiple syringe drive modules, the power distribution wiring can
affect the system reliability. The best system wiring practice is to connect each
drive module with an individual pair of power leads from the power supply to that
individual module. This is called a "star" connection. The power leads for each
module should be twisted together along their length to reduce radiated fields.
External filter capacitors are not required, as internal filters are included.
The device address on the communications bus can be hard-wired into the
connector so a device can be inserted into an instrument without a need to set the
address switch to a particular location. To use this feature, that address switch
must be in the “F” position. If the address switch is in any other position, a conflict
will result between a hard-wired address and the address indicated on the switch.
The address inputs have built-in pull up resistors and use positive logic. The default
Address input level is logic “1". A logic “0" is made by grounding an Address pin.
The address is set as a 4-bit binary number by shorting those pins to ground which
should have a zero value. The address weighting on the pins is as follows:
The address value is the sum of the pin weights which are not connected to
ground. See Table 2-1 for the pin connections corresponding to the equivalent
address switch settings.
To wire an address onto the card edge connector, convert the address “1" through
P/N 23455 Rev. D, 09-02-04
8
“F” into a binary representation of the hexadecimal number and ground the pins
which should have a zero value.
The pin connections are shown below. A “Ground” indicates the pin should be
connected to a ground pin. The notation “n/c”signifies there should be no
connection to the pin.
To use the hard-wired address, the Address Switch MUST be set to “F”.
If it is not, an address conflict will exist between the wiring and the switch.
The address can be set with either the address switch or with the card
edged connector wiring. Only one of the two methods may be used.
If the card edge connector wiring method is NOT used to set the pump address,
the address must be set with the Address Switch (Figure 2-1).
The DVM Input allows 8-bit measurements of external analog voltages. Analog
values may be reported to the host controller, or used within a user program to
compare a measured analog value to a user-preset value to make a conditional
program jump. Also, the DVM Input can be used to set program instruction
parameter values, as described in Section 4.5.2.
The input impedance is 1 Mohm for dc inputs, and is 20 Kohm in series with 0.1
uF capacitance to ground for high-frequency signals. This input impedance is
due to the anti-aliasing filter. The anti-aliasing filter at the input, shown in Figure
2.2A, has a -3 dB cutoff frequency of 80 Hz, and an attenuation rate of -6
dB/octave above the cutoff frequency. Although the conversion time for an input
sample is approximately 18 microseconds, the time constant of the filter is 2
milliseconds. If the input value changes, 5.5 time constants are required, worst-
case, for the new value to settle to within the resolution (1/256 of full scale) of the
DVM. If an abrupt step change were to occur as a conversion begins, the input
filter time constant will insure that the correct valve at the start of conversion will
be read to within the DVM accuracy.
The input voltage range is 0 to 5.1 V, corresponding to an internal conversion
integer value from 0 to 255, respectively. It is recommended that the input
voltage range be restricted to 5 V or less. Each increment of internal value (an
LSB) corresponds to an analog input increment of 20 mV.
The internal numerical value for a DVM input can be calculated by this relation:
To avoid noise and errors due to ground loops, the ground wire of the voltage
source to be measured should be twisted together with the input wire (a "twisted
pair") and connected directly to the analog ground pin. If a shielded, twisted pair
is used, the shield should be grounded at one end only.
P/N 23455 Rev. D, 09-02-04
10
2.1.4 Reset Input
A Reset Input is located on pin 25. When this pin is brought low (below 0.8Vdc),
the processor resets. The reset condition remains active while the input is low.
When the input is returned high, the processor begins a pump initialization cycle
after a 0.25 seconds delay. The Reset Input is referenced to a ground on one of
pins 23 to 26. Reset is also automatically generated internally when power is first
applied. A reset causes the following actions:
As shown in the equivalent input circuit in Figure 2-2B, each input has a 4.7K pull-
up resistor and is protected for input voltages up to 30 Vdc. Inputs are compatible
with CMOS and TTL logic operating from 5V supplies, with other pump's digital
outputs, and with external switches. An "on" input is less than 1 V. An "off" input
is more than 3.5 V, or an open circuit. The internal resistance provides the bias
required for external switches. External switches should make a connection to
ground when in the "on" condition.
2.2 OUTPUTS
The Digital Outputs are “active low”. An “on” condition is a 5-ohm resistance to
ground. An “off” condition is an open-circuit. This is compatibility with the digital
inputs.
P/N 23455 Rev. D, 09-02-04
11
2.2.2 Error Outputs
Pin 16 provides an Error Out suitable for driving logic or an LED indicator. The
output is active whenever an unreported error condition exists within the pump.
When an error condition occurs, the Error Out on pin 16 is set to an “on” condition,
which acts like a 5 ohm resistance to ground. In the absence of an error or after an
error has been reported to a controller via the communications I/O, the Error Out
is an open-circuit.
The Error Bias output on pin 15 consists of a 330 ohm resistor connected
internally to the +5 Vdc power. This output provides a current-limited output suitable
for direct drive of an LED indicator anode. To drive an external LED error indicator,
connect pin 15 to the anode and pin 16 to the cathode.
If an LED is not used, the Error Out can be used to drive some other error
indicating device. The maximum output voltage in the “off” condition is 40 volts. If
an external supply is used, a common ground connection should be taken from the
I/O ground to the external supply ground. Since no internal protection is provided
for inductive loads, if relays or solenoids are driven, a clamp diode across the load
is required. For sending an error indication to a remote electronic equipment, the
Error Out pin can be used to drive the input of an opto-isolator.
The Error outputs of several devices may be tied together to make a single "wire-
OR'ed" system error signal. This signal may be used to drive a LED or an input to
a controller.
To power external I/O circuits, the card edge interface includes a +5 Vdc power
output on pin 5. This output is rated for loads up to 100 mAdc. Any of the Ground
pins on the card edge may be used in conjunction with this pin.
The serial I/O (IOX) expansion port is independent of the serial communications port
and is located on pins 1 through 6 of the edge connector. The IOX uses four
signals: IOX Input, IOX Output, IOX Clock, and IOX Strobe.
The IOX Input receives serial data as 8-bit bytes from an external circuit and the
IOX Output sends data as 8-bit bytes from the pump. The IOX port acts as a
“master” using the IOX Clock to synchronize the serial data transfers bit-by-bit. The
IOX Strobe acts as a synchronous, active-low enable signal for external devices.
Depending on the value of the IOX mode parameter “~S”, IOX operation will
perform one-byte or two-byte data transfers.
The RS485 I/O is available on pins 11 through 14. There are two signals, RS485
“A” and RS485 “B”. The "A" line is the "positive" line, and the "B" line is the
"negative" line under idle bias conditions. To prevent common-mode voltage
errors, the communications should also use the Com Ground on pin 10 for an
RS485 communication ground in addition to the "A" and "B" lines.
The “A” signal is duplicated on pins 13 and 14, while the “B” signal is duplicated on
pins 11 and 12. This duplication permits a straight wire to pass straight through
each pair of the “A” and “B” lines to interconnect a series of devices.
The RS485 bus requires a proper bias and termination network for reliable
operation. The necessary network is included in the pump and is applied via the
RS484 Bias toggles “3" and “4" on the Com Setup Switch shown in Figure 2-3.
The first and last devices on an RS485 bus should have the network switched “on”.
All other devices between the first and last devices should have the network
switched “off”. A toggle is “on” when the button is positioned to the center of the
switch housing; a toggle is “off” when the button is positioned nearest the edge of
the switch housing.
Do NOT have more than two RS485 bias networks switched “on”, regardless
of the number of devices on the bus. Use ONLY one network “on” at each
end of the overall RS485 bus wiring.
The com bus wiring should be a twisted pair for the “A” and “B” signals. The rate
of twist should be approximately one to three turns per inch. The ground wire may
be a shield or a third wire twisted with the “A” and “B” wires.
An RS485 bus with multiple devices must be wired directly from device-to-
device, using “A”, “B”, and “Com Ground” pins.
There are two lines: RS232 Rx on pin 7 and RS232 Tx on pin 8. The Tx pin sends
data from the pump to a controller, and the Rx pin receives data from a controller
The RS232 protocol uses no flow control. Therefore, no signals other than RS232
RxD, TxD, and Com Ground are needed for serial communications.
The Com Setup Switch is shown in Figure 2-1. This switch has four “toggles”, or
“buttons” numbered “1" through “4". These toggles control whether the RS485 bias
network is attached to the RS585 bus and whether the communications defaults
for baud rate and protocol are set to the factory default values or to the values set
in the configuration variables. The toggles are numbered from “1" at the top to “4"
at the bottom of the switch. The toggle assignments are shown in Figure 2-3 below
Turn “On” or “Off” BOTH toggles 3 and 4 to connect the RS485 bias network.
Do not have only one of the RS485 Bias toggles set to “On”.
The Default toggle (number 1) must be in the “Off” position to permit the
baud rate and protocol to change from the factory default settings.
If the Address Switch is set to “F”, the pump address may be determined by
wiring the Address pins on the card edge connector, as explained in Section 2.2.
If the switch is in any other position, the wired address will conflict with the switch
address.
As shown in Figure 1-2, the card edge connector is supplied with a “key”. This key
is a plastic insert in the connector which corresponds to the slot in the card edge as
depicted in Figure 2-4.
Check the key to ensure it is in the proper position in the connector to match the slot
in the card edge. The key may be moved by grasping it with a needle-nose plier
and pulling it out of the connector. The key may be inserted into the connector by
pressing the key into the detents which are located between each opposing pair
of connector contacts.
Quantity Item
(1) VersaPump 6 drive module
(1) Valve
(1) Syringe
(1+) Teflon washer (one per port used + syringe)
(1) Power supply (24 to 30 Vdc, 40 Watts)
(1) Communications cable, PC-to-pump, Kloehn P/N 17734
(1) PC communications software
(1) Card edge adapter board kit, Kloehn P/N 23428 or card edge
connector, Kloehn P/N 23277 or equivalent.
Getting started requires certain basic actions be taken, in order. These actions are:
Section 3 leads the first-time user through these steps using either the Kloehn
Starter Kit or user-supplied power and wiring. Advanced users can go directly to
Section 4 to study the command set.
(1) Turn on the power to the pump and press the Initialize Button on the front
panel of the pump. Wait for the initialize move to complete. The slot in the
valve drive shaft should be horizontal.
(2) Insert the valve into the faceplate so that the Valve Index Pin engages a
corresponding hole in the valve and the valve drive motor shaft slot engages
the blade in the back of the valve. It may be necessary to rotate the valve
slightly to cause full engagement of both the index pin and the motor shaft.
The valve should seat flush onto the pump faceplate.
(3) Install the two Valve Screws through the valve and into the faceplate.
Tighten the screws firmly, but only finger tight. Over-tightening can damage
the valve.
Note: The valve should be in the port A position when installing the valve.
Note: If the valve is rotated too far during installation, the valve may be
installed with the ports 180 degrees out of position.
Note: The Teflon washer MUST be used to ensure the syringe fully seats.
If the washer is not inserted, the syringe will bottom out on its shoulder.
There are two methods for connecting the pump to power and a PC. One method
uses the Kloehn Starter Kit and the other method uses a Card edge connector with
user-supplied wiring. Section 3.3.1 describes the setup with the Starter Kit. Section
3.3.2 describes the setup with the card edge connector. Use the section which is
appropriate for the application.
The Kloehn Starter Kit, P/N 23427, contains all the accessories needed to power
the V6 pump and control it using a PC. The following items are included in the kit:
1. 24 Vdc Power Supply, P/N 17732, with power cables (Figure 3-3)
2. RS232 Communications cable, P/N 17734 (Figure 3-2)
3. Card Edge Adapter Board, P/N 23352 (Figure 3-1)
4. Disk with software and manual, P/N
5. Installation instruction sheet
The Card Edge Adapter Board (Adapter P/N 23352), shown in Figure 3-1, converts
the card edge connector on the rear of the pump to a set of 0.1-inch connectors
compatible with the 50300 series pump accessories, including the power supply
cable and the communications cable. Inset the card edge connector on the board
onto the card edge of the pump. The .1-inch connectors should be located near the
center of the rear of the pump.
When inserting a wiring connector into an Adapter board connector, ensure the
Polarizing Key is oriented toward the Locking Tab, as shown in Figure 3-5, and
the pins are properly aligned with the connector.
The Communications Cable (com cable) has a DB-9 connector on one end and a
three-pin .1-inch connector on the other end, as shown in Figure 3-2. Plug the 3-pin
The 24 Vdc power supply, P/N 17732, is provided with two cables as shown in
Figure 3-3. The 24 Vdc cable is integral to the supply and has a 4-pin connector
attached. This cable connects to the pump via the Card Edge Adapter. Plug the
4-pin connector into the Adapter board connector labeled “POWER”. Observe the
locking tab polarization.
Note: On the 4-pin DC Power connector, the two inner pins are identical +Power
Input and the two outer pins are identical Ground pins. The power supply has
sufficient capacity to power one VersaPump 6.
Insert the card edge connector onto the card edge at the rear of the pump. Note the
power pins are at the bottom edge of the connector, as indicated in Figures 2-1 and
3-4.
Be certain the card edge connector is oriented with the power pins at the
bottom of the connector as shown in Figures 2-1 and 3-4.
Figure 3-4 shows the connections for DC power and communications with a PC.
The PC serial port connects to the “RS232" pins.
The RS232 cable wiring is illustrated in Figure 3-5 for both DB-25 and DB-9
connectors. For connecting more than one pump, see Sections 6.5 for
communications wiring and Section 9.2 for power distribution wiring. Section 6.5
also illustrates the wiring for an RS485 bus.
Note pins 2 and 3 are reversed between the DB-9 and the DB-25.
The following procedure will locate and configure the HyperTerminal program.
. (5) Go to Connect Using, select Direct to COM1, and click on OK. This will
select a serial port. If you are using another serial port, then select the
appropriate "Direct to Com...".
(6) In the new window, make these entries:
(a) Bits Per Second 9600
(b) Data Bits 8
(c) Parity None
(d) Stop Bits 1
(e) Flow Control None
(11) Click on the ASCII Setup button and place a check mark in the following
boxes:
T Send line ends with line feeds
T Echo typed characters locally
T Append line feeds to incoming line ends
T Wrap lines that exceed terminal width
(12) Click on OK and then again on the next OK.
When HyperTerminal or some other communications program has been set up for
communications with the pump, verify the communications link is operational.
(2) After the pump has initialized, send the command: /1 <Enter>
(3) The pump should respond with “/0`”. If this response is seen, proceed to the
next section. If not, go to Section 6.6 for troubleshooting tips.
A command is an instruction to the pump to do one thing, such as move the syringe
or turn the valve. Commands can combined, or concatenated” to form command
strings. Command strings, also called programs, can perform complex tasks
consisting of many operations, including decision-making.
A command consists of ASCII characters and contain two parts: the command
and its argument. The command is a case-sensitive letter which represents a
specific type of action to perform. The argument follows the command letter and
determines how the command will execute. For example, the command “D1200"
tells the pump to dispense (“D”) 1200 steps.
All commands and command strings must begin with a device address. The
device address determines which devices will respond to a particular command
string. In this way, many devices can be connected together on a single
communications line without interfering with each other. The character which
signifies an address is the forward slash, “/”. When the slash is seen by a pump,
the pump reads the character which follows as an address to determine if that
pump should accept the command string. The individual device address is set via
the Address Switch or by the Address pin wiring on the card edge connector.
For example, if the Address Switch is set to “3", a command string which begins
with “/3" will be accepted by the pump. If the string were to begin with “/2", the
pump would ignore the string.
Pumps may be addressed individually or in groups. The groups may be in pairs,
groups of four, or all pumps on a single communications line. The details of pump
addressing are given in Sections 6.1 and 6.2.
When the pump receives a command string, it checks the string for correctness and
sends a reply. The reply always begins with “/0", which is the address of the PC or
controlling device. At least one character follows immediately after the “/0". This
character is the status byte. The status byte informs the controller of the current
status of the communication and the pump.
There are two types of status: “ok” and “error”. There is a unique letter assigned to
each type of error the pump can recognize. For every error, the status letter may
be capitalized or small-case. If the status byte is capitalized, the pump is busy
doing something. If the status byte is lower-case, the pump is not busy, and is
ready for another command. The “ok” status has two special characters to indicate
“busy” or “ready”: the accent mark “`” indicates “ready”, and the ampersand “@”
indicates “busy”. A typical response is “/0`” or “/0@”. Both these responses
indicate the pump and command string are ok.
Most command strings cannot be accepted until the previous command string is
completed. The exception to this rule is queries. A query asks the pump to report
something, not to do something. A query can be asked any time and will be
answered when it is received, even if the pump is busy.
For example, the configuration command “~V8" sets the valve type to 6-way
distribution. The “~” denotes a configuration command. The “V” denotes the valve
parameter, and the “8" sets the valve to a six-way distribution. The valve parameter
is the only parameter which MUST be set before the pump can be used.
Look up the valve parameter which corresponds to the valve type to be mounted to
the pump. The parameters are listed in Section 4.2.2. Then send the command
/1~Vn <Enter> (Substitute the number of the valve type in place of “n”.)
<Enter> means to press the Enter key on the keyboard.
The syringe zero position must be calibrated prior to the first use of the syringe
whenever a new syringe, valve, or syringe washer is installed. This is a simple
procedure using the buttons on the front panel.
(1) With the syringe and valve already mounted to the pump, press the lower of
the two front panel buttons, the INITIALIZE button. This will cause the
syringe to move to a position a small distance below the top-of-stroke. This
position is internally fixed and is sometimes called the soft limit.
(2) When the INITIALIZE move completes, the syringe motor power will be Off.
(Normally, when a move ends, the motor is left at half-power.) Rotate the
Thumbwheel at the lower left corner to move the syringe piston upward until
it barely contacts the top of the syringe. This will be the zero position, also
called Home. In some applications, the position may be slightly below the
top-of-stroke position if a small air gap is desired.
(3) Press the upper button, the SET HOME button. The syringe will move
downward to the INITIALIZE position and then return to the zero position.
When step (3) above executes, the location of the zero position is stored in NVM.
This value will remain even after power is removed from the pump. The zero
position will be remembered by the pump whenever the pump is powered up.
This initializes the syringe just as the INITIALIZE button did on the front
panel.
This causes the syringe to move to the position 24000 steps below the zero
position. “A” means “go to the Absolute position”. This will be half-way down
for a 48000-step model or all the way down for a 24000-step model.
(3) Enter the command: /1o3R <Enter>
The valve will move clockwise (viewed from the front) to port “C”. The “o”
denotes a valve move and the “3" corresponds to port “C” (1=A, 2=B, etc.).
The syringe will move 2/3 the distance to the zero position (syringe at 24000
moves upward by 16000 to position 8000).
Since queries are executed when they are received, no Run command was needed.
This is true for all queries and configuration commands. For other commands, the
command or command string will execute when the “R” command is sent, either at
the end of the string or as the next command sent. For example,
There are two syringe resolutions: 24000 steps and 48000 steps, depending on
the model of pump.
These commands cause the syringe to move to a commanded position along its
range of motion. An absolute position is a specific point. A relative position is a
distance offset from the current position. Absolute vs relative positions are
illustrated in Figure 4-1.
It is highly recommended that the upper case form of the "An", "Bn", and "Cn"
commands be used so that busy status can be ascertained. The lower case "an",
"bn", and "cn" do not reveal busy status upon query.
In each of the commands below, the "n" value is expressed in steps, where "0" is
at top-of-stroke (0 volume).
An Go to Absolute position "n", with the BUSY status bit set to "busy".
(n: 0...24000 steps or 0...48000 steps, @n) [n/a]
an Go to absolute position "n", with the BUSY status bit set to "ready".
(n: 0...24000 steps or 0...48000 steps, @n) [n/a]
Dn Dispense "n" steps from the current position, with the BUSY status bit set
to a "busy". The dispense direction is upward, towards the valve.
(n: 0...24000 steps or 0...48000 steps, @n) [n/a]
dn dispense "n" steps from the current position, with the BUSY status set to l
"ready". The dispense direction is upward, towards the valve.
(n: 0...24000 steps or 0...48000 steps, @n) [n/a]
Pn Aspirate (“Pick up”) "n" steps from the current position, with the BUSY status
bit set to a logic "1". The aspirate direction is downward, away from the
valve. (n: 0...24000 steps or 0...48000 steps, @n) [n/a]
pn Aspirate (“pick up”) "n" steps from the current position, with the BUSY
status bit cleared to a logic "0". The aspirate direction is downward, away
from the valve. (n: 0...24000 steps or 0...48000 steps, @n) [n/a]
Referring to Figure 4-1, relative position is measured from the current position to the
target position. Absolute position is measured always from zero position (top of
stroke). In the figure above, a move from the upper position at 8600 absolute to
the lower position at 40000 absolute can be done with either a relative aspirate
(move downward) or an absolute (go to position) command as follows.
Both commands will result in the syringe moving to the position shown on the right.
In general, any move which goes to the zero or maximum (full-stroke) positions
should use an absolute positioning command (e.g, “A0" or “A48000"). A move
which goes from one position to another position which is not at either end of the
stroke would use a relative positioning command (“Pn” or “Dn”), although an
absolution positioning command could also be used.
Use the capitalized version of the An, Pn, and Dn commands. Lower-case
versions will not report a “busy” status if the pump is queried while moving.
The coordination between the two pumps is done automatically by the pumps when
their inputs and outputs are connected as explained in Section 8.3.3. The value of
“n” in the handshake dispense commands determines which of the user inputs will
be used for the handshake coordination. For example, if the command is “h2", then
the pump will use input #2 and output #2.
As each pump nears the end of its dispense, it provides an advance trigger signal
to the other pump, which immediately begins its own dispense. The timing on the
trigger signal is automatically adjusted to compensate for different acceleration
settings.
The syringe axis uses the following variables to determine the speeds,
accelerations, and drive compensation moves. See Section 8.2.3 for tips on setting
speed and acceleration values.
During power up of the pump, default values in the operational memory are recalled
from the NVM. The operational values can be set at any time a move is not in
progress. Top Speed is an exception, as it can be set “on-the-fly”.
Except as noted, all these commands require a “R” (Run) command to execute
immediately.
Sn Set a predefined syringe speed. The speeds in the table below are in steps
per second (sps). (n: 0...33, @n) [n/a]
! Store the current values of Top speed, Start speed, Stop speed, and
Backlash as the default values to be used after each power-up or reset. This
command may not be stored within a program.
For most applications, only the Acceleration and Top speed are adjusted. The
remaining parameters are left at the default settings. If the Top speed should be set
to a value lower than the Start speed, the pump will begin the move at the Top
Speed. If the Top speed is set lower than the Stop Speed, the move will end at the
Top Speed. For this reason, values of Top speed which are set lower than either
the Start Speed or the Stop Speed do not require any adjustment in Start speed or
Stop Speed.
4.1.3 Initialization
The syringe position must be initialized (calibrated) after each power-up, reset, or
syringe overload condition. Until the syringe has been initialized, other syringe
movement commands will not be accepted. This is because the syringe position
cannot be absolutely known after the preceding conditions occur. An initialization
command causes the syringe to go to the INITIALIZE position. This is the only
Initialization may use one of three commands: Wn, Yn, or Zn. Each operates in
the same way except for the definition of the valve port positions used during
initialization. For all initialization commands, the argument "n" denotes an initialize
move (n = 4) or a “set home” operation (n = 5).
The “W4” command always initializes the syringe using port “A”. The “Y4” and “Z4”
commands initialize the syringe using the valve port which has been set by the
“~Yn” or “~Zn” commands, respectively. This permits three different ports to be
used for syringe initialization.
The front panel INITIALIZE button executes only the “W4" command. The SET
HOME button effectively executes all three “W5", “Y5", and “Z5" commands, as
there is no practical difference between these three versions.
n=4 Move the syringe to the INITIALIZE position after moving the valve to
port A.
n=5 Set the current syringe position as the "Zero" position. The result is
automatically stored in non-volatile memory (NVM).
Yn Initialize the syringe after moving the valve to the port corresponding to the
number stored for the "~Yn" configuration command.
(n: 4 or 5, refer to command "Wn" for explanations of "n" values) [1]
Zn Initialize the syringe after moving the valve to the port corresponding to the
number stored for the "~Zn" configuration command.
(n: 4 or 5, refer to command "Wn" for explanations of "n" values) [1]
~Yn Select the valve position which the valve will use while initializing the syringe.
This parameter value is used by the "Y4" command. This command checks
the “~V” parameter to determine which port numbers are acceptable.
(n: 1...8) [1]
~Zn Select the valve position which the valve will use while initializing the syringe.
This parameter value is used by the "Z4" command. This command checks
the “~V” parameter to determine which port numbers are acceptable. See the
“~Yn” command for the number-to-port letter translation.
(n: 1...8) [1]
?1 Query the syringe Start speed (“vn” value) in equivalent steps per second.
?2 Query the syringe Top speed (“Vn” value) in equivalent steps per second.
?3 Query the syringe Stop speed (“cn” value) in equivalent steps per second.
?30 Query the acceleration and deceleration numbers (“Ln” and “lm” values).
The first returned number is acceleration and the second is deceleration.
~Y Query the valve port number used by the “Y4" syringe initialization.
~Z Query the valve port number used by the “Z4" syringe initialization.
For non-distribution valves, some valve positions block the syringe port, preventing
fluid from entering or leaving the syringe. The pump does not allow syringe moves
in those positions with such valves.
For each move command, the argument "n" determines both the destination port
and the direction of valve rotation The default direction is clockwise.
I Move a three way standard valve to the "input" position (port A-to-syringe).
The preceding three commands are used with a 3-way non-distribution valve only.
on Move the valve to the position selected by "n". This command is the
preferred command for all valve moves. The values of “n” must be consistent
with the configured valve type (see Configuration Commands). Positive
numbers cause clockwise rotation as viewed from the front. Negative
numbers cause counterclockwise rotation as viewed from the front.
(n: -8...8, not including 0, where 1= port A, 2 = port B, etc., @n) [n/a]
When a valve fails to turn the commanded amount, a valve stall has occurred.
The next valve move command will cause the valve to move to Port A (“1") before
moving to the commanded port if the destination port was other than “A”. The
move to port A is a recalibration move. See Section 5 for error messages.
Due to automatic valve move retries after a valve motor stall, the time for a
valve move can vary significantly. Do NOT use timing loops in controller
software to assume a valve move has completed within the nominal time.
When writing software to control the pump, do not assume a valve move will
complete in a certain time. In the event of a motor stall and subsequent automatic
error recovery attempt, the time required for the valve to complete a valve move
can increase substantially beyond the normal time for a move. Instead, query the
pump status with a carriage return (hex 0D, decimal 13) character to determine if
the pump is busy or the move has finished.
?8 Query the current valve position. Return the ASCII numerical value. (1= port
A, 2 = port B, etc.)
% Query the number of valve movements since the last power-up or Reset.
Return an ASCII number.
~V Query the valve type setting. Return the value of the "~Vn" parameter. (See
Section 4.2.1 for the values.)
sn Send a serial byte from the User Serial expansion Port, MSB first. The value
of the ASCII number "n" is the base 10 representation of the value of a
binary byte. For transmitted bytes, positive logic applies ("1" = high logic
level). In the 2-byte serial mode, "n" represents the second byte sent. The
first byte is the same as the first byte sent by a "sn,m" instruction. See
Section 4.5 for an explanation of "@n" usage.
(n: 0...255, @n) [n/a]
Example: s85 Send the decimal number “85" in binary format. The
serial I/O device will receive the binary number
01010101 (= 85 in decimal - base 10 - format). A “1" is
a high logic level and a “0" is a low logic level.
sn,m Send two bytes from the User Serial expansion Port, byte "m" first and then
byte "n" second. Both bytes are sent MSB (most significant bit) first. The
values of "n" and "m" are expressed as the ASCII base 10 representation of
the binary bytes.
(n: 0...255, m: 0...255, @n) [n/a]
Example: s85, 129 Send the decimal numbers 85 and 129 as binary
numbers. The external serial I/O device will
receive the binary numbers 01010101
10000001. A “1" is a high logic level and a “0" is
a low logic level.
un Turn the user parallel output "n" OFF (open-circuited) or turn off a serial I/O
port output bit.
(n: 1...3 = parallel outputs 1...3
11...18 = serial byte 1, bit 1...8 of the serial expansion port
21...28 = serial byte 2, bit 1...8 of the serial expansion port) [n/a]
A special syntax is available for controlling the outputs while the pump is executing
other commands or a program. This allows immediate, real-time control of the
outputs. The syntax is a variation of the preceding output commands. The syntax
is
These commands use the same values for “n” as the Un and un commands.
Input query commands are sent from a host controller and request a status reply
from the pump. These commands are executed when they are received by the
pump and do not require a “R” command. These commands can not be embedded
in a program string.
?4 Query the "User Input 1" status. Send the value to the host as an ASCII "1"
if "true" (low logic input level) or an ASCII "0" if "false" (high logic input level).
Example:
command /5?4 Query User Input #1 status on pump #5
reply /0'1 /0 = host address (fixed assignment)
‘ = status is “not busy” and “no errors”
1 = input is “true” (low input logic level)
?5 Query the "User Input 2" status. Send the value to the host (see "?4").
?6 Query the "User Input 3" status. Send the value to the host (see "?4").
Example:
command /1?7 Query Digital Voltmeter input on pump #1
?10 Query the value of the first byte received from the Expansion I/O port input.
An input byte is shifted in (MSB first), and the numerical value of the first
input byte is reported in a base 10 ASCII format. The value uses a negative
logic convention (low level = 1, high level = 0). In 1-byte mode, this is the
only byte. In 2-byte mode, this is the first of two bytes.
Example: The inputs for the first byte are 11001001 (201 decimal)
?20 Query the value of the second byte received from the Expansion I/O port
input in 2-byte mode. Two input bytes are shifted in (MSB first), and the
numerical value of the second input byte is reported in a base 10 ASCII
format. The value uses a negative logic convention (low level = 1, high level
= 0). This instruction is not valid in 1-byte mode. See “?10" above for an
example.
?n Query the state of the Expansion I/O port input bit designated by "n". A
serial byte is input (MSB first), and the state of the designated bit is reported
as an ASCII "0" if the bit is "false" (high input logic level) or an ASCII "1" if
"true" (low input logic level).
(n: 11...18 bit 1...8 in Expansion input byte #1
21...28 bit 1...8 in Expansion input byte #2)
These commands are used to control the way a program executes, depending
upon the state of an input variable. The commands are intended to be embedded
within a program string and not to be executed alone. See Section 4.4.3 for more
information about program jumps and labels.
Example: i18b Test bit #8 in Expansion byte #1. If it is at a low level, begin
executing the instructions at program label “b”. If it is not at a
low level, continue with the next instruction after this one.
i<np If the analog input (DVM) value is less than the number in the command,
jump to label “p”. The input voltage range of 0 to 5V is converted into one of
255 levels. The number “n” is the numerical value of the level. This can be
found as n = 51 x input volts, truncated to an integer number.
(n: 0...255, @n p: a...z, A...Z)
i>np If the analog input (DVM) value is greater than the number in the command,
jump to label “p”. The input voltage range of 0 to 5V is converted into one of
255 levels. The number “n” is the numerical value of the level. This can be
found as n = 51 x input volts, truncated to an integer number.
(n: 0...255, @n p: a...z, A...Z)
Commands, command strings, and programs are executed in the pump RAM
(temporary) memory. The pump can also store programs in non-volatile memory
(NVM). The NVM acts like a solid-state disk drive. See Section 7 for details on the
pump’s internal memory.
User program storage commands can load, save, run, or erase user programs in
the pump memory. Program execution commands are used to stop or start
programs. Program control commands determine the order of execution (flow) of
a program.
These commands control the storage, retrieval, and erasure of a user program in
the non-volatile user program memory (NVM). These command execute when
received and can not be placed within a program. A “R” command is not required.
En Store the current command string into non-volatile memory. Maximum
program length is 450 characters.
(n: 1...10 for standard NVM, 11...99 for expanded NVM) [n/a]
?19 Query which program numbers are currently used to store a program.
Return a list of the numbers in use, separated by a space between numbers.
The non-volatile user-program memory and its "auto-start" capability are unique to
Kloehn pumps. The external "Stop" input function is also an added feature on
Kloehn pumps. Only the "H" command can be used within a program. These
commands do not require a “R” command for immediate execution.
~An Enable or disable autostart for a program in NVM. If “n” is not zero, begin
executing the numbered program when power is applied or after a reset.
If autostart is disabled, a stored program is started with the "r n" command.
(n: 0 = disable, 1...10 = enable, @n) [0] (See Section 7.2.3)
fnp If the flag is set (=1), then clear it and jump to label “p”. This is useful to
change the way a program executes if the path has already been done once
before. The program will jump the first time this instruction is encountered,
but not when it is encountered after the first time. A flag is a bit which can
be set (turned “on”), cleared (turned “off”) or tested (if...then). There are
eight flags, numbered 1 through 8.
(n: 1...8 p: a...z, A...Z)
inp If the input level is true (low input level), jump to label "p". This tests if a user
input pin on the card edge connector is at a high or a low level. There are
three user inputs. If an I/O Expansion Board is used, the number of inputs
increases by 16, organized as two bytes of eight bits each.
(n: 1...3 User input number
11...18 bit 1...8 in Expansion input byte #1
21...28 bit 1...8 in Expansion input byte #2
p: a...z, A...Z)
i<np If the analog input (DVM) value is less than the number in the command,
jump to label “p”. The input voltage range of 0 to 5V is converted into one of
255 levels. The number “n” is the numerical value of the level. This can be
found as n = 51 x input volts, truncated to an integer number.
(n: 0...255, p: a...z, A...Z)
i>np If the analog input (DVM) value is greater than the number in the command,
jump to label “p”. The input voltage range of 0 to 5V is converted into one of
255 levels. The number “n” is the numerical value of the level. This can be
found as n = 51 x input volts, truncated to an integer number.
(n: 0...255, p: a...z, A...Z)
s<np If the Expansion input byte has a value less than "n", jump to label "p". This
reads in the value of the first I/O Expansion input byte and compares the
numerical value of the byte against the number in the command.
(n: 0...255, p: a...z, A...Z)
s>np If the Expansion input byte is greater than "n", go to label "p".
(n: 0...255, @n p: a...z, A...Z)
y<np If the syringe position is less than "n", jump to label "p". This is useful in
loops which repeatedly aspirate or dispense until some event occurs. This
test can prevent the error which occurs if a move is commanded beyond
zero or full-stroke.
(n: 0...24000 or 0...48000, @n p: a...z, A...Z)
Example: go1P6000o3A0G10
g...G10 repeat the sequence of commands ten times
A time delay is a pause in a program. These are useful for timing events such as
generating pulses, very slow syringe moves, and event synchronization.
Mn Delay (pause) "n" milliseconds. The "Mn" command will wait for "n"
milliseconds before moving to the next command. 1000 milliseconds = 1
second.
(n: 1...60000) [n/a]
4.5 VARIABLES
There are two types of variables: general and indirect. General variables are set by
the user and are declared before a program is run. Indirect variables use values
obtained from hardware inputs or internal pump values. All variables use the syntax
“@n”, where the @ symbol denotes a variable and the value of “n” denotes the
source of the variable.
There are eight general variables, z1 through z8. There are two forms of syntax
used with the general-purpose variables: one to use the variable in a command and
one to set the value of the variable.
The "zn" command executes as soon as the pump recognizes the command. The
"zn" command cannot, therefore, be stored as part of a program. The values of all
"zn" commands are stored into RAM, and are lost if the power is removed from the
pump or if the pump is reset. The default value of all zn variables is zero after a
reset.
@1 Numerical value of Expansion input byte #1, read as a two-digit packed BCD
number (0...99)
@9 most recently-sent value of the byte #2 sent with the sn,m command
@10 most recently-sent value of the byte #1 sent with the sn,m command
The commands listed in this section may use variables. The column labeled
“Scaled” indicates if the variable is scaled for use with a particular command.
Variables which are not scaled are used as the actual numeric value of a command
argument. Variables which are scaled are used to compute a proportional amount
of the argument’s range. The proportion is
Example: o@3 Not scaled. Use the number as the value. If the number were
“6", the command would be “o6".
Example: V@3 Scaled. The value used for the command will be proportional
to the maximum value of the number. In this case, if the value
of @3 were “127", the actual argument would be 4980. This
is computed as follows:
Configuration commands execute when they are received and do not require a “R”
command. They can not be used within a program. Either upper or lower-case
letters may be used.
~An Select the program to auto-start when the power is turned on. A selection
of "0" means no program is selected for an autostart. If the value is not zero,
the number is the program number to be autostarted after power-up or
~Bn Select the communications baud rate. If no parameter “n” is entered, the
current value of "n" is returned.
(n: 0...7) [3]
~Hn Set the SET HOME button mode on the faceplate. If no parameter “n” is
entered, the current value of "n" is returned. This parameter determines if
the front panel SET HOME button is working or not working. This is useful
for preventing users from resetting the Home position of the syringe.
(n: 0 = the button operation is enabled.
1 = the button operation is disabled.) [0]
~in Enable or disable the valve power-up initialization mode. If no parameter “n”
is entered, the current value of the parameter is returned. When power is
first applied to a pump or immediately after a Reset, the valve normally
performs a move to home (port “A”). In systems with several pumps, it may
be desired to inhibit this initialization move to prevent a large current demand
on the power supply due to all pumps moving at the same time. If the power-
up move is inhibited, the first valve move command or the first syringe
initialize command will cause the valve to perform an initialization move as
the first part of the command.
(n: 0 = the move is enabled and will occur
1 = the move is inhibited and will not occur) [0]
~Ln Set User Input #3 operating mode. If "n" is omitted, the current value of the
operating mode will be returned. The default is 0. Regardless of the
operating mode, the syringe position snapshot feature is active (See “?29"
in Section 4.7).
n Operating mode
0 Normal The input is a normal logic input
1 Limit A syringe dispense will stop when the input goes true
(low), and the input can still be read and tested like a
normal logic input.
~Pn Select the communication protocol. If no parameter "n" is entered, the
current value of the parameter is returned.
(n: 1=DT, 2=OEM) [1]
~Sn Select the Expansion I/O mode. This determines if one or two bytes will be
sent and received for each I/O operation. If the I/O Expander Board is
used, the two-byte mode must be selected. If no parameter "n" is entered,
the current value of the parameter is returned. The factory default is 1-byte.
(n: 1=1-byte transfers, 2=2-byte transfers) [1]
~Yn Select the valve position to which the valve will go just prior to moving the
syringe to the soft limit using the "Y4" command. The "~Vn" value is
checked for a valid entry before accepting the value of "n". This permits a
port different from “A” to be used for the syringe initialization move.
(n: 1...8) [1]
~Zn Select the valve position to which the valve will go just prior to moving the
syringe to the soft limit using the "Z4" command. The "~Vn" value is checked
for a valid entry before accepting the value of "n". This permits a port
different from “A” to be used for the syringe initialization move.
(n: 1...8) [1]
Query commands are executed when they are received. They return a value or
set of values to the query. A query command can be sent at any time, even if the
pump is busy doing something else, and a reply will be sent.
All query commands are executed when they are received and can not be placed
within a program. Query commands do not require a “R” command to execute
immediately.
Q Return the status byte. (See Section 5.0 for status replies.)
The simplest form of status query is a Carriage Return (hex code 0D). The
command “/ address <carriage return >” returns only a single-character ASCII
status byte. Example: /1<CR>
x? Report the last error that was trapped by an error trap instruction.
? Query the syringe absolute position. Return the value in steps from zero
position (top-of-stroke).
?1 Query the syringe Start speed (vn) in steps per second.
?4 Query the status of the User Input #1. Return “1" (“true”) if low or “0" (“false”)
if high.
?5 Query the status of the User Input #2. Return “1" (“true”) if low or “0"
(“false”) if high.
?6 Query the status of the User Input #3. Return “1" (“true”) if low or “0"
(“false”) if high.
?7 Query the voltage at the Digital Voltmeter input. Send the value to the host
controller as an ASCII base 10 number. Voltage = number x 0.02 volts.
?10 Query the first byte value of the Expansion I/O port input. An input byte is
input (MSB first), and the numerical value of the input byte is reported in a
base 10 ASCII format (low input level = 1, high input level = 0). In 1-byte
mode, this is the only byte. In 2-byte mode, this is the first of two bytes.
?19 Query which program numbers are currently used to store a program.
Return a list of the numbers in use, separated by a space between numbers.
?20 Query the numerical value of the second byte of the Expansion I/O port
input in 2-byte mode. Two input bytes are received (MSB first), and the
numerical value of the second input byte is reported in a base 10 ASCII
format. The value uses a negative logic convention (low level = 1, high level
= 0). This instruction is not valid in 1-byte mode.
?29 Query the contents of the syringe position snapshot memory. When the
User input #3 transitions from high to low, the current value of the syringe
position is stored in the snapshot memory. The last two consecutive
snapshots are saved and reported.
?30 Query the acceleration and deceleration values. Return the acceleration
value first and the deceleration value second.
?31 Query the number of syringe backlash steps.
& Report the firmware version as: <letter> <reference P/N> -<ID letter><rev>
(i.e., P54022 -R5)
% Report the number of valve movements since the last power-up or Reset.
* Report the supply voltage in decimal volts, rounded to the nearest 1/10 volt.
The value is averaged over not less than 8 readings.
~A Query the NVM user program autostart state. Return "0" if disabled. If
enabled, report the program number to autostart.
~B Query the communications baud rate. Return the baud number “n”.
n Baud rate n Baud rate
1 38,400 5 2,400
2 19,200 6 1,200
3 9,600 7 600
4 4,800 8 300
~H Query the operating mode of the front panel SET HOME button.
n: 0 = The button operation is enabled
1 = The button operation is disabled
~i Query the mode of the power-up (post Reset) valve initialize move.
n: 0 = The move is enabled and will occur
1 = The move is inhibited and will not occur
Errors may occur during pump operation, in the structure of a user program, during
communications, or in the way a command is given. The pump recognizes these
errors. Normally, an error causes a program or instruction to halt and generates an
error message to be reported in reply to the next received command. This
normal response to an error can be redefined by a user program using a trap.
A user error handler is thus made from three parts: the label which marks the
beginning of the handler, the commands which are the body of the handler, and the
exit command which marks the end of the handler.
A trap instruction takes effect when it is declared in the program. It remains in effect
as written unless it is changed afterwards. Thus error traps can be re-defined “on-
the-fly” in a program. The syntax for an error trap is
If error #n should occur after a trap for error #n is set, the program will jump to the
label “p”. By declaring the same trap with a different label, different error handling
routines can be used for the same type of error in different parts of a program.
Traps can provide graceful recovery or controlled exits from occasional error
conditions. A trap can NOT fix system problems or overcome serious
mechanical difficulties.
The last instruction of an error handler (exception program) MUST be a trap exit
command. Trap exit commands mark the end of an error handler and specify what
action the program is to take when exiting the error handler.
If the exit type “4" is used, use some means must be used to prevent an
“endless loop” of error -> handler -> error -> handler...
This command executes when received and does not require a “R” command. This
command can not be placed within a program.
The counters are organized as one active and eight exchangeable memory
locations. All operations are performed on the active counter. To use one of the
other counter memories, that memory must be exchanged with the active counter.
The value of the active counter will then be placed in the memory location and the
contents of the memory will be placed into the active counter.
The symbol for the counters is “k”. The counter instructions require a “R” command
to execute immediately. The test-and-jump instructions must be used within a
program.
k^n Exchange the contents of counter memory “n” with the active counter.
k<np If the active software counter is less than "n", jump to label "p". A software
counter is internal to the pump and can be set to a number, added to,
subtracted from, and tested. It is useful for counting program events and for
the temporary storage of internal variables such as syringe or valve
position. See Section 4.9.1 for more information on software counters.
(n: 0...65535, @n p: a...z, A...Z)
k=np If the active software counter is equal to "n", jump to label "p".
(n: 0...65535, @n p: a...z, A...Z)
k>np If the active software counter is greater than "n", go to label "p".
(n: 0...65535, @n p: a...z, A...Z)
Example: memory 1 (#1) = 13, memory 3 (#3) = 45, active counter (ac) = 122
Increment #3.
k^3 #1 = 13, #3 = 122, ac = 45
k+1 #1 = 13, #3 = 122, ac = 46
k^3 #1 = 13, #3 = 46, ac = 122
There are six general-purpose flags (f1...f6) and three special-purpose flags (f7...f9).
The flag instructions require a “R” command to execute immediately. The test-and-
jump instructions must be used within a program.
fn? query the status of flag “n”. Return a “0" is cleared or a “1" if set.
(n: 1...9) [n/a]
fnp test the status of flag “n”. If it is set, then clear it and jump to program label
“p”. This is useful for altering the way something is done the first time this
instruction is encountered. The first time will see the flag set and subsequent
times will see it cleared.
(n: 1...8) [n/a]
f-np test the status of flag “n”. If it is clear, then jump to program label “p”. This
is useful for altering the way something is done after the first time it is
encountered.
(n: 1...8) [n/a]
The SET HOME button on the front panel can be inhibited, thus preventing it from
being inadvertently activated by a user. There are two ways this can be done, one
of which is a long-term control and one of which is intended to be dynamically set
“on-the-fly”.
When the button is enabled, pressing the button will perform the “W5" command
function, which sets the current syringe position as the “zero”, or top-of-stroke
position and stores the result into non-volatile memory. This is an operation which
should be done only when the valve, syringe, or washer has been changed or when
the top-of-stroke position needs to be changed.
When the button is disabled, pressing the button has no effect. The two means of
controlling the activation of the SET HOME button are:
~Hn Set the SET HOME button mode. If no parameter “n” is entered, the current
value of "n" is returned. Use this as a long-term enable or inhibit. The
number times the SET HOME function can be done is limited to 10,000.
(n: 0 = the button operation is enabled.
1 = the button operation is disabled.) [0]
f9- Enable the SET HOME button operation. This command operates in RAM
(temporary memory) and is effective as long as power is applied. Use this
command to enable button operation “on-the-fly”.
f9? Query the status of the button flag “f9". Report “1" is disabled or “0" if
enabled.
The ~Hn and f9 flag interact. If the ~H is set to inhibit, the button will be inhibited
regardless of the state of the f9 flag. On useful application of the flags is to set f9
when the system initializes and clear it only when a technician enters an access
code into a controller or activates a User Input to service the pump.
Once stopped, the syringe cannot be moved further in the dispense direction
unless the Limit input changes to an "off" (high) condition or unless the flag #7 is
set. Moves in the aspirate direction can still be made at any time. If flag #7 is set,
then a dispense may be initiated against an active limit input. When the move has
begun, the flag is automatically cleared so that the next limit input transition from
high-to-low will cause the syringe to stop again. This is useful in applications where
successive dispenses are to be made under the control of an external signal, such
as filling containers using a fill-until-signal.
For some applications, it is desired to stop a dispense after the second high-to-low
limit input transition. This is accomplished by setting flag #8. Such a limit action is
useful for titrations where the transition is measured optically and a pair of pulses
is generated through the transition region. If this feature is used in conjunction
with the "snapshot" feature, fully automatic titrations can be done.
Even in the "Limit" mode, the User Input #3 can still be used for the normal logic
functions of reporting Input #3 status to a host and for "test-and-branch" decisions
within a program.
The valve motor is normally off. The valve motor automatically turns “on” at the
beginning of a valve move and turns “off” at the end of a valve move. There are no
rotary forces acting on a valve and the combination of the internal friction in a valve
and the motor detent torque are sufficient to hold the valve in place between moves.
When a move takes place in either the syringe or valve motor, the normal motor
power operation for the move overrides the current state of the “mn” command.
Example:
m0 turn off the syringe motor (motor is off)
A1200 send the syringe to position “1200" (motor is on during
and after moving)
m0 turn off the syringe motor again (motor is off)
An entire command string can be repeated in its entirety by sending the string
repeat command. The syntax is:
This command can be used repeatedly and will repeat the same command string
each time. This command does not work for queries and configuration commands.
Example:
o2A12000o-1A0R Move the valve to port B, fill the syringe, move
the valve to port A, empty the syringe.
Each status byte has two forms: busy and ready. "Busy" means the device is
executing a command or program. "Ready" indicates the device is ready to receive
another command. The status messages are:
Bit 5 of the status byte, denoted by "X" above, is set to "0" if the pump is busy, and
is set to a "1" if the pump is not busy. The Error # is the number used by the error
trapping command.
B, b A command just sent was not recognized as valid. A character was sent
that is not part of the command set. A typing error may have occurred. For
example, "N1000" is not valid because "N" is not a legal command.
C, c The number sent with a command is not valid. The command itself was
valid, but the value sent with it was out of the allowed range of values for that
command. For example, "A25000" has a value, "25000", which is not within
the range of available values. This most frequently occurs when a series of
relative dispenses is commanded, and the last dispense command exceeds
the volume remaining.
E, e A “R” (Run) command was sent with a command which does not require it.
F, f The device supply voltage was too low. The condition may be caused by a
low power supply voltage or by voltage transients on the power supply wiring
near the pump.
G, g A move command was sent while the device was in an uninitialized state.
The device must be initialized before a move command will be accepted.
An initialized state results after a power-up, a reset, or a syringe overload
error.
I, i The load on the syringe drive axis was too great. The syringe motor stalled.
A stall does no damage to the drive system. There are several possibilities:
(1) A fluid path was constricted or blocked. Check for kinks in tubing,
valve washers which may have a shrunken hole, other valves sticking,
and other sources of constriction.
(2) The syringe velocity was too high. Back pressure increases with the
square of velocity. Available thrust force also decreases with velocity.
Reduce the syringe top speed ("Vn" or "Sn").
(3) The acceleration is too high. High acceleration places a power
demand upon the syringe motor in addition to the friction and fluid
back pressure demands. Decrease the acceleration value ("Ln").
(4) The flow path inside diameter is too small for the fluid flow rate. A
larger diameter, shorter path, or lower velocity may be required. The
K, k A syringe move command was not allowed because the valve is in a bypass
position (syringe port blocked), or because the supply voltage was too low.
L, l The User Input #3 limit input is active. The syringe cannot dispense against
an active limit input.
M, m The expanded non-volatile memory (NVM) has failed. Erasing a progam and
restoring it can sometimes overcome this error.
O, o A command was sent while another was executing. The last command
which was sent was not executed and was discarded.
R, r A program label called by a jump instruction was not found in the program.
Remember that the labels are case-sensitive. A label may have been
changed or deleted when editing a program.
S, s A program stored in the non-volatile memory (NVM) does not have the
required end-of-program indicator. The NVM may have been corrupted. Try
saving the program again into NVM.
Z, z The syringe may try to go upwards past the Home (zero) position. This
message is generated whenever a check of the computed syringe position
exhibits an out-of-tolerance error. Syringe “crashes” are avoided by this
means.
When the syringe position is calibrated, the distance from the INITIALIZE
position to the top-of-stroke (zero) is stored into NVM. Each time the syringe
passes up through the INITIALIZE point, the computed position is compared
to the stored value. If the two values do not match within a given error band,
the syringe is stopped and the error message is generated.
The two most common sources of this error are (1) having the Home position
set at the INITIALIZE point and (2), having “lost” (not counted) steps during
a move. Steps can be lost when the “T” command is used to stop a syringe
which is moving at speeds above about 2000 steps pers second or when a
syringe overload occurs.
In the table below, the Switch Setting column is the number to which the Address
Switch is set on the pump. The ASCII Char column refers to the ASCII character
(also the keyboard character) corresponding to the address switch setting. Devices
addressed in this mode will respond with a status byte and an answer to a query.
Multiple pump addressing sends a command string to more than one pump on the
communications bus at the same time. To prevent bus conflicts, the pumps will not
provide a response to a command in one of these multiple-pump addressing
modes.
Pump group 1, 2 3, 4 5, 6 7, 8 9, A B, C D, E
Hex address 41 43 45 47 49 4B 4D
ASCII character A C E G I K M
In the quad device addressing mode, a group of four pumps is addressed. In this
mode, individual devices do not provide status responses to commands.
Pump group 1, 2, 3, 4 5, 6, 7, 8 9, A, B, C D, E, F
Hex address 51 55 59 5D
ASCII character Q U Y ]
The communications software protocols are the command and response formats
used send commands and receive responses from pumps. There are two
protocols: DT (data terminal) and OEM (original equipment manufacturer). Both
software protocols use the same hardware protocol stated in Section 11.6. The
status responses to commands should be monitored by the user's controlling
software to ensure overall system operational integrity.
The DT protocol is a simple data terminal protocol which is compatible with nearly
all terminal emulation programs and basic communications drivers. This is the
preferred protocol in most situations.
Explanation of bytes:
Byte 1: The starting character signals the beginning of a new packet. It is the
front slash character "/" on the computer keyboard, 2F hex.
Byte 2: The device address is a address number for a device or for a group
of devices. It can address a total of 15 devices in the network mode.
Byte 3+n: The ending character indicates the end of a packet. It is 0D hex, the
carriage return on the keyboard.
Explanation of bytes:
Byte 1: The starting character, 2F hex, which signals the beginning of a new
packet, is the front slash character "/" on a computer keyboard,.
Byte 2: The host address, 30 hex (ASCII 0), is the address number for the
host computer.
Byte 3: The status and error byte describes the device status. Refer to
Appendix C for the definitions of the status and errors.
Byte 4+n+2: End of packet character is the line feed character, 0A hex.
Byte 4+n+3: The extra ending character, FF hex, is an extra character to ensure
the packet is properly sent. This character might not be displayed by
the host terminal.
Explanation of bytes:
Byte 1: The line synchronization character, FF hex, indicates a command
packet is coming.
Byte 2: The start transmit character, 02 hex, signals the beginning of a new
packet.
Byte 3: The device address is a address number for a device or for a group
of devices. Up to 15 devices can be addressed.
Byte 5+n+1: The check sum is calculated by an exclusive-or operation on all bytes
except line synchronization byte and check sum byte.
This section describes the response packet format in the OEM protocol. The OEM
response format is identical to the Cavro OEM response format. The response
packet is used to send status and responses from the syringe drive to the
controlling host device.
Byte 2: The starting character, 02 hex, signals the beginning of a new packet.
Byte 3: The host address, 30 hex, is the address number for the host
computer.
Byte 4: The status and error byte describes the device status. Please refer
to Appendix C for the definitions of the status and errors.
Byte 5+n: The end-of-response mark, 03 hex, indicates the end of the response
byte(s).
Byte 5+n+1: The check sum is calculated by an exclusive-or operation on all bytes
except the line synchronization byte and the check sum byte.
Byte 5+n+2: The extra ending character, FF hex, is an extra character to ensure
the packet is properly sent. This character might not be displayed the
host terminal.
There are four communications settings: address, bus termination, baud rate, and
protocol. Baud rate and protocol are set by the configuration commands “~Bn” and
“~Pn” as explained in Section 4.6. The address is set via the Address Switch or the
wiring on the card edge connector, as explained in Section 2.5.2 and Section 3.4.2.
The bus termination setting is explained in Section 2.5.1 and Section 3.4.1.
The bus wiring should connect all RS485 "A" pins to one wire, all "B" pins to another
wire, and all comm ground pins to a third wire. The connections begin at one device
and proceed from that device to the next, one device after another. The three
wires connecting one device to the next should be twisted together with a twist rate
from one to three twists per inch. A wiring diagram is shown in Figure 6-1. The
wiring to connect a PC to the first drive unit is shown in Figure 3.5.
Each end of the bus must be terminated in a network which both biases the bus and
provides the proper impedance. Terminations are made only on the first and last
devices along the bus as shown in Figure 6-1. Terminating networks are provided
on each drive for these purposes. To terminate the bus, set toggle switches 3 and
4 to the “ON” position for the first and last pumps on the RS485 bus. All pumps
between the first and last must have these toggles set to “OFF”.
Only the pump at each end of the RS485 bus may have the RS485 Bias
switched “on”. All pumps between the two end pumps MUST have their
RS485 Bias Switched “off”. See Figures 2-1 and 2-3.
After the communications wiring is connected and the PC serial port cable has
been connected to the first device on the bus, turn on the pumps. When the power-
up valve move is complete, send a Query of the module status as shown next. If
needed, see Section 3.3, Section 3.4, and Section 3.5 for communications setup
instructions.
Note: If the query is sent while the power-up initialization sequence is in progress,
no response will be seen. The pump does not "listen" until the power-up sequence
is completed.
If there is no response, then if the pump is not powered up, the communications
hardware connection is not properly made, or the communications program is
either not properly configured or not operating correctly. Check the items below:
(1) Insure that the communications connector is inserted properly into the RS-
232 connector and NOT into the RS485 connector.
(2) Try another comm port selection in step (5) of the Terminal program setup
procedure (Section 3.5.1).
(3) Using a voltmeter, with the communications cable connected to the RS-232
pins on P1, measure voltages from the "GND" pin to the "RXD IN" pin and
the "TXD OUT" pin. Each pin should measure -6 Vdc to -15Vdc. If they do
not, the following errors may exist.
(a) "RXD IN" fails the check: the host PC port is not functioning, the
Kloehn Company provides a driver called KSerial which operates from the
command line and can be called from within a user’s program. KSerial handles all
the communications overhead with Kloehn pumps in both DT and OEM protocols.
IA0A3000M500OD1500
In a command string, each new command will execute immediately after the
preceding command has completed. The command sequence will run in the
minimum possible time without the need to query the drive to determine whether it
is busy or ready for the next command. This can eliminate much communications
overhead. Such a program can be executed immediately or some time after the
program is sent to the drive. It can be executed from temporary memory (RAM) or
from non-volatile memory (NVM).
When a command string is sent to the drive, the string is entered into temporary
memory (RAM). This memory retains its contents while power is applied to the drive
unit. When power is removed, the contents of RAM are lost. After a command
string is executed, it may be repeated by sending the "X" command.
To execute a program at the time it is sent, append a "R" (“Run”) command to the
string. If no "R" command is appended, the program will execute when a
subsequent "R" command is sent. If another command is sent after the program
string and before the "R", or if the "R" is appended to another command, the
original program string will be overwritten by the last command string.
For example, the command "D1000R" will execute as soon as it is received by the
drive. The command "D1000" will be stored into RAM, but will not execute until a
separate, subsequent "R" is sent.
Non-volatile memory (NVM) will retain its contents for at least 15 years without
power. Thus the NVM acts as if it were a "solid-state disk drive". Up to ten
programs can be stored in the standard NVM which is part of all pumps. An
expansion option provides additional storage for up to another 89 programs. The
maximum number of times a program string may be written into the NVM is 10,000.
After 10,000 writes, the integrity of a stored program cannot be guaranteed. There
is no limit to the number of times a stored program can be read or executed.
The maximum number of times a program string may be written into the NVM
is 10,000. After this, the integrity of a stored program is not guaranteed.
Because of the limitation on writes, NVM should not be written every time an
application is run. It should be used to store a command sequence or program if
that program will be long-lived in the application. Short-term programs such as
programs which can change often, should be executed from RAM. Some program
which vary in the numbers but not in structure can use general variables, as
explained in Section 4.5.
The VersaPump 6 has the ability to automatically begin executing a program stored
in NVM when power is applied. This feature is known as "Autostart". This is useful
for those applications which may require rapid and automatic pump initialization or
in cases where a program sequence is controlled with User Inputs or Expansion I/O.
The Autostart feature is enabled by setting the "~An" parameter to "1" with the
"~A1" command. The auto-start can be disabled by setting the "~An" parameter to
"0" with the command "~A0". These commands require no "R" command.
The Com Setup Switch (Figure 2-3) DEFAULT toggle switch must be set to
OFF for the Auto-Start feature to function. The toggle will inhibit Auto-Start.
This section discusses best practices when writing software to control the pump.
These techniques represent years of practical experience in developing
applications.
When a pump is installed into a system, the pump may not have the configuration
parameters set to the needed values (see Section 4.6 for configuration
parameters). Such parameters include valve type, I/O operating modes, and
initialization parameters. The overall system reliability in the field is greatly
enhanced if the controller software can perform the setting of these parameters as
needed when a pump is installed.
Do NOT set the configuration parameters each time the system is powered-
Query <parameter>
if <parameter> is not the <desired value> then Set <parameter>
For example, if the valve type should be “6", the code might look like this in Basic:
Using this technique, factory installations and field replacements will always be
correctly configured. This technique can also be used to ensure any required user
programs are stored into the NVM. If an external text-based configuration file is
used, servicing the system software becomes an easy matter.
Commands might NOT take the same time to execute if an error condition
occurs. Do NOT use timing loops as a means of establishing when to send
The only valid way to determine if the pump is ready to accept another command
is to query its status. The simplest way to do this is to send just the address and a
carriage return character (hex 0D or decimal 13). A typical query might be:
/1<Carriage Return>
Wait for the reply and check the status byte to see if the pump is ready or busy (see
Section 5.1 for the status codes). The queries should not be sent too fast.
Checking at a rate of eight times per second or less is adequate for nearly all
systems. This also permits the controlling software to discover error conditions
much sooner than would otherwise occur.
Two situations are deserve special acknowledgment: valve moves and traps. If a
valve motor stall occurs, the valve will automatically attempt a recovery (see Section
4.2). The recover attempt can take up to several seconds. An error trap causes the
program to go to a user program to handle the error (see Section 4.8). This can
extend the time required for a program sequence to complete.
A second way to determine when the pump has completed a task or operational
cycle is to program the pump to set a User Output to ON when each instance of the
task is done. A controller can sample the controller input to which the pump output
is connected. This technique avoids the communications overhead.
Many tasks are repetitive. These include priming cycles, wash cycles, and some
fixed I/O routines. The essential nature of such command sequences is that they
never vary; they always execute exactly the same way. Such a routine is a good
candidates for a stored program. By storing such a routine in the NVM, the
overhead of repeating it in a program or sending a long command string can be
avoided. A program can “call” a stored program with the call command “jn”. A host
software program can call the routine with the stored program “run” command “r n”.
Calling stored routines is a very efficient way to handle repetitive tasks. With the
use of general variables (see Section 4.5.1), even tasks which vary only in the
numbers, but not in the sequence of events, can be stored and called, with the
numbers set when the routine is called.
The pump has two buttons on the front panel. The INITIALIZE button simply moves
the syringe to the internal calibration point. If a user presses this button, no harm
is usually done. The upper button is the SET HOME button. If a user presses this
button, the location of the zero point is reset to some indeterminate (and probably
wrong) location and errors in operation are likely to result.
Button-induced user errors can be avoided by using the HOME button inhibit
features. The button can be inhibited long-term using the configuration command
“~Hn”, which inhibits the button via the NVM. This is useful when only a service
technician is allowed to replace syringes, valves, or washers.
If the user is to be allowed to set a new HOME position, there may be an advantage
in inhibiting the SET HOME button as part of the system initialization. The user, like
a technician, would then enter a “setup” mode to enable the button. The button
would be disabled when the setup mode is exited. For this operation, use the “f9"
flag, as this is not written to NVM. See Section 4.9.3 for operational details.
This section offers techniques for programming the pump using pump command
strings. These techniques extend the usefulness of the pump.
Thus the complete program string for a dispense is then “gD1MnGm”. The
equivalent speed is found as the reciprocal of the time to execute one pass
through the loop.
Speed = 1/Time
Example: gD1M17G6000 (Start Speed = 650)
The calculations above may require fine adjustment in “n” for greater accuracy in
very slow moves.
Errors can occur during operation of the pump. Errors can range from incorrect
commands to motor overloads. The pump can detect most error conditions (see
Section 5). For some systems, the robustness of the design can be enhanced by
programming the pump to take corrective action automatically. This is called
trapping and the part of the user program designed to handle the error is called the
error handler, or exception handler. The syntax to do this is given in Section 4.8.
This section will provide an examples of error trapping.
Example: Trap a syringe overload error. Save the value of the syringe position,
initialize the syringe to the input port, then return to the stall position
and continue the dispense. Note: this assumes the dispense was
intended to deliver all the contents of the syringe.
In the main user program, the trap is set by declaring:
x9V If a syringe overload (#9, see Section 5), occurs, go to label “V”.
At the end of the program, where error handlers are normally located, the
handler might be as follows:
There are some limitations on error trapping. The error trapping feature is designed
to provide a graceful recovery from errors, but it can not fix system errors. Any error
induced by mechanical or fluidic problems cannot be fixed by a program. Such
things must be fixed at the external root cause. In some cases, a syringe overload
might be handled by reducing the syringe speed and trying again.
Error trapping can NOT fix external mechanical or fluidic problems. Trapping
is intended to provide graceful systems exits from error conditions.
Example: Recover from a valve overload by initializing the valve and then
repeating the valve move. An “error cycle counter” is included to
prevent a run-away loop.
Example: If any error occurs, set the User Output #2 low, set User Output #1
high, save the current Digital Voltmeter input value, and then exit the
program.
Set the error trap in the main program:
At the end of the program, where error handlers are normally located, the
handler might be as follows:
The syringe motor does not start at zero speed and accelerate smoothly to the Top
Speed (at which syringe moves normally occur). Rather, the motor jumps abruptly
from zero to the Start Speed and then accelerate smoothly to the Top Speed. The
move proceeds at the Top Speed. As the destination is approached, the motor
decelerates from the Top Speed to the Stop Speed. When the Stop Speed is
reached, the motor performs an abrupt stop at the target position. The speed profile
is thus trapezoidal, as shown in Figure 8-1.
If a high Top Speed and low acceleration are combined with a very short move, the
syringe speed may not reach the programmed Top Speed and the profile of Figure
8-2 will result.
The back-pressure of a fluid in motion is greater at the syringe than at the delivery
point. The difference between the two is the pressure rise. The pressure rise can
exceed several hundred psi (tens of atmospheres) in some cases. Here are some
of the factors which contribute to the pressure rise and consequent back-pressure:
Factor Effect
Path diameter Pressure varies as fourth power of diameter
Path length Pressure varies directly with length
Fluid velocity Pressure varies with square of velocity
Temperature Temperature changes viscosity, which changes back-
pressure. Over 5:1 variations are possible.
All these effects are cumulative. Bar far the most sensitive is the path diameter.
An increase of just 19% in inside diameter of the tubing or an orifice can drop the
back pressure by as much as 50%. One source of gradually increasing back-
pressure is too much torque on the fittings used with the valve. The valve requires
Teflon® washers to seal the fitting-to-valve connection. If the fittings are tightened
too much, the pressure of the connection will cause the Teflon to “cold flow” in a
way that reduces the size of the hole in the washer. In extreme cases, the hole can
shrink to a pin-hole.
Higher fluid velocities have two reinforcing effects: (1) the pressure increases as the
square, and (2) the available motor power decreases with increases in speed. If
syringe overloads are occurring, small reductions in Top Speed can produce major
improvements in system reliability.
If a move fails to begin, the problem may be too high a Start Speed or a blocked
fluid path. In general, the default value of Start Speed is a good compromise.
If the pump generates frequent “Z” errors (error #26), the cause may be too high a
Stop Speed. An abrupt stop from too high a speed may cause syringe position to
become corrupted, resulting in the error message. In nearly all cases, no value of
programmed deceleration will result in this problem.
When adjusting the speeds, consider the trade-offs and consequences. Most
problems are the result of too high a Top Speed or too high a Stop Speed. The Top
Speed must be set to accommodate the dimensions of the fluid path, the fluid
viscosity, and the decreasing thrust force as speed increases.
The number of times a given event has occurred can be determined with the
Software Counter (see Section 4.9.1). In the example below, the number of times
a programmed dispensing sequence has occurred is counted so a controller can
query the pump to determine the number of dispenses which have occurred since
the program was initiated.
In the example above, the program begins by setting the counter to zero. the
syringe is refilled each time the syringe position is too small to do another dispense.
After each dispense, the counter is incremented by “1'. The counter can be queried
at any time to read how many dispenses have occurred. The complete program
string would be:
k0:Bo-1A48000o3:Ay<1500BD9600k+1JA
The conversion of syringe volume to steps (syringe increments) can be easily done
using a proportion.
steps required = desired volume
total steps in full stroke total volume of full stroke
Set up proportion:
steps required = 250 µR
48,000 5000 µR
While the input is high, the test for input #3 to be low will fail and the jump to
“T” will not be taken. The next command, “Jr” is therefor executed. The “Jr”
command send the program execution back to the “r” label and the test will
be repeated. When input #3 goes low, the jump to label “T” will be taken.
Label “T” then leads to the next instruction in the program.
Figure 8-3 shows the wire connections for a handshake. It is assumed the
necessary ground connection between the pumps is present. Each pump has one
output connected to and input on the other pump. This allows each pump to send
a signal to the other pump. The sequence of operations is illustrated in the voltage-
time diagram of Figure 8-3.
First Handshake:
At the beginning, both outputs are idle at the high level.
At (1), pump 2 sets its Output #2 low to signal pump 1 to begin its next operation.
At (2), pump 1 sees the signal and sets its Output 2 low to indicate “signal seen”.
At (3), pump 2 sees the response from pump 1and resets its output back high.
At (4), pump 1 sees the return high from pump 2 and sets its output back high.
After (4), pump 1 begins its next operation and both outputs are in the initial state.
Second handshake:
The handshake command strings are the same for each pump. Any of the User
Inputs and Outputs could have been used. The handshake command strings for
the preceding example are as follows.
Receiving a handshake:
:C label “C”
i2D if input is low, go to label “D”
JC if not low, go to label “C”
:D input is low
u2 set Output #2 low to say “signal is seen”
:E label “E”
i2E if input is still low, check it again
U2 input went high, so set out back to high
One special case of a handshake is the handshake dispense, described in Section
8.3.3. This command provides an automatic handshake sequence.
When a continuous fluid flow is required, the handshake dispense commands may
be used to synthesize the flow using two pumps. The resulting flow is continuous,
with no gaps in delivery. The handshake connections and signal sequences
explained in Section 8.3.2 are used, but the handshaking is an inherent part of the
instructions and does not require any programing.
The input ports of both pumps are connected with a “T” fitting so a single source line
is used. The output ports of both pumps are connected together with a “T”
connection to sum the two outputs into a single delivery line.
As one pump is dispensing, the other pump is refilling. When pump A approaches
the end of its dispense, it signals pump “B” to begin to dispense. W hile pump B is
dispensing, pump A refills itself. The handshake signals which tell each pump to
begin its dispense are generated by the dispensing pump just prior to finishing a
dispense. As one pump is finishing a dispense, the other begins and the fluid flow
is thus continuous.
When this instruction is encountered, the pump begins testing User Input #n for a
low level. When a low level is seen, a dispense begins. The dispense is always
from the current syringe position to zero (the full-dispense position). As the
dispense nears the zero position, the User Output #n is set low just before the
dispense ends. This is used as advance notice to the other pump to start its own
handshake dispense. All these I/O operations are automatic.
To begin a handshake dispense without an external trigger signal, use the syntax
“h-n”. This is useful to start a handshake dispense operation or to resume one that
has been stopped.
The Digital Voltmeter (DVM) input can be used as a selector switch. If repeatable
voltage levels can be applied to the DVM input, a series of tests can be made to
determine what the program should do next. These levels can be generated from
a digital-to-analog converter or from a series of resistors soldered around a selector
switch to form a tapped voltage divider. In the following command sequence, each
test level is chosen to be half-way between the actual voltage levels, not at the
voltage levels. This is done for noise immunity.
The snapshot feature uses the User Input #3. Each time the User Input #3
transitions from high-to-low, the current location of the syringe is stored in memory.
The snapshot memory retains the positions for the two most recent input
transitions. The syringe positions for these two points can be queried at any time
with the “?29" query. This feature is always available regardless of the input #3
operating mode.
The snapshot feature is very useful for titrations using optical detection, where the
detector outputs a double pulse and the two positions at the time of the pulses must
be known. It is also useful in any application in which the amount to be dispensed
is unknown in advance and must ve determined on-the-fly during the process.
The V6 includes three digital inputs, three digital outputs, and a Digital Voltmeter
input as part of the standard unit. For those applications which need more I/O or
different I/O, an Expansion I/O port is also included. The Expansion I/O port is a
synchronous serial port which can increase the I/O by either one byte (eight bits of
input + eight bits of output) or two bytes (16 bits of input + 16 bits of output). Kloehn
makes an I/O Expander Board (P/N 50765) which implements the two-byte
expansion.
The 50765 I/O Expander Board is an example of the I/O increase possible with the
Expansion port. The 50765 provides 16 extra inputs which can be operated as two
bytes or bit-by-bit, and 16 extra outputs, each of which can switch up to 250
milliamperes at up to 40 Vdc. These can be used to control solenoid valves, relays,
indicator lights, or other motors.
sn,m Send two bytes from the User Serial expansion Port, byte "m" first and then
byte "n" second. Both bytes are sent MSB (most significant bit) first. The
values of "n" and "m" are expressed as the ASCII base 10 representation of
the binary bytes.
(n: 0...255, m: 0...255, @n) [n/a]
Un Turn the user parallel output "n" ON (low logic level) or turn on a serial I/O
port output bit.
(n: 11...18 = serial byte 1, bit 1...8 of the serial expansion port
21...28 = serial byte 2, bit 1...8 of the serial expansion port) [n/a]
un Turn the user parallel output "n" OFF (open-circuited) or turn off a serial I/O
port output bit.
(n: 11...18 = serial byte 1, bit 1...8 of the serial expansion port
21...28 = serial byte 2, bit 1...8 of the serial expansion port) [n/a]
The inputs are read by these commands, which are executed immediately upon
receipt and cannot be included in a program:
?10 Query the value of the first byte received from the Expansion I/O port input.
An input byte is shifted in (MSB first), and the numerical value of the first
input byte is reported in a base 10 ASCII format. The value uses a negative
logic convention (low level = 1, high level = 0). In 1-byte mode, this is the
only byte. In 2-byte mode, this is the first of two bytes.
?20 Query the value of the second byte received from the Expansion I/O port
input in 2-byte mode. Two input bytes are shifted in (MSB first), and the
numerical value of the second input byte is reported in a base 10 ASCII
format. The value uses a negative logic convention (low level = 1, high level
= 0). This instruction is not valid in 1-byte mode.
?n Query the state of the Expansion I/O port input bit designated by "n". A
serial byte is input (MSB first), and the state of the designated bit is reported
as an ASCII "0" if the bit is "false" (high input logic level) or an ASCII "1" if
"true" (low input logic level).
(n: 11...18 bit 1...8 in Expansion input byte #1
21...28 bit 1...8 in Expansion input byte #2)
In the circuit of Figure 8-4, the user inputs are labeled with their equivalent binary
weights, with “128" as the most significant bit. The inputs are shown with pull-up
resistors (4.7K) and series input protection resistors (100K). These resistors are
highly recommended. This circuit will provide an extra eight bits of input in the one-
byte mode (see Section 4.6).
If the two time delays are omitted to obtain the maximum pulse rate, the resulting
pulse rate is about 400 pulses per second.
In some applications, one of several selections must be made via a selector switch
or PLC logic lines. The most economical approach is to encode the inputs as binary
numbers. This section describes a way to program a binary selection tree. This is
a way of making the input bits act as if they have a binary weighting (e.g., 1, 2, 4,
etc.). This illustration uses all three inputs as a seven-way selector. The Expansion
I/O could also have been used to input the bits with the same instructions (see
Section 8.3.6 for Expansion I/O commands). Figure 8-5 shows a flow chart of the
algorithm.
External LED (light-emitting diode) indicators can be driven from the User Outputs.
The diode anode should be connected to +5Vdc through a 470-ohm resistor.
The LED cathode is connected to the output. When the output is turned “on”, the
output level will go low and turn on the LED. The output level will still be low enough
to drive other external logic. A “super-bright” LED should be used.
An output could also drive the input to an opto-isolator. The internal opto-isolator
LED should be connected as described above. The drive current will be about eight
milliamps.
The Error Out output can also drive an LED. This output should be connected as
described above, or the anode of the LED can be connected to the Error Bias pin,
which provides an internal resistor to +5Vdc.
The User Outputs 1, 2, and 3 are suitable for driving a variety of loads. The open-
drain MOSFET outputs can drive up to 170 milliamps (mA) and withstand voltages
to 12 Volts greater than the pump power supply voltage, up to a peak of 50 Vdc.
Each output includes integral protection against inductive turn-off transients, as
shown in Figure 8-6. The zener diode provides about 13 Volts across and inductive
load during the current decay to speed up the inductive load turn-off. Typical
inductive loads are solenoids , solenoid valves, relays, and small DC motors.
This section describes the low voltage condition detection, the selection of power
supplies, and good power distribution wiring practices.
The power supply capacity should be consistent with the specifications of Section
11.3 of this manual. If a Kloehn power supply is used, these specifications will be
met. One Kloehn P/N 17732 power supply has sufficient capacity to power two
VersaPump 6 devices.
An output capacity of 40 watts at 24 Vdc is considered a practical value for a one-
pump power supply for normal pump operation. The normal idle power
consumption is about 11 watts. The 40 watt rating allows for the maximum power
required during syringe and valve moves, with a small reserve for reliability.
For multiple pumps on one supply, the overall system operation should be
considered. If there are N pumps, of which only M units will be making a syringe or
valve move at the same time, then the average power capacity of the supply should
be at least P = 40M + 11(N-M) watts. The pump automatically turns on the valve
motor for moves and then turns it off when not moving. See section 8.2 for
additional multiple-pump system wiring considerations.
At power-up, all the valve motors will make simultaneous valve calibration moves,
demanding about 1.1 Adc each. To allow for the valve calibration moves, the power
supply should have a peak power capacity of P = 40N watts. The peak capacity is
often not specified directly. It can be calculated from the peak current specification
(Ipk) as P = 40N(Ipk). If this results in an excessively large power rating for the
normal system operation, the power-up initialize inhibit parameter can be set to
prevent the power up moves (see Section 4.6).
In-rush current at initial power-up is the idle current plus the current required to
charge the nominal 470 uF capacitance at each pump power input. For almost any
power supply, this current will be well within its capacity.
There are three general types of power supply: unregulated DC, linear regulator
types, and switching regulator types. Each has different selection considerations.
The unregulated supply is the cheapest and simplest. Its output voltage will
typically vary about 5% to 20% from no-load to rated load. In addition, the output
will vary in proportion to the input line voltage. Since the driver is specified for
24Vdc ± 10%, it is not recommended for use with the V6 pumps.
The linear regulator supply usually has a current limiting feature which must be set
high enough to handle any current transients generated by the syringe drive. If the
current limit is too low, erratic pump operation will result with no obvious cause.
A switching power supply is the preferred choice. It offers higher efficiency, lower
heat generation, and a well-filtered output. Some switching power supplies have
a minimum load current requirement. Since the pump can idle as low as 70
milliamps, the supply should be rated for a minimum load current equal to the
minimum total system idle current. A ballast resistor may be added across the
supply output to guarantee the minimum load requirement of the supply.
The use of an output filter in each line can reduce radiated and conducted EMI.
The simplest filter consists of a series inductance of about 10 uH (rated at 2.5
amps) inserted in-line with the positive power wire near to the pump.
The J1 interface connector has two power input pins and two ground pins. Good
wiring practice uses both opposing pins for the positive lead and both opposing
pins for the ground lead. Redundant pins ensure reliable power connections.
If communications upsets occur during ESD
testing when high-voltage arcs are injected into
either the controller or the syringe drive,
insertion of a ferrite common-mode choke with
good high-frequency impedance may eliminate
the problem. The power and communications
lines should be looped two or three times
through a ferrite toroid having an outside
diameter of about one inch.
Improved EMC performance can often be
realized by grounding the pump faceplate. The
black anodize surface coating should be
removed from around a lower mounting hole
and a thick wire should be used to connect the pump to a nearby ground plane.
Syringe drives should not share the same power leads as large, noisy electrical
loads such as motors and large solenoids. While the syringe design contains
filtering to reduce susceptibility to electrical noise conducted via the power supply
wires, large current or voltage transients could be harmful to the pump.
If the pump supply voltage decreases below the internal reference minimum (20V),
a "Low Voltage" error condition is generated. While the voltage remains below the
minimum, valve and syringe moves are inhibited. For supply voltages down to
about 8 Vdc, the internal control electronics and memory are not affected and other
instructions, such as I/O operations and queries, will still operate normally after the
low voltage error message has been reported or cleared.
Some power supplies will turn on gradually. If the rise time of the supply is slow
enough, the internal computer may generate a "Low Voltage" error when the pump
powers up. This will not cause any operational problems after the power has
stabilized and communications has been established. The error message will have
to be cleared before any other commands can be executed. The message can be
cleared by querying the pump status.
If low voltage errors persist when a voltmeter check of the power supply appears to
show a proper voltage, the problem may be transients on the power supply leads.
Transients may be induced by wiring which passes close to other high-current
electrical loads, by current-limiting operation of linear supplies, by transients passed
through the power supply from the ac power source used by the supply, or by using
a wire size which is too small for the length.
The V6 pump draws a current which depends upon the power supply voltage, the
idle logic current, and the motor currents. The current consumption can be
minimized in some applications through the pump programming.
The supply voltage is inversely proportional the current consumption. This is
because the pump is a constant power device. As the voltage increases, the
current decreases so the product of the two will remain approximately constant.
The capacity of a battery for portable operation is thus best estimated using a watt-
hour rating (watt-hours = ampere-hours x volts).
The motor current is the sum of the valve motor and syringe motor demands. The
valve motor draws current during a valve move, and automatically turns off when a
valve ends. The valve motor automatically turns on at the start of a valve move.
The Syringe motor normally idles at half-power. When a syringe move begins, the
syringe switches to full-power operation for the duration of the move. When the
move ends, the power automatically switches back to half-power. If the syringe is
not required to hold a significant back-pressure, the syringe motor can be turned
off at the completion of each move, thereby reducing idle power to the logic idle
power alone. The logic idle power alone is typically about 2 Watts.
10.1 MOUNTING
The mounting dimensions of the VersaPump 6 are shown in Figure 10-1. The drive
is usually base mounted using the holes in the bottom of the front and rear
mounting feet. Alternately, the pump may be face-mounted.
An instrument enclosure to which the drive is mounted should have good electrical
conductivity to the system chassis ground. This will reduce radiated emissions
from the equipment. A wire from the pump chassis to the equipment chassis will
generally not provide a satisfactory system ground because it does not provide the
high-frequency transient conductivity required. See the illustration of preferred
versus unsatisfactory wiring types illustrated in Section 9.2. If possible, a metallic
enclosure or a plastic enclosure with RF shielding is preferred.
The pump has been designed with a large operating ambient temperature margin.
This margin depends on a good natural convection air flow across the driver side
plate. The power devices on the driver board, on the right side as viewed from the
rear, use the side plate as a heat radiator for cooling. If air flow is inhibited, the
driver board may overheat and fail prematurely.
Adequate air venting for an enclosure is required for system reliability. In most
applications, a large cooling air inlet at the bottom of an enclosure and an adequate
hot air vent near the top can provide adequate ventilation.
When measuring the internal temperatures, a temperature probe placed into the
center of the pump cavity is generally not adequate. The probe should measure
the temperature on the inside of the left side plate near the front of the pump.
11.1 ENVIRONMENTAL
Temperature
Operating -25 to 55 °C (-13 to 131 °F)
Storage -25 to 85 °C (-13 to 185 °F)
Humidity 5 to 95% RH, non-condensing
Altitude
Operating 10,000 feet pressure altitude, maximum
Non-operating 40,000 feet pressure altitude, maximum
11.2 PHYSICAL
Height 10.00 inches 254 mm
Width 2.55 inches 64.77 mm
Depth 4.75 inches 181 mm
Weight 5.07 pounds 2.30 Kg
11.3 POWER
Voltage 20 to 30 Vdc, 24 Vdc nominal
Current (at 24 Vdc)
Idle, syringe on 0.42 to 0.48 Adc
Idle, syringe off 0.08 Adc
Valve move 1.8 Adc
Syringe move 1.0 Adc
Turn-on surge 2.5 A peak, 15 msec
Power consumption
Idle, syringe off 2 Watts, max.
Idle, syringe on 11 Watts, max
Syringe or valve in motion 36 Watts, max.
The syringe axis is designed to drive a syringe having a full-stroke length of 6 cm.
11.4.1 Resolution
The syringe axis is available in two resolutions: 24000 steps and 48000 steps for
the same 6 cm stroke length. The resolution is predicated on mechanical design
and is not electronically “inflated”. Which of the two resolutions is applicable
depends upon which model is purchased.
11.4.2 Accuracy
Accuracy is described by two parameters: accuracy and precision. For both, the
value given is expressed as a percentage of the full stroke of the syringe. Accuracy
measures how closely a dispensed amount of fluid corresponds to the ideal
Additional factors contributing to system accuracy are the total syringe size, any air
bubbles or gaps, and any elasticity in the fluid path. The syringe tolerance is a
maximum ±1% of total volume. This error contribution is proportional to the
amount dispensed as a fraction of syringe volume. Air bubbles, gaps, and tubing
elasticity can contribute errors due to compressibility or expansion of their volumes.
Such errors are proportional to the positive or negative fluid pressures in the fluid
path.
For small dispensed volumes, the accuracy of the volume can be sensitive to the
means by which the volume is removed from the probe of tubing tip. Any meniscus
can contribute several microliters of dispense error. To minimize these errors,
submerge the tip into the destination fluid or "touch off" the tip against the container.
11.4.3 Speed
Syringe speeds are measures in steps per second. The definition of a step is one
increment of motion.
The 48000-step model has a typical maximum thrust of about 50 pounds or more
at any speed. For the 24000-step model, as the syringe speed is increased, the
available syringe thrust can decrease substantially, as shown in the next table.
Syringe friction is larger for the larger syringes. The largest is the 50 mL, with about
five to seven pounds of friction. The smallest syringes have about one to three
pounds of friction.
11.6 COMMUNICATIONS
The VersaPump 6 syringe drive has two serial communications protocols: OEM
and DT. The two protocols are compatible with the corresponding Cavro protocols.
In each case, the pump acts as a slave device. It cannot initiate communications,
but can only respond to commands from a controlling device. All communications
are serial, half-duplex data transfers. The RS232 and RS485 interfaces are
supported.
All communications use ASCII characters for both commands and responses. All
numbers are expressed as ASCII decimal numbers. The two protocols, DT and
OEM, are explained in Section 6.3.
The following subsections describe the User Inputs/Outputs (User I/O) available on
the 50300 Syringe Drive Unit. There are 3 parallel digital outputs, 3 parallel digital
inputs, one digital voltmeter input, and a serial I/O expansion port for adding
additional I/O externally.
There are three digital outputs. These are open-drain MOSFETs. The outputs can
be controlled from within a program or by external command. They are suitable for
driving relays, solenoids, indicator lights, opto-isolators, or the logic inputs. In
DC or peak load current: 170 mA maximum per output (4 watt load at 24 Vdc)
Output resistance: 5 S typical
Output voltage: 45 Vdc maximum (external load supply voltage)
Output leakage (off): Io < 100 µA
There is one digital voltmeter input. This input performs an 8-bit analog-to-digital
conversion. An anti-aliasing input filter is included. See figure 2-2 for the input
equivalent circuit.
The voltmeter specifications are:
The Serial I/O Expansion Port (IOX) provides a means to expand the number of
external inputs and outputs of the pump. An I/O Expander board (P/N 50765) is
available to add 16 additional inputs and 16 additional outputs. Each of the
expander outputs can sink up to 250 mA at voltages to 40 Vdc.
The IOX has one 6-pin interface which simultaneously shifts output data out from
the port, input data into the port, synchronous clock pulses out from the port, and
provides a timing strobe signal output. The strobe output is active low during a data
I/O operation. +5V and ground, for powering external I/O circuits, are available on
the connector.
Inputs:
Logic "0" +3.5 V to +5.0 V
Logic "1" -0.3 V to +1 V
Input current < 10 :A
Outputs:
Logic "0" < 0.4 V at 1.6 mA sink
Logic "1" > 4.2 V at 0.8 mA source
+5V output: 100 mA dc to load, maximum
Clock:
Quiescent level Logic "0"
Active edges Positive-going
Frequency 115.2 KHz
Data Strobe:
Quiescent level Logic "1"
Data hold time 0 sec
Data transfer cycle time (strobe pulse width):
1-byte mode 93 ± 4 :sec
2-byte mode 187 to 262 :sec
The Error LED output provides drive for a light-emitting diode (LED) or external logic
whenever an error condition exists within the pump. See Section 5 for a list and
explanations of error conditions. Refer to Section 2.2.2 for Error output details.
Error +: internal +5 Vdc supply, internally current limited through 330 ohms
Error -: 5 ohm resistance to ground when in ON (error) condition,
open-circuit (> 1 Mohm) when in OFF (normal no-error) condition
en (i) program erase (n: 1...10 with std NVM, 1...99 with exp NVM) {4.4.1}
inp (p) if input bit is "true" (low level), then jump to label "p"
(n: 1...3 = User Inputs 1...3
11...18 = Expansion I/O input byte 1, bits 1...8
21...28 = Expansion I/O input byte 2, bits 1...8
@
p: a...z, A...Z) {4.3.3}
i>np (p) if Digital Voltmeter input is less than "n", then jump to label "p"
(n: 0...255, @ p: a...z, A...Z) {4.3.3}
i<np (p) if analog (digital voltmeter) input is greater than "n", then jump to label "p"
(n: 0...255, @ p: a...z, A...Z) {4.3.3}
Jp (p) jump always to label "p" (p: a...z, A...Z) {4.4.3}
jn (p) execute program #n and then return to next instruction in this program
(n: 1...10, @) {4.4.3}
k-n subtract "n" from the software counter (n: 0...65535, @) {4.9.1}
k^n exchange the contents of counter memory “n” with the active counter
(n: 1...8) {4.9.1}
k<np (p) if the software counter is less than "n", then jump to label "p"
(n: 0...65535, @ p: a...z, A...Z) {4.9.1}
k=np (p) if the software counter is equal to "n", then jump to label "p"
(n: 0...65535, @ p: a...z, A-Z) {4.9.1}
k>np (p) if the software counter is greater than "n", then jump to label "p"
(n: 0-65535, @ p: a...z, A...Z) {4.9.1}
Ln set syringe acceleration slope, Hz/sec = 2500 x "n" (n: 1...20, @) {4.1.2}
ln set syringe deceleration slope, Hz/sec = 2500 x "n" (n: 1...20, @) {4.1.2}
mn turn motors on/off (n: 0=syringe motor off, 1=syringe motor on, 2=valve motor
off, 3=valve motor on) {4.9.5}
U#n (i) turn on User Output bit “n” immediately (set to low) (n: 1...3) {4.3.1}
y<np (o) if syringe position is less than “n”, then go to label “p”
(n: 0...48000 or 24000 p=a...z, A...Z) {4.4.3}
y>np (o) if syringe position greater than “n”, then go to label “p”
(n: 0...48000 or 24000 p=a...z, A...Z) {4.4.3}
Yn initialize the syringe and select the port specified by the "~Y" parameter
(n: 4...5, see "Wn") {4.1.3}
Zn initialize the syringe and select the port specified by the "~Z" parameter
(n: 4...5, see "Wn") {4.1.3}
znp trap error #n and jump to a user error handler routine at program label “p”
(n: 1...26, p = a...z, A...Z) {4.8.1}
?4 (i) query the User Input 1 status, reply "1" if at low level {4.3.2}
?5 (i) query the User Input 2 status, reply "1" if at low level {4.3.2}
?6 (i) query the User Input 3 status, reply "1" if at low level {4.3.2}
?7 (i) query the User Analog Input voltage, volts = reply x 0.02 {4.3.2}
?10 (i) query the numerical value of the serial I/O input byte, or of byte 1 if in 2-
byte mode {4.3.2}
?19 (i) query NVM, reply list of program numbers in NVM {4.4.1 }
?20 (i) query numerical value of serial I/O input byte 2 {4.3.2}
?29 (i) query contents of the syringe position snapshot memory {8.3.5}
?30 (i) query the acceleration followed by the deceleration values {4.1.4}
?31 (I) query the number of syringe backlash steps {4.1.4}
$ (i) query for "valve stalls" (reply: 0=no stall, 2=stalled) {4.2.3}
~? (i) query command operating mode (reply: "-1" if in configuration mode, else
reply with syringe position) {4.7}
~An (~an) (i) set autostart program number to "n" (n: 0...10, 0=none) [0] {4.6}
~B (~b) (i) query the communications baud rate setting (see ~Bn) {4.6}
~Hn (~hn) (i) set the HOME button mode (n: 0=enabled, 1=disabled) [0] {4.6}
~In (~in) (i) set the power-up valve move mode (n: 0=enabled, 1=disabled) [0] {4.6}
~L (~l) (i) query User Input 3 operating mode (reply: 0=normal "logic", 1=dispense
"limit") {4.6}
~Sn (~sn) (i) set Expansion I/O mode to 1-byte or 2-byte transfers
(n: 1=1-byte, 2=2-byte) [1] {4.6}
~Y Query the valve position to which the valve will go just prior to moving the
syringe to the soft limit using the "Y4" command. {4.1.4}
~Yn Select the valve position to which the valve will go just prior to moving the
syringe to the soft limit using the "Y4" command. {4.1.3}
~Z Query the valve position to which the valve will go just prior to moving the
syringe to the soft limit using the "Y4" command. {4.1.4}
~Zn Select the valve position to which the valve will go just prior to moving the
syringe to the soft limit using the "Z4" command. {4.1.3}
n Port n Port n Port
1 A 5 E 9 I
2 B 6 F 10 J
3 C 7 G 11 K
4 D 8 H 12 L
A.2 VARIABLES
This section lists the general and indirect variables which can be used with the “@n” syntax
for command argument values. See Section 4.5 for details. General variables are set
before a program runs. Indirect variables use values derived by the pump.
@9 most recently-sent value of the byte #2 sent with the sn,m command
@10 most recently-sent value of the byte #1 sent with the sn,m command
Each status byte has two forms: busy and ready. "Busy" means the device is executing
a command or program. "Ready" indicates the device is ready to receive another
command. The status messages are:
ASCII Error Decimal binary Status
busy ready . # . busy ready 76543210
Bit 5 of the status byte, denoted by "X" above, is set to "0" if the pump is busy, and is set
to a "1" if the pump is not busy. The Error # is the error designator “n” used by the error
trap command “xnp”.
This section presents two typical driver functions: send and receive a string, and test
for busy status. These functions have been written and tested in the QBasic syntax as
supplied with DOS 6.x [TM]. The structures can be easily converted to Visual Basic or
ANSI C. The "GOTO" statements can be used, or a more structured style can be
employed.
The communications channel for the syringe drive is opened by the statement:
OPEN "COM2: 9600, N, 8, 1, CS0, DS0, CD0, RS" FOR RANDOM AS #1
When the program ends, the statement below must be used to close the channel.
CLOSE #1
The preceding two QBasic statements will need to be developed as function calls in
ANSI C or Visual Basic if an equivalent library function is not available. Windows
programs should use the Windows Applications Programming Interface (API) for I/O
handling whenever possible. The driver code presented in this manual is intended as a
sample of driver structures to facilitate the development of user drivers.
This module checks to see if the syringe drive is busy or is ready for another
command. It returns to the calling routine when the status is "ready". Note that it
uses the communications module "GetPump" from Section 6.7.1.
'************** UTILITY MODULE: Check Pump for Busy Status************
' wait for pump to return a "not busy" status
' no entry parameters, no return value
PumpBusy:
pump$ = "/1Q" 'set up status query string
GOSUB GetPump 'send status query
IF PumpErr$ <> "" THEN GOTO pb2 'if pump status error, exit routine
IF status$ = "@" THEN GOTO PumpBusy 'else check until "not busy"
pb2:
RETURN
When writing an ANSI C version of the preceding drivers, the statement "PRINT #1,
Pump$" in the listing below must be replaced with a function call which handles the
character-by-character details of string transmission. Also, the "In$ = INPUT$(LOC(1),
#1)" statement requires a function call to handle the reception and construction of the
reply string.
This module checks to see if the syringe drive is busy or is ready for another command.
It returns to the calling routine when the status is "ready". Note that it uses the
communications module "GetPump" from Section 6.7.1.