type

PhEntity

PhEntity : Entity

Project Haystack entity. This is base class for all entities in the Haystack ontology. It defines every tag as a global slot to ensure consistent usage of terminology.

meta abstract slots id

Unique identifier for entity in its project

spec

Type of this entity

globals absorption

Cooling process using energy from heat source such as hot water

ac

Relating to alternating current (AC) electricity

active

Working, operative, effective

actuator

Equipment to move or control a mechanism

ahu

Air Handling Unit

air

The mixture of gases which surrounds the earth

airCooling

Cooling by dissipating heat into the surrounding air

airRef

Air flows from the referent to this entity

alarm

Notification of a condition which requires attention

angle

Measurement of the relative difference in direction between two vectors or phasors

apparent

Perceived quantity

area

Area of a shape or floor space

ates

Aquifer Thermal Energy Storage system

atesClosedLoop

The ATES uses closed piping to transport a water/glycol mixture through the ground

atesDoublet

The ATES has one or more pairs of a separate warm and cool well

atesDoubletPaired

The ATES is as a doublet, but with specific warm and cool wells linked together

atesMono

The ATES has only one physical well

atesUnidirectional

Similar to a doublet, but water always flows in the same direction from the extraction to the infiltration well

attr

Attribute is a single datum of static information on an entity

atmospheric

Related to the atmosphere of the earth

avg

Average

bacnet

ASHRAE building automation and control protocol

barometric

Relating atmospheric pressure

baseUri

Base URI for normalizing relative URIs

battery

Equipment used to store electric energy

biomass

Plant or animal material used as fuel to produce electricity or heat

biomassHeating

Heating by the combustion of biomass

blowdown

Removal from container or pipe

blowdownWaterRef

Blowdown water flows from the referent to this entity

bluetooth

Short range wireless communication protocol

boiler

Equipment to generate hot water or steam for heating

branchSelector

Branch selector used for heat recovery in a VRF system

bypass

Pipe used to bypass an equipment

cable

An assembly of one or more insulated conductors

cav

Constant air volume terminal unit

centrifugal

Compression via a continuous flow of fluid through an impeller

ch2o

Formaldehyde (CH₂O)

ch4

Methane (CH₄)

chilled

Substance is cooled using cooling process

chilledBeam

Conditions a space using a heat exchanger integrated into the ceiling

chilledBeamZone

AHU supplies air to chilled beam terminal units

chilledWaterCooling

Cooling using transfer of heat to chilled water

chilledWaterRef

Chilled water flows from the referent to this entity

chiller

Equipment to remove heat from a liquid

circ

Pipe used to circulate fluid through an equipment or system

circuit

Electrical circuit and its associated components such as breakers

cloudage

Percentage of sky obscured by clouds

cmd

Point is a command, actuator, AO/BO

co

Carbon monoxide (CO)

co2

Carbon dioxide (CO₂)

co2e

Carbon dioxide equivalent

coal

Combustible sedimentary rock

coalHeating

Heating by the combustion of coal

coap

Constrained Application Protocol

cold

Having low degree of heat

coldDeck

Duct carries air for cooling

compressor

Device for mechanically increasing the pressure of a gas or refrigerant vapor by reducing its volume

computed

Computed point

computedFromReciprocal

Indicates a relationship that is computed from its reciprocal

computedModel

See Synthetics chapter

computer

General purpose computer

concentration

Abundance of substance in the total volume of a mixture

condensate

Liquid phase produced by the condensation of steam or other gas

condensateRef

Condensate flows from the referent to this entity

condenser

Device or related to process of condensation

condenserClosedLoop

Working fluid is kept separate from fluid used for heat transfer into the atmosphere

condenserCooling

Removal of heat through the process of water condensation

condenserOpenLoop

Uses working fluid itself for evaporation into the atmosphere

condenserWaterRef

Condenser water flows from the referent to this entity

conditioning

Related to cleaning, heating, cooling, humidifying, dehumidifying, ventilating or circulating  air. 

constantAirVolume

Delivers a constant volume of air flow

controller

Microprocessor based device used in a control system

controls

Associated with the control system for an industrial process

cool

Associted with low temperature or cooling processes

cooling

Cooling mode or process

coolingCapacity

Measurement of a chiller ability to remove heat measured

coolingCoil

Coil used to cool air

coolingOnly

Equipment without heating

coolingTower

Equipment to transfer waste heat into the atmosphere

coupler

Device that joins two components together

crac

Computer Room Air Conditioner

cur

Supports current value

curErr

Error description when curStatus indicates error condition

curStatus

Status of point's current value reading

curVal

Current value of a point

current

Movement of fluid or electricity

dali

Digital Addressable Lighting Interface protocol for lighting

damper

Damper equipment or control point

dataCenter

Space used to house computer and networking gear

daytime

Time between sunrise and sunset

dc

Relating to direct current (DC) electricity

deadband

The range in a process where no changes to output are made

delta

Differential of fluid between entering and leaving sensors

demand

Rate required for a process

deprecated

Obsoleted

design

Data related to intended design and operating conditions

dessicantDehumidifier

Decreases humidity from air using a substance which absorbs moisture

device

Microprocessor based hardware device

deviceRef

Device which controls a monitors this entity

dewPoint

Dew point temperature at which water vapor will form dew

diesel

Liquid fuel specifically designed for use in diesel engines

directZone

AHU supplies air directly to the zone

direction

Compass direction measured in degrees

dis

Display name for an entity

discharge

Duct for air leaving an equipment

dispenser

Equipment that releases a specific amount of a substance

diverting

Three way valve which inputs one pipe and diverts between two output pipes

doas

Dedicated Outside Air System

domestic

For human use

domesticWaterRef

Domestic water flows from the referent to this entity

dualDuct

Two ducts

duct

Conduit used to convey air for HVAC

ductArea

Config point on a vav for duct area measured in ft² or m²

duration

Number with a unit of time

dxCooling

Cooling using direct expansion of a refrigerant vapor

dxHeating

Heating using direct expansion of a refrigerant vapor

economizer

Duct to access fresh outside air only for economizing, not ventilation

economizing

Energy reduction mode which augments heating/cooling with outside air

effective

Current control setpoint in effect taking into account other factors

efficiency

Efficiency point of a chiller measured in "COP" or "kW/ton"

elec

Associated with electricity or with electrical force, power, or energy

elecHeating

Heating by the conversion of electrical energy

elecLAvg

Average of L1, L2, L3 measurements

elecLLAvg

Average of L1-L2, L2-L3, L3-L1 measurements

elecQuadrant

Quadrant used to describe the flow of AC electric power

elecRef

Electricity flows from the referent to this entity

elevator

Enclosure used to move people between floors

emission

Amount of a substance discharged into the air

enable

Secondary on/off point of an equip especially used with a vfd

enclosure

Container or housing that surrounds and protects equipment or components

energy

Measure of ability to do work

entering

Pipe conveys fluid into an equipment

enthalpy

Total heat content of a system

enum

Defines an eumeration of string key names

equip

Equipment asset

equipRef

Reference to equip which contains this entity

escalator

Moving staircase used to move people between floors

evaporator

Mechanism used to convert a refrigerant from its liquid to gaseous state

evse

Electric Vehicle Supply Equipment

evseCableType

Physical type of EvseCable

exhaust

Duct used to expel air back outside

export

Supplied out of a system

extraction

Taking a substance out of another substance

faceBypass

Point of an ahu indicating air flow is by-passing the heating/cooling coils

fan

Fan equipment or control point

fanPowered

Device with a fan

fcu

Fan Coil Unit

feature

Feature namespace of definitions formatted as feature:name

feelsLike

Apparent temperature perceived when considering humidity, wind chill, and heat index

fileExt

Filename extension such as "csv"

filetype

File format type definition

filter

Related to an air or fluid filter

filterStr

Haystack filter string

