`lib-ph` 库参考

原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793881990/FIN+5.3.1+lib-ph 中文整理基于 FIN 5.3.1

导读： Project Haystack 核心定义

以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。

目录（导读）

概述（中译）

Project Haystack 核心定义

API 正文（英文）

tags


accumulate	Accumulate the tag's value during inheritance and defx
association	Associations model ontological relationships between definitions
baseUri	Base URI for normalizing relative URIs
bool	Boolean value `true` or `false`
children	List of prototypes contained by this entity
childrenFlatten	List of aspects to flatten into children prototypes
choice	Choice specifies an exclusive marker selection
computedFromReciprocal	Indicates a relationship that is computed from its reciprocal
containedBy	The entity is logically contained by the referent
contains	Entities logically contained by this entity
coord	Geographic coordinate in latitude/longitude in decimal degrees
date	ISO 8601 date as year, month, day
dateTime	ISO 8601 timestamp followed by timezone identifier
def	Create a new definition bound to the given symbol
defx	Extends the given definition with additional meta tags
depends	List of this library's dependencies
deprecated	Obsoleted
dict	Map of name/value tag pairs
dis	Display name for an entity
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
duration	Number with a unit of time
entity	Top-level dicts with a unique identifier
enum	Defines an eumeration of string key names
feature	Feature namespace of definitions formatted as `feature:name`
fileExt	Filename extension such as "csv"
filetype	File format type definition
filterStr	Haystack filter string
geoAddr	Free form street address
geoCity	Geographic city or locality name
geoCoord	Geographic coordinate as `C(latitude,longitude)`
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
id	Defines the unique identifier of an entity in system using a `ref` value type
input	Entity inputs a substance which flows from another entity
inputs	The entity inputs a substance from the referent
int	Unitless integer number
is	Defines one or more supertypes of a subtyping relationship
kind	Kind name used to identity a value data type
lib	Library module of symbolic definitions
list	Ordered list of zero or more values
mandatory	Requires that the marker be applied to dicts which use the marker's subtypes
marker	Marker labels a dict with typing information
max	Maximum
maxVal	Inclusive maximum for a numeric value
mime	Mime type formatted as type/subtype
min	Minimum
minVal	Inclusive minimum for a numeric value
na	Not available used to indicate invalid or missing data
noSideEffects	Marks a function or operation as having no side effects
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
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
output	Entity outputs a substance with flows to other entities
outputs	The entity outputs a substance to the referent
reciprocalOf	Specifies the inverse of an association or relationships
ref	Reference to an entity
relationship	Ref tags used to model entity-to-entity relationships
remove	Singleton for remove operation
scalar	Scalar is an atomic value kind
span	Time span as modeled encoded as XStr
str	Unicode string of characters
symbol	Symbol to a def
tagOn	This tag is used on the given entity
tags	Tags used with this entity
time	ISO 8601 time as hour, minute, seconds
transient	Indicates a value tag which should not be persisted
transitive	This marker is applied to a `relationship` to indicate it is transitive
tz	Timezone identifier from standard timezone database
unit	Unit identifier from standard unit database
uri	Universal resource identifier
val	Data value type
version	Version string formatted as decimal integers separated by a dot
wikipedia	Hyperlink to the subject's page on Wikipedia
xstr	Extended string - type name and string value encoding

ops


about	Query basic information about the server
close	Close the current session and cancel the auth bearer token
defs	Query the definitions in the current namespace
filetypes	Query the filetype defs in the current namespace
libs	Query the lib defs in the current namespace
nav	Query the navigation tree for discovery
ops	Query the op defs in the current namespace
read	Query the a set of entity records by id or by filter
watchPoll	Poll a watch subscription
watchSub	Subscribe to entity data
watchUnsub	Unsubscribe to entity data

filetypes


csv	Comma Separated Values - see CSV
json	Haystack JavaScript Object Notation format - see Json
jsonld	JavaScript Object Notation for Linked Data - see RDF
trio	Haystack Tag Record Input Output - see Trio
turtle	RDF Turtle - see RDF
zinc	Haystack typed CSV format - see Zinc

accumulate

Accumulate the tag's value during inheritance and defx. Tags marked as accumulate are aggregated together during normalization and deduplicated. This marker must only be used on tags which expect a list value.

meta


def	accumulate
is	marker
lib	lib:ph

supertypes


marker	Marker labels a dict with typing information

def

association

Associations model ontological relationships between definitions. See Associations chapter.

meta


def	association
is	list
lib	lib:ph
of	symbol
uiInput	uiDev::SymbolListInput

supertypes


val	Data value type
list	Ordered list of zero or more values

subtypes


is	Defines one or more supertypes of a subtyping relationship
quantities	Quantities used to measure this phenomenon
quantityOf	Associates quantity as measurement of a phenomenon
tagOn	This tag is used on the given entity
tags	Tags used with this entity

def

baseUri

Base URI for normalizing relative URIs

meta


def	baseUri
is	uri
lib	lib:ph
tagOn	lib

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
uri	Universal resource identifier

def

bool

Boolean value true or false. See Kinds chapter.

meta


def	bool
is	scalar
lib	lib:ph

supertypes


val	Data value type
scalar	Scalar is an atomic value kind

subtypes


mqttCleanSession	Whether to set the clean session flag on the connect request to the broker
mqttRetain	Set the retention flag on a published message

def

children

List of prototypes contained by this entity. See Protos chapter for more details.

meta


accumulate	✓
def	children
is	list
lib	lib:ph
of	dict

supertypes


val	Data value type
list	Ordered list of zero or more values

def

childrenFlatten

List of aspects to flatten into children prototypes. See Protos chapter for more details.

meta


def	childrenFlatten
is	list
lib	lib:ph
of	symbol

supertypes


val	Data value type
list	Ordered list of zero or more values

def

choice

Choice specifies an exclusive marker selection. See Choices chapter.

meta


def	choice
is	marker
lib	lib:ph
uiInput	ui::ChoiceInput

supertypes


marker	Marker labels a dict with typing information

subtypes


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
arcType	Document type which determines workflow
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 accounts for the phase angle between voltage and current but excludes effects of nonlinear waveforms ( harmonic distortion)
pfDistortion	Distortion power factor, which measures the component of power factor attributable to harmonic distortion in voltage and current waveforms
pfTrue	True power factor, which includes effects of harmonic distortion
pfStandard	Standard for interpreting power factor's positive or negative sign
pfIec	Power factor according to the IEC convention defines a positive or negative sign based on the direction of active power flow
pfIeee	Power factor according to the IEEE convention defines a positive or negative sign based on whether the load is capacitive or inductive
phaseCount	Number of phases for an AC electrical power system or connected equipment
singlePhase	Single-phase AC electricity
splitPhase	Split-phase AC electricity
threePhase	Three-phase AC electricity
twoPhase	Two-phase AC electricity
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
ruleType	Rule type choice
curRule	Marker tag for a cur rule type
kpiRule	Marker tag for a KPI rule type
sparkRule	Marker tag for a spark rule type
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

def

computedFromReciprocal

Indicates a relationship that is computed from its reciprocal. Computed defs cannot be used as tags themselves.

meta


def	computedFromReciprocal
is	marker
lib	lib:ph

supertypes


marker	Marker labels a dict with typing information

def

containedBy

The entity is logically contained by the referent.

meta


def	containedBy
is	relationship
lib	lib:ph
reciprocalOf	contains
transitive	✓
uiInput	uiDev::SymbolInput

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
symbol	Symbol to a def
relationship	Ref tags used to model entity-to-entity relationships

def

contains

Entities logically contained by this entity

meta


computedFromReciprocal	✓
def	contains
is	relationship
lib	lib:ph
reciprocalOf	containedBy
transitive	✓
uiInput	uiDev::SymbolInput

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
symbol	Symbol to a def
relationship	Ref tags used to model entity-to-entity relationships

