`lib-ph` 库参考（第 2 部分）

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

导读： 订阅实体数据。参见操作章节。

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

目录（导读）

概述（中译）

订阅实体数据。参见操作章节。

API 正文（英文）

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
op	Operation for HTTP API

op:watchUnsub

Unsubscribe to entity data. See Ops chapter.

meta


def	op:watchUnsub
is	op
lib	lib:ph

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
op	Operation for HTTP API

output

Entity outputs a substance with flows to other entities

meta


def	output
is	marker
lib	lib:ph

supertypes


marker	Marker labels a dict with typing information

subtypes


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

outputs

The entity outputs a substance to the referent. The value of this tag is what is supplied.

meta


def	outputs
is	relationship
lib	lib:ph
reciprocalOf	inputs
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

reciprocalOf

Specifies the inverse of an association or relationships. See Associations and Relationships chapter.

meta


def	reciprocalOf
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

ref

Reference to an entity. Ref values are ASCII strings limited to the following chars: a-z, A-Z, 0-9, underbar, colon, dash, dot, or tilde. See Kinds chapter.

meta


def	ref
is	scalar
lib	lib:ph

supertypes


val	Data value type
scalar	Scalar is an atomic value kind

subtypes


airRef	Air flows from the referent to this entity
arcOn	Subject of the document
arcbeamConnRef	Used on a proxy point to reference its parent `arcbeamConn`
assignedTo	Person who is currently responsible for the workflow task
bacnetConnRef	Used on a proxy object to reference its parent `bacnetConn`
bacnetDeviceRef	Applied to a `bacnetConn` or `ext` to reference a BACnet device object
bacnetServerDeviceRef	Applied to an `equip` to bind the equip to a `bacnetServerDevice`
blowdownWaterRef	Blowdown water flows from the referent to this entity
by	Author of a document or part
calendarRef	Used to chain a calendar to a schedule or another calendar
chilledWaterRef	Chilled water flows from the referent to this entity
cloneSetRef	Clone set which manages the clone
condensateRef	Condensate flows from the referent to this entity
condenserWaterRef	Condenser water flows from the referent to this entity
connTuningRef	Reference to a tuning configuration defined by a `connTuning` rec
deviceRef	Device which controls a monitors this entity
domesticWaterRef	Domestic water flows from the referent to this entity
ecobeeConnRef	Used on a proxy point to reference its parent `ecobeeConn`
elecRef	Electricity flows from the referent to this entity
energyStarConnRef	Used on a proxy object to reference its parent `energyStarConn`
equipRef	Reference to equip which contains this entity
finMailConnRef	Used on a proxy object to reference its parent `finMailConn`
finPreviewImageRef	This is a ref to an image that will be previewed for what this is
finWatcherChangedRef	Reference to the record that is detected as changed
finpFileRef	This tag is a ref to the finp file
floorRef	A legacy deprecated floor reference
fuelOilRef	Fuel oil flows from the referent to this entity
gasolineRef	Gasoline flows from the referent to this entity
ghgEmissionSourceRef	Ref to the emission source where this emission factor will apply
ghgFactorHisRef	References a ghgFactorHis point record that the Greenhouse Gas Emission Engine uses to calculate emissions
ghgSourceRef	Ref to the emission source used to calculate Greenhouse Gas Emissions
haystackConnRef	Used on a proxy point to reference its parent `haystackConn`
hotWaterRef	Hot water flows from the referent to this entity
id	Defines the unique identifier of an entity in system using a `ref` value type
knxConnRef	Assocation with `knxConn`
knxProjFileRef	`A reference to the *knxproj file attached to a given KnxConn`
makeupWaterRef	Makeup water flows from the referent to this entity
mlOutputVarRef	Dependent variable, also known as the model output or target, associated, with a machine learning model
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
modbusConnRef	Used on a proxy point to reference its parent `modbusConn`
mqttConnRef	Used on a proxy point to reference its parent `mqttConn`
naturalGasRef	Natural gas flows from the referent to this entity
nestConnRef	Used on a proxy point to reference its parent `nestConn`
networkRef	Associates a device which communicates on specific a network
nodeRef	Reference to a node in the cluster database
obixConnRef	Used on a proxy point to reference its parent `obixConn`
obsMqttConnRef	Subscribe to the topic on this MQTT connector
opcConnRef	Used on a proxy object to reference its parent `opcConn`
pointRef	See Synthetics chapter
programRef	Reference to associated `program` rec
refrigRef	Refrigerant flows from the referent to this entity
ruleRef	Reference to rule which contains this entity
ruleTuningTargetRef	Reference to a specific rule target or target parent
scheduleRef	Associates a `schedulable` with its schedule
sedonaConnRef	Used on a proxy point to reference its parent `sedonaConn`
siteRef	Reference to site which contains the entity
snmpConnRef	Used on a proxy object to reference its parent `snmpConn`
sourceRef	Reference to the source of the alarm
spaceRef	Reference to space which contains this entity
sqlConnRef	Used on a proxy point to reference its parent `sqlConn`
steamRef	Steam flows from the referent to this entity
submeterOf	Reference to parent meter which is immediately upstream of this meter
syntheticModelRef	See Synthetics chapter
systemRef	Reference to system
targetRef	Reference to the target record of a rule result or associated record
tariffChargeRef	Reference to an entity
tariffFeeHisRef	The ref to the history point that contains the historical fee data
tariffHisRef	If multiple meters share the same tariff history, then you can use this tag to reference the "master" point containing the tariff history
tariffRef	The tariff a charge belongs to
tplTrendConnRef	Used on a proxy point to reference its parent `tplTrendConn`
userProtoRef	User prototype to apply to a user
userRef	Reference to user entity
weatherStationRef	Reference to weather station for to use this entity

relationship

Ref tags used to model entity-to-entity relationships. See Relationships chapter.

meta


def	relationship
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

subtypes


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

remove

Singleton for remove operation. See Kinds chapter.

meta


def	remove
is	scalar
lib	lib:ph

supertypes


val	Data value type
scalar	Scalar is an atomic value kind

scalar

Scalar is an atomic value kind

meta


def	scalar
is	val
lib	lib:ph

supertypes


val	Data value type

subtypes


