OAS Logo

Variables

As a base, linking datapoints to the include, the px includes in this module using ORD variables.

To provide a flexible way of binding points to the includes a series of ORD variables, shown below, are used in all PxIncludes.

$(nSpace)$(base)$(plant)$(subPlant)$(plantPart)$(equipLoc)$(equip)$(point)

In the whole definition there is no | nor a /. Thats because if there would be an the user has to have use the predefined structure and would not be able to use his own. More on that later in the Examples section.

Until the last variable, called point in this example, all are used to define a structured way of defining the ord path to the needed point in the Niagara system. In table below the meaning of each and every variables is listed:

Variable type Description Example
$(nSpace) folder Defines the Controller where the point is located on. nspace:AHU|
$(base) folder Defines the ‘start’ Folder where all points are commonly located. slot:/Home/Prog/
$(plant) folder Defines the plant name where the points are located. HV01_/
$(subPlant) folder Defines the subplant name where the points are located. HK01_/
$(plantPart) folder Defines the part of the plant the points are located. SYS00/
$(equipLoc) folder Defines the location the equipment is located. VL_/
$(equip) folder Defines the equipment where the points are organized for. VT01/
$(cmd) point Defines the point representing the command point. FRG__SB__BI
$(signal) point Defines the point representing the signal point. HTS__Y__U
$(error) point Defines the point representing the error point. ANZ__SM__BI
$(operation) point Defines the point representing the operation point. ANZ__BM__BI
$(lockedStatus) point Defines the point representing the lockedStatus of the Aggregate. HTS__Y__U/ORT

Please Note that the structure of the variables are leaned on a very specific naming scheme. If you don’t want to use it you can simply use the variables marked as type point directly. But if one of the type folder variables is set the directly used variables like cmd, signal, etc do not work anymore. See the examples. Also sometimes the variables are pre- or suffixed with Top, Bottom, left or right to show which aggregate is meant, if more than one same aggregate is on the include.

Examples

According to the table above the ord to a inlet valve of a heat circuit would be defined like this:

Variable Value
$(nSpace) nspace:AHU:|
$(base) slot:/Home/Prog/
$(plant) HV01_/
$(subPlant) HK01_/
$(plantPart) SYS00/
$(equipLoc) VL_/
$(equip) VT01/
$(signal) HTS__Y__U

This translates to:

nspace:AHU:|slot:/Home/Prog/HV01_/HK01_/SYS00/VL_/VT01/HTS__Y___U_

If your station is not structured in that way we can also us the signal variable directly without defining the others:

Variable Value
$(nSpace)
$(base)
$(plant)
$(subPlant)
$(plantPart)
$(equipLoc)
$(equip)
$(signal) nspace:AHU:&#124slot:/Home/Prog/HV01_/HK01_/SYS00/VL_/VT01/HTS__Y__U

This translates also to:

nspace:AHU:|slot:/Home/Prog/HV01_/HK01_/SYS00/VL_/VT01/HTS__Y___U_

That way we are able to directly declare multiple points for the Include without splitting the ord across the variables.

Variable Value
$(nSpace)
$(base)
$(plant)
$(subPlant)
$(plantPart)
$(equipLoc)
$(equip)
$(signal) nspace:AHU:&#124slot:/Home/Prog/HV01_/HK01_/SYS00/VL_/VT01/HTS__Y__U
$(operation) nspace:AHU:&#124slot:/Home/Prog/HV01_/HK01_/SYS00/VL_/UP01/ANZ__BM__BI

This translates to:

nspace:AHU:|slot:/Home/Prog/HV01_/HK01_/SYS00/VL_/VT01/HTS__Y___U_

and:

nspace:AHU:|slot:/Home/Prog/HV01_/HK01_/SYS00/VL_/UP01/ANZ__BM__BI

Now that the points are defined we could split them e.g:

Variable Value
$(nSpace) nspace:AHU:&#124
$(base)
$(plant)
$(subPlant)
$(plantPart)
$(equipLoc)
$(equip)
$(signal) slot:/Home/Prog/HV01_/HK01_/SYS00/VL_/VT01/HTS__Y__U
$(operation) slot:/Home/Prog/HV01_/HK01_/SYS00/VL_/UP01/ANZ__BM__BI

This translates also to:

nspace:AHU:|slot:/Home/Prog/HV01_/HK01_/SYS00/VL_/VT01/HTS__Y___U_

and:

nspace:AHU:|slot:/Home/Prog/HV01_/HK01_/SYS00/VL_/UP01/ANZ__BM__BI

However if the $(equip) variable would be set the direct declaration would not work anymore:

Variable Value
$(nSpace) nspace:AHU:&#124
$(base)
$(plant)
$(subPlant)
$(plantPart)
$(equipLoc)
$(equip) VT01/
$(signal) slot:/Home/Prog/HV01_/HK01_/SYS00/VL_/VT01/HTS__Y__U
$(operation) slot:/Home/Prog/HV01_/HK01_/SYS00/VL_/UP01/ANZ__BM__BI

This translates to:

nspace:AHU:|VT01/slot:/Home/Prog/HV01_/HK01_/SYS00/VL_/VT01/HTS__Y___U_

and:

nspace:AHU:|VT01/slot:/Home/Prog/HV01_/HK01_/SYS00/VL_/UP01/ANZ__BM__BI

The produced Ord path do not fit the defined scheme and is therefore invalid.