def

coord

Geographic coordinate in latitude/longitude in decimal degrees. See Kinds chapter.

meta


def	coord
is	scalar
lib	lib:ph

supertypes


val	Data value type
scalar	Scalar is an atomic value kind

subtypes


geoCoord	Geographic coordinate as `C(latitude,longitude)`

def

date

ISO 8601 date as year, month, day: 2011-06-07. See Kinds chapter.

meta


def	date
is	scalar
lib	lib:ph

supertypes


val	Data value type
scalar	Scalar is an atomic value kind

subtypes


dueDate	Date expected for completion of the workflow task
expires	Expiration date

def

dateTime

ISO 8601 timestamp followed by timezone identifier. See Kinds chapter.

meta


def	dateTime
is	scalar
lib	lib:ph

supertypes


val	Data value type
scalar	Scalar is an atomic value kind

subtypes


acked	Time that the alarm was acknowledged
cloneMod	Modified timestamp of the clone's progenitor
created	The timestamp when entity was created
finMailSentDate	The email `Sent date`
hisEnd	Timestamp of newest item in history
hisStart	Timestamp of oldest item in history
mod	Last modified time of record - see docSkySpark
nextTime	Next time stamp when the schedule transition
occurred	Date/Time that the alarm actually occurred
statsResetTs	Set the start time used to calculate the statistics
ts	Timestamp

def

Create a new definition bound to the given symbol. See Defs chapter.

meta


def	def
is	symbol
lib	lib:ph
uiInput	ui::SymbolNameInput

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
symbol	Symbol to a def

tags


doc	Documentation in simplified flavor of markdown
enum	Defines an eumeration of string key names
is	Defines one or more supertypes of a subtyping relationship
mandatory	Requires that the marker be applied to dicts which use the marker's subtypes
maxVal	Inclusive maximum for a numeric value
minVal	Inclusive minimum for a numeric value
notInherited	Marker applied to a def to indicate that is not inherited into subtype definitions
of	Expected value type of a collection, reference, or choice
tagOn	This tag is used on the given entity
transient	Indicates a value tag which should not be persisted
wikipedia	Hyperlink to the subject's page on Wikipedia

def

defx

Extends the given definition with additional meta tags. See Normalization.

meta


def	defx
is	symbol
lib	lib:ph
uiInput	uiDev::SymbolInput

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
symbol	Symbol to a def

def

depends

List of this library's dependencies. The dependent libs define the lib namespace. Also see Normalization.

meta


def	depends
is	list
lib	lib:ph
of	ref
tagOn	lib

supertypes


val	Data value type
list	Ordered list of zero or more values

def

deprecated

Obsoleted

meta


def	deprecated
is	marker
lib	lib:ph

supertypes


marker	Marker labels a dict with typing information

def

dict

Map of name/value tag pairs. See Kinds chapter.

meta


def	dict
is	val
lib	lib:ph

supertypes


val	Data value type

subtypes


arcPart	Arc document part
arcTransitions	State transitions used on an `arcState` def
confirm	Used on actions to prompt for confirmation
connFeatures	Defines the features supported by a given connector
enumx	Extened enum tag definitions
finInteraction	Map of name/value tag pairs
metadata	Information related to the alarm that will live with the lifecycle of the alarm
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
userAuth	Defines how a user authenticates
userMfa	Indicates the user requires multifactor authentication and which multifactor authentication method is configured
viewLink	View name and state for linking to a saved view

def

dis

Display name for an entity. See Ontology chapter.

meta


def	dis
is	str
lib	lib:ph
tagOn	entity, finSetting, func

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

doc

Documentation in simplified flavor of markdown. The first sentence up to the period is used as the summary.

Specific formatting options:

// inline formatting
*italic*           // italics font
**bold**           // bold font
'code'             // code or API term
`point`            // hyperlink to def (code link)
[text]`point`      // hyperlink with explicit link text
![alt]`image.png`  // image

// unordered list
- one
- two
- three

// ordered list; use numbers or letters
1. one
2. two
3. three

The main difference between markdown is that inline code uses single ticks and hyperlinks are annotated using the backtick. Links may be:

absolute http/https URIs
def symbol such as "site" or "hot-water"

meta


def	doc
is	str
lib	lib:ph
multiLine	✓
tagOn	arcPart, def, fav, func, projMeta

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

docAssociations

Generate a section in the docs for this association.

meta


def	docAssociations
is	marker
lib	lib:ph

supertypes


marker	Marker labels a dict with typing information

def

docTaxonomy

Generate a taxonomy tree for this term in the documentationindex. When applied to a def, then it will will be listed in the docs under the taxonomies section.

meta


def	docTaxonomy
is	marker
lib	lib:ph
notInherited	✓

supertypes


marker	Marker labels a dict with typing information

def

duration

Number with a unit of time

meta


def	duration
is	number
lib	lib:ph

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
number	Integer or floating point numbers annotated with an optional unit

subtypes


actorTimeout	Timeout for messages send to the connector's actor thread
arcbeamMinEventTime	Applied to `arcbeamConn` to tune how fast the server should send current value updates
bacnetInitInterval	Applied to ConnTuning to tune the duration between driver re-initialization
bacnetScheduleReadFreq	This tag denotes the frequency duration at which schedule read sync will occur
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
dur	Total duration of the spark periods measured in hours
haystackPollFreq	Applied to `haystackConn` to tune the duration between watch polls
hisAppendNA	Specifies the amount of time after a history point's `hisEnd` that the `hisRead()` function should append an `NA`
hisCollectCovRateLimit	Rate limits the frequency for `hisCollectCov`
hisCollectInterval	Enables interval history collection of the `curVal`
hisCollectWriteFreq	This tag configures how long to buffer collected history items in memory before flushing them to the historian
hisInterval	The interval at which sampled or consumption data is collected
hisRollupAutoMinInterval	Forces `hisRollupAuto()` to do a rollup using this interval when none is specified and the range of the source history grid is less than 2 days
hisRollupInterval	Indicates the roll-up interval in his grid column meta-data
hisTsPrecision	Controls the precision used to store timetamps in the historian
modbusReadTimeout	How long to wait before timing out on a modbus read
modbusWriteTimeout	How long to wait before timing out on a modbus write
mqttRetryInterval	How long to wait between retries for messages that require acknowlegment
obixPollFreq	Duration between obixConn watch polls
obsScheduleFreq	Schedule events with given frequency
pollTime	Frequency between polls of `curVal`
ruleFreq	Execution frequency of a curRule
staleTime	Time before a point's curStatus marked from "ok" to "stale" See Connector Tuning
steadyState	The delay before transitioning to the steady state
timeout	Maximum elapsed time to allow an operation to continue
writeMaxTime	Maximum time between writes used to send periodic writes
writeMinTime	Minimum time between writes used to throttle the speed of writes

def

entity

Top-level dicts with a unique identifier. See Ontology chapter.

meta


def	entity
icon	BorderOutlined
is	marker
lib	lib:ph

supertypes


marker	Marker labels a dict with typing information

subtypes


