附录索引（appendix）（第 2 部分）

原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793160722/FIN+5.3.1+appendix+part+2 中文整理基于 FIN 5.3.1

导读： 本页为附录索引 / 参考列表（函数、标签等）。

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

目录（导读）

（本页无二级以上标题）

API 正文（英文）


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

All ops listed alphabetically


about	Query basic information about the server
close	Close the current session and cancel the auth bearer token
commit	Commit one or more diffs to the Folio database
defs	Query the definitions in the current namespace
eval	Evaluate an Axon expression
export	Export a view to a file
ext	Ext specific HTTP servicing
filetypes	Query the filetype defs in the current namespace
hisRead	Read historized time series data from a `his-point`
hisWrite	Write historized time series data from a `his-point`
invokeAction	Invoke a user action on a target entity
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
pointWrite	Read or command a `writable-point`
read	Query the a set of entity records by id or by filter
rec	Get a record by id
watchPoll	Poll a watch subscription
watchSub	Subscribe to entity data
watchUnsub	Unsubscribe to entity data


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


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


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


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


relationship	Ref tags used to model entity-to-entity relationships
containedBy	The entity is logically contained by the referent
contains	Entities logically contained by this entity
inputs	The entity inputs a substance from the referent
outputs	The entity outputs a substance to the referent


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


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

