def

marker

Marker labels a dict with typing information. See Kinds chatper.

meta

def marker
doc See above
docTaxonomy
lib ph

subtypes

absorption

Cooling process using energy from heat source such as hot water

    chiller-absorption
ac

Relating to alternating current electricity

accumulate

Accumulate the tag's value during inheritance and defx

active

Working, operative, effective

ahuZoneDeliveryType

AHU delivery method of conditioned air to the zone

    chilledBeamZone

AHU supplies air to chilled beam terminal units

    directZone

AHU supplies air directly to the zone

    multiZone

AHU discharge air is split into a duct per zone

    vavZone

AHU supplies air to VAV terminal units

airVolumeAdjustabilityType

Ability of air handling equip to adjust volume of air flow

    constantAirVolume

Delivers a constant volume of air flow

    variableAirVolume

Delivers a variable volume of air flow

angle

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

apparent

Perceived quantity

atmospheric

Related to the atmosphere of the earth

avg

Average

barometric

Relating atmospheric pressure

blowdown

Removal from container or pipe

centrifugal

Compression via a continuous flow of fluid through an impeller

    chiller-centrifugal
chilled

Substance is cooled using cooling process

chillerMechanismType

Primary mechanism of chiller

    chiller-absorption
    chiller-centrifugal
    chiller-reciprocal
    chiller-rotaryScrew
computed

Indicates a definition which is computed

condenser

Device or related to process of condensation

condenserLoopType

Open or closed loop for condenser working fluid

    condenserClosedLoop

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

    condenserOpenLoop

Uses working fluid itself for evaporation into the atmosphere

controls

Associated with the control system for an industrial process

cool

Point used to command equipment cooling

cooling

Cooling mode or process

coolingOnly

Device without heating

cur

Supports current value

current

Movement of fluid or electricity

damper

Damper equipment or control point

dc

Relating to direct current electricity

delta

Differential of fluid between entering and leaving sensors

demand

Rate required for a process

dessicantDehumidifier

Decreases humidity from air using a substance which absorbs moisture

diverting

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

docSection

This tag is documented with its own section

docTaxonomy

Generate a taxonomy tree for this term in the documentation index

domestic

For human use

ductArea

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

ductConfigType

Ductwork configuration

    dualDuct

Two ducts

    singleDuct

One single duct

    tripleDuct

Three ducts

ductDeckType

Cold, hot, or neutral deck

    coldDeck

Duct carries air for cooling

    hotDeck

Duct carries air for heating

    neutralDeck

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

ductSectionType

Equipment section of ductwork

    discharge

Duct for air leaving an equipment

    economizer

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

    exhaust

Duct used to expel air back outside

    flue

Duct for exhausting combustion

    inlet

Duct with air entering an equipment

    mixed

Duct where fresh outside air and return air is mixed together

    outside

Duct to access fresh outside air for both ventilation and economizer

    return

Duct returning air back to equipment

    ventilation

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

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"

entity

Top-level dicts with a unique identifier

    device

Microprocessor based hardware device

        controller

Microprocessor based device used in a control system

        networking-device

Microprocessor device used to establish networks

            networking-router

Networking device used to route data between different networks

            networking-switch

Networking device used to connect devices on the same network

        phone

Telephone used for voice telecommunication

            mobile-phone

Cellular phone providing telecommunication over radio links

        server

General purpose computer

        tablet

Mobile device with touch screen for user input

    equip

Equipment asset

        actuator

Equipment to move or control a mechanism

            damper-actuator

Actuator to regulate the flow of air

            valve-actuator

Actuator to regulate the flow of fluid

        airHandlingEquip

HVAC equipment that conditions and delivers air via one or more fans

            ahu

Air Handling Unit

                doas

Dedicated Outside Air System

                    mau

Makeup Air Unit

                rtu

Roof Top Unit

            fcu

Fan Coil Unit

                crac

Computer Room Air Conditioner

                unitVent

Unit Ventilator

            heatPump

Heat pump

        airTerminalUnit

Equipment in air distribution systems which terminate at the space

            cav

Constant air volume terminal unit

            vav

Variable air volume terminal unit

                coolingOnly-vav

Cooling only VAV without fan or reheat

                fanPowered-vav

VAV contains a fan with reheat

        battery

Equipment used to store electric energy

        boiler