arc	Arc document
note	Note is a simple document without workflow
ticket	Ticket tracks a software or help case
workorder	Workorder tracks maintenance case
cloneSet	Defines a clone set to subscribe to records in a remote project
conn	Connector for communication to a remote system
arcbeamConn	Arcbeam connector
ecobeeConn	Ecobee connector
energyStarConn	Energy Star connector to a portfolio manager account
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
opcConn	Marker tag for OPC connector record which stores the configuration for connectivity to an OPC UA endpoint
sedonaConn	Sedona Sox connector to a remote device
snmpConn	SNMP connector
sqlConn	SQL connector to a relational database using JDBC
tplTrendConn	TplTrend connector
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
fav	Favorite saved view link
ghgSource	Identifies an emission source
ghgDirectSource	Direct emissions include
ghgIndirectSource	Indirect emissions are from the generation of purchased electricity
job	Background job
mlVar	Machine learning variable representing both model inputs and outputs
network	Logical communications network between two or more devices
node	Cluster node
point	Data point such as a sensor or actuator
calendar	Marker tag for a calendar entity
connPoint	Point associated with a connector for data synchronization with a remote system
arcbeamPoint	Point which synchronizes data via a arcbeam connector
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
opcPoint	Point which synchronizes data via an OPC connector
sedonaPoint	Point which synchronizes data via a Sedona connector
snmpPoint	Point which synchronizes data via an SNMP connector
sqlPoint	Point which synchronizes data via a SQL connector
tplTrendPoint	Point which synchronizes data via the TplTrend 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
tariffHis	Identifies the tariff history point for a meter
schedule	Marker tag for a schedule entity
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
provManifest	A provisioning manifest
provBuild	The manifest contains all files for a SkySpark build
provImage	The manifest is an image and can be used to deploy files to nodes in the cluster
provNode	The manifest contains files which should be applied to a specific node in the cluster
provOverlay	The manifest contains files which should be applied after the SkySpark build and patches
provPatch	The manifest contains patches for a SkySpark build
provPlatform	The manifest contains files which should be applied to a specific platform as determined by the `hostModel` tag
rule	Marker tag for a rule record
ruleTuning	Marker applied to a rec which defines a rule tuning configuration
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
tariff	A tariff rec
tariffCharge	A tariff charge rec
tariffAxonCharge	An Axon charge rec
tariffConsumptionCharge	A consumption charge rec
tariffDemandCharge	A demand charge rec
tariffFixedCharge	A fixed charge rec
tariffPercentageCharge	A percentage charge rec
task	Dispatch task function
notifyTopic	A topic that can be subscribed
user	User account
userCertificate	A user certificate
userProto	A user prototype
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

def

enum

Defines an eumeration of string key names. The range may also be applied to format a Bool ordered as "false,true". The value of this tag may be formatted in one of five ways:

dict of dicts keyed by name and Dict values for meta such as doc tag
comma separated names on one line
names separated by a "\n" newline character
markdown unordered list formatted as a series of "- name: description\n"
ref to a Xeto sys::Enum spec

Enum names should follow valid tag naming rules (start with lowercase ASCII letter and contain only ASCII letters and numbers). However in cases where mapping directly to external enumerations enum names can contain arbitrary characters such as space.

meta


def	enum
is	val
lib	lib:ph
tagOn	def, finSetting, point
uiInput	ui::EnumDefInput

supertypes


val	Data value type

def

feature

Feature namespace of definitions formatted as feature:name

meta


def	feature
lib	lib:ph

subtypes


app	UI application grouping of views
filetype	File format type definition
finDashboard	Feature namespace of definitions formatted as `feature:name`
finDropOverride	Feature namespace of definitions formatted as `feature:name`
func	Axon function
lib	Library module of symbolic definitions
ext	Extension library
sysMod	System module library
op	Operation for HTTP API
tag	Legacy backward compatible tag definitions
view	Fresco UI view

def

fileExt

Filename extension such as "csv"

meta


def	fileExt
is	str
lib	lib:ph
tagOn	filetype

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

filetype

File format type definition

meta


def	filetype
is	feature
lib	lib:ph

supertypes


feature	Feature namespace of definitions formatted as `feature:name`

tags


fileExt	Filename extension such as "csv"
mime	Mime type formatted as type/subtype

def

filetype:csv

Comma Separated Values - see CSV

meta


def	filetype:csv
dis	CSV
fileExt	csv
icon	table
is	filetype
lib	lib:ph
mime	text/csv
optsTemplate	csvOpts
reader	haystack::CsvReader
wikipedia	https://wikipedia.org/wiki/Comma-separated_values
writer	haystack::CsvWriter

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
filetype	File format type definition

tags


fileExt	Filename extension such as "csv"
mime	Mime type formatted as type/subtype

def

filetype:json

Haystack JavaScript Object Notation format - see Json

meta


def	filetype:json
dis	JSON
fileExt	json
icon	page
is	filetype
lib	lib:ph
mime	application/json
reader	haystack::JsonReader
wikipedia	https://wikipedia.org/wiki/JSON
writer	haystack::JsonWriter

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
filetype	File format type definition

tags


fileExt	Filename extension such as "csv"
mime	Mime type formatted as type/subtype

def

filetype:jsonld

JavaScript Object Notation for Linked Data - see RDF

meta


def	filetype:jsonld
dis	JSON-LD
fileExt	jsonld
icon	rdf
is	filetype
lib	lib:ph
mime	application/ld+json
wikipedia	https://wikipedia.org/wiki/JSON-LD
writer	def::JsonLdWriter

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
filetype	File format type definition

tags


fileExt	Filename extension such as "csv"
mime	Mime type formatted as type/subtype

def

filetype:trio

Haystack Tag Record Input Output - see Trio

meta


def	filetype:trio
dis	Trio
fileExt	trio
icon	page
is	filetype
lib	lib:ph
mime	text/trio
reader	haystack::TrioReader
writer	haystack::TrioWriter

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
filetype	File format type definition

tags


fileExt	Filename extension such as "csv"
mime	Mime type formatted as type/subtype

def

filetype:turtle

RDF Turtle - see RDF

meta


def	filetype:turtle
dis	Turtle
fileExt	ttl
icon	rdf
is	filetype
lib	lib:ph
mime	text/turtle
wikipedia	https://wikipedia.org/wiki/Turtle_(syntax)
writer	def::TurtleWriter

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
filetype	File format type definition

tags


fileExt	Filename extension such as "csv"
mime	Mime type formatted as type/subtype

def

filetype:zinc

Haystack typed CSV format - see Zinc

meta


def	filetype:zinc
dis	Zinc
fileExt	zinc
icon	page
is	filetype
lib	lib:ph
mime	text/zinc
reader	haystack::ZincReader
writer	haystack::ZincWriter

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
filetype	File format type definition

tags


fileExt	Filename extension such as "csv"
mime	Mime type formatted as type/subtype

def

filterStr

Haystack filter string. See Filters

meta


def	filterStr
is	str
lib	lib:ph

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

subtypes


arcAccessFilter	Restricts access to arc document records
cloneFilter	Filter string for clone set data
ghgConsumptionOn	An axon filter used by the Greenhouse Gas Emission Engine to identify the usage data to calculate emissions
mlVarFilter	Filter used for querying points by tags, providing more flexibility than mlVarPoint, although it is not mandatory
navAuxFilter	Apply extra filter string to a navigation tree
obsFilter	Filter string to define the record data set observed
obsRuleFilter	Filter string for rule records to observe
obsTargetFilter	Filter string for target records to observe
projAccessFilter	Applied to users to defines access to projects
projIncludeFilter	Selects other projects to include in UI navigation
ruleOn	Target filter for a rule or rule ready func
ruleTuningTargetFilter	Filter string to match rule target records
siteAccessFilter	Restricts access to sites
tariffUsageOn	An axon filter used by the tariff engine to identify the charge's historical usage data
userAccessFilter	Restricts which users are visible

def

geoAddr

Free form street address. Best practice is to follow local norms for a postal address. Typically this string includes the geoStreet, geoCity, geoState (in US), and geoPostalCode:

Examples:

"1600 Pennsylvania Avenue NW, Washington, DC 20500"

"10 Downing St, Westminster, London SW1A 2AA, United Kingdom"

"Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France"

meta


def	geoAddr
is	str
lib	lib:ph
tagOn	geoPlace

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

geoCity

Geographic city or locality name

meta


def	geoCity
is	str
lib	lib:ph
tagOn	geoPlace

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

geoCoord

Geographic coordinate as C(latitude,longitude)

meta


def	geoCoord
is	coord
lib	lib:ph
tagOn	geoPlace

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
coord	Geographic coordinate in latitude/longitude in decimal degrees

