Item tree

Owned by dominik.kurfner (Unlicensed)
Last updated: Jan 31, 2022 by Reinhard Mayr (Unlicensed)
4 min read

The basic principle of the NETx BMS Core Server is to get the data and information (i.e. datapoints) from the fieldbus and to store within the server as so called server items. Thus, a server item represents a single datapoint within the field level of the building automation system. Each server item consists of several properties that represent the datapoint within the building automation systems.
These server items are hierarchically arranged in a tree-like view called server item tree. This server item tree consists of the server items (leaves of the tree) as well as so called branches (nodes between the leaves and root of the tree) that are used to organize the tree. The server item tree can be seen as the network-visible representation of the server's information model that can be accessed by the management clients. An example of such a server item tree within the NETx BMS Core Studio.

The basic structure of this server item tree is unique within the NETx BMS Core Server. Server items and branches are addressed by clients using their item ID that is unique within the server item tree. This item ID refers to the browsing path that the item or branch has within the server item tree i.e. it is the concatenation of all item and branch names from the item or branch to the root node of the tree including the deliminators between the names The deliminator can be configured within the server. For the rest of this documentation the default deliminator "\" is used. The server item tree starts with the root node that has always the name:

Folder nameDescription
NETx\Root folder
NETx\XIO\Datapoints from the field level that are controlled by server
NETx\XIO\KNX\

Here, the different KNX devices, router, and group addresses can be found. The following items are located within this sub-tree:

  • .\<Router>\: KNXnet/IP routers and interfaces
  • .\<Router>\GATEWAY: KNXnet/IP router and interface monitoring item
  • .\<Router>\<GroupAddress>\: KNX group addresses
  • .\<Router>\Devices\<IndividualAddress>\: KNX devices
NETx\XIO\Modbus\

Here, the different Modbus devices and datapoints can be found . The following items are located within this sub-tree:

  • .\<DeviceName>\: Modbus devices
  • .\<DeviceName>\GATEWAY\: Modbus devices monitoring item
  • .\<DeviceName>\Discrete Inputs\<Address>\: Modbus discrete inputs
  • .\<DeviceName>\Coils\<Address>\: Modbus coils
  • .\<DeviceName>\Input Registers\<Address>\: Modbus input registers
  • .\<DeviceName>\Holding Registers\<Address>\: Modbus holding registers
NETx\XIO\BACnet\

Here, the different BACnet devices and objects can be found. The following items are located within this sub-tree:

  • .\<DeviceName>\: BACnet/IP devices
  • .\<RouterName>\: BACnet/IP routers
  • .\<RouterName>\<DeviceName>\: BACnet non-IP devices
  • .\...\GATEWAY\: BACnet devices monitoring item
  • .\<RouterName>\<DeviceName>\<ObjectName>\: BACnet objects

For read-only objects:

  • .\<RouterName>\<DeviceName>\<ObjectName>\<DatapointValue>\

For writable objects:

  • Reading:...\BACnet\<RouterName>\<DeviceName>\<ObjectName>\<DatapointValue>\
  • Writing:...\BACnet\<RouterName>\<DeviceName>\<ObjectName>\<DatapointValue>-PRIO <nr1>\
  • Resetting:...\BACnet\<RouterName>\<DeviceName>\<ObjectName>\<DatapointValue>-PRIO <nr1> RESET\
  • Writing:...\BACnet\<RouterName>\<DeviceName>\<ObjectName>\<DatapointValue>-PRIO <nr2>\
  • Resetting:...\BACnet\<RouterName>\<DeviceName>\<ObjectName>\<DatapointValue>-PRIO <nr2> RESET\
NETx\XIO\JSON\

Here, the different JSON devices and datapoints can be found. The following items are located within this sub-tree:

  • JSON gateways: NETx\XIO\JSON\<GatewayName>\
  • JSON gateway monitoring item: NETx\XIO\JSON\<GatewayName>\GATEWAY\
  • ABB EQ Meter: NETx\XIO\JSON\<GatewayName>\<Serial>\

  • ABB EQ Meter monitoring item: NETx\XIO\JSON\<GatewayName>\<Serial>\GATEWAY\ - ABB EQ Meter energy values:


NETx\XIO\JSON\<GatewayName>\<Serial>\apparent\
NETx\XIO\JSON\<GatewayName>\<Serial>\apparent\importenergy\
NETx\XIO\JSON\<GatewayName>\<Serial>\apparent\importenergy\total\
NETx\XIO\JSON\<GatewayName>\<Serial>\apparent\importenergy\l\[1-3\]\
NETx\XIO\JSON\<GatewayName>\<Serial>\apparent\importenergy\t\[1-4\]\
NETx\XIO\JSON\<GatewayName>\<Serial>\apparent\exportenergy\
. . .
NETx\XIO\JSON\<GatewayName>\<Serial>\apparent\netenergy\
. . .
NETx\XIO\JSON\<GatewayName>\<Serial>\reactive\
. . .
NETx\XIO\JSON\<GatewayName>\<Serial>\active\
. . .
NETx\Cluster\Items of the Cluster module (e.g. items from foreign OPC DA Servers, items from other NETx BMS Core Servers)
NETx\Cluster\VNET\

Here, the different Server Items of integrated, remote NETx BMS Core Servers can be found . For each NETx BMS Core Server, the sub-tree NETx\Cluster\VNET\<IPAddress>\<ServerName>\ is created. The following items are located within this sub-tree:

  • .\<IPAddress>\<ServerName>\Connected\: This item indicates whether the connection to the NETx BMS Core Server is working.
  • .\<IPAddress>\<ServerName>\<ItemName>: In addition, all Server Items integrated from the remote NETx BMS Core Server are listed.
NETx\Cluster\OPC_DA\

Here, the different OPC Items of foreign OPC DA Servers can be found. For each OPC DA Server, the sub-tree NETx\cluster\OPC_DA\<IPAddress>\<ServerName>\ is created. The following items are located within this sub-tree:

  • .\<IPAddress>\<ServerName>\Connected: This item indicates whether the connection to the OPC DA Server is working.
  • .\<IPAddress>\<ServerName>\<ItemName>: In addition, all OPC items integrated from the foreign OPC DA Server are listed.
NETx\Module\

Items of NETx BMS Core Server modules. Currently, the following modules are available:

NETx\API\Items of additional driver modules (e.g. items from the Fidelio module)
NETx\Server\

General information about the NETx server (e.g. status of server, number of connected clients, . . . ).

  • NETx\Server\WorkspaceName: Name of the current workspace.
NETx\Server\License\License information, used data points and client connections.
NETx\Server\Database\Database status information. The database size (in MB) is updated every 10 minutes.
NETx\Server\WebManager\Web Manager status information.
NETx\Server\WebServer\

Webserver status information:

  • Status: 0=active; 1=not available; 2=inactive
NETx\Today\Time and date as well as weather information.
NETx\Geo\Geographic information like sunset time and moon age.
NETx\Custom\

Using LUA scripts, it is possible to create so called custom items that can be seen as virtual items that are only available within the server. It is also possible to define them within a user-specific hierarchy. These custom items are located within this sub-tree.

NETx\Aliases\Aliases for existing server items.
NETx\VAR\Pre-definied virtual datapoints that can freely be used.
NETx\XCOMMAND\Definition of the so called XCOMMANDs that are used by the server-based event modules (for future use).
NETx\VIRTUAL\Items as defined in the Virtual item definitions.
NETx\XCON\ Items that can be used for communication with other systems or network services are located (e.g. items for UDP, TCP, HTTP, COM port, e mail communication).