floor

Storey of a building

floorNum

Unitless integer indicating the floor's distance from ground level

flow

Measure of volumetric flow of fluid

flowInverter

System to change direction of substance flow

flue

Duct for exhausting combustion

flux

Measurement through a given surface

freezeStat

A boolean point of an ahu indicating a freezing condition

freq

Occurrences per unit time

ftp

File Transfer Protocol

fuelOil

Petroleum based oil burned for energy

fuelOilHeating

Heating by the combustion of fuel oil

fuelOilRef

Fuel oil flows from the referent to this entity

fumeHood

Ventilation equipment to limit exposure to hazardous fumes

gasoline

Petroleum derived liquid used as a fuel source

gasolineRef

Gasoline flows from the referent to this entity

geoAddr

Free form street address

geoCity

Geographic city or locality name

geoCoord

Geographic coordinate as C(latitude,longitude)

geoCountry

Geographic country as ISO 3166-1 two letter code

geoCounty

Geographic subdivision of US state

geoElevation

Elevation above sea-level of the location

geoPlace

Geographic place

geoPostalCode

Geographic postal code

geoState

State or province name

geoStreet

Geographic street address and name

ground

Related to the surface of the earth

haystack

Haystack HTTP protocol for exchanging tagged data

header

Pipe used as central connection or manifold for other piping runs

heat

Associated with a heating process

heatExchanger

Equipment to transfer heat between two working fluids

heatPump

Equipment that employs a vapor compression cycle with a reversing valve to provide heating or cooling

heatRecovery

Transfer of heat from one substance to another to reduce energy consumption

heatWheel

Boolean point indicating command state of AHU's heat wheel

heating

Heating mode or process

heatingCoil

Coil used to heat air

heatingOnly

Equipment without cooling

height

Dimensional height of the asset

hfc

Hydrofluorocarbons

his

Supports historization of data

hisEnd

Last historized timestamped sample

hisErr

Error description when hisStatus indicates error condition

hisMode

Indicates the way that history data is collected for a point

hisSize

Number of historical timestamped samples historized by point

hisStart

First historized timestamped sample

hisStatus

Status of point's history collection or synchronization

hisTotalized

Indicates values which are a continuous stream of totalization

hot

Having high degree of heat

hotDeck

Duct carries air for heating

hotWaterHeating

Heating using energy of hot water

hotWaterRef

Hot water flows from the referent to this entity

http

Hypertext Transfer Protocol which is foundation of the web

humidifier

Adding moisture to air

humidity

Percent relative humidity

hvac

Heating, ventilation, and air conditioning

hvacMode

Operational mode for HVAC equipment

ice

Water in its solid form

illuminance

Luminous flux hitting the inside of the sphere at a specific point

imap

Internet Message Access Protocol for retrieving email

imbalance

Lacking balance

import

Received into a system

indoorUnit

Operates inside the conditioned space

infiltration

Permeation of a substance into another substance

inlet

Duct with air entering an equipment

input

Entity inputs a substance which flows from another entity

int

Unitless integer number

intensity

Measure of an electromagnetic field

irradiance

Energy received at a surface by area

isolation

Actuator used to isolate an equipment from a pipe or ductwork system

kind

Kind name used to identity a value data type

knx

KNX protocol commonly used for lighting systems

laptop

Portable laptop computer

leaving

Pipe conveys fluid out of an equipment

length

Dimensional length of the asset

level

Range from 0% to 100%

light

Electromagnetic radiation in the visible spectrum

lighting

Systems associated with illumination in the built environment

load

Chiller point to command or measure the chiller's load as a percentage from "0%" to "100%"

luminaire

Light fixture using electricity to provide illumination

luminance

Energy of light in a given direction

luminous

Relating to light as perceived by the eye

magnitude

Size or extent

makeup

Restore something missed or lost

makeupWaterRef

Makeup water flows from the referent to this entity

manufacturer

Company name that produced the asset

manufactureDate

Date the asset was produced by the manufacturer

mau

Makeup Air Unit

max

Maximum

maxVal

Inclusive maximum for a numeric value

mech

Associated with a machine or its mechanical force, torque, power, or energy

meter

Equipment to meter a substance or phenomenon

mime

Mime type formatted as type/subtype

min

Minimum

minVal

Inclusive minimum for a numeric value

mixed

Duct where fresh outside air and return air is mixed together

mixing

Three way valve which inputs two pipes and outputs a mixture between the two to a single output pipe

ml

Machine learning point

mlIdentificationPeriod

Training period description, known as the identification period or baseline, utilized during the model training process

mlInputVarRefs

List of independent variables, also known as model inputs or features, associated with a machine learning model

mlModel

See Synthetics chapter

mlModelMetrics

Goodness-of-fit metrics provided in the form of a simple dictionary

mlModelParameters

Result of model identification, which may appear as a list of model parameters for simpler models or as a reference to a stored model, in the form of a file uri

mlOutputVarRef

Dependent variable, also known as the model output or target, associated, with a machine learning model

mlVar

Machine learning variable representing both model inputs and outputs

mlVarFilter

Filter used for querying points by tags, providing more flexibility than mlVarPoint, although it is not mandatory

mlVarPoint

Reference to a point associated with a machine learning variable, known as a machine learning variable point

mlVarRef

Reference to a machine learning variable

mobile

Relating to mobile phones, hand-held computers, and similar technology

modbus

Register based communication protocol used with industrial devices

modelSeries

Manufacturer assigned identifier for a general product line

modelNumber

Manufacturer assigned alphanumeric identifier for a specific product configuration

modulating

Indicates equipment or point with variable output from 0% to 100%, as opposed to binary on/off or discrete staged control

motor

Equipment that converts electrical energy into mechanical energy

movingWalkway

Conveyor to move people across a horizontal or inclined plane

mqtt

Message Queuing Telemetry Transport publish/subscribe protocol

multiZone

AHU discharge air is split into a duct per zone

n2o

Nitrous oxide (N₂O)

na

Not available used to indicate invalid or missing data

naturalGas

Fossil fuel energy source consisting largely of methane and other hydrocarbons

naturalGasHeating

Heating by the combustion of natural gas

naturalGasRef

Natural gas flows from the referent to this entity

net

Difference between import and export

network

Logical communications network between two or more devices

networkRef

Associates a device which communicates on specific a network

networking

Related to data communication networks

neutral

when applied to a point entity that has the elec and current tags, indicates electrical current being measured on an electrical neutral conductor

neutralDeck

Duct carries air which by-passes both heating and cooling coils

nf3

Nitrogen trifluoride (NF₃)

nh3

Ammonia (NH₃)

no2

Nitrogen dioxide (NO₂)

noSideEffects

Marks a function or operation as having no side effects

nodoc

Undocumented and not officially supported

nosrc

Do not include source code in documentation

o2

Oxygen (O₂) - the common dioxygen allotrope in the air

o3

Ozone (O₃)

obix

XML based Open Building Information eXchange protocol

occ

Occupied mode of a space

occupancy

Number of occupants in a space

occupants

People who use the built environment

occupied

Setpoint or sensor indicating occupancy of a space

of

Expected value type of a collection, reference, or choice

op

Operation for HTTP API

openEnum

Apply to str enum tags where the enumeration range is open ended

outdoorUnit

operates outside the conditioned space

output

Entity outputs a substance with flows to other entities

outside

Duct to access fresh outside air for both ventilation and economizer

panel

Enclosure for electrical and control equipment

parallel

Circuit with multiple paths of flow

perimeterHeat

Auxiliary heating points associated with a vav

pf

Electric power factor

pfDisplacement

Displacement power factor, which accounts for the phase angle between voltage and current but excludes effects of nonlinear waveforms ( harmonic distortion)

pfDistortion

Distortion power factor, which measures the component of power factor attributable to harmonic distortion in voltage and current waveforms

pfIec

