Overview

High level functions for pump control and execution of dosing tasks such as volume dosing, flow generation, aspiration and dispension.

These functions work with volumes in microlitres µl and flow rates in microlitres per minute (µl/min). For proper unit conversion a syringe should be properly configured with NemV4SetSyringe().

Collaboration diagram for Dosing and pump control functions:

Functions
long	NemV4DoseVolume (TNemesysV4 *Nemesys, double Volume_ul, double Flow_ul_min)
	Dose a certain volume with a certain flow rate. More...

long	NemV4GenerateFlow (TNemesysV4 *Nemesys, double Flow_ul_min)
	Generate a constant flow until syringe is empty or full. More...

long	NemV4GetCurrentFlow (TNemesysV4 Nemesys, double Flow_ul_min)
	Returns the current flow in ul / min. More...

long	NemV4GetMaxFlow (TNemesysV4 Nemesys, double Flow_ul_min)
	Returns the maximum flow in ul / min. More...

long	NemV4GetMaxSyringeLevel (TNemesysV4 Nemesys, double Level_ul)
	Returns the maximum syringe level in µl. More...

long	NemV4GetSyringeLevel (TNemesysV4 Nemesys, double Level_ul)
	Returns the current syringe level in µl. More...

long	NemV4IsStopped (TNemesysV4 *Nemesys)
	Checks if a dosing unit is moving or stopped. More...

long	NemV4SetSyringeLevel (TNemesysV4 *Nemesys, double Level_ul, double Flow_ul_min)
	Set syringe to a certain fill level. More...

long	NemV4Stop (TNemesysV4 *Nemesys)
	Stops the current dosing move. More...

Function Documentation

long NemV4DoseVolume	(	TNemesysV4 *	Nemesys,
		double	Volume_ul,
		double	Flow_ul_min
	)

Dose a certain volume with a certain flow rate.

Depending on the sign of the given volume parameter, this functions will aspirate (negative sign) or dispense (positive sign) a certain amount of fluid with the flow rate given in Flow_ul_min parameter.

Parameters

Nemesys	The Nemesys device to control
Volume_ul	The volume in microlitres. A negative volume means aspiration and a positive volume means dispension.
Flow_ul_min	The flow rate for the dosing in microlitres per minute.

Returns: Error code - ERR_NOERR indicates success

See also: NemV4GetSyringeLevel(), NemV4GetCurrentFlow()

 {
     int32_t Distance;
     int32_t Velocity;
 
     Distance = NemV4MicrolitresToDevicePos(Nemesys, Volume_ul);
     Velocity = NemV4MicrolitresPerMinuteToDeviceVel(Nemesys, Flow_ul_min);
     return NemV4MoveDistance(Nemesys, Distance, Velocity);
 }

Here is the call graph for this function:

long NemV4GenerateFlow	(	TNemesysV4 *	Nemesys,
		double	Flow_ul_min
	)

Generate a constant flow until syringe is empty or full.

The function generates a constant flow. The sign of the given flow value indicates the direction. A positive flow value means aspiration and a negative flow value means aspiration. The pump moves the pusher until it reaches the minimum or maximum position.

Parameters

Nemesys	The Nemesys device to control
Flow_ul_min	The flow rate to generate. Negative values mean aspiration.

Returns: Error code - ERR_NOERR indicates success

 {
     int32_t Velocity = NemV4MicrolitresPerMinuteToDeviceVel(Nemesys, Flow_ul_min);
     return NemV4MoveWithVelocity(Nemesys, Velocity);
 }

Here is the call graph for this function:

long NemV4GetCurrentFlow	(	TNemesysV4 *	Nemesys,
		double *	Flow_ul_min
	)

Returns the current flow in ul / min.

Parameters

Nemesys	Nemesys device to read from
Flow_ul_min	Returns the current flow in µl per minute

Returns: Error code - ERR_NOERR indicates success

 {
     int32_t CurrentVelocity;
     long Result = NemV4GetCurrentVelocity(Nemesys, &CurrentVelocity);
     CSI_RETURN_ON_ERROR(Result);
     *Flow_ul_min = NemV4DeviceVelToMicrolitresPerMinute(Nemesys, CurrentVelocity);
     return ERR_NOERR;
 }

Here is the call graph for this function:

long NemV4GetMaxFlow	(	TNemesysV4 *	Nemesys,
		double *	Flow_ul_min
	)

Returns the maximum flow in ul / min.

Parameters

Nemesys	Nemesys device to read from
Flow_ul_min	Returns the maximum flow in µl per minute

Returns: Error code - ERR_NOERR indicates success

 {
     *Flow_ul_min = NemV4DeviceVelToMicrolitresPerMinute(Nemesys, Nemesys->MaxVelocity);
     return ERR_NOERR;
 }

Here is the call graph for this function:

