RecipeOpen

This function/function block was added in KAS 5.00.

PLCopen motion icon Pipe Network motion icon

Function Block - Open a recipe file and create a recipe object.

Recipe files opened with RecipeOpen must include a recipe definition section.

Instance sections are optional.
Recipes without instance sections can be opened and used later with RecipeStoreInstance to create instances from active program data.

Inputs

Input

Data Type

See Data Types.

Range

Unit

Default

Description

Execute

BOOL

FALSE, TRUE

N/A

No default

On the rising edge, load a recipe file.

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.
RecipeID	UDINT	No range	N/A	The ID of the recipe object.

FBD Language Example

FFLD Language Example

IL Language Example

Not available.

ST Language Example

Inst_RecipeOpen(True, 'Parts.xml', RCP_FMT_XML);
IF Inst_RecipeOpen.Error THEN 
   errorMessage := MC_ErrorDescription(Inst_RecipeOpen.ErrorID); 
ELSE 
   recipeID = Inst_RecipeOpen.RecipeID 
END_IF;