def

marker

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

meta

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

accumulate

Accumulate the tag's value during inheritance and defx

active

Working, operative, effective

admin

Requires admin permission

alarm

Notification of a condition which requires attention

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

Compression via a continuous flow of fluid through an impeller

chilled

Substance is cooled using cooling process

choice

Choice specifies an exclusive marker selection

    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

    airVolumeAdjustability

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

    atesDesign

Design type of the ATES underground 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

    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

    condenserLoop

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

    coolingProcess

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

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

    heatingProcess

Processed used to heat a substance

        biomassHeating

Heating by the combustion of biomass

        coalHeating

Heating by the combustion of coal

        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

        propaneHeating

Heating by the combustion of propane

        steamHeating

Heating using energy of steam

    meterScope

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

    observes

Observable subscription - see docs

    pfScope

Power factor scope

        pfDisplacement

Displacement power factor, which excludes effects of harmonic distortion

        pfDistortion

Distortion power factor

        pfTrue

True power factor, which includes effects of harmonic distortion

    phaseCount

Number of phases for an AC electrical power system or connected equipment

        singlePhase

Single-phase AC electrical power

        threePhase

Three-phase AC electrical power

    pipeFluid

Type of fluid conveyed by piping

    pipeSection

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

    plantLoop

Plant piping loop

        primaryLoop

Pipework which circulates closest to the energy source

        secondaryLoop

Pipework which circulates closest to the building or end use

        tertiaryLoop

Pipework which circulates within the building

    pointFunction

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

        synthetic

Synthetic point with computed operational data

            computed

Computed point

            ml

Machine learning point

            sim

Simulation point

    pointQuantity

Quantity the point senses or controls

    pointSubject

What the point senses or controls

    simScenario

See Synthetics chapter

        simBaseline

See Synthetics chapter

        simOperation

See Synthetics chapter

        simOptimum

See Synthetics chapter

    tankSubstance

Substance stored by a tank

    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

co2e

Carbon dioxide equivalent

cold

Having low degree of heat

compressor

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

computedFromReciprocal

Indicates a relationship that is computed from its reciprocal

condenser

Device or related to process of condensation

conditioning

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

controls

Associated with the control system for an industrial process

cool

Associted with low temperature or cooling processes

cooling

Cooling mode or process

coolingOnly

Equipment without heating

cur

Supports current value

curTracksWrite

When configured curVal automatically tracks changes to writeVal and curStatus is set to "ok"

current

Movement of fluid or electricity

damper

Damper equipment or control point

dc

Relating to direct current 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

disableOverridableChecks

Disables function overridable checking

disabled

Indicates the entity is in a disabled state

dispenser

Equipment that releases a specific amount of a substance

diverting

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

docAssociations

Generate a section in the docs for this association

docTaxonomy

Generate a taxonomy tree for this term in the documentationindex

domestic

For human use

ductArea

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

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"

enable

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

entity

Top-level dicts with a unique identifier

    conn

Connector for communication to a remote system

        ecobeeConn

Ecobee connector

        haystackConn

Haystack connector to a Haystack REST API server

        modbusConn

Modbus connector

        mqttConn

MQTT connector to an MQTT Broker

        nestConn

Google Nest connector

        obixConn

Connector to an oBIX HTTP server

        sedonaConn

Sedona Sox connector to a remote device

        sqlConn

SQL connector to a relational database using JDBC

    connTuning

Marker applied to a rec which defines a tuning configuration

    device

Microprocessor based hardware device

        computer

General purpose computer

            laptop

Portable laptop computer

            server-computer

General purpose computer used as a server

        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

        tablet

Mobile device with touch screen for user input

    dockerContainer

Docker container

    dockerImage

Docker image

    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

                vrf-indoorUnit-fcu

Indoor unit fan coil unit in a VRF system

        airTerminalUnit

Equipment in air distribution systems which terminate at the space

            cav

Constant air volume terminal unit

            vav

Variable air volume terminal unit

        ates

Aquifer Thermal Energy Storage system

        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

        cable

An assembly of one or more insulated conductors

        chiller

Equipment to remove heat from a liquid

        circuit

Electrical circuit and its associated components such as breakers

        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

        evse-equip

Equipment that supports the delivery of electricity to charging inlets located on EVs

            evse-cable

