def

scalar

Scalar is an atomic value kind

meta

def scalar
doc See above
is val
lib ph

supertypes

val

Data value type

subtypes

bool

Boolean value true or false

coord

Geographic coordinate in latitude/longitude formatted as C(lat,lng)

    geoCoord

Geographic coordinate as C(latitude,longitude)

curVal

Current value of a point

date

ISO 8601 date as year, month, day

dateTime

ISO 8601 timestamp followed by timezone identifier

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

    duration

Number with a unit of time

    geoElevation

Elevation above sea-level of the location

    int

Unitless integer number

        floorNum

Unitless integer indicating the floor's distance from ground level

        stage

Stage number of an AHU cooling or heating coil

        writeLevel

Current priority level for writeVal as number between 1 and 17

    maxVal

Inclusive minimum for a numeric value

    minVal

Inclusive maximum for a numeric value

    yearBuilt

Original year of construction as four digit year such as 1980

ref

Reference to an entity

    ahuRef

AHU which supplies air to an equipment or space

    chilledWaterPlantRef

Plant which supplies chilled water to the entity

    equipRef

Reference to equip which contains this entity

    hotWaterPlantRef

Plant which supplies hot water to the entity

    id

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

    siteRef

Reference to site which contains the entity

    spaceRef

Reference to space which contains this entity

    steamPlantRef

Plant which supplies steam to the entity

    submeterOf

Reference to parent meter which is immediately upstream of this meter

    weatherRef

Reference to weather station for to use this entity

str

Unicode string of characters

    children

Prototypes contained by this entity

    curErr

Error description when curStatus indicates error condition

    curStatus

Status of point's current value reading

    dis

Display name for an entity

    doc

Documentation in simplified flavor of markdown

    enum

Defines an eumeration of string keys

    fileExt

Filename extension such as "csv"

    filter

Haystack filter string

    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

    hisErr

Error description when hisStatus indicates error condition

    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 before Haystack 4.0 to identity data types

    mime

Mime type formatted as type/subtype

    primaryFunction

Primary function of building as US Energy Star key

    tz

Timezone identifier from standard timezone database

    unit

Unit identifier from standard unit database

    version

Version string formatted as decimal integers separated by a dot

    writeErr

Error description when writeStatus indicates error condition

    writeStatus

Current status of a writable point output

symbol

Symbol to a def

    choice

Choice specifies an exclusive marker selection

        ahuZoneDelivery

AHU delivery method of conditioned air to the zone

        chillerMechanism

Primary mechanism of chiller

        coolingProcess

Processed used to cool a substance

        ductConfig

Ductwork configuration

        ductDeck

Cold, hot, or neutral deck

        ductSection

Equipment section of ductwork

        equipFunction

Models one of the primary functions of an equipment type

            conveys

Equipment conveys a substance or phenomenon

            cools

Equipment removes heat from a substance

            dehumidifies

Equipment removes moisture from air to decrease humidity

            heats

Equipment heats a substance

                reheats

Equipment heats a substance previously cooled or heated

            humidifies

Equipment adds moisture to air to increase humidity

            moves

Equipment moves a substance

            regulates

Equipment regulates the flow of substance or phenomenon

            stores

Equipment stores a substance or phenomenon

            ventilates

Equipment brings fresh outside air into a space

        heatingProcess

Processed used to heat a substance

        meterScope

Classifies a meter as a main site meter or submeter

        pipeSection

Equipment section of piping

        pointFunction

Classifies the point as a sensor, command, or setpoint

        pointQuantity

Quantity the point senses or controls

        pointSubject

What the point senses or controls

        vavAirCircuit

How does the VAV pull in air

        vavModulation

How does VAV modulate the temp based on duct pressure

    def

Create a new definition bound to the given symbol

    defx

Extends the given definition with additional meta tags

    inverseOf

Specifies the inverse of a relationship

    of

Expected value type of a collection, reference, or choice

    reciprocalOf

Specifies the inverse of an association

    relationship

Supertype for tags which model relationships

        receives

The entity receives from the referent

        supplies

The entity supplies to the referent

time

ISO 8601 time as hour, minute, seconds

uri

Unverisal resource identifier

    baseUri

Base URI for normalizing relative URIs

    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