All tags listed alphabetically


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
ackErr	This tag is set when there is an error acknowledging alarm and contains the reason for the error
ackInProgress	This alarm is current being acknowledged
ackMessage	Message or reason for acknowledgement
ackMessageRequired	This alarm requires a message when acknowledging
ackRequired	This alarm requires acknowledgement
acked	Time that the alarm was acknowledged
ackedBy	Who acknowledged the alarm
active	Working, operative, effective
actorTimeout	Timeout for messages send to the connector's actor thread
actuator	Equipment to move or control a mechanism
addOn	Feature which may be enabled or disabled at runtime
addTags	A comma separated list of tags and their values to apply to records
admin	Requires admin permission
advanced
ahu	Air Handling Unit
ahuZoneDelivery	AHU delivery method of conditioned air to the zone
air	The mixture of gases which surrounds the earth
airCooling	Cooling by dissipating heat into the surrounding air
airHandlingEquip	HVAC equipment that conditions and delivers air via one or more fans
airQuality	Concentration of contaminants in the air
airQualityZonePoints	Entity with logical grouping of zone air quality points
airRef	Air flows from the referent to this entity
airTerminalUnit	Equipment in air distribution systems which terminate at the space
airVolumeAdjustability	Ability of air handling equip to adjust volume of air flow
alarm	Notification of a condition which requires attention
alarmAckAccessFilter	String filter applied to a user record which defines which alarms a user may acknowldege
alarmConfig	This tag identifies a tag bundle as an alarm configuration
alarmEmailToggle	Having to do with the alarm email toggle
alarmHistory	Alarm history record
alarmRoute	Alarm route
alarmRule	Alarm rule
allowFilter	A string that can be parsed into a filter that determines what records the tag bunlde can be applied to
alsoSee	Legacy tag definitions
angle	Measurement of the relative difference in direction between two vectors or phasors
app	UI application grouping of views
appAccess	Restricts the set of accessible apps
appFormOn	Application Form Selector Tag
appName	View containing app name
apparent	Perceived quantity
arc	Arc document
arcAccessFilter	Restricts access to arc document records
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
arcLabel	Base type for arc document label tags
arcMaintenance	Preventative or scheduled maintenance task
arcOn	Subject of the document
arcPart	Arc document part
arcPlumbing	Task is plumbing in nature
arcPriority	Priority level of the document
arcSafety	Hazardous situation
arcState	Defines work flow state of an arc document
arcSupport	Assistance required
arcTransitions	State transitions used on an `arcState` def
arcType	Document type which determines workflow
arcTypeDefault	Make an arc type the default selection in the UI
arcUnassignable	Hides the user from `assignedTo` field on arc documents
arcWish	Wish list for future enhancement
arcWriteAccess	Defines write permissions for arc documents
arcbeamConn	Arcbeam connector
arcbeamConnRef	Used on a proxy point to reference its parent `arcbeamConn`
arcbeamCur	Used on a arcbeam proxy point to store the id of the entity in the remote system used to read and watch `curVal`
arcbeamHis	Used on a arcbeam proxy point object to store the id of the historized point in the remote system used to sync history data
arcbeamMinEventTime	Applied to `arcbeamConn` to tune how fast the server should send current value updates
arcbeamPoint	Point which synchronizes data via a arcbeam connector
arcbeamWrite	Used on a arcbeam proxy point to store the id of the entity in the remote system used to write `writeVal`
arcbeamWriteLevel	Number between 1 and 16 used with `arcbeamWrite` to determine which priority level of the remote system is written to
area	Area of a shape or floor space
assignedTo	Person who is currently responsible for the workflow task
association	Associations model ontological relationships between definitions
ates	Aquifer Thermal Energy Storage system
atesClosedLoop	The ATES uses closed piping to transport a water/glycol mixture through the ground
atesDesign	Design type of the ATES underground system
atesDoublet	The ATES has one or more pairs of a separate warm and cool well
atesDoubletPaired	The ATES is as a doublet, but with specific warm and cool wells linked together
atesMono	The ATES has only one physical well
atesUnidirectional	Similar to a doublet, but water always flows in the same direction from the extraction to the infiltration well
atmospheric	Related to the atmosphere of the earth
attachments	List of attachments as URIs in the virtual file tree
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)
bacnet	ASHRAE building automation and control protocol
bacnetAlarmPid	It specifies the connector will only handle alarms associated with that process identifier
bacnetConn	Marker tag for BACnet connection
bacnetConnRef	Used on a proxy object to reference its parent `bacnetConn`
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
bacnetCur	Used on a BACnet proxy point to subscribe for current value
bacnetDevice	Applied to a `record` to create a BACnet device object
bacnetDeviceName	Tag for current device name
bacnetDeviceRef	Applied to a `bacnetConn` or `ext` to reference 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
bacnetHis	Used on a BACnet proxy point to store BACnet trend log id
bacnetInitInterval	Applied to ConnTuning to tune the duration between driver re-initialization
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
bacnetRoute	bacnetRoute string tag if connecting through VPN and if network number is 0
bacnetScheduleRead	bacnetScheduleRead tag enables the reading of BACnet schedule properties, required for schedule read sync
bacnetScheduleReadFreq	This tag denotes the frequency duration at which schedule read sync will occur
bacnetScheduleWrite	bacnetScheduleWrite tag enables the writing of BACnet schedule properties
bacnetServerCovIncrement	Numeric tag that sets the delta threshold for when a COV notification should be send
bacnetServerDevice	Applied to a `record` to create a BACnet device object
bacnetServerDeviceRef	Applied to an `equip` to bind the equip to a `bacnetServerDevice`
bacnetServerDis	Apply the bacnetServerDis tag of String type to any point or equip to set custom description for the BACnet server
bacnetServerIgnore	Apply the bacnetServerIgnore marker tag to any point you do not want to process or expose via the BACnet server
bacnetServerInstance	Applied to a `bacnetDevice` to export it as an BACnet device
bacnetServerLocalAddress	Applied to a bacnetServer `ext` record configures the interface the server listens to request
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
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
bacnetServerRefreshInterval	Numeric tag that says how often the BACnet server will rescan equipments on the current project
bacnetUseConfirmedCov	Applied to ConnTuning to make the COV subscription mechanism to use confirmed COV messages
bacnetVersion	Tag for current connection protocol version
bacnetWrite	Reference for BACnet object id to be written
bacnetWriteLevel	Number between 1 and 17 used with bacnetWriteLevel to determine which priority level of the remote system is written to
barometric	Relating atmospheric pressure
baseChart	Basic charting functions
baseUri	Base URI for normalizing relative URIs
batchRecords	Indicates that the function will process multiple records
battery	Equipment used to store electric energy
beta	Indicates a beta quality definition
bindStatus	Current status of a component cell binding
biomass	Plant or animal material used as fuel to produce electricity or heat
biomassHeating	Heating by the combustion of biomass
blowdown	Removal from container or pipe
blowdownWaterRef	Blowdown water flows from the referent to this entity
bluetooth	Short range wireless communication protocol
boiler	Equipment to generate hot water or steam for heating
bool	Boolean value `true` or `false`
branchSelector	Branch selector used for heat recovery in a VRF system
builderSettings	Function returns settings for builder
by	Author of a document or part
bypass	Pipe used to bypass an equipment
cable	An assembly of one or more insulated conductors
calendar	Marker tag for a calendar entity
calendarGrid	Configures the items for a daily calendar
calendarRef	Used to chain a calendar to a schedule or another calendar
cav	Constant air volume terminal unit
centrifugal	Compression via a continuous flow of fluid through an impeller
certificatePem	PEM encoding of the User Certificate
ch2o	Formaldehyde (CH₂O)
ch4	Methane (CH₄)
chart	Functions related to charting
chartAreaMode	Enumeration for how to renders an area fill for a line plot series Note
chartGroup	Group name used to explicitly group series into one chart
chartHeight	Fixes the height of a chart plot
chartLegend	Provides option to control legend on charts
chartLegendNoSort	Disable sorting series by their display name in the legend
chartMax	Define explicit max value for series axis
chartMin	Define explicit min value for series axis
chartNoScroll	Disable scrollbars in viz charts
chartOn	Chart Record Selector Tag
chartOnDownload
chartTest
chartType	Enumerated chart type such as "line" or "bar"
childData
children	List of prototypes contained by this entity
childrenFlatten	List of aspects to flatten into children prototypes
chilled	Substance is cooled using cooling process
chilledBeam	Conditions a space using a heat exchanger integrated into the ceiling
chilledBeamZone	AHU supplies air to chilled beam terminal units
chilledWaterCooling	Cooling using transfer of heat to chilled water
chilledWaterRef	Chilled water flows from the referent to this entity
chiller	Equipment to remove heat from a liquid
chillerMechanism	Primary mechanism of chiller
choice	Choice specifies an exclusive marker selection
circ	Pipe used to circulate fluid through an equipment or system
circuit	Electrical circuit and its associated components such as breakers
clone	Marks a record as a clone
cloneFilter	Filter string for clone set data
cloneMod	Modified timestamp of the clone's progenitor
cloneProj	Project name for clone set data
cloneSet	Defines a clone set to subscribe to records in a remote project
cloneSetRef	Clone set which manages the clone
cloneSetStatus	Current status of a cloneSet
cloudage	Percentage of sky obscured by clouds
cmd	Point is a command, actuator, AO/BO
co	Carbon monoxide (CO)
co2	Carbon dioxide (CO₂)
co2e	Carbon dioxide equivalent
coal	Combustible sedimentary rock
coalHeating	Heating by the combustion of coal
coap	Constrained Application Protocol
coil	Heat exchanger used to heat or cool air
cold	Having low degree of heat
coldDeck	Duct carries air for cooling
color	Color encoded as `#RRGGBB`, `#RGB`, or a CSS color keyword
compressor	Device for mechanically increasing the pressure of a gas or refrigerant vapor by reducing its volume
computed	Computed point
computedFromReciprocal	Indicates a relationship that is computed from its reciprocal
computedModel	See Synthetics chapter
computer	General purpose computer
concentration	Abundance of substance in the total volume of a mixture
condensate	Liquid phase produced by the condensation of steam or other gas
condensateRef	Condensate flows from the referent to this entity
condenser	Device or related to process of condensation
condenserClosedLoop	Working fluid is kept separate from fluid used for heat transfer into the atmosphere
condenserCooling	Removal of heat through the process of water condensation
condenserLoop	Open or closed loop for condenser working fluid
condenserOpenLoop	Uses working fluid itself for evaporation into the atmosphere
condenserWaterRef	Condenser water flows from the referent to this entity
conditioning	Related to cleaning, heating, cooling, humidifying, dehumidifying, ventilating or circulating air.
conduit	Duct, pipe, or cable to convey a substance or phenomenon
confirm	Used on actions to prompt for confirmation
conn	Connector for communication to a remote system
connDebug	Connector debugging functions
connErr	Error message associated when `connStatus` indicates an error condition
connFeatures	Defines the features supported by a given connector
connLinger	Linger timeout used to keep a connector open
connOpenRetryFreq	Duration used for connector open retries
connPingFreq	Duration used to configure the auto-ping feature on a given connector
connPoint	Point associated with a connector for data synchronization with a remote system
connState	Current connection state of a connector as one of the predefined strings
connStatus	Current status of a connector as one of the predefined strings See Connectors
connTrees	Related to dbAddEdit
connTuning	Marker applied to a rec which defines a tuning configuration
connTuningRef	Reference to a tuning configuration defined by a `connTuning` rec
constantAirVolume	Delivers a constant volume of air flow
construct	Defines a constructor for the function
containedBy	The entity is logically contained by the referent
contains	Entities logically contained by this entity
contextSensitive	This is docs or video that are context Sensitive
controller	Microprocessor based device used in a control system
controls	Associated with the control system for an industrial process
cool	Associted with low temperature or cooling processes
cooling	Cooling mode or process
coolingCapacity	Measurement of a chiller ability to remove heat measured
coolingCoil	Coil used to cool air
coolingOnly	Equipment without heating
coolingProcess	Processed used to cool a substance
coolingTower	Equipment to transfer waste heat into the atmosphere
coord	Geographic coordinate in latitude/longitude in decimal degrees
crac	Computer Room Air Conditioner
created	The timestamp when entity was created
cur	Supports current value
curCalibration	Calibration value to apply to adjust the value read from the connector before updating curVal
curConvert	Conversion to apply when reading curVal from connector
curErr	Error description when `curStatus` indicates error condition
curRule	Marker tag for a cur rule type
curStatus	Status of point's current value reading
curTracksWrite	When configured `curVal` automatically tracks changes to `writeVal` and `curStatus` is set to "ok"
curVal	Current value of a point
currency	The currency unit related to the entity
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)
dali	Digital Addressable Lighting Interface protocol for lighting
damper	Damper equipment or control point
dataCenter	Space used to house computer and networking gear
date	ISO 8601 date as year, month, day
dateTime	ISO 8601 timestamp followed by timezone identifier
daytime	Time between sunrise and sunset
dbAddEdit	Marks a function that holds add/edit logic for DB Builder forms
dbToolCategory	Used to group forms together without affecting their folder path
dc	Relating to direct current (DC) electricity
deadband	The range in a process where no changes to output are made
def	Create a new definition bound to the given symbol
defName	Specifies definition symbol name to use
defUri	Host relative URI to redirect the user upon login
defVal	Default value
defView	The name of the view that should be the default for a user or project
defx	Extends the given definition with additional meta tags
deleteTop
delta	Differential of fluid between entering and leaving sensors
demand	Rate required for a process
depends	List of this library's dependencies
deprecated	Obsoleted
design	Data related to intended design and operating conditions
dessicantDehumidifier	Decreases humidity from air using a substance which absorbs moisture
device	Microprocessor based hardware device
deviceRef	Device which controls a monitors this entity
dewPoint	Dew point temperature at which water vapor will form dew
dict	Map of name/value tag pairs
diesel	Liquid fuel specifically designed for use in diesel engines
digTime	Related to digest time functions
directZone	AHU supplies air directly to the zone
direction	Compass direction measured in degrees
dis	Display name for an entity
disKey	Localized string key formatted as `pod::key`
disMacro	Display name using macro syntax
disableOverridableChecks	Disables function `overridable` checking
disabled	Indicates the entity is in a disabled state
discharge	Duct for air leaving an equipment
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
doas	Dedicated Outside Air System
doc	Documentation in simplified flavor of markdown
docAssociations	Generate a section in the docs for this association
docTaxonomy	Generate a taxonomy tree for this term in the documentationindex
dockerContainer	Docker container
dockerImage	Docker image
dockerState	Current status of a Docker container
dockerStatus	Additional human-readable status of the container
domestic	For human use
domesticWaterRef	Domestic water flows from the referent to this entity
dualDuct	Two ducts
duct	Conduit used to convey air for HVAC
ductArea	Config point on a `vav` for duct area measured in ft² or m²
ductConfig	Ductwork configuration
ductDeck	Cold, hot, or neutral deck
ductSection	Equipment section of ductwork
dueDate	Date expected for completion of the workflow task
dur	Total duration of the spark periods measured in hours
duration	Number with a unit of time
dxCooling	Cooling using direct expansion of a refrigerant vapor
dxHeating	Heating using direct expansion of a refrigerant vapor
ecobeeClientId	Your Ecobee API Key
ecobeeConn	Ecobee connector
ecobeeConnRef	Used on a proxy point to reference its parent `ecobeeConn`
ecobeeCur	Ecobee address to use to get the current value
ecobeeHis	Ecobee address to use to sync point history
ecobeePoint	Point which synchronizes data via an Ecobee connector
ecobeeRefreshToken	The refresh token you obtained for your API key
ecobeeWrite	Ecobee address to use to write a point value
economizer	Duct to access fresh outside air only for economizing, not ventilation
economizing	Energy reduction mode which augments heating/cooling with outside air
editSum
effective	Current control setpoint in effect taking into account other factors
efficiency	Efficiency point of a chiller measured in "COP" or "kW/ton"
elec	Associated with electricity or with electrical force, power, or energy
elecHeating	Heating by the conversion of electrical energy
elecLine	Single-phase line measurement of an electric quantity in a multi-phase AC electric power system
elecLineToLine	Single-phase electric quantity measured line-to-line in a multi-phase AC electric power system
elecLineToNeutral	Single-phase electric quantity measured line-to-neutral in a multi-phase AC electric power system
elecRef	Electricity flows from the referent to this entity
elevator	Enclosure used to move people between floors
email	An email address
emission	Amount of a substance discharged into the air
enable	Secondary on/off `point` of an `equip` especially used with a `vfd`
energy	Measure of ability to do work
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
energyStarConn	Energy Star connector to a portfolio manager account
energyStarConnRef	Used on a proxy object to reference its parent `energyStarConn`
energyStarCustomerIds	Comma separated list of customer account ids used for the connection
energyStarMeter	Tag applied to a `point` record which marks the point as mapped to a meter in Portfolio Manager
energyStarMeterType	String enum for EnergyStar meter type applied to `energyStarMeter` points
energyStarSite	Tag applied to a `site` record which marks a site as mapped into Portfolio Manager
entering	Pipe conveys fluid into an equipment
enthalpy	Total heat content of a system
entity	Top-level dicts with a unique identifier
enum	Defines an eumeration of string key names
enumExpr	Axon expression to dynamically compute an enum
enumMeta	Project singleton record with enumeration name/code definitions
enumx	Extened enum tag definitions
equip	Equipment asset
equipRef	Reference to equip which contains this entity
err	Indicates an error condition, `dis` should contain display message
errTrace	Exception stack trace
escalator	Moving staircase used to move people between floors
evaporator	Mechanism used to convert a refrigerant from its liquid to gaseous state
event	Event dict - see docs
evse	Electric Vehicle Supply Equipment
evseCableType	Physical type of `evse-cable`
evseSession	Describes an event during which an `evse-port` can deliver power to an EV
evseStatus	Status of one or more `evse-port` reported by an EVSE
example	Defines an example for the function
exclude	Marks a series are excluded from the chart
excludes
exhaust	Duct used to expel air back outside
expires	Expiration date
export	Supplied out of a system
expr	Axon expression string
ext	Extension library
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
fav	Favorite saved view link
fcu	Fan Coil Unit
feature	Feature namespace of definitions formatted as `feature:name`
feelsLike	Apparent temperature perceived when considering humidity, wind chill, and heat index
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
fileExt	Filename extension such as "csv"
filetype	File format type definition
filter	Related to an air or fluid filter
filterStr	Haystack filter string
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
finBoolStatsFreq	Tune how often the FinWatcher computes boolean `runStarts` and `runTime`
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
finDashboard	Feature namespace of definitions formatted as `feature:name`
finDocs	Tag that has a link to docs.finproducts.com
finDocsPath	This is the path where you find the docs in docs.finproducts.com
finDropOverride	Feature namespace of definitions formatted as `feature:name`
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
finInteraction	Map of name/value tag pairs
finKeyWords	A Comma Seperated string that we can add keywords too, so the user can search on this tag
finMailBody	Present if the email body is bigger than 1024 chars, it stores to body as Bin
finMailConn	Marker tag for finMail connection
finMailConnRef	Used on a proxy object to reference its parent `finMailConn`
finMailContent	The first 1024 characters of the email content (body)
finMailDEBUG	Marker tag to set the mail connection in debug mode
finMailFrom	Comma separated list of `From` addresses
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
finMailRec	Marker tag for an email message record
finMailReplyTo	Comma separated list of `Reply To` addresses
finMailSSL	Marker tag to set the connection to use SSL
finMailSentDate	The email `Sent date`
finMailSubject	The email `Subject`
finMailTo	Comma separated list of `To` addresses
finMailTotalMessages	Shows the number of email on the inbox folder
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
finPreviewImageRef	This is a ref to an image that will be previewed for what this is
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
finWatcherCallbackOn	Axon expression tag placed on a `finWatcherCallback` callback
finWatcherChanged	Marker tag for a changed record
finWatcherChangedRef	Reference to the record that is detected as changed
finWatcherChanges	A serialized Zinc grid that encodes which tags where added/changed/removed on a `finWatcherChangedRef` record
finWatcherFreq	Tune how often the FinWatcher looks for changes
finWatcherRemoved	Marker tag for a removed record
finpFile	The asset is a finp file, that can be downloaded and opened in FIN Builder
finpFileRef	This tag is a ref to the finp file
flags	Flags string
floor	Storey of a building
floorNum	Unitless integer indicating the floor's distance from ground level
floorRef	A legacy deprecated floor reference
flow	Measure of volumetric flow of fluid
flowInverter	System to change direction of substance flow
flue	Duct for exhausting combustion
fluid	Liquid or gas
flux	Measurement through a given surface
foldOn	Registers a function as folding a given value type
folderPath	Folder Path Tag
fontWeight	Font weight setting
foo	Useless
formOn	Form Record Selector Tag
format	Pattern used to format a value via `format()`
freezeStat	A boolean point of an ahu indicating a freezing condition
freq	Occurrences per unit time
fromState	State of the entity prior to alarm transition
ftp	File Transfer Protocol
fuelOil	Petroleum based oil burned for energy
fuelOilHeating	Heating by the combustion of fuel oil
fuelOilRef	Fuel oil flows from the referent to this entity
fumeHood	Ventilation equipment to limit exposure to hazardous fumes
func	Axon function
funcName	Name of function associated with route
gas	Substance with neither definite volume nor shape
gasoline	Petroleum derived liquid used as a fuel source
gasolineRef	Gasoline flows from the referent to this entity
geoAddr	Free form street address
geoCity	Geographic city or locality name
geoCoord	Geographic coordinate as `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
ghgConsumptionOn	An axon filter used by the Greenhouse Gas Emission Engine to identify the usage data to calculate emissions
ghgDirectSource	Direct emissions include
ghgEmissionSourceRef	Ref to the emission source where this emission factor will apply
ghgFactorGrid	Identifies emission factor values to calculate the emissions of the associated Greenhouse Gas
ghgFactorHis	Identifies point record with interval emission factor data that the Greenhouse Gas Emission Engine uses to calculate emissions
ghgFactorHisRef	References a ghgFactorHis point record 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
ghgHeatContentDis	Describes source of location specific heat content values
ghgHeatContentSyncId	Used internally for syncing location specific heat content values
ghgIndirectSource	Indirect emissions are from the generation of purchased electricity
ghgMobileCombustion	Identifies direct GHG emissions associated with fuel combustion in owned or operated mobile sources
ghgSource	Identifies an emission source
ghgSourceRef	Ref to the emission source used to calculate Greenhouse Gas Emissions
ghgSourceSyncId	Identifies the emission source used for automatically creating emission factors
ghgStationaryCombustion	Identifies direct GHG emissions from stationary (non-transport) combustion of fossil fuels at a facility (e.g., boilers, turbines, process heat)
ghgSyncId	Identifies the individual Greenhouse Gas Emission to sync
globalCont	Defines usage in Global Control
grid	Two dimension table of columns and rows
ground	Related to the surface of the earth
halign	Horizontal layout alignment
haystack	Haystack HTTP protocol for exchanging tagged data
haystackApi	Function which is a published Hasytack REST API op
haystackConn	Haystack connector to a Haystack REST API server
haystackConnRef	Used on a proxy point to reference its parent `haystackConn`
haystackCur	Used on a haystack proxy point to store the id of the entity in the remote system used to read and watch `curVal`
haystackHis	Used on a haystack proxy point object to store the id of the historized point in the remote system used to sync history data
haystackPoint	Point which synchronizes data via a Haystack connector
haystackPollFreq	Applied to `haystackConn` to tune the duration between watch polls
haystackWrite	Used on a haystack proxy point to store the id of the entity in the remote system used to write `writeVal`
haystackWriteLevel	Number between 1 and 16 used with `haystackWrite` to determine which priority level of the remote system is written to
header	Pipe used as central connection or manifold for other piping runs
heat	Associated with a heating process
heatExchanger	Equipment to transfer heat between two working fluids
heatPump	Equipment that employs a vapor compression cycle with a reversing valve to provide heating or cooling
heatRecovery	Transfer of heat from one substance to another to reduce energy consumption
heatWheel	Boolean point indicating command state of AHU's heat wheel
heating	Heating mode or process
heatingCoil	Coil used to heat air
heatingOnly	Equipment without cooling
heatingProcess	Processed used to heat a substance
help	End user documentation
helpDoc	Path to help documentation
hfc	Hydrofluorocarbons
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
hisAppendNA	Specifies the amount of time after a history point's `hisEnd` that the `hisRead()` function should append an `NA`
hisCollectCov	Enables COV history collection of the `curVal`
hisCollectCovRateLimit	Rate limits the frequency for `hisCollectCov`
hisCollectInterval	Enables interval history collection of the `curVal`
hisCollectNA	Historize the NA value whenever the `curVal` is null or `curStatus` is not equal to "ok"
hisCollectWriteFreq	This tag configures how long to buffer collected history items in memory before flushing them to the historian
hisConfig	This tag identifies a tag bundle as a history configuration
hisConvert	Conversion to apply when reading history data from connector
hisEnd	Timestamp of newest item in history
hisErr	Error description when `hisStatus` indicates error condition
hisFunc	Axon expression used to create a computed history
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
hisInterpolateMode	Explicitly configures the interpolation mode to use for this point
hisInterval	The interval at which sampled or consumption data is collected
hisMode	Indicates the way that history data is collected for a point
hisOnWrite	Axon expression to trap and map history data before writing to the historian database
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
hisRollupFunc	Function name to use for `hisRollupAuto()`
hisRollupInterval	Indicates the roll-up interval in his grid column meta-data
hisSize	Approximate number of timestamp/value pairs stored in history
hisSrc	Legacy 2.1 support for function picker in History App
hisStart	Timestamp of oldest item in history
hisStatus	Status of point's history collection or synchronization
hisTotalized	Indicates values which are a continuous stream of totalization
hisTotalizedRollover	Defines the rollover value for a totalized history - see totalized
hisTsPrecision	Controls the precision used to store timetamps in the historian
hot	Having high degree of heat
hotDeck	Duct carries air for heating
hotKey	One or more key combinations separated by a comma
hotWaterHeating	Heating using energy of hot water
hotWaterRef	Hot water flows from the referent to this entity
http	Hypertext Transfer Protocol which is foundation of the web
humidifier	Adding moisture to air
humidity	Percent relative humidity
hvac	Heating, ventilation, and air conditioning
hvacMode	Operational mode for HVAC equipment
hvacZonePoints	Entity with logical grouping of zone HVAC air points
ice	Water in its solid form
icon	Icon logical name - see Icons
id	Defines the unique identifier of an entity in system using a `ref` value type
illuminance	Luminous flux hitting the inside of the sphere at a specific point
imageSize	Image size in pixels
imap	Internet Message Access Protocol for retrieving email
imbalance	Lacking balance
import	Received into a system
indoorUnit	Operates inside the conditioned space
infiltration	Permeation of a substance into another substance
inlet	Duct with air entering an equipment
input	Entity inputs a substance which flows from another entity
inputs	The entity inputs a substance from the referent
int	Unitless integer number
intensity	Measure of an electromagnetic field
irradiance	Energy received at a surface by area
is	Defines one or more supertypes of a subtyping relationship
isolate	Isolate this node from making inbound requests
isolation	Actuator used to isolate an equipment from a pipe or ductwork system
job	Background job
jobExpr	Axon expression to execute for job
jobSchedule	Specifies when a job is scheduled using a string format
jobStatus	Current status of a job
kind	Kind name used to identity a value data type
knx	KNX protocol commonly used for lighting systems
knxAddr	The KNX Group Address used on a particular KnxConn
knxConn	Marker tag for the KNX connector record which stores the connectivity configuration used to access a KNX access point
knxConnRef	Assocation with `knxConn`
knxCur	Uri to use for current value subscriptions
knxDevice	Marker tag on records that represent a physical KNX device
knxIndividualAddr	The KNX individual address of a physical device record (e.g
knxProjFileRef	`A reference to the *knxproj file attached to a given KnxConn`
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
knxWatchdogFreq	KNX watchdog polling interval
knxWrite	Stores the Uri to be used when writing to the datapoint
kpi	Marker tag to indicate a KPI dict
kpiRule	Marker tag for a KPI rule type
laptop	Portable laptop computer
ldapUserProtoAttrVal	The value of this tag is used to help the LDAP mod determine which user prototypes an LDAP user maps to
leaving	Pipe conveys fluid out of an equipment
level	Range from 0% to 100%
lib	Library module of symbolic definitions
libStatus	Current status of an extension or sys module library
licStatus	License status
light	Electromagnetic radiation in the visible spectrum
lighting	Systems associated with illumination in the built environment
lightingZonePoints	Entity with logical grouping of lighting points
lineAvg	Line average of single-phase electrical quantity measurements in an AC electric power system
lineCurrent	Single-phase line current measured in an AC electric power system
lineEnergy	Single-phase energy measured line-to-line in an AC electric power system
linePf	Single-phase power factor measured line-to-line in an AC electric power system
linePower	Single-phase power measured line-to-line in an AC electric power system
lineVolt	Single-phase voltage measured line-to-line in an AC electric power system
linter	Fantom qname of `Linter` class
liquid	Substance with definite volume but takes the shape of its container
list	Ordered list of zero or more values
load	Chiller point to command or measure the chiller's load as a percentage from "0%" to "100%"
logLevel	Severity level
luminaire	Light fixture using electricity to provide illumination
luminance	Energy of light in a given direction
luminous	Relating to light as perceived by the eye
magnitude	Size or extent
makeup	Restore something missed or lost
makeupWaterRef	Makeup water flows from the referent to this entity
mandatory	Requires that the marker be applied to dicts which use the marker's subtypes
marker	Marker labels a dict with typing information
mau	Makeup Air Unit
max	Maximum
maxVal	Inclusive maximum for a numeric value
mech	Associated with a machine or its mechanical force, torque, power, or energy
message	Message describing the alarm or reason for the alarm
metadata	Information related to the alarm that will live with the lifecycle of the alarm
meter	Equipment to meter a substance or phenomenon
meterPoints	This point, configured on the uiMeta record, defines the meter points that will be available in the energy app
meterScope	Classifies a meter as a main site meter or submeter
metricUnits	Add this tag to the WeatherExt rec to force all units in forecast and history syncs to be in metric system (degrees C)
mime	Mime type formatted as type/subtype
min	Minimum
minVal	Inclusive minimum for a numeric value
mixed	Duct where fresh outside air and return air is mixed together
mixing	Three way valve which inputs two pipes and outputs a mixture between the two to a single output pipe
ml	Machine learning point
mlIdentificationPeriod	Training period description, known as the identification period or baseline, utilized during the model training process
mlInputVarRefs	List of independent variables, also known as model inputs or features, associated with a machine learning model
mlModel	See Synthetics chapter
mlModelMetrics	Goodness-of-fit metrics provided in the form of a simple dictionary
mlModelParameters	Result of model identification, which may appear as a list of model parameters for simpler models or as a reference to a stored model, in the form of a file uri
mlOutputVarRef	Dependent variable, also known as the model output or target, associated, with a machine learning model
mlVar	Machine learning variable representing both model inputs and outputs
mlVarFilter	Filter used for querying points by tags, providing more flexibility than mlVarPoint, although it is not mandatory
mlVarPoint	Reference to a point associated with a machine learning variable, known as a machine learning variable point
mlVarRef	Reference to a machine learning variable
mobile	Relating to mobile phones, hand-held computers, and similar technology
mod	Last modified time of record - see docSkySpark
modbus	Register based communication protocol used with industrial devices
modbusBlockGap	Applied to `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
modbusConn	Modbus connector
modbusConnRef	Used on a proxy point to reference its parent `modbusConn`
modbusCur	Modbus address to use for current value subscriptions
modbusPoint	Point which synchronizes data via a Haystack connector
modbusReadTimeout	How long to wait before timing out on a modbus read
modbusRegMapUri	Applied to `modbusConn` to define the register map CSV file
modbusSlave	Applied to `modbusConn` to identify the slave address on this modbus network
modbusWrite	Used on a modbus proxy point to store the id of the entity in the remote system used to write `writeVal`
modbusWriteTimeout	How long to wait before timing out on a modbus write
motor	Equipment that converts electrical energy into mechanical energy
movingWalkway	Conveyor to move people across a horizontal or inclined plane
mqtt	Message Queuing Telemetry Transport publish/subscribe protocol
mqttCertAlias	Used on an `mqttConn` to indicate which certificate and key pair to use for client authentication to the broker
mqttCleanSession	Whether to set the clean session flag on the connect request to the broker
mqttClientId	The client identifier to use when connecting to the broker
mqttConn	MQTT connector to an MQTT Broker
mqttConnRef	Used on a proxy point to reference its parent `mqttConn`
mqttMaxRetry	How many times to retry sending messages that require acknowlegment
mqttPoint	Point which synchronizes data via a MQTT connector
mqttQos	MQTT Quality of Service (QoS) - `0` - At most once (fire-and-forget) - `1` - At least once - `2` - Exactly once
mqttRetain	Set the retention flag on a published message
mqttRetryInterval	How long to wait between retries for messages that require acknowlegment
mqttVersion	MQTT protocol version
multi	Indicates multiple selection
multiLine	Indicates that a multi-line text input should be used
multiZone	AHU discharge air is split into a duct per zone
n2o	Nitrous oxide (N₂O)
na	Not available used to indicate invalid or missing data
name	Name key
naturalGas	Fossil fuel energy source consisting largely of methane and other hydrocarbons
naturalGasHeating	Heating by the combustion of natural gas
naturalGasRef	Natural gas flows from the referent to this entity
navAuxFilter	Apply extra filter string to a navigation tree
navCluster	Select from all the nodes in the cluster
navHidden	Hide an entity in the navigation selection pickers
navName	Navigation name commonly used with `disMacro` to create computed display strings
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
navTarget	Apply to a def to specify a default navigation target
navTree	Navigation tree name to use for ref tag
nestClientId	The OAuth client_id for your application
nestClientSecret	The OAuth client_secret for your application
nestConn	Google Nest connector
nestConnRef	Used on a proxy point to reference its parent `nestConn`
nestCur	Nest address to use to get the current value
nestPoint	Point which synchronizes data via a Nest connector
nestProjectId	The project identifier from your Google Device Access project
nestRefreshToken	The OAuth refresh_token for your application
nestWrite	Nest address to use to write a point value
net	Difference between import and export
network	Logical communications network between two or more devices
networkRef	Associates a device which communicates on specific a network
networking	Related to data communication networks
neutral	when applied to a point entity that has the `elec` and `current` tags, indicates electrical current being measured on an electrical neutral conductor
neutralDeck	Duct carries air which by-passes both heating and cooling coils
nextTime	Next time stamp when the schedule transition
nextVal	Next value the schedule will transition to
nf3	Nitrogen trifluoride (NF₃)
nh3	Ammonia (NH₃)
no2	Nitrogen dioxide (NO₂)
noData	Message string when no data available
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
node	Cluster node
nodeId	Node id as string without the `n:` prefix
nodeRef	Reference to a node in the cluster database
nodeStatus	Current status of a cluster node
nodeType	Is node haxall or skyspark
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
note	Note is a simple document without workflow
notifications	The set of notifications a user is subscribed to
notifyTopic	A topic that can be subscribed
notifyTopicProj	The value is a project name
number	Integer or floating point numbers annotated with an optional unit
o2	Oxygen (O₂) - the common dioxygen allotrope in the air
o3	Ozone (O₃)
obix	XML based Open Building Information eXchange protocol
obixConn	Connector to an oBIX HTTP server
obixConnRef	Used on a proxy point to reference its parent `obixConn`
obixCur	Used on a oBIX proxy point to store the URI of the entity in the remote system used to read and watch `curVal`
obixHis	URI of the `obix:History` to synchronized history data
obixLobby	The lobby URI is used to address an `obixConn` API endpoint
obixPoint	Point which synchronizes data via a oBIX connector
obixPollFreq	Duration between obixConn watch polls
obixWritable	Server export of a writable point as an `obix:Writable:Point`
obixWrite	URI of the `obix:WritablePoint` to write `writeVal`
obixWriteLevel	Number between 1 and 16 used with `obixWrite` to determine which priority level of the remote system is written to
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
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
obsEvents	Subscribe to event creation - see docs
obsFilter	Filter string to define the record data set observed
obsHisWrites	Subscribe to history data updates- see docs
obsMqtt	Subscribe to MQTT connector published messages
obsMqttConnRef	Subscribe to the topic on this MQTT connector
obsMqttTopic	Receive published messages that match this filter
obsPointWrites	Subscribe to writable point priority array updates - see docs
obsRecs	Base class for observables on database records
obsRemoves	Process when an existing data item is removed from the observed data set
obsRuleFilter	Filter string for rule records to observe
obsSchedule	Subscribe to scheduled timer event - see docs
obsScheduleDaysOfMonth	Schedule events for given days of the month
obsScheduleDaysOfWeek	Schedule events for given days of the week
obsScheduleFreq	Schedule events with given frequency
obsScheduleSpan	Schedule events only during the configured span of time
obsScheduleTimes	Schedule events for given times of the day
obsSparks	Subscribe to rule engine sparks - see docs
obsTargetFilter	Filter string for target records to observe
obsUpdates	Process when an existing data item is updated in the observed data set
obsWatches	Subscribe to watch and unwatch events - see docs
observable	Observable subscription - see docs
observes	Observable subscription - see docs
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
occurred	Date/Time that the alarm actually occurred
of	Expected value type of a collection, reference, or choice
op	Operation for HTTP API
opacity	Alpha transparency for colors as number between 0.0 (transparent) to 1.0 (completely opaque)
opcCertAlias	Used on an `opcConn` to indicate which certificate and key pair to use for asymmetric message security
opcConn	Marker tag for OPC connector record which stores the configuration for connectivity to an OPC UA endpoint
opcConnRef	Used on a proxy object to reference its parent `opcConn`
opcCur	OPC UA encoded address to use for current value subscriptions
opcHis	OPC UA encoded address to use for a historized proxy point
opcPoint	Point which synchronizes data via an OPC connector
opcSecurity	Defines a security policy and security mode pair to use for OPC UA messages
opcType	The NodeId of the point's OPC type
opcUserAuthMode	How the client should authenticate with the OPC-UA server
opcWrite	OPC UA encoded address to use for writing a point
openEnum	Apply to str enum tags where the enumeration range is open ended
optional	Not required
optsTemplate	TODO
order	Used to order definitions
outdoorUnit	operates outside the conditioned space
output	Entity outputs a substance with flows to other entities
outputs	The entity outputs a substance to the referent
outside	Duct to access fresh outside air for both ventilation and economizer
overridable	Applied to an ext function to enable override by project record functions
pageSize	Printed page size formatted as "width,height" with an explicit unit of "pt", "in", "mm", or "cm"
panel	Enclosure for electrical and control equipment
parallel	Circuit with multiple paths of flow
password	Manages password which is hashed/stored to the password store
percentage	A percentage specified as as `<percent> * 100`
perimeterHeat	Auxiliary heating points associated with a `vav`
periods	Timeline of on/off periods encoded as Base64 via `discretePeriods()`
pf	Electric power factor
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
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
pfScope	Power factor scope
pfStandard	Standard for interpreting power factor's positive or negative sign
pfTrue	True power factor, which includes effects of harmonic distortion
pfc	Perfluorocarbons
phase	Phase measurement in a three-phase electrical system
phaseAvg	Phase average of single-phase electrical quantity measurements in an AC electric power system
phaseCount	Number of phases for an AC electrical power system or connected equipment
phaseCurrent	Single-phase current measured line-to-line in an AC electric power system
phaseEnergy	Single-phase energy measured line-to-neutral in an AC electric power system
phasePf	Single-phase power factor measured line-to-neutral in an AC electric power system
phasePower	Single-phase power measured line-to-neutral in an AC electric power system
phaseVolt	Single-phase voltage measured line-to-neutral in an AC electric power system
phenomenon	Aspect of scientific interest with measurable quantities
phone	Telephone used for voice telecommunication
pipe	Conduit used to convey a fluid
pipeFluid	Type of fluid conveyed by piping
pipeSection	Equipment section of piping
placeholder	Hint displayed in a text field input
plant	Central plant used to generate a substance for a process
plantLoop	Plant piping loop
pm01	Particulate matter 0.1
pm10	Particulate matter 10
pm25	Particulate matter 2.5
podName	Fantom pod name
point	Data point such as a sensor or actuator
pointConvert	Point value conversion used to normalize data to/from a remote system
pointFunction	Classifies the point as a sensor, command, or setpoint
pointGroup	Grouping of children points used by spaces and equipment
pointOverrideAccess	Defines levels which may be overridden by the user for writable points
pointQuantity	Quantity the point senses or controls
pointRef	See Synthetics chapter
pointSubject	What the point senses or controls
pollTime	Frequency between polls of `curVal`
polyStats
poo	Useless
pop3	Post Office Protocol version 3 for retrieving email
port	A gateway or opening used to transfer a substance
power	Energy consumed per unit time
powerConverter	Converts one electrical waveform to another using power electronic circuitry
precipitation	Amount of atmospheric water vapor fallen including rain, sleet, snow, and hail
prefUnit	Defines a preferred unit to be used with a quantity
pressure	Measure of force applied
pressureDependent	VAV damper modulates to control space temp
pressureIndependent	VAV damper or a control valve that modulates to maintain desired flow setpoint
primaryFunction	Primary function of building as US Energy Star key
primaryLoop	Pipework which circulates closest to the energy source
private	Marks the function as private
process	Industrial or HVAC process
program	Identifies and defines a control program
programOn	String filter which defines the targets for a control `program`
programRef	Reference to associated `program` rec
programVars	Zinc encoded table of variable definitions
projAccessFilter	Applied to users to defines access to projects
projIncludeFilter	Selects other projects to include in UI navigation
projMeta	Singleton record for project meta data
propane	By-product of natural gas processing and petroleum refining (C₃H₈)
propaneHeating	Heating by the combustion of propane
protocol	Communication protocol used for devices on a network
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
provManifest	A provisioning manifest
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
pubKey	Public key as encoded string
pump	Pump equipment or control point
purge	Associated with a cleaning process to remove contaminants
quality	Quantity measured against standard metric
quantities	Quantities used to measure this phenomenon
quantity	Measurable property of a substance or phenomenon
quantityOf	Associates quantity as measurement of a phenomenon
queryString
rack	Enclosure or chassis used to mount computer and networking gear
radiantEquip	HVAC equipment that conditions a space without forced air
radiantFloor	Heats a space using pipes or cables embedded beneath floor
radiator	Heats a space using exposed pipes or coils
rated	Data specified by a manufacturer or rating organization
reactive	Relating to reactance
readRouteStatus	Project cluster route status for reads
reader	Fantom type qname for reader class
readonly	Indicates a value which may be read, but not written
reciprocal	Piston compressor driven by a crankshaft
reciprocalOf	Specifies the inverse of an association or relationships
ref	Reference to an entity
refresh	Indicates an operation which requires a page refresh
refrig	Fluid used in refrigeration and heat exchange
refrigRef	Refrigerant flows from the referent to this entity
reheat	Command point for reheating process
relationship	Ref tags used to model entity-to-entity relationships
relationshipFunc	Indentifies functions that hold pre-configured relationships
relationshipTree	Related to dbAddEdit
remove	Singleton for remove operation
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
return	Duct returning air back to equipment
roof	Envelope covering the top of a building
room	Enclosed room of a building
rotaryScrew	Rotary screw compression
routeOn	Filter that will select alarms to route
routeStatus	Project cluster route status
router	Device used to route data packets
rtu	Roof Top Unit
rule	Marker tag for a rule record
ruleCost	Specifies formula used to apply a cost tag to sparks
ruleFreq	Execution frequency of a curRule
ruleFunc	Specifies the function to run for a `rule`
ruleOn	Target filter for a rule or rule ready func
ruleRef	Reference to rule which contains this entity
ruleStatus	Current status of a rule
ruleTuning	Marker applied to a rec which defines a rule tuning configuration
ruleTuningTargetFilter	Filter string to match rule target records
ruleTuningTargetRef	Reference to a specific rule target or target parent
ruleType	Rule type choice
run	Primary on/off `point` of an `equip` especially used with a `vfd`
samlSsoUserProtoAttrVal	The value of this tag is used to help the SAML SSO auth mod determine which user prototypes a SAML SSO user matches
savedQueryFilterTree	Related to dbAddEdit
scalar	Scalar is an atomic value kind
schedulable	Binds a `schedule` to a writable point
schedule	Marker tag for a schedule entity
scheduleConfig	This tag identifies a tag bundle as a schedule configuration
scheduleGrid	Configures the items for a schedule
scheduleRef	Associates a `schedulable` with its schedule
scheduleVal	The string name/encoding of a schedule value
secondaryLoop	Pipework which circulates closest to the building or end use
sedonaConn	Sedona Sox connector to a remote device
sedonaConnRef	Used on a proxy point to reference its parent `sedonaConn`
sedonaCur	Sedona address to use for current value subscritions
sedonaPoint	Point which synchronizes data via a Sedona connector
sedonaWrite	Sedona address to use for writing
select	Used on an action to use current selection
sensor	Point is a sensor, input, AI/BI
series	Circuit with single path of flow
server	Hardware or software which provides services for other programs or devices
serviceFactor	Ratio of the maximum continuous output capacity at which a machine or system may operate without damage to the machine or system’s nominal output capacity
sf6	Sulphur hexafluoride (SF₆)
showDis	Show display names in UI instead of programmatic names
sim	Simulation point
simBaseline	See Synthetics chapter
simModel	See Synthetics chapter
simOperation	See Synthetics chapter
simOptimum	See Synthetics chapter
simScenario	See Synthetics chapter
singleDuct	One single duct
singlePhase	Single-phase AC electricity
site	Site is a geographic location of the built environment
siteAccessFilter	Restricts access to sites
siteMeter	Main meter for the associated site
sitePoint	Marker tag applied to a `point` to indicate the point is site-wide
siteRef	Reference to site which contains the entity
smtp	Simple Mail Transfer Protocol for sending email
snmp	Simple Network Management Protocol for managing IP devices
snmpAuthProtocol	If the `snmpSecurityLevel` indicates that authentication is required, then this is the digest algorithm to use
snmpCommunity	If the `snmpVersion` is `2c`, then this is the name of the SNMP community to use when messaging with the remote agent
snmpConn	SNMP connector
snmpConnRef	Used on a proxy object to reference its parent `snmpConn`
snmpCur	SNMP address to use for current-value subscription
snmpDesc	For learned points, this is the description of the point as found in its MIB `OBJECT-TYPE` definition
snmpMibType	For learned points, this is the human-readable qualified name (qname) of the point
snmpMibsUri	Applied to `snmpConn` to define the collection of MIB files to load
snmpPoint	Point which synchronizes data via an SNMP connector
snmpPrivProtocol	If the `snmpSecurityLevel` indicates that message privacy is required, then this is the encryption algorithm to use
snmpProtocol	Applied to `snmpConn` to indicate the network protocol to use for communicating with a remote agent
snmpSecurityLevel	If the `snmpVersion` is `3`, then this is the security level to use for messaging with the remote agent
snmpVersion	Applied to `snmpConn` to indicate the SNMP protocol version to use for messaging with the remote agent
snmpWrite	SNMP address to use for writing a point
solar	Relating to energy from the sun
solid	Substance with definite shape and volume
sourceRef	Reference to the source of the alarm
sox	Sedona Framework UDP based communication protocol
sp	Point is a setpoint, soft point, internal control variable, schedule
space	Space is a three-dimensional volume in the built environment
spaceRef	Reference to space which contains this entity
span	Time span as modeled encoded as XStr
spanModes	Restrict Span input modes
spark	Marker tag to indicate a spark dict
sparkRule	Marker tag for a spark rule type
speed	Distance per unit time
splitPhase	Split-phase AC electricity
sqlConn	SQL connector to a relational database using JDBC
sqlConnRef	Used on a proxy point to reference its parent `sqlConn`
sqlHis	Arbitrary key used by the SQL connector to synchronized history data
sqlPoint	Point which synchronizes data via a SQL connector
sqlSyncHisExpr	This is a tag which must be configured on each `sqlConn` record used by the `connSyncHis()` function
src	Source code
stage	Stage number of staged equipment operation such as coil or pump
staleTime	Time before a point's curStatus marked from "ok" to "stale" See Connector Tuning
standby	Readiness mode of a space
state	State of the alarm
stateOfCharge	State of charge (SoC) of an electric `battery`
statsResetTs	Set the start time used to calculate the statistics
steadyState	The delay before transitioning to the steady state
steam	Water in its gas form
steamHeating	Heating using energy of steam
steamRef	Steam flows from the referent to this entity
str	Unicode string of characters
strokeDasharray	Comma separated lengths of dashs and gaps for rendering lines such as "6,4"
strokeWidth	Stroke width for rendering lines
su	Requires superuser permission
submeter	Submeters measure usage of a sub-system or equipment within a site
submeterOf	Reference to parent meter which is immediately upstream of this meter
substance	Matter in one the three states solid, liquid, or gas
subterranean	Below the surface of the earth
subtitle	Defines subtitle string for visualizations
summs
switch	Device for toggling state or routing data
symbol	Symbol to a def
synthetic	Synthetic point with computed operational data
syntheticModel	See Synthetics chapter
syntheticModelRef	See Synthetics chapter
sysMod	System module library
system	Grouping of related equipment dedicated to a single application
systemRef	Reference to system
tablet	Mobile device with touch screen for user input
tag	Legacy backward compatible tag definitions
tagBundle	This tag identifies records as tag bundles
tagBundleFunc	Indentifies functions that hold pre-configured tag bundles
tagBundleTree	Related to dbAddEdit
tagOn	This tag is used on the given entity
tags	Tags used with this entity
tank	Tank used to store a substance for temporary holding
tankSubstance	Substance stored by a tank
targetFilter	Filter which matches points to be commanded by this route
targetRef	Reference to the target record of a rule result or associated record
tariff	A tariff rec
tariffAxonCharge	An Axon charge rec
tariffCharge	A tariff charge rec
tariffChargeFunc	The name of the function that tariff engine should call to compute the cost
tariffChargeRef	Reference to an entity
tariffChargeRefs	The charges that a percentage charge applies to
tariffConsumptionCharge	A consumption charge rec
tariffContractMin	The minimum contractual demand necessary for this charge to apply
tariffDemandCharge	A demand charge rec
tariffFee	A fixed numeric fee for the charge
tariffFeeFreq	The frequency that the charge applies per bill period
tariffFeeHisRef	The ref to the history point that contains the historical fee data
tariffFixedCharge	A fixed charge rec
tariffHis	Identifies the tariff history point for a meter
tariffHisRef	If multiple meters share the same tariff history, then you can use this tag to reference the "master" point containing the tariff history
tariffPercentageCharge	A percentage charge rec
tariffRangeStrategy	When a charge has multiple ranges this tag indicates to the tariff engine how to interpret and calculate costs based on those ranges
tariffRanges	The fee ranges for a usage-based charge
tariffRatchetPercentage	The peak demand identified during the ratchet period will be multiplied by this percentage to obtain the minimum peak demand
tariffRatchetPeriod	A value representing how far back to go when calculating the minimum peak demand for a billing period
tariffRef	The tariff a charge belongs to
tariffUsageOn	An axon filter used by the tariff engine to identify the charge's historical usage data
task	Dispatch task function
taskExpr	Task messaging handling Axon expression
taskStatus	Current status of a task
temp	Temperature - measure of hot and cold
templateName	Template by name - legacy support
templateTree	Related to dbAddEdit
tertiaryLoop	Pipework which circulates within the building
thd	Total harmonic distortion
thermal	Related to energy of heat
thermostat	Senses and controls temperature of space in HVAC system
threePhase	Three-phase AC electricity
ticket	Ticket tracks a software or help case
ticketState	Workflow state for a ticket
time	ISO 8601 time as hour, minute, seconds
timeout	Maximum elapsed time to allow an operation to continue
timez	Definition of a timezone function
title	Defines title string for visualizations
toState	State of the entity when going into alarm
topics
topicsEmailDigest	Classic legacy support
topicsEmailImmediate	Classic legacy support
total	Complete or absolute
tplTrendConn	TplTrend connector
tplTrendConnRef	Used on a proxy point to reference its parent `tplTrendConn`
tplTrendCur	TplTrend address to use for reading the current value
tplTrendHis	TplTrend address to use for reading historical data
tplTrendPoint	Point which synchronizes data via the TplTrend connector
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
tripleDuct	Three ducts
ts	Timestamp
tvoc	Total volatile organic compound (TVOC)
twoPhase	Two-phase AC electricity
typeName	Fantom type qname
tz	Timezone identifier from standard timezone database
uiFormOn	uiForm Record Selector Tag
uiInput	Fantom type qname for `Input` to use for a definition
uiMeta	Singleton used to configure project level user interface settings
unit	Unit identifier from standard unit database
unitVent	Unit Ventilator
unitless	Hide the unit picker for a number field
unocc	Unoccupied mode of a space
update
ups	Uninterruptible power supply
uri	Universal resource identifier
usedWith	Legacy tag definitions
user	User account
userAccessFilter	Restricts which users are visible
userAllow	List of function names to allow on this user
userAuth	Defines how a user authenticates
userCertificate	A user certificate
userFailedLogins	How many failed login attempts the user has made since last successful login
userLockOut	Indicates the user is locked out because of too many failed login attempts
userMfa	Indicates the user requires multifactor authentication and which multifactor authentication method is configured
userProto	A user prototype
userProtoName	User prototype name
userProtoRef	User prototype to apply to a user
userRef	Reference to user entity
userRole	Indicates what permissions and access rights the user has
username	Username for an authentication account
val	Data value type
validate	Axon expression to validate def
value	Value to write to the selected points
valve	Valve equipment or control point
variableAirVolume	Delivers a variable volume of air flow
vav	Variable air volume terminal unit
vavAirCircuit	How does the VAV pull in air
vavModulation	How does VAV modulate the temp based on duct pressure
vavZone	AHU supplies air to VAV terminal units
velocity	Speed in a given direction
ventilation	Duct to access fresh outside air only for ventilation, not economizing
version	Version string formatted as decimal integers separated by a dot
verticalTransport	Equipment to move humans and materials
vfd	Variable-frequency drive
view	Fresco UI view
viewLink	View name and state for linking to a saved view
viewerSettings	Function returns settings for viewer
visibility	Distance at which light can be clearly discerned
volt	Electrical potential difference or electromotive force
volume	Three dimensional space occupied by a substance
vrf	Variable refigerant flow
warm	Relatively warm in comparison to another substance, without being actively heated
water	Water in its liquid form
waterCooling	Cooling using transfer of heat to water which is not explicitly chilled
weather	Associated with atmospheric air or phenomenon
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
weatherCond	Enumeration of weather conditions
weatherStation	Logical weather station and its measurement points
weatherStationRef	Reference to weather station for to use this entity
weatherSyncIds	Applied to a `weatherStation` to indicate which weather points to sync for that station
well	A well is a source of groundwater and potentially thermal energy
wetBulb	Wet bulb air temperature
wikipedia	Hyperlink to the subject's page on Wikipedia
wind	Flow of air on surface of the Earth
wire	Cabling used to convey electricity or data
workorder	Workorder tracks maintenance case
workorderState	Workflow state for a workorder
writable	Supports writing data
writeConvert	Conversion to apply when writing writeVal to the connector
writeErr	Error description when `writeStatus` indicates error condition
writeLevel	Current priority level for `writeVal` as number between 1 and 17
writeMaxTime	Maximum time between writes used to send periodic writes
writeMinTime	Minimum time between writes used to throttle the speed of writes
writeOnOpen	Issue a write every time the connector transitions from open to closed
writeOnStart	Issue a write when the system first starts up
writeStatus	Current status of a writable point output
writeVal	Current desired value to write to output
writer	Fantom type qname for writer class
xstr	Extended string - type name and string value encoding
yearBuilt	Original year of construction as four digit year such as 1980
zigbee	Low power wireless communication protocol for home automation
zone	Related to spaces from a system perspective
zwave	Low power wireless communication protocol for home automation

FIN Framework

Axon Language

Other

Fantom Language

Haxall & SkySpark

Project Haystack

FIN Libraries

System Libraries

附录索引（appendix）（第 2 部分）

目录（导读）

API 正文（英文）

附录索引（appendix）（第 2 部分） ​

目录（导读） ​

API 正文（英文） ​

附录索引（appendix）（第 2 部分）

目录（导读）

API 正文（英文）