The electrical cable between an evse-port and an EV charging inlet on a vehicle

            evse-dispenser

Equipment that dispenses electricity to an EV

            evse-port

An EVSE port delivers electricity to a single EV charging inlet at a time

                ac-evse-port

An AC EVSE port delivers ac electricity to a single EV charging inlet at a time

                dc-evse-port

A DC EVSE port delivers dc electricity to a single EV charging inlet at a time

            evse-powerConverter

A power converter that has a dc electrical output applied to a dc-evse-port

        flowInverter

System to change direction of substance flow

        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

                evse-port

An EVSE port delivers electricity to a single EV charging inlet at a time

                    ac-evse-port

An AC EVSE port delivers ac electricity to a single EV charging inlet at a time

                    dc-evse-port

A DC EVSE port delivers dc electricity to a single EV charging inlet at a time

            flow-meter

Meter to measure flow rate and total volume of 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

        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

            vrf-refrig-plant

Group of outdoor units in a VRF system

        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

        ups

Uninterruptible power supply

        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

        vrf-equip

Equipment used in VRF systems

            branchSelector

Branch selector used for heat recovery in a VRF system

            vrf-indoorUnit

Indoor unit in a VRF system

                vrf-indoorUnit-fcu

Indoor unit fan coil unit in a VRF system

            vrf-outdoorUnit

Outdoor unit with one or more compressors in a VRF system

        well

A well is a source of groundwater and potentially thermal energy

    evseSession

Describes an event during which an evse-port can deliver power to an EV

    mlVar

Machine learning variable representing both model inputs and outputs

    network

Logical communications network between two or more devices

    point

Data point such as a sensor or actuator

        connPoint

Point associated with a connector for data synchronization with a remote system

            ecobeePoint

Point which synchronizes data via an Ecobee connector

            haystackPoint

Point which synchronizes data via a Haystack connector

            modbusPoint

Point which synchronizes data via a Haystack connector

            mqttPoint

Point which synchronizes data via a MQTT connector

            nestPoint

Point which synchronizes data via a Nest connector

            obixPoint

Point which synchronizes data via a oBIX connector

            sedonaPoint

Point which synchronizes data via a Sedona connector

            sqlPoint

Point which synchronizes data via a SQL connector

        cur-point

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

        his-point

Historized point with a history log of timestamp/value pairs

        synthetic-point

See Synthetics chapter

            computed-point

See Synthetics chapter

            ml-point

See Synthetics chapter

            sim-point

See Synthetics chapter

        weather-point

Weather station observation point

        writable-point

Point with writable output using 16-level priority array

    pointGroup

Grouping of children points used by spaces and equipment

        airQualityZonePoints

Entity with logical grouping of zone air quality points

            hvac-zone-space

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

        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 of lighting points

            lighting-zone-space

Zone related to lighting system

            luminaire

Light fixture using electricity to provide illumination

    projMeta

Singleton record for project meta data

    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

    syntheticModel

See Synthetics chapter

        computedModel

See Synthetics chapter

        mlModel

See Synthetics chapter

        simModel

See Synthetics chapter

    system

Grouping of related equipment dedicated to a single application

        air-system

System for moving air to maintain indoor thermal comfort and/or air quality

            air-conditioning-system

System for air treatment to control its temperature, humidity, cleanliness, and distribution to meet the requirements of a conditioned space

            air-exhaust-system

System consisting of one or more fans that remove air from the building

            air-ventilation-system

System that supplies or removes air by natural or mechanical means to or from any space in order to provide outdoor air to the space

        elec-system

System that generates, converts, distributes, and/or stores electricity

            evse-system

A system that supplies electricity to EVSE assembly equipment and its auxiliary loads

            lighting-system

System designed to provide lighting

        refrig-system

Refrigerant distribution to fulfill all or parts of a refrigeration cycle

            vrf-system

Variable refigerant flow system

                vrf-coolingOnly-system

Cooling only VRF system can only cool

                vrf-heatPump-system

Heat pump VRF system can either heat, or cool, but not at the same time

                vrf-heatRecovery-system

Heat recovery VRF system can operate cooling and heating by each indoor unit independently, at the same time

        water-system

System that supplies or collects potable or non-potable water in any state

            chilled-water-system

System that circulates water in its liquid state below ambient temperature for cooling a space or process

            condenser-water-system

System that circulates water in its liquid state for rejecting heat from a space or process

            domestic-water-system

System that circulates potable water in its liquid state for purposes other than space conditioning and process requirements

                domestic-cold-water-system

System that circulates potable cold water in its liquid state for purposes other than space cooling and process requirements

                domestic-hot-water-system

System that circulates potable hot water in its liquid state for purposes other than space heating and process requirements

            hot-water-system

System that circulates water in its liquid state for heating a space or process

            steam-system

System that circulates water in its vapor state for heating a space or process

    task

Dispatch task function

    weatherStation

Logical weather station and its measurement points

enumMeta

Project singleton record with enumeration name/code definitions

err

Indicates an error condition, dis should contain display message

evaporator

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

evse

Electric Vehicle Supply Equipment

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

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

Associated with a heating process

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

heatingOnly

Equipment without cooling

his

Supports historization of data

hisCollectCov

Enables COV history collection of the curVal

hisCollectNA

Historize the NA value whenever the curVal is null or curStatus is not equal to "ok"

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

hvacMode

Operational mode for HVAC equipment

imbalance

Lacking balance

import

Received into a system

indoorUnit

Operates inside the conditioned space

infiltration

Permeation of a substance into another substance

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

        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

        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

                vrf-indoorUnit-fcu

Indoor unit fan coil unit in a VRF system

        airTerminalUnit

Equipment in air distribution systems which terminate at the space

            cav

Constant air volume terminal unit

            vav

Variable air volume terminal unit

        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

        circuit

Electrical circuit and its associated components such as breakers

        coolingTower

Equipment to transfer waste heat into the atmosphere

        elec-meter

Electricity meter

            ac-elec-meter

AC Electricity meter

            dc-elec-meter

DC Electricity meter

            evse-port

An EVSE port delivers electricity to a single EV charging inlet at a time

                ac-evse-port

An AC EVSE port delivers ac electricity to a single EV charging inlet at a time

                dc-evse-port

A DC EVSE port delivers dc electricity to a single EV charging inlet at a time

        elec-panel

Physical housing for electrical circuits, fuses, and breakers

        elecHeating

Heating by the conversion of electrical energy

        elevator

Enclosure used to move people between floors

        escalator

Moving staircase used to move people between floors

        evse-equip

Equipment that supports the delivery of electricity to charging inlets located on EVs

            evse-cable

The electrical cable between an evse-port and an EV charging inlet on a vehicle

            evse-dispenser

Equipment that dispenses electricity to an EV

            evse-port

An EVSE port delivers electricity to a single EV charging inlet at a time

                ac-evse-port

An AC EVSE port delivers ac electricity to a single EV charging inlet at a time

                dc-evse-port

A DC EVSE port delivers dc electricity to a single EV charging inlet at a time

            evse-powerConverter

A power converter that has a dc electrical output applied to a dc-evse-port

        fumeHood

Ventilation equipment to limit exposure to hazardous fumes

        luminaire

Light fixture using electricity to provide illumination

        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

        movingWalkway

Conveyor to move people across a horizontal or inclined plane

    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

        branchSelector

Branch selector used for heat recovery in a VRF system

        vrf-indoorUnit

Indoor unit in a VRF system

            vrf-indoorUnit-fcu

Indoor unit fan coil unit in a VRF system

    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

lineAvg

Line average of single-phase electrical quantity measurements in an AC electric power system

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 something missed or lost

mandatory

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

max

Maximum

mech

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

min

Minimum

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, hand-held computers, and similar technology

multiLine

Indicates that a multi-line text input should be used

net

Difference between import and export

networking

Related to data communication networks

neutral

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

noSideEffects

Marks a function or operation as having no side effects

noSkyarc

Marks a Haxall library as not runnable on SkySpark enabled products

nodoc

Undocumented and not officially supported

nosrc

Do not include source code in documentation

notInherited

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

obsAddOnInit

Fire add event for all existing records in data set on initialization

obsAdds

Process when a new data item is added to the observed data set

obsRemoves

Process when an existing data item is removed from the observed data set

obsUpdates

Process when an existing data item is updated in the observed data set

observable

Observable subscription - see docs

    obsMqtt

Subscribe to MQTT connector published messages

    obsRecs

