Overview
This group defines all required functions for reading and changing the device state and for reading the error state and error information.
Functions | |
long NemV4ClearFault (TNemesysV4 *Nemesys) | |
Clear fault state of Nemesys. More... | |
long NemV4GetLastDevErr (TNemesysV4 *Nemesys, int32_t *pLastDevErr) | |
Read last Nemesys error from error register. More... | |
uint32_t NemV4IsEnabled (TNemesysV4 *Nemesys) | |
Check if Nemesys is in enabled state. More... | |
uint32_t NemV4IsInFaultState (TNemesysV4 *Nemesys) | |
Query fault state of Nemesys pump drive. More... | |
long NemV4ReadStatusWord (TNemesysV4 *Nemesys, uint16_t *pwStatusWord) | |
Read status word from Nemesys. More... | |
long NemV4SetEnabled (TNemesysV4 *Nemesys) | |
Set single dosing unit into enable state. More... | |
Function Documentation
long NemV4ClearFault | ( | TNemesysV4 * | Nemesys | ) |
Clear fault state of Nemesys.
If Nemesys is in fault state then it is not possible to enable the Nemesys until the fault state is cleared. In fault state the Nemesys cannot execute any move. If you need further information about the error occurred you can call the function NemV4GetLastDevErr().
- Parameters
-
Nemesys Device pointer of device to reset from fault state.
- Returns
- Error code - ERR_NOERR indicates success
long NemV4GetLastDevErr | ( | TNemesysV4 * | Nemesys, |
int32_t * | pLastDevErr | ||
) |
Read last Nemesys error from error register.
If Nemesys is in fault state, then a Nemesys error occurred. The last Nemesys error is always stored in the Nemesys error register. This function reads the last Nemesys error from the Nemesys error register. The function NemV4ClearFault() will clear the error register so the application should read the last Nemesys error before it clears the fault state.
- Parameters
-
[in] Nemesys Nemesys to query [out] pLastDevErr Stores last Nemesys error code
- Returns
- Error code - ERR_NOERR indicates success
- See also
- NemV4IsInFaultState(), NemV4ClearFault()
uint32_t NemV4IsEnabled | ( | TNemesysV4 * | Nemesys | ) |
Check if Nemesys is in enabled state.
If Nemesys is not in enabled state, then dosing is not possible. You need to call NemV4SetEnabled() to set Nemesys in enabled state.
- Parameters
-
[in] Nemesys Device pointer of device to query
- Return values
-
1 enabled state 0 disabled state <0 Error code
- See also
- NemV4SetEnabled()
uint32_t NemV4IsInFaultState | ( | TNemesysV4 * | Nemesys | ) |
Query fault state of Nemesys pump drive.
Check if Nemesys is in fault state. The fault state needs to get cleared via NemV4ClearFault() before the pump drive can be enabled.
- See also
- NemV4ClearFault()
- Parameters
-
Nemesys Device pointer
- Return values
-
1 fault state 0 not in fault state <0 Error code
Referenced by NemV4ClearFault().
long NemV4ReadStatusWord | ( | TNemesysV4 * | Nemesys, |
uint16_t * | pwStatusWord | ||
) |
Read status word from Nemesys.
The bits of the statusword indicate the current state of the drive.
- Parameters
-
[in] Nemesys Nemesys to query [out] pwStatusWord Buffer stores received status word
- Returns
- Error code - ERR_NOERR indicates success
Referenced by NemV4_ExecDrvStateCmd(), NemV4_IsState(), and NemV4SetEnabled().
long NemV4SetEnabled | ( | TNemesysV4 * | Nemesys | ) |
Set single dosing unit into enable state.
Dosing is possible if Nemesys is in enable state. If Nemesys is in fault state, then you need to clear the fault state first by calling NemV4ClearFault() and then you can set the Nemesys into enable state by calling this function.
- Parameters
-
[in] Nemesys Nemesys device to set enabled
- Returns
- Error code - ERR_NOERR indicates success
- See also
- NemV4IsOperational(), NemV4ClearFault()