Dosing Info

Overview

This group defines all required functions for query of different dosing parameters and device states.

Collaboration diagram for Dosing Info:

Functions
long	NemGetFlowRate (TNemesys *Nemesys, int32_t *pdwFlowRate)
	Query actual flow rate of dosing unit. More...
long	NemGetSyringeLevel (TNemesys *Nemesys, int32_t *pSyringeLevel)
	Query actual syringe fill level. More...
long	NemIsCalibrationFinished (TNemesys *Nemesys)
	Checks if a dosing unit finished the calibration move. More...
long	NemIsDosingFinished (TNemesys *Nemesys)
	Checks if a dosing unit finished the last dosing task. More...

Function Documentation

long NemGetFlowRate	(	TNemesys *	Nemesys,
		int32_t *	pdwFlowRate
	)

Query actual flow rate of dosing unit.

Parameters

[in]	Nemesys	Device to query
[out]	pdwFlowRate	Stores flow rate (speed in mrpm - millirevolutions per minute)

Returns

Error code - ERR_NOERR indicates success

{
    int32_t Result;

    *pFlowRate = 0;
    Result = NemIsDosingFinished(Nemesys);
    if (Result < 0)
    {
        return Result;
    }

    //
    // If dosing is finished, then the flow rate is 0
    //
    if (Result)
    {
        Nemesys->LastVelocity = 0;
    }

    *pFlowRate = Nemesys->LastVelocity;
    return Result;
}

Here is the call graph for this function:

long NemGetSyringeLevel	(	TNemesys *	Nemesys,
		int32_t *	pSyringeLevel
	)

Query actual syringe fill level.

Parameters

[in]	Nemesys	Device to query
[out]	pSyringeLevel	Stores the syringe level in increments 0 = empty syringe > 0 = filled syringe < 0 = invalid, axis needs recalibration

Returns

Error code - ERR_NOERR indicates success

{
    return Nem_GetPosIs(Nemesys, pSyringeLevel);
}

Here is the call graph for this function:

long NemIsCalibrationFinished

(

TNemesys *

Nemesys

)

Checks if a dosing unit finished the calibration move.

During calibration the dosing unit moves the pusher to the lower limit switch and then to the zero position. Calibration is finished if the zero position is reached. (position counter is reset to zero)

Parameters

[in]

Nemesys

Device to query

Return values

1	finished - drive stopped and calibrated
0	calibration is active - drive is moving
<0	Error code - ERR_NOERR indicates success

{
     long    Result;
     uint8_t  IsFinished;
     
     Result = Nem_IsState(Nemesys, SWBIT_HOMING_ATTAINED, SWBIT_HOMING_ATTAINED, &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 NemIsDosingFinished

(

TNemesys *

Nemesys

)

Checks if a dosing unit finished the last dosing task.

The last dosing task is finished if device reached the target volume or device reached its minimum or maximum limits. That means dosing is finished if device is stopped - it does not indicate, that dosing was successful (that the requested volume was completely transfered)

Parameters

[in]

Nemesys

Device to query

Return values

1	finished - drive stopped and calibrated
0	calibration is active - drive is moving
<0	Error code - ERR_NOERR indicates success

Referenced by NemGetFlowRate().

{
     long    Result;
     uint8_t  IsFinished;
     
     Result = Nem_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: