def

entity

Top-level dicts with a unique identifier

meta

def entity
doc See above
is marker
lib ph

usage

supertypes

marker

Marker labels a dict with typing information

subtypes

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

tags

dis

Display name for an entity

id

Defines the unique identifier of an entity in system using a Ref value type