RecipeQuickLoad

This function/function block was added in KAS 5.00.

PLCopen motion icon Pipe Network motion icon

Function Block - Load a recipe file and immediately apply the items it contains.

RecipeQuickLoad loads a recipe instance without requiring that a recipe definition be loaded first.

Only the first recipe instance found in the file is applied.
When ContinueOnError is TRUE, all validation errors encountered are added to the controller log.
- See Log Messages tabs.

Inputs

Input

Data Type

See Data Types.

Range

Unit

Default

Description

Execute

BOOL

FALSE, TRUE

N/A

No default

On the rising edge, request loading and applying the recipe stored in the file RecipeFile.

ContinueOnError

BOOL

FALSE, TRUE

N/A

No default

If FALSE, no recipe items are applied if an error occurs.
If TRUE, an error does not halt application of recipe items.
All recipe items that can be applied are applied.

RecipeFile

STRING

No range

N/A

No default

The location of the recipe file.

RecipeFormat

SINT

Enumerated

N/A

No default

The recipe file format.
Valid values include one of these enumeration values:

Value	Description
RCP_FMT_XML	XML file format.
RCP_FMT_TOML	TOML file format.

Outputs

Output	Data Type See Data Types.	Range	Unit	Description
Done	BOOL	FALSE, TRUE	N/A	If TRUE, the command completed successfully.
Busy	BOOL	FALSE, TRUE	N/A	If TRUE, the function block is executing.
Error	BOOL	FALSE, TRUE	N/A	If TRUE, an error has occurred.
ErrorID	DINT	Enumerated	N/A	Indicates the error if Error output is TRUE. See PLCopen Function Block ErrorIDs.

FBD Language Example

FFLD Language Example

IL Language Example

Not available.

ST Language Example

Inst_RecipeQuickLoad(True, False, 'CogsRecipeInst.xml', RCP_FMT_XML);
IF Inst_RecipeQuickLoad.Error THEN 
   errorMessage := MC_ErrorDescription(Inst_RecipeQuickLoad.ErrorID); 
END_IF;