Functions to query the actual pump status, flow and volume.
This groups defines all functions to read the actual pump status (pumping or stopped), the actual flow and volume from the device.
◆ LCP_GetDosedVolume()
LCP_Func long LCP_CALL LCP_GetDosedVolume |
( |
dev_hdl |
hPump, |
|
|
double * |
pDosedVolume |
|
) |
| |
Get the already dosed volume.
- Parameters
-
[in] | hPump | A valid pump handle |
[out] | pDosedVolume | Returns the already dosed volume |
- Returns
- Error code - ERR_NOERR indicates success
- Examples:
- capi_contiflow_test.cpp.
◆ LCP_GetFillLevel()
LCP_Func long LCP_CALL LCP_GetFillLevel |
( |
dev_hdl |
hPump, |
|
|
double * |
pFillLevel |
|
) |
| |
Returns the actual fill level of the pump.
This function returns valid results only for pumps that support a fill level (eg. syringe pumps). Peristaltic pumps do not support fill level. For a syringe pump this function returns the current syringe fill level
- Parameters
-
[in] | hPump | A valid pump handle |
[out] | pFillLevel | Returns the current fill level of the pump container (eg. syringe) |
- Returns
- Error code - ERR_NOERR indicates success
- Examples:
- capi_nemesys_test.cpp, and capi_pressure_control_test.cpp.
◆ LCP_GetFlowIs()
LCP_Func long LCP_CALL LCP_GetFlowIs |
( |
dev_hdl |
hPump, |
|
|
double * |
pFlowRateIs |
|
) |
| |
◆ LCP_GetTargetVolume()
LCP_Func long LCP_CALL LCP_GetTargetVolume |
( |
dev_hdl |
hPump, |
|
|
double * |
pTargetVolume |
|
) |
| |
Read the target volume.
This function simply returns the set target volume value
- Parameters
-
[in] | hPump | A valid pump handle |
[out] | pTargetVolume | Returns the target volume to dose |
- Returns
- Error code - ERR_NOERR indicates success
◆ LCP_IsCalibrationFinished()
LCP_Func long LCP_CALL LCP_IsCalibrationFinished |
( |
dev_hdl |
hPump | ) |
|
◆ LCP_IsPositionSensingInitialized()
LCP_Func long LCP_CALL LCP_IsPositionSensingInitialized |
( |
dev_hdl |
hPump | ) |
|
Returns true, if the position sensing system is properly initialized.
Each pump drive tracks the actual position value (volume value) by an internal position counter / encoder. Some pumps, such as the new Nemesys S and Nemesys M pumps, have an absolute encoder. That means, this encoder always keeps its position, even if the pumps are turned of. For these pumps this function always returns true. Other pumps, like the Nemesys Low Pressure Pump, have an incremental encoder. This encoder loses its position if the pump power is turned off. That means, if such a pump gets powered on, the this function returns false, because the position of the incremental encoder is not initialized yet. To initialize the position of the encoder, you need to do a reference move via LCP_SyringePumpCalibrate() or you need to restore a previously saved encoder position via LCP_RestoreDrivePosCnt().
- Parameters
-
[in] | hPump | A valid pump handle |
- Return values
-
- See also
- LCP_SyringePumpCalibrate(), LCP_RestoreDrivePosCnt()
- Examples:
- capi_nemesys4_test.cpp, and Pump_CAPI_Init.cpp.
◆ LCP_IsPumping()
LCP_Func long LCP_CALL LCP_IsPumping |
( |
dev_hdl |
hPump | ) |
|