long NemV4GetMaxSyringeLevel	(	TNemesysV4 *	Nemesys,
		double *	Level_ul
	)

Returns the maximum syringe level in µl.

Parameters

Nemesys	Nemesys device to read from
Level_ul	Returns the maximum syringe level in µl

Returns: Error code - ERR_NOERR indicates success

 {
     *Level_ul = NemV4DevicePosToMicrolitres(Nemesys, Nemesys->MinPos);
     return ERR_NOERR;
 }

Here is the call graph for this function:

long NemV4GetSyringeLevel	(	TNemesysV4 *	Nemesys,
		double *	Level_ul
	)

Returns the current syringe level in µl.

Parameters

Nemesys	Nemesys device to read from
Level_ul	Returns the current syringe level in µl

Returns: Error code - ERR_NOERR indicates success

 {
     int32_t PosIs;
     long Result = NemV4GetPosIs(Nemesys, &PosIs);
     CSI_RETURN_ON_ERROR(Result);
     *Level_ul = NemV4DevicePosToMicrolitres(Nemesys, PosIs);
     return ERR_NOERR;
 }

Here is the call graph for this function:

long NemV4IsStopped ( TNemesysV4 * Nemesys )

Checks if a dosing unit is moving or stopped.

If the pump is stopped, this does not indicate, that dosing was successful (that the requested volume was completely transfered).

Parameters

[in] Nemesys Nemesys to query

Return values

1	stopped - drive stopped because pump reached target or because an error occurred.
0	moving - a dosage is active
<0	Error code

Referenced by NemV4GetCurrentVelocity().

 {
      long    Result;
      uint8_t  IsFinished;
      
      Result = NemV4_IsState(Nemesys, SWBIT_TARG_REACHED, SWBIT_TARG_REACHED, &IsFinished);
      
      //
      // If function call was successful then return the state of dosing move
      // if function returns error code then return the error to user
      //
      if (Result != ERR_NOERR)
      {
          return Result;
      } 
      else
      {
          return  IsFinished;
      }
 }

Here is the call graph for this function:

long NemV4SetSyringeLevel	(	TNemesysV4 *	Nemesys,
		double	Level_ul,
		double	Flow_ul_min
	)

Set syringe to a certain fill level.

This function moves the pusher to a certain syringe fill level. This means, depending on the current syringe fill level this function will cause a aspiration or a dosing. You can call the function NemV4GetMaxSyringeLevel() to get the maximum syringe fill level for the current syringe configuration. The following example shows how to refill the syringe to its maximum level with the maximum flow rate.

double MaxLevel;
double MaxFlow;
NemV4GetMaxSyringeLevel(Nemesys1, &MaxLevel);
NemV4GetMaxFlow(Nemesys1, &MaxFlow);
NemV4SetSyringeLevel(Nemesys1, MaxLevel, MaxFlow);

Parameters

Nemesys	The Nemesys device to control
Level_ul	The target syringe fill level in microlitres
Flow_ul_min	The flow rate in microlitres per minute

Returns: Error code - ERR_NOERR indicates success

See also: NemV4GetSyringeLevel(), NemV4GetMaxSyringeLevel(), NemV4GetMaxFlow()

 {
     long    Result;
     int32_t PosIs;
     int32_t Velocity;
     int32_t TargetPos;
 
     TargetPos = NemV4MicrolitresToDevicePos(Nemesys, Level_ul);
     Velocity = NemV4MicrolitresPerMinuteToDeviceVel(Nemesys, Flow_ul_min);
 
     //
     // First read the actual position
     //
     Result = NemV4GetPosIs(Nemesys, &PosIs);
     CSI_RETURN_ON_ERROR(Result);
 
     //
     // We save last flow rate now - if the syringe level is > the is position
     // the we know that we aspirate and flowrate is < 0. If the syringe level is
     // < then the is position then we know that we dispense and flowrate is > 0
     //
     if (TargetPos > PosIs)
     {
         Nemesys->LastVelocity = 0 - Velocity;
     }
     else
     {
         Nemesys->LastVelocity = Velocity;
     }
 
     return NemV4MoveToPos(Nemesys, TargetPos, Velocity);
 }

Here is the call graph for this function:

long NemV4Stop ( TNemesysV4 * Nemesys )

Stops the current dosing move.

This function immediately stops the actual dosing move.

Parameters

Nemesys The Nemesys device to stop

Returns: Error code - ERR_NOERR indicates success

 {
     long     Result;
     uint16_t  ControlWord = CW_OP_EN | CWBIT_HALT;
 
     Result = NemV4_SetControlWord(Nemesys, ControlWord);
     if (ERR_NOERR == Result)
     {
         Nemesys->LastVelocity = 0;
     }
 
     return Result;
 }

Here is the call graph for this function:

Overview

Functions

Function Documentation