Equipment to generate hot water or steam for heating

            hot-water-boiler

Boiler which outputs hot water

            steam-boiler

Boiler which outputs steam

        chiller

Equipment to remove heat from a liquid

        conduit

Duct, pipe, or cable to convey a substance or phenomenon

            duct

Conduit used to convey air for HVAC

            pipe

Conduit used to convey a fluid

            wire

Cabling used to convey electricity or data

        coolingTower

Equipment to transfer waste heat into the atmosphere

        fumeHood

Ventilation equipment to limit exposure to hazardous fumes

        heatExchanger

Equipment to transfer heat between two working fluids

            coil

Heat exchanger used to heat or cool air

                coolingCoil

Coil used to cool air

                heatingCoil

Coil used to heat air

        humidifier-equip

Equipment which adds moisture to air to increase humidity

        luminaire

Light fixture using electricity to provide illumination

        meter

Equipment to meter a substance or phenomenon

            elec-meter

Electricity meter

                ac-elec-meter

AC Electricity meter

                dc-elec-meter

DC Electricity meter

            flow-meter

Meter to measure flow rate and total volume of fluid

            thermal-meter

Meter to measure energy transfer via fluid

        motor

Equipment that converts electrical energy into mechanical energy

            fan-motor

Motor used with a fan to create air flow

            pump-motor

Motor used with a pump to move fluid

            vfd

Motor with variable frequency drive

        panel

Enclosure for electrical and control equipment

            controls-panel

Panel housing controllers and networking gear

            elec-panel

Physical housing for electrical circuits, fuses, and breakers

        plant

Central plant used to generate a substance for a process

            chilled-water-plant

Plant used to generate chilled water for cooling

            hot-water-plant

Plant used to generate hot water for heating

            steam-plant

Plant used to generate steam for heating

        rack

Enclosure or chassis used to mount computer and networking gear

        radiantEquip

HVAC equipment that conditions a space without forced air

            chilledBeam

Conditions a space using a heat exchanger integrated into the ceiling

            radiantFloor

Heats a space using pipes or cables embedded beneath floor

            radiator

Heats a space using exposed pipes or coils

        tank

Tank used to store a substance for temporary holding

        thermostat

Senses and controls temperature of space in HVAC system

        verticalTransport

Equipment to move humans and materials

            elevator

Enclosure used to move people between floors

            escalator

Moving staircase used to move people between floors

            movingWalkway

Conveyor to move people across a horizontal or inclined plane

    network

Logical communications network between two or more devices

    point

Data point such as a sensor or actuator

        cur-point

Point with support to report a "real-time" current value

        his-point

Historized point with a history log of timestamp/value pairs

        weather-point

Weather station sensor point

        writable-point

Point with writable output using 16-level priority array

    pointGroup

Grouping of children points used by spaces and equipment

        hvacZonePoints

Entity with logical grouping of zone HVAC air points

            hvac-zone-space

Zone related to conditioning of a space's air temperature and quality

            thermostat

Senses and controls temperature of space in HVAC system

        lightingZonePoints

Entity with logical grouping lighting points

            lighting-zone-space

Zone related to lighting system

            luminaire

Light fixture using electricity to provide illumination

    protocol

Communication protocol used for devices on a network

        bacnet

ASHRAE building automation and control protocol

        bluetooth

Short range wireless communication protocol

        coap

Constrained Application Protocol

        dali

Digital Addressable Lighting Interface protocol for lighting

        ftp

File Transfer Protocol

        haystack

Haystack HTTP protocol for exchanging tagged data

        http

Hypertext Transfer Protocol which is foundation of the web

        imap

Internet Message Access Protocol for retreiving email

        knx

KNX protocol commonly used for lighting systems

        modbus

Register based communication protocol used with industrial devices

        mqtt

Message Queuing Telemetry Transport publish/subscribe protocol

        obix

XML based Open Building Information eXchange protocol

        pop3

Post Office Protocol version 3 for retreiving email

        smtp

Simple Mail Transfer Protocol for sending email

        snmp

Simple Network Management Protocol for managing IP devices

        sox

Sedona Framework UDP based communication protocol

        thread

Low power wireless IoT protocol

        zigbee

Low power wireless communication protocol for home automation

        zwave

Low power wireless communication protocol for home automation

    site

Site is a geographic location of the built environment

    space

