FB_SoEReadCommandState

FB_SoEReadCommandState 1:

The function block FB_SoEReadCommandState can be used to read the state of a command.  

VAR_INPUT

VAR_INPUT
    sNetId   : T_AmsNetId := '';
    nIdn     : WORD;
    bExecute : BOOL;
    tTimeout : TIME := DEFAULT_ADS_TIMEOUT;
END_VAR

sNetId: A string containing the AMS network identifier of the PC.

nIdn: Parameter number for the command, i.e. "P_0_IDN + 160" for executing a P-0-0160 command

bExecute: The block is activated by a rising edge at this input.

tTimeout: Maximum time allowed for the execution of the function block.

VAR_IN_OUT

VAR_IN_OUT
    Axis : NCTOPLC_AXLESTRUCT;(* reference to NC axis *)
END_VAR

Axis: Axis structure.

VAR_OUTPUT

VAR_OUTPUT
    bBusy         : BOOL;
    bError        : BOOL;
    eCmdState     : E_SoE_CmdState;
    iAdsErrId     : UINT;
    iSercosErrId  : UINT;
END_VAR

bBusy: This output is set when the function block is activated, and remains set until an acknowledgement is received.

bError: This output is set up after the bBusy output has been reset if there has been an error in transmission of the command.

iAdsErrId: Supplies the ADS error code associated with the most recently executed command if the bError output is set.

iSercosErrId: Supplies the Sercos error code associated with the most recently executed command if the bError output is set.

dwAttribute: Supplies the Sercos parameter attribute.

eCmdState: Supplies the command state

    eSoE_CmdState_NotSet =
0               
- no command active

    eSoE_CmdState_Set =
1                  
- command set (prepared) but (not yet) executed

    eSoE_CmdState_Executed =
2             
- command was executed

    eSoE_CmdState_SetEnabledExecuted =
3    - command set (prepared) and executed

    eSoE_CmdState_SetAndInterrupted =
5     - command was set but interupted

    eSoE_CmdState_SetEnabledNotExecuted = 7 -
command execution is stll active

    eSoE_CmdState_Error =
15               
- error during command execution, switched to error state

Sample

fbReadCommandState : FB_SoEReadCommandState;
bReadCommandState  : BOOL;
nIdn               : WORD;
eCmdState          :E_SoE_CmdState;

(* NcAxis *)
stNcToPlc AT %I* : NCTOPLC_AXLESTRUCT;
IF bReadCommandState THEN
    nIdn := P_0_IDN + 160;
    fbReadCommandState(
        Axis     := stNcToPlc,
        bExecute := TRUE,
        tTimeout := DEFAULT_ADS_TIMEOUT,
        nIdn     := nIdn,
        eCmdState => eCmdState
    );
    IF NOT fbReadCommandState.bBusy THEN
        fbReadCommandState(Axis := stNcToPlc, bExecute := FALSE);
        bReadCommandState := FALSE;
    END_IF
END_IF