Base class for observables on database records

        obsCommits

Subscribe to record commits in Folio - see docs

        obsCurVals

Subscribe to transient commits of curVal or curStatus - see docs

        obsHisWrites

Subscribe to history data updates- see docs

        obsPointWrites

Subscribe to writable point priority array updates - see docs

        obsWatches

Subscribe to watch and unwatch events - see docs

    obsSchedule

Subscribe to scheduled timer event - see docs

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

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

    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

                vrf-indoorUnit-fcu

Indoor unit fan coil unit in a VRF system

        airTerminalUnit

Equipment in air distribution systems which terminate at the space

            cav

Constant air volume terminal unit

            vav

Variable air volume terminal unit

    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

        battery

Equipment used to store electric energy

        circuit

Electrical circuit and its associated components such as breakers

        elec-meter

Electricity meter

            ac-elec-meter

AC Electricity meter

            dc-elec-meter

DC Electricity meter

            evse-port

An EVSE port delivers electricity to a single EV charging inlet at a time

                ac-evse-port

An AC EVSE port delivers ac electricity to a single EV charging inlet at a time

                dc-evse-port

A DC EVSE port delivers dc electricity to a single EV charging inlet at a time

        elec-panel

Physical housing for electrical circuits, fuses, and breakers

        evse-equip

Equipment that supports the delivery of electricity to charging inlets located on EVs

            evse-cable

The electrical cable between an evse-port and an EV charging inlet on a vehicle

            evse-dispenser

Equipment that dispenses electricity to an EV

            evse-port

An EVSE port delivers electricity to a single EV charging inlet at a time

                ac-evse-port

An AC EVSE port delivers ac electricity to a single EV charging inlet at a time

                dc-evse-port

A DC EVSE port delivers dc electricity to a single EV charging inlet at a time

            evse-powerConverter

A power converter that has a dc electrical output applied to a dc-evse-port

    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

        vrf-outdoorUnit

Outdoor unit with one or more compressors in a VRF system

        vrf-refrig-plant

Group of outdoor units in a VRF system

    steam-output

Entity outputs steam to other entities

        steam-boiler

Boiler which outputs steam

        steam-plant

Plant used to generate steam for heating

overridable

Applied to an ext function to enable override by project record functions

parallel

Circuit with multiple paths of flow

perimeterHeat

Auxiliary heating points associated with a vav

phaseAvg

Phase average of single-phase electrical quantity measurements in an AC electric power system

phenomenon

Aspect of scientific interest with measurable quantities

    elec

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

        ac-elec

Alternating current electricity

        dc-elec

Direct current electricity

    light

Electromagnetic radiation in the visible spectrum

    solar

Relating to energy from the sun

    substance

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

        biomass

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

        fluid

Liquid or gas

            gas

Substance with neither definite volume nor shape

                air

The mixture of gases which surrounds the earth

                ch2o

Formaldehyde (CH₂O)

                ch4

Methane (CH₄)

                co

Carbon monoxide (CO)

                co2

Carbon dioxide (CO₂)

                hfc

Hydrofluorocarbons

                n2o

Nitrous oxide (N₂O)

                naturalGas

Fossil fuel energy source consisting largely of methane and other hydrocarbons

                nf3

Nitrogen trifluoride (NF₃)

                nh3

Ammonia (NH₃)

                no2

Nitrogen dioxide (NO₂)

                o2

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

                o3

Ozone (O₃)

                pfc

Perfluorocarbons

                propane

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

                sf6

Sulphur hexafluoride (SF₆)

                steam

Water in its gas form

                tvoc

Total volatile organic compound (TVOC)

            liquid

Substance with definite volume but takes the shape of its container

                condensate

Liquid phase produced by the condensation of steam or other gas

                diesel

Liquid fuel specifically designed for use in diesel engines

                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 cooled for use in HVAC and industrial processes

                    cold-water

Water supplied to cold taps

                    condenser-water

Water used used to remove heat through condensation

                    cool-water

Relatively cool water without active chilling

                    domestic-water

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

                    ground-water

Water present under the ground or from a well

                    hot-water

Hot water used for HVAC heating or supplied to hot taps

                    makeup-water

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

                    purge-water

Water expelled from a system to remove contaminants

                    warm-water

Relatively warm water without active heating

            refrig