Power factor according to the IEC convention defines a positive or negative sign based on the direction of active power flow

pfIeee

Power factor according to the IEEE convention defines a positive or negative sign based on whether the load is capacitive or inductive

pfTrue

True power factor, which includes effects of harmonic distortion

pfc

Perfluorocarbons

phase

Single-phase measurement of an electric quantity in a multi-phase AC electric power system

phone

Telephone used for voice telecommunication

pipe

Conduit used to convey a fluid

plant

Central plant used to generate a substance for a process

pm01

Particulate matter 0.1

pm10

Particulate matter 10

pm25

Particulate matter 2.5

point

Data point such as a sensor or actuator

pointRef

See Synthetics chapter

pop3

Post Office Protocol version 3 for retrieving email

port

A gateway or opening used to transfer a substance

power

Energy consumed per unit time

powerConverter

Converts one electrical waveform to another using power electronic circuitry

precipitation

Amount of atmospheric water vapor fallen including rain, sleet, snow, and hail

prefUnit

Defines a preferred unit to be used with a quantity

pressure

Measure of force applied

pressureDependent

VAV damper modulates to control space temp

pressureIndependent

VAV damper or a control valve that modulates to maintain desired flow setpoint

primaryFunction

Primary function of building as US Energy Star key

primaryLoop

Pipework which circulates closest to the energy source

process

Industrial or HVAC process

propane

By-product of natural gas processing and petroleum refining (C₃H₈)

propaneHeating

Heating by the combustion of propane

protocol

Communication protocol used for devices on a network

pump

Pump equipment or control point

purge

Associated with a cleaning process to remove contaminants

quality

Quantity measured against standard metric

rack

Enclosure or chassis used to mount computer and networking gear

radiantFloor

Heats a space using pipes or cables embedded beneath floor

radiator

Heats a space using exposed pipes or coils

rated

Data specified by a manufacturer or rating organization

reactive

Relating to reactance

reciprocal

Piston compressor driven by a crankshaft

refrig

Fluid used in refrigeration and heat exchange

refrigRef

Refrigerant flows from the referent to this entity

reheat

Command point for reheating process

return

Duct returning air back to equipment

roof

Envelope covering the top of a building

room

Enclosed room of a building

rotaryScrew

Rotary screw compression

router

Device used to route data packets

rtu

Roof Top Unit

run

Primary on/off point of an equip especially used with a vfd

scalar

Scalar is an atomic value kind

secondaryLoop

Pipework which circulates closest to the building or end use

sensor

Point is a sensor, input, AI/BI

serialNumber

Manufacturer assigned unique, alphanumeric identifier for a specific asset

series

Circuit with single path of flow

server

Hardware or software which provides services for other programs or devices

serviceFactor

Ratio of the maximum continuous output capacity at which a machine or system may operate without damage to the machine or system’s nominal output capacity

sf6

Sulphur hexafluoride (SF₆)

sim

Simulation point

simBaseline

See Synthetics chapter

simModel

See Synthetics chapter

simOperation

See Synthetics chapter

simOptimum

See Synthetics chapter

singleDuct

One single duct

singlePhase

Single-phase AC electricity

site

Site is a geographic location of the built environment

siteMeter

Main meter for the associated site

siteRef

Reference to site which contains the entity

smtp

Simple Mail Transfer Protocol for sending email

snmp

Simple Network Management Protocol for managing IP devices

solar

Relating to energy from the sun

solid

Substance with definite shape and volume

sox

Sedona Framework UDP based communication protocol

sp

Point is a setpoint, soft point, internal control variable, schedule

space

Space is a three-dimensional volume in the built environment

spaceRef

Reference to space which contains this entity

speed

Distance per unit time

splitPhase

Split-phase AC electricity

stage

Stage number of staged equipment operation, such as coil or pump

standby

Readiness mode of a space

stateOfCharge

State of charge (SoC) of an electric battery

steam

Water in its gas form

steamHeating

Heating using energy of steam

steamRef

Steam flows from the referent to this entity

submeter

Submeters measure usage of a sub-system or equipment within a site

submeterOf

Reference to parent meter which is immediately upstream of this meter

subterranean

Below the surface of the earth

switch

Device for toggling state or routing data

synthetic

Synthetic point with computed operational data

syntheticModel

See Synthetics chapter

syntheticModelRef

See Synthetics chapter

system

Grouping of related equipment dedicated to a single application

systemRef

Reference to system

tablet

Mobile device with touch screen for user input

tank

Tank used to store a substance for temporary holding

temp

Temperature - measure of hot and cold

tertiaryLoop

Pipework which circulates within the building

thd

Total harmonic distortion

thermal

Related to energy of heat

thermostat

Senses and controls temperature of space in HVAC system

threePhase

Three-phase AC electricity

total

Complete or absolute

tripleDuct

Three ducts

tvoc

Total volatile organic compound (TVOC)

twoPhase

Two-phase AC electricity

tz

Timezone identifier from standard timezone database

unit

Unit identifier from standard unit database

unitVent

Unit Ventilator

unocc

Unoccupied mode of a space

ups

Uninterruptible power supply

val

Data value type

valve

Valve equipment or control point

variableAirVolume

Delivers a variable volume of air flow

vav

Variable air volume terminal unit

vavZone

AHU supplies air to VAV terminal units

velocity

Speed in a given direction

ventilation

Duct to access fresh outside air only for ventilation, not economizing

version

Version string formatted as decimal integers separated by a dot

vfd

Variable-frequency drive

visibility

Distance at which light can be clearly discerned

volt

Electrical potential difference or electromotive force

volume

Three dimensional space occupied by a substance

vrf

Variable refigerant flow

warm

Relatively warm in comparison to another substance, without being actively heated

water

Water in its liquid form

waterCooling

Cooling using transfer of heat to water which is not explicitly chilled

weather

Associated with atmospheric air or phenomenon

weatherCond

Enumeration of weather conditions

weatherStation

Logical weather station and its measurement points

weatherStationRef

Reference to weather station for to use this entity

weight

Weight of the asset

well

A well is a source of groundwater and potentially thermal energy

wetBulb

Wet bulb air temperature

width

Dimensional width of the asset

wikipedia

Hyperlink to the subject's page on Wikipedia

wind

Flow of air on surface of the Earth

wire

Cabling used to convey electricity or data

writable

Supports writing data

writeErr

Error description when writeStatus indicates error condition

writeLevel

Current priority level for writeVal as number between 1 and 17

writeStatus

Current status of a writable point output

writeVal

Current desired value to write to output

xstr

Extended string - type name and string value encoding

yearBuilt

Original year of construction as four digit year such as 1980

zigbee

Low power wireless communication protocol for home automation

zone

Related to spaces from a system perspective

zwave

Low power wireless communication protocol for home automation

absorption Marker <global>

Cooling process using energy from heat source such as hot water

ac Marker <global>

Relating to alternating current (AC) electricity

active Marker <global>

Working, operative, effective

actuator Marker <global>

Equipment to move or control a mechanism. Actuators may be manually operated or automated via a control system to convert an energy source into mechanical energy. Typically the energy source is electricity, hydraulics, or pneumatics.

ahu Marker <global>

Air Handling Unit: An enclosure with a fan that delivers air to a space via ductwork and performs one or more of the functions of cleaning, heating, cooling, humidifying, dehumidifying, ventilating or circulating the air. See AHUs chapter.

air Marker <global>

The mixture of gases which surrounds the earth

airCooling Marker <global>

Cooling by dissipating heat into the surrounding air

airRef MultiRef <global>

Air flows from the referent to this entity

alarm Marker <global>

Notification of a condition which requires attention

angle Marker <global>

Measurement of the relative difference in direction between two vectors or phasors

apparent Marker <global>

Perceived quantity

area Number <global, quantity:area>

Area of a shape or floor space

ates Marker <global>

