RecipeManCommands.DeleteRecipe (METH) ¶ METHOD DeleteRecipe : DWORD Removes a recipe from the recipe definition InOut: Scope Name Type Comment Return DeleteRecipe DWORD Possible last error values: ERR_RECIPE_DEFINITION_NOT_FOUND ERR_RECIPE_NOT_FOUND ERR_NO_RECIPE_MANAGER_SET ERR_OK See ReturnValues (GVL) for a description of all possible errors. Inout Const RecipeDefinitionName STRING Name of the recipe definition RecipeName STRING Name of the recipe
RecipeManCommands.prvCompareRecipe (METH) ¶ METHOD prvCompareRecipe : BOOL InOut: Scope Name Type Comment Return prvCompareRecipe BOOL Inout Const RecipeDefinitionName STRING Name of the recipe definition RecipeName STRING Name of the recipe
RDT_ERROR (ENUM) ¶ TYPE RDT_ERROR : Attributes: qualified_only InOut: Name Initial Comment ERR_RDT_NO_ERROR 0 ERR_RDT_RESPH_KO 1000 The first error enumeration is the reported by NBS ERR_RDT_RESPH_KO_CMD Result phase not correct, command not correct ERR_RDT_BUFFER_SIZE Buffer not big enought ERR_RDT_RESCM_KO Command phase not correct ERR_RDT_RESCM_KO_TYPE Command phase not correct, protocol type ERR_RDT_NO_DATA No data in the queue ERR_RDT_TIME_OUT_TRS Transmission timeout ERR_RDT_TIME_OUT_REC Receiving timeout ERR_RDT_STATEM_ERR State machine general error ERR_RDT_WRONG_PARAMETER Wrong parameter
RecipeManCommands.ReadAndSaveAs (METH) ¶ METHOD ReadAndSaveAs : DWORD Reads the current PLC values and stores the values in a recipe file without changing any existing recipe The content of an existing file will be overridden. InOut: Scope Name Type Comment Return ReadAndSaveAs DWORD Possible last error values: ERR_RECIPE_DEFINITION_NOT_FOUND ERR_RECIPE_SAVE_ERR ERR_NO_RECIPE_MANAGER_SET ERR_OK See ReturnValues (GVL) for a description of all possible errors. Inout Const RecipeDefinitionName STRING Name of the recipe definition. FileName STRING(255) Name of the file
RecipeManCommands.ReadAndSaveRecipe (METH) ¶ METHOD ReadAndSaveRecipe : DWORD Reads the current PLC values into the recipe and afterwards stores the recipe into the standard recipe file The content of an existing file will be overridden. InOut: Scope Name Type Comment Return ReadAndSaveRecipe DWORD Possible last error values: ERR_RECIPE_DEFINITION_NOT_FOUND ERR_RECIPE_NOT_FOUND ERR_RECIPE_SAVE_ERR ERR_NO_RECIPE_MANAGER_SET ERR_OK See ReturnValues (GVL) for a description of all possible errors. Inout Const RecipeDefinitionName STRING Name of the recipe definition RecipeName STRING Name of the recipe
RDT_Server (FB) ¶ FUNCTION_BLOCK RDT_Server EXTENDS RDT_Base IMPLEMENTS IRdtProtServer Server FB that encapsulates NBS.TCP activities in Redundancy Data Transfer Sets up a server over the ip and port specified in “ipAddress” and “uiPort” in “Initialize” method. A server can handle several connections. The output “itfServer” of this function block can be used to establish a connection via |TCP_Connection| . Properties: Active Busy Enable Error ErrorCode IPAddress , inherited from RDT_Base Port , inherited from RDT_Base RcvTimeout , inherited from RDT_Base TrsTimeout , inherited from RDT_Base Methods: FB_exit RcvCommand RcvData TrsAnswer Create CyclicCall FlushRec , inherited from RDT_Base ReceiveBytes , inherited from RDT_Base RegisterCommand SendBytes , inherited from RDT_Base SetNewCertificate SetTLSContext , inherited from RDT_Base Structure: FB_exit (Method) IRdtProServer Active (Property) Busy (Property) Create (Method) CyclicCall (Method) Enable (Property) Error (Property) ErrorCode (Property) RegisterCommand (Method) SetNewCertificate (Method) RcvCommand (Method) RcvData (Method) TrsAnswer (Method)
RecipeManCommands.ReadAndSaveRecipeAs (METH) ¶ METHOD ReadAndSaveRecipeAs : DWORD Reads the current PLC values into the recipe and afterwards stores the recipe into the specified recipe file The content of an existing file will be overridden. Attention: The behaviour from this method has changed in the following way. If both parameters “RecipeDefinitionName” and “RecipeName” are set ( stringlength > 0) the behaviour is not changed. In this case a read to a specific recipe does also an automatically save to the recipe when the option “Save recipes changes to recipe files automatically” is set in the RecipeManager configuration “General”. If the RecipeName is not set ( stringlength = 0) the behaviour has changed. In this case an automatically save to the recipe is not executed and the new recipe values are only stored into the given file name. InOut: Scope Name Type Comment Return ReadAndSaveRecipeAs DWORD Possible last error values: ERR_RECIPE_DEFINITION_NOT_FOUND ERR_RECIPE_NOT_FOUND ERR_RECIPE_SAVE_ERR ERR_NO_RECIPE_MANAGER_SET ERR_OK See ReturnValues (GVL) for a description of all possible errors. Inout Const RecipeDefinitionName STRING Name of the recipe definition. RecipeName STRING Name of the recipe. FileName STRING(255) Name of the file
RDT_Server.FB_exit (METH) ¶ METHOD FB_exit : BOOL FB_Exit must be implemented explicitly. If there is an implementation, then the method is called before the controller removes the code of the function block instance (implicit call). The return value is not evaluated. InOut: Scope Name Type Comment Return FB_Exit BOOL Input bInCopyCode BOOL TRUE: the exit method is called in order to leave the instance which will be copied afterwards (online change).
RecipeManCommands.ReadRecipe (METH) ¶ METHOD ReadRecipe : DWORD Reads the current PLC values into the recipe InOut: Scope Name Type Comment Return ReadRecipe DWORD Possible last error values: ERR_RECIPE_DEFINITION_NOT_FOUND ERR_RECIPE_NOT_FOUND ERR_NO_RECIPE_MANAGER_SET ERR_OK DataServer Errors from 16#2000 to 16#20FF, DataSourceDriver Errors from 16#2100 to 16#21FF DataServer and DataSourceDriver errors can occur if a DataServer and DataSource is configured beneth your current application (CODESYS HMI) and the command is called from the visualization. See ReturnValues (GVL) for a description of all possible errors. Inout Const RecipeDefinitionName STRING Name of the recipe definition RecipeName STRING Name of the recipe
RecipeManCommands.RegisterDatasourceRecipeDefinition (METH) ¶ METHOD RegisterDatasourceRecipeDefinition : DWORD Helper method that can be used to preregister variable lists for a recipe definition within devices connected via datasources. The intention of this function is to speedup reading/writing of recipes at the cost of an initial registration process after each connection setup of the affected datasources. If a recipe is read or written several times then this initial effort is necessary only once and each read or write operation is executed faster. Important This functionality does not automatically update the created variable list in case of online changes (eg. affecting the recipe definition). Therefore if online changes modify a recipe definition or locations of variables within a recipe definition, the according list has to be setup again! This can be done by searching and deleting it using the methodes of |IDatasources.IDatasourcesMgr2| Important This function might block until it is possible to access the datasources. Note If there is no performance flaw when reading/writing recipe definitions over datasources then it’s not necessary to call this method. Note The error code |CmpErrors.Errors.ERR_NOT_SUPPORTED| signals that one of the affected datasources does not support this feature and so it cannot be used at all. The error code |IDatasources.Errors.ERR_DS_READONLY_ITEM| signals that at least one of the variables of the recipe definition is reaonly and therefore the feature of preregistering according variable lists is not supported. InOut: Scope Name Type Comment Return RegisterDatasourceRecipeDefinition DWORD An error code representing the result of this operation. See ReturnValues (GVL) for a description of all possible errors. Inout Const RecipeDefinitionName STRING Name of the recipe definition. Input datasourcesMgr IDatasources.IDatasourcesMgr The global instance of the datasources manager. Typically pass g_Datasources