Functions to control and maintain the drive that drives the pump.
◆ LCP_ClearFault()
LCP_Func long LCP_CALL LCP_ClearFault |
( |
dev_hdl |
hPump | ) |
|
◆ LCP_Disable()
LCP_Func long LCP_CALL LCP_Disable |
( |
dev_hdl |
hPump | ) |
|
Set pump into disabled state.
Call this function to remove power from pump drive
- Parameters
-
[in] | hPump | A valid pump handle |
- Returns
- Error code
◆ LCP_Enable()
LCP_Func long LCP_CALL LCP_Enable |
( |
dev_hdl |
hPump | ) |
|
◆ LCP_GetDrivePosCnt()
LCP_Func long LCP_CALL LCP_GetDrivePosCnt |
( |
dev_hdl |
hPump, |
|
|
long * |
pPosCntValue |
|
) |
| |
Query the value of the internal drive position counter.
- See also
- LCP_RestoreDrivePosCnt()
- Parameters
-
[in] | hPump | Valid pump handle |
[out] | pPosCntValue | Returns the actual value of the position counter |
- Returns
- Error code - ERR_NOERR indicates success
◆ LCP_GetPumpDriveHandle()
Returns the drive handle of pump drive for the given pump.
You can pass the drive handle to the motion control library to access the drive functionality (like reading and restoring the position counter) directly.
- Parameters
-
[in] | hPump | A valid pump handle |
- Return values
-
0 | - No pump drive access possible |
1 | - Pump drive handle |
<0 | - Error code - Error getting pump drive handle |
- Examples:
- capi_nemesys_test.cpp.
◆ LCP_IsEnabled()
LCP_Func long LCP_CALL LCP_IsEnabled |
( |
dev_hdl |
hPump | ) |
|
◆ LCP_IsInFaultState()
LCP_Func long LCP_CALL LCP_IsInFaultState |
( |
dev_hdl |
hPump | ) |
|
◆ LCP_RestoreDrivePosCnt()
LCP_Func long LCP_CALL LCP_RestoreDrivePosCnt |
( |
dev_hdl |
hPump, |
|
|
long |
PosCntValue |
|
) |
| |
Restore internal hardware position counter value of pump drive.
The function restores the internal position counter value saved with LCA_GetDrivePosCnt(). This function is not required and not supported for devices that have an absolute encoder such as the new Nemesys 4 devices Nemesys S and Nemesys M.
- Note
- In many drives the actual position value is counted by a quadrature decoder. This internal position counter value will get lost, as soon as the device is switched off. In order to restore this position counter value after power on, an application can query the internal position counter value (LCA_GetDrivePosCnt()), store it persistently into a configuration file and restore it later by calling this function.
- See also
- LCP_GetDrivePosCnt()
- Parameters
-
[in] | hPump | Valid pump handle |
[in] | PosCntValue | The position counter value to restore |
- Return values
-
ERR_NOERR | indicates success |
-ERR_DEVNOSUPP | if the device has an absolute encoder and restoring position counter values is not required and not supported. |
- Examples:
- capi_nemesys4_test.cpp, and Pump_CAPI_Init.cpp.