def

marker

Marker labels a dict with typing information

meta

def marker
doc See above
lib ph

subtypes

absorption

Cooling process using energy from heat source such as hot water

    chiller-absorption

Cooling process using energy from heat source such as hot water

ac

Relating to alternating current electricity

active

Working, operative, effective

ahuZoneDelivery

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

angle

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

apparent

Perceived quantity

atmospheric

Related to the atmosphere of the earth

barometric

Relating atmospheric pressure

blowdown

Removal from container or pipe

centrifugal

Compression via a continuous flow of fluid through an impeller

    chiller-centrifugal

Compression via a continuous flow of fluid through an impeller

chilled

Cooled

chillerMechanism

Primary mechanism of chiller

    chiller-absorption

Cooling process using energy from heat source such as hot water

    chiller-centrifugal

Compression via a continuous flow of fluid through an impeller

    chiller-reciprocal

Piston compressor driven by a crankshaft

    chiller-rotaryScrew

Rotary screw compression

condenser

Device or related to process of condensation

cooling

Associated with a cooling process

coolingLoop

Open or closed loop

    closedLoop

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

    openLoop

Uses working fluid itself for evaporation into the atmosphere

coolingOnly

Device without heating

cur

Related to a current value

current

Movement of fluid or electricity

dc

Relating to direct current electricity

domestic

For human use

ductConfig

Ductwork configuration

    dualDuct

Two ducts

    singleDuct

One single duct

    tripleDuct

Three ducts

ductDeck

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

ductSection

Equipment section of ductwork

    discharge

Duct with air leaving an equipment

    exhaust

Duct used to expel air back outside

    inlet

Duct with air entering an equipment

    mixed

Duct where fresh outside and return air is mixed together

    outside

Duct to access fresh outside air

    return

Duct returning air back to equipment

entity

Top-level dicts with a unique identifier

    equip

Equipment asset

        ahu

Air handling unit

        battery

Device used to store electric energy

        boiler

Boilers generate hot water or steam for heating

            hot-water-boiler

Boiler which outputs hot water

            steam-boiler

Boiler which outputs steam

        chiller

Device to remove heat via a vapor compression or an absorption refrigeration cycle

        conduit

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

            duct

Conduit used to convey air for HVAC

                s-duct

Duct in equipment section s

            pipe

Conduit used to convey a fluid

                f-pipe

Pipe which conveys fluid f

                    s-f-pipe

Pipe in equipment section s which conveys fluid f

                s-pipe

Pipe in equipment section s

                    s-f-pipe

Pipe in equipment section s which conveys fluid f

            wire

Cabling used to convey electricity

        coolingTower

Device used to transfer waste heat into the atmosphere

        heatExchanger

Device used to transfer heat between two fluids

        meter

Equipment to meter a substance or electricity

            elec-meter

Electricity meter

            flow-meter

Meter to measure flow rate and total volume of fluid

                f-flow-meter

Meter to measure flow rate and total volume of fluid f

            thermal-meter

Meter to measure energy transfer via fluid

                f-thermal-meter

Meter to measure energy transfer via fluid f

        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

        tank

Tank used to store a substance for temporary holding

            f-tank

Tank which stores fluid f

        vav

Variable air volume terminal unit

            coolingOnly-vav

Cooling only VAV without fan or reheat

            fanPowered-vav

VAV contains a fan with reheat

        weatherStation

Weather station

    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

        p-point

Point which measures or controls phenomenon p

            p-q-point

Point which measures or controls phenomenon p and quantity q

        q-point

Point which measures or controls quantity q

            p-q-point

Point which measures or controls phenomenon p and quantity q

        writable-point

Point with writable output using 16-level priority array

    site

Site is a geographic location of the built environment

        building

Site which is a building

        weatherStation

Weather station

    space

Space is a three-dimensional volume in the built environment

        building

Site which is a building

        floor

Storey of a building

        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

fanPowered

Device with a fan

geoPlace

Geographic place

    site

Site is a geographic location of the built environment

        building

Site which is a building

        weatherStation

Weather station

heating

Associated with a heating process

his

Related to historization of data

hisTotalized

Indicates values which are a continuous stream of totalization

hot

Having high degree of heat

hvac

Heating, ventilation, and air conditioning

imbalance

Lacking balance

lighting

Systems associated with illumination in the built environment

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

meterSphere

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

mixin

Marker added to a def to indicate inclusive subtyping

notInherited

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

parallel

Circuit with multiple paths of flow

phenomenon

Aspect of scientific interest with measurable quantities

    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

        weather

Associated with atmospheric air or phenomenon

    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

                    weather

Associated with atmospheric air or phenomenon

                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

                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

    wind

Flow of air on surface of the Earth

        weather

Associated with atmospheric air or phenomenon

pipeSection

Equipment section of piping

    bypass

Pipe used to bypass an equipment

    entering

Pipe conveys fluid into an equipment

    leaving

Pipe conveys fluid out of an equipment

pointType

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

    cooling-process

Processed used to cool a substance

        ahuCoolingProcess

Method used to cool air for conditioning spaces

            ahu-chilledWaterCooling

Cooling using transfer of heat to chilled water

            ahu-dxCooling

Cooling using refrigerant vapar expansion and compression

        airCooling

Cooling by dissipating heat into the surrounding air

            chiller-airCooling

Cooling by dissipating heat into the surrounding air

        chilledWaterCooling

Cooling using transfer of heat to chilled water

            ahu-chilledWaterCooling

Cooling using transfer of heat to chilled water

        chillerCoolingProcess

Processed used to remove heat from refrigerant

            chiller-airCooling

Cooling by dissipating heat into the surrounding air

            chiller-condenserCooling

Removal of heat through the process of water condensation

        condenserCooling

Removal of heat through the process of water condensation

            chiller-condenserCooling

Removal of heat through the process of water condensation

        dxCooling

Cooling using refrigerant vapar expansion and compression

            ahu-dxCooling

Cooling using refrigerant vapar expansion and compression

    heating-process

Processed used to heat a substance

        ahuHeatingProcess

Method used to heat air for conditioning spaces

            ahu-elecHeating

Heating by the conversion of electrical energy

            ahu-gasHeating

Heating by the combustion of natural gas

            ahu-hotWaterHeating

Heating using energy of hot water

            ahu-steamHeating

Heating using energy of steam

        boilerHeatingProcess

Method used to heat water in a boiler

            boiler-gasHeating

Heating by the combustion of natural gas

            boiler-oilHeating

Heating by the combustion of fuel oil

        elecHeating

Heating by the conversion of electrical energy

            ahu-elecHeating

Heating by the conversion of electrical energy

            vav-elecHeating

Heating by the conversion of electrical energy

        gasHeating

Heating by the combustion of natural gas

            ahu-gasHeating

Heating by the combustion of natural gas

            boiler-gasHeating

Heating by the combustion of natural gas

        hotWaterHeating

Heating using energy of hot water

            ahu-hotWaterHeating

Heating using energy of hot water

            vav-hotWaterHeating

Heating using energy of hot water

        oilHeating

Heating by the combustion of fuel oil

            boiler-oilHeating

Heating by the combustion of fuel oil

        steamHeating

Heating using energy of steam

            ahu-steamHeating

Heating using energy of steam

            vav-steamHeating

Heating using energy of steam

        vavReheat

Method used by VAV to reheat air

            vav-elecHeating

Heating by the conversion of electrical energy

            vav-hotWaterHeating

Heating using energy of hot water

            vav-steamHeating

Heating using energy of steam

quality

Quantity measured against standard metric

quantity

Measurable property of a substance or phenomenon

    airQuality

Measurement of contaminants in the air

        co2

Carbon dioxide level

        pm10

Particulate Matter 10

        pm25

Particulate Matter 2.5

        tvoc

Total volatile organic compound (TVOC)

    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

    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

    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

    irradiance

Energy received at a surface by area

        solar-irradiance

Energy received on surface of the earth from the sun

    level

Fill level of a vessel containing a fluid where 0% is empty and 100% if filled

    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

    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-power

Reactive power or imaginary power

    speed

Distance per unit time

        wind-speed

Wind flow speed

    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

    weatherCond

Enumeration of weather conditions

    webBulb

Wet bulb air temperature

reactive

Relating to reactance

reciprocal

Piston compressor driven by a crankshaft

    chiller-reciprocal

Piston compressor driven by a crankshaft

rotaryScrew

Rotary screw compression

    chiller-rotaryScrew

Rotary screw compression

series

Circuit with single path of flow

thd

Total harmonic distortion

thermal

Related to energy of heat

transient

Indicates a value tag which should not be persisted

transitive

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

vavAirCircuit

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

vavModulation

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

Related to data which can written

zone

Related to spaces from a system perspective