bool	Boolean value `true` or `false`
mqttCleanSession	Whether to set the clean session flag on the connect request to the broker
mqttRetain	Set the retention flag on a published message
coord	Geographic coordinate in latitude/longitude in decimal degrees
geoCoord	Geographic coordinate as `C(latitude,longitude)`
curVal	Current value of a point
date	ISO 8601 date as year, month, day
dueDate	Date expected for completion of the workflow task
expires	Expiration date
dateTime	ISO 8601 timestamp followed by timezone identifier
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
na	Not available used to indicate invalid or missing data
nextVal	Next value the schedule will transition to
number	Integer or floating point numbers annotated with an optional unit
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
ref	Reference to an entity
airRef	Air flows from the referent to this entity
arcOn	Subject of the document
arcbeamConnRef	Used on a proxy point to reference its parent `arcbeamConn`
assignedTo	Person who is currently responsible for the workflow task
bacnetConnRef	Used on a proxy object to reference its parent `bacnetConn`
bacnetDeviceRef	Applied to a `bacnetConn` or `ext` to reference a BACnet device object
bacnetServerDeviceRef	Applied to an `equip` to bind the equip to a `bacnetServerDevice`
blowdownWaterRef	Blowdown water flows from the referent to this entity
by	Author of a document or part
calendarRef	Used to chain a calendar to a schedule or another calendar
chilledWaterRef	Chilled water flows from the referent to this entity
cloneSetRef	Clone set which manages the clone
condensateRef	Condensate flows from the referent to this entity
condenserWaterRef	Condenser water flows from the referent to this entity
connTuningRef	Reference to a tuning configuration defined by a `connTuning` rec
deviceRef	Device which controls a monitors this entity
domesticWaterRef	Domestic water flows from the referent to this entity
ecobeeConnRef	Used on a proxy point to reference its parent `ecobeeConn`
elecRef	Electricity flows from the referent to this entity
energyStarConnRef	Used on a proxy object to reference its parent `energyStarConn`
equipRef	Reference to equip which contains this entity
finMailConnRef	Used on a proxy object to reference its parent `finMailConn`
finPreviewImageRef	This is a ref to an image that will be previewed for what this is
finWatcherChangedRef	Reference to the record that is detected as changed
finpFileRef	This tag is a ref to the finp file
floorRef	A legacy deprecated floor reference
fuelOilRef	Fuel oil flows from the referent to this entity
gasolineRef	Gasoline flows from the referent to this entity
ghgEmissionSourceRef	Ref to the emission source where this emission factor will apply
ghgFactorHisRef	References a ghgFactorHis point record that the Greenhouse Gas Emission Engine uses to calculate emissions
ghgSourceRef	Ref to the emission source used to calculate Greenhouse Gas Emissions
haystackConnRef	Used on a proxy point to reference its parent `haystackConn`
hotWaterRef	Hot water flows from the referent to this entity
id	Defines the unique identifier of an entity in system using a `ref` value type
knxConnRef	Assocation with `knxConn`
knxProjFileRef	`A reference to the *knxproj file attached to a given KnxConn`
makeupWaterRef	Makeup water flows from the referent to this entity
mlOutputVarRef	Dependent variable, also known as the model output or target, associated, with a machine learning model
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
modbusConnRef	Used on a proxy point to reference its parent `modbusConn`
mqttConnRef	Used on a proxy point to reference its parent `mqttConn`
naturalGasRef	Natural gas flows from the referent to this entity
nestConnRef	Used on a proxy point to reference its parent `nestConn`
networkRef	Associates a device which communicates on specific a network
nodeRef	Reference to a node in the cluster database
obixConnRef	Used on a proxy point to reference its parent `obixConn`
obsMqttConnRef	Subscribe to the topic on this MQTT connector
opcConnRef	Used on a proxy object to reference its parent `opcConn`
pointRef	See Synthetics chapter
programRef	Reference to associated `program` rec
refrigRef	Refrigerant flows from the referent to this entity
ruleRef	Reference to rule which contains this entity
ruleTuningTargetRef	Reference to a specific rule target or target parent
scheduleRef	Associates a `schedulable` with its schedule
sedonaConnRef	Used on a proxy point to reference its parent `sedonaConn`
siteRef	Reference to site which contains the entity
snmpConnRef	Used on a proxy object to reference its parent `snmpConn`
sourceRef	Reference to the source of the alarm
spaceRef	Reference to space which contains this entity
sqlConnRef	Used on a proxy point to reference its parent `sqlConn`
steamRef	Steam flows from the referent to this entity
submeterOf	Reference to parent meter which is immediately upstream of this meter
syntheticModelRef	See Synthetics chapter
systemRef	Reference to system
targetRef	Reference to the target record of a rule result or associated record
tariffChargeRef	Reference to an entity
tariffFeeHisRef	The ref to the history point that contains the historical fee data
tariffHisRef	If multiple meters share the same tariff history, then you can use this tag to reference the "master" point containing the tariff history
tariffRef	The tariff a charge belongs to
tplTrendConnRef	Used on a proxy point to reference its parent `tplTrendConn`
userProtoRef	User prototype to apply to a user
userRef	Reference to user entity
weatherStationRef	Reference to weather station for to use this entity
remove	Singleton for remove operation
str	Unicode string of characters
ackErr	This tag is set when there is an error acknowledging alarm and contains the reason for the error
ackMessage	Message or reason for acknowledgement
ackedBy	Who acknowledged the alarm
addTags	A comma separated list of tags and their values to apply to records
alarmAckAccessFilter	String filter applied to a user record which defines which alarms a user may acknowldege
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
appAccess	Restricts the set of accessible apps
appFormOn	Application Form Selector Tag
appName	View containing app name
arcPriority	Priority level of the document
arcState	Defines work flow state of an arc document
ticketState	Workflow state for a ticket
workorderState	Workflow state for a workorder
arcWriteAccess	Defines write permissions for arc documents
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
arcbeamWrite	Used on a arcbeam proxy point to store the id of the entity in the remote system used to write `writeVal`
bacnetCur	Used on a BACnet proxy point to subscribe for current value
bacnetDeviceName	Tag for current device name
bacnetHis	Used on a BACnet proxy point to store BACnet trend log id
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
bacnetScheduleWrite	bacnetScheduleWrite tag enables the writing of BACnet schedule properties
bacnetServerDis	Apply the bacnetServerDis tag of String type to any point or equip to set custom description for the BACnet server
bacnetServerLocalAddress	Applied to a bacnetServer `ext` record configures the interface the server listens to request
bacnetVersion	Tag for current connection protocol version
bacnetWrite	Reference for BACnet object id to be written
bindStatus	Current status of a component cell binding
builderSettings	Function returns settings for builder
certificatePem	PEM encoding of the User Certificate
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
chartLegend	Provides option to control legend on charts
chartOn	Chart Record Selector Tag
chartType	Enumerated chart type such as "line" or "bar"
cloneProj	Project name for clone set data
cloneSetStatus	Current status of a cloneSet
color	Color encoded as `#RRGGBB`, `#RGB`, or a CSS color keyword
connErr	Error message associated when `connStatus` indicates an error condition
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
construct	Defines a constructor for the function
curErr	Error description when `curStatus` indicates error condition
curStatus	Status of point's current value reading
dbToolCategory	Used to group forms together without affecting their folder path
defName	Specifies definition symbol name to use
defView	The name of the view that should be the default for a user or project
dis	Display name for an entity
disKey	Localized string key formatted as `pod::key`
disMacro	Display name using macro syntax
doc	Documentation in simplified flavor of markdown
dockerState	Current status of a Docker container
dockerStatus	Additional human-readable status of the container
ecobeeCur	Ecobee address to use to get the current value
ecobeeHis	Ecobee address to use to sync point history
ecobeeWrite	Ecobee address to use to write a point value
elecLine	Single-phase line measurement of an electric quantity in a multi-phase AC electric power system
lineCurrent	Single-phase line current measured 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
elecLineToLine	Single-phase electric quantity measured line-to-line in a multi-phase 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
phaseCurrent	Single-phase current measured line-to-line in an AC electric power system
elecLineToNeutral	Single-phase electric quantity measured line-to-neutral in a multi-phase AC electric power system
phaseVolt	Single-phase voltage measured line-to-neutral in an AC electric power system
email	An email address
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
enumExpr	Axon expression to dynamically compute an enum
errTrace	Exception stack trace
evseCableType	Physical type of `evse-cable`
evseStatus	Status of one or more `evse-port` reported by an EVSE
example	Defines an example for the function
excludes
expr	Axon expression string
taskExpr	Task messaging handling Axon expression
fileExt	Filename extension such as "csv"
filterStr	Haystack filter string
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
finMailContent	The first 1024 characters of the email content (body)
finMailFrom	Comma separated list of `From` addresses
finMailReplyTo	Comma separated list of `Reply To` addresses
finMailSubject	The email `Subject`
finMailTo	Comma separated list of `To` addresses
finWatcherCallbackOn	Axon expression tag placed on a `finWatcherCallback` callback
finWatcherChanges	A serialized Zinc grid that encodes which tags where added/changed/removed on a `finWatcherChangedRef` record
flags	Flags string
foldOn	Registers a function as folding a given value type
fontWeight	Font weight setting
formOn	Form Record Selector Tag
format	Pattern used to format a value via `format()`
fromState	State of the entity prior to alarm transition
funcName	Name of function associated with route
geoAddr	Free form street address
geoCity	Geographic city or locality name
geoCountry	Geographic country as ISO 3166-1 two letter code
geoCounty	Geographic subdivision of US state
geoPostalCode	Geographic postal code
geoState	State or province name
geoStreet	Geographic street address and name
ghgHeatContentDis	Describes source of location specific heat content values
ghgHeatContentSyncId	Used internally for syncing location specific heat content values
ghgSourceSyncId	Identifies the emission source used for automatically creating emission factors
ghgSyncId	Identifies the individual Greenhouse Gas Emission to sync
halign	Horizontal layout alignment
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
haystackWrite	Used on a haystack proxy point to store the id of the entity in the remote system used to write `writeVal`
help	End user documentation
helpDoc	Path to help documentation
hisErr	Error description when `hisStatus` indicates error condition
hisFunc	Axon expression used to create a computed history
hisInterpolateMode	Explicitly configures the interpolation mode to use for this point
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
hisRollupFunc	Function name to use for `hisRollupAuto()`
hisStatus	Status of point's history collection or synchronization
hotKey	One or more key combinations separated by a comma
icon	Icon logical name - see Icons
imageSize	Image size in pixels
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
knxAddr	The KNX Group Address used on a particular KnxConn
knxIndividualAddr	The KNX individual address of a physical device record (e.g
ldapUserProtoAttrVal	The value of this tag is used to help the LDAP mod determine which user prototypes an LDAP user maps to
libStatus	Current status of an extension or sys module library
licStatus	License status
logLevel	Severity level
message	Message describing the alarm or reason for the alarm
mime	Mime type formatted as type/subtype
modbusCur	Modbus address to use for current value subscriptions
modbusWrite	Used on a modbus proxy point to store the id of the entity in the remote system used to write `writeVal`
mqttCertAlias	Used on an `mqttConn` to indicate which certificate and key pair to use for client authentication to the broker
mqttClientId	The client identifier to use when connecting to the broker
mqttVersion	MQTT protocol version
name	Name key
navName	Navigation name commonly used with `disMacro` to create computed display strings
navTarget	Apply to a def to specify a default navigation target
navTree	Navigation tree name to use for ref tag
nestCur	Nest address to use to get the current value
nestProjectId	The project identifier from your Google Device Access project
nestWrite	Nest address to use to write a point value
noData	Message string when no data available
nodeId	Node id as string without the `n:` prefix
nodeStatus	Current status of a cluster node
nodeType	Is node haxall or skyspark
notifyTopicProj	The value is a project name
obsMqttTopic	Receive published messages that match this filter
obsScheduleDaysOfMonth	Schedule events for given days of the month
obsScheduleDaysOfWeek	Schedule events for given days of the week
opcCertAlias	Used on an `opcConn` to indicate which certificate and key pair to use for asymmetric message security
opcCur	OPC UA encoded address to use for current value subscriptions
opcHis	OPC UA encoded address to use for a historized proxy point
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
optsTemplate	TODO
pageSize	Printed page size formatted as "width,height" with an explicit unit of "pt", "in", "mm", or "cm"
password	Manages password which is hashed/stored to the password store
ecobeeClientId	Your Ecobee API Key
ecobeeRefreshToken	The refresh token you obtained for your API key
nestClientId	The OAuth client_id for your application
nestClientSecret	The OAuth client_secret for your application
nestRefreshToken	The OAuth refresh_token for your application
periods	Timeline of on/off periods encoded as Base64 via `discretePeriods()`
phase	Phase measurement in a three-phase electrical system
placeholder	Hint displayed in a text field input
podName	Fantom pod name
pointConvert	Point value conversion used to normalize data to/from a remote system
curConvert	Conversion to apply when reading curVal from connector
hisConvert	Conversion to apply when reading history data from connector
writeConvert	Conversion to apply when writing writeVal to the connector
pointOverrideAccess	Defines levels which may be overridden by the user for writable points
primaryFunction	Primary function of building as US Energy Star key
program	Identifies and defines a control program
programOn	String filter which defines the targets for a control `program`
programVars	Zinc encoded table of variable definitions
pubKey	Public key as encoded string
queryString
reader	Fantom type qname for reader class
routeOn	Filter that will select alarms to route
routeStatus	Project cluster route status
readRouteStatus	Project cluster route status for reads
ruleCost	Specifies formula used to apply a cost tag to sparks
ruleFunc	Specifies the function to run for a `rule`
ruleStatus	Current status of a rule
samlSsoUserProtoAttrVal	The value of this tag is used to help the SAML SSO auth mod determine which user prototypes a SAML SSO user matches
scheduleVal	The string name/encoding of a schedule value
sedonaCur	Sedona address to use for current value subscritions
sedonaWrite	Sedona address to use for writing
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
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
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
sqlHis	Arbitrary key used by the SQL connector to synchronized history data
sqlSyncHisExpr	This is a tag which must be configured on each `sqlConn` record used by the `connSyncHis()` function
src	Source code
state	State of the alarm
strokeDasharray	Comma separated lengths of dashs and gaps for rendering lines such as "6,4"
subtitle	Defines subtitle string for visualizations
targetFilter	Filter which matches points to be commanded by this route
tariffChargeFunc	The name of the function that tariff engine should call to compute the cost
tariffFeeFreq	The frequency that the charge applies per bill period
tariffRangeStrategy	When a charge has multiple ranges this tag indicates to the tariff engine how to interpret and calculate costs based on those ranges
tariffRatchetPeriod	A value representing how far back to go when calculating the minimum peak demand for a billing period
taskStatus	Current status of a task
templateName	Template by name - legacy support
title	Defines title string for visualizations
toState	State of the entity when going into alarm
topicsEmailDigest	Classic legacy support
topicsEmailImmediate	Classic legacy support
tplTrendCur	TplTrend address to use for reading the current value
tplTrendHis	TplTrend address to use for reading historical data
typeName	Fantom type qname
uiInput	Fantom type qname for `Input` to use for a definition
tz	Timezone identifier from standard timezone database
uiFormOn	uiForm Record Selector Tag
unit	Unit identifier from standard unit database
currency	The currency unit related to the entity
usedWith	Legacy tag definitions
userProtoName	User prototype name
userRole	Indicates what permissions and access rights the user has
username	Username for an authentication account
validate	Axon expression to validate def
version	Version string formatted as decimal integers separated by a dot
viewerSettings	Function returns settings for viewer
writeErr	Error description when `writeStatus` indicates error condition
writeStatus	Current status of a writable point output
writer	Fantom type qname for writer class
symbol	Symbol to a def
def	Create a new definition bound to the given symbol
defx	Extends the given definition with additional meta tags
of	Expected value type of a collection, reference, or choice
reciprocalOf	Specifies the inverse of an association or relationships
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
time	ISO 8601 time as hour, minute, seconds
uri	Universal resource identifier
baseUri	Base URI for normalizing relative URIs
defUri	Host relative URI to redirect the user upon login
knxCur	Uri to use for current value subscriptions
knxWrite	Stores the Uri to be used when writing to the datapoint
modbusRegMapUri	Applied to `modbusConn` to define the register map CSV file
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
obixWrite	URI of the `obix:WritablePoint` to write `writeVal`
snmpMibsUri	Applied to `snmpConn` to define the collection of MIB files to load
wikipedia	Hyperlink to the subject's page on Wikipedia
value	Value to write to the selected points
writeVal	Current desired value to write to output
xstr	Extended string - type name and string value encoding
finMailBody	Present if the email body is bigger than 1024 chars, it stores to body as Bin
span	Time span as modeled encoded as XStr
mlIdentificationPeriod	Training period description, known as the identification period or baseline, utilized during the model training process
obsScheduleSpan	Schedule events only during the configured span of time

span

Time span as modeled encoded as XStr. This is a placeholder to eventually formalize the time range used by hisRead op.

meta


def	span
is	xstr
lib	lib:ph

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
xstr	Extended string - type name and string value encoding

subtypes


mlIdentificationPeriod	Training period description, known as the identification period or baseline, utilized during the model training process
obsScheduleSpan	Schedule events only during the configured span of time

str

Unicode string of characters. See Kinds chapter.

meta


def	str
is	scalar
lib	lib:ph

supertypes


val	Data value type
scalar	Scalar is an atomic value kind

subtypes


ackErr	This tag is set when there is an error acknowledging alarm and contains the reason for the error
ackMessage	Message or reason for acknowledgement
ackedBy	Who acknowledged the alarm
addTags	A comma separated list of tags and their values to apply to records
alarmAckAccessFilter	String filter applied to a user record which defines which alarms a user may acknowldege
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
appAccess	Restricts the set of accessible apps
appFormOn	Application Form Selector Tag
appName	View containing app name
arcPriority	Priority level of the document
arcState	Defines work flow state of an arc document
ticketState	Workflow state for a ticket
workorderState	Workflow state for a workorder
arcWriteAccess	Defines write permissions for arc documents
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
arcbeamWrite	Used on a arcbeam proxy point to store the id of the entity in the remote system used to write `writeVal`
bacnetCur	Used on a BACnet proxy point to subscribe for current value
bacnetDeviceName	Tag for current device name
bacnetHis	Used on a BACnet proxy point to store BACnet trend log id
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
bacnetScheduleWrite	bacnetScheduleWrite tag enables the writing of BACnet schedule properties
bacnetServerDis	Apply the bacnetServerDis tag of String type to any point or equip to set custom description for the BACnet server
bacnetServerLocalAddress	Applied to a bacnetServer `ext` record configures the interface the server listens to request
bacnetVersion	Tag for current connection protocol version
bacnetWrite	Reference for BACnet object id to be written
bindStatus	Current status of a component cell binding
builderSettings	Function returns settings for builder
certificatePem	PEM encoding of the User Certificate
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
chartLegend	Provides option to control legend on charts
chartOn	Chart Record Selector Tag
chartType	Enumerated chart type such as "line" or "bar"
cloneProj	Project name for clone set data
cloneSetStatus	Current status of a cloneSet
color	Color encoded as `#RRGGBB`, `#RGB`, or a CSS color keyword
connErr	Error message associated when `connStatus` indicates an error condition
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
construct	Defines a constructor for the function
curErr	Error description when `curStatus` indicates error condition
curStatus	Status of point's current value reading
dbToolCategory	Used to group forms together without affecting their folder path
defName	Specifies definition symbol name to use
defView	The name of the view that should be the default for a user or project
dis	Display name for an entity
disKey	Localized string key formatted as `pod::key`
disMacro	Display name using macro syntax
doc	Documentation in simplified flavor of markdown
dockerState	Current status of a Docker container
dockerStatus	Additional human-readable status of the container
ecobeeCur	Ecobee address to use to get the current value
ecobeeHis	Ecobee address to use to sync point history
ecobeeWrite	Ecobee address to use to write a point value
elecLine	Single-phase line measurement of an electric quantity in a multi-phase AC electric power system
lineCurrent	Single-phase line current measured 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
elecLineToLine	Single-phase electric quantity measured line-to-line in a multi-phase 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
phaseCurrent	Single-phase current measured line-to-line in an AC electric power system
elecLineToNeutral	Single-phase electric quantity measured line-to-neutral in a multi-phase AC electric power system
phaseVolt	Single-phase voltage measured line-to-neutral in an AC electric power system
email	An email address
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
enumExpr	Axon expression to dynamically compute an enum
errTrace	Exception stack trace
evseCableType	Physical type of `evse-cable`
evseStatus	Status of one or more `evse-port` reported by an EVSE
example	Defines an example for the function
excludes
expr	Axon expression string
taskExpr	Task messaging handling Axon expression
fileExt	Filename extension such as "csv"
filterStr	Haystack filter string
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
finMailContent	The first 1024 characters of the email content (body)
finMailFrom	Comma separated list of `From` addresses
finMailReplyTo	Comma separated list of `Reply To` addresses
finMailSubject	The email `Subject`
finMailTo	Comma separated list of `To` addresses
finWatcherCallbackOn	Axon expression tag placed on a `finWatcherCallback` callback
finWatcherChanges	A serialized Zinc grid that encodes which tags where added/changed/removed on a `finWatcherChangedRef` record
flags	Flags string
foldOn	Registers a function as folding a given value type
fontWeight	Font weight setting
formOn	Form Record Selector Tag
format	Pattern used to format a value via `format()`
fromState	State of the entity prior to alarm transition
funcName	Name of function associated with route
geoAddr	Free form street address
geoCity	Geographic city or locality name
geoCountry	Geographic country as ISO 3166-1 two letter code
geoCounty	Geographic subdivision of US state
geoPostalCode	Geographic postal code
geoState	State or province name
geoStreet	Geographic street address and name
ghgHeatContentDis	Describes source of location specific heat content values
ghgHeatContentSyncId	Used internally for syncing location specific heat content values
ghgSourceSyncId	Identifies the emission source used for automatically creating emission factors
ghgSyncId	Identifies the individual Greenhouse Gas Emission to sync
halign	Horizontal layout alignment
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
haystackWrite	Used on a haystack proxy point to store the id of the entity in the remote system used to write `writeVal`
help	End user documentation
helpDoc	Path to help documentation
hisErr	Error description when `hisStatus` indicates error condition
hisFunc	Axon expression used to create a computed history
hisInterpolateMode	Explicitly configures the interpolation mode to use for this point
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
hisRollupFunc	Function name to use for `hisRollupAuto()`
hisStatus	Status of point's history collection or synchronization
hotKey	One or more key combinations separated by a comma
icon	Icon logical name - see Icons
imageSize	Image size in pixels
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
knxAddr	The KNX Group Address used on a particular KnxConn
knxIndividualAddr	The KNX individual address of a physical device record (e.g
ldapUserProtoAttrVal	The value of this tag is used to help the LDAP mod determine which user prototypes an LDAP user maps to
libStatus	Current status of an extension or sys module library
licStatus	License status
logLevel	Severity level
message	Message describing the alarm or reason for the alarm
mime	Mime type formatted as type/subtype
modbusCur	Modbus address to use for current value subscriptions
modbusWrite	Used on a modbus proxy point to store the id of the entity in the remote system used to write `writeVal`
mqttCertAlias	Used on an `mqttConn` to indicate which certificate and key pair to use for client authentication to the broker
mqttClientId	The client identifier to use when connecting to the broker
mqttVersion	MQTT protocol version
name	Name key
navName	Navigation name commonly used with `disMacro` to create computed display strings
navTarget	Apply to a def to specify a default navigation target
navTree	Navigation tree name to use for ref tag
nestCur	Nest address to use to get the current value
nestProjectId	The project identifier from your Google Device Access project
nestWrite	Nest address to use to write a point value
noData	Message string when no data available
nodeId	Node id as string without the `n:` prefix
nodeStatus	Current status of a cluster node
nodeType	Is node haxall or skyspark
notifyTopicProj	The value is a project name
obsMqttTopic	Receive published messages that match this filter
obsScheduleDaysOfMonth	Schedule events for given days of the month
obsScheduleDaysOfWeek	Schedule events for given days of the week
opcCertAlias	Used on an `opcConn` to indicate which certificate and key pair to use for asymmetric message security
opcCur	OPC UA encoded address to use for current value subscriptions
opcHis	OPC UA encoded address to use for a historized proxy point
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
optsTemplate	TODO
pageSize	Printed page size formatted as "width,height" with an explicit unit of "pt", "in", "mm", or "cm"
password	Manages password which is hashed/stored to the password store
ecobeeClientId	Your Ecobee API Key
ecobeeRefreshToken	The refresh token you obtained for your API key
nestClientId	The OAuth client_id for your application
nestClientSecret	The OAuth client_secret for your application
nestRefreshToken	The OAuth refresh_token for your application
periods	Timeline of on/off periods encoded as Base64 via `discretePeriods()`
phase	Phase measurement in a three-phase electrical system
placeholder	Hint displayed in a text field input
podName	Fantom pod name
pointConvert	Point value conversion used to normalize data to/from a remote system
curConvert	Conversion to apply when reading curVal from connector
hisConvert	Conversion to apply when reading history data from connector
writeConvert	Conversion to apply when writing writeVal to the connector
pointOverrideAccess	Defines levels which may be overridden by the user for writable points
primaryFunction	Primary function of building as US Energy Star key
program	Identifies and defines a control program
programOn	String filter which defines the targets for a control `program`
programVars	Zinc encoded table of variable definitions
pubKey	Public key as encoded string
queryString
reader	Fantom type qname for reader class
routeOn	Filter that will select alarms to route
routeStatus	Project cluster route status
readRouteStatus	Project cluster route status for reads
ruleCost	Specifies formula used to apply a cost tag to sparks
ruleFunc	Specifies the function to run for a `rule`
ruleStatus	Current status of a rule
samlSsoUserProtoAttrVal	The value of this tag is used to help the SAML SSO auth mod determine which user prototypes a SAML SSO user matches
scheduleVal	The string name/encoding of a schedule value
sedonaCur	Sedona address to use for current value subscritions
sedonaWrite	Sedona address to use for writing
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
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
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
sqlHis	Arbitrary key used by the SQL connector to synchronized history data
sqlSyncHisExpr	This is a tag which must be configured on each `sqlConn` record used by the `connSyncHis()` function
src	Source code
state	State of the alarm
strokeDasharray	Comma separated lengths of dashs and gaps for rendering lines such as "6,4"
subtitle	Defines subtitle string for visualizations
targetFilter	Filter which matches points to be commanded by this route
tariffChargeFunc	The name of the function that tariff engine should call to compute the cost
tariffFeeFreq	The frequency that the charge applies per bill period
tariffRangeStrategy	When a charge has multiple ranges this tag indicates to the tariff engine how to interpret and calculate costs based on those ranges
tariffRatchetPeriod	A value representing how far back to go when calculating the minimum peak demand for a billing period
taskStatus	Current status of a task
templateName	Template by name - legacy support
title	Defines title string for visualizations
toState	State of the entity when going into alarm
topicsEmailDigest	Classic legacy support
topicsEmailImmediate	Classic legacy support
tplTrendCur	TplTrend address to use for reading the current value
tplTrendHis	TplTrend address to use for reading historical data
typeName	Fantom type qname
uiInput	Fantom type qname for `Input` to use for a definition
tz	Timezone identifier from standard timezone database
uiFormOn	uiForm Record Selector Tag
unit	Unit identifier from standard unit database
currency	The currency unit related to the entity
usedWith	Legacy tag definitions
userProtoName	User prototype name
userRole	Indicates what permissions and access rights the user has
username	Username for an authentication account
validate	Axon expression to validate def
version	Version string formatted as decimal integers separated by a dot
viewerSettings	Function returns settings for viewer
writeErr	Error description when `writeStatus` indicates error condition
writeStatus	Current status of a writable point output
writer	Fantom type qname for writer class

symbol

Symbol to a def. Symbol values are ASCII strings limited to the following chars: a-z, A-Z, 0-9, underbar, colon, dash, dot. See Kinds chapter.

meta


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

supertypes


val	Data value type
scalar	Scalar is an atomic value kind

subtypes


def	Create a new definition bound to the given symbol
defx	Extends the given definition with additional meta tags
of	Expected value type of a collection, reference, or choice
reciprocalOf	Specifies the inverse of an association or relationships
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

tagOn

This tag is used on the given entity

meta


accumulate	✓
def	tagOn
is	association
lib	lib:ph
notInherited	✓
of	symbol
reciprocalOf	tags
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


computedFromReciprocal	✓
def	tags
docAssociations	✓
is	association
lib	lib:ph
of	symbol
reciprocalOf	tagOn
uiInput	ui::MultiStrInput

time

ISO 8601 time as hour, minute, seconds: 09:51:27.354. See Kinds chapter.

meta


def	time
is	scalar
lib	lib:ph

supertypes


val	Data value type
scalar	Scalar is an atomic value kind

transient

Indicates a value tag which should not be persisted. Transient values often change frequently and do not provide long term informational value. Typyically they are stored only in RAM and should not be stored to durable storage.

meta


def	transient
is	marker
lib	lib:ph
tagOn	def

supertypes


marker	Marker labels a dict with typing information

def

transitive

This marker is applied to a relationship to indicate it is transitive. Transitivity requires that if the relationship applies to A,B and B,C then it also applies to A,C.

meta


def	transitive
is	marker
lib	lib:ph

supertypes


marker	Marker labels a dict with typing information

def

tz

Timezone identifier from standard timezone database

meta


def	tz
enum	See below
is	str
lib	lib:ph
tagOn	haystackConn, point, site, user, userProto, weatherStation
uiInput	ui::TzInput

enum


Abidjan
Accra
Adak
Adelaide
Algiers
Almaty
Amman
Amsterdam
Anadyr
Anchorage
Andorra
Apia
Aqtau
Aqtobe
Araguaina
Ashgabat
Astrakhan
Asuncion
Athens
Atikokan
Atyrau
Auckland
Azores
Baghdad
Bahia
Bahia_Banderas
Baku
Bangkok
Barbados
Barnaul
Beirut
Belem
Belgrade
Belize
Berlin
Bermuda
Beulah
Bishkek
Bissau
Blanc-Sablon
Boa_Vista
Bogota
Boise
Bougainville
Brisbane
Broken_Hill
Brunei
Brussels
Bucharest
Budapest
Buenos_Aires
CET
CST6CDT
Cairo
Cambridge_Bay
Campo_Grande
Canary
Cancun
Cape_Verde
Caracas
Casablanca
Casey
Catamarca
Cayenne
Center
Ceuta
Chagos
Chatham
Chicago
Chihuahua
Chisinau
Chita
Choibalsan
Christmas
Chuuk
Cocos
Colombo
Copenhagen
Cordoba
Costa_Rica
Creston
Cuiaba
Curacao
Currie
Damascus
Danmarkshavn
Darwin
Davis
Dawson
Dawson_Creek
Denver
Detroit
Dhaka
Dili
Dubai
Dublin
DumontDUrville
Dushanbe
EET
EST
EST5EDT
Easter
Edmonton
Efate
Eirunepe
El_Aaiun
El_Salvador
Enderbury
Eucla
Fakaofo
Famagusta
Faroe
Fiji
Fort_Nelson
Fortaleza
Funafuti
GMT
GMT+1
GMT+10
GMT+11
GMT+12
GMT+2
GMT+3
GMT+4
GMT+5
GMT+6
GMT+7
GMT+8
GMT+9
GMT-1
GMT-10
GMT-11
GMT-12
GMT-13
GMT-14
GMT-2
GMT-3
GMT-4
GMT-5
GMT-6
GMT-7
GMT-8
GMT-9
Galapagos
Gambier
Gaza
Gibraltar
Glace_Bay
Godthab
Goose_Bay
Grand_Turk
Guadalcanal
Guam
Guatemala
Guayaquil
Guyana
HST
Halifax
Havana
Hebron
Helsinki
Hermosillo
Ho_Chi_Minh
Hobart
Hong_Kong
Honolulu
Hovd
Indianapolis
Inuvik
Iqaluit
Irkutsk
Istanbul
Jakarta
Jamaica
Jayapura
Jerusalem
Johannesburg
Juba
Jujuy
Juneau
Kabul
Kaliningrad
Kamchatka
Karachi
Kathmandu
Kerguelen
Khandyga
Khartoum
Kiev
Kiritimati
Kirov
Knox
Kolkata
Kosrae
Krasnoyarsk
Kuala_Lumpur
Kuching
Kwajalein
La_Paz
La_Rioja
Lagos
Lima
Lindeman
Lisbon
London
Lord_Howe
Los_Angeles
Louisville
Luxembourg
MET
MST
MST7MDT
Macau
Maceio
Macquarie
Madeira
Madrid
Magadan
Mahe
Majuro
Makassar
Maldives
Malta
Managua
Manaus
Manila
Maputo
Marengo
Marquesas
Martinique
Matamoros
Mauritius
Mawson
Mazatlan
Melbourne
Mendoza
Menominee
Merida
Metlakatla
Mexico_City
Minsk
Miquelon
Monaco
Moncton
Monrovia
Monterrey
Montevideo
Monticello
Moscow
Nairobi
Nassau
Nauru
Ndjamena
New_Salem
New_York
Nicosia
Nipigon
Niue
Nome
Norfolk
Noronha
Noumea
Novokuznetsk
Novosibirsk
Ojinaga
Omsk
Oral
Oslo
PST8PDT
Pago_Pago
Palau
Palmer
Panama
Pangnirtung
Paramaribo
Paris
Perth
Petersburg
Phoenix
Pitcairn
Pohnpei
Pontianak
Port-au-Prince
Port_Moresby
Port_of_Spain
Porto_Velho
Prague
Puerto_Rico
Punta_Arenas
Pyongyang
Qatar
Qostanay
Qyzylorda
Rainy_River
Rankin_Inlet
Rarotonga
Recife
Regina
Rel
Resolute
Reunion
Reykjavik
Riga
Rio_Branco
Rio_Gallegos
Riyadh
Rome
Rothera
Sakhalin
Salta
Samara
Samarkand
San_Juan
San_Luis
Santarem
Santiago
Santo_Domingo
Sao_Paulo
Sao_Tome
Saratov
Scoresbysund
Seoul
Shanghai
Simferopol
Singapore
Sitka
Sofia
South_Georgia
Srednekolymsk
St_Johns
Stanley
Stockholm
Swift_Current
Sydney
Syowa
Tahiti
Taipei
Tallinn
Tarawa
Tashkent
Tbilisi
Tegucigalpa
Tehran
Tell_City
Thimphu
Thule
Thunder_Bay
Tijuana
Tirane
Tokyo
Tomsk
Tongatapu
Toronto
Tripoli
Troll
Tucuman
Tunis
UTC
Ulaanbaatar
Ulyanovsk
Urumqi
Ushuaia
Ust-Nera
Uzhgorod
Vancouver
Vevay
Vienna
Vilnius
Vincennes
Vladivostok
Volgograd
Vostok
WET
Wake
Wallis
Warsaw
Whitehorse
Winamac
Windhoek
Winnipeg
Yakutat
Yakutsk
Yangon
Yekaterinburg
Yellowknife
Yerevan
Zaporozhye
Zurich

supertypes


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

def

unit

Unit identifier from standard unit database

meta


def	unit
enum	See below
is	str
lib	lib:ph
tagOn	finSetting, point
uiInput	ui::UnitInput

enum


%	percent (dimensionless)
%RH	percent_relative_humidity (dimensionless)
px	pixel (dimensionless)
db	decibel (dimensionless)
pf	power_factor (dimensionless)
pH	ph (dimensionless)
gH₂O/kgAir	grams_of_water_per_kilogram_dry_air (dimensionless)
V/K	volts_per_degree_kelvin (dimensionless)
°daysC	degree_days_celsius (dimensionless)
°daysF	degree_days_fahrenheit (dimensionless)
%obsc/ft	percent_obscuration_per_foot (dimensionless)
%obsc/m	percent_obscuration_per_meter (dimensionless)
psi/°F	psi_per_degree_fahrenheit (dimensionless)
m²/N	square_meters_per_newton (dimensionless)
W/m²K	watts_per_square_meter_degree_kelvin (dimensionless)
dBmV	db_millivolt (dimensionless)
dBµV	db_microvolt (dimensionless)
ppu	parts_per_unit (dimensionless)
ppm	parts_per_million (dimensionless)
ppb	parts_per_billion (dimensionless)
g/kg	grams_per_kilogram (dimensionless)
rad	radian (dimensionless)
deg	degrees_angular (dimensionless)
degPh	degrees_phase (dimensionless)
sr	steradian (dimensionless)
ntu	nephelometric_turbidity_units (dimensionless)
fnu	formazin_nephelometric_unit (dimensionless)
PUE	power_usage_effectiveness (dimensionless)
DCIE	data_center_infrastructure_efficiency (dimensionless)
Af	afghani (currency)
DZD	algerian_dinar (currency)
ARS	argentine_peso (currency)
Դ	armenian_dram (currency)
ƒ	aruban_guilder_florin (currency)
AUD	australian_dollar (currency)
ман	azerbaijanian_manat (currency)
BSD	bahamian_dollar (currency)
BHD	bahraini_dinar (currency)
฿	baht (currency)
PAB	balboa (currency)
BBD	barbados_dollar (currency)
Br	belarussian_ruble (currency)
BZD	belize_dollar (currency)
BMD	bermudian_dollar (currency)
VEF	bolivar_fuerte (currency)
BOB	boliviano (currency)
R$	brazilian_real (currency)
BND	brunei_dollar (currency)
лв	bulgarian_lev (currency)
BIF	burundi_franc (currency)
CAD	canadian_dollar (currency)
CVE	cape_verde_escudo (currency)
KYD	cayman_islands_dollar (currency)
₵	cedi (currency)
XAF	cfa_franc_bceao (currency)
XPF	cfp_franc (currency)
CLP	chilean_peso (currency)
元	chinese_yuan (currency)
CDF	congolese_franc (currency)
C$	cordoba_oro (currency)
₡	costa_rican_colon (currency)
Kn	croatian_kuna (currency)
CUP	cuban_peso (currency)
Kč	czech_koruna (currency)
GMD	dalasi (currency)
kr	danish_krone (currency)
ден	denar (currency)
DJF	djibouti_franc (currency)
Db	dobra (currency)
DOP	dominican_peso (currency)
₫	dong (currency)
XCD	east_caribbean_dollar (currency)
EGP	egyptian_pound (currency)
ETB	ethiopian_birr (currency)
€	euro (currency)
FKP	falkland_islands_pound (currency)
FJD	fiji_dollar (currency)
HUF	forint (currency)
GIP	gibraltar_pound (currency)
HTG	gourde (currency)
₲	guarani (currency)
GNF	guinea_franc (currency)
GYD	guyana_dollar (currency)
HKD	hong_kong_dollar (currency)
₴	hryvnia (currency)
Kr	iceland_krona (currency)
₹	indian_rupee (currency)
IRR	iranian_rial (currency)
IQD	iraqi_dinar (currency)
JMD	jamaican_dollar (currency)
JOD	jordanian_dinar (currency)
Sh	kenyan_shilling (currency)
PGK	kina (currency)
₭	kip (currency)
КМ	konvertibilna_marka (currency)
KWD	kuwaiti_dinar (currency)
MK	kwacha (currency)
Kz	kwanza (currency)
MMK	kyat (currency)
ლ	lari (currency)
LBP	lebanese_pound (currency)
ALL	lek (currency)
HNL	lempira (currency)
Le	leone (currency)
RON	leu (currency)
LRD	liberian_dollar (currency)
LYD	libyan_dinar (currency)
SZL	lilangeni (currency)
LSL	loti (currency)
MGA	malagasy_ariary (currency)
RM	malaysian_ringgit (currency)
TMT	manat (currency)
MUR	mauritius_rupee (currency)
MTn	metical (currency)
MXN	mexican_peso (currency)
MDL	moldavian_leu (currency)
MAD	moroccan_dirham (currency)
₦	naira (currency)
Nfk	nakfa (currency)
NAD	namibia_dollar (currency)
NPR	nepalese_rupee (currency)
₪	new_israeli_shekel (currency)
NZD	new_zealand_dollar (currency)
BTN	ngultrum (currency)
KPW	north_korean_won (currency)
NOK	norwegian_krone (currency)
PEN	nuevo_sol (currency)
UM	ouguiya (currency)
₨	pakistan_rupee (currency)
MOP	pataca (currency)
UYU	peso_uruguayo (currency)
₱	philippine_peso (currency)
£	pound_sterling (currency)
BWP	pula (currency)
zł	pzloty (currency)
QAR	qatari_rial (currency)
GTQ	quetzal (currency)
ZAR	rand (currency)
OMR	rial_omani (currency)
KHR	riel (currency)
MVR	rufiyaa (currency)
Rp	rupiah (currency)
RUB	russian_ruble (currency)
RWF	rwanda_franc (currency)
SHP	saint_helena_pound (currency)
SAR	saudi_riyal (currency)
din	serbian_dinar (currency)
SCR	seychelles_rupee (currency)
SGD	singapore_dollar (currency)
SBD	solomon_islands_dollar (currency)
KGS	som (currency)
SOS	somali_shilling (currency)
ЅМ	somoni (currency)
₩	south_korean_won (currency)
Rs	sri_lanka_rupee (currency)
SDG	sudanese_pound (currency)
SRD	suriname_dollar (currency)
SEK	swedish_krona (currency)
SFr	swiss_franc (currency)
SYP	syrian_pound (currency)
TWD	taiwan_dollar (currency)
৳	taka (currency)
WST	tala (currency)
TZS	tanzanian_shilling (currency)
〒	tenge (currency)
TTD	trinidad_and_tobago_dollar (currency)
₮	tugrik (currency)
TND	tunisian_dinar (currency)
₤	turkish_lira (currency)
AED	uae_dirham (currency)
UGX	uganda_shilling (currency)
$	us_dollar (currency)
UZS	uzbekistan_sum (currency)
Vt	vatu (currency)
YER	yemeni_rial (currency)
¥	yen (currency)
ZK	zambian_kwacha (currency)
ZWL	zimbabwe_dollar (currency)
m/s²	meters_per_second_squared (acceleration)
rad/s²	radians_per_second_squared (angular acceleration)
Js	joule_second (angular momentum)
rad/s	radians_per_second (angular velocity)
rpm	revolutions_per_minute (angular velocity)
m²	square_meter (area)
mm²	square_millimeter (area)
cm²	square_centimeter (area)
km²	square_kilometer (area)
in²	square_inch (area)
ft²	square_foot (area)
yd²	square_yard (area)
mile²	square_mile (area)
acre	acre (area)
F	farad (capacitance)
COP	coefficient_of_performance (cooling efficiency)
EER	energy_efficiency_ratio (cooling efficiency)
kW/ton	kilowatt_per_ton (cooling efficiency)
kg/m³	kilograms_per_cubic_meter (density)
g/m³	grams_per_cubic_meter (density)
mg/m³	milligrams_per_cubic_meter (density)
µg/m³	micrograms_per_cubic_meter (density)
kg/L	kilograms_per_liter (density)
mg/L	milligrams_per_liter (density)
C	coulomb (electric charge)
Ah	ampere_hour (electric charge)
S	siemens (electric conductance)
A	ampere (electric current)
mA	milliampere (electric current)
Am²	ampere_square_meter (electromagnetic moment)
A/m²	amperes_per_square_meter (electric current density)
V/m	volts_per_meter (electric field strength)
V	volt (electric potential)
mV	millivolt (electric potential)
kV	kilovolt (electric potential)
MV	megavolt (electric potential)
Ω	ohm (electric resistance)
kΩ	kilohm (electric resistance)
MΩ	megohm (electric resistance)
mΩ	milliohm (electric resistance)
S/m	siemens_per_meter (electrical conductivity)
Ωm	ohm_meter (electrical resistivity)
J	joule (energy)
kJ	kilojoule (energy)
Wh	watt_hour (energy)
kWh	kilowatt_hour (energy)
MWh	megawatt_hour (energy)
GWh	gigawatt_hour (energy)
BTU	btu (energy)
kBTU	kilobtu (energy)
MMBTU	megabtu (energy)
hph	horsepower_hour (energy)
cal	calorie (energy)
therm	therm (energy)
tonrefh	tons_refrigeration_hour (energy)
MJ	megajoule (energy)
GJ	gigajoule (energy)
Nm	newton_meter (energy)
m³_gas	cubic_meters_natural_gas (energy)
ft³_gas	cubic_feet_natural_gas (energy)
Hcf_natural_gas	hundred_cubic_feet_natural_gas (energy)
Ccf_natural_gas	centum_cubic_feet_natural_gas (energy)
Mcf_natural_gas	thousand_cubic_feet_natural_gas (energy)
MMcf_natural_gas	million_cubic_feet_natural_gas (energy)
VAh	volt_ampere_hour (apparent energy)
kVAh	kilovolt_ampere_hour (apparent energy)
MVAh	megavolt_ampere_hour (apparent energy)
VARh	volt_ampere_reactive_hour (reactive energy)
kVARh	kilovolt_ampere_reactive_hour (reactive energy)
MVARh	megavolt_ampere_reactive_hour (reactive energy)
J/m²	joules_per_square_meter (energy by area)
Wh/m²	watt_hours_per_square_meter (energy by area)
Wh/ft²	watt_hours_per_square_foot (energy by area)
kWh/m²	kilowatt_hours_per_square_meter (energy by area)
kWh/ft²	kilowatt_hours_per_square_foot (energy by area)
MWh/m²	megawatt_hours_per_square_meter (energy by area)
MWh/ft²	megawatt_hours_per_square_foot (energy by area)
MJ/m²	megajoules_per_square_meter (energy by area)
MJ/ft²	megajoules_per_square_foot (energy by area)
BTU/ft²	btu_per_square_foot (energy by area)
kBTU/ft²	kilobtu_per_square_foot (energy by area)
MBTU/ft²	megabtu_per_square_foot (energy by area)
J/m³	joules_per_cubic_meter (energy by volume)
GJ/m³	gigajoules_per_cubic_meter (energy by volume)
kWh/m³	kilowatt_hours_per_cubic_meter (energy by volume)
J/g	joules_per_gram (enthalpy)
J/kg	joules_per_kilogram (enthalpy)
J/kg_dry	joules_per_kilogram_dry_air (enthalpy)
BTU/lb	btu_per_pound (enthalpy)
btu/lb_dry	btus_per_pound_dry_air (enthalpy)
kJ/kg	kilojoules_per_kilogram (enthalpy)
kJ/kg_dry	kilojoules_per_kilogram_dry_air (enthalpy)
MJ/kg_dry	megajoules_per_kilogram_dry_air (enthalpy)
cal/g	calorie_per_gram (enthalpy)
J/°K	joules_per_degree_kelvin (entropy)
kJ/°K	kilojoules_per_degree_kelvin (entropy)
MJ/°K	megajoules_per_degree_kelvin (entropy)
N	newton (force)
lbf	pound_force (force)
Hz	hertz (frequency)
kHz	kilohertz (frequency)
cph	cycles_per_hour (frequency)
cpm	cycles_per_minute (frequency)
MHz	megahertz (frequency)
/min	per_minute (frequency)
/s	per_second (frequency)
/h	per_hour (frequency)
%/s	percent_per_second (frequency)
ACH	air_changes_per_hour (frequency)
kg/m²	kilograms_per_square_meter (grammage)
g/m²	grams_per_square_meter (grammage)
K/s	degrees_kelvin_per_second (heating rate)
°C/h	degrees_celsius_per_hour (heating rate)
°C/min	degrees_celsius_per_minute (heating rate)
°F/h	degrees_fahrenheit_per_hour (heating rate)
°F/min	degrees_fahrenheit_per_minute (heating rate)
K/h	degrees_kelvin_per_hour (heating rate)
K/min	degrees_kelvin_per_minute (heating rate)
lx	lux (illuminance)
fc	footcandle (illuminance)
phot	phot (illuminance)
H	henry (inductance)
W/m²_irr	watts_per_square_meter_irradiance (irradiance)
W/ft²_irr	watts_per_square_foot_irradiance (irradiance)
m	meter (length)
µm	micrometer (length)
mm	millimeter (length)
cm	centimeter (length)
km	kilometer (length)
in	inch (length)
ft	foot (length)
yd	yard (length)
mile	mile (length)
cd/m²	candelas_per_square_meter (luminance)
cd/ft²	candels_per_square_foot (luminance)
lm	lumen (luminous flux)
cd	candela (luminous intensity)
A/m	amperes_per_meter (magnetic field strength)
Wb	weber (magnetic flux)
T	tesla (magnetic flux density)
kg	kilogram (mass)
mg	milligram (mass)
g	gram (mass)
oz	ounce (mass)
lb	pound (mass)
klb	kilopound (mass)
ton	metric_ton (mass)
t	short_ton (mass)
kg/s	kilograms_per_second (mass flow)
kg/min	kilograms_per_minute (mass flow)
kg/h	kilograms_per_hour (mass flow)
lb/min	pounds_per_minute (mass flow)
lb/h	pounds_per_hour (mass flow)
lb/s	pounds_per_second (mass flow)
klb/h	kilopounds_per_hour (mass flow)
g/s	grams_per_second (mass flow)
g/min	grams_per_minute (mass flow)
ton/h	metric_tons_per_hour (mass flow)
Ns	newton_second (momentum)
W	watt (power)
mW	milliwatt (power)
kW	kilowatt (power)
MW	megawatt (power)
GW	gigawatt (power)
BTU/h	btus_per_hour (power)
therm/h	therms_per_hour (power)
hp	horsepower (power)
ftlbs/sec	foot_pounds_per_second (power)
tonref	tons_refrigeration (power)
kBTU/h	kilobtus_per_hour (power)
MMBTU/h	megabtus_per_hour (power)
J/h	joules_per_hour (power)
kJ/h	kilojoules_per_hour (power)
MJ/h	megajoules_per_hour (power)
GJ/h	gigajoules_per_hour (power)
W/m²	watts_per_square_meter (power by area)
W/ft²	watts_per_square_foot (power by area)
kW/m²	kilowatts_per_square_meter (power by area)
kW/ft²	kilowatts_per_square_foot (power by area)
kBTU/h/ft²	kilobtus_per_hour_per_square_foot (power by area)
W/m³/s	watts_per_cubic_meters_per_second (power by volumetric flow)
W/cfm	watts_per_cubic_feet_per_minute (power by volumetric flow)
kW/kcfm	kilowatts_per_kilocubic_feet_per_minute (power by volumetric flow)
kW/gal/min	kilowatts_per_gallons_per_minute (power by volumetric flow)
VA	volt_ampere (apparent power)
kVA	kilovolt_ampere (apparent power)
mVA	megavolt_ampere (apparent power)
VAR	volt_ampere_reactive (reactive power)
kVAR	kilovolt_ampere_reactive (reactive power)
MVAR	megavolt_ampere_reactive (reactive power)
Pa	pascal (pressure)
kPa	kilopascal (pressure)
bar	bar (pressure)
atm	atmosphere (pressure)
psi	pounds_per_square_inch (pressure)
cmH₂O	centimeters_of_water (pressure)
inH₂O	inches_of_water (pressure)
mmHg	millimeters_of_mercury (pressure)
cmHg	centimeters_of_mercury (pressure)
inHg	inches_of_mercury (pressure)
hPa	hectopascal (pressure)
mbar	millibar (pressure)
J/kg°K	joules_per_kilogram_degree_kelvin (specific entropy)
N/m	newtons_per_meter (surface tension)
°F	fahrenheit (temperature)
°C	celsius (temperature)
K	kelvin (temperature)
Δ°F	fahrenheit_degrees (temperature differential)
Δ°C	celsius_degrees (temperature differential)
ΔK	kelvin_degrees (temperature differential)
W/m°K	watts_per_meter_degree_kelvin (thermal conductivity)
ns	nanosecond (time)
µs	microsecond (time)
ms	millisecond (time)
cs	hundredths_second (time)
ds	tenths_second (time)
sec	second (time)
min	minute (time)
hr	hour (time)
day	day (time)
wk	week (time)
mo	julian_month (time)
yr	year (time)
m/s	meters_per_second (velocity)
km/s	kilometers_per_second (velocity)
km/h	kilometers_per_hour (velocity)
mph	miles_per_hour (velocity)
ft/s	feet_per_second (velocity)
ft/min	feet_per_minute (velocity)
in/h	inches_per_hour (velocity)
mm/s	millimeters_per_second (velocity)
mm/min	millimeters_per_minute (velocity)
mm/h	millimeters_per_hour (velocity)
m/min	meters_per_minute (velocity)
m/h	meters_per_hour (velocity)
knot	knot (velocity)
cfm/ft²	cubic_feet_per_minute_per_square_foot (velocity)
m³	cubic_meter (volume)
mm³	cubic_millimeter (volume)
cm³	cubic_centimeter (volume)
mL	milliliter (volume)
hL	hectoliter (volume)
L	liter (volume)
kL	kiloliter (volume)
in³	cubic_inch (volume)
ft³	cubic_foot (volume)
yd³	cubic_yard (volume)
gal	gallon (volume)
kgal	kilogallon (volume)
qt	quart (volume)
pt	pint (volume)
fl_oz	fluid_ounce (volume)
galUK	imperial_gallon (volume)
hft³	hecto_cubic_foot (volume)
Hcf	hundred_cubic_feet (volume)
Ccf	centum_cubic_feet (volume)
Mcf	thousand_cubic_feet (volume)
MMcf	million_cubic_feet (volume)
m³/s	cubic_meters_per_second (volumetric flow)
mL/s	milliliters_per_second (volumetric flow)
hL/s	hectoliters_per_second (volumetric flow)
L/s	liters_per_second (volumetric flow)
cfs	cubic_feet_per_second (volumetric flow)
cfm	cubic_feet_per_minute (volumetric flow)
cfh	cubic_feet_per_hour (volumetric flow)
kcfm	kilocubic_feet_per_minute (volumetric flow)
galUK/min	imperial_gallons_per_minute (volumetric flow)
L/min	liters_per_minute (volumetric flow)
gal/min	gallons_per_minute (volumetric flow)
gph	gallons_per_hour (volumetric flow)
L/h	liters_per_hour (volumetric flow)
m³/min	cubic_meters_per_minute (volumetric flow)
m³/h	cubic_meters_per_hour (volumetric flow)
byte	byte (bytes)
kB	kilobyte (bytes)
MB	megabyte (bytes)
GB	gigabyte (bytes)
TB	terabyte (bytes)
PB	petabyte (bytes)

supertypes


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

subtypes


currency	The currency unit related to the entity

def

uri

Universal resource identifier. See Kinds chapter.

meta


def	uri
is	scalar
lib	lib:ph
tagOn	arcbeamConn, energyStarConn, haystackConn, modbusConn, mqttConn, opcConn, sedonaConn, snmpConn, sqlConn, tplTrendConn

supertypes


val	Data value type
scalar	Scalar is an atomic value kind

subtypes


baseUri	Base URI for normalizing relative URIs
defUri	Host relative URI to redirect the user upon login
knxCur	Uri to use for current value subscriptions
knxWrite	Stores the Uri to be used when writing to the datapoint
modbusRegMapUri	Applied to `modbusConn` to define the register map CSV file
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
obixWrite	URI of the `obix:WritablePoint` to write `writeVal`
snmpMibsUri	Applied to `snmpConn` to define the collection of MIB files to load
wikipedia	Hyperlink to the subject's page on Wikipedia

def

val

Data value type

meta


def	val
lib	lib:ph

subtypes


defVal	Default value
dict	Map of name/value tag pairs
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
enum	Defines an eumeration of string key names
grid	Two dimension table of columns and rows
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
list	Ordered list of zero or more values
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
scalar	Scalar is an atomic value kind
bool	Boolean value `true` or `false`
mqttCleanSession	Whether to set the clean session flag on the connect request to the broker
mqttRetain	Set the retention flag on a published message
coord	Geographic coordinate in latitude/longitude in decimal degrees
geoCoord	Geographic coordinate as `C(latitude,longitude)`
curVal	Current value of a point
date	ISO 8601 date as year, month, day
dueDate	Date expected for completion of the workflow task
expires	Expiration date
dateTime	ISO 8601 timestamp followed by timezone identifier
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
na	Not available used to indicate invalid or missing data
nextVal	Next value the schedule will transition to
number	Integer or floating point numbers annotated with an optional unit
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
ref	Reference to an entity
airRef	Air flows from the referent to this entity
arcOn	Subject of the document
arcbeamConnRef	Used on a proxy point to reference its parent `arcbeamConn`
assignedTo	Person who is currently responsible for the workflow task
bacnetConnRef	Used on a proxy object to reference its parent `bacnetConn`
bacnetDeviceRef	Applied to a `bacnetConn` or `ext` to reference a BACnet device object
bacnetServerDeviceRef	Applied to an `equip` to bind the equip to a `bacnetServerDevice`
blowdownWaterRef	Blowdown water flows from the referent to this entity
by	Author of a document or part
calendarRef	Used to chain a calendar to a schedule or another calendar
chilledWaterRef	Chilled water flows from the referent to this entity
cloneSetRef	Clone set which manages the clone
condensateRef	Condensate flows from the referent to this entity
condenserWaterRef	Condenser water flows from the referent to this entity
connTuningRef	Reference to a tuning configuration defined by a `connTuning` rec
deviceRef	Device which controls a monitors this entity
domesticWaterRef	Domestic water flows from the referent to this entity
ecobeeConnRef	Used on a proxy point to reference its parent `ecobeeConn`
elecRef	Electricity flows from the referent to this entity
energyStarConnRef	Used on a proxy object to reference its parent `energyStarConn`
equipRef	Reference to equip which contains this entity
finMailConnRef	Used on a proxy object to reference its parent `finMailConn`
finPreviewImageRef	This is a ref to an image that will be previewed for what this is
finWatcherChangedRef	Reference to the record that is detected as changed
finpFileRef	This tag is a ref to the finp file
floorRef	A legacy deprecated floor reference
fuelOilRef	Fuel oil flows from the referent to this entity
gasolineRef	Gasoline flows from the referent to this entity
ghgEmissionSourceRef	Ref to the emission source where this emission factor will apply
ghgFactorHisRef	References a ghgFactorHis point record that the Greenhouse Gas Emission Engine uses to calculate emissions
ghgSourceRef	Ref to the emission source used to calculate Greenhouse Gas Emissions
haystackConnRef	Used on a proxy point to reference its parent `haystackConn`
hotWaterRef	Hot water flows from the referent to this entity
id	Defines the unique identifier of an entity in system using a `ref` value type
knxConnRef	Assocation with `knxConn`
knxProjFileRef	`A reference to the *knxproj file attached to a given KnxConn`
makeupWaterRef	Makeup water flows from the referent to this entity
mlOutputVarRef	Dependent variable, also known as the model output or target, associated, with a machine learning model
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
modbusConnRef	Used on a proxy point to reference its parent `modbusConn`
mqttConnRef	Used on a proxy point to reference its parent `mqttConn`
naturalGasRef	Natural gas flows from the referent to this entity
nestConnRef	Used on a proxy point to reference its parent `nestConn`
networkRef	Associates a device which communicates on specific a network
nodeRef	Reference to a node in the cluster database
obixConnRef	Used on a proxy point to reference its parent `obixConn`
obsMqttConnRef	Subscribe to the topic on this MQTT connector
opcConnRef	Used on a proxy object to reference its parent `opcConn`
pointRef	See Synthetics chapter
programRef	Reference to associated `program` rec
refrigRef	Refrigerant flows from the referent to this entity
ruleRef	Reference to rule which contains this entity
ruleTuningTargetRef	Reference to a specific rule target or target parent
scheduleRef	Associates a `schedulable` with its schedule
sedonaConnRef	Used on a proxy point to reference its parent `sedonaConn`
siteRef	Reference to site which contains the entity
snmpConnRef	Used on a proxy object to reference its parent `snmpConn`
sourceRef	Reference to the source of the alarm
spaceRef	Reference to space which contains this entity
sqlConnRef	Used on a proxy point to reference its parent `sqlConn`
steamRef	Steam flows from the referent to this entity
submeterOf	Reference to parent meter which is immediately upstream of this meter
syntheticModelRef	See Synthetics chapter
systemRef	Reference to system
targetRef	Reference to the target record of a rule result or associated record
tariffChargeRef	Reference to an entity
tariffFeeHisRef	The ref to the history point that contains the historical fee data
tariffHisRef	If multiple meters share the same tariff history, then you can use this tag to reference the "master" point containing the tariff history
tariffRef	The tariff a charge belongs to
tplTrendConnRef	Used on a proxy point to reference its parent `tplTrendConn`
userProtoRef	User prototype to apply to a user
userRef	Reference to user entity
weatherStationRef	Reference to weather station for to use this entity
remove	Singleton for remove operation
str	Unicode string of characters
ackErr	This tag is set when there is an error acknowledging alarm and contains the reason for the error
ackMessage	Message or reason for acknowledgement
ackedBy	Who acknowledged the alarm
addTags	A comma separated list of tags and their values to apply to records
alarmAckAccessFilter	String filter applied to a user record which defines which alarms a user may acknowldege
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
appAccess	Restricts the set of accessible apps
appFormOn	Application Form Selector Tag
appName	View containing app name
arcPriority	Priority level of the document
arcState	Defines work flow state of an arc document
ticketState	Workflow state for a ticket
workorderState	Workflow state for a workorder
arcWriteAccess	Defines write permissions for arc documents
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
arcbeamWrite	Used on a arcbeam proxy point to store the id of the entity in the remote system used to write `writeVal`
bacnetCur	Used on a BACnet proxy point to subscribe for current value
bacnetDeviceName	Tag for current device name
bacnetHis	Used on a BACnet proxy point to store BACnet trend log id
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
bacnetScheduleWrite	bacnetScheduleWrite tag enables the writing of BACnet schedule properties
bacnetServerDis	Apply the bacnetServerDis tag of String type to any point or equip to set custom description for the BACnet server
bacnetServerLocalAddress	Applied to a bacnetServer `ext` record configures the interface the server listens to request
bacnetVersion	Tag for current connection protocol version
bacnetWrite	Reference for BACnet object id to be written
bindStatus	Current status of a component cell binding
builderSettings	Function returns settings for builder
certificatePem	PEM encoding of the User Certificate
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
chartLegend	Provides option to control legend on charts
chartOn	Chart Record Selector Tag
chartType	Enumerated chart type such as "line" or "bar"
cloneProj	Project name for clone set data
cloneSetStatus	Current status of a cloneSet
color	Color encoded as `#RRGGBB`, `#RGB`, or a CSS color keyword
connErr	Error message associated when `connStatus` indicates an error condition
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
construct	Defines a constructor for the function
curErr	Error description when `curStatus` indicates error condition
curStatus	Status of point's current value reading
dbToolCategory	Used to group forms together without affecting their folder path
defName	Specifies definition symbol name to use
defView	The name of the view that should be the default for a user or project
dis	Display name for an entity
disKey	Localized string key formatted as `pod::key`
disMacro	Display name using macro syntax
doc	Documentation in simplified flavor of markdown
dockerState	Current status of a Docker container
dockerStatus	Additional human-readable status of the container
ecobeeCur	Ecobee address to use to get the current value
ecobeeHis	Ecobee address to use to sync point history
ecobeeWrite	Ecobee address to use to write a point value
elecLine	Single-phase line measurement of an electric quantity in a multi-phase AC electric power system
lineCurrent	Single-phase line current measured 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
elecLineToLine	Single-phase electric quantity measured line-to-line in a multi-phase 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
phaseCurrent	Single-phase current measured line-to-line in an AC electric power system
elecLineToNeutral	Single-phase electric quantity measured line-to-neutral in a multi-phase AC electric power system
phaseVolt	Single-phase voltage measured line-to-neutral in an AC electric power system
email	An email address
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
enumExpr	Axon expression to dynamically compute an enum
errTrace	Exception stack trace
evseCableType	Physical type of `evse-cable`
evseStatus	Status of one or more `evse-port` reported by an EVSE
example	Defines an example for the function
excludes
expr	Axon expression string
taskExpr	Task messaging handling Axon expression
fileExt	Filename extension such as "csv"
filterStr	Haystack filter string
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
finMailContent	The first 1024 characters of the email content (body)
finMailFrom	Comma separated list of `From` addresses
finMailReplyTo	Comma separated list of `Reply To` addresses
finMailSubject	The email `Subject`
finMailTo	Comma separated list of `To` addresses
finWatcherCallbackOn	Axon expression tag placed on a `finWatcherCallback` callback
finWatcherChanges	A serialized Zinc grid that encodes which tags where added/changed/removed on a `finWatcherChangedRef` record
flags	Flags string
foldOn	Registers a function as folding a given value type
fontWeight	Font weight setting
formOn	Form Record Selector Tag
format	Pattern used to format a value via `format()`
fromState	State of the entity prior to alarm transition
funcName	Name of function associated with route
geoAddr	Free form street address
geoCity	Geographic city or locality name
geoCountry	Geographic country as ISO 3166-1 two letter code
geoCounty	Geographic subdivision of US state
geoPostalCode	Geographic postal code
geoState	State or province name
geoStreet	Geographic street address and name
ghgHeatContentDis	Describes source of location specific heat content values
ghgHeatContentSyncId	Used internally for syncing location specific heat content values
ghgSourceSyncId	Identifies the emission source used for automatically creating emission factors
ghgSyncId	Identifies the individual Greenhouse Gas Emission to sync
halign	Horizontal layout alignment
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
haystackWrite	Used on a haystack proxy point to store the id of the entity in the remote system used to write `writeVal`
help	End user documentation
helpDoc	Path to help documentation
hisErr	Error description when `hisStatus` indicates error condition
hisFunc	Axon expression used to create a computed history
hisInterpolateMode	Explicitly configures the interpolation mode to use for this point
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
hisRollupFunc	Function name to use for `hisRollupAuto()`
hisStatus	Status of point's history collection or synchronization
hotKey	One or more key combinations separated by a comma
icon	Icon logical name - see Icons
imageSize	Image size in pixels
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
knxAddr	The KNX Group Address used on a particular KnxConn
knxIndividualAddr	The KNX individual address of a physical device record (e.g
ldapUserProtoAttrVal	The value of this tag is used to help the LDAP mod determine which user prototypes an LDAP user maps to
libStatus	Current status of an extension or sys module library
licStatus	License status
logLevel	Severity level
message	Message describing the alarm or reason for the alarm
mime	Mime type formatted as type/subtype
modbusCur	Modbus address to use for current value subscriptions
modbusWrite	Used on a modbus proxy point to store the id of the entity in the remote system used to write `writeVal`
mqttCertAlias	Used on an `mqttConn` to indicate which certificate and key pair to use for client authentication to the broker
mqttClientId	The client identifier to use when connecting to the broker
mqttVersion	MQTT protocol version
name	Name key
navName	Navigation name commonly used with `disMacro` to create computed display strings
navTarget	Apply to a def to specify a default navigation target
navTree	Navigation tree name to use for ref tag
nestCur	Nest address to use to get the current value
nestProjectId	The project identifier from your Google Device Access project
nestWrite	Nest address to use to write a point value
noData	Message string when no data available
nodeId	Node id as string without the `n:` prefix
nodeStatus	Current status of a cluster node
nodeType	Is node haxall or skyspark
notifyTopicProj	The value is a project name
obsMqttTopic	Receive published messages that match this filter
obsScheduleDaysOfMonth	Schedule events for given days of the month
obsScheduleDaysOfWeek	Schedule events for given days of the week
opcCertAlias	Used on an `opcConn` to indicate which certificate and key pair to use for asymmetric message security
opcCur	OPC UA encoded address to use for current value subscriptions
opcHis	OPC UA encoded address to use for a historized proxy point
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
optsTemplate	TODO
pageSize	Printed page size formatted as "width,height" with an explicit unit of "pt", "in", "mm", or "cm"
password	Manages password which is hashed/stored to the password store
ecobeeClientId	Your Ecobee API Key
ecobeeRefreshToken	The refresh token you obtained for your API key
nestClientId	The OAuth client_id for your application
nestClientSecret	The OAuth client_secret for your application
nestRefreshToken	The OAuth refresh_token for your application
periods	Timeline of on/off periods encoded as Base64 via `discretePeriods()`
phase	Phase measurement in a three-phase electrical system
placeholder	Hint displayed in a text field input
podName	Fantom pod name
pointConvert	Point value conversion used to normalize data to/from a remote system
curConvert	Conversion to apply when reading curVal from connector
hisConvert	Conversion to apply when reading history data from connector
writeConvert	Conversion to apply when writing writeVal to the connector
pointOverrideAccess	Defines levels which may be overridden by the user for writable points
primaryFunction	Primary function of building as US Energy Star key
program	Identifies and defines a control program
programOn	String filter which defines the targets for a control `program`
programVars	Zinc encoded table of variable definitions
pubKey	Public key as encoded string
queryString
reader	Fantom type qname for reader class
routeOn	Filter that will select alarms to route
routeStatus	Project cluster route status
readRouteStatus	Project cluster route status for reads
ruleCost	Specifies formula used to apply a cost tag to sparks
ruleFunc	Specifies the function to run for a `rule`
ruleStatus	Current status of a rule
samlSsoUserProtoAttrVal	The value of this tag is used to help the SAML SSO auth mod determine which user prototypes a SAML SSO user matches
scheduleVal	The string name/encoding of a schedule value
sedonaCur	Sedona address to use for current value subscritions
sedonaWrite	Sedona address to use for writing
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
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
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
sqlHis	Arbitrary key used by the SQL connector to synchronized history data
sqlSyncHisExpr	This is a tag which must be configured on each `sqlConn` record used by the `connSyncHis()` function
src	Source code
state	State of the alarm
strokeDasharray	Comma separated lengths of dashs and gaps for rendering lines such as "6,4"
subtitle	Defines subtitle string for visualizations
targetFilter	Filter which matches points to be commanded by this route
tariffChargeFunc	The name of the function that tariff engine should call to compute the cost
tariffFeeFreq	The frequency that the charge applies per bill period
tariffRangeStrategy	When a charge has multiple ranges this tag indicates to the tariff engine how to interpret and calculate costs based on those ranges
tariffRatchetPeriod	A value representing how far back to go when calculating the minimum peak demand for a billing period
taskStatus	Current status of a task
templateName	Template by name - legacy support
title	Defines title string for visualizations
toState	State of the entity when going into alarm
topicsEmailDigest	Classic legacy support
topicsEmailImmediate	Classic legacy support
tplTrendCur	TplTrend address to use for reading the current value
tplTrendHis	TplTrend address to use for reading historical data
typeName	Fantom type qname
uiInput	Fantom type qname for `Input` to use for a definition
tz	Timezone identifier from standard timezone database
uiFormOn	uiForm Record Selector Tag
unit	Unit identifier from standard unit database
currency	The currency unit related to the entity
usedWith	Legacy tag definitions
userProtoName	User prototype name
userRole	Indicates what permissions and access rights the user has
username	Username for an authentication account
validate	Axon expression to validate def
version	Version string formatted as decimal integers separated by a dot
viewerSettings	Function returns settings for viewer
writeErr	Error description when `writeStatus` indicates error condition
writeStatus	Current status of a writable point output
writer	Fantom type qname for writer class
symbol	Symbol to a def
def	Create a new definition bound to the given symbol
defx	Extends the given definition with additional meta tags
of	Expected value type of a collection, reference, or choice
reciprocalOf	Specifies the inverse of an association or relationships
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
time	ISO 8601 time as hour, minute, seconds
uri	Universal resource identifier
baseUri	Base URI for normalizing relative URIs
defUri	Host relative URI to redirect the user upon login
knxCur	Uri to use for current value subscriptions
knxWrite	Stores the Uri to be used when writing to the datapoint
modbusRegMapUri	Applied to `modbusConn` to define the register map CSV file
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
obixWrite	URI of the `obix:WritablePoint` to write `writeVal`
snmpMibsUri	Applied to `snmpConn` to define the collection of MIB files to load
wikipedia	Hyperlink to the subject's page on Wikipedia
value	Value to write to the selected points
writeVal	Current desired value to write to output
xstr	Extended string - type name and string value encoding
finMailBody	Present if the email body is bigger than 1024 chars, it stores to body as Bin
span	Time span as modeled encoded as XStr
mlIdentificationPeriod	Training period description, known as the identification period or baseline, utilized during the model training process
obsScheduleSpan	Schedule events only during the configured span of time

def

version

Version string formatted as decimal integers separated by a dot

meta


def	version
is	str
lib	lib:ph
tagOn	lib, projMeta, provBuild, provImage, provOverlay, provPatch

supertypes


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

def

wikipedia

Hyperlink to the subject's page on Wikipedia

meta


def	wikipedia
is	uri
lib	lib:ph
tagOn	def

supertypes


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

def

xstr

Extended string - type name and string value encoding. See Kinds chapter.

meta


def	xstr
is	scalar
lib	lib:ph

supertypes


val	Data value type
scalar	Scalar is an atomic value kind

subtypes


finMailBody	Present if the email body is bigger than 1024 chars, it stores to body as Bin
span	Time span as modeled encoded as XStr
mlIdentificationPeriod	Training period description, known as the identification period or baseline, utilized during the model training process
obsScheduleSpan	Schedule events only during the configured span of time

lib-ph 库参考（第 2 部分） ​

目录（导读） ​

概述（中译） ​

API 正文（英文） ​

op:watchUnsub ​

output ​

outputs ​

reciprocalOf ​

ref ​

relationship ​

remove ​

scalar ​

span ​

str ​

symbol ​

tagOn ​

tags ​

time ​

transient ​

transitive ​

tz ​

unit ​

uri ​

val ​

version ​

wikipedia ​

xstr ​

`lib-ph` 库参考（第 2 部分）

目录（导读）

概述（中译）

API 正文（英文）

op:watchUnsub

output

outputs

reciprocalOf

ref

relationship

remove

scalar

span

str

symbol

tagOn

tags

time

transient

transitive

tz

unit

uri

val

version

wikipedia

xstr