def

geoCountry

Geographic country as ISO 3166-1 two letter code

meta


def	geoCountry
enum	See below
is	str
lib	lib:ph
tagOn	geoPlace

enum


AF	Afghanistan
AX	Aland Islands
AL	Albania
DZ	Algeria
AS	American Samoa
AD	Andorra
AO	Angola
AI	Anguilla
AQ	Antarctica
AG	Antigua and Barbuda
AR	Argentina
AM	Armenia
AW	Aruba
AU	Australia
AT	Austria
AZ	Azerbaijan
BS	Bahamas
BH	Bahrain
BD	Bangladesh
BB	Barbados
BY	Belarus
BE	Belgium
BZ	Belize
BJ	Benin
BM	Bermuda
BT	Bhutan
BO	Bolivia
BA	Herzegovina
BW	Botswana
BV	Bouvet Island
BR	Brazil
IO	British Indian Ocean Territory
BN	Brunei Darussalam
BG	Bulgaria
BF	Burkina Faso
BI	Burundi
KH	Cambodia
CM	Cameroon
CA	Canada
CV	Cape Verde
KY	Cayman Islands
CF	Central African Republic
TD	Chad
CL	Chile
CN	China
CX	Christmas Island
CC	Cocos
CO	Colombia
KM	Comoros
CG	Congo
CD	Congo, the Democratic Republic of the
CK	Cook Islands
CR	Costa Rica
CI	Cote D'ivoire
HR	Croatia
CU	Cuba
CY	Cyprus
CZ	Czech Republic
DK	Denmark
DJ	Djibouti
DM	Dominica
DO	Dominican Republic
EC	Ecuador
EG	Egypt
SV	El Salvador
GQ	Equatorial Guinea
ER	Eritrea
EE	Vatican City State See Holy
ET	Ethiopia
FK	Falkland Islands
FO	Faroe Islands
FJ	Fiji
FI	Finland
FR	France
GF	French Guiana
PF	French Polynesia
TF	French Southern Territories
GA	Gabon
GM	Gambia
GE	Georgia
DE	Germany
GH	Ghana
GI	Gibraltar
GR	Greece
GL	Greenland
GD	Grenada
GP	Guadeloupe
GU	Guam
GT	Guatemala
GG	Guernsey
GN	Guinea
GW	Guinea-bissau
GY	Guyana
HT	Haiti
HM	Heard Island and Mcdonald Islands
VA	Vatican
HN	Honduras
HK	Hong Kong
HU	Hungary
IS	Iceland
IN	India
ID	Indonesia
IR	Iran
IQ	Iraq
IE	Ireland
IM	Isle of Man
IL	Israel
IT	Italy
JM	Jamaica
JP	Japan
JE	Jersey
JO	Jordan
KZ	Kazakhstan
KE	Kenya
KI	Kiribati
KP	Korea, Democratic People's Republic of
KR	Korea
KW	Kuwait
KG	Kyrgyzstan
LA	Lao
LV	Latvia
LB	Lebanon
LS	Lesotho
LR	Liberia
LY	Libyan Arab Jamahiriya
LI	Liechtenstein
LT	Lithuania
LU	Luxembourg
MO	Macao
MK	Macedonia
MG	Madagascar
MW	Malawi
MY	Malaysia
MV	Maldives
ML	Mali
MT	Malta
MH	Marshall Islands
MQ	Martinique
MR	Mauritania
MU	Mauritius
YT	Mayotte
MX	Mexico
FM	Micronesia
MD	Moldova
MC	Monaco
MN	Mongolia
ME	Montenegro
MS	Montserrat
MA	Morocco
MZ	Mozambique
MM	Myanmar
NA	Namibia
NR	Nauru
NP	Nepal
NL	Netherlands
AN	Netherlands Antilles
NC	New Caledonia
NZ	New Zealand
NI	Nicaragua
NE	Niger
NG	Nigeria
NU	Niue
NF	Norfolk Island
MP	Northern Mariana Islands
NO	Norway
OM	Oman
PK	Pakistan
PW	Palau
PS	Palestine
PA	Panama
PG	Papua New Guinea
PY	Paraguay
PE	Peru
PH	Philippines
PN	Pitcairn
PL	Poland
PT	Portugal
PR	Puerto Rico
QA	Qatar
RE	Reunion
RO	Romania
RU	Russian Federation
RW	Rwanda
BL	Saint Barthelemy
SH	Saint Helena
KN	Saint Kitts and Nevis
LC	Saint Lucia
MF	Saint Martin
PM	Saint Pierre and Miquelon
VC	Saint Vincent and the Grenadines
WS	Samoa
SM	San Marino
ST	Sao Tome and Principe
SA	Saudi Arabia
SN	Senegal
RS	Serbia
SC	Seychelles
SL	Sierra Leone
SG	Singapore
SK	Slovakia
SI	Slovenia
SB	Solomon Islands
SO	Somalia
ZA	South Africa
GS	South Georgia and the South Sandwich Islands
ES	Spain
LK	Sri Lanka
SD	Sudan
SR	Suriname
SJ	Svalbard and Jan Mayen
SZ	Swaziland
SE	Sweden
CH	Switzerland
SY	Syrian Arab Republic
TW	Taiwan
TJ	Tajikistan
TZ	Tanzania
TH	Thailand
TL	Timor-leste
TG	Togo
TK	Tokelau
TO	Tonga
TT	Trinidad and Tobago
TN	Tunisia
TR	Turkey
TM	Turkmenistan
TC	Turks and Caicos Islands
TV	Tuvalu
UG	Uganda
UA	Ukraine
AE	United Arab Emirates
GB	Great Britain
US	USA
UM	United States Minor Outlying Islands
UY	Uruguay
UZ	Uzbekistan
VU	Vanuatu
VE	Venezuela
VN	Viet Nam
VG	Virgin Islands, British
VI	Virgin Islands, U.S.
WF	Wallis and Futuna
EH	Western Sahara
YE	Yemen
ZM	Zambia
ZW	Zimbabwe

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

geoCounty

Geographic subdivision of US state

meta


def	geoCounty
is	str
lib	lib:ph
tagOn	geoPlace

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

geoElevation

Elevation above sea-level of the location

meta


def	geoElevation
is	number
lib	lib:ph
tagOn	geoPlace

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
number	Integer or floating point numbers annotated with an optional unit

def

geoPlace

Geographic place

meta


def	geoPlace
is	marker
lib	lib:ph

supertypes


marker	Marker labels a dict with typing information

subtypes


site	Site is a geographic location of the built environment
weatherStation	Logical weather station and its measurement points

tags


geoAddr	Free form street address
geoCity	Geographic city or locality name
geoCoord	Geographic coordinate as `C(latitude,longitude)`
geoCountry	Geographic country as ISO 3166-1 two letter code
geoCounty	Geographic subdivision of US state
geoElevation	Elevation above sea-level of the location
geoPostalCode	Geographic postal code
geoState	State or province name
geoStreet	Geographic street address and name

def

geoPostalCode

Geographic postal code; for US this is a five digit zip code

meta


def	geoPostalCode
is	str
lib	lib:ph
tagOn	geoPlace

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

geoState

State or province name; for US this is two letter state code. May be used in other countries to model administrative area between the geoCity and geoCountry level.

meta


def	geoState
enum	See below
is	str
lib	lib:ph
openEnum	✓
tagOn	geoPlace

enum


