Configurate dosing unit parameters. More...

Functions
NCS_Func long __stdcall	NCS_Calibrate (ncs_hdl hDevice, unsigned char DosingUnit)
	Execute calibration for single dosing unit. More...

NCS_Func long __stdcall	NCS_FindHome (ncs_hdl hDevice, unsigned char DosingUnit, char HomingMethod)
	Execute homing move (calibration) with a certain homing method. More...

NCS_Func long __stdcall	NCS_GetFlowRateMax (ncs_hdl hDevice, unsigned char DosingUnit, double *pFlowRateMax)
	Get maximum flow rate that is realizable with current dosing unit configuration. More...

NCS_Func long __stdcall	NCS_GetFlowRateMaxEx (ncs_hdl hDevice, unsigned char DosingUnit, double *pFlowRateMax, TFlowUnitId FlowUnit)
	Get maximum flow rate that is realizable with current dosing unit configuration. More...

NCS_Func long __stdcall	NCS_GetNumberOfDosingUnits (ncs_hdl hDevice)
	Get number of dosing unnits connected to dosing platform. More...

NCS_Func long __stdcall	NCS_GetSyringeLevelMax (ncs_hdl hDevice, unsigned char DosingUnit, double *pSyringeLevelMax)
	Get maximum syringe fill level for a single dosing unit. More...

NCS_Func long __stdcall	NCS_GetSyringeLevelMaxEx (ncs_hdl hDevice, unsigned char DosingUnit, double *pSyringeLevelMax, TVolUnitId VolUnit)
	Get maximum syringe fill level for a single dosing unit. More...

NCS_Func long __stdcall	NCS_GetSyringeLevelMin (ncs_hdl hDevice, unsigned char DosingUnit, double *pSyringeLevelMin)
	Get minimum syringe fill level for a single dosing unit. More...

NCS_Func long __stdcall	NCS_GetSyringeLevelMinEx (ncs_hdl hDevice, unsigned char DosingUnit, double *pSyringeLevelMin, TVolUnitId VolUnit)
	Get minimum syringe fill level for a single dosing unit. More...

NCS_Func long __stdcall	NCS_GetSyringeLimits (ncs_hdl hDevice, unsigned char DosingUnit, double pLimitMin_mm, double pLimitMax_mm)
	Returns syringe limits. More...

NCS_Func long __stdcall	NCS_GetSyringeParam (ncs_hdl hDevice, unsigned char DosingUnit, double pInnerDiameter_mm, double pMaxPistonStroke_mm)
	Read syringe parameters. More...

NCS_Func long __stdcall	NCS_IsHighPressureModule (ncs_hdl hDevice, unsigned char DosingUnit)
	Checks if a certain dosing unit is a high pressure module. More...

NCS_Func long __stdcall	NCS_SetSyringeLimits (ncs_hdl hDevice, unsigned char DosingUnit, double LimitMin_mm, double LimitMax_mm)
	Set syringe limits. More...

NCS_Func long __stdcall	NCS_SetSyringeParam (ncs_hdl hDevice, unsigned char DosingUnit, double InnerDiameter_mm, double MaxPistonStroke_mm)
	Set syringe parameters. More...

Detailed Description

Configurate dosing unit parameters.

This group defines all required functions for reading and writing configuration parameters of the dosing system an single dosing unts.

Function Documentation

NCS_Func long __stdcall NCS_Calibrate	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit
	)

Execute calibration for single dosing unit.

During calibration move the dosing unit moves the pusher to the lowest possible position. This position is lower than the normal zero position during normal operation. Therfore you should only execute this reference move if you are sure that no syringe is fitted on the device.

Warning: Executing the calibration move with a syringe fitted on the device may cause damage to the syringe.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1

Returns: Error code - ERR_NOERR indicates success

NCS_Func long __stdcall NCS_FindHome	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		char	HomingMethod
	)

Execute homing move (calibration) with a certain homing method.

The homing method depends on the drive units that are built into the syringe pump. If you know the drive unit type and if you have the drive documentation (e.g. von maxon EPOS drive unit), you can execute a homing move with a certain homing method.

Warning: Executing the calibration move with a syringe fitted on the device may cause damage to the syringe.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Dosing unit to calibrate

Returns: Error code - ERR_NOERR indicates success

NCS_Func long __stdcall NCS_GetFlowRateMax	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pFlowRateMax
	)

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]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[out]	pFlowRateMax	Maximum flow rate.

Returns: Error code - ERR_NOERR indicates success

