Overview

This group defines all required functions for reading and changing the device state and for reading the error state and error information.

Collaboration diagram for Device State and Error Handling:

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

See also: NemV4IsInFaultState(), NemV4GetLastDevErr()

 {
     long Result;
 
     Result = NemV4IsInFaultState(Nemesys);
     CSI_RETURN_ON_ERROR(Result);
 
     // If we are not in fault state, then we can return now
     if (!Result)
     {
         return ERR_NOERR;
     }
 
     //
     // First we clear the error history and then we clear the fault state
     //
     Result = NemV4_ClearErrHist(Nemesys);
     CSI_RETURN_ON_ERROR(Result);
 
     return NemV4_SetControlWord(Nemesys, CW_FAULT_RST);
 }

Here is the call graph for this function:

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()

 {
     return CsiDevReadObject(&Nemesys->Device, NemV4_OD_H1003_ERROR_HISTORY,
         H1003_SUB_01_ERR_IDX_1, (uint32_t*)pLastDevErr);
 }

Here is the call graph for this function:

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()

 {
     long    Result;
     uint8_t  IsOperational;
     
     Result = NemV4_IsState(Nemesys, 0x006F, SW_OP_EN, &IsOperational);
     
     //
     // If function call was successful then return the state of dosing move
     // if function returns error code then return the error to user
     //
     if (Result != ERR_NOERR)
     {
         return Result;
     } 
     else
     {
         return IsOperational;
     }
 }

Here is the call graph for this function:

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    Result;
     uint8_t  IsInFaultState;
      
     Result = NemV4_IsState(Nemesys, 0x004F, SW_FAULT, &IsInFaultState);
     
     //
     // If function call was successful then return the state of dosing move
     // if function returns error code then return the error to user
     //
     if (Result != ERR_NOERR)
     {
         return Result;
     } 
     else
     {
         return IsInFaultState;
     }
 }

Here is the call graph for this function:

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    Result;
     uint32_t StatusWord;
 
     Result = CsiDevReadObject(&Nemesys->Device, NemV4_OD_H6041_STATUS_WORD, 0, &StatusWord);
     *pwStatusWord = StatusWord;
 
     return Result;
 }

Here is the call graph for this function:

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()

 {
     uint16_t state;
     long Result;
     uint8_t loopcnt = 0;
 
     //
     // first read status word
     //
     Result = NemV4ReadStatusWord(Nemesys, &state);
     CSI_RETURN_ON_ERROR(Result);
 
     //
     // if drive is in fault state or in fault reaction state then we cannot enable
     // drive because the user has to clear the fault state first
     //
     if (STATE_IS_FAULT(state) || STATE_IS_FAULT_REAC(state))
     {
         return -ERR_DS402_DRV_ENABLE_FAULT_STATE;
     }
 
     //
     // loop until we rach the operation enable state or until
     // we reach the loop limit
     //
     do
     {
         if (STATE_IS_QUICK_STOP(state))
         {
             Result = NemV4_ExecDrvStateCmd(Nemesys, CW_OP_EN, &state, DRV_PROC_TIME);
         }
         else if (STATE_IS_SWON_DIS(state))
         {
             Result = NemV4_ExecDrvStateCmd(Nemesys, CW_SHUTDOWN, &state, DRV_PROC_TIME);
         }
         else if (STATE_IS_SWON_RDY(state) || STATE_IS_SWON(state))
         {
             //
             // if we enable operation we set the halt bit in order to avoid
             // a running drive
             //
             Result = NemV4_ExecDrvStateCmd(Nemesys, CW_OP_EN | CWBIT_HALT, &state, DRV_PROC_TIME);
         }
     } while (!STATE_IS_OP_EN(state) && (loopcnt++ < 10) && (ERR_NOERR == Result));
 
 
     if (loopcnt <= 10)
     {
         return Result;
     }
     else
     {
         return -ERR_DS402_TIMEOUT_STATUSWORD;
     }
 }

Here is the call graph for this function:

Overview

Functions

Function Documentation