Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 18 Current »

Feature Description

Recipes are a way to save preset parameters for tag values and can be changed to presets during runtime. Users can create new Recipes with a similar or completely different present. Recipes allow for the ease of managing multiple tags that will be required to be changed all at once, which can make setting up multiple tag values to be changed at once a lot easier. Sending a recipe will have the recipe parameters saved to each tag specified. Receiving a recipe will save the current tag value in the recipe and can allow for those same values to be called back during runtime.

Designer Functionalities

Recipe Editor

The Recipe Editor is where users can add new recipes. Users can create new Recipes, edit those recipes, and also delete them. Users can also import and export CSV files to bring an already-created recipe into the project. Users can also edit the parameter bindings and add and delete records within the recipe. Users can also edit the parameters for each record within a recipe and change the value within the record itself.

Add / Edit Recipe Database

Clicking the + icon on the Recipe Editor will open a popup window to create a new Recipe Database. Here, the user can set the recipe's name and what tag the Record ID will be tagged to. Having this will allow the user to navigate the recipe index easily. The user has the option to enable Handshake as well. Handshake is used to verify the communication status while recipe data is being transferred. This option is off by default. If it is active, using any of the tags is not recommended because it is still communicating the new data.

This menu will also open if the user clicks the Edit Recipe button. Users are allowed to edit the Recipe Database's name, change the Record ID's Tag, and enable or disable Handshake as well. These changes will automatically be saved and applied immediately when the change is confirmed.

Back to Top of Recipes

Parameter Bindings

The Parameter Bindings are what tie a parameter to a specific Tag. This is how the user will specify what tags will be changed when a recipe is received. Users can set the Tag for each parameter, create a new parameter, delete one, or move one up or down the list of current parameters.

Back to Top of Recipes

Runtime Functionalities

Recipe Recieve and Send

Recipes can receive and send data to tags with commands. Recipes have action commands that allow users to interact with the recipe list during runtime. Sending a Recipe will set the tag values to whatever is saved within the recipe. Receiving a Recipe will keep the current tag values within the recipe, which can be called upon later within the runtime.

Back to Top of Recipes

Recipe CSV Exportation and Importation

The user can export and import recipe data to and from a CSV for record keeping. The user can transfer data to a separate device via USB, SD card, File Transfer Protocol (FTP), or local memory* on Linux Xpanel.

A CSV file can be created in two ways: a command set to Export Recipe CSV or a script that calls the following function: exportCsv(string recipe, Storage type, string path). The user can specify the storage location recipe and path to the CSV.

A CSV file can be imported in two ways: creating a command set to Import Recipe CSV or creating a script that calls the following function: importCsv(string recipe, Storage type, string path). The user can specify the storage location, a recipe, and a path to the CSV.

An example of what the CSV file would look like after generation is shown on the far right:

Disclaimer: CIMON recommends exclusively using a USB or SD card for storage types. Saved CSV files to local memory are only accessible through an SSH connection.

Back to Top of Recipes
  • No labels