Aquifer Thermal Energy Storage system. See ATES chapter.

atesClosedLoop Marker <global>

The ATES uses closed piping to transport a water/glycol mixture through the ground. The system works like a heat exchanger; there is no ground water transported.

atesDoublet Marker <global>

The ATES has one or more pairs of a separate warm and cool well.

atesDoubletPaired Marker <global>

The ATES is as a doublet, but with specific warm and cool wells linked together. These linked wells do not exchange water with other wells.

atesMono Marker <global>

The ATES has only one physical well. This well is deep enough to penetrate two layers of groundwater.

atesUnidirectional Marker <global>

Similar to a doublet, but water always flows in the same direction from the extraction to the infiltration well.

attr Marker <global>

Attribute is a single datum of static information on an entity. Attributes often represent nameplate data or design/rated data.

atmospheric Marker <global>

Related to the atmosphere of the earth

avg Marker <global>

Average; central or typical value; median

bacnet Marker <global>

ASHRAE building automation and control protocol

barometric Marker <global>

Relating atmospheric pressure

baseUri Uri <global>

Base URI for normalizing relative URIs

battery Marker <global>

Equipment used to store electric energy

biomass Marker <global>

Plant or animal material used as fuel to produce electricity or heat

biomassHeating Marker <global>

Heating by the combustion of biomass

blowdown Marker <global>

Removal from container or pipe

blowdownWaterRef MultiRef <global>

Blowdown water flows from the referent to this entity

bluetooth Marker <global>

Short range wireless communication protocol

boiler Marker <global>

Equipment to generate hot water or steam for heating

branchSelector Marker <global>

Branch selector used for heat recovery in a VRF system. These are control devices directing the liquid refrigerant or gas refrigerant to zones requiring cooling or heating. See VRF chapter.

bypass Marker <global>

Pipe used to bypass an equipment

cable Marker <global>

An assembly of one or more insulated conductors.

cav Marker <global>

Constant air volume terminal unit. CAV systems use a constant air flow rate with a variable air temperature.

centrifugal Marker <global>

Compression via a continuous flow of fluid through an impeller

ch2o Marker <global>

Formaldehyde (CH₂O)

ch4 Marker <global>

Methane (CH₄)

chilled Marker <global>

Substance is cooled using cooling process

chilledBeam Marker <global>

Conditions a space using a heat exchanger integrated into the ceiling

chilledBeamZone Marker <global>

AHU supplies air to chilled beam terminal units

chilledWaterCooling Marker <global>

Cooling using transfer of heat to chilled water

chilledWaterRef MultiRef <global>

Chilled water flows from the referent to this entity

chiller Marker <global>

Equipment to remove heat from a liquid. Chillers typically use a vapor compression or an absorption refrigeration cycle.

circ Marker <global>

Pipe used to circulate fluid through an equipment or system

circuit Marker <global>

Electrical circuit and its associated components such as breakers. See Elec Panels chapter.

cloudage Marker <global>

Percentage of sky obscured by clouds. This is also known as cloudiness, or cloud amount.

cmd Marker <global>

Point is a command, actuator, AO/BO. See Points chapter.

co Marker <global>

Carbon monoxide (CO)

co2 Marker <global>

Carbon dioxide (CO₂)

co2e Marker <global>

Carbon dioxide equivalent

coal Marker <global>

Combustible sedimentary rock

coalHeating Marker <global>

Heating by the combustion of coal

coap Marker <global>

Constrained Application Protocol

cold Marker <global>

Having low degree of heat

coldDeck Marker <global>

Duct carries air for cooling

compressor Marker <global>

Device for mechanically increasing the pressure of a gas or refrigerant vapor by reducing its volume.

computed Marker <global>

Computed point. See Synthetics chapter.

computedFromReciprocal Marker <global>

Indicates a relationship that is computed from its reciprocal. Computed defs cannot be used as tags themselves.

computedModel Marker <global>

See Synthetics chapter.

computer Marker <global>

General purpose computer.

concentration Marker <global>

Abundance of substance in the total volume of a mixture.

condensate Marker <global>

Liquid phase produced by the condensation of steam or other gas

condensateRef MultiRef <global>

Condensate flows from the referent to this entity

condenser Marker <global>

Device or related to process of condensation

condenserClosedLoop Marker <global>

Working fluid is kept separate from fluid used for heat transfer into the atmosphere

condenserCooling Marker <global>

Removal of heat through the process of water condensation

condenserOpenLoop Marker <global>

Uses working fluid itself for evaporation into the atmosphere

condenserWaterRef MultiRef <global>

Condenser water flows from the referent to this entity

conditioning Marker <global>

Related to cleaning, heating, cooling, humidifying, dehumidifying, ventilating or circulating  air. 

constantAirVolume Marker <global>

Delivers a constant volume of air flow. Typically this means equipment with a single speed fan.

controller Marker <global>

Microprocessor based device used in a control system. Controllers interact with the physical world through direct I/O to sensors and actuators or via network protocols.

controls Marker <global>

Associated with the control system for an industrial process

cool Marker <global>

Associted with low temperature or cooling processes. When used on a point, this tag is associated with the control of cooling. When paired with a substance, this tag indicates the substance is relatively cool in comparison to another substance, without being actively cooled by e.g. a chiller.

cooling Marker <global>

Cooling mode or process

coolingCapacity Number <global>

Measurement of a chiller ability to remove heat measured

coolingCoil Marker <global>

Coil used to cool air.

coolingOnly Marker <global>

Equipment without heating

coolingTower Marker <global>

Equipment to transfer waste heat into the atmosphere

coupler Marker <global>

Device that joins two components together.

crac Marker <global>

Computer Room Air Conditioner: An FCU designed to condition a computer room. See AHUs and Data Centers chapters.

cur Marker <global>

Supports current value

curErr Str <global, transient>

Error description when curStatus indicates error condition

curStatus CurStatus <global, transient>

Status of point's current value reading. The curVal is only available when curStatus is "ok" or "stale". However a "stale" value should be used with caution since the local system does not have a fresh value. It is recommended that the curVal tag is removed from a point when the curStatus is not "ok" nor "stale".

curVal Obj <global, transient>

Current value of a point. The current value is only available when the curStatus is "ok" or "stale".

current Marker <global>

Movement of fluid or electricity

dali Marker <global>

Digital Addressable Lighting Interface protocol for lighting

damper Marker <global>

Damper equipment or control point.

dataCenter Marker <global>

Space used to house computer and networking gear. See Data Centers chapter.

daytime Marker <global>

Time between sunrise and sunset

dc Marker <global>

Relating to direct current (DC) electricity

deadband Marker <global>

The range in a process where no changes to output are made. May also indicate the difference between a base setpoint and effective setpoint.

delta Marker <global>

Differential of fluid between entering and leaving sensors.

demand Marker <global>

Rate required for a process.

deprecated Marker <global>

Obsoleted

design Marker <global>

Data related to intended design and operating conditions. This includes sizing and other data specified by design engineers and engineered drawings. Also see rated.

dessicantDehumidifier Marker <global>

Decreases humidity from air using a substance which absorbs moisture.

device Marker <global>

Microprocessor based hardware device. This is the general term for all computers, mobile phones, controllers, and I/O modules. See Devices chapter.

deviceRef Ref <of:Device, global>

Device which controls a monitors this entity

dewPoint Marker <global>

Dew point temperature at which water vapor will form dew

diesel Marker <global>

Liquid fuel specifically designed for use in diesel engines

directZone Marker <global>

AHU supplies air directly to the zone

direction Marker <global>

Compass direction measured in degrees: North: 0° = 360°, East: 90°, South: 180°, West: 270°

dis Str <global>

Display name for an entity. See Ontology chapter.

discharge Marker <global>

Duct for air leaving an equipment

dispenser Marker <global>

Equipment that releases a specific amount of a substance.