Fluid used in refrigeration and heat exchange

        solid

Substance with definite shape and volume

            coal

Combustible sedimentary rock

            ice

Water in its solid form

            pm01

Particulate matter 0.1

            pm10

Particulate matter 10

            pm25

Particulate matter 2.5

    weather

Associated with atmospheric air or phenomenon

    wind

Flow of air on surface of the Earth

port

A gateway or opening used to transfer a substance

powerConverter

Converts one electrical waveform to another using power electronic circuitry

process

Industrial or HVAC process

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

    zigbee

Low power wireless communication protocol for home automation

    zwave

Low power wireless communication protocol for home automation

pump

Pump equipment or control point

purge

Associated with a cleaning process to remove contaminants

quality

Quantity measured against standard metric

quantity

Measurable property of a substance or phenomenon

    air-velocity

Rate of air movement as distance over time

    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 obscured by clouds

    concentration

Abundance of substance in the total volume of a mixture

        airQuality

Concentration of contaminants in the air

            ch2o-concentration

Concentration of formaldehyde (CH₂O) in the air

            co-concentration

Concentration of carbon monoxide (CO) in the air

            co2-concentration

Concentration of carbon dioxide (CO₂) in the air

            nh3-concentration

Concentration of ammonia (NH₃) in the air

            no2-concentration

Concentration of nitrogen dioxide (NO₂) in the air

            o3-concentration

Concentration of ozone (O₃) in the air

            pm01-concentration

Concentration of particulate matter 0.1 in the air

            pm10-concentration

Concentration of particulate matter 10 in the air

            pm25-concentration

Concentration of particulate matter 2.5 in the air

            tvoc-concentration

Concentration of total volatile organic compounds (TVOC) in the air

    current-angle

AC current phase angle

    current-imbalance

AC current imbalance

    current-thd

Total harmonic distortion (THD) of current

    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

    emission

Amount of a substance discharged into the air

        ch4-emission

Greenhouse gas emission of methane (CH₄) into the air

        co2-emission

Greenhouse gas emission of carbon dioxide (CO₂) into the air

        hfc-emission

Greenhouse gas emission of hydrofluorocarbons into the air

        n2o-emission

Greenhouse gas emission of nitrous oxide (N₂O) into the air

        nf3-emission

Greenhouse gas emission of nitrogen trifluoride (NF₃) into the air

        pfc-emission

Greenhouse gas emission of perfluorocarbons into the air

        sf6-emission

Greenhouse gas emission of sulphur hexafluoride (SF₆) into the air

    energy

Measure of ability to do work

        elec-energy

Electrical energy consumed

            active-energy

Integral of active-power over time

    enthalpy

Total heat content of a system

    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

Electric 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

    stateOfCharge

State of charge (SoC) of an electric battery

    temp

Temperature - measure of hot and cold

        air-temp

Dry bulb temperature

    vfd-freq

VFD frequency measured in "Hz"

    vfd-speed

VFD speed measured in "%"

    visibility

Distance at which light can be clearly discerned

    volt-angle

AC voltage phase angle

    volt-imbalance

AC voltage imbalance

    volt-thd

Total harmonic distortion (THD) of voltage

    volume

Three dimensional space occupied by a substance

    weatherCond

Enumeration of weather conditions

    wetBulb

Wet bulb air temperature

rated

Data specified by a manufacturer or rating organization

reactive

Relating to reactance

reciprocal

Piston compressor driven by a crankshaft

    chiller-reciprocal

Piston compressor driven by a crankshaft

reheat

Command point for reheating process

roof

Envelope covering the top of a building

rotaryScrew

Rotary screw compression

    chiller-rotaryScrew

Rotary screw compression

router

Device used to route data packets

run

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

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

sitePoint

Marker tag applied to a point to indicate the point is site-wide

standby

Readiness mode of a space

su

Requires superuser permission

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

trash

Marks a record for deletion

unocc

Unoccupied mode of a space

valve

Valve equipment or control point

velocity

Speed in a given direction

vfd

Variable-frequency drive

volt

Electrical potential difference or electromotive force

vrf

Variable refigerant flow

warm

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

writable

Supports writing data

writeOnOpen

Issue a write every time the connector transitions from open to closed

writeOnStart

Issue a write when the system first starts up

zone

Related to spaces from a system perspective