Space is a three-dimensional volume in the built environment

        dataCenter

Space used to house computer and networking gear

        floor

Storey of a building

            ground-floor

Floor at ground level

            roof-floor

The roof floor is the topmost level of a building

            subterranean-floor

Floor below ground level

        room

Enclosed room of a building

        zone-space

Space associated with a specific system

            hvac-zone-space

Zone related to conditioning of a space's air temperature and quality

            lighting-zone-space

Zone related to lighting system

    weatherStation

Logical weather station and its measurement points

evaporator

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

export

Supplied out of a system

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

filter

Related to an air or fluid filter

flux

Measurement through a given surface

freezeStat

A boolean point of an ahu indicating a freezing condition

geoPlace

Geographic place

    site

Site is a geographic location of the built environment

    weatherStation

Logical weather station and its measurement points

ground

Related to the surface of the earth

heat

Point used to command equipment heating

heatWheel

Boolean point indicating command state of AHU's heat wheel

heating

Heating mode or process

his

Supports historization of data

hisTotalized

Indicates values which are a continuous stream of totalization

hot

Having high degree of heat

humidifier

Adding moisture to air

hvac

Heating, ventilation, and air conditioning

imbalance

Lacking balance

import

Received into a system

input

Entity inputs a substance which flows from another entity

    air-input

Entity inputs air which flows from another entity

        airCooling

Cooling by dissipating heat into the surrounding air

        airTerminalUnit

Equipment in air distribution systems which terminate at the space

            cav

Constant air volume terminal unit

            vav

Variable air volume terminal unit

                coolingOnly-vav

Cooling only VAV without fan or reheat

                fanPowered-vav

VAV contains a fan with reheat

        hvac-zone-space

Zone related to conditioning of a space's air temperature and quality

    blowdown-water-input

Entity inputs blowdown water which flows from another entity

    chilled-water-input

Entity inputs chilled water which flows from another entity

        chilledWaterCooling

Cooling using transfer of heat to chilled water

    condensate-input

Entity inputs condensate which flows from another entity

    condenser-water-input

Entity inputs condenser water which flows from another entity

    domestic-water-input

Entity inputs domestic water which flows from another entity

    elec-input

Entity inputs electricity which flows from another entity

        elec-meter

Electricity meter

            ac-elec-meter

AC Electricity meter

            dc-elec-meter

DC Electricity meter

        elecHeating

Heating by the conversion of electrical energy

    fuelOil-input

Entity inputs fuel oil which flows from another entity

        fuelOilHeating

Heating by the combustion of fuel oil

    gasoline-input

Entity inputs gasoline which flows from another entity

    hot-water-input

Entity inputs hot water which flows from another entity

        hotWaterHeating

Heating using energy of hot water

    makeup-water-input

Entity inputs makeup water which flows from another entity

    naturalGas-input

Entity inputs natural gas which flows from another entity

        naturalGasHeating

Heating by the combustion of natural gas

    refrig-input

Entity inputs refrigerant which flows from another entity

    steam-input

Entity inputs steam which flows from another entity

        steamHeating

Heating using energy of steam

intensity

Measure of an electromagnetic field

isolation

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

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%"

luminous

Relating to light as perceived by the eye

magnitude

Size or extent

makeup

Restore soemthing missed or lost

mandatory

Requires that the marker be applied to dicts which use the marker's subtypes

meterScopeType

Classifies a meter as a main site meter or submeter

    siteMeter

Main meter for the associated site

    submeter

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

mixing

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

mobile

Relating to mobile phones, handheld computers, and similar technology

net

Difference between import and export

networking

Related to data communication networks

notInherited

Marker applied to a def to indicate that is not inherited into subtype definitions

occ

Occupied mode of a space

occupancy

Number of occupants in a space

occupants

People who use the built ennvironment

occupied

Setpoint or sensor indicating occupancy of a space

openEnum

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

output

Entity outputs a substance with flows to other entities

    air-output

Entity outputs air to other entities

        airHandlingEquip

HVAC equipment that conditions and delivers air via one or more fans

            ahu

Air Handling Unit

                doas

Dedicated Outside Air System

                    mau

Makeup Air Unit

                rtu

Roof Top Unit

            fcu

Fan Coil Unit

                crac

Computer Room Air Conditioner

                unitVent

