Map of name/value tag pairs

Defines the features supported by a given connector

Goodness-of-fit metrics provided in the form of a simple dictionary

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

Defines an eumeration of string key names

Two dimension table of columns and rows

Ordered list of zero or more values

Associations model ontological relationships between definitions

Defines one or more supertypes of a subtyping relationship

Quantities used to measure this phenomenon

Associates quantity as measurement of a phenomenon

This tag is used on the given entity

Tags used with this entity

List of prototypes contained by this entity

List of aspects to flatten into children prototypes

List of this library's dependencies

List of independent variables, also known as model inputs or features, associated with a machine learning model

Schedule events for given times of the day

Defines a preferred unit to be used with a quantity

Scalar is an atomic value kind

Boolean value true or false

Whether to set the clean session flag on the connect request to the broker

Set the retention flag on a published message

Geographic coordinate in latitude/longitude in decimal degrees

Geographic coordinate as C(latitude,longitude)

Current value of a point

ISO 8601 date as year, month, day

ISO 8601 timestamp followed by timezone identifier

The timestamp when entity was created

Last modified time of record - see docSkySpark

Not available used to indicate invalid or missing data

Integer or floating point numbers annotated with an optional unit

Area of a shape or floor space

Measurement of a chiller ability to remove heat measured

Calibration value to apply to adjust the value read from the connector before updating curVal

Number with a unit of time

Timeout for messages send to the connector's actor thread

Linger timeout used to keep a connector open

Duration used for connector open retries

Duration used to configure the auto-ping feature on a given connector

Applied to haystackConn to tune the duration between watch polls

Rate limits the frequency for hisCollectCov

Enables interval history collection of the curVal

This tag configures how long to buffer collected history items in memory before flushing them to the historian

How long to wait before timing out on a modbus read

How long to wait before timing out on a modbus write

How long to wait between retries for messages that require acknowlegment

Duration between obixConn watch polls

Schedule events with given frequency

Frequency between polls of curVal

Time before a point's curStatus marked from "ok" to "stale" See Connector Tuning

The delay before transitioning to the steady state

Maximum time between writes used to send periodic writes

Minimum time between writes used to throttle the speed of writes

Elevation above sea-level of the location

Enables COV history collection of the curVal

Unitless integer number

Unitless integer indicating the floor's distance from ground level

Number between 1 and 16 used with haystackWrite to determine which priority level of the remote system is written to

Applied to modbusConn to allow for gaps in block reads

Applied to modbusConn to limit the maximum number of registers to read in a block read

Applied to modbusConn to identify the slave address on this modbus network

How many times to retry sending messages that require acknowlegment

Server export of a writable point as an obix:Writable:Point

Number between 1 and 16 used with obixWrite to determine which priority level of the remote system is written to

Stage number of staged equipment operation such as coil or pump

Current priority level for writeVal as number between 1 and 17

Original year of construction as four digit year such as 1980

Inclusive maximum for a numeric value

Inclusive minimum for a numeric value

MQTT Quality of Service (QoS)

• 0 - At most once (fire-and-forget)
• 1 - At least once
• 2 - Exactly once

Reference to an entity

Air flows from the referent to this entity

Blowdown water flows from the referent to this entity

Chilled water flows from the referent to this entity

Condensate flows from the referent to this entity

Condenser water flows from the referent to this entity

Reference to a tuning configuration defined by a connTuning rec

Device which controls a monitors this entity

Domestic water flows from the referent to this entity

Used on a proxy point to reference its parent ecobeeConn

Electricity flows from the referent to this entity

Reference to equip which contains this entity

Fuel oil flows from the referent to this entity

Gasoline flows from the referent to this entity

Used on a proxy point to reference its parent haystackConn

Hot water flows from the referent to this entity

Defines the unique identifier of an entity in system using a ref value type

Makeup water flows from the referent to this entity

Dependent variable, also known as the model output or target, associated, with a machine learning model

Reference to a point associated with a machine learning variable, known as a machine learning variable point

Reference to a machine learning variable

Used on a proxy point to reference its parent modbusConn

Used on a proxy point to reference its parent mqttConn

Natural gas flows from the referent to this entity

Used on a proxy point to reference its parent nestConn

Associates a device which communicates on specific a network

Used on a proxy point to reference its parent obixConn

Subscribe to the topic on this MQTT connector

See Synthetics chapter

Refrigerant flows from the referent to this entity

Used on a proxy point to reference its parent sedonaConn

Reference to site which contains the entity

Reference to space which contains this entity

Used on a proxy point to reference its parent sqlConn

Steam flows from the referent to this entity

Reference to parent meter which is immediately upstream of this meter

See Synthetics chapter

Reference to system

Reference to weather station for to use this entity