AL	Alabama
AK	Alaska
AS	American Samoa
AZ	Arizona
AR	Arkansas
CA	California
CO	Colorado
CT	Connecticut
DE	Delaware
DC	District of Columbia
FM	Federated States of Micronesia
FL	Florida
GA	Georgia
GU	Guam
HI	Hawaii
ID	Idaho
IL	Illinois
IN	Indiana
IA	Iowa
KS	Kansas
KY	Kentucky
LA	Louisiana
ME	Maine
MH	Marshall Islands
MD	Maryland
MA	Massachusetts
MI	Michigan
MN	Minnesota
MS	Mississippi
MO	Missouri
MT	Montana
NE	Nebraska
NV	Nevada
NH	New Hampshire
NJ	New Jersey
NM	New Mexico
NY	New York
NC	North Carolina
ND	North Dakota
MP	Northern Mariana Islands
OH	Ohio
OK	Oklahoma
OR	Oregon
PW	Palau
PA	Pennsylvania
PR	Puerto Rico
RI	Rhode Island
SC	South Carolina
SD	South Dakota
TN	Tennessee
TX	Texas
UT	Utah
VA	Virginia
VI	Virgin Islands
VT	Vermont
WA	Washington
WV	West Virginia
WI	Wisconsin
WY	Wyoming

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

geoStreet

Geographic street address and name

meta


def	geoStreet
is	str
lib	lib:ph
tagOn	geoPlace

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

grid

Two dimension table of columns and rows. See Kinds chapter.

meta


def	grid
is	val
lib	lib:ph

supertypes


val	Data value type

subtypes


calendarGrid	Configures the items for a daily calendar
ghgFactorGrid	Identifies emission factor values to calculate the emissions of the associated Greenhouse Gas
scheduleGrid	Configures the items for a schedule
tariffRanges	The fee ranges for a usage-based charge

def

id

Defines the unique identifier of an entity in system using a ref value type. The scope of an entity is undefined, but must be unique with a given system or project. This identifier may be used by other entities for cross-referencing. See Ontology chapter.

meta


def	id
is	ref
lib	lib:ph
tagOn	entity

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
ref	Reference to an entity

def

input

Entity inputs a substance which flows from another entity

meta


def	input
is	marker
lib	lib:ph

supertypes


marker	Marker labels a dict with typing information

subtypes


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

def

inputs

The entity inputs a substance from the referent. The value of this tag is what is received.

meta


def	inputs
is	relationship
lib	lib:ph
reciprocalOf	outputs
transitive	✓
uiInput	uiDev::SymbolInput

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
symbol	Symbol to a def
relationship	Ref tags used to model entity-to-entity relationships

def

int

Unitless integer number

meta


def	int
is	number
lib	lib:ph

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
number	Integer or floating point numbers annotated with an optional unit

subtypes


arcbeamWriteLevel	Number between 1 and 16 used with `arcbeamWrite` to determine which priority level of the remote system is written to
floorNum	Unitless integer indicating the floor's distance from ground level
haystackWriteLevel	Number between 1 and 16 used with `haystackWrite` to determine which priority level of the remote system is written to
hisSize	Approximate number of timestamp/value pairs stored in history
modbusBlockGap	Applied to `modbusConn` to allow for gaps in block reads
modbusBlockMax	Applied to `modbusConn` to limit the maximum number of registers to read in a block read
modbusSlave	Applied to `modbusConn` to identify the slave address on this modbus network
mqttMaxRetry	How many times to retry sending messages that require acknowlegment
obixWritable	Server export of a writable point as an `obix:Writable:Point`
obixWriteLevel	Number between 1 and 16 used with `obixWrite` to determine which priority level of the remote system is written to
schedulable	Binds a `schedule` to a writable point
stage	Stage number of staged equipment operation such as coil or pump
writeLevel	Current priority level for `writeVal` as number between 1 and 17
yearBuilt	Original year of construction as four digit year such as 1980

def

is

Defines one or more supertypes of a subtyping relationship. See Subtyping chapter.

meta


def	is
is	association
lib	lib:ph
of	symbol
tagOn	def
uiInput	uiDev::SymbolListInput

supertypes


val	Data value type
list	Ordered list of zero or more values
association	Associations model ontological relationships between definitions

def

kind

Kind name used to identity a value data type

meta


def	kind
enum	See below
is	str
lib	lib:ph
tagOn	finSetting, point
uiInput	ui::KindInput

enum


Marker	is-a label
Bool	true or false
NA	not available
Number	floating point with optional unit
Str	Unicode string
Uri	Universal resource identifier
Ref	reference to an entity
Date	an ISO 8601 date as year, month, day: 2011-06-07
Time	an ISO 8601 time as hour, minute, seconds: 09:51:27.354
DateTime	an ISO 8601 timestamp followed by timezone name
Coord	geographic coordinate in latitude/longitude formatted as C(lat,lng)
XStr	extended string with type name
List	ordered sequence
Dict	key/value map
Grid	two dimensional tabular data collection

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

lib

Library module of symbolic definitions. See Namespaces chapter.

meta


def	lib
is	feature
lib	lib:ph

supertypes


feature	Feature namespace of definitions formatted as `feature:name`

subtypes


ext	Extension library
sysMod	System module library

tags


baseUri	Base URI for normalizing relative URIs
connTuningRef	Reference to a tuning configuration defined by a `connTuning` rec
depends	List of this library's dependencies
version	Version string formatted as decimal integers separated by a dot

def

list

Ordered list of zero or more values. See Kinds chapter.

meta


def	list
is	val
lib	lib:ph

supertypes


val	Data value type

subtypes


association	Associations model ontological relationships between definitions
is	Defines one or more supertypes of a subtyping relationship
quantities	Quantities used to measure this phenomenon
quantityOf	Associates quantity as measurement of a phenomenon
tagOn	This tag is used on the given entity
tags	Tags used with this entity
attachments	List of attachments as URIs in the virtual file tree
children	List of prototypes contained by this entity
childrenFlatten	List of aspects to flatten into children prototypes
depends	List of this library's dependencies
fileAccess	List of directory Uris that a non-su user has read-write access to
fileAccessReadOnly	List of directory Uris that a non-su user has read-only access to
linter	Fantom qname of `Linter` class
meterPoints	This point, configured on the uiMeta record, defines the meter points that will be available in the energy app
mlInputVarRefs	List of independent variables, also known as model inputs or features, associated with a machine learning model
notifications	The set of notifications a user is subscribed to
obsScheduleTimes	Schedule events for given times of the day
prefUnit	Defines a preferred unit to be used with a quantity
spanModes	Restrict Span input modes
tariffChargeRefs	The charges that a percentage charge applies to
userAllow	List of function names to allow on this user
weatherSyncIds	Applied to a `weatherStation` to indicate which weather points to sync for that station

def

mandatory

Requires that the marker be applied to dicts which use the marker's subtypes. This tag is typically applied to top-level entity tags such as equip. For example if an instance is tagged with a subtype of equip such as tank, then the instance must also include the equip tag as a mandatory marker.

meta


def	mandatory
is	marker
lib	lib:ph
notInherited	✓
tagOn	def

supertypes


marker	Marker labels a dict with typing information

def

marker

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

meta


def	marker
lib	lib:ph

subtypes


