CETONI SDK  20220623
The software libraries for integration of all CETONI devices.
Pump API Initialisation

Overview

API specific initialisation functions.

This groups defines all functions to setup and initialize the labbCAN pump API properly.

+ Collaboration diagram for Pump API Initialisation:

Functions

LCP_Func long LCP_CALL LCP_GetNoOfPumps ()
 Query number of detected pump devices. More...
 
LCP_Func long LCP_CALL LCP_GetPumpHandle (unsigned char Index, dev_hdl *PumpHandle)
 Get pump handle by its index. More...
 
LCP_Func long LCP_CALL LCP_LookupPumpByName (const char *pPumpName, dev_hdl *PumpHandle)
 Lookup for a pump device by its name. More...
 

Function Documentation

◆ LCP_GetNoOfPumps()

LCP_Func long LCP_CALL LCP_GetNoOfPumps ( )

Query number of detected pump devices.

Return values
>=0 Number of detected pump devices
<0 Error code
Examples:
capi_nemesys_test.cpp.

◆ LCP_GetPumpHandle()

LCP_Func long LCP_CALL LCP_GetPumpHandle ( unsigned char  Index,
dev_hdl PumpHandle 
)

Get pump handle by its index.

Parameters
[in]IndexIndex into list of available pump devices
[out]PumpHandleHandle to pump device or 0 if the given index is out of range
Return values
-ERR_PARAM_RANGEIf the given device index is out of range
ERR_NOERRindicates success
Examples:
capi_event_queue_test.cpp, capi_nemesys_test.cpp, and capi_pressure_control_test.cpp.

◆ LCP_LookupPumpByName()

LCP_Func long LCP_CALL LCP_LookupPumpByName ( const char *  pPumpName,
dev_hdl PumpHandle 
)

Lookup for a pump device by its name.

Parameters
[in]pPumpNameThe name of the device to lookup for
[out]PumpHandleHandle to pump device or 0 if no pump with given name exists
Return values
-ERR_NODEVNo device with the given name found
ERR_NOERRindicates success
Examples:
capi_contiflow_test.cpp, capi_nemesys4_test.cpp, capi_nemesys_forcemon_test.cpp, capi_nemesys_test.cpp, capi_nemesys_valve_test.cpp, and Pump_CAPI_Init.cpp.