val – Project Haystack

def

val

Data value type

meta

def val
doc See above
docTaxonomy
lib lib:ph

subtypes

dict

Map of name/value tag pairs

    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

    prefUnit

Defines a preferred unit to be used with a quantity

scalar

Scalar is an atomic value kind

    bool

Boolean value true or false

    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

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

        maxVal

Inclusive maximum for a numeric value

        minVal

Inclusive minimum for a numeric value

    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

        deviceRef

Device which controls a monitors this entity

        domesticWaterRef

Domestic water flows from the referent to this entity

        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

        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

        makeupWaterRef

Makeup water flows from the referent to this entity

        naturalGasRef

Natural gas flows from the referent to this entity

        networkRef

Associates a device which communicates on specific a network

        refrigRef

Refrigerant flows from the referent to this entity

        siteRef

Reference to site which contains the entity

        spaceRef

Reference to space which contains this entity

        steamRef

Steam flows from the referent to this entity

        submeterOf

Reference to parent meter which is immediately upstream of this meter

        weatherStationRef

Reference to weather station for to use this entity

    remove

Singleton for remove operation

    str

Unicode string of characters

        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 key names

        fileExt

Filename extension such as "csv"

        filterStr

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

        phase

Phase measurement in a three-phase electrical system

        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

            airVolumeAdjustability

Ability of air handling equip to adjust volume of air flow

            atesDesign

Design type of the ATES underground system

            chillerMechanism

Primary mechanism of chiller

            condenserLoop

Open or closed loop for condenser working fluid

            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

                produces

Equipment produces a substance or phenomenon

                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

            plantLoop

Plant piping loop

            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

        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

        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