diverting Marker <global>

Three way valve which inputs one pipe and diverts between two output pipes.

doas Marker <global>

Dedicated Outside Air System: An AHU that brings in 100% outside air and no recirculated air in order to provide ventilation to spaces. See AHUs chapter.

domestic Marker <global>

For human use

domesticWaterRef MultiRef <global>

Domestic water flows from the referent to this entity

dualDuct Marker <global>

Two ducts: combination of hotDeck, coldDeck, or neutralDeck

duct Marker <global>

Conduit used to convey air for HVAC

ductArea Marker <global>

Config point on a vav for duct area measured in ft² or m²

duration Number <global>

Number with a unit of time

dxCooling Marker <global>

Cooling using direct expansion of a refrigerant vapor. Also see dxHeating and heatPump.

dxHeating Marker <global>

Heating using direct expansion of a refrigerant vapor. Also see dxCooling and heatPump.

economizer Marker <global>

Duct to access fresh outside air only for economizing, not ventilation

economizing Marker <global>

Energy reduction mode which augments heating/cooling with outside air.

effective Marker <global>

Current control setpoint in effect taking into account other factors

efficiency Marker <global>

Efficiency point of a chiller measured in "COP" or "kW/ton".

elec Marker <global>

Associated with electricity or with electrical force, power, or energy. This is often opposed to mech mechanical energy.

elecHeating Marker <global>

Heating by the conversion of electrical energy

elecLAvg Marker <global>

Average of L1, L2, L3 measurements

elecLLAvg Marker <global>

Average of L1-L2, L2-L3, L3-L1 measurements

elecQuadrant ElecAcQuadrant <global>

Quadrant used to describe the flow of AC electric power

elecRef MultiRef <global>

Electricity flows from the referent to this entity

elevator Marker <global>

Enclosure used to move people between floors.

emission Marker <global>

Amount of a substance discharged into the air

enable Marker <global>

Secondary on/off point of an equip especially used with a vfd. Enable is used with Bool points where true indicates on and false indicates off. Equip with an enable should always also define a run point which indicates the primary on/off state of the equipment.

enclosure Marker <global>

Container or housing that surrounds and protects equipment or components. Enclosures may be cabinets, sealed boxes, weatherproof housings, or other protective structures that provide physical protection, environmental sealing, or safety isolation.

energy Marker <global>

Measure of ability to do work

entering Marker <global>

Pipe conveys fluid into an equipment

enthalpy Marker <global>

Total heat content of a system. It is defined as internal energy of the system plus the product of pressure and volume.

enum Obj <global>

Defines an eumeration of string key names. The range may also be applied to format a Bool ordered as "false,true". The value of this tag may be formatted in one of five ways:

  • dict of dicts keyed by name and Dict values for meta such as doc tag
  • comma separated names on one line
  • names separated by a "\n" newline character
  • markdown unordered list formatted as a series of "- name: description\n"
  • ref to a Xeto sys::Enum spec

Enum names should follow valid tag naming rules (start with lowercase ASCII letter and contain only ASCII letters and numbers). However in cases where mapping directly to external enumerations enum names can contain arbitrary characters such as space.

equip Marker <global>

Equipment asset. See Equips chapter.

equipRef Ref <of:Equip, global>

Reference to equip which contains this entity

escalator Marker <global>

Moving staircase used to move people between floors.

evaporator Marker <global>

Mechanism used to convert a refrigerant from its liquid to gaseous state.

evse Marker <global>

Electric Vehicle Supply Equipment. See EVSE chapter.

evseCableType EvseCableType <global>

Physical type of EvseCable.

exhaust Marker <global>

Duct used to expel air back outside

export Marker <global>

Supplied out of a system

extraction Marker <global>

Taking a substance out of another substance

faceBypass Marker <global>

Point of an ahu indicating air flow is by-passing the heating/cooling coils. If a boolean point, then true indicates the unit is in by-pass mode and false indicates by-pass is disabled. If the point is an analog point then 100% indicates full by-pass mode and 0% indicates by-pass is completely disabled.

fan Marker <global>

Fan equipment or control point

fanPowered Marker <global>

Device with a fan

fcu Marker <global>

Fan Coil Unit: A unitary, factory-made enclosure with a fan and coil that recirculates air in a space and performs one or more of the functions of cleaning, heating, cooling, humidifying, dehumidifying, or ventilating the air. Unit heaters are examples of FCUs. See AHUs chapter.

feature Obj <global>

Feature namespace of definitions formatted as feature:name

feelsLike Marker <global>

Apparent temperature perceived when considering humidity, wind chill, and heat index

fileExt Str <global>

Filename extension such as "csv"

filetype Obj <global>

File format type definition

filter Marker <global>

Related to an air or fluid filter.

filterStr Str <global>

Haystack filter string. See Filters

floor Marker <global>

Storey of a building. See Spaces chapter.

floorNum Number <global>

Unitless integer indicating the floor's distance from ground level. The ground floor is always defined as zero. Additional floors above ground are numbered 1, 2, 3, etc. Subterranean floors are numbered -1, -2, -3, etc. This convention is consistent with how most European buildings number floors. In North America its common to label the ground floor as the first floor; however Haystack requires the ground level to be assigned a floorNum of 0.

flow Marker <global>

Measure of volumetric flow of fluid

flowInverter Marker <global>

System to change direction of substance flow

flue Marker <global>

Duct for exhausting combustion

flux Marker <global>

Measurement through a given surface

freezeStat Marker <global>

A boolean point of an ahu indicating a freezing condition. This might require a control sequence to protect the equipment. If true then a freeze condition is detected, or false if not.

freq Marker <global>

Occurrences per unit time

ftp Marker <global>

File Transfer Protocol

fuelOil Marker <global>

Petroleum based oil burned for energy

fuelOilHeating Marker <global>

Heating by the combustion of fuel oil

fuelOilRef MultiRef <global>

Fuel oil flows from the referent to this entity

fumeHood Marker <global>

Ventilation equipment to limit exposure to hazardous fumes.

gasoline Marker <global>

Petroleum derived liquid used as a fuel source

gasolineRef MultiRef <global>

Gasoline flows from the referent to this entity

geoAddr Str <global>

Free form street address. Best practice is to follow local norms for a postal address. Typically this string includes the geoStreet, geoCity, geoState (in US), and geoPostalCode:

Examples: "1600 Pennsylvania Avenue NW, Washington, DC 20500"

"10 Downing St, Westminster, London SW1A 2AA, United Kingdom"

"Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France"

geoCity Str <global>

Geographic city or locality name

geoCoord Coord <global>

Geographic coordinate as C(latitude,longitude)

geoCountry GeoCountry <global>

Geographic country as ISO 3166-1 two letter code

geoCounty Str <global>

Geographic subdivision of US state

geoElevation Number <global>

Elevation above sea-level of the location

geoPlace Marker <global>

Geographic place

geoPostalCode Str <global>

Geographic postal code; for US this is a five digit zip code

geoState GeoState <global>

State or province name; for US this is two letter state code. May be used in other countries to model administrative area between the geoCity and geoCountry level.

geoStreet Str <global>

Geographic street address and name

ground Marker <global>

Related to the surface of the earth. Used to indicate electrical current being measured on an electrical ground conductor when applied to a point entity that has the elec and current tags.

haystack Marker <global>

Haystack HTTP protocol for exchanging tagged data

header Marker <global>

Pipe used as central connection or manifold for other piping runs.

heat Marker <global>

Associated with a heating process. When used on a point, this tag is associated with the control of heating.

heatExchanger Marker <global>

Equipment to transfer heat between two working fluids.

heatPump Marker <global>

Equipment that employs a vapor compression cycle with a reversing valve to provide heating or cooling. For vapor compression heating without a reversing valve, such as for a heat pump water heater, see dxHeating which should be used.

heatRecovery Marker <global>

