Serial (RS232) Commands

Within the terminal program on the controlling computer, the following commands can be entered to set parameters or control the micro syringe pump.

CommandDescription
helpDisplays a list of available commands.
startStarts the micro syringe pump with the currently set parameters. The parameters that will run depend upon which mode (Basic Mode or Multi-Step Mode) the pump touchscreen is showing.
pausePauses the current micro syringe pump run. The run can be resumed from this point using the start command.
stopEnds the current run. The run cannot be resumed and can only be restarted from the beginning.
set diameter XSets the inner diameter (ID) of the syringe in millimeters. This setting simultaneously affects the syringe ID used in both Basic Mode and Multi-Step Mode settings, which will also affect the volume and rate parameters in both modes. X can be an integer or decimal (up to three decimal places) within the parameter limits for the specific micro syringe pump (e.g., 0.103 mm to 40.000 mm for the Fusion series).

EXAMPLE

set diameter 11.73

Returns the set diameter.

set units XSets the units used for the rate of infusion/withdrawal. This parameter also sets the units for the transfer volume, where the transfer volume unit will be the same as the unit of volume used in the rate. This setting simultaneously changes the units used in both Basic Mode and Multi-Step Mode settings. X can be an integer from 0 to 3. Each integer represents a specific rate unit: 0: mL/min 1: mL/hr 2: μL/min 3: μL/hr

EXAMPLE

set units 2

Returns the integer corresponding to the set rate unit.

set volume X,X,X,…Set the transfer volume. The micro syringe pump will run until the volume infused or withdrawn equals this volume(s). This command also sets whether the micro syringe pump will infuse or withdraw (Supported models only) and the number of steps used in Multi-Step Mode. X must be an integer or decimal (up to five decimal places) within the volume limits for the syringe (See read limit parameter command). A negative sign can be added in front of any volume value to indicate a switch to withdrawal mode (Supported models only). For Basic Mode, only one value is required. Entering only one value will automatically switch the micro syringe pump to Basic Mode.

EXAMPLE (BASIC MODE)

set volume 25.0

To set volumes in Multi-Step Mode, the micro syringe pump must be manually switched to Multi-Step Mode on the pump. For each step, a value must be entered, separated by commas and no spaces. The number of steps will be automatically adjusted to the number of values entered (i.e., entering only three values will change the number of steps to three).

EXAMPLE (MULTI-STEP MODE)

set volume 3,–2,4

Returns the transfer volume, transfer rate, and transfer time (in Basic Mode). Returns only the transfer volumes (in Multi-Step Mode).

set time X,X,X,…Sets the target time for a micro syringe pump run. This will adjust the transfer rate so that the run will last for the input time. The target volume will remain the same. This command also sets the number of steps used in Multi-Step Mode. X must be an integer or decimal (up to five decimal places). The resulting transfer rate must be within the rate limits for the syringe (See read limit parameter command). For Basic Mode, only one value is required. Entering only one value will automatically switch the micro syringe pump to Basic Mode.

EXAMPLE (BASIC MODE)

set time 1.0

To set target times in Multi-Step Mode, the micro syringe pump must be manually switched to Multi-Step Mode on the pump. For each step, a value must be entered, separated by commas and no spaces. The number of steps will be automatically adjusted to the number of values entered (i.e., entering only three values will change the number of steps to three).

EXAMPLE (MULTI-STEP MODE)

set time 1.0,0.5,1.3

Returns target time and rate (in Basic Mode). Returns no values (in Multi-Step Mode).

set rate X,X,X,…Sets the transfer rate for infusion/withdrawal. X must be an integer or decimal (up to five decimal places) within the rate limits for the syringe (see read limit parameter command). For Basic Mode, only one value is required.

EXAMPLE (BASIC MODE)

set rate 1.0

To set rates in Multi-Step Mode, the pump must be manually switched to Multi-Step Mode on the pump. For each step, a value must be entered, separated by commas and no spaces.

EXAMPLE (MULTI-STEP MODE)

set rate 1.0,0.5,1.3

If the number of values is less than the number of steps, the remaining steps will gain the same rate value as the last entered value. Any extra values beyond the number of steps will be truncated. Variable rates may also be set in Multi-Step Mode. Rate 1 and Rate 2 for each step can be set using a backslash. Each step is still separated by a comma.