Unit Ventilator

            heatPump

Heat pump

        airTerminalUnit

Equipment in air distribution systems which terminate at the space

            cav

Constant air volume terminal unit

            vav

Variable air volume terminal unit

                coolingOnly-vav

Cooling only VAV without fan or reheat

                fanPowered-vav

VAV contains a fan with reheat

    blowdown-water-output

Entity outputs blowdown water to other entities

    chilled-water-output

Entity outputs chilled water to other entities

        chilled-water-plant

Plant used to generate chilled water for cooling

    condensate-output

Entity outputs condensate to other entities

    condenser-water-output

Entity outputs condenser water to other entities

    domestic-water-output

Entity outputs domestic water to other entities

    elec-output

Entity outputs electricity to other entities

        elec-meter

Electricity meter

            ac-elec-meter

AC Electricity meter

            dc-elec-meter

DC Electricity meter

    fuelOil-output

Entity outputs fuel oil to other entities

    gasoline-output

Entity outputs gasoline to other entities

    hot-water-output

Entity outputs hot water to other entities

        hot-water-boiler

Boiler which outputs hot water

        hot-water-plant

Plant used to generate hot water for heating

    makeup-water-output

Entity outputs makeup water to other entities

    naturalGas-output

Entity outputs natural gas to other entities

    refrig-output

Entity outputs refrigerant to other entities

    steam-output

Entity outputs steam to other entities

        steam-boiler

Boiler which outputs steam

        steam-plant

Plant used to generate steam for heating

parallel

Circuit with multiple paths of flow

perimeterHeat

Auxiliary heating points associated with a vav

phenomenon

Aspect of scientific interest with measurable quantities

    drive

Related to the drive control of a motor

    elec

Associated with electricity, electric charge

        ac-elec

Alternating current electricity

        dc-elec

Direct current electricity

    light

Electromagnetic radiation in the visibile spectrum

    solar

Relating to energy from the sun

    state

Software, hardware, or process control status

    substance

Matter in one the three states solid, liquid, or gas

        fluid

Liquid or gas

            gas

Substance with neither definite volume nor shape

                air

The mixture of gases which surrounds the earth

                naturalGas

Fossil fuel energy source consisting largely of methane and other hydrocarbons

                steam

Water in its gas form

            liquid

Substance with definite volume but takes the shape of its container

                condensate

Liquid phase produced by the condensation of steam or other gas

                fuelOil

Petroleum based oil burned for energy

                gasoline

Petroleum derived liquid used as a fuel source

                water

Water in its liquid form

                    blowdown-water

Water expelled from a system to remove mineral build up

                    chilled-water

Water used for HVAC cooling

                    condenser-water

Water used used to remove heat through condensation

                    domestic-water

Tap water for drinking, washing, cooking, and flushing of toliets

                    hot-water

Hot water used for HVAC heating or supply to hot taps

                    makeup-water

Water used used to makeup water loss through leaks, evaporation, or blowdown

            refrig

Fluid used in refrigeration and heat exchange

        solid

Substance with definite shape and volume

            ice

Water in its solid form

    weather

Associated with atmospheric air or phenomenon

    wind

Flow of air on surface of the Earth

pipeSectionType

Equipment section of piping

    bypass

Pipe used to bypass an equipment

    circ

Pipe used to circulate fluid through an equipment or system

    entering

Pipe conveys fluid into an equipment

    header

Pipe used as central connection or manifold for other piping runs

    leaving

Pipe conveys fluid out of an equipment

plantLoopType

Plant piping loop

    plantPrimaryLoop

Pipework which circulates within the central plant

    plantSecondaryLoop

Pipework which circulates between the central plant and building

    plantTertiaryLoop

Pipework which circulates within the building

pointFunctionType

Classifies the point as a sensor, command, or setpoint

    cmd

Point is a command, actuator, AO/BO

    sensor

Point is a sensor, input, AI/BI

    sp

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

process

Industrial or HVAC process

    coolingProcessType

Processed used to cool a substance

        airCooling

Cooling by dissipating heat into the surrounding air

        chilledWaterCooling

Cooling using transfer of heat to chilled water

        condenserCooling

Removal of heat through the process of water condensation

        dxCooling

Cooling using direct expansion of a refrigerant vapor

        waterCooling

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

    heatingProcessType

Processed used to heat a substance

        dxHeating

