User Tools

Site Tools


Recipes

The recipe allows you to initialize a set of values ​​to a certain group of registers. There are several options for using recipes:

  • placing a list of recipes on a dashboard in the form of a drop-down or full list. After choosing a recipe, there are two options - immediately apply it, or use a script that will track the selection of a new recipe and perform some additional actions.
  • activation of the recipe inside the script, which can be initiated, for example, by the scheduler (you can apply several recipes at the same time, implementing script management, for example control of lighting zones, etc.).

Recipes are created in the Configuration/Recipes menu.

Configuration/Recipes menu

Recipes can have sub-categories, i.e. the list of recipes on a dashboard can be displayed completely, or only from a certain category.

category

And also be available to specific users.

users

When placing a list of recipes on a dashboard, you must specify:

  • Category of recipes, or a complete list of all categories
  • Drop-down or multiline list
  • Number of the register where the recipe number will change. (changing this register can be monitored in scripts when you need to perform some actions associated with this recipe)
  • Whether to apply the recipe immediately or not (in the second case, only the register number will change where the current recipe number is stored)

dashboard

To apply recipes within scripts, the ApplyRecipe (recipeId, userId) function is used. See here. After it is executed, if a list is displayed on one of the dashboards, the contents of the recipe from the ApplyRecipe function, you must also write the recipe number in the register tied to the list - to synchronize the display of the list.


Page Tools