FB_VN_InitializeFunction

This FB initializes selected functions. Before, it needs to initialize itself, i.e. call the FB until the output bInitialized is true before using it for function initialization.

Syntax

Definition:

FUNCTION_BLOCK FB_VN_InitializeFunction
VAR_INPUT
    eFunction : ETcVnInitializableFunction;
    nOptions  : ULINT;
    bStart    : BOOL;
    nTimeout  : TIME;
END_VAR
VAR_OUTPUT
    bBusy     : BOOL;
    bError    : BOOL;
    nErrorId  : UDINT;
END_VAR

Inputs

Name	Type	Default	Description
eFunction	ETcVnInitializableFunction		Selects the function to initialize
nOptions	ULINT	0	Selects initialization options for the function
bStart	BOOL		Function initialization is triggered by a rising edge at this input.
nTimeout	TIME	VISION_ADS_TIMEOUT	Indicates the time before the function is cancelled.

Outputs

Name	Type	Description
bBusy	BOOL	This output remains TRUE until the function block has executed a command, but at the longest for the duration supplied to the 'nTimeout' input. While bBusy = TRUE, no new command will be accepted at the inputs.
bError	BOOL	This output is switched to TRUE as soon as an error occurs during the execution of a command. The command-specific error code is contained in ‘nErrorId’. If the function block has a timeout error, 'bError' is TRUE and 'nErrorId' is 1861 (hexadecimal 0x745). Is reset to FALSE by the execution of a command at the inputs.
nErrorId	UDINT	Contains the ADS error code or the command-specific error code of the last executed command. Is reset to 0 by the execution of a command at the inputs.

Further information

The function block FB_VN_InitializeFunction initializes the function specified at eFunction. The required data is loaded asynchronously into the PLC in the background.

Parameter

Some parameters are described centrally in the section File Access Parameters. In contrast to the description, the function to be initialized must be specified for this function block instead of a file path.

Function

The eFunction to be initialized.

Options

Selection of the initialization options nOptions for the specified function. The possible enum options can be found in the description of the function to be initialized. The options can be linked with a OR and thus loaded with a call to the function block.

Application

The initialization of the OCR function with the option to classify capital letters looks like this, for example:

fbInitOCR(
    eFunction   := TCVN_IF_OCR, 
    nOptions    := ETcVnOcrModelType.TCVN_OMT_UCLETTERS,
    bStart      := TRUE,
    nTimeout    := T#500MS);

IF NOT fbInitOCR.bBusy AND NOT fbInitOCR.bError THEN
    // The function is initialized and can be used with the specified options
END_IF

Related functions

F_VN_CheckFunctionInitialization can be used to check whether a function is initialized with a corresponding option.
F_VN_DeinitializeFunction offers the possibility to de-initialize an option of a function and thus release the memory.

Required License

TC3 Vision Base

System Requirements

Development environment	Target platform	PLC libraries to include
TwinCAT V3.1. 4024.44 or later	PC or CX (x64) with PL50, e.g. Intel 4-core Atom CPU	Tc3_Vision