Dosing

Overview

This group defines all required functions for execution of different dosing tasks like dosing a certain volume or generating a constant flow.

Collaboration diagram for Dosing:

Functions
long	NemDoseVolume (TNemesys *Nemesys, uint32_t dwVolume, int32_t dwFlowRate)
	Dose a certain volume with a certain flowrate. More...
long	NemGenerateConstantFlow (TNemesys *Nemesys, int32_t dwFlowRate)
	Generate a constant flow rate. More...
long	NemSetSyringeLevel (TNemesys *Nemesys, uint32_t dwSyringeLevel, uint32_t dwFlowRate)
	Set syringe to a certain fill level. More...
long	NemStop (TNemesys *Nemesys)
	Stops actual dosing move. More...

Function Documentation

long NemDoseVolume	(	TNemesys *	Nemesys,
		uint32_t	dwVolume,
		int32_t	dwFlowRate
	)

Dose a certain volume with a certain flowrate.

This call moves the pusher to a target position until the target volume is dosed or until the upper or lower limit is reached.

Parameters

[in]	Nemesys	Device to move
[in]	dwVolume	Volume (relative position range) to dose. The value is given in increments
[in]	dwFlowRate	The flow rate (speed) in mrpm (milli revolutions per second). The sign of the flowrate value defines the direction: flowrate < 0 = aspiration flowrate > 0 = dispense

Returns

Error code - ERR_NOERR indicates success

{
    long    Result;
    int32_t  dwPosIs;
    int32_t  dwTargetPos;

    Nemesys->LastVelocity = dwFlowRate;
    //
    // First read the actual position - this is our starting point
    //
    Result = Nem_GetPosIs(Nemesys, &dwPosIs);
    if (Result != ERR_NOERR)
    {
        return Result;
    }

    //
    // Now calculate target position - target position depends on the
    // dwVolume value and on the sign of the dwFlowRate  - a negative flowrate
    // indicates aspiration and a positive flowrate indicates dispension
    // The drive only uses positive flow rates so we invert the flow rate
    // if it is negative.
    //
    if (dwFlowRate < 0)
    {
        dwFlowRate = 0 - dwFlowRate;
        dwTargetPos = dwPosIs + dwVolume;
    }
    else
    {
        dwTargetPos = dwPosIs - dwVolume;
    }

    //
    // Finally execute a simple absolut position move
    //
    return Nem_MoveToPos(Nemesys, dwTargetPos, dwFlowRate);
}

Here is the call graph for this function:

long NemGenerateConstantFlow	(	TNemesys *	Nemesys,
		int32_t	dwFlowRate
	)

Generate a constant flow rate.

The pusher moves until the upper or lower limit is reached or until the user manually halts the movement.

Parameters

[in]	Nemesys	Device to move
[in]	dwFlowRate	The flow rate (speed) in mrpm (milli revolutions per second). The sign of the flowrate value defines the direction: flowrate < 0 = aspiration flowrate > 0 = dispense

Returns

Error code - ERR_NOERR indicates success

See also

NemStop()

{
    int32_t TargetPos;

    Nemesys->LastVelocity = FlowRate;
    //
    // Now calculate target position - target position depends on the
    // dwVolume value and on the sign of the dwFlowRate
    //
    if (FlowRate < 0)
    {
        FlowRate = 0 - FlowRate;
        TargetPos = Nemesys->MaxPos; // move to upper limit
    }
    else
    {
        TargetPos = 0;             // move to lower limit
    }

    //
    // Finally execute a simple absolut position move
    //
    return Nem_MoveToPos(Nemesys, TargetPos, FlowRate);
}

Here is the call graph for this function:

long NemSetSyringeLevel	(	TNemesys *	Nemesys,
		uint32_t	dwSyringeLevel,
		uint32_t	dwFlowRate
	)

Set syringe to a certain fill level.

This call moves the pusher to a certain position.

Parameters

[in]	Nemesys	Device to move
[in]	dwSyringeLevel	The fill level (absolut position) in increments
[in]	dwFlowRate	The flow rate (speed) in mrpm (milli revolutions per minute)

Returns

Error code - ERR_NOERR indicates success

See also

NemGetSyringeLevel()

{
    long    Result;
    int32_t dwPosIs;


    //
    // First read the actual position
    //
    Result = Nem_GetPosIs(Nemesys, &dwPosIs);
    if (Result != ERR_NOERR)
    {
        return 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 ((int32_t)dwSyringeLevel > dwPosIs)
    {
        Nemesys->LastVelocity = 0 - dwFlowRate;
    }
    else
    {
        Nemesys->LastVelocity = dwFlowRate;
    }

    return Nem_MoveToPos(Nemesys, dwSyringeLevel, dwFlowRate);
}

Here is the call graph for this function:

long NemStop

(

TNemesys *

Nemesys

)

Stops actual dosing move.

This function immediatelly stops the actual dosing move.

Parameters

[in]

Nemesys

Device to stop

Returns

Error code - ERR_NOERR indicates success

{
    long     Result;
    uint16_t  ControlWord = CW_OP_EN | CWBIT_HALT;

    Result = Nem_SetControlWord(Nemesys, ControlWord);
    if (ERR_NOERR == Result)
    {
        Nemesys->LastVelocity = 0;
    }

    return Result;
}

Here is the call graph for this function: