Versions Compared

Version Old Version 13 New Version 14
Changes made by

Richard Mendoza (Unlicensed)

Richard Mendoza (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Feature Description

Recipes are a way to have preset parameters saved for tag values and are able to be changed to those presets during runtime. Users can create new Recipes with a similar or completely different present. Recipes allow for the ease of management of multiple tags that will be required to be changed all at once, which can make the process of 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.

Table of Contents
maxLevel4
minLevel1
include
outlinefalse
indent
excludeFeature Description
typelist
printabletrue
class

Designer Functionalities

Recipe Editor

The Recipe Editor is where users can add new recipes. Users are able to create new Recipes, edit those recipes, and also delete them. Users can also import CSV and Export CSV files as well to bring in an already created Recipe into the project. Users can also edit the parameter bindings and also add and delete records within the Recipe as well. Within a recipe, users can also edit the parameters for each Record, 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 name of the Recipe, and also what tag the Record ID will be tagged to. Having this will allow the user to easily navigate the index of the Recipe. 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, it is not recommended to use any of the tags because it is still communicating the new data.

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

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 will be able to set the Tag for each parameter, create a new parameter, delete one, or move one up or down the list of current parameters.

Runtime Functionalities

Recipe Recieve and Send

Recipes are able to receive and send data to tags with commands. Recipes have Action Commands that will allow the user to interact with the Recipe list during runtime. Sending a Recipe will set the tag values to whatever is saved within the Recipe itself. Receiving a Recipe will save the current tag values within the Recipe, which can be called upon later within the runtime.

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, or File Transfer Protocol (FTP), or to local memory* on Linux Xpanel.

A CSV file can be created in two ways: creating a command set to Export Recipe CSV or creating 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:

Info

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.