absorption	Cooling process using energy from heat source such as hot water
chiller-absorption	Cooling process using energy from heat source such as hot water
ac	Relating to alternating current (AC) electricity
accumulate	Accumulate the tag's value during inheritance and defx
ackInProgress	This alarm is current being acknowledged
ackMessageRequired	This alarm requires a message when acknowledging
ackRequired	This alarm requires acknowledgement
active	Working, operative, effective
addOn	Feature which may be enabled or disabled at runtime
admin	Requires admin permission
advanced
alarm	Notification of a condition which requires attention
alarmHistory	Alarm history record
alarmConfig	This tag identifies a tag bundle as an alarm configuration
alarmEmailToggle	Having to do with the alarm email toggle
angle	Measurement of the relative difference in direction between two vectors or phasors
apparent	Perceived quantity
arcLabel	Base type for arc document label tags
arcBreakdown	Mechanical failure
arcBug	Software defect causing improper behavior
arcDamage	Equipment has been physically damaged
arcElectrical	Task is electrical in nature
arcEnhancement	Software request to add new functionality
arcHvac	Task is HVAC in nature
arcInspection	Equipment requires inspection
arcMaintenance	Preventative or scheduled maintenance task
arcPlumbing	Task is plumbing in nature
arcSafety	Hazardous situation
arcSupport	Assistance required
arcWish	Wish list for future enhancement
arcTypeDefault	Make an arc type the default selection in the UI
arcUnassignable	Hides the user from `assignedTo` field on arc documents
atmospheric	Related to the atmosphere of the earth
auditCommit	Log each time a diff is committed to the folio database
avg	Average
axonTemplate	This is a sample axon query that can be used like a template
baSuExec	BA Super User (Defined here because the BA connector does not support 5.0)
bacnetConn	Marker tag for BACnet connection
bacnetDevice	Applied to a `record` to create a BACnet device object
bacnetDisableCov	Applied to ConnTuning to disable the COV for a specific point or all the points in a connector
bacnetEnableOutOfService	Applied to ConnTuning will enable getting the overridden value for points that have the BACnet OUT_OF_SERVICE (Remote Disabled) status flag
bacnetEnumPropMapping	Marker tag for Enum and property value conversion mapping for schedule object
bacnetServerDevice	Applied to a `record` to create a BACnet device object
bacnetServerIgnore	Apply the bacnetServerIgnore marker tag to any point you do not want to process or expose via the BACnet server
bacnetServerReadOnly	Apply the bacnetServerReadOnly marker tag to any points you wish to expose as read-only via the BACnet server, while still allowing them to be writable within FIN.Execute the folio query bacnetServerSyncDevices() to ensure all devices are synchronized with this new configuration
bacnetUseConfirmedCov	Applied to ConnTuning to make the COV subscription mechanism to use confirmed COV messages
barometric	Relating atmospheric pressure
baseChart	Basic charting functions
batchRecords	Indicates that the function will process multiple records
beta	Indicates a beta quality definition
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
chart	Functions related to charting
chartLegendNoSort	Disable sorting series by their display name in the legend
chartNoScroll	Disable scrollbars in viz charts
chartOnDownload
chartTest
childData
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
arcType	Document type which determines workflow
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 accounts for the phase angle between voltage and current but excludes effects of nonlinear waveforms ( harmonic distortion)
pfDistortion	Distortion power factor, which measures the component of power factor attributable to harmonic distortion in voltage and current waveforms
pfTrue	True power factor, which includes effects of harmonic distortion
pfStandard	Standard for interpreting power factor's positive or negative sign
pfIec	Power factor according to the IEC convention defines a positive or negative sign based on the direction of active power flow
pfIeee	Power factor according to the IEEE convention defines a positive or negative sign based on whether the load is capacitive or inductive
phaseCount	Number of phases for an AC electrical power system or connected equipment
singlePhase	Single-phase AC electricity
splitPhase	Split-phase AC electricity
threePhase	Three-phase AC electricity
twoPhase	Two-phase AC electricity
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
ruleType	Rule type choice
curRule	Marker tag for a cur rule type
kpiRule	Marker tag for a KPI rule type
sparkRule	Marker tag for a spark rule type
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
clone	Marks a record as a clone
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.
connDebug	Connector debugging functions
connTrees	Related to dbAddEdit
contextSensitive	This is docs or video that are context Sensitive
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
customaryUnits	Add this tag to the WeatherExt rec to force all units in forecast and history syncs to be in US customary system (degrees F)
damper	Damper equipment or control point
dbAddEdit	Marks a function that holds add/edit logic for DB Builder forms
dc	Relating to direct current (DC) electricity
deadband	The range in a process where no changes to output are made
deleteTop
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
digTime	Related to digest time functions
disableOverridableChecks	Disables function `overridable` checking
disabled	Indicates the entity is in a disabled state
disjoinCurValWriteArray	This marker tag is applied on <bacnetServer> ext
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
editSum
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`
energyBaselineFunc	Marker tag on a function which can be used to generate a baseline curve
energyNormFunc	Marker tag on a function which can be used to normalize energy data
entity	Top-level dicts with a unique identifier
arc	Arc document
note	Note is a simple document without workflow
ticket	Ticket tracks a software or help case
workorder	Workorder tracks maintenance case
cloneSet	Defines a clone set to subscribe to records in a remote project
conn	Connector for communication to a remote system
arcbeamConn	Arcbeam connector
ecobeeConn	Ecobee connector
energyStarConn	Energy Star connector to a portfolio manager account
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
opcConn	Marker tag for OPC connector record which stores the configuration for connectivity to an OPC UA endpoint
sedonaConn	Sedona Sox connector to a remote device
snmpConn	SNMP connector
sqlConn	SQL connector to a relational database using JDBC
tplTrendConn	TplTrend connector
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
fav	Favorite saved view link
ghgSource	Identifies an emission source
ghgDirectSource	Direct emissions include
ghgIndirectSource	Indirect emissions are from the generation of purchased electricity
job	Background job
mlVar	Machine learning variable representing both model inputs and outputs
network	Logical communications network between two or more devices
node	Cluster node
point	Data point such as a sensor or actuator
calendar	Marker tag for a calendar entity
connPoint	Point associated with a connector for data synchronization with a remote system
arcbeamPoint	Point which synchronizes data via a arcbeam connector
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
opcPoint	Point which synchronizes data via an OPC connector
sedonaPoint	Point which synchronizes data via a Sedona connector
snmpPoint	Point which synchronizes data via an SNMP connector
sqlPoint	Point which synchronizes data via a SQL connector
tplTrendPoint	Point which synchronizes data via the TplTrend 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
tariffHis	Identifies the tariff history point for a meter
schedule	Marker tag for a schedule entity
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
provManifest	A provisioning manifest
provBuild	The manifest contains all files for a SkySpark build
provImage	The manifest is an image and can be used to deploy files to nodes in the cluster
provNode	The manifest contains files which should be applied to a specific node in the cluster
provOverlay	The manifest contains files which should be applied after the SkySpark build and patches
provPatch	The manifest contains patches for a SkySpark build
provPlatform	The manifest contains files which should be applied to a specific platform as determined by the `hostModel` tag
rule	Marker tag for a rule record
ruleTuning	Marker applied to a rec which defines a rule tuning configuration
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
tariff	A tariff rec
tariffCharge	A tariff charge rec
tariffAxonCharge	An Axon charge rec
tariffConsumptionCharge	A consumption charge rec
tariffDemandCharge	A demand charge rec
tariffFixedCharge	A fixed charge rec
tariffPercentageCharge	A percentage charge rec
task	Dispatch task function
notifyTopic	A topic that can be subscribed
user	User account
userCertificate	A user certificate
userProto	A user prototype
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
event	Event dict - see docs
evse	Electric Vehicle Supply Equipment
exclude	Marks a series are excluded from the chart
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
finActionCat	Indicates that the function will process fin actions
finAsset	Marks resources published from FIN Builder as asset files
finBestPractice	This is either docs or videos that are best practices, typically videos
finBucket	This tag means that the resource is a FIN Bucket resource
finBuilder	This tag is used for content that is used in FIN Builder
finBuilderAction	This resource belongs to a FIN Builder Action
finBuilderComponent	This tag means that the resource is associated with a component
finBuilderCustom	This tag means that the finp file is a custom graphic, IE.
finBuilderMenu	Identifies functions that have elements for right-click menus in Graphics Builder
finCommonQuery	Identifies functions that return common queries to be used with folio
finDocs	Tag that has a link to docs.finproducts.com
finDocsPath	This is the path where you find the docs in docs.finproducts.com
finExample	This tag is for an something that is an example, either for a video, or docs typically
finFile	Marker for Fin Builder published file resource, the actual file stored on disk
finFileUpload	Marker for Fin Builder uploaded files
finForm	Form Record Selector Tag
finIcon	Marker for Fin Builder published project icon file
finKeyWords	A Comma Seperated string that we can add keywords too, so the user can search on this tag
finMailConn	Marker tag for finMail connection
finMailDEBUG	Marker tag to set the mail connection in debug mode
finMailRec	Marker tag for an email message record
finMailSSL	Marker tag to set the connection to use SSL
finMime	Marker for Fin Builder published file resource mime type
finModel	This asset is a FIN Model that can be opened in FIN BUilder
finModelFunc	Defines functions that returns FIN Models
finNavTree	Indentifies a function as containing a root node for a DB Builder tree
finProject	Marks resources published from FIN Builder as project files
finRemoteAsset	Defines functions that returns graphics remote assets
finRemoteResource
finResource	Marks resources published from FIN Builder
finRuntime	Marks resources published from FIN Builder as runtime files (i.e
finSavedChart
finScreenshot	Marker for Fin Builder published project screen shot file
finStack	This tag means the asset can be used in FIN
finStackMobileMenu
finString	Having to do with fin string related functions
finTemplateFunc	Defines functions that returns FIN Templates
finThumb	Marker for Fin Builder published project thumb file
finTipsAndTricks	This is a resource for FIN Tips and Tricks
finUpdateRecords
finUri	Marker for Fin Builder published resource Uri
finVideo	This tag means it's a video
finVideoPath	This is the path that goes to youTube for the video
finWatcherAdded	Marker tag for an added record
finWatcherCallback	Marker tag for a callback function that instructs the watcher to call it when changes are detected
finWatcherChanged	Marker tag for a changed record
finWatcherRemoved	Marker tag for a removed record
finpFile	The asset is a finp file, that can be downloaded and opened in FIN Builder
flux	Measurement through a given surface
folderPath	Folder Path Tag
foo	Useless
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
ghgFactorHis	Identifies point record with interval emission factor data that the Greenhouse Gas Emission Engine uses to calculate emissions
ghgFuelSource	Identifies a direct fuel source used for combustion
ghgHeatContent	Identifies a direct emission with local heat content data
ghgMobileCombustion	Identifies direct GHG emissions associated with fuel combustion in owned or operated mobile sources
ghgStationaryCombustion	Identifies direct GHG emissions from stationary (non-transport) combustion of fossil fuels at a facility (e.g., boilers, turbines, process heat)
globalCont	Defines usage in Global Control
ground	Related to the surface of the earth
haystackApi	Function which is a published Hasytack REST API op
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
hidden	Hide a column in a table or a field on a form
hideFromMobileDB	Hide from database builder
hideMobile	Used to hide forms in mobile
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"
hisConfig	This tag identifies a tag bundle as a history configuration
hisFuncReady	Indicates a function designed to be used directly as a `computed history`
hisFuncWritable	Allow writing raw data to a point that has the `hisFunc` tag
hisSrc	Legacy 2.1 support for function picker in History App
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
isolate	Isolate this node from making inbound requests
isolation	Actuator used to isolate an equipment from a pipe or ductwork system
knxConn	Marker tag for the KNX connector record which stores the connectivity configuration used to access a KNX access point
knxDevice	Marker tag on records that represent a physical KNX device
knxRouter	When present on a knxConn, the watchdog will ping router devices (detected from the ETS project file) first and skip bus device checks if the router is unreachable
knxWatchdogEnabled	Enable periodic KNX device connectivity watchdog polling
kpi	Marker tag to indicate a KPI dict
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
metricUnits	Add this tag to the WeatherExt rec to force all units in forecast and history syncs to be in metric system (degrees C)
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
multi	Indicates multiple selection
multiLine	Indicates that a multi-line text input should be used
navCluster	Select from all the nodes in the cluster
navHidden	Hide an entity in the navigation selection pickers
navSelAny	Select any level of a navigation tree which might include groupings
navSelAnyRec	Select any level of a navigation tree which maps to Folio record
net	Difference between import and export
networking	Related to data communication networks
neutral	when applied to a point entity that has the `elec` and `current` tags, indicates electrical current being measured on an electrical neutral conductor
noDoc	Documentation Ignore Tag
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
obsEvents	Subscribe to event creation - see docs
obsMqtt	Subscribe to MQTT connector published messages
obsRecs	Base class for observables on database records
obsArcs	Subscribe to arc document changes - see docs
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
obsSparks	Subscribe to rule engine sparks - see docs
obsolete	Marks a function as obsolete and that it needs to be reviewed before removal
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
optional	Not required
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
polyStats
poo	Useless
port	A gateway or opening used to transfer a substance
powerConverter	Converts one electrical waveform to another using power electronic circuitry
private	Marks the function as private
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	Apparent energy in an AC eletrical power system
apparent-power	Apparent 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 phase imbalance
current-thd	Total harmonic distortion (THD) of AC 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	Root-mean-square (RMS) magnitude of AC electrical current
elec-volt	Electrical voltage, potential difference
volt-magnitude	Root-mean-square (RMS) magnitude of AC 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
active-energy	Active energy in an AC eletrical power system
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 an alternating current waveform
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	Rate of electrical energy transfer
active-power	Active power or real power
elec-demand	Active power averaged over a regular 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	Reactive energy in an AC eletrical power system
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 phase imbalance
volt-thd	Total harmonic distortion (THD) of AC 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
readonly	Indicates a value which may be read, but not written
reciprocal	Piston compressor driven by a crankshaft
chiller-reciprocal	Piston compressor driven by a crankshaft
refresh	Indicates an operation which requires a page refresh
reheat	Command point for reheating process
relationshipFunc	Indentifies functions that hold pre-configured relationships
relationshipTree	Related to dbAddEdit
removeTags	A comma separated list of tags to be removed from records
reportCanSave	Enables an operator user to save reports to the database
restart	Indicates a setting which requires restart when modified
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`
savedQueryFilterTree	Related to dbAddEdit
scheduleConfig	This tag identifies a tag bundle as a schedule configuration
select	Used on an action to use current selection
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
showDis	Show display names in UI instead of programmatic names
sitePoint	Marker tag applied to a `point` to indicate the point is site-wide
spark	Marker tag to indicate a spark dict
standby	Readiness mode of a space
su	Requires superuser permission
subterranean	Below the surface of the earth
summs
switch	Device for toggling state or routing data
tagBundle	This tag identifies records as tag bundles
tagBundleFunc	Indentifies functions that hold pre-configured tag bundles
tagBundleTree	Related to dbAddEdit
templateTree	Related to dbAddEdit
thd	Total harmonic distortion
thermal	Related to energy of heat
timez	Definition of a timezone function
topics
total	Complete or absolute
trackBundle	This tag indicates records should keep track of when this tag bundle is applied to them
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
uiMeta	Singleton used to configure project level user interface settings
unitless	Hide the unit picker for a number field
unocc	Unoccupied mode of a space
update
userLockOut	Indicates the user is locked out because of too many failed login attempts
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
weatherAutoSyncForecast	Applied to a `weatherStation` to indicate that the weather forecast should be automatically synchronized using built-in weather subscription
weatherAutoSyncHis	Applied to a `weatherStation` to indicate that point histories should automatically be synchronized with built-in weather subscription
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