EXAMPLE (MULTI-STEP MODE WITH VARIABLE RATES)

set rate 0.5/1.0,0.5/1.0,1.3

Returns the flow rate and transfer time (in Basic Mode). Returns the flow rate 1 and flow rate 2 for each step (in Multi-Step Mode).

set delay X,X,X,…Sets the start time delay (in minutes) prior to each step of a pump run. Upon starting a step with a delay, the pump will wait until the delay time elapses before starting to transfer volume. X must be an integer or decimal (up to five decimal places) within the rate limits for the syringe (see read limit parameter command). For Basic Mode, only one value is required. Entering only one value will automatically switch the pump to Basic Mode.

EXAMPLE (BASIC MODE)

set delay 1.0

To set rates in Multi-Step Mode, the pump must be manually switched to Multi-Step Mode on the pump. For each step of Multi-Step Mode, a value must be entered, separated by commas and no spaces.

EXAMPLE (MULTI-STEP MODE)

set delay 1.0,0.5,1.3

If the number of values is less than the number of steps, the remaining steps will gain the same delay value as the last entered value. Any extra values beyond the number of steps will be truncated. Returns the delay time (in Basic Made). Returns the delay time for each step (in Multi-Step Mode).

read limit parameterReturns the min/max values that can be set for transfer volume and transfer rate. The returned values are dependent on the syringe inner diameter (ID). The transfer volume limits are typically greater than the maximum volume of the syringe being used. Returns: max rate, min rate, max volume, min volume.
dispensed volumeReturns the transferred volume for the current run/step. If no run has started, returns the transferred volume for the last run/step.
elapsed timeReturns the elapsed time (in minutes) for the current run/step. If no run has started, returns the elapsed time for the last run/step. Elapsed time does not include any delay time.
view parameterReturns the currently set parameters (Basic Mode only). Returns: rate units, syringe inner diameter, transfer rate, priming rate, time (in whole number minutes), transfer volume, time delay (in whole number minutes).
statusReturns the current status of the pump. The returned integer correlates to the status of the pump. 0: Pump stopped 1: Pump running 2: Pump paused 3: Pump delayed 4: Pump stalled Returns the integer that corresponds to the current status of the pump.
hexw2 X X X X X X startSets multiple parameters in one command (Basic Mode only).X variables in order:units: see set units commandtransfer mode: 0-infusion, 1-withdrawalsyringe ID: see set diameter commandtransfer volume: see set volume command (no negative values)transfer rate: see set rate commandstart time delay: see set delay command The following example shows the command using these parameters: units = mL/min; transfer mode = withdrawal; diameter = 23.05 mm; volume = 1.2 mL; rate = 3.0 mL/in; delay = 30 sec (0.5 min).

EXAMPLE

hexw2 0 1 23.04 1.2 3.0 0.5

A start command can be added after the six parameters to immediately start the run with the new parameters.

EXAMPLE

hexw2 0 1 23.04 1.2 3.0 0.5 start

All six parameters do not need to be entered; however, all parameters up to the parameter(s) of interest must be also be included. The other parameters not entered will remain as they are currently set.

EXAMPLE

hexw2 0 1 23.04 2.4
set primerate XSets the priming/bolus rate (Basic Mode only). X must be an integer or decimal (up to five decimal places) within the rate limits for the syringe (see read limit parameter command). Only one value is entered.

EXAMPLE

set primerate 1.0

Returns the set priming/bolus rate (in Basic Mode).

restartPowers off and then automatically powers on the pump

In some cases, depending on the software used to connect to the pump, each command may need to be followed by a line feed character such as “\n” or “\r” to execute. If a command does not appear to work, try adding “\r” or “\n” to the end of the line.

EXAMPLE

set units 1 \r

When the pump does not recognize a command, it will return a text similar to the following:

EXAMPLE

Command not recognized-type in “help”
and press enter to see a command list.

For more information on connecting a Chemyx syringe pump to a computer, please refer to our Connecting article.

Have any questions or comments about this article? Fill out the form below and we'll get back to you as soon as possible!

Privacy & Terms

By choosing "I agree" below you agree to Chemyx Inc Terms of Service. You Also agree to our Privacy Policy, which describes how we process your information.