Heating using direct expansion of a refrigerant vapor

        elecHeating

Heating by the conversion of electrical energy

        fuelOilHeating

Heating by the combustion of fuel oil

        hotWaterHeating

Heating using energy of hot water

        naturalGasHeating

Heating by the combustion of natural gas

        steamHeating

Heating using energy of steam

pump

Pump equipment or control point

quality

Quantity measured against standard metric

quantity

Measurable property of a substance or phenomenon

    airQuality

Measurement of contaminants in the air

        co

Carbon monoxide level

        co2

Carbon dioxide level

        pm10

Particulate Matter 10

        pm25

Particulate Matter 2.5

        tvoc

Total volatile organic compound (TVOC)

    apparent-energy

Integral of apparent-power over time

    apparent-power

Apparent power is perceived magnitude of power due to the combination of active and reactive power

    cloudage

Percentage of sky obscurred by clouds

    current-angle

AC current phase angle

    current-imbalance

Current phase imbalance in a multiphase AC system

    current-thd

Total harmonic current distortion

    daytime

Time between sunrise and sunset

    dewPoint

Dew point temperature at which water vapor will form dew

    direction

Compass direction measured in degrees

        wind-direction

Compass direction from which wind originates

    drive-freq

Motor frequency measured in "Hz"

    drive-speed

Motor speed measured in "%"

    elec-current

Electrical current

        current-magnitude

Magnitude of electrical current

    elec-volt

Electrical voltage, potential difference

        volt-magnitude

Magnitude of electrical voltage

    energy

Measure of ability to do work

        elec-energy

Electrical energy consumed

            active-energy

Integral of active-power over time

    feelsLike

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

    flow

Measure of volumetric flow of fluid

    freq

Occurrences per unit time

        ac-freq

Frequency of alternating current

    humidity

Percent relative humidity

    illuminance

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

    irradiance

Energy received at a surface by area

        solar-irradiance

Energy received on surface of the earth from the sun

    level

Range from 0% to 100%

        light-level

Sensed or controlled dimming level of electrical lighting

    luminance

Energy of light in a given direction

    luminous-flux

Total perceived light in all directions

    luminous-intensity

Perceived light in a particular direction per unit solid angle

    pf

Electrical power factor

    power

Energy consumed per unit time

        elec-power

Electrical energy consumed per unit time

            active-power

Active power or real power

                elec-demand

Active power averaged over a rolling interval

    precipitation

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

    pressure

Measure of force applied

        atmospheric-pressure

Barometric pressure exerted by the weight of the atmosphere

    reactive-energy

Integral of reactive-power over time

    reactive-power

Reactive power or imaginary power

    speed

Distance per unit time

        wind-speed

Wind flow speed

    stateQuantity

What is sensed or controlled of software, hardware, or process state

        enable

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

        run

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

    temp

Temperature - measure of hot and cold

        air-temp

Dry bulb temperature

    visibility

Distance at which light can be clearly discerned

    volt-angle

AC voltage phase angle

    volt-imbalance

AC voltage phase imbalance

    volume

Three dimensional space occupied by a substance

    weatherCond

Enumeration of weather conditions

    wetBulb

Wet bulb air temperature

reactive

Relating to reactance

reciprocal

Piston compressor driven by a crankshaft

    chiller-reciprocal
reheat

Command point for reheats process

roof

Envelope covering the top of a building

rotaryScrew

Rotary screw compression

    chiller-rotaryScrew
router

Device used to route data packets

series

Circuit with single path of flow

standby

Readiness mode of a space

subterranean

Below the surface of the earth

switch

Device for toggling state or routing data

thd

Total harmonic distortion

thermal

Related to energy of heat

total

Complete or absolute

transient

Indicates a value tag which should not be persisted

transitive

This marker is applied to a relationship to indicate it is transitive

unocc

Unoccupied mode of a space

valve

Valve equipment or control point

vavAirCircuitType

How does the VAV pull in air

    vav-parallel

VAV pulls air from outside the primary air flow

    vav-series

VAV pulls air from the primary air flow

vavModulationType

How does VAV modulate the temp based on duct pressure

    pressureDependent

VAV damper modulates to control space temp

    pressureIndependent

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

volt

Electrical voltage, potential difference

writable

Supports writing data

zone

Related to spaces from a system perspective