def

max

Maximum

meta


def	max
is	marker
lib	lib:ph

supertypes


marker	Marker labels a dict with typing information

def

maxVal

Inclusive maximum for a numeric value.

meta


def	maxVal
is	number
lib	lib:ph
tagOn	def, point

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
number	Integer or floating point numbers annotated with an optional unit

def

mime

Mime type formatted as type/subtype

meta


def	mime
is	str
lib	lib:ph
tagOn	filetype

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

min

Minimum

meta


def	min
is	marker
lib	lib:ph

supertypes


marker	Marker labels a dict with typing information

def

minVal

Inclusive minimum for a numeric value.

meta


def	minVal
is	number
lib	lib:ph
tagOn	def, point

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
number	Integer or floating point numbers annotated with an optional unit

def

na

Not available used to indicate invalid or missing data. See Kinds chapter.

meta


def	na
is	scalar
lib	lib:ph

supertypes


val	Data value type
scalar	Scalar is an atomic value kind

def

noSideEffects

Marks a function or operation as having no side effects. The function may or may not be pure in that calling it multiple times with the same arguments always evaluates to the same result.

meta


def	noSideEffects
is	marker
lib	lib:ph
wikipedia	https://en.wikipedia.org/wiki/Side_effect_(computer_science)

supertypes


