Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 DescriptionScopeUnitMandatory / default value
1Item suffixThe 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.stringnonemandatory
2Base path or base item ID

Specifies the source Item ID or the base path for searching within the item tree when multiple items shall be selected.

stringnonemandatoryempty
3SelectorIf 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.stringnoneemptymandatory
4Data typeThe type of the virtual item that is created. BOOL, STR, BYTE, CHAR, INT8, UINT8, INT16, UINT16, INT32, UINT32, INT64, UINT64, FLOAT, DOUBLE, DATE, TIMEnoneR
5Access modeThe access rights of the virtual item that is created.  Allowed values are R (read-only), W (write-only), RW (read and writable).R, W, RWnoneR
6DescriptionThe description of the virtual item that is created. If left empty, the description of the source item is used.stringnoneempty (source item description is used)
7PersistentThe persistent flag of the virtual item that is created. If left empty, the flag of the source item is used.empty/true/falsenoneempty (source item setting is used)
8SynchronizeThe synchronize flag of the virtual item that is created. If left empty, the flag of the source item is used.empty/true/falsenoneempty (source item setting is used)
9In calculation functionThe 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".stringnoneempty
10Out calculation functionThe 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".stringnoneempty
11In processing typeIf incoming data shall be processed, the incoming data type is specified here. Nothing, JSON, XMLnoneemptyNothing
12In processing resourceIf 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. stringnoneempty
13Out processing typetrue/falseIf outgoing data shall be processed, the outgoing data type is specified here. Nothing, JSON, XMLnonefalseNothing
14Out processing resourcetrue/falseIf 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.stringnonetrueempty
15Linked 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.

stringnoneempty