def
val
Data value type
meta
subtypes
dict |
Map of name/value tag pairs |
---|---|
connFeatures |
Defines the features supported by a given connector |
enum |
Defines an eumeration of string key names |
grid |
Two dimension table of columns and rows |
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 |
children |
List of prototypes contained by this entity |
childrenFlatten |
List of aspects to flatten into children prototypes |
depends |
List of this library's dependencies |
obsScheduleTimes |
Schedule events for given times of the day |
prefUnit |
Defines a preferred unit to be used with a quantity |
scalar |
Scalar is an atomic value kind |
bool |
Boolean value |
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 |
curVal |
Current value of a point |
date |
ISO 8601 date as year, month, day |
dateTime |
ISO 8601 timestamp followed by timezone identifier |
created |
The timestamp when entity was created |
mod |
Last modified time of record - see docSkySpark |
na |
Not available used to indicate invalid or missing data |
number |
Integer or floating point numbers annotated with an optional unit |
area |
Area of a shape or floor space |
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 |
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 |
haystackPollFreq |
Applied to |
hisCollectCovRateLimit |
Rate limits the frequency for |
hisCollectInterval |
Enables interval history collection of the |
hisCollectWriteFreq |
This tag configures how long to buffer collected history items in memory before flushing them to 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 |
staleTime |
Time before a point's curStatus marked from "ok" to "stale" See Connector Tuning |
steadyState |
The delay before transitioning to the steady state |
writeMaxTime |
Maximum time between writes used to send periodic writes |
writeMinTime |
Minimum time between writes used to throttle the speed of writes |
geoElevation |
Elevation above sea-level of the location |
hisCollectCov |
Enables COV history collection of the |
int |
Unitless integer number |
floorNum |
Unitless integer indicating the floor's distance from ground level |
haystackWriteLevel |
Number between 1 and 16 used with |
modbusBlockGap |
Applied to |
modbusBlockMax |
Applied to |
modbusSlave |
Applied to |
mqttMaxRetry |
How many times to retry sending messages that require acknowlegment |
obixWritable |
Server export of a writable point as an |
obixWriteLevel |
Number between 1 and 16 used with |
stage |
Stage number of staged equipment operation such as coil or pump |
writeLevel |
Current priority level for |
yearBuilt |
Original year of construction as four digit year such as 1980 |
maxVal |
Inclusive maximum for a numeric value |
minVal |
Inclusive minimum for a numeric value |
mqttQos |
MQTT Quality of Service (QoS)
|
ref |
Reference to an entity |
airRef |
Air flows from the referent to this entity |
blowdownWaterRef |
Blowdown water flows from the referent to this entity |
chilledWaterRef |
Chilled water flows from the referent to this entity |
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 |
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 |
elecRef |
Electricity flows from the referent to this entity |
equipRef |
Reference to equip which contains this entity |
fuelOilRef |
Fuel oil flows from the referent to this entity |
gasolineRef |
Gasoline flows from the referent to this entity |
haystackConnRef |
Used on a proxy point to reference its parent |
hotWaterRef |
Hot water flows from the referent to this entity |
id |
Defines the unique identifier of an entity in system using a |
makeupWaterRef |
Makeup water flows from the referent to this entity |
modbusConnRef |
Used on a proxy point to reference its parent |
mqttConnRef |
Used on a proxy point to reference its parent |
naturalGasRef |
Natural gas flows from the referent to this entity |
nestConnRef |
Used on a proxy point to reference its parent |
networkRef |
Associates a device which communicates on specific a network |
obixConnRef |
Used on a proxy point to reference its parent |
obsMqttConnRef |
Subscribe to the topic on this MQTT connector |
refrigRef |
Refrigerant flows from the referent to this entity |
sedonaConnRef |
Used on a proxy point to reference its parent |
siteRef |
Reference to site which contains the entity |
spaceRef |
Reference to space which contains this entity |
sqlConnRef |
Used on a proxy point to reference its parent |
steamRef |
Steam flows from the referent to this entity |
submeterOf |
Reference to parent meter which is immediately upstream of this meter |
systemRef |
Reference to system |
weatherStationRef |
Reference to weather station for to use this entity |
remove |
Singleton for remove operation |
str |
Unicode string of characters |
connErr |
Error message associated when |
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 |
curErr |
Error description when |
curStatus |
Status of point's current value reading |
dis |
Display name for an entity |
disKey |
Localized string key formatted as |
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 an 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 an AC electric power system |
lineEnergy |
Single-phase energy measured line-to-line in an AC electric power system |
linePf |
Single-phase power factor measured line-to-line in an AC electric power system |
linePower |
Single-phase power measured line-to-line in an AC electric power system |
lineVolt |
Single-phase voltage measured line-to-line in an AC electric power system |
phaseCurrent |
Single-phase current measured line-to-line in an AC electric power system |
elecLineToNeutral |
Single-phase electric quantity measured line-to-neutral in an AC electric power system |
phaseVolt |
Single-phase voltage measured line-to-neutral in an AC electric power system |
errTrace |
Exception stack trace |
expr |
Axon expression string |
taskExpr |
Task messaging handling Axon expression |
fileExt |
Filename extension such as "csv" |
filterStr |
Haystack filter string |
obsFilter |
Filter string to define the record data set observed |
flags |
Flags string |
foldOn |
Registers a function as folding a given value type |
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 |
haystackCur |
Used on a haystack proxy point to store the id of the entity in the remote system used to read and watch |
haystackHis |
Used on a haystack proxy point object to store the id of the historized point in the remote system used to sync history data |
haystackWrite |
Used on a haystack proxy point to store the id of the entity in the remote system used to write |
hisErr |
Error description when |
hisMode |
Indicates the way that history data is collected for a point |
hisStatus |
Status of point's history collection or synchronization |
kind |
Kind name used to identity a value data type |
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 |
mqttCertAlias |
Used on an |
mqttClientId |
The client identifier to use when connecting to the broker |
mqttVersion |
MQTT protocol version |
name |
Name key |
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 |
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 |
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 |
phase |
Phase measurement in a three-phase electrical system |
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 |
primaryFunction |
Primary function of building as US Energy Star key |
reader |
Fantom type qname for reader class |
sedonaCur |
Sedona address to use for current value subscritions |
sedonaWrite |
Sedona address to use for writing |
sqlHis |
Arbitrary key used by the SQL connector to synchronized history data |
sqlSyncHisExpr |
This is a tag which must be configured on each |
src |
Source code |
taskStatus |
Current status of a task |
typeName |
Fantom type qname |
tz |
Timezone identifier from standard timezone database |
unit |
Unit identifier from standard unit database |
username |
Username for an authentication account |
version |
Version string formatted as decimal integers separated by a dot |
writeErr |
Error description when |
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 |
modbusRegMapUri |
Applied to |
obixCur |
Used on a oBIX proxy point to store the URI of the entity in the remote system used to read and watch |
obixHis |
URI of the |
obixLobby |
The lobby URI is used to address an |
obixWrite |
URI of the |
wikipedia |
Hyperlink to the subject's page on Wikipedia |
writeVal |
Current desired value to write to output |
xstr |
Extended string - type name and string value encoding |
span |
Time span as modeled encoded as XStr |
obsScheduleSpan |
Schedule events only during the configured span of time |