neMESYS SDK  20150729
Flow Profile

Setup, execute and stop flow profile tables. More...

Functions

NCS_Func long __stdcall NCS_AddFlowProfileValue (ncs_hdl hDevice, unsigned char DosingUnit, double Flow, unsigned int FlowUnit, unsigned long Duration, unsigned int ValveAction)
 Add single flow profile value to flow profile of certain dosing unit. More...
 
NCS_Func long __stdcall NCS_ClearFlowProfile (ncs_hdl hDevice, unsigned char DosingUnit)
 Clear flow profile. More...
 
NCS_Func long __stdcall NCS_GetFlowProfileState (ncs_hdl hDevice, unsigned char DosingUnit, unsigned long *pRemainingCycles, unsigned long *pActiveValueIndex)
 Get state of runnning flow profile. More...
 
NCS_Func long __stdcall NCS_GetFlowProfileValue (ncs_hdl hDevice, unsigned char DosingUnit, unsigned long Index, double *pValue)
 Read a certain entry from flow profile table. More...
 
NCS_Func long __stdcall NCS_GetNumberOfFlowProfileValues (ncs_hdl hDevice, unsigned char DosingUnit, unsigned long *pNumberOfValues)
 Query number of flow values values in current flow profile. More...
 
NCS_Func long __stdcall NCS_StartFlowProfile (ncs_hdl hDevice, unsigned char DosingUnit, unsigned long StartIndex, unsigned long Cycles)
 Start processing of flow profile for single dosing unit. More...
 

Detailed Description

Setup, execute and stop flow profile tables.

This group defines all required functions for configuration and execution of flow profiles (flow tables). The flow profile enables the autonomous processing of completely preconfigured flow tables. The processing of these flow tables leads to a certain flow profile generated by the certain pump unit.
For each step of the profile the flow rate, the duration and the valve action are configurable.

Function Documentation

NCS_Func long __stdcall NCS_AddFlowProfileValue ( ncs_hdl  hDevice,
unsigned char  DosingUnit,
double  Flow,
unsigned int  FlowUnit,
unsigned long  Duration,
unsigned int  ValveAction 
)

Add single flow profile value to flow profile of certain dosing unit.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
[in]FlowSingle flow value to add to end of flow profile
[in]FlowUnitUnit of the flow value in Flow parameter
[in]DurationTime in multiple of 100 ms a certain flow shall remain constant. I.e. a duration of 2 would produce a flow of 200 milliseconds.
[in]ValveActionIdentifies the valve action that should be triggered at the start of this flow profile entry. The valve actions are defined in the type TValveAction.
Returns
Error code - ERR_NOERR indicates success
NCS_Func long __stdcall NCS_ClearFlowProfile ( ncs_hdl  hDevice,
unsigned char  DosingUnit 
)

Clear flow profile.

Clears the list of flow profile values. Do this bevore you start to store new values into the flow profile with NCS_AddFlowProfileValue().

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
Returns
Error code - ERR_NOERR indicates success
NCS_Func long __stdcall NCS_GetFlowProfileState ( ncs_hdl  hDevice,
unsigned char  DosingUnit,
unsigned long *  pRemainingCycles,
unsigned long *  pActiveValueIndex 
)

Get state of runnning flow profile.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
[out]pRemainingCyclesReturns the number of remaining flow profile processing cycles.
[out]pActiveValueIndexIndex of active flow profile entry in flow table
Returns
Error code - ERR_NOERR indicates success
NCS_Func long __stdcall NCS_GetFlowProfileValue ( ncs_hdl  hDevice,
unsigned char  DosingUnit,
unsigned long  Index,
double *  pValue 
)

Read a certain entry from flow profile table.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
[in]IndexIndex into table of flow values (flow profile)
[out]pValueStores flow rate of flow profile entry
Returns
Error code - ERR_NOERR indicates success
NCS_Func long __stdcall NCS_GetNumberOfFlowProfileValues ( ncs_hdl  hDevice,
unsigned char  DosingUnit,
unsigned long *  pNumberOfValues 
)

Query number of flow values values in current flow profile.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
[out]pNumberOfValuesStores number of flow values.
Returns
Error code - ERR_NOERR indicates success
NCS_Func long __stdcall NCS_StartFlowProfile ( ncs_hdl  hDevice,
unsigned char  DosingUnit,
unsigned long  StartIndex,
unsigned long  Cycles 
)

Start processing of flow profile for single dosing unit.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
[in]StartIndexIndex of the flow table entry to start from
[in]CyclesNumber of cycles to process current flow profile (0 = infinite processing until user stops operation)
Returns
Error code - ERR_NOERR indicates success