Device State

Overview

This group defines all required functions for reading and writing device state specific parameters.

Collaboration diagram for Device State:

Functions
long	NemClearFault (TNemesys *Nemesys)
	Clear fault state of device. More...
uint32_t	NemIsEnabled (TNemesys *Nemesys)
	Check if device is in enabled state. More...
uint32_t	NemIsInFaultState (TNemesys *Nemesys)
	Query fault state of device Check if device is in fault state. More...
long	NemSetEnabled (TNemesys *Nemesys)
	Set single dosing unit into enable state. More...

Function Documentation

long NemClearFault

(

TNemesys *

Nemesys

)

Clear fault state of device.

If device is in fault state then it is not possible to enable the device until the fault state is cleared. In fault state the device cannot execute any move. If you need further information about the error occured you can call the function NemGetLastDevErr().

Parameters

[in]

Nemesys

Device to reset from fault state

Returns

Error code - ERR_NOERR indicates success

See also

NemIsInFaultState(), NemGetLastDevErr()

{
    long Result;

    //
    // First we clear the error history and tehn we clear the fault state
    //
    Result = Nem_ClearErrHist(Nemesys);
    if (ERR_NOERR != Result)
    {
        return Result;
    }

    return Nem_SetControlWord(Nemesys, CW_FAULT_RST);
}

Here is the call graph for this function:

uint32_t NemIsEnabled

(

TNemesys *

Nemesys

)

Check if device is in enabled state.

If device is not in enabled state, then dosing is not possible. You need to call NemSetEnabled() to set device in enabled state.

Parameters

[in]

Nemesys

Device to query

Return values

1	enabled state
0	disabled state
<0	Error code

See also

NemSetEnabled()

{
    long    Result;
    uint8_t  IsOperational;
    
    Result = Nem_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 NemIsInFaultState

(

TNemesys *

Nemesys

)

Query fault state of device Check if device is in fault state.

Parameters

[in]

Nemesys

Device to query

Return values

1	fault state
0	not in fault state
<0	Error code

See also

NemClearFault(), NemGetLastDevErr()

{
    long    Result;
    uint8_t  IsInFaultState;
     
    Result = Nem_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 NemSetEnabled

(

TNemesys *

Nemesys

)

Set single dosing unit into enable state.

Dosing is possible if device is in enable state. If device is in fault state, then you need to clear the fault state first by calling NemClearFault() and then you can set the device into enable state by calling this function.

Parameters

[in]

Nemesys

Device to set enabled

Returns

Error code - ERR_NOERR indicates success

See also

NemIsOperational(), NemClearFault()

{
    uint16_t   state;
    long      Result;
    uint8_t    loopcnt = 0;

    //
    // first read status word
    //
    Result = NemReadStatusWord(Nemesys, &state);
    if (Result != ERR_NOERR)
    {
        return 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 // while (state != DS402_STATE_OP_EN)
    {
        if (STATE_IS_QUICK_STOP(state))
        {
            Result = Nem_ExecDrvStateCmd(Nemesys, CW_OP_EN, &state, DRV_PROC_TIME);
        }
        else if (STATE_IS_SWON_DIS(state))
        {
            Result = Nem_ExecDrvStateCmd(Nemesys, CW_SHUTDOWN, &state, DRV_PROC_TIME);
        }
        else if (STATE_IS_SWON_RDY(state))
        {
            Result = Nem_ExecDrvStateCmd(Nemesys, CW_SWON, &state, DRV_PROC_TIME);
        }
        else if (STATE_IS_SWON(state))
        {
            //
            // if operation is enabled we set the hal bit in order to avoid
            // a running drive
            //
            Result = Nem_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: