All tags listed alphabetically
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 |
actorTimeout |
Timeout for messages send to the connector's actor thread |
actuator |
Equipment to move or control a mechanism |
admin |
Requires admin permission |
ahu |
Air Handling Unit |
ahuZoneDelivery |
AHU delivery method of conditioned air to the zone |
air |
The mixture of gases which surrounds the earth |
airCooling |
Cooling by dissipating heat into the surrounding air |
airHandlingEquip |
HVAC equipment that conditions and delivers air via one or more fans |
airQuality |
Concentration of contaminants in the air |
airQualityZonePoints |
Entity with logical grouping of zone air quality points |
airRef |
Air flows from the referent to this entity |
airTerminalUnit |
Equipment in air distribution systems which terminate at the space |
airVolumeAdjustability |
Ability of air handling equip to adjust volume of air flow |
alarm |
Notification of a condition which requires attention |
angle |
Measurement of the relative difference in direction between two vectors or phasors |
apparent |
Perceived quantity |
area |
Area of a shape or floor space |
association |
Associations model ontological relationships between definitions |
ates |
Aquifer Thermal Energy Storage system |
atesClosedLoop |
The ATES uses closed piping to transport a water/glycol mixture through the ground |
atesDesign |
Design type of the ATES underground system |
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 |
atmospheric |
Related to the atmosphere of the earth |
avg |
Average |
bacnet |
ASHRAE building automation and control protocol |
barometric |
Relating atmospheric pressure |
baseUri |
Base URI for normalizing relative URIs |
battery |
Equipment used to store electric energy |
biomass |
Plant or animal material used as fuel to produce electricity or heat |
biomassHeating |
Heating by the combustion of biomass |
blowdown |
Removal from container or pipe |
blowdownWaterRef |
Blowdown water flows from the referent to this entity |
bluetooth |
Short range wireless communication protocol |
boiler |
Equipment to generate hot water or steam for heating |
bool |
Boolean value |
branchSelector |
Branch selector used for heat recovery in a VRF system |
bypass |
Pipe used to bypass an equipment |
cable |
An assembly of one or more insulated conductors |
cav |
Constant air volume terminal unit |
centrifugal |
Compression via a continuous flow of fluid through an impeller |
ch2o |
Formaldehyde (CH₂O) |
ch4 |
Methane (CH₄) |
children |
List of prototypes contained by this entity |
childrenFlatten |
List of aspects to flatten into children prototypes |
chilled |
Substance is cooled using cooling process |
chilledBeam |
Conditions a space using a heat exchanger integrated into the ceiling |
chilledBeamZone |
AHU supplies air to chilled beam terminal units |
chilledWaterCooling |
Cooling using transfer of heat to chilled water |
chilledWaterRef |
Chilled water flows from the referent to this entity |
chiller |
Equipment to remove heat from a liquid |
chillerMechanism |
Primary mechanism of chiller |
choice |
Choice specifies an exclusive marker selection |
circ |
Pipe used to circulate fluid through an equipment or system |
circuit |
Electrical circuit and its associated components such as breakers |
cloudage |
Percentage of sky obscured by clouds |
cmd |
Point is a command, actuator, AO/BO |
co |
Carbon monoxide (CO) |
co2 |
Carbon dioxide (CO₂) |
co2e |
Carbon dioxide equivalent |
coal |
Combustible sedimentary rock |
coalHeating |
Heating by the combustion of coal |
coap |
Constrained Application Protocol |
coil |
Heat exchanger used to heat or cool air |
cold |
Having low degree of heat |
coldDeck |
Duct carries air for cooling |
compressor |
Device for mechanically increasing the pressure of a gas or refrigerant vapor by reducing its volume |
computed |
Computed point |
computedFromReciprocal |
Indicates a relationship that is computed from its reciprocal |
computedModel |
See Synthetics chapter |
computer |
General purpose computer |
concentration |
Abundance of substance in the total volume of a mixture |
condensate |
Liquid phase produced by the condensation of steam or other gas |
condensateRef |
Condensate flows from the referent to this entity |
condenser |
Device or related to process of condensation |
condenserClosedLoop |
Working fluid is kept separate from fluid used for heat transfer into the atmosphere |
condenserCooling |
Removal of heat through the process of water condensation |
condenserLoop |
Open or closed loop for condenser working fluid |
condenserOpenLoop |
Uses working fluid itself for evaporation into the atmosphere |
condenserWaterRef |
Condenser water flows from the referent to this entity |
conditioning |
Related to cleaning, heating, cooling, humidifying, dehumidifying, ventilating or circulating air. |
conduit |
Duct, pipe, or cable to convey a substance or phenomenon |
conn |
Connector for communication to a remote system |
connErr |
Error message associated when |
connFeatures |
Defines the features supported by a given connector |
connLinger |
Linger timeout used to keep a connector open |
connOpenRetryFreq |
Duration used for connector open retries |
connPingFreq |
Duration used to configure the auto-ping feature on a given connector |
connPoint |
Point associated with a connector for data synchronization with a remote system |
connState |
Current connection state of a connector as one of the predefined strings |
connStatus |
Current status of a connector as one of the predefined strings See Connectors |
connTuning |
Marker applied to a rec which defines a tuning configuration |
connTuningRef |
Reference to a tuning configuration defined by a |
constantAirVolume |
Delivers a constant volume of air flow |
containedBy |
The entity is logically contained by the referent |
contains |
Entities logically contained by this entity |
controller |
Microprocessor based device used in a control system |
controls |
Associated with the control system for an industrial process |
cool |
Associted with low temperature or cooling processes |
cooling |
Cooling mode or process |
coolingCapacity |
Measurement of a chiller ability to remove heat measured |
coolingCoil |
Coil used to cool air |
coolingOnly |
Equipment without heating |
coolingProcess |
Processed used to cool a substance |
coolingTower |
Equipment to transfer waste heat into the atmosphere |
coord |
Geographic coordinate in latitude/longitude in decimal degrees |
crac |
Computer Room Air Conditioner |
created |
The timestamp when entity was created |
cur |
Supports current value |
curCalibration |
Calibration value to apply to adjust the value read from the connector before updating curVal |
curConvert |
Conversion to apply when reading curVal from connector |
curErr |
Error description when |
curStatus |
Status of point's current value reading |
curTracksWrite |
When configured |
curVal |
Current value of a point |
current |
Movement of fluid or electricity |
dali |
Digital Addressable Lighting Interface protocol for lighting |
damper |
Damper equipment or control point |
dataCenter |
Space used to house computer and networking gear |
date |
ISO 8601 date as year, month, day |
dateTime |
ISO 8601 timestamp followed by timezone identifier |
daytime |
Time between sunrise and sunset |
dc |
Relating to direct current electricity |
deadband |
The range in a process where no changes to output are made |
def |
Create a new definition bound to the given symbol |
defx |
Extends the given definition with additional meta tags |
delta |
Differential of fluid between entering and leaving sensors |
demand |
Rate required for a process |
depends |
List of this library's dependencies |
deprecated |
Obsoleted |
design |
Data related to intended design and operating conditions |
dessicantDehumidifier |
Decreases humidity from air using a substance which absorbs moisture |
device |
Microprocessor based hardware device |
deviceRef |
Device which controls a monitors this entity |
dewPoint |
Dew point temperature at which water vapor will form dew |
dict |
Map of name/value tag pairs |
diesel |
Liquid fuel specifically designed for use in diesel engines |
directZone |
AHU supplies air directly to the zone |
direction |
Compass direction measured in degrees |
dis |
Display name for an entity |
disKey |
Localized string key formatted as |
disMacro |
Display name using macro syntax |
disableOverridableChecks |
Disables function |
disabled |
Indicates the entity is in a disabled state |
discharge |
Duct for air leaving an equipment |
dispenser |
Equipment that releases a specific amount of a substance |
diverting |
Three way valve which inputs one pipe and diverts between two output pipes |
doas |
Dedicated Outside Air System |
doc |
Documentation in simplified flavor of markdown |
docAssociations |
Generate a section in the docs for this association |
docTaxonomy |
Generate a taxonomy tree for this term in the documentationindex |
dockerContainer |
Docker container |
dockerImage |
Docker image |
dockerState |
Current status of a Docker container |
dockerStatus |
Additional human-readable status of the container |
domestic |
For human use |
domesticWaterRef |
Domestic water flows from the referent to this entity |
dualDuct |
Two ducts |
duct |
Conduit used to convey air for HVAC |
ductArea |
Config point on a |
ductConfig |
Ductwork configuration |
ductDeck |
Cold, hot, or neutral deck |
ductSection |
Equipment section of ductwork |
duration |
Number with a unit of time |
dxCooling |
Cooling using direct expansion of a refrigerant vapor |
dxHeating |
Heating using direct expansion of a refrigerant vapor |
ecobeeClientId |
Your Ecobee API Key |
ecobeeConn |
Ecobee connector |
ecobeeConnRef |
Used on a proxy point to reference its parent |
ecobeeCur |
Ecobee address to use to get the current value |
ecobeeHis |
Ecobee address to use to sync point history |
ecobeePoint |
Point which synchronizes data via an Ecobee connector |
ecobeeRefreshToken |
The refresh token you obtained for your API key |
ecobeeWrite |
Ecobee address to use to write a point value |
economizer |
Duct to access fresh outside air only for economizing, not ventilation |
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" |
elec |
Associated with electricity or with electrical force, power, or energy |
elecHeating |
Heating by the conversion of electrical energy |
elecLine |
Single-phase line measurement of an electric quantity in an AC electric power system |
elecLineToLine |
Single-phase electric quantity measured line-to-line in an AC electric power system |
elecLineToNeutral |
Single-phase electric quantity measured line-to-neutral in an AC electric power system |
elecRef |
Electricity flows from the referent to this entity |
elevator |
Enclosure used to move people between floors |
emission |
Amount of a substance discharged into the air |
enable |
Secondary on/off |
energy |
Measure of ability to do work |
entering |
Pipe conveys fluid into an equipment |
enthalpy |
Total heat content of a system |
entity |
Top-level dicts with a unique identifier |
enum |
Defines an eumeration of string key names |
enumMeta |
Project singleton record with enumeration name/code definitions |
equip |
Equipment asset |
equipRef |
Reference to equip which contains this entity |
err |
Indicates an error condition, |
errTrace |
Exception stack trace |
escalator |
Moving staircase used to move people between floors |
evaporator |
Mechanism used to convert a refrigerant from its liquid to gaseous state |
evse |
Electric Vehicle Supply Equipment |
evseCableType |
Physical type of |
evseSession |
Describes an event during which an |
evseStatus |
Status of one or more |
exhaust |
Duct used to expel air back outside |
export |
Supplied out of a system |
expr |
Axon expression string |
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 |
fcu |
Fan Coil Unit |
feature |
Feature namespace of definitions formatted as |
feelsLike |
Apparent temperature perceived when considering humidity, wind chill, and heat index |
fileExt |
Filename extension such as "csv" |
filetype |
File format type definition |
filter |
Related to an air or fluid filter |
filterStr |
Haystack filter string |
flags |
Flags string |
floor |
Storey of a building |
floorNum |
Unitless integer indicating the floor's distance from ground level |
flow |
Measure of volumetric flow of fluid |
flowInverter |
System to change direction of substance flow |
flue |
Duct for exhausting combustion |
fluid |
Liquid or gas |
flux |
Measurement through a given surface |
foldOn |
Registers a function as folding a given value type |
freezeStat |
A boolean point of an ahu indicating a freezing condition |
freq |
Occurrences per unit time |
ftp |
File Transfer Protocol |
fuelOil |
Petroleum based oil burned for energy |
fuelOilHeating |
Heating by the combustion of fuel oil |
fuelOilRef |
Fuel oil flows from the referent to this entity |
fumeHood |
Ventilation equipment to limit exposure to hazardous fumes |
func |
Axon function |
gas |
Substance with neither definite volume nor shape |
gasoline |
Petroleum derived liquid used as a fuel source |
gasolineRef |
Gasoline flows from the referent to this entity |
geoAddr |
Free form street address |
geoCity |
Geographic city or locality name |
geoCoord |
Geographic coordinate as |
geoCountry |
Geographic country as ISO 3166-1 two letter code |
geoCounty |
Geographic subdivision of US state |
geoElevation |
Elevation above sea-level of the location |
geoPlace |
Geographic place |
geoPostalCode |
Geographic postal code |
geoState |
State or province name |
geoStreet |
Geographic street address and name |
grid |
Two dimension table of columns and rows |
ground |
Related to the surface of the earth |
haystack |
Haystack HTTP protocol for exchanging tagged data |
haystackConn |
Haystack connector to a Haystack REST API server |
haystackConnRef |
Used on a proxy point to reference its parent |
haystackCur |
Used on a haystack proxy point to store the id of the entity in the remote system used to read and watch |
haystackHis |
Used on a haystack proxy point object to store the id of the historized point in the remote system used to sync history data |
haystackPoint |
Point which synchronizes data via a Haystack connector |
haystackPollFreq |
Applied to |
haystackWrite |
Used on a haystack proxy point to store the id of the entity in the remote system used to write |
haystackWriteLevel |
Number between 1 and 16 used with |
header |
Pipe used as central connection or manifold for other piping runs |
heat |
Associated with a heating process |
heatExchanger |
Equipment to transfer heat between two working fluids |
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 |
heatingCoil |
Coil used to heat air |
heatingOnly |
Equipment without cooling |
heatingProcess |
Processed used to heat a substance |
hfc |
Hydrofluorocarbons |
his |
Supports historization of data |
hisCollectCov |
Enables COV history collection of the |
hisCollectCovRateLimit |
Rate limits the frequency for |
hisCollectInterval |
Enables interval history collection of the |
hisCollectNA |
Historize the NA value whenever the |
hisCollectWriteFreq |
This tag configures how long to buffer collected history items in memory before flushing them to the historian |
hisConvert |
Conversion to apply when reading history data from connector |
hisErr |
Error description when |
hisMode |
Indicates the way that history data is collected for a point |
hisStatus |
Status of point's history collection or synchronization |
hisTotalized |
Indicates values which are a continuous stream of totalization |
hot |
Having high degree of heat |
hotDeck |
Duct carries air for heating |
hotWaterHeating |
Heating using energy of hot water |
hotWaterRef |
Hot water flows from the referent to this entity |
http |
Hypertext Transfer Protocol which is foundation of the web |
humidifier |
Adding moisture to air |
humidity |
Percent relative humidity |
hvac |
Heating, ventilation, and air conditioning |
hvacMode |
Operational mode for HVAC equipment |
hvacZonePoints |
Entity with logical grouping of zone HVAC air points |
ice |
Water in its solid form |
id |
Defines the unique identifier of an entity in system using a |
illuminance |
Luminous flux hitting the inside of the sphere at a specific point |
imap |
Internet Message Access Protocol for retrieving email |
imbalance |
Lacking balance |
import |
Received into a system |
indoorUnit |
Operates inside the conditioned space |
infiltration |
Permeation of a substance into another substance |
inlet |
Duct with air entering an equipment |
input |
Entity inputs a substance which flows from another entity |
inputs |
The entity inputs a substance from the referent |
int |
Unitless integer number |
intensity |
Measure of an electromagnetic field |
irradiance |
Energy received at a surface by area |
is |
Defines one or more supertypes of a subtyping relationship |
isolation |
Actuator used to isolate an equipment from a pipe or ductwork system |
kind |
Kind name used to identity a value data type |
knx |
KNX protocol commonly used for lighting systems |
laptop |
Portable laptop computer |
leaving |
Pipe conveys fluid out of an equipment |
level |
Range from 0% to 100% |
lib |
Library module of symbolic definitions |
light |
Electromagnetic radiation in the visible spectrum |
lighting |
Systems associated with illumination in the built environment |
lightingZonePoints |
Entity with logical grouping of lighting points |
lineAvg |
Line average of single-phase electrical quantity measurements in an AC electric power system |
lineCurrent |
Single-phase line current measured in an AC electric power system |
lineEnergy |
Single-phase energy measured line-to-line in an AC electric power system |
linePf |
Single-phase power factor measured line-to-line in an AC electric power system |
linePower |
Single-phase power measured line-to-line in an AC electric power system |
lineVolt |
Single-phase voltage measured line-to-line in an AC electric power system |
liquid |
Substance with definite volume but takes the shape of its container |
list |
Ordered list of zero or more values |
load |
Chiller point to command or measure the chiller's load as a percentage from "0%" to "100%" |
luminaire |
Light fixture using electricity to provide illumination |
luminance |
Energy of light in a given direction |
luminous |
Relating to light as perceived by the eye |
magnitude |
Size or extent |
makeup |
Restore something missed or lost |
makeupWaterRef |
Makeup water flows from the referent to this entity |
mandatory |
Requires that the marker be applied to dicts which use the marker's subtypes |
marker |
Marker labels a dict with typing information |
mau |
Makeup Air Unit |
max |
Maximum |
maxVal |
Inclusive maximum for a numeric value |
mech |
Associated with a machine or its mechanical force, torque, power, or energy |
meter |
Equipment to meter a substance or phenomenon |
meterScope |
Classifies a meter as a main site meter or submeter |
mime |
Mime type formatted as type/subtype |
min |
Minimum |
minVal |
Inclusive minimum for a numeric value |
mixed |
Duct where fresh outside air and return air is mixed together |
mixing |
Three way valve which inputs two pipes and outputs a mixture between the two to a single output pipe |
ml |
Machine learning point |
mlIdentificationPeriod |
Training period description, known as the identification period or baseline, utilized during the model training process |
mlInputVarRefs |
List of independent variables, also known as model inputs or features, associated with a machine learning model |
mlModel |
See Synthetics chapter |
mlModelMetrics |
Goodness-of-fit metrics provided in the form of a simple dictionary |
mlModelParameters |
Result of model identification, which may appear as a list of model parameters for simpler models or as a reference to a stored model, in the form of a file uri |
mlOutputVarRef |
Dependent variable, also known as the model output or target, associated, with a machine learning model |
mlVar |
Machine learning variable representing both model inputs and outputs |
mlVarFilter |
Filter used for querying points by tags, providing more flexibility than mlVarPoint, although it is not mandatory |
mlVarPoint |
Reference to a point associated with a machine learning variable, known as a machine learning variable point |
mlVarRef |
Reference to a machine learning variable |
mobile |
Relating to mobile phones, hand-held computers, and similar technology |
mod |
Last modified time of record - see docSkySpark |
modbus |
Register based communication protocol used with industrial devices |
modbusBlockGap |
Applied to |
modbusBlockMax |
Applied to |
modbusConn |
Modbus connector |
modbusConnRef |
Used on a proxy point to reference its parent |
modbusCur |
Modbus address to use for current value subscriptions |
modbusPoint |
Point which synchronizes data via a Haystack connector |
modbusReadTimeout |
How long to wait before timing out on a modbus read |
modbusRegMapUri |
Applied to |
modbusSlave |
Applied to |
modbusWrite |
Used on a modbus proxy point to store the id of the entity in the remote system used to write |
modbusWriteTimeout |
How long to wait before timing out on a modbus write |
motor |
Equipment that converts electrical energy into mechanical energy |
movingWalkway |
Conveyor to move people across a horizontal or inclined plane |
mqtt |
Message Queuing Telemetry Transport publish/subscribe protocol |
mqttCertAlias |
Used on an |
mqttCleanSession |
Whether to set the clean session flag on the connect request to the broker |
mqttClientId |
The client identifier to use when connecting to the broker |
mqttConn |
MQTT connector to an MQTT Broker |
mqttConnRef |
Used on a proxy point to reference its parent |
mqttMaxRetry |
How many times to retry sending messages that require acknowlegment |
mqttPoint |
Point which synchronizes data via a MQTT connector |
mqttQos |
MQTT Quality of Service (QoS)
|
mqttRetain |
Set the retention flag on a published message |
mqttRetryInterval |
How long to wait between retries for messages that require acknowlegment |
mqttVersion |
MQTT protocol version |
multiLine |
Indicates that a multi-line text input should be used |
multiZone |
AHU discharge air is split into a duct per zone |
n2o |
Nitrous oxide (N₂O) |
na |
Not available used to indicate invalid or missing data |
name |
Name key |
naturalGas |
Fossil fuel energy source consisting largely of methane and other hydrocarbons |
naturalGasHeating |
Heating by the combustion of natural gas |
naturalGasRef |
Natural gas flows from the referent to this entity |
nestClientId |
The OAuth client_id for your application |
nestClientSecret |
The OAuth client_secret for your application |
nestConn |
Google Nest connector |
nestConnRef |
Used on a proxy point to reference its parent |
nestCur |
Nest address to use to get the current value |
nestPoint |
Point which synchronizes data via a Nest connector |
nestProjectId |
The project identifier from your Google Device Access project |
nestRefreshToken |
The OAuth refresh_token for your application |
nestWrite |
Nest address to use to write a point value |
net |
Difference between import and export |
network |
Logical communications network between two or more devices |
networkRef |
Associates a device which communicates on specific a network |
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 |
neutralDeck |
Duct carries air which by-passes both heating and cooling coils |
nf3 |
Nitrogen trifluoride (NF₃) |
nh3 |
Ammonia (NH₃) |
no2 |
Nitrogen dioxide (NO₂) |
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 |
number |
Integer or floating point numbers annotated with an optional unit |
o2 |
Oxygen (O₂) - the common dioxygen allotrope in the air |
o3 |
Ozone (O₃) |
obix |
XML based Open Building Information eXchange protocol |
obixConn |
Connector to an oBIX HTTP server |
obixConnRef |
Used on a proxy point to reference its parent |
obixCur |
Used on a oBIX proxy point to store the URI of the entity in the remote system used to read and watch |
obixHis |
URI of the |
obixLobby |
The lobby URI is used to address an |
obixPoint |
Point which synchronizes data via a oBIX connector |
obixPollFreq |
Duration between obixConn watch polls |
obixWritable |
Server export of a writable point as an |
obixWrite |
URI of the |
obixWriteLevel |
Number between 1 and 16 used with |
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 |
obsCommits |
Subscribe to record commits in Folio - see docs |
obsCurVals |
Subscribe to transient commits of curVal or curStatus - see docs |
obsFilter |
Filter string to define the record data set observed |
obsHisWrites |
Subscribe to history data updates- see docs |
obsMqtt |
Subscribe to MQTT connector published messages |
obsMqttConnRef |
Subscribe to the topic on this MQTT connector |
obsMqttTopic |
Receive published messages that match this filter |
obsPointWrites |
Subscribe to writable point priority array updates - see docs |
obsRecs |
Base class for observables on database records |
obsRemoves |
Process when an existing data item is removed from the observed data set |
obsSchedule |
Subscribe to scheduled timer event - see docs |
obsScheduleDaysOfMonth |
Schedule events for given days of the month |
obsScheduleDaysOfWeek |
Schedule events for given days of the week |
obsScheduleFreq |
Schedule events with given frequency |
obsScheduleSpan |
Schedule events only during the configured span of time |
obsScheduleTimes |
Schedule events for given times of the day |
obsUpdates |
Process when an existing data item is updated in the observed data set |
obsWatches |
Subscribe to watch and unwatch events - see docs |
observable |
Observable subscription - see docs |
observes |
Observable subscription - 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 |
of |
Expected value type of a collection, reference, or choice |
op |
Operation for HTTP API |
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 |
outputs |
The entity outputs a substance to the referent |
outside |
Duct to access fresh outside air for both ventilation and economizer |
overridable |
Applied to an ext function to enable override by project record functions |
panel |
Enclosure for electrical and control equipment |
parallel |
Circuit with multiple paths of flow |
password |
Manages password which is hashed/stored to the password store |
perimeterHeat |
Auxiliary heating points associated with a |
pf |
Electric power factor |
pfDisplacement |
Displacement power factor, which excludes effects of harmonic distortion |
pfDistortion |
Distortion power factor |
pfScope |
Power factor scope |
pfTrue |
True power factor, which includes effects of harmonic distortion |
pfc |
Perfluorocarbons |
phase |
Phase measurement in a three-phase electrical system |
phaseAvg |
Phase average of single-phase electrical quantity measurements in an AC electric power system |
phaseCount |
Number of phases for an AC electrical power system or connected equipment |
phaseCurrent |
Single-phase current measured line-to-line in an AC electric power system |
phaseEnergy |
Single-phase energy measured line-to-neutral in an AC electric power system |
phasePf |
Single-phase power factor measured line-to-neutral in an AC electric power system |
phasePower |
Single-phase power measured line-to-neutral in an AC electric power system |
phaseVolt |
Single-phase voltage measured line-to-neutral in an AC electric power system |
phenomenon |
Aspect of scientific interest with measurable quantities |
phone |
Telephone used for voice telecommunication |
pipe |
Conduit used to convey a fluid |
pipeFluid |
Type of fluid conveyed by piping |
pipeSection |
Equipment section of piping |
plant |
Central plant used to generate a substance for a process |
plantLoop |
Plant piping loop |
pm01 |
Particulate matter 0.1 |
pm10 |
Particulate matter 10 |
pm25 |
Particulate matter 2.5 |
point |
Data point such as a sensor or actuator |
pointConvert |
Point value conversion used to normalize data to/from a remote system |
pointFunction |
Classifies the point as a sensor, command, or setpoint |
pointGroup |
Grouping of children points used by spaces and equipment |
pointQuantity |
Quantity the point senses or controls |
pointRef |
See Synthetics chapter |
pointSubject |
What the point senses or controls |
pollTime |
Frequency between polls of |
pop3 |
Post Office Protocol version 3 for retrieving email |
port |
A gateway or opening used to transfer a substance |
power |
Energy consumed per unit time |
powerConverter |
Converts one electrical waveform to another using power electronic circuitry |
precipitation |
Amount of atmospheric water vapor fallen including rain, sleet, snow, and hail |
prefUnit |
Defines a preferred unit to be used with a quantity |
pressure |
Measure of force applied |
pressureDependent |
VAV damper modulates to control space temp |
pressureIndependent |
VAV damper or a control valve that modulates to maintain desired flow setpoint |
primaryFunction |
Primary function of building as US Energy Star key |
primaryLoop |
Pipework which circulates closest to the energy source |
process |
Industrial or HVAC process |
projMeta |
Singleton record for project meta data |
propane |
By-product of natural gas processing and petroleum refining (C₃H₈) |
propaneHeating |
Heating by the combustion of propane |
protocol |
Communication protocol used for devices on a network |
pump |
Pump equipment or control point |
purge |
Associated with a cleaning process to remove contaminants |
quality |
Quantity measured against standard metric |
quantities |
Quantities used to measure this phenomenon |
quantity |
Measurable property of a substance or phenomenon |
quantityOf |
Associates quantity as measurement of a phenomenon |
rack |
Enclosure or chassis used to mount computer and networking gear |
radiantEquip |
HVAC equipment that conditions a space without forced air |
radiantFloor |
Heats a space using pipes or cables embedded beneath floor |
radiator |
Heats a space using exposed pipes or coils |
rated |
Data specified by a manufacturer or rating organization |
reactive |
Relating to reactance |
reader |
Fantom type qname for reader class |
reciprocal |
Piston compressor driven by a crankshaft |
reciprocalOf |
Specifies the inverse of an association or relationships |
ref |
Reference to an entity |
refrig |
Fluid used in refrigeration and heat exchange |
refrigRef |
Refrigerant flows from the referent to this entity |
reheat |
Command point for reheating process |
relationship |
Ref tags used to model entity-to-entity relationships |
remove |
Singleton for remove operation |
return |
Duct returning air back to equipment |
roof |
Envelope covering the top of a building |
room |
Enclosed room of a building |
rotaryScrew |
Rotary screw compression |
router |
Device used to route data packets |
rtu |
Roof Top Unit |
run | |
scalar |
Scalar is an atomic value kind |
secondaryLoop |
Pipework which circulates closest to the building or end use |
sedonaConn |
Sedona Sox connector to a remote device |
sedonaConnRef |
Used on a proxy point to reference its parent |
sedonaCur |
Sedona address to use for current value subscritions |
sedonaPoint |
Point which synchronizes data via a Sedona connector |
sedonaWrite |
Sedona address to use for writing |
sensor |
Point is a sensor, input, AI/BI |
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 |
sf6 |
Sulphur hexafluoride (SF₆) |
sim |
Simulation point |
simBaseline |
See Synthetics chapter |
simModel |
See Synthetics chapter |
simOperation |
See Synthetics chapter |
simOptimum |
See Synthetics chapter |
simScenario |
See Synthetics chapter |
singleDuct |
One single duct |
singlePhase |
Single-phase AC electrical power |
site |
Site is a geographic location of the built environment |
siteMeter |
Main meter for the associated site |
sitePoint |
Marker tag applied to a |
siteRef |
Reference to site which contains the entity |
smtp |
Simple Mail Transfer Protocol for sending email |
snmp |
Simple Network Management Protocol for managing IP devices |
solar |
Relating to energy from the sun |
solid |
Substance with definite shape and volume |
sox |
Sedona Framework UDP based communication protocol |
sp |
Point is a setpoint, soft point, internal control variable, schedule |
space |
Space is a three-dimensional volume in the built environment |
spaceRef |
Reference to space which contains this entity |
span |
Time span as modeled encoded as XStr |
speed |
Distance per unit time |
sqlConn |
SQL connector to a relational database using JDBC |
sqlConnRef |
Used on a proxy point to reference its parent |
sqlHis |
Arbitrary key used by the SQL connector to synchronized history data |
sqlPoint |
Point which synchronizes data via a SQL connector |
sqlSyncHisExpr |
This is a tag which must be configured on each |
src |
Source code |
stage |
Stage number of staged equipment operation such as coil or pump |
staleTime |
Time before a point's curStatus marked from "ok" to "stale" See Connector Tuning |
standby |
Readiness mode of a space |
stateOfCharge |
State of charge (SoC) of an electric |
steadyState |
The delay before transitioning to the steady state |
steam |
Water in its gas form |
steamHeating |
Heating using energy of steam |
steamRef |
Steam flows from the referent to this entity |
str |
Unicode string of characters |
su |
Requires superuser permission |
submeter |
Submeters measure usage of a sub-system or equipment within a site |
submeterOf |
Reference to parent meter which is immediately upstream of this meter |
substance |
Matter in one the three states solid, liquid, or gas |
subterranean |
Below the surface of the earth |
switch |
Device for toggling state or routing data |
symbol |
Symbol to a def |
synthetic |
Synthetic point with computed operational data |
syntheticModel |
See Synthetics chapter |
syntheticModelRef |
See Synthetics chapter |
system |
Grouping of related equipment dedicated to a single application |
systemRef |
Reference to system |
tablet |
Mobile device with touch screen for user input |
tagOn |
This tag is used on the given entity |
tags |
Tags used with this entity |
tank |
Tank used to store a substance for temporary holding |
tankSubstance |
Substance stored by a tank |
task |
Dispatch task function |
taskExpr |
Task messaging handling Axon expression |
taskStatus |
Current status of a task |
temp |
Temperature - measure of hot and cold |
tertiaryLoop |
Pipework which circulates within the building |
thd |
Total harmonic distortion |
thermal |
Related to energy of heat |
thermostat |
Senses and controls temperature of space in HVAC system |
threePhase |
Three-phase AC electrical power |
time |
ISO 8601 time as hour, minute, seconds |
total |
Complete or absolute |
transient |
Indicates a value tag which should not be persisted |
transitive |
This marker is applied to a |
trash |
Marks a record for deletion |
tripleDuct |
Three ducts |
tvoc |
Total volatile organic compound (TVOC) |
typeName |
Fantom type qname |
tz |
Timezone identifier from standard timezone database |
unit |
Unit identifier from standard unit database |
unitVent |
Unit Ventilator |
unocc |
Unoccupied mode of a space |
ups |
Uninterruptible power supply |
uri |
Universal resource identifier |
username |
Username for an authentication account |
val |
Data value type |
valve |
Valve equipment or control point |
variableAirVolume |
Delivers a variable volume of air flow |
vav |
Variable air volume terminal unit |
vavAirCircuit |
How does the VAV pull in air |
vavModulation |
How does VAV modulate the temp based on duct pressure |
vavZone |
AHU supplies air to VAV terminal units |
velocity |
Speed in a given direction |
ventilation |
Duct to access fresh outside air only for ventilation, not economizing |
version |
Version string formatted as decimal integers separated by a dot |
verticalTransport |
Equipment to move humans and materials |
vfd |
Variable-frequency drive |
visibility |
Distance at which light can be clearly discerned |
volt |
Electrical potential difference or electromotive force |
volume |
Three dimensional space occupied by a substance |
vrf |
Variable refigerant flow |
warm |
Relatively warm in comparison to another substance, without being actively heated |
water |
Water in its liquid form |
waterCooling |
Cooling using transfer of heat to water which is not explicitly chilled |
weather |
Associated with atmospheric air or phenomenon |
weatherCond |
Enumeration of weather conditions |
weatherStation |
Logical weather station and its measurement points |
weatherStationRef |
Reference to weather station for to use this entity |
well |
A well is a source of groundwater and potentially thermal energy |
wetBulb |
Wet bulb air temperature |
wikipedia |
Hyperlink to the subject's page on Wikipedia |
wind |
Flow of air on surface of the Earth |
wire |
Cabling used to convey electricity or data |
writable |
Supports writing data |
writeConvert |
Conversion to apply when writing writeVal to the connector |
writeErr |
Error description when |
writeLevel |
Current priority level for |
writeMaxTime |
Maximum time between writes used to send periodic writes |
writeMinTime |
Minimum time between writes used to throttle the speed of writes |
writeOnOpen |
Issue a write every time the connector transitions from open to closed |
writeOnStart |
Issue a write when the system first starts up |
writeStatus |
Current status of a writable point output |
writeVal |
Current desired value to write to output |
writer |
Fantom type qname for writer class |
xstr |
Extended string - type name and string value encoding |
yearBuilt |
Original year of construction as four digit year such as 1980 |
zigbee |
Low power wireless communication protocol for home automation |
zone |
Related to spaces from a system perspective |
zwave |
Low power wireless communication protocol for home automation |