Overview

Functions for configuration of pump parameters and pump SI units.

Collaboration diagram for Pump Configuration:

Functions
long	LCP_GetFlowRateMax (dev_hdl hPump, double *FlowRateMax)
	Get maximum flow rate that is realizable with current dosing unit configuration. More...

long	LCP_GetFlowUnit (dev_hdl hPump, int pPrefix, int pVolumeUnit, int *pTimeUnit)
	Queries the current flow unit used for passing flow values. More...

long	LCP_GetSyringeParam (dev_hdl hPump, double pInnerDiameter_mm, double pMaxPistonStroke_mm)
	Syringe pump specific functions for configuration. More...

long	LCP_GetVolumeMax (dev_hdl hPump, double *VolumeMax)
	Returns the maximum volume a pump can aspirate into its container (syringe) For some devices like peristaltic pumps the maximum volume is not limited while for other pumps, like syringe pumps, the maximum volume is limited by the maximum travel range of the drive unit and by the maximum piston stroke of the mounted syringe. More...

long	LCP_GetVolumeUnit (dev_hdl hPump, int pPrefix, int pVolumeUnit)
	Queries the current volume unit used for all dosage functions. More...

long	LCP_SetFlowUnit (dev_hdl hPump, int Prefix, int VolumeUnit, int TimeUnit)
	Sets the flow unit for a certain pump. More...

long	LCP_SetSyringeParam (dev_hdl hPump, double InnerDiameter_mm, double MaxPistonStroke_mm)
	Set syringe parameters. More...

long	LCP_SetVolumeUnit (dev_hdl hPump, int Prefix, int VolumeUnit)
	This function sets the default volume unit. More...

Function Documentation

long 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]	hPump	A valid syringe pump handle
[out]	FlowRateMax	Returns the maximum flow rate in configured SI unit

Returns: Error code - ERR_NOERR indicates success

Examples:: capi_contiflow_test.cpp, capi_nemesys_forcemon_test.cpp, capi_nemesys_test.cpp, and capi_pressure_control_test.cpp.

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

Queries the current flow unit used for passing flow values.

Parameters

[in]	hPump	A valid syringe pump handle
[out]	pPrefix	Returns the prefix of the flow unit (see Prefix Constants)
[out]	pVolumeUnit	Returns the volume unit (numerator) of the velocity unit (i.e. LITRES - see Volume SI Units)
[out]	pTimeUnit	Returns 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()

long LCP_GetSyringeParam	(	dev_hdl	hPump,
		double *	pInnerDiameter_mm,
		double *	pMaxPistonStroke_mm
	)

Syringe pump specific functions for configuration.

This group defines functions for configuration of syringe pump parameters like configuration of syringe parameters. Read syringe parameters.

Parameters

[in]	hPump	A valid syringe pump handle
[out]	pInnerDiameter_mm	Inner diameter of the syringe tube in Millimeters.
[out]	pMaxPistonStroke_mm	The maximum piston stroke defines the maximum position the piston can be moved to before it slips out of the syringe tube. The maximum piston stroke limits the maximum travel range of the syringe pump pusher.

Returns: Error code - ERR_NOERR indicates success

Examples:: capi_nemesys_test.cpp.

long LCP_GetVolumeMax	(	dev_hdl	hPump,
		double *	VolumeMax
	)

Returns the maximum volume a pump can aspirate into its container (syringe) For some devices like peristaltic pumps the maximum volume is not limited while for other pumps, like syringe pumps, the maximum volume is limited by the maximum travel range of the drive unit and by the maximum piston stroke of the mounted syringe.

This function returns the maximum volume the pump can take up with the current container (eg.syringe) configuration

Parameters

[in]	hPump	A valid syringe pump handle
[out]	VolumeMax	Returns the maximum volume in configured SI units

Returns: Error code - ERR_NOERR indicates success

Examples:: capi_contiflow_test.cpp, and capi_nemesys_test.cpp.

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

Queries the current volume unit used for all dosage functions.

Parameters

[in]	hPump	A valid syringe pump handle
[out]	pPrefix	Returns the prefix of the SIunit (i.e MILLI - see Prefix Constants)
[out]	pVolumeUnit	Returns the volume unit identifier (i.e. LITRES - see Volume SI Units)

Returns: Error code - ERR_NOERR indicates success

See also: LCP_SetVolumeUnit()

long 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.

1 long Result = LCA_SetFlowUnit(hAxis, MILLI, LITRES, PER_SECOND);

Parameters

[in]	hPump	A valid syringe pump handle
[in]	Prefix	The prefix of the velocity unit (see Prefix Constants)
[in]	VolumeUnit	The volume unit (numerator) of the velocity unit (i.e. LITRES - see Volume SI Units)
[in]	TimeUnit	The 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_contiflow_test.cpp, capi_nemesys_test.cpp, capi_pressure_control_test.cpp, and Pump_CAPI_Init.cpp.

long LCP_SetSyringeParam	(	dev_hdl	hPump,
		double	InnerDiameter_mm,
		double	MaxPistonStroke_mm
	)

Set syringe parameters.

If you change the syringe in one device, you need to setup the new syringe parameters to get proper conversion of flow rate und volume units.

Parameters

[in]	hPump	A valid syringe pump handle
[in]	InnerDiameter_mm	Inner diameter of the syringe tube in millimetres.
[in]	MaxPistonStroke_mm	The maximum piston stroke defines the maximum position the piston can be moved to before it slips out of the syringe tube. The maximum piston stroke limits the maximum travel range of the syringe pump pusher.

Returns: Error code - ERR_NOERR indicates success

Examples:: capi_contiflow_test.cpp, capi_nemesys_test.cpp, and Pump_CAPI_Init.cpp.

long 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:

1 long Result = LCP_SetVolumeUnit(hPump1, MILLI, LITRES);

Parameters

[in]	hPump	A valid syringe pump handle
[in]	Prefix	The prefix of the SIunit (i.e MILLI - see Prefix Constants)
[in]	VolumeUnit	The volume unit identifier (i.e. LITRES - see Volume SI Units)

Returns: Error code - ERR_NOERR indicates success

See also: LCP_GetVolumeUnit()

Examples:: capi_contiflow_test.cpp, capi_nemesys_test.cpp, and Pump_CAPI_Init.cpp.