The Logic module can be used to process incoming and outgoing data point values. The calculation and processing functions can be defined within this definition file.
...
| Col# | Parameter | Description | Scope | Unit | Mandatory / default value | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Name | The name of the data point. In combination with the Path, it must be uniqueItem suffix | The new item ID used for the virtual item that is created by the module consists of the item ID of the source item + the specified suffix. Original item ID and suffix are separated by a dot. E.g. if suffix is calculated and the source item is NETx\XIO\KNX\IP_Router\01/0/000, the ID of virtual item that is created by the module is NETx\XIO\KNX\IP_Router\01/0/000.calculated. | string | none | mandatory | |||||
| 2 | Path | The structure that is used to represent the data point. In combination with the Name, it must be unique | Base path or base item ID | Specifies the base path for searching within the item tree when multiple items shall be selected. | string | none | empty | ||||
| 3 | Selector | If multiple items shall be selected, the selector specifies the matching pattern for the items below the base path. The selector itself is a regular expression. E.g. if the base path is NETx\VAR\Numeric and the selector is the regular expression .*Item00.*, the items NETx\VAR\Numeric\Item001 toNETx\VAR\Numeric\Item009 are selected. | string | none | emptymandatory | ||||||
| 34 | Data type | The type of the data pointvirtual item that is created. | BOOL, STR, BYTE, CHAR, INT8, UINT8, INT16, UINT16, INT32, UINT32, INT64, UINT64, FLOAT, DOUBLE, DATE, TIME | none | STRR | ||||||
| 45 | Access mode | The access rights of the data point. virtual item that is created. Allowed values are R (read-only), W (write-only), RW (read and writable). | R, W, RW | none | R | ||||||
| 56 | Polling UrlDescription | The URL which is used to retrieve the data point value. The server polls by HTTP GET requests to this URL. If empty, polling is not availabledescription of the virtual item that is created. If left empty, the description of the source item is used. | string | none | empty | ||||||
| 6 | Polling interval | The polling interval in milliseconds. | 50 – 65535 | ms | 5000 | ||||||
| 7 | Polling Resource | The resource that is used for polling. It has to match the name that is used in the HTTP resource definition. | Reference to HTTP resource definition | none | empty | ||||||
| 8 | Polling Parameters | A comma-separated list of parameters that are used to replace the placeholders within the polling resource ({0}, {1}, ...). | string | ms | empty | ||||||
| 9 | Update Url | The URL which is used to update the data point values. The server issues HTTP PUT, POST or GET requests to this URL. If empty, updating of the values is not possible(source item description is used) | |||||||||
| 7 | Persistent | The persistent flag of the virtual item that is created. If left empty, the flag of the source item is used. | empty/true/false | none | empty (source item setting is used) | ||||||
| 8 | Synchronize | The synchronize flag of the virtual item that is created. If left empty, the flag of the source item is used. | empty/true/false | none | empty (source item setting is used) | ||||||
| 9 | In calculation function | The mathematical expression that is used to recalculate incoming data changes. it must contain the placeholder for the value (default value). An example of a valid expression is value * 10 + 5. | string | none | empty | ||||||
| 10 | Update Method | The web update request method. | POST, PUT, GET | none | POST | ||||||
| 11 | Update Resource | The resource that is used for updating. It has to match the name that is used in the HTTP resource definition. | Reference to HTTP resource definition | none | empty | ||||||
| 12 | Update Parameters | A comma-separated list of parameters that are used to replace the placeholders within the update resource ({0}, {1}, ...)Out calculation function | The mathematical expression that is used to recalculate outgoing data changes. it must contain the placeholder for the value (default value). An example of a valid expression is value * 10 + 5. | string | none | empty | |||||
| 1311Persistent | In processing type | If enabledincoming data shall be processed, the last known incoming data point value is restored after server start up.true/falsetype is specified here. | Nothing, JSON, XML | none | falseNothing | ||||||
| 1412Synchronize | In processing resource | If enabled, the value is synchronized with the backup server if used. | true/false | none | true | 15 | Authentication User | Username for Basic or Digest HTTP authentication if required by the HTTP server. If empty, no HTTP authentication is used.incoming data shall be processed, the parsing function must be defined here. For JSON, a JPATH expression is required here – for XML an XPATH expression. | string | none | empty |
| 16 | Authentication Password | Password for Basic or Digest HTTP authentication if required by the HTTP server. If empty, no HTTP authentication is used. | string | none | empty | ||||||
| 17 | Additional HTTP Headers | A list of additional HTTP headers which is included in each HTTP request, e.g. for authentication purposes. Additional headers must have the following form: "<key1>: <value1>\r\n<key2>: <value2>\r\n<key3>: <value3>..."13 | Out processing type | If outgoing data shall be processed, the outgoing data type is specified here. | Nothing, JSON, XML | none | Nothing | ||||
| 14 | Out processing resource | If outgoing data shall be processed, the text template must specified here. For JSON, a valid JSON object is required – for XML an XML object. The text template must contain the value tag (default @value@) which is replaced by the current value of the virtual item. | string | none | empty | 18 | Authentication Method | The authentication method (Basic or Digest) if required by the HTTP server. | Basic, Digest | none | |
| Basic15 | Linked item(s) | The virtual item(s) that are created by the module can directly be linked to other item(s). Depending on the access rights, this link is uni- or bidirectional. If multiple items are selected, the target item ID must contain regular expression groups for selected the correct target items. | string | none | empty |