Transfer of heat from one substance to another to reduce energy consumption.

heatWheel Marker <global>

Boolean point indicating command state of AHU's heat wheel.

heating Marker <global>

Heating mode or process

heatingCoil Marker <global>

Coil used to heat air.

heatingOnly Marker <global>

Equipment without cooling

height Marker <global>

Dimensional height of the asset

hfc Marker <global>

Hydrofluorocarbons

his Marker <global>

Supports historization of data

hisEnd DateTime <global, transient>

Last historized timestamped sample

hisErr Str <global, transient>

Error description when hisStatus indicates error condition

hisMode HisMode <global>

Indicates the way that history data is collected for a point.

hisSize Number <global, transient>

Number of historical timestamped samples historized by point

hisStart DateTime <global, transient>

First historized timestamped sample

hisStatus HisStatus <global, transient>

Status of point's history collection or synchronization

hisTotalized Marker <global>

Indicates values which are a continuous stream of totalization. History data reads and should be normalized by computing the delta.

hot Marker <global>

Having high degree of heat

hotDeck Marker <global>

Duct carries air for heating

hotWaterHeating Marker <global>

Heating using energy of hot water

hotWaterRef MultiRef <global>

Hot water flows from the referent to this entity

http Marker <global>

Hypertext Transfer Protocol which is foundation of the web

humidifier Marker <global>

Adding moisture to air

humidity Marker <global>

Percent relative humidity; measure of moisture in the air

hvac Marker <global>

Heating, ventilation, and air conditioning

hvacMode Marker <global>

Operational mode for HVAC equipment

ice Marker <global>

Water in its solid form

illuminance Marker <global>

Luminous flux hitting the inside of the sphere at a specific point.

Also see ies.org

imap Marker <global>

Internet Message Access Protocol for retrieving email

imbalance Marker <global>

Lacking balance

import Marker <global>

Received into a system

indoorUnit Marker <global>

Operates inside the conditioned space

infiltration Marker <global>

Permeation of a substance into another substance

inlet Marker <global>

Duct with air entering an equipment

input Marker <global>

Entity inputs a substance which flows from another entity

int Number <global>

Unitless integer number

intensity Marker <global>

Measure of an electromagnetic field

irradiance Marker <global>

Energy received at a surface by area

isolation Marker <global>

Actuator used to isolate an equipment from a pipe or ductwork system

kind Kind <global>

Kind name used to identity a value data type

knx Marker <global>

KNX protocol commonly used for lighting systems

laptop Marker <global>

Portable laptop computer.

leaving Marker <global>

Pipe conveys fluid out of an equipment

length Marker <global>

Dimensional length of the asset

level Marker <global>

Range from 0% to 100%. When paired with a fluid this implies a fill level where 0% is empty and 100% is full.

light Marker <global>

Electromagnetic radiation in the visible spectrum

lighting Marker <global>

Systems associated with illumination in the built environment

load Marker <global>

Chiller point to command or measure the chiller's load as a percentage from "0%" to "100%". When paired with cmd this models the chiller's load limit. When paired with sensor this models the chiller's current load factor.

luminaire Marker <global>

Light fixture using electricity to provide illumination

luminance Marker <global>

Energy of light in a given direction.

Also see ies.org

luminous Marker <global>

Relating to light as perceived by the eye

magnitude Marker <global>

Size or extent

makeup Marker <global>

Restore something missed or lost

makeupWaterRef MultiRef <global>

Makeup water flows from the referent to this entity

manufacturer Marker <global>

Company name that produced the asset.

manufactureDate Marker <global>

Date the asset was produced by the manufacturer.

mau Marker <global>

Makeup Air Unit: A DOAS that provides make-up air for a separate, dedicated exhaust system. That is, this equip does not contain an exhaust air section. See AHUs chapter.

max Marker <global>

Maximum

maxVal Number <global>

Inclusive maximum for a numeric value.

mech Marker <global>

Associated with a machine or its mechanical force, torque, power, or energy. This is often opposed to elec electrical energy.

meter Marker <global>

Equipment to meter a substance or phenomenon. See Meters chapter.

mime Str <global>

Mime type formatted as type/subtype

min Marker <global>

Minimum

minVal Number <global>

Inclusive minimum for a numeric value.

mixed Marker <global>

Duct where fresh outside air and return air is mixed together

mixing Marker <global>

Three way valve which inputs two pipes and outputs a mixture between the two to a single output pipe.

ml Marker <global>

Machine learning point. See Synthetics chapter.

mlIdentificationPeriod Span <global>

Training period description, known as the identification period or baseline, utilized during the model training process.

mlInputVarRefs List <of:_0, global>

List of independent variables, also known as model inputs or features, associated with a machine learning model.

mlModel Marker <global>

See Synthetics chapter.

mlModelMetrics Dict <global>

Goodness-of-fit metrics provided in the form of a simple dictionary. For example: {r2:0.7889, cvrmse:58}.

mlModelParameters Dict <global>

Result of model identification, which may appear as a list of model parameters for simpler models or as a reference to a stored model, in the form of a file uri. The structure of the dict is user-specific.

mlOutputVarRef Ref <of:MlVar, global>

Dependent variable, also known as the model output or target, associated, with a machine learning model. Represents the predicted outcome generated by the model.

mlVar Marker <global>

Machine learning variable representing both model inputs and outputs.

mlVarFilter Str <global>

Filter used for querying points by tags, providing more flexibility than mlVarPoint, although it is not mandatory.

mlVarPoint Ref <of:Point, global>

Reference to a point associated with a machine learning variable, known as a machine learning variable point.

mlVarRef Ref <of:MlVar, global>

Reference to a machine learning variable.

mobile Marker <global>

Relating to mobile phones, hand-held computers, and similar technology

modbus Marker <global>

Register based communication protocol used with industrial devices.

modelSeries Marker <global>

Manufacturer assigned identifier for a general product line. For example, modelSeries is "iPhone 12", but modelNumber is "MGF43LL/A". The modelSeries tends to be a marketing name and not an exact identifier. Always use modelNumber for the actual model identifier.

modelNumber Marker <global>

Manufacturer assigned alphanumeric identifier for a specific product configuration. For example, modelSeries is "iPhone 12", but modelNumber is "MGF43LL/A".

modulating Marker <global>

Indicates equipment or point with variable output from 0% to 100%, as opposed to binary on/off or discrete staged control.

motor Marker <global>

Equipment that converts electrical energy into mechanical energy. See Motors chapter.

movingWalkway Marker <global>

Conveyor to move people across a horizontal or inclined plane.

mqtt Marker <global>

Message Queuing Telemetry Transport publish/subscribe protocol

multiZone Marker <global>

AHU discharge air is split into a duct per zone

n2o Marker <global>

Nitrous oxide (N₂O)

na Obj <global>

Not available used to indicate invalid or missing data. See Kinds chapter.

naturalGas Marker <global>

Fossil fuel energy source consisting largely of methane and other hydrocarbons.

The energy content of natural gas varies by region within a range determined on impurities in the gas. You can find a table of these conversions here

naturalGasHeating Marker <global>

Heating by the combustion of natural gas

naturalGasRef MultiRef <global>

Natural gas flows from the referent to this entity

net Marker <global>

Difference between import and export

network Marker <global>

Logical communications network between two or more devices. See Devices chapter.

networkRef Ref <of:Network, global>

Associates a device which communicates on specific a network.

networking Marker <global>

Related to data communication networks

neutral Marker <global>

when applied to a point entity that has the elec and current tags, indicates electrical current being measured on an electrical neutral conductor.

neutralDeck Marker <global>

Duct carries air which by-passes both heating and cooling coils

nf3 Marker <global>

Nitrogen trifluoride (NF₃)

nh3 Marker <global>

Ammonia (NH₃)

no2 Marker <global>

Nitrogen dioxide (NO₂)

