get_access_to_registers
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
get_access_to_registers [2019/01/09 10:27] – akuzmuk | get_access_to_registers [2019/01/09 10:43] – akuzmuk | ||
---|---|---|---|
Line 31: | Line 31: | ||
{{ : | {{ : | ||
- | ---- | + | |
==== GetRegStatus(variable_name) ==== | ==== GetRegStatus(variable_name) ==== | ||
The GetRegStatus function returns the status of specified register. Function works exactly like function **GetReg**. | The GetRegStatus function returns the status of specified register. Function works exactly like function **GetReg**. | ||
Line 42: | Line 42: | ||
* alert | * alert | ||
- | ---- | ||
==== GetRegFromLog(variable_name, | ==== GetRegFromLog(variable_name, | ||
Line 99: | Line 98: | ||
</ | </ | ||
- | ---- | + | |
==== SetReg(variable_name[, | ==== SetReg(variable_name[, | ||
The SetReg function sets the current value of the register with the name of the variable **variable_name** to **new_value** for the current scan. This function **DOES NOT** send new value to external devices. When polling this register in subsequent cycles, the old value will be read. | The SetReg function sets the current value of the register with the name of the variable **variable_name** to **new_value** for the current scan. This function **DOES NOT** send new value to external devices. When polling this register in subsequent cycles, the old value will be read. | ||
Line 107: | Line 106: | ||
The parameters **variable_name** and **connection_name** work just like in the GetReg function. Since version 3.2 there is no more **connection_name** parameter. | The parameters **variable_name** and **connection_name** work just like in the GetReg function. Since version 3.2 there is no more **connection_name** parameter. | ||
- | ---- | + | |
==== WriteReg(variable_name[, | ==== WriteReg(variable_name[, | ||
The WriteReg function sets the current value of the register with the name of the variable **variable_name** (optionally you can specify the connection **connection_name**) to provided **new_value** for the current scan and writes this value to the external device in the beginning of the next cycle. When polling this register in subsequent scans, a new value will be read (if it was not changed by the device itself). | The WriteReg function sets the current value of the register with the name of the variable **variable_name** (optionally you can specify the connection **connection_name**) to provided **new_value** for the current scan and writes this value to the external device in the beginning of the next cycle. When polling this register in subsequent scans, a new value will be read (if it was not changed by the device itself). | ||
Line 115: | Line 114: | ||
The parameters **variable_name** and **connection_name** work just like in the GetReg function. Since version 3.2 there is no more **connection_name** parameter. | The parameters **variable_name** and **connection_name** work just like in the GetReg function. Since version 3.2 there is no more **connection_name** parameter. | ||
- | ---- | ||
- | ==== ApplyRecipe(recipeId, | ||
- | The **ApplyRecipe** function applies the recipe with the number **recipeId** on behalf of the user with id = **userId**. If this user does not have permissions for this recipe, the recipe will not be applied. | ||
- | |||
- | The application of the recipe is to write the corresponding values to the registers that are specified in the recipe. | ||
- | |||
- | ==== GetRecipeById(recipeId) ==== | ||
- | The **GetRecipeById** function gets the recipe with the number **recipeId**. Function is available since WebHMI v 3.2. | ||
- | |||
- | On success table with following fields will be returned: | ||
- | * id - Recipe Id | ||
- | * title - Recipe title | ||
- | * registers - table with Register Id as key and new value as value | ||
- | |||
- | On error (recipe not found, etc) false will be returned. | ||
get_access_to_registers.txt · Last modified: 2024/03/15 16:01 by atolstov