NCS_Func long __stdcall NCS_GetFlowRateMaxEx	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pFlowRateMax,
		TFlowUnitId	FlowUnit
	)

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. Extended version of function NCS_GetFlowRateMax(). The flow unit for the maximum flow rate is configurable here.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[out]	pFlowRateMax	Maximum flow rate.
[in]	FlowUnit	Flow unit identifier for flow returned in pFlowrateMax

Returns: Error code - ERR_NOERR indicates success

NCS_Func long __stdcall NCS_GetNumberOfDosingUnits ( ncs_hdl hDevice )

Get number of dosing unnits connected to dosing platform.

Parameters

[in] hDevice Valid device handle

Returns: Number of dosing units (0..32) or error code (< 0)

NCS_Func long __stdcall NCS_GetSyringeLevelMax	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pSyringeLevelMax
	)

Get maximum syringe fill level for a single dosing unit.

This function returns the maximum syringe level in preconfigured SI units.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[out]	pSyringeLevelMax	Maximum syringe fill level

Returns: Error code - ERR_NOERR indicates success

See also: NCS_GetSyringeLevelMaxEx(), NCS_SetActiveVolumeUnit()

NCS_Func long __stdcall NCS_GetSyringeLevelMaxEx	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pSyringeLevelMax,
		TVolUnitId	VolUnit
	)

Get maximum syringe fill level for a single dosing unit.

Extended version of function NCS_GetSyringeLevelMax(). The volume unit for the syringle level is configurable here.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[out]	pSyringeLevelMax	Maximum syringe fill level
[in]	VolUnit	Volume unit for value returned in pSyringeLevelMax

Returns: Error code - ERR_NOERR indicates success

NCS_Func long __stdcall NCS_GetSyringeLevelMin	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pSyringeLevelMin
	)

Get minimum syringe fill level for a single dosing unit.

This function returns the minimum syringe level in preconfigured SI units.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[out]	pSyringeLevelMin	Minimum syringe fill level

Returns: Error code - ERR_NOERR indicates success

See also: NCS_GetSyringeLevelMinEx(), NCS_SetActiveVolumeUnit()

NCS_Func long __stdcall NCS_GetSyringeLevelMinEx	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pSyringeLevelMin,
		TVolUnitId	VolUnit
	)

Get minimum syringe fill level for a single dosing unit.

Normally the minimum syringe fill level is 0. But the minimum level may may be limited by the software position limit to a higher level. The pusher only travels between the maximum and minimum syringe level.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[out]	pSyringeLevelMin	Maximum syringe fill level
[in]	VolUnit	Volume unit for value returned in pSyringeLevelMax

Returns: Error code - ERR_NOERR indicates success

NCS_Func long __stdcall NCS_GetSyringeLimits	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pLimitMin_mm,
		double *	pLimitMax_mm
	)

Returns syringe limits.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[in]	pLimitMin_mm	Returns the minimum limit.
[in]	pLimitMax_mm	Returns the maximum limit.

Returns: Error code - ERR_NOERR indicates success

See also: NCS_SetSyringeLimits()

NCS_Func long __stdcall NCS_GetSyringeParam	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pInnerDiameter_mm,
		double *	pMaxPistonStroke_mm
	)

Read syringe parameters.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[out]	pInnerDiameter_mm	Inner diameter of the syringe tube in millimetres.
[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 neMESYS pusher.

Returns: Error code - ERR_NOERR indicates success

NCS_Func long __stdcall NCS_IsHighPressureModule	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit
	)

Checks if a certain dosing unit is a high pressure module.

You can call this function to identify the type of dosing unit.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1

Return values

0	Dosing unit is not a high pressure module
1	Dosing unit is a high pressure module
<0	Error code - Error occured

NCS_Func long __stdcall NCS_SetSyringeLimits	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double	LimitMin_mm,
		double	LimitMax_mm
	)

Set syringe limits.

The maximum travel range of the pusher is limited by the length of the linear drive and by the maxmimum piston stroke of the syringe. With this function it is possible to apply syringe limits that may limit the travel range even further. The drive unit stops as soon as it reaches a limit.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[in]	LimitMin_mm	The minimum limit to apply. This prevents the drive unit from traveling to the zero position. Apply a value of 0 to set the default value.
[in]	LimitMax_mm	The maximum limit to apply. This prevents the drive unit from traveling the complete syringe piston stroke. To set it to the maximum you should set it to a value > 80 mm because this is more then the physical linear drive range.

Returns: Error code - ERR_NOERR indicates success

See also: NCS_GetSyringeLimits()

NCS_Func long __stdcall NCS_SetSyringeParam	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		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]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[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 neMESYS pusher.

Returns: Error code - ERR_NOERR indicates success

Functions

Detailed Description

Function Documentation