noSideEffects Marker <global>

Marks a function or operation as having no side effects. The function may or may not be pure in that calling it multiple times with the same arguments always evaluates to the same result.

nodoc Marker <global>

Undocumented and not officially supported

nosrc Marker <global>

Do not include source code in documentation

o2 Marker <global>

Oxygen (O₂) - the common dioxygen allotrope in the air

o3 Marker <global>

Ozone (O₃)

obix Marker <global>

XML based Open Building Information eXchange protocol.

occ Marker <global>

Occupied mode of a space. See Zones chapter.

occupancy Marker <global>

Number of occupants in a space. See Zones chapter.

occupants Marker <global>

People who use the built environment. See Zones chapter.

occupied Marker <global>

Setpoint or sensor indicating occupancy of a space. See Zones chapter.

of Symbol <global>

Expected value type of a collection, reference, or choice

op Obj <global>

Operation for HTTP API. See Ops chapter.

openEnum Marker <global>

Apply to str enum tags where the enumeration range is open ended. User interfaces should support data entry for arbitrary strings, but also provide a dropdown for the predefined enumeration.

outdoorUnit Marker <global>

operates outside the conditioned space

output Marker <global>

Entity outputs a substance with flows to other entities

outside Marker <global>

Duct to access fresh outside air for both ventilation and economizer.

panel Marker <global>

Enclosure for electrical and control equipment. Panels may be used to isolate electrical connections and provide environmental protection.

parallel Marker <global>

Circuit with multiple paths of flow

perimeterHeat Marker <global>

Auxiliary heating points associated with a vav

pf Marker <global>

Electric power factor; which is the ratio of active power to apparent power in an AC electric power system. Measured with values in the range of -1.0 to 1.0 or 0.0 to 1.0 without a unit. When the range of -1.0 to 1.0 is applied, a negative value for power factor indicates the electrical current leads the electrical voltage and a positive value indicates the electrical current lags the electrical voltage.

pfDisplacement Marker <global>

Displacement power factor, which accounts for the phase angle between voltage and current but excludes effects of nonlinear waveforms ( harmonic distortion).

pfDistortion Marker <global>

Distortion power factor, which measures the component of power factor attributable to harmonic distortion in voltage and current waveforms.

pfIec Marker <global>

Power factor according to the IEC convention defines a positive or negative sign based on the direction of active power flow. Power factor is positive when active power flows into a load. Power factor is negative when active power flows out of a load.

pfIeee Marker <global>

Power factor according to the IEEE convention defines a positive or negative sign based on whether the load is capacitive or inductive. Power factor is positive when the load is capacitive, or when voltage lags behind current. Power factor is negative when the load is inductive, or when current lags behind voltage.

pfTrue Marker <global>

True power factor, which includes effects of harmonic distortion. Power factor is assumed to be true power factor when PfScope is not defined. However, it is recommended to specify a scope for power factor to help avoid misinterpretation of data.

pfc Marker <global>

Perfluorocarbons

phase Phase <global>

Single-phase measurement of an electric quantity in a multi-phase AC electric power system.

phone Marker <global>

Telephone used for voice telecommunication.

pipe Marker <global>

Conduit used to convey a fluid

plant Marker <global>

Central plant used to generate a substance for a process. See Plants.

pm01 Marker <global>

Particulate matter 0.1; atmospheric pollutant of fine particles with an aerodynamic diameter of 0.1 micrometers or less

pm10 Marker <global>

Particulate matter 10; atmospheric pollutant of fine particles with an aerodynamic diameter of 10 micrometers or less

pm25 Marker <global>

Particulate matter 2.5; atmospheric pollutant of fine particles with an aerodynamic diameter of 2.5 micrometers or less

point Marker <global>

Data point such as a sensor or actuator. See Points chapter.

pointRef Ref <of:Point, global>

See Synthetics chapter.

pop3 Marker <global>

Post Office Protocol version 3 for retrieving email

port Marker <global>

A gateway or opening used to transfer a substance.

power Marker <global>

Energy consumed per unit time

powerConverter Marker <global>

Converts one electrical waveform to another using power electronic circuitry. Involves the use of one or more power modules.

May convert:

Note: An AC/AC power converter performs the same task as a power transformer but using power electronics. Similarly, a DC/DC power converter transforms an input DC voltage to an output DC voltage at another level.

precipitation Marker <global>

Amount of atmospheric water vapor fallen including rain, sleet, snow, and hail

prefUnit List <of:Str, global>

Defines a preferred unit to be used with a quantity

pressure Marker <global>

Measure of force applied

pressureDependent Marker <global>

VAV damper modulates to control space temp; dependent on duct pressure being maintained

pressureIndependent Marker <global>

VAV damper or a control valve that modulates to maintain desired flow setpoint; independent of the duct pressure

primaryFunction PrimaryFunction <global>

Primary function of building as US Energy Star key

primaryLoop Marker <global>

Pipework which circulates closest to the energy source. In a central plant, the primary loop indicates the pipes and equipment within the central plant. In context of heat exchangers between the primary and secondary loops, this tag indicates the side closest to the plant.

process Marker <global>

Industrial or HVAC process

propane Marker <global>

By-product of natural gas processing and petroleum refining (C₃H₈)

propaneHeating Marker <global>

Heating by the combustion of propane

protocol Marker <global>

Communication protocol used for devices on a network.

pump Marker <global>

Pump equipment or control point

purge Marker <global>

Associated with a cleaning process to remove contaminants. Most commonly it indicates purging water or air by using a filter or by letting out a certain amount of the substance at a high flow rate.

quality Marker <global>

Quantity measured against standard metric

rack Marker <global>

Enclosure or chassis used to mount computer and networking gear. Devices are mounted to rails of a standard width, typically 19 or 23 inches. Height is measured in rack units where one 1U is 1.75 inches. A full rack has a height of 42U. See Data Centers chapter.

radiantFloor Marker <global>

Heats a space using pipes or cables embedded beneath floor.

radiator Marker <global>

Heats a space using exposed pipes or coils. Hot water and steam radiators are often cast iron and installed directly in the space or along the baseboard. Electric radiators are typically installed on the baseboard.

rated Marker <global>

Data specified by a manufacturer or rating organization. Typically this information is from the equipment data plate or cut sheet. Also see design.

reactive Marker <global>

Relating to reactance

reciprocal Marker <global>

Piston compressor driven by a crankshaft

refrig Marker <global>

Fluid used in refrigeration and heat exchange. Refrigerants typically alternate between liquid and gas state.

refrigRef MultiRef <global>

Refrigerant flows from the referent to this entity

reheat Marker <global>

Command point for reheating process

return Marker <global>

Duct returning air back to equipment

roof Marker <global>

Envelope covering the top of a building

room Marker <global>

Enclosed room of a building

rotaryScrew Marker <global>

Rotary screw compression

router Marker <global>

Device used to route data packets

rtu Marker <global>

Roof Top Unit: A unitary AHU that is weatherized for outdoor use. See AHUs chapter.

run Marker <global>

Primary on/off point of an equip especially used with a vfd. Run is used with Bool points where true indicates on and false indicates off. When paired with cmd this is the commanded state of the equipment. When paired with sensor this is the actual status of the equip. If the equipment also defines an enable point then both must be commanded on in order to run the equipment.

scalar Obj <global>

Scalar is an atomic value kind

secondaryLoop Marker <global>

Pipework which circulates closest to the building or end use. In a central plant, the secondary loop indicates the pipes and equipment between the central plant and the building. In context of heat exchangers between the primary and secondary loops, this tag indicates the side closest to the building.

sensor Marker <global>

Point is a sensor, input, AI/BI. See Points chapter.

serialNumber Marker <global>

Manufacturer assigned unique, alphanumeric identifier for a specific asset.

series Marker <global>

Circuit with single path of flow

server Marker <global>

Hardware or software which provides services for other programs or devices.

