get_access_to_registers
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revisionNext revisionBoth sides next revision | ||
| get_access_to_registers [2019/01/09 10:26] – created akuzmuk | get_access_to_registers [2019/01/09 10:27] – akuzmuk | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== Functions to get access to registers ====== | ||
| ==== GetReg(variable_name[, | ==== GetReg(variable_name[, | ||
| Line 30: | 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 41: | Line 42: | ||
| * alert | * alert | ||
| - | ---- | ||
| ==== GetRegFromLog(variable_name, | ==== GetRegFromLog(variable_name, | ||
| Line 98: | 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 106: | 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 114: | 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, | ==== 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 **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. | ||
get_access_to_registers.txt · Last modified: 2024/03/15 16:01 by atolstov