Singleton for remove operation

Unicode string of characters

Error message associated when connStatus indicates an error condition

Current connection state of a connector as one of the predefined strings

Current status of a connector as one of the predefined strings See Connectors

Error description when curStatus indicates error condition

Status of point's current value reading

Display name for an entity

Localized string key formatted as pod::key

Display name using macro syntax

Documentation in simplified flavor of markdown

Current status of a Docker container

Additional human-readable status of the container

Ecobee address to use to get the current value

Ecobee address to use to sync point history

Ecobee address to use to write a point value

Single-phase line measurement of an electric quantity in an AC electric power system

Single-phase line current measured in an AC electric power system

Single-phase energy measured line-to-neutral in an AC electric power system

Single-phase power factor measured line-to-neutral in an AC electric power system

Single-phase power measured line-to-neutral in an AC electric power system

Single-phase electric quantity measured line-to-line in an AC electric power system

Single-phase energy measured line-to-line in an AC electric power system

Single-phase power factor measured line-to-line in an AC electric power system

Single-phase power measured line-to-line in an AC electric power system

Single-phase voltage measured line-to-line in an AC electric power system

Single-phase current measured line-to-line in an AC electric power system

Single-phase electric quantity measured line-to-neutral in an AC electric power system

Single-phase voltage measured line-to-neutral in an AC electric power system

Exception stack trace

Physical type of evse-cable

Status of one or more evse-port reported by an EVSE

Axon expression string

Task messaging handling Axon expression

Filename extension such as "csv"

Haystack filter string

Filter used for querying points by tags, providing more flexibility than mlVarPoint, although it is not mandatory

Filter string to define the record data set observed

Flags string

Registers a function as folding a given value type

Free form street address

Geographic city or locality name

Geographic country as ISO 3166-1 two letter code

Geographic subdivision of US state

Geographic postal code

State or province name

Geographic street address and name

Used on a haystack proxy point to store the id of the entity in the remote system used to read and watch curVal

Used on a haystack proxy point object to store the id of the historized point in the remote system used to sync history data

Used on a haystack proxy point to store the id of the entity in the remote system used to write writeVal

Error description when hisStatus indicates error condition

Indicates the way that history data is collected for a point

Status of point's history collection or synchronization

Kind name used to identity a value data type

Mime type formatted as type/subtype

Modbus address to use for current value subscriptions

Used on a modbus proxy point to store the id of the entity in the remote system used to write writeVal

Used on an mqttConn to indicate which certificate and key pair to use for client authentication to the broker

The client identifier to use when connecting to the broker

MQTT protocol version

Name key

Nest address to use to get the current value

The project identifier from your Google Device Access project

Nest address to use to write a point value

Receive published messages that match this filter

Schedule events for given days of the month

Schedule events for given days of the week

Manages password which is hashed/stored to the password store

Your Ecobee API Key

The refresh token you obtained for your API key

The OAuth client_id for your application

The OAuth client_secret for your application

The OAuth refresh_token for your application

Phase measurement in a three-phase electrical system

Point value conversion used to normalize data to/from a remote system

Conversion to apply when reading curVal from connector

Conversion to apply when reading history data from connector

Conversion to apply when writing writeVal to the connector

Primary function of building as US Energy Star key

Fantom type qname for reader class

Sedona address to use for current value subscritions

Sedona address to use for writing

Arbitrary key used by the SQL connector to synchronized history data

This is a tag which must be configured on each sqlConn record used by the connSyncHis() function

Source code

Current status of a task

Fantom type qname

Timezone identifier from standard timezone database

Unit identifier from standard unit database

Username for an authentication account

Version string formatted as decimal integers separated by a dot

Error description when writeStatus indicates error condition

Current status of a writable point output

Fantom type qname for writer class

Symbol to a def

Create a new definition bound to the given symbol

Extends the given definition with additional meta tags

Expected value type of a collection, reference, or choice

Specifies the inverse of an association or relationships

Ref tags used to model entity-to-entity relationships

The entity is logically contained by the referent

Entities logically contained by this entity

The entity inputs a substance from the referent

The entity outputs a substance to the referent

ISO 8601 time as hour, minute, seconds

Universal resource identifier

Base URI for normalizing relative URIs

Applied to modbusConn to define the register map CSV file

Used on a oBIX proxy point to store the URI of the entity in the remote system used to read and watch curVal

URI of the obix:History to synchronized history data

The lobby URI is used to address an obixConn API endpoint

URI of the obix:WritablePoint to write writeVal

Hyperlink to the subject's page on Wikipedia

Current desired value to write to output

Extended string - type name and string value encoding

Time span as modeled encoded as XStr

Training period description, known as the identification period or baseline, utilized during the model training process

Schedule events only during the configured span of time