serviceFactor Marker <global>

Ratio of the maximum continuous output capacity at which a machine or system may operate without damage to the machine or system’s nominal output capacity.

sf6 Marker <global>

Sulphur hexafluoride (SF₆)

sim Marker <global>

Simulation point. See Synthetics chapter.

simBaseline Marker <global>

See Synthetics chapter.

simModel Marker <global>

See Synthetics chapter.

simOperation Marker <global>

See Synthetics chapter.

simOptimum Marker <global>

See Synthetics chapter.

singleDuct Marker <global>

One single duct

singlePhase Marker <global>

Single-phase AC electricity. Power is provided by a single AC voltage source with a 2-wire connection.

site Marker <global>

Site is a geographic location of the built environment. Typically site maps to one building with its own unique street address. See Sites chapter.

siteMeter Marker <global>

Main meter for the associated site

siteRef Ref <of:Site, global>

Reference to site which contains the entity

smtp Marker <global>

Simple Mail Transfer Protocol for sending email

snmp Marker <global>

Simple Network Management Protocol for managing IP devices

solar Marker <global>

Relating to energy from the sun

solid Marker <global>

Substance with definite shape and volume

sox Marker <global>

Sedona Framework UDP based communication protocol

sp Marker <global>

Point is a setpoint, soft point, internal control variable, schedule. See Points chapter.

space Marker <global>

Space is a three-dimensional volume in the built environment. See Spaces chapter.

spaceRef Ref <of:Space, global>

Reference to space which contains this entity

speed Marker <global>

Distance per unit time

splitPhase Marker <global>

Split-phase AC electricity. Power is provided by a single AC voltage source with a 3-wire connection, consisting of two hot wires (phases), separated from each other by a 180-degree phase angle, and one neutral wire. Despite having two labeled phases, split-phase AC electricity is not a true two-phase system.

stage Number <global>

Stage number of staged equipment operation, such as coil or pump. The first stage is 1, second stage 2, etc. Used on boolean points that correspond to a specific stage.

standby Marker <global>

Readiness mode of a space

stateOfCharge Marker <global>

State of charge (SoC) of an electric battery. Uses a percentage in the range of 0% to 100%, where no charge is indicated as 0% and full charge is indicated as 100%.

steam Marker <global>

Water in its gas form

steamHeating Marker <global>

Heating using energy of steam

steamRef MultiRef <global>

Steam flows from the referent to this entity

submeter Marker <global>

Submeters measure usage of a sub-system or equipment within a site

submeterOf Ref <of:Meter, global>

Reference to parent meter which is immediately upstream of this meter

subterranean Marker <global>

Below the surface of the earth

switch Marker <global>

Device for toggling state or routing data

synthetic Marker <global>

Synthetic point with computed operational data. The computed data if classified as:

  • ml for machine learning
  • sim for simulation
  • computed as catch all for other computations

See Synthetics chapter.

syntheticModel Marker <global>

See Synthetics chapter.

syntheticModelRef Ref <of:SyntheticModel, global>

See Synthetics chapter.

system Marker <global>

Grouping of related equipment dedicated to a single application. See Systems chapter.

systemRef MultiRef <of:System, global>

Reference to system

tablet Marker <global>

Mobile device with touch screen for user input.

tank Marker <global>

Tank used to store a substance for temporary holding

temp Marker <global>

Temperature - measure of hot and cold

tertiaryLoop Marker <global>

Pipework which circulates within the building.

thd Marker <global>

Total harmonic distortion

thermal Marker <global>

Related to energy of heat

thermostat Marker <global>

Senses and controls temperature of space in HVAC system. Thermostats may provide an interface for setpoint control.

threePhase Marker <global>

Three-phase AC electricity. Power is provided by three AC voltage sources, each separated from the others by a 120-degree phase angle. May have a 4-wire connection with a neutral (Wye) or a 3-wire connection without a neutral (Delta).

total Marker <global>

Complete or absolute

tripleDuct Marker <global>

Three ducts: hotDeck, coldDeck, or neutralDeck

tvoc Marker <global>

Total volatile organic compound (TVOC).

twoPhase Marker <global>

Two-phase AC electricity. Power is provided by two AC voltage sources, separated from each other by a 90-degree phase angle. Two-phase systems are extremely rare in modern buildings; they have been replaced by modern threePhase systems.

tz TimeZone <global>

Timezone identifier from standard timezone database

unit Unit <global>

Unit identifier from standard unit database

unitVent Marker <global>

Unit Ventilator: An FCU that has direct access to outside air to provide the space with ventilation. See AHUs chapter.

unocc Marker <global>

Unoccupied mode of a space. See Zones chapter.

ups Marker <global>

Uninterruptible power supply

val Obj <global>

Data value type

valve Marker <global>

Valve equipment or control point

variableAirVolume Marker <global>

Delivers a variable volume of air flow. Most variable volume systems are powered by a VFD fan. However other techniques such as inlet vanes may be used in older systems.

vav Marker <global>

Variable air volume terminal unit. VAV systems use a constant air temperature with a variable air flow rate. See VAVs chapter.

vavZone Marker <global>

AHU supplies air to VAV terminal units

velocity Marker <global>

Speed in a given direction

ventilation Marker <global>

Duct to access fresh outside air only for ventilation, not economizing

version Version <global>

Version string formatted as decimal integers separated by a dot

vfd Marker <global>

Variable-frequency drive. See Motors chapter.

visibility Marker <global>

Distance at which light can be clearly discerned

volt Marker <global>

Electrical potential difference or electromotive force.

volume Marker <global>

Three dimensional space occupied by a substance

vrf Marker <global>

Variable refigerant flow. See VRF chapter.

warm Marker <global>

Relatively warm in comparison to another substance, without being actively heated. The substance can be used as a source of energy for a heating process, for example a warm water well in an ates system.

water Marker <global>

Water in its liquid form

waterCooling Marker <global>

Cooling using transfer of heat to water which is not explicitly chilled

weather Marker <global>

Associated with atmospheric air or phenomenon. See Weather chapter.

weatherCond Marker <global>

Enumeration of weather conditions

weatherStation Marker <global>

Logical weather station and its measurement points. See Weather chapter.

weatherStationRef Ref <of:WeatherStation, global>

Reference to weather station for to use this entity

weight Marker <global>

Weight of the asset

well Marker <global>

A well is a source of groundwater and potentially thermal energy. When used within an ATES system, the well facilitates thermal energy exchange with the ground warm and cool water sources. In this case, a well can be either a closed system that transports water through pipes in the ground, or an open system that pumps up and returns ground water.

wetBulb Marker <global>

Wet bulb air temperature. Temperature which the air would have if cooled to saturation by the evaporation of water into it.

width Marker <global>

Dimensional width of the asset

wikipedia Uri <global>

Hyperlink to the subject's page on Wikipedia

wind Marker <global>

Flow of air on surface of the Earth

wire Marker <global>

Cabling used to convey electricity or data

writable Marker <global>

Supports writing data

writeErr Str <global, transient>

Error description when writeStatus indicates error condition

writeLevel Number <global, transient>

Current priority level for writeVal as number between 1 and 17. The value 17 indicates the relinquish default value.

writeStatus WriteStatus <global, transient>

Current status of a writable point output

writeVal Obj <global, transient>

Current desired value to write to output. This is the current "winning" value of the priority array indicated by writeLevel. If this tag is missing then the winning value is null/auto.

xstr Obj <global>

Extended string - type name and string value encoding. See Kinds chapter.

yearBuilt Int <global>

Original year of construction as four digit year such as 1980

zigbee Marker <global>

Low power wireless communication protocol for home automation

zone Marker <global>

Related to spaces from a system perspective

zwave Marker <global>

Low power wireless communication protocol for home automation

Haxall 4.0.5 ∙ 24-Feb-2026 14:33 EST