recipes
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
recipes [2020/06/01 12:40] – emozolyak | recipes [2022/01/15 15:41] (current) – ↷ Links adapted because of a move operation 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | {{ network: | ||
======Recipes====== | ======Recipes====== | ||
- | The recipe allows you to initialize a set of values to a certain group of registers. There are several options for using recipes: | + | The recipe allows you to initialize a set of registers |
* Recipes can be applied either by selecting an entry in the recipe drop-down list or by calling a script | * Recipes can be applied either by selecting an entry in the recipe drop-down list or by calling a script | ||
- | * Recipes can be edited right on the dashboard with a quick edit method (not going back to the Recipe list) | + | * Recipes can be edited right on the dashboard with a quick edit method (not going back to the main recipe menu) |
* Recipes can be visible or not for different users. Some recipes can be ' | * Recipes can be visible or not for different users. Some recipes can be ' | ||
- | * Recipe list can be used as a handy tool for analysing user choice from different options. The selected id is returned to the lua script which then can process the selecion. | + | * Recipe list can be used as a handy tool for analysing user choice from different options. In this case recipe names in the list or category serve as a placeholders for the selection listbox. The selected id is returned to the lua script which then can process the selection. |
- | The recipe management menu resided in a ' | + | ===== Recipes page===== |
- | {{ :: | + | |
+ | The recipe management menu resides in a ' | ||
- | * 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. | + | {{ network: |
- | * 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 | + | The main spots of the recipe management page are: |
+ | - Import/ | ||
+ | - Add recipe button | ||
+ | - Recipe category. use them to divide the list, then the dropdown lists on dashboard can show only specific category you set for them | ||
+ | - ' | ||
+ | - Checkbox for selecting export candidates | ||
+ | - Common (non-locked) recipe list. | ||
+ | - Edit/ | ||
- | {{ :recipes1.png?direct |Configuration/ | + | {{ network:recipe_list_inum.png?direct& |
- | Recipes can have sub-categories, | + | ===== Recipe setup===== |
- | {{ :recipes2.png?direct |category}} | + | The //Basic// tab: |
+ | ***Title** - this title will be seen in the selection lists and setup page | ||
+ | ***Description** - user comments for the recipe | ||
+ | ***Disable** checkbox - hides this recipe from the list | ||
+ | ***Lock** - prevent the recipe from editing by non-admin users | ||
+ | ***Registers 1..4 / Value / Description** - this set of the registers will be initialized with the respective values upon invoking recipe. The description given here will be used to show the comments in the quick edit window (right on the dashboard) | ||
+ | ***Delete** button deletes the register //n// from the list | ||
+ | ***Add register to recipe** button expands the list with a new entry | ||
- | And also be available to specific users. | + | {{ network: |
- | {{ :recipes3.png?direct |users}} | + | The // |
+ | {{ network:recipe_permissions.png?direct& | ||
- | When placing a list of recipes | + | ===== Using recipe |
- | * Category of recipes, or a complete list of all categories | + | When placing a recipes |
- | * 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) | + | |
- | {{ :recipe4.png?direct |dashboard}} | + | * // |
+ | * The // | ||
+ | * '// | ||
+ | * '// | ||
- | To apply recipes within scripts, the **ApplyRecipe (recipeId, userId)** function is used. [[working_with_recipes|See here]]. | + | |
+ | {{ network: | ||
+ | |||
+ | If the user has right to edit the recipe, he can do this right in the selectoin box: | ||
+ | |||
+ | {{ network: | ||
+ | |||
+ | ===== Using recipes in scripts ===== | ||
+ | |||
+ | To apply recipes within scripts, the **ApplyRecipe (recipeId, userId)** function is used. [[working_with_recipes|See here]]. | ||
+ | |||
+ | <code lua> | ||
+ | function | ||
+ | local id = GetReg(" | ||
+ | ApplyRecipe(id, userId) | ||
+ | AddInfoMessage(" | ||
+ | end | ||
+ | </ | ||
+ | |||
+ | {{ network: |
recipes.txt · Last modified: 2022/01/15 15:41 by 127.0.0.1