val – Project Haystack

def

val

Data value type

def	val
doc	See above
docTaxonomy	✓
lib	lib:ph

subtypes

dict	Map of name/value tag pairs
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
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
mlInputVarRefs	List of independent variables, also known as model inputs or features, associated with a machine learning model
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
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
naturalGasRef	Natural gas flows from the referent to this entity
networkRef	Associates a device which communicates on specific a network
pointRef	See Synthetics chapter
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
syntheticModelRef	See Synthetics chapter
systemRef	Reference to system
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
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
evseCableType	Physical type of `evse-cable`
evseStatus	Status of one or more `evse-port` reported by an EVSE
fileExt	Filename extension such as "csv"
filterStr	Haystack filter string
mlVarFilter	Filter used for querying points by tags, providing more flexibility than mlVarPoint, although it is not mandatory
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 to identity a value data type
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
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
mlIdentificationPeriod	Training period description, known as the identification period or baseline, utilized during the model training process

Project Haystack

def

val

meta

subtypes