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

Overview

Functions for configuration of pump parameters and pump SI units.

+ Collaboration diagram for Pump Configuration:

Modules

 Syringe Pump Configuration
 Syringe pump specific functions for configuration.
 

Functions

LCP_Func long LCP_CALL LCP_GetFlowRateMax (dev_hdl hPump, double *FlowRateMax)
 Get maximum flow rate that is realizable with current dosing unit configuration. More...
 
LCP_Func long LCP_CALL LCP_GetFlowUnit (dev_hdl hPump, int *pPrefix, int *pVolumeUnit, int *pTimeUnit)
 Queries the current flow unit used for passing flow values. More...
 
LCP_Func long LCP_CALL LCP_GetVolumeUnit (dev_hdl hPump, int *pPrefix, int *pVolumeUnit)
 Queries the current volume unit used for all dosage functions. More...
 
LCP_Func long LCP_CALL LCP_SetFlowUnit (dev_hdl hPump, int Prefix, int VolumeUnit, int TimeUnit)
 Sets the flow unit for a certain pump. More...
 
LCP_Func long LCP_CALL LCP_SetVolumeUnit (dev_hdl hPump, int Prefix, int VolumeUnit)
 This function sets the default volume unit. More...
 

Function Documentation

◆ LCP_GetFlowRateMax()

LCP_Func long LCP_CALL LCP_GetFlowRateMax ( dev_hdl  hPump,
double *  FlowRateMax 
)

Get maximum flow rate that is realizable with current dosing unit configuration.

The maximum flow rate depends on the mechanical configuration of the dosing unit (gear) and on the syringe configuration. If larger syringes are used then larger flow rates are realizable.

Parameters
[in]hPumpA valid syringe pump handle
[out]FlowRateMaxReturns the maximum flow rate in configured SI unit
Returns
Error code - ERR_NOERR indicates success
Examples:
capi_nemesys_test.cpp, and capi_pressure_control_test.cpp.

◆ LCP_GetFlowUnit()

LCP_Func long LCP_CALL LCP_GetFlowUnit ( dev_hdl  hPump,
int *  pPrefix,
int *  pVolumeUnit,
int *  pTimeUnit 
)

Queries the current flow unit used for passing flow values.

Parameters
[in]hPumpA valid syringe pump handle
[out]pPrefixReturns the prefix of the flow unit (see Prefix Constants)
[out]pVolumeUnitReturns the volume unit (numerator) of the velocity unit (i.e. LITRES - see Volume SI Units)
[out]pTimeUnitReturns the time unit (denominator) of the flow unit. (i.e. PER_SECOND - see Time Units)
Returns
Error code - ERR_NOERR indicates success
See also
LCP_SetFlowUnit()

◆ LCP_GetVolumeUnit()

LCP_Func long LCP_CALL LCP_GetVolumeUnit ( dev_hdl  hPump,
int *  pPrefix,
int *  pVolumeUnit 
)

Queries the current volume unit used for all dosage functions.

Parameters
[in]hPumpA valid syringe pump handle
[out]pPrefixReturns the prefix of the SIunit (i.e MILLI - see Prefix Constants)
[out]pVolumeUnitReturns the volume unit identifier (i.e. LITRES - see Volume SI Units)
Returns
Error code - ERR_NOERR indicates success
See also
LCP_SetVolumeUnit()

◆ LCP_SetFlowUnit()

LCP_Func long LCP_CALL LCP_SetFlowUnit ( dev_hdl  hPump,
int  Prefix,
int  VolumeUnit,
int  TimeUnit 
)

Sets the flow unit for a certain pump.

The flow unit defines the unit to be used for all flow values passed to API functions or retrieved from API functions.

long Result = LCA_SetFlowUnit(hAxis, MILLI, LITRES, PER_SECOND);
Parameters
[in]hPumpA valid syringe pump handle
[in]PrefixThe prefix of the velocity unit (see Prefix Constants)
[in]VolumeUnitThe volume unit (numerator) of the velocity unit (i.e. LITRES - see Volume SI Units)
[in]TimeUnitThe time unit (denominator) of the velocity unit. (i.e. PER_SECOND - see Time Units)
Returns
Error code - ERR_NOERR indicates success
See also
LCP_GetFlowUnit()
Examples:
capi_nemesys_test.cpp, capi_pressure_control_test.cpp, and Pump_CAPI_Init.cpp.

◆ LCP_SetVolumeUnit()

LCP_Func long LCP_CALL LCP_SetVolumeUnit ( dev_hdl  hPump,
int  Prefix,
int  VolumeUnit 
)

This function sets the default volume unit.

All parameters of subsequent dosing function calls are given in this new unit. Example to select milliliters as volume unit. Example:

long Result = LCP_SetVolumeUnit(hPump1, MILLI, LITRES);
Parameters
[in]hPumpA valid syringe pump handle
[in]PrefixThe prefix of the SIunit (i.e MILLI - see Prefix Constants)
[in]VolumeUnitThe volume unit identifier (i.e. LITRES - see Volume SI Units)
Returns
Error code - ERR_NOERR indicates success
See also
LCP_GetVolumeUnit()
Examples:
capi_nemesys_test.cpp, and Pump_CAPI_Init.cpp.