def
entity
Top-level dicts with a unique identifier. See Ontology chapter.
meta
supertypes
| marker |
Marker labels a dict with typing information |
|---|
subtypes
| 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-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 |
| dc-evse-port |
A DC EVSE port delivers |
| evse-powerConverter |
A power converter that has a |
| 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 |
| dc-evse-port |
A DC EVSE port delivers |
| 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 |
| 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 |