Qmix SDK  20200506
The software libraries for integration of all CETONI devices.
Pump Control

Overview

Functions to control the pump parameters like flow and volume.

This groups defines all functions to control the pump and to control simple dosing tasks like dosing volumes and generating constant flow.

+ Collaboration diagram for Pump Control:

Functions

LCP_Func long LCP_CALL LCP_Aspirate (dev_hdl hPump, double Volume, double Flow)
 Aspirate a certain volume with a certain flow rate. More...
 
LCP_Func long LCP_CALL LCP_Dispense (dev_hdl hPump, double Volume, double Flow)
 Dispense a certain volume with a certain flow rate. More...
 
LCP_Func long LCP_CALL LCP_GenerateFlow (dev_hdl hPump, double FlowRate)
 Generate a continuous flow. More...
 
LCP_Func long LCP_CALL LCP_PumpVolume (dev_hdl hPump, double Volume, double Flow)
 Pump a certain volume with a certain flow rate. More...
 
LCP_Func long LCP_CALL LCP_SetFillLevel (dev_hdl hPump, double Level, double Flow)
 Pumps fluid with the given flow rate until the requested fill level is reached. More...
 
LCP_Func long LCP_CALL LCP_StopAllPumps ()
 Immediately stop pumping off all pumps. More...
 
LCP_Func long LCP_CALL LCP_StopPumping (dev_hdl hPump)
 Immediately stop pumping. More...
 
LCP_Func long LCP_CALL LCP_SyringePumpCalibrate (dev_hdl hPump)
 Executes a reference move for a syringe pump. More...
 

Function Documentation

◆ LCP_Aspirate()

LCP_Func long LCP_CALL LCP_Aspirate ( dev_hdl  hPump,
double  Volume,
double  Flow 
)

Aspirate a certain volume with a certain flow rate.

Parameters
[in]hPumpA valid pump handle
[in]VolumeThe volume to aspirate in physical units
[in]FlowThe flow rate to use to aspirate the volume negative flow rates are invalid
Return values
ERR_NOERRindicates success
-ERR_PARAM_RANGELevel or Flow value is out of ranges
Examples:
capi_nemesys_test.cpp.

◆ LCP_Dispense()

LCP_Func long LCP_CALL LCP_Dispense ( dev_hdl  hPump,
double  Volume,
double  Flow 
)

Dispense a certain volume with a certain flow rate.

Parameters
[in]hPumpA valid pump handle
[in]VolumeThe volume to dispense in physical units
[in]FlowThe flow rate to use to dispense the volume negative flow rates are invalid
Return values
ERR_NOERRindicates success
-ERR_PARAM_RANGELevel or Flow value is out of range
Examples:
capi_nemesys_test.cpp.

◆ LCP_GenerateFlow()

LCP_Func long LCP_CALL LCP_GenerateFlow ( dev_hdl  hPump,
double  FlowRate 
)

Generate a continuous flow.

Parameters
[in]hPumpA valid pump handle
[in]FlowRateA positive flow rate indicates dispensing and a negative flow rate indicates aspiration
Return values
ERR_NOERRindicates success
-ERR_PARAM_RANGEFlow value is out of range
Examples:
capi_nemesys_test.cpp, and capi_pressure_control_test.cpp.

◆ LCP_PumpVolume()

LCP_Func long LCP_CALL LCP_PumpVolume ( dev_hdl  hPump,
double  Volume,
double  Flow 
)

Pump a certain volume with a certain flow rate.

Parameters
[in]hPumpA valid pump handle
[in]VolumeThe volume to pump in physical units negative volumes indicate aspiration positive volumes indicate dispensing
[in]FlowThe flow rate to use to pump the volume
Return values
ERR_NOERRindicates success
-ERR_PARAM_RANGELevel or Flow value is out of range
Examples:
capi_nemesys_test.cpp.

◆ LCP_SetFillLevel()

LCP_Func long LCP_CALL LCP_SetFillLevel ( dev_hdl  hPump,
double  Level,
double  Flow 
)

Pumps fluid with the given flow rate until the requested fill level is reached.

Depending on the requested fill level given in Level parameter this function may cause aspiration or dispension of fluid. This function only works properly for pump devices that support a fill level (eg. syringe pumps). Pumps like peristaltic pumps do not support a fill level and the function returns an error for unsupported pump types.

Parameters
[in]hPumpA valid pump handle
[in,out]LevelThe requested fill level. A level of 0 indicates a completely empty container (eg. empty syringe).
[in,out]FlowThe flow rate to use for pumping
Return values
ERR_NOERRindicates success
-ERR_PARAM_RANGELevel or Flow value is out of range
Examples:
capi_nemesys_test.cpp.

◆ LCP_StopAllPumps()

LCP_Func long LCP_CALL LCP_StopAllPumps ( )

Immediately stop pumping off all pumps.

Returns
Error code - ERR_NOERR indicates success

◆ LCP_StopPumping()

LCP_Func long LCP_CALL LCP_StopPumping ( dev_hdl  hPump)

Immediately stop pumping.

Parameters
[in]hPumpA valid pump handle
Returns
Error code - ERR_NOERR indicates success

◆ LCP_SyringePumpCalibrate()

LCP_Func long LCP_CALL LCP_SyringePumpCalibrate ( dev_hdl  hPump)

Executes a reference move for a syringe pump.

Warning
A reference move will move the pusher slightly below the zero position. This may cause a damage to a mounted glass syringe. So if you use this function in your software, you should warn the user about this risk and ask him to unmount the syringe.
Parameters
[in]hPumpA valid pump handle
Returns
Error code - ERR_NOERR indicates success
See also
LCP_IsCalibrationFinished()
Examples:
capi_nemesys_test.cpp.