marker	Marker labels a dict with typing information

def

nodoc

Undocumented and not officially supported

meta


def	nodoc
is	marker
lib	lib:ph

supertypes


marker	Marker labels a dict with typing information

def

nosrc

Do not include source code in documentation

meta


def	nosrc
is	marker
lib	lib:ph

supertypes


marker	Marker labels a dict with typing information

def

notInherited

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

meta


def	notInherited
is	marker
lib	lib:ph
tagOn	def

supertypes


marker	Marker labels a dict with typing information

def

number

Integer or floating point numbers annotated with an optional unit. See Kinds chapter.

meta


def	number
is	scalar
lib	lib:ph

supertypes


val	Data value type
scalar	Scalar is an atomic value kind

subtypes


area	Area of a shape or floor space
bacnetAlarmPid	It specifies the connector will only handle alarms associated with that process identifier
bacnetCovResubscribeTimeout	Applied to ConnTuning specifies when the COV re-subscribe should be performed for points that failed to be subscribed
bacnetCovTimeout	Applied to ConnTuning to specify the lifetime for a COV subscription sent to the device
bacnetInstance	Applied to `bacnetDevice` it specifies what device instance number is used when the connector is in COV mode, the default instance number randomly picked between 50000 and 200000
bacnetServerCovIncrement	Numeric tag that sets the delta threshold for when a COV notification should be send
bacnetServerInstance	Applied to a `bacnetDevice` to export it as an BACnet device
bacnetServerMacAddress	Applied to a `bacnetServerDevice` assigns an unique mac address to this device
bacnetServerNetwork	Applied to a bacnetServer `ext` record assigns an unique BACnet network number to the current project the extension is enabled in
bacnetServerRefreshInterval	Numeric tag that says how often the BACnet server will rescan equipments on the current project
bacnetWriteLevel	Number between 1 and 17 used with bacnetWriteLevel to determine which priority level of the remote system is written to
chartHeight	Fixes the height of a chart plot
chartMax	Define explicit max value for series axis
chartMin	Define explicit min value for series axis
coolingCapacity	Measurement of a chiller ability to remove heat measured
curCalibration	Calibration value to apply to adjust the value read from the connector before updating curVal
duration	Number with a unit of time
actorTimeout	Timeout for messages send to the connector's actor thread
arcbeamMinEventTime	Applied to `arcbeamConn` to tune how fast the server should send current value updates
bacnetInitInterval	Applied to ConnTuning to tune the duration between driver re-initialization
bacnetScheduleReadFreq	This tag denotes the frequency duration at which schedule read sync will occur
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
dur	Total duration of the spark periods measured in hours
haystackPollFreq	Applied to `haystackConn` to tune the duration between watch polls
hisAppendNA	Specifies the amount of time after a history point's `hisEnd` that the `hisRead()` function should append an `NA`
hisCollectCovRateLimit	Rate limits the frequency for `hisCollectCov`
hisCollectInterval	Enables interval history collection of the `curVal`
hisCollectWriteFreq	This tag configures how long to buffer collected history items in memory before flushing them to the historian
hisInterval	The interval at which sampled or consumption data is collected
hisRollupAutoMinInterval	Forces `hisRollupAuto()` to do a rollup using this interval when none is specified and the range of the source history grid is less than 2 days
hisRollupInterval	Indicates the roll-up interval in his grid column meta-data
hisTsPrecision	Controls the precision used to store timetamps in the historian
modbusReadTimeout	How long to wait before timing out on a modbus read
modbusWriteTimeout	How long to wait before timing out on a modbus write
mqttRetryInterval	How long to wait between retries for messages that require acknowlegment
obixPollFreq	Duration between obixConn watch polls
obsScheduleFreq	Schedule events with given frequency
pollTime	Frequency between polls of `curVal`
ruleFreq	Execution frequency of a curRule
staleTime	Time before a point's curStatus marked from "ok" to "stale" See Connector Tuning
steadyState	The delay before transitioning to the steady state
timeout	Maximum elapsed time to allow an operation to continue
writeMaxTime	Maximum time between writes used to send periodic writes
writeMinTime	Minimum time between writes used to throttle the speed of writes
finBoolStatsFreq	Tune how often the FinWatcher computes boolean `runStarts` and `runTime`
finMailMaxMsgCount	Set the maximum numbers of email records this connector can store
finMailNewMessages	Shows the number of unread email
finMailPollFreq	Applied to `finMailConn` to tune the duration between email checks
finMailTotalMessages	Shows the number of email on the inbox folder
finWatcherFreq	Tune how often the FinWatcher looks for changes
geoElevation	Elevation above sea-level of the location
hisCollectCov	Enables COV history collection of the `curVal`
hisTotalizedRollover	Defines the rollover value for a totalized history - see totalized
int	Unitless integer number
arcbeamWriteLevel	Number between 1 and 16 used with `arcbeamWrite` to determine which priority level of the remote system is written to
floorNum	Unitless integer indicating the floor's distance from ground level
haystackWriteLevel	Number between 1 and 16 used with `haystackWrite` to determine which priority level of the remote system is written to
hisSize	Approximate number of timestamp/value pairs stored in history
modbusBlockGap	Applied to `modbusConn` to allow for gaps in block reads
modbusBlockMax	Applied to `modbusConn` to limit the maximum number of registers to read in a block read
modbusSlave	Applied to `modbusConn` to identify the slave address on this modbus network
mqttMaxRetry	How many times to retry sending messages that require acknowlegment
obixWritable	Server export of a writable point as an `obix:Writable:Point`
obixWriteLevel	Number between 1 and 16 used with `obixWrite` to determine which priority level of the remote system is written to
schedulable	Binds a `schedule` to a writable point
stage	Stage number of staged equipment operation such as coil or pump
writeLevel	Current priority level for `writeVal` as number between 1 and 17
yearBuilt	Original year of construction as four digit year such as 1980
knxWatchdogFreq	KNX watchdog polling interval
maxVal	Inclusive maximum for a numeric value
minVal	Inclusive minimum for a numeric value
mqttQos	MQTT Quality of Service (QoS) - `0` - At most once (fire-and-forget) - `1` - At least once - `2` - Exactly once
opacity	Alpha transparency for colors as number between 0.0 (transparent) to 1.0 (completely opaque)
order	Used to order definitions
percentage	A percentage specified as as `<percent> * 100`
strokeWidth	Stroke width for rendering lines
tariffContractMin	The minimum contractual demand necessary for this charge to apply
tariffFee	A fixed numeric fee for the charge
tariffRatchetPercentage	The peak demand identified during the ratchet period will be multiplied by this percentage to obtain the minimum peak demand
userFailedLogins	How many failed login attempts the user has made since last successful login

def

of

Expected value type of a collection, reference, or choice

meta


def	of
is	symbol
lib	lib:ph
tagOn	def
uiInput	uiDev::SymbolInput

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
symbol	Symbol to a def

def

op

Operation for HTTP API. See Ops chapter.

meta


def	op
is	feature
lib	lib:ph

supertypes


feature	Feature namespace of definitions formatted as `feature:name`

def

openEnum

Apply to str enum tags where the enumeration range is open ended. User interfaces should support data entry for arbitrary strings, but also provide a dropdown for the predefined enumeration.