Cooling process using energy from heat source such as hot water
Relating to alternating current (AC) electricity
AC Electricity meter. See `docHaystack::Meters` chapter.
{avg, ac, elec, current, angle, sensor, point}
{avg, ac, elec, current, imbalance, sensor, point}
{avg, ac, elec, current, magnitude, sensor, point}
{avg, ac, elec, current, thd, sensor, point}
{avg, ac, elec, volt, angle, sensor, point}
{avg, ac, elec, volt, imbalance, sensor, point}
{avg, ac, elec, volt, magnitude, sensor, point}
{avg, ac, elec, volt, thd, sensor, point}
{phase:A, ac, elec, current, angle, sensor, point}
{phase:A, ac, elec, current, imbalance, sensor, point}
{phase:A, ac, elec, current, magnitude, sensor, point}
{phase:A, ac, elec, current, thd, sensor, point}
{phase:A, ac, elec, volt, angle, sensor, point}
{phase:A, ac, elec, volt, imbalance, sensor, point}
{phase:A, ac, elec, volt, magnitude, sensor, point}
{phase:A, ac, elec, volt, thd, sensor, point}
{phase:A, active, ac, elec, power, sensor, point}
{phase:A, apparent, ac, elec, power, sensor, point}
{phase:A, net, ac, elec, active, energy, sensor, point}
{phase:A, reactive, ac, elec, power, sensor, point}
{total, ac, elec, demand, sensor, point}
{total, active, ac, elec, power, sensor, point}
{total, apparent, ac, elec, power, sensor, point}
{total, export, ac, elec, active, energy, sensor, point}
{total, import, ac, elec, active, energy, sensor, point}
{total, net, ac, elec, active, energy, sensor, point}
{total, reactive, ac, elec, power, sensor, point}
An AC EVSE port delivers `ac` electricity to a single EV charging inlet at a time. See `docHaystack::EVSE#port` chapter. Typically a max current or max power setpoint should reference an AC EVSE port, but not both. Usually it is preferred to control an AC EVSE port using a max current setpoint. It is recommended to include electrical location related tags on electrical points that reference an AC EVSE port. See `docHaystack::Meters#elecMeters` chapter for more details.
{dc, elec, stateOfCharge, sensor, point}
{import, ac, elec, active, energy, hisTotalized, sensor, point}
{import, ac, elec, active, power, max, sp, point}
{import, ac, elec, active, power, sensor, point}
{import, ac, elec, magnitude, current, max, sp, point}
{import, ac, elec, magnitude, current, sensor, point}
{import, ac, elec, magnitude, volt, sensor, point}
{import, ac, elec, pfScope, pf, sensor, point}
Frequency of an alternating current waveform
Accumulate the tag's value during [inheritance]`docHaystack::Normalization#inherit` and [defx]`docHaystack::Normalization#defx`. Tags marked as accumulate are aggregated together during normalization and deduplicated. This marker must only be used on tags which expect a list value.
Active energy in an AC eletrical power system. Integral of `active-power` over time.
Active power or real power; represents energy transfer that contributes useful work.
Equipment to move or control a mechanism. Actuators may be manually operated or automated via a control system to convert an energy source into mechanical energy. Typically the energy source is electricity, hydraulics, or pneumatics.
Air Handling Unit: An enclosure with a fan that delivers air to a space via ductwork and performs one or more of the functions of cleaning, heating, cooling, humidifying, dehumidifying, ventilating or circulating the air. See `docHaystack::AHUs` chapter.
AHU delivery method of conditioned air to the zone
The mixture of gases which surrounds the earth
System for air treatment to control its temperature, humidity, cleanliness, and distribution to meet the requirements of a conditioned space.
System consisting of one or more fans that remove air from the building. Exhaust systems allow outdoor air to enter by ventilation inlets or normal leakage paths sthrough the building envelope.
Entity inputs air which flows from another entity
System for moving air to maintain indoor thermal comfort and/or air quality.
Rate of air movement as distance over time
System that supplies or removes air by natural or mechanical means to or from any space in order to provide outdoor air to the space. Such air may or may not have been conditioned.
Cooling by dissipating heat into the surrounding air
HVAC equipment that conditions and delivers air via one or more fans. Conditioning of air includes heating, cooling, humidification, dehumidification, and ventilation. See `docHaystack::AHUs` chapter.
Concentration of contaminants in the air
Entity with logical grouping of zone air quality points. See `docHaystack::Zones#airQuality` chapter.
{zone, air, ch2o, concentration, sensor, point}
{zone, air, co, concentration, sensor, point}
{zone, air, co2, concentration, sensor, point}
{zone, air, co2, concentration, sp, point}
{zone, air, nh3, concentration, sensor, point}
{zone, air, no2, concentration, sensor, point}
{zone, air, o3, concentration, sensor, point}
{zone, air, pm01, concentration, sensor, point}
{zone, air, pm10, concentration, sensor, point}
{zone, air, pm25, concentration, sensor, point}
{zone, air, tvoc, concentration, sensor, point}
Air flows from the referent to this entity
Equipment in air distribution systems which terminate at the space. Terminal units receive air from `airHandlingEquip` which have the primarily responsibility to condition air. Terminal units are primarily responsible for delivery of air to the space and tempering the temperature.
Ability of air handling equip to adjust volume of air flow
Notification of a condition which requires attention
Measurement of the relative difference in direction between two vectors or phasors
Apparent energy in an AC eletrical power system. Integral of `apparent-power` over time.
Apparent power; the perceived magnitude of electric power transfer in an AC electric system due to the combination of active and reactive power.
Associations model ontological relationships between definitions. See [Associations]`docHaystack::Associations` chapter.
Aquifer Thermal Energy Storage system. See `docHaystack::ATES` chapter.
{cool, water, flow, thermal, meter, equip}
{ground, water, pressure, sensor, point}
{warm, water, flow, thermal, meter, equip}
The ATES uses closed piping to transport a water/glycol mixture through the ground. The system works like a heat exchanger; there is no ground water transported.
Design type of the ATES underground system.
The ATES has one or more pairs of a separate warm and cool well.
The ATES is as a doublet, but with specific warm and cool wells linked together. These linked wells do not exchange water with other wells.
The ATES has only one physical well. This well is deep enough to penetrate two layers of groundwater.
Similar to a doublet, but water always flows in the same direction from the extraction to the infiltration well.
Barometric pressure exerted by the weight of the atmosphere
Average; central or typical value; median
ASHRAE building automation and control protocol
Plant or animal material used as fuel to produce electricity or heat
Water expelled from a system to remove mineral build up
Entity inputs blowdown water which flows from another entity
Entity outputs blowdown water to other entities
Blowdown water flows from the referent to this entity
Short range wireless communication protocol
Equipment to generate hot water or steam for heating
Boolean value 'true' or 'false'. See [Kinds chapter]`docHaystack::Kinds#bool`.
Branch selector used for heat recovery in a VRF system. These are control devices directing the liquid refrigerant or gas refrigerant to zones requiring cooling or heating. See `docHaystack::VRF#branchSelector` chapter.
An assembly of one or more insulated conductors.
Constant air volume terminal unit. CAV systems use a constant air flow rate with a variable air temperature.
Compression via a continuous flow of fluid through an impeller
Concentration of formaldehyde (CH₂O) in the air.
Greenhouse gas emission of methane (CH₄) into the air.
List of prototypes contained by this entity. See [Protos chapter]`docHaystack::Protos` for more details.
List of aspects to flatten into children prototypes. See [Protos chapter]`docHaystack::Protos` for more details.
Substance is cooled using cooling process
Water cooled for use in HVAC and industrial processes
Entity inputs chilled water which flows from another entity
Entity outputs chilled water to other entities
Plant used to generate chilled water for cooling. See `docHaystack::Plants`.
{chilled, water, delta, pressure, point}
{chilled, water, mixing, valve, cmd, point}
{condenser, water, delta, flow, sensor, point}
{condenser, water, delta, pressure, sensor, point}
{condenser, water, delta, temp, sensor, point}
System that circulates water in its liquid state below ambient temperature for cooling a space or process.
Conditions a space using a heat exchanger integrated into the ceiling
AHU supplies air to chilled beam terminal units
Cooling using transfer of heat to chilled water
Chilled water flows from the referent to this entity
Equipment to remove heat from a liquid. Chillers typically use a vapor compression or an absorption refrigeration cycle.
{chilled, water, delta, flow, sensor, point}
{chilled, water, delta, temp, sensor, point}
{chilled, water, valve, isolation, cmd, point}
{condenser, refrig, pressure, sensor, point}
{condenser, refrig, temp, sensor, point}
{condenser, water, entering, pipe, equip}
{condenser, water, leaving, pipe, equip}
{condenser, water, valve, isolation, cmd, point}
{evaporator, refrig, pressure, sensor, point}
{evaporator, refrig, temp, sensor, point}
Piston compressor driven by a crankshaft
Choice specifies an exclusive marker selection. See [Choices]`docHaystack::Choices` chapter.
Pipe used to circulate fluid through an equipment or system
Electrical circuit and its associated components such as breakers. See `docHaystack::ElecPanels#circuits` chapter.
Percentage of sky obscured by clouds. This is also known as cloudiness, or cloud amount.
Point is a command, actuator, AO/BO. See `docHaystack::Points#function` chapter.
Concentration of carbon monoxide (CO) in the air.
Concentration of carbon dioxide (CO₂) in the air.
Greenhouse gas emission of carbon dioxide (CO₂) into the air.
Heat exchanger used to heat or cool air. Coils are sub-components of HVAC equipment such as `airHandlingEquip`.
Device for mechanically increasing the pressure of a gas or refrigerant vapor by reducing its volume.
Computed point. See `docHaystack::Synthetics` chapter.
Indicates a relationship that is computed from its reciprocal. Computed defs cannot be used as tags themselves.
Abundance of substance in the total volume of a mixture.
Liquid phase produced by the condensation of steam or other gas
Entity inputs condensate which flows from another entity
Entity outputs condensate to other entities
Condensate flows from the referent to this entity
Device or related to process of condensation
Water used used to remove heat through condensation
Entity inputs condenser water which flows from another entity
Entity outputs condenser water to other entities
System that circulates water in its liquid state for rejecting heat from a space or process.
Working fluid is kept separate from fluid used for heat transfer into the atmosphere
Removal of heat through the process of water condensation
Open or closed loop for condenser working fluid
Uses working fluid itself for evaporation into the atmosphere
Condenser water flows from the referent to this entity
Related to cleaning, heating, cooling, humidifying, dehumidifying, ventilating or circulating air.
Duct, pipe, or cable to convey a substance or phenomenon
Delivers a constant volume of air flow. Typically this means equipment with a single speed fan.
The entity is logically contained by the referent.
Entities logically contained by this entity
Microprocessor based device used in a control system. Controllers interact with the physical world through direct I/O to sensors and actuators or via network [protocols]`protocol`.
Associated with the control system for an industrial process
Panel housing controllers and networking gear
Associted with low temperature or cooling processes. When used on a point, this tag is associated with the control of cooling. When paired with a substance, this tag indicates the substance is relatively cool in comparison to another substance, without being actively cooled by e.g. a chiller.
Relatively cool water without active chilling
Measurement of a chiller ability to remove heat measured
{chilled, water, cool, valve, cmd, point}
Equipment to transfer waste heat into the atmosphere
Geographic coordinate in latitude/longitude in decimal degrees. See [Kinds chapter]`docHaystack::Kinds#coord`.
Computer Room Air Conditioner: An FCU designed to condition a computer room. See `docHaystack::AHUs` and `docHaystack::DataCenters` chapters.
Point with support to report a "real-time" current value. By real-time we typically mean freshness within the order of a few seconds or at most a few minutes. For systems with direct I/O the current value is typically driven by the I/O scan rate. For overlay systems which acquire data via a protocol such as BACnet or Modbus then the current value is typically refreshed using polling or subscription over a network. Also see `docHaystack::Points#cur` chapter.
Error description when `curStatus` indicates error condition
Status of point's current value reading. The `curVal` is only available when curStatus is "ok" or "stale". However a "stale" value should be used with caution since the local system does not have a fresh value. It is recommended that the `curVal` tag is removed from a point when the curStatus is not "ok" nor "stale".
- ok: all is okay - stale: the point's curVal is not fresh data - fault: a configuration or hardware problem - see `curErr` - down: a communication or network problem - see `curErr` - disabled: manual disable of the point or connector - unknown: we don't know anything (usually boot state) - remoteFault: point in remote system is fault - remoteDown: point in remote system is down - remoteDisabled: point in remote system is disabled - remoteUnknown: point in remote system is unknown
Current value of a point. The current value is only available when the `curStatus` is "ok" or "stale".
AC current phase imbalance. Also referred to as current unbalance.
Root-mean-square (RMS) magnitude of AC electrical current
Total harmonic distortion (THD) of AC current
Digital Addressable Lighting Interface protocol for lighting
Space used to house computer and networking gear. See `docHaystack::DataCenters` chapter.
ISO 8601 date as year, month, day: '2011-06-07'. See [Kinds chapter]`docHaystack::Kinds#date`.
ISO 8601 timestamp followed by timezone identifier. See [Kinds chapter]`docHaystack::Kinds#dateTime`.
- nighttime: false indicates sun is below horizon - daytime: true indicates sun is above horizon
Relating to direct current (DC) electricity
DC Electricity meter. See `docHaystack::Meters` chapter.
A DC EVSE port delivers `dc` electricity to a single EV charging inlet at a time. See `docHaystack::EVSE#port` chapter. Typically a max current or max power setpoint should reference a DC EVSE port, but not both. Usually it is preferred to control a DC EVSE port using a max power setpoint.
{import, dc, elec, current, max, sp, point}
{import, dc, elec, current, sensor, point}
{import, dc, elec, energy, hisTotalized, sensor, point}
{import, dc, elec, power, max, sp, point}
{import, dc, elec, power, sensor, point}
The range in a process where no changes to output are made. May also indicate the difference between a base setpoint and effective setpoint.
Create a new definition bound to the given symbol. See [Defs chapter]`docHaystack::Defs`.
Extends the given definition with additional meta tags. See [Normalization]`docHaystack::Normalization#defx`.
Differential of fluid between entering and leaving sensors.
List of this library's dependencies. The dependent libs define the [lib namespace]`docHaystack::Namespaces#lib`. Also see [Normalization]`docHaystack::Normalization#resolve`.
Data related to intended design and operating conditions. This includes sizing and other data specified by design engineers and engineered drawings. Also see `rated`.
Decreases humidity from air using a substance which absorbs moisture.
Microprocessor based hardware device. This is the general term for all computers, mobile phones, controllers, and I/O modules. See `docHaystack::Devices#networks` chapter.
Device which controls a monitors this entity
Dew point temperature at which water vapor will form dew
Map of name/value tag pairs. See [Kinds chapter]`docHaystack::Kinds#dict`.
Liquid fuel specifically designed for use in diesel engines
Compass direction measured in degrees: North: 0° = 360°, East: 90°, South: 180°, West: 270°
Display name for an entity. See `docHaystack::Ontology#entities` chapter.
Equipment that releases a specific amount of a substance.
Three way valve which inputs one pipe and diverts between two output pipes.
Dedicated Outside Air System: An AHU that brings in 100% outside air and no recirculated air in order to provide ventilation to spaces. See `docHaystack::AHUs` chapter.
Documentation in simplified flavor of markdown. The first sentence up to the period is used as the summary. Specific formatting options: pre> // inline formatting *italic* // italics font **bold** // bold font 'code' // code or API term `point` // hyperlink to def (code link) [text]`point` // hyperlink with explicit link text ![alt]`image.png` // image // unordered list - one - two - three // ordered list; use numbers or letters 1. one 2. two 3. three <pre The main difference between markdown is that inline code uses single ticks and hyperlinks are annotated using the backtick. Links may be: - absolute http/https URIs - def symbol such as "site" or "hot-water"
Generate a section in the docs for this association.
Generate a taxonomy tree for this term in the documentationindex. When applied to a def, then it will will be listed in the docs under the [taxonomies]`docHaystack::Docs#taxonomies` section.
System that circulates potable cold water in its liquid state for purposes other than space cooling and process requirements.
System that circulates potable hot water in its liquid state for purposes other than space heating and process requirements.
Tap water for drinking, washing, cooking, and flushing of toilets
Entity inputs domestic water which flows from another entity
Entity outputs domestic water to other entities
System that circulates potable water in its liquid state for purposes other than space conditioning and process requirements.
Domestic water flows from the referent to this entity
Two ducts: combination of hotDeck, coldDeck, or neutralDeck
{air, co2, concentration, sensor, point}
Config point on a `vav` for duct area measured in ft² or m²
Cold, hot, or neutral deck. Can be applied to 'ahu' equip if the AHU is part of a 'dualDuct' or 'tripleDuct' system but only serves a single deck type.
Cooling using direct expansion of a refrigerant vapor. Also see `dxHeating` and `heatPump`.
Heating using direct expansion of a refrigerant vapor. Also see `dxCooling` and `heatPump`.
Duct to access fresh outside air only for economizing, not ventilation
Energy reduction mode which augments heating/cooling with outside air.
Current control setpoint in effect taking into account other factors
Efficiency point of a chiller measured in "COP" or "kW/ton".
Associated with electricity or with electrical force, power, or energy. This is often opposed to `mech` mechanical energy.
Active power averaged over a regular interval. For utility meters the demand interval is based on the billing period.
Electrical energy; integral of electric power
Entity inputs electricity which flows from another entity
Entity outputs electricity to other entities
Physical housing for electrical circuits, fuses, and breakers. See `docHaystack::ElecPanels#panels` chapter.
Rate of electrical energy transfer; energy transfer per unit time
System that generates, converts, distributes, and/or stores electricity.
Electrical voltage, potential difference
Heating by the conversion of electrical energy
Single-phase line measurement of an electric quantity in a multi-phase AC electric power system.
- L1: line 1 measurement - L2: line 2 measurement - L3: line 3 measurement
Single-phase electric quantity measured line-to-line in a multi-phase AC electric power system.
- L1-L2: line 1 to line 2 measurement - L2-L3: line 2 to line 3 measurement - L3-L1: line 3 to line 1 measurement
Single-phase electric quantity measured line-to-neutral in a multi-phase AC electric power system.
- L1-N: line 1 to neutral measurement - L2-N: line 2 to neutral measurement - L3-N: line 3 to neutral measurement
Electricity flows from the referent to this entity
Enclosure used to move people between floors.
Amount of a substance discharged into the air
Secondary on/off `point` of an `equip` especially used with a `vfd`. Enable is used with Bool points where true indicates on and false indicates off. Equip with an enable should always also define a `run` point which indicates the primary on/off state of the equipment.
Total heat content of a system. It is defined as internal energy of the system plus the product of pressure and volume.
Top-level dicts with a unique identifier. See `docHaystack::Ontology#entities` chapter.
Defines an eumeration of string key names. The range may also be applied to format a Bool ordered as "false,true". The value of this tag may be formatted in one of five ways: - dict of dicts keyed by name and Dict values for meta such as 'doc' tag - comma separated names on one line - names separated by a "\n" newline character - markdown unordered list formatted as a series of "- name: description\n" - ref to a Xeto 'sys::Enum' spec Enum names *should* follow valid tag naming rules (start with lowercase ASCII letter and contain only ASCII letters and numbers). However in cases where mapping directly to external enumerations enum names can contain arbitrary characters such as space.
Equipment asset. See `docHaystack::Equips` chapter.
Reference to equip which contains this entity
Moving staircase used to move people between floors.
Mechanism used to convert a refrigerant from its liquid to gaseous state.
Electric Vehicle Supply Equipment. See `docHaystack::EVSE` chapter.
The electrical cable between an `evse-port` and an EV charging inlet on a vehicle. The `evseCableType` tag distinguishes the type of cable. See `docHaystack::EVSE#cable` chapter.
Equipment that dispenses electricity to an EV. It consists of a physical EVSE enclosure and its contents to which an `evse-cable` attaches. An `evse-dispenser` can contain zero or more `evse-port`. Children points are used to describe or control one or more `evse-port` within the EVSE manufacturer's package. See `docHaystack::EVSE#dispenser` chapter.
Equipment that supports the delivery of electricity to charging inlets located on EVs. See `docHaystack::EVSE` chapter.
An EVSE port delivers electricity to a single EV charging inlet at a time. Comprised of a software-controlled electrical contactor or circuit breaker. Typically contained within an `evse-dispenser`, but may be contained within an `evse-powerConverter`. More than one `evse-cable` may be connected to a single `evse-port`, however, only one may be energized at any given time. Note: In the future we might add an entity that describes `evse-port` contained in an AC distribution panel. This scenario is not common. See `docHaystack::EVSE#port` chapter.
A power converter that has a `dc` electrical output applied to a `dc-evse-port`. May be contained within an `evse-dispenser` or in a separate dedicated equipment enclosure. Children points are used to describe or control one or more `evse-port` within the EVSE manufacturer's package. See `docHaystack::EVSE#powerConverter` chapter.
A system that supplies electricity to EVSE assembly equipment and its auxiliary loads.
- ccs1: CCS1 charging cable - ccs2: CCS2 charging cable - chademo: CHAdeMO charging cable - saeJ3400: SAE J3400 charging cable - saeJ1772: SAE J1772 charging cable - saeJ3068: SAE J3068 charging cable - iecType2: IEC 62196 Type 2 charging cable - mcs: Megawatt Charging System charging cable - gbt: GB/T charging cable
Describes an event during which an `evse-port` can deliver power to an EV. The EVSE may need to authorize a user to initiate an `evseSession`. At minimum has the following data: - ts: when the event was logged by the system of record - started: when the event started - stopped: when the event stopped - tx: transaction ID for the event - targetRef: reference to the `evse-port` - energyDelivered: energy delivered during the `evseSession` - event: marker tag - meterStart: meter register's value at the beginning of the `evseSession` In the future additional data might be included, such as the means of EV charging session authorization.
Status of one or more `evse-port` reported by an EVSE. When applied to an `evse-port`, indicates the status of an EVSE port. When applied to an `evse-dispenser` or `evse-powerConverter`, indicates the status of one or more `evse-port` within an EVSE manufacturer's package. In this case only the enum values available, unavailable, and fault apply.
- available: When the point references an `evse-port`, indicates the `evse-port` is available for recharging a vehicle. During this condition none of the `evse-cable` that reference the `evse-port` are plugged into a vehicle charging inlet. Also, a parked vehicle may prohibit another vehicle from recharging. When the point references `evse-dispenser` or `evse-powerConverter`, indicates `evse-port` within the EVSE manufacturer's package are available for an `evseSession` and may actively be in one. Also, an `evse-port` may have another `evseStatus` based on its condition. - preparing: After an `evse-port` is no longer available and before an `evseSession` begins. Typically this condition applies during the authorization of an `evseSession`. This value is deprecated in favor of the occupied value. - charging: When there is an active `evseSession` and the contactor for the `evse-port` is closed. This value is deprecated in favor of the occupied value. - suspendedEVSE: When the `evse-port` is occupied and not within an active `evseSession` due to inavailability of power to deliver to the vehicle or an unsuccessful attempt to establish an `evseSession`. This value is deprecated in favor of the occupied value. - suspendedEV: When a vehicle does not accept power being offered by the `evse-port` during an active `evseSession`. This value is deprecated in favor of the occupied value. - finishing: After an `evseSession` when the `evse-port` is still occupied. This value is deprecated in favor of the occupied value. - occupied: When an `evse-cable` that references the `evse-port` is plugged into a vehicle's charging inlet. During this condition the `evse-port` may or may not be within an active `evseSession`. - reserved: When the `evse-port` is dedicated to a specific user. During this condition only the intended user can authorize an `evseSession` with their vehicle. An unauthorized user and their parked vehicle may prohibit an authorized user from recharging. - unavailable: When the EVSE prohibits EV charging on the `evse-port` due to an applied software setting for the `evse-port` or EVSE manufacturer's package. - fault: When the EVSE prohibits EV charging on the `evse-port` due to a fault condition within the `evse-port` or EVSE manufacturer's package.
Taking a substance out of another substance
Point of an ahu indicating air flow is by-passing the heating/cooling coils. If a boolean point, then true indicates the unit is in by-pass mode and false indicates by-pass is disabled. If the point is an analog point then 100% indicates full by-pass mode and 0% indicates by-pass is completely disabled.
Motor used with a fan to create air flow. See `docHaystack::Motors` chapter.
Fan Coil Unit: A unitary, factory-made enclosure with a fan and coil that recirculates air in a space and performs one or more of the functions of cleaning, heating, cooling, humidifying, dehumidifying, or ventilating the air. Unit heaters are examples of FCUs. See `docHaystack::AHUs` chapter.
Feature namespace of definitions formatted as 'feature:name'
Apparent temperature perceived when considering humidity, wind chill, and heat index
Comma Separated Values - see `docHaystack::Csv`
Haystack JavaScript Object Notation format - see `docHaystack::Json`
JavaScript Object Notation for Linked Data - see `docHaystack::Rdf`
Haystack Tag Record Input Output - see `docHaystack::Trio`
Haystack typed CSV format - see `docHaystack::Zinc`
Haystack filter string. See `docHaystack::Filters`
Storey of a building. See `docHaystack::Spaces#floors` chapter.
Unitless integer indicating the floor's distance from ground level. The ground floor is always defined as zero. Additional floors above ground are numbered 1, 2, 3, etc. Subterranean floors are numbered -1, -2, -3, etc. This convention is consistent with how most European buildings number floors. In North America its common to label the ground floor as the first floor; however Haystack requires the ground level to be assigned a floorNum of 0.
Meter to measure flow rate and total volume of fluid. See `docHaystack::Meters` chapter.
System to change direction of substance flow
A boolean point of an ahu indicating a freezing condition. This might require a control sequence to protect the equipment. If true then a freeze condition is detected, or false if not.
Entity inputs fuel oil which flows from another entity
Entity outputs fuel oil to other entities
Fuel oil flows from the referent to this entity
Ventilation equipment to limit exposure to hazardous fumes.
Substance with neither definite volume nor shape
Petroleum derived liquid used as a fuel source
Entity inputs gasoline which flows from another entity
Entity outputs gasoline to other entities
Gasoline flows from the referent to this entity
Free form street address. Best practice is to follow local norms for a postal address. Typically this string includes the `geoStreet`, `geoCity`, `geoState` (in US), and `geoPostalCode`: Examples: "1600 Pennsylvania Avenue NW, Washington, DC 20500" "10 Downing St, Westminster, London SW1A 2AA, United Kingdom" "Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France"
Geographic coordinate as 'C(latitude,longitude)'
Geographic country as [ISO 3166-1]`http://en.wikipedia.org/wiki/ISO_3166-1` two letter code
- AF: Afghanistan - AX: Aland Islands - AL: Albania - DZ: Algeria - AS: American Samoa - AD: Andorra - AO: Angola - AI: Anguilla - AQ: Antarctica - AG: Antigua and Barbuda - AR: Argentina - AM: Armenia - AW: Aruba - AU: Australia - AT: Austria - AZ: Azerbaijan - BS: Bahamas - BH: Bahrain - BD: Bangladesh - BB: Barbados - BY: Belarus - BE: Belgium - BZ: Belize - BJ: Benin - BM: Bermuda - BT: Bhutan - BO: Bolivia, Plurinational State of - BO: Bolivia - BA: Bosnia and Herzegovina - BA: Bosnia - BA: Herzegovina - BW: Botswana - BV: Bouvet Island - BR: Brazil - IO: British Indian Ocean Territory - BN: Brunei Darussalam - BG: Bulgaria - BF: Burkina Faso - BI: Burundi - KH: Cambodia - CM: Cameroon - CA: Canada - CV: Cape Verde - KY: Cayman Islands - CF: Central African Republic - TD: Chad - CL: Chile - CN: China - CX: Christmas Island - CC: Cocos (keeling) Islands - CC: Cocos - CO: Colombia - KM: Comoros - CG: Congo - CD: Congo, the Democratic Republic of the - CK: Cook Islands - CR: Costa Rica - CI: Cote D'ivoire - HR: Croatia - CU: Cuba - CY: Cyprus - CZ: Czech Republic - DK: Denmark - DJ: Djibouti - DM: Dominica - DO: Dominican Republic - EC: Ecuador - EG: Egypt - SV: El Salvador - GQ: Equatorial Guinea - ER: Eritrea - EE: Estonia - ET: Ethiopia - FK: Falkland Islands (malvinas) - FK: Falkland Islands - FO: Faroe Islands - FJ: Fiji - FI: Finland - FR: France - GF: French Guiana - PF: French Polynesia - TF: French Southern Territories - GA: Gabon - GM: Gambia - GE: Georgia - DE: Germany - GH: Ghana - GI: Gibraltar - GR: Greece - GL: Greenland - GD: Grenada - GP: Guadeloupe - GU: Guam - GT: Guatemala - GG: Guernsey - GN: Guinea - GW: Guinea-bissau - GY: Guyana - HT: Haiti - HM: Heard Island and Mcdonald Islands - VA: Holy See (vatican City State) - VA: Vatican - HN: Honduras - HK: Hong Kong - HU: Hungary - IS: Iceland - IN: India - ID: Indonesia - IR: Iran, Islamic Republic of - IR: Iran - IQ: Iraq - IE: Ireland - IM: Isle of Man - IL: Israel - IT: Italy - JM: Jamaica - JP: Japan - JE: Jersey - JO: Jordan - KZ: Kazakhstan - KE: Kenya - KI: Kiribati - KP: Korea, Democratic People's Republic of - KR: Korea, Republic of - KR: Korea - KW: Kuwait - KG: Kyrgyzstan - LA: Lao People's Democratic Republic - LA: Lao - LV: Latvia - LB: Lebanon - LS: Lesotho - LR: Liberia - LY: Libyan Arab Jamahiriya - LI: Liechtenstein - LT: Lithuania - LU: Luxembourg - MO: Macao - MK: Macedonia, the Former Yugoslav Republic of - MK: Macedonia - MG: Madagascar - MW: Malawi - MY: Malaysia - MV: Maldives - ML: Mali - MT: Malta - MH: Marshall Islands - MQ: Martinique - MR: Mauritania - MU: Mauritius - YT: Mayotte - MX: Mexico - FM: Micronesia, Federated States of - FM: Micronesia - MD: Moldova, Republic of - MD: Moldova - MC: Monaco - MN: Mongolia - ME: Montenegro - MS: Montserrat - MA: Morocco - MZ: Mozambique - MM: Myanmar - NA: Namibia - NR: Nauru - NP: Nepal - NL: Netherlands - AN: Netherlands Antilles - NC: New Caledonia - NZ: New Zealand - NI: Nicaragua - NE: Niger - NG: Nigeria - NU: Niue - NF: Norfolk Island - MP: Northern Mariana Islands - NO: Norway - OM: Oman - PK: Pakistan - PW: Palau - PS: Palestinian Territory, Occupied - PS: Palestine - PA: Panama - PG: Papua New Guinea - PY: Paraguay - PE: Peru - PH: Philippines - PN: Pitcairn - PL: Poland - PT: Portugal - PR: Puerto Rico - QA: Qatar - RE: Reunion - RO: Romania - RU: Russian Federation - RW: Rwanda - BL: Saint Barthelemy - SH: Saint Helena, Ascension and Tristan Da Cunha - SH: Saint Helena - KN: Saint Kitts and Nevis - LC: Saint Lucia - MF: Saint Martin - PM: Saint Pierre and Miquelon - VC: Saint Vincent and the Grenadines - WS: Samoa - SM: San Marino - ST: Sao Tome and Principe - SA: Saudi Arabia - SN: Senegal - RS: Serbia - SC: Seychelles - SL: Sierra Leone - SG: Singapore - SK: Slovakia - SI: Slovenia - SB: Solomon Islands - SO: Somalia - ZA: South Africa - GS: South Georgia and the South Sandwich Islands - ES: Spain - LK: Sri Lanka - SD: Sudan - SR: Suriname - SJ: Svalbard and Jan Mayen - SZ: Swaziland - SE: Sweden - CH: Switzerland - SY: Syrian Arab Republic - TW: Taiwan, Province of China - TW: Taiwan - TJ: Tajikistan - TZ: Tanzania, United Republic of - TZ: Tanzania - TH: Thailand - TL: Timor-leste - TG: Togo - TK: Tokelau - TO: Tonga - TT: Trinidad and Tobago - TN: Tunisia - TR: Turkey - TM: Turkmenistan - TC: Turks and Caicos Islands - TV: Tuvalu - UG: Uganda - UA: Ukraine - AE: United Arab Emirates - GB: United Kingdom - GB: England - GB: Britain - GB: Great Britain - US: United States - US: United States of America - US: USA - UM: United States Minor Outlying Islands - UY: Uruguay - UZ: Uzbekistan - VU: Vanuatu - EE: Vatican City State See Holy - VE: Venezuela, Bolivarian Republic of - VE: Venezuela - VN: Viet Nam - VG: Virgin Islands, British - VI: Virgin Islands, U.S. - WF: Wallis and Futuna - EH: Western Sahara - YE: Yemen - ZM: Zambia - ZW: Zimbabwe
Elevation above sea-level of the location
Geographic postal code; for US this is a five digit zip code
State or province name; for US this is two letter state code. May be used in other countries to model administrative area between the geoCity and geoCountry level.
- AL: Alabama - AK: Alaska - AS: American Samoa - AZ: Arizona - AR: Arkansas - CA: California - CO: Colorado - CT: Connecticut - DE: Delaware - DC: District of Columbia - FM: Federated States of Micronesia - FL: Florida - GA: Georgia - GU: Guam - HI: Hawaii - ID: Idaho - IL: Illinois - IN: Indiana - IA: Iowa - KS: Kansas - KY: Kentucky - LA: Louisiana - ME: Maine - MH: Marshall Islands - MD: Maryland - MA: Massachusetts - MI: Michigan - MN: Minnesota - MS: Mississippi - MO: Missouri - MT: Montana - NE: Nebraska - NV: Nevada - NH: New Hampshire - NJ: New Jersey - NM: New Mexico - NY: New York - NC: North Carolina - ND: North Dakota - MP: Northern Mariana Islands - OH: Ohio - OK: Oklahoma - OR: Oregon - PW: Palau - PA: Pennsylvania - PR: Puerto Rico - RI: Rhode Island - SC: South Carolina - SD: South Dakota - TN: Tennessee - TX: Texas - UT: Utah - VA: Virginia - VI: Virgin Islands - VT: Vermont - WA: Washington - WV: West Virginia - WI: Wisconsin - WY: Wyoming
Two dimension table of columns and rows. See [Kinds chapter]`docHaystack::Kinds#grid`.
Related to the surface of the earth. Used to indicate electrical current being measured on an electrical ground conductor when applied to a point entity that has the `elec` and `current` tags.
Floor at ground level. In North America this is typically called the first floor, but in Europe its often labeled as floor zero. If `floorNum` is defined, then it must be set to zero.
Water present under the ground or from a well
Haystack HTTP protocol for exchanging tagged data
Pipe used as central connection or manifold for other piping runs.
Associated with a heating process. When used on a point, this tag is associated with the control of heating.
Equipment to transfer heat between two working fluids.
Equipment that employs a vapor compression cycle with a reversing valve to provide heating or cooling. For vapor compression heating without a reversing valve, such as for a heat pump water heater, see `dxHeating` which should be used.
Transfer of heat from one substance to another to reduce energy consumption.
Boolean point indicating command state of AHU's heat wheel.
Greenhouse gas emission of hydrofluorocarbons into the air.
Historized point with a history log of timestamp/value pairs. Points marked as historized indicate the system can response to queries via the 'hisRead' operation to return a trend log of timestamp/value pairs. There are typically two mechanisms for historization: - the local system performs the historization by logging the point's `curVal` to local storage - in overlay systems a downstream device performs the historization and the local system synchronizes the history data in batch on a periodic basis Also see `docHaystack::Points#his` chapter.
Error description when `hisStatus` indicates error condition
Indicates the way that history data is collected for a point.
- sampled: Data is sampled on a regular interval. The timestamp indicates exactly when the sample was taken, and we assume linear interpolation between samples. - cov: Data is logged when it changes. The means the timestamp indicates exactly when it changed (inclusive) and it remains that value until the next sample's timestamp (exclusive). - consumption: Integral data is sampled on a regular interval and logged at the *end* of the interval. The timestamp indicates the *end* of the interval. Therefore, the raw data is logged as start *exclusive*, end *inclusive*. This is mode is typical for consumption meters.
Status of point's history collection or synchronization
- ok: last sync attempt was successful - fault: a configuration problem - see `hisErr` - down: a communication or network problem - see `hisErr` - disabled: manual disable of the point or parent connector - unknown: we don't know anything (usually boot state) - pending: sync has been scheduled and is waiting to running - syncing: sync is currently running
Indicates values which are a continuous stream of totalization. History data reads and should be normalized by computing the delta.
Hot water used for HVAC heating or supplied to hot taps
Entity inputs hot water which flows from another entity
Entity outputs hot water to other entities
Plant used to generate hot water for heating. See `docHaystack::Plants`.
{hot, water, delta, flow, sensor, point}
{hot, water, delta, pressure, sensor, point}
{hot, water, delta, temp, sensor, point}
System that circulates water in its liquid state for heating a space or process.
Hot water flows from the referent to this entity
Hypertext Transfer Protocol which is foundation of the web
Equipment which adds moisture to air to increase humidity
Percent relative humidity; measure of moisture in the air
Heating, ventilation, and air conditioning
Zone related to conditioning of a space's air temperature and quality. See `docHaystack::Spaces#zones` and `docHaystack::Zones#hvac` chapters.
{zone, air, temp, effective, cooling, sp, point}
{zone, air, temp, effective, heating, sp, point}
{zone, air, temp, occ, cooling, sp, point}
{zone, air, temp, occ, heating, sp, point}
{zone, air, temp, standby, cooling, sp, point}
{zone, air, temp, standby, heating, sp, point}
{zone, air, temp, unocc, cooling, sp, point}
{zone, air, temp, unocc, heating, sp, point}
- cooling: - heating: - reheat: - warmup: morning warmup where AHU is supplying warm air - purge: night purge when AHU is supplying 100% fresh air - pressurize: - depressurize: - manual:
Entity with logical grouping of zone HVAC air points. See `docHaystack::Zones#hvac` chapter.
Defines the unique identifier of an entity in system using a `ref` value type. The scope of an entity is undefined, but must be unique with a given system or project. This identifier may be used by other entities for cross-referencing. See `docHaystack::Ontology#entities` chapter.
Luminous flux hitting the inside of the sphere at a specific point. Also see [ies.org]`https://www.ies.org/definitions/illuminance/`
Internet Message Access Protocol for retrieving email
Permeation of a substance into another substance
Entity inputs a substance which flows from another entity
The entity inputs a substance from the referent. The value of this tag is what is received.
Defines one or more supertypes of a subtyping relationship. See [Subtyping]`docHaystack::Subtyping` chapter.
Actuator used to isolate an equipment from a pipe or ductwork system
Kind name used to identity a value data type
- Marker: is-a label - Bool: true or false - NA: not available - Number: floating point with optional unit - Str: Unicode string - Uri: Universal resource identifier - Ref: reference to an entity - Date: an ISO 8601 date as year, month, day: 2011-06-07 - Time: an ISO 8601 time as hour, minute, seconds: 09:51:27.354 - DateTime: an ISO 8601 timestamp followed by timezone name - Coord: geographic coordinate in latitude/longitude formatted as C(lat,lng) - XStr: extended string with type name - List: ordered sequence - Dict: key/value map - Grid: two dimensional tabular data collection
KNX protocol commonly used for lighting systems
Range from 0% to 100%. When paired with a fluid this implies a fill level where 0% is empty and 100% is full.
Library module of symbolic definitions. See `docHaystack::Namespaces#libs` chapter.
Project Haystack definitions for Information and Communications Technology. This includes microprocessor based hardware, software, and networking technologies.
Project Haystack definitions for Internet of Things
Electromagnetic radiation in the visible spectrum
Sensed or controlled dimming level of electrical lighting. Level is measured as a percentage where 0% is off and 100% is full brightness.
Systems associated with illumination in the built environment
Zone related to lighting system. See `docHaystack::Spaces#zones` and `docHaystack::Zones#lighting` chapters.
Entity with logical grouping of lighting points. See `docHaystack::Zones#lighting` chapter.
Line average of single-phase electrical quantity measurements in an AC electric power system. When applied to a point entity that has the `elec` and `volt` tags, indicates the average of all available `lineVolt` measurements. When applied to a point entity that has the `elec` and `current` tags, indicates the average of all available `lineCurrent` measurements. When applied to a point entity that has the `elec` and `power` tags, indicates the average of all available `linePower` measurements. When applied to a point entity that has the `elec` and `pf` tags, indicates the average of all available `linePf` measurements. When applied to a point entity that has the `elec` and `energy` tags, indicates the average of all available `lineEnergy` measurements.
Single-phase line current measured 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. May also be referred to as a line power measurement.
Single-phase voltage measured line-to-line in an AC electric power system. May also be referred to as a line voltage measurement.
Substance with definite volume but takes the shape of its container
Ordered list of zero or more values. See [Kinds chapter]`docHaystack::Kinds#list`.
Chiller point to command or measure the chiller's load as a percentage from "0%" to "100%". When paired with cmd this models the chiller's load limit. When paired with sensor this models the chiller's current load factor.
Light fixture using electricity to provide illumination
Energy of light in a given direction. Also see [ies.org]`https://www.ies.org/definitions/luminance/`
Relating to light as perceived by the eye
Total perceived light in all directions. Also see [ies.org]`https://www.ies.org/definitions/luminous-flux/`
Perceived light in a particular direction per unit solid angle. Also see [ies.org]`https://www.ies.org/definitions/luminous-intensity/`
Water used used to makeup water loss through leaks, evaporation, or blowdown
Entity inputs makeup water which flows from another entity
Entity outputs makeup water to other entities
Makeup water flows from the referent to this entity
Requires that the marker be applied to dicts which use the marker's subtypes. This tag is typically applied to top-level entity tags such as 'equip'. For example if an instance is tagged with a subtype of 'equip' such as 'tank', then the instance must also include the 'equip' tag as a mandatory marker.
Marker labels a dict with typing information. See [Kinds chapter]`docHaystack::Kinds#marker`.
Makeup Air Unit: A DOAS that provides make-up air for a separate, dedicated exhaust system. That is, this equip does not contain an exhaust air section. See `docHaystack::AHUs` chapter.
Associated with a machine or its mechanical force, torque, power, or energy. This is often opposed to `elec` electrical energy.
Equipment to meter a substance or phenomenon. See `docHaystack::Meters` chapter.
Classifies a meter as a main site meter or submeter
Duct where fresh outside air and return air is mixed together
Three way valve which inputs two pipes and outputs a mixture between the two to a single output pipe.
Machine learning point. See `docHaystack::Synthetics` chapter.
Training period description, known as the identification period or baseline, utilized during the model training process.
List of independent variables, also known as model inputs or features, associated with a machine learning model.
Goodness-of-fit metrics provided in the form of a simple dictionary. For example: {r2:0.7889, cvrmse:58}.
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. The structure of the dict is user-specific.
Dependent variable, also known as the model output or target, associated, with a machine learning model. Represents the predicted outcome generated by the model.
Machine learning variable representing both model inputs and outputs.
Filter used for querying points by tags, providing more flexibility than mlVarPoint, although it is not mandatory.
Reference to a point associated with a machine learning variable, known as a machine learning variable point.
Reference to a machine learning variable.
Relating to mobile phones, hand-held computers, and similar technology
Cellular phone providing telecommunication over radio links.
Register based communication protocol used with industrial devices.
Equipment that converts electrical energy into mechanical energy. See `docHaystack::Motors` chapter.
Conveyor to move people across a horizontal or inclined plane.
Message Queuing Telemetry Transport publish/subscribe protocol
AHU discharge air is split into a duct per zone
Greenhouse gas emission of nitrous oxide (N₂O) into the air.
Not available used to indicate invalid or missing data. See [Kinds chapter]`docHaystack::Kinds#na`.
Fossil fuel energy source consisting largely of methane and other hydrocarbons. The energy content of natural gas varies by region within a range determined on impurities in the gas. You can find a table of these conversions [here]`https://en.wikipedia.org/wiki/Heat_of_combustion#Higher_heating_values_of_natural_gases_from_various_sources`
Entity inputs natural gas which flows from another entity
Entity outputs natural gas to other entities
Heating by the combustion of natural gas
Natural gas flows from the referent to this entity
Logical communications network between two or more devices. See `docHaystack::Devices#networks` chapter.
Associates a device which communicates on specific a network.
Microprocessor device used to establish networks.
Networking device used to route data between different networks.
Networking device used to connect devices on the same network.
when applied to a point entity that has the `elec` and `current` tags, indicates electrical current being measured on an electrical neutral conductor.
Duct carries air which by-passes both heating and cooling coils
Greenhouse gas emission of nitrogen trifluoride (NF₃) into the air.
Concentration of ammonia (NH₃) in the air
Concentration of nitrogen dioxide (NO₂) in the air
Marks a function or operation as having no side effects. The function may or may not be *pure* in that calling it multiple times with the same arguments always evaluates to the same result.
Undocumented and not officially supported
Do not include source code in documentation
Marker applied to a def to indicate that is not inherited into subtype definitions.
Integer or floating point numbers annotated with an optional unit. See [Kinds chapter]`docHaystack::Kinds#number`.
Oxygen (O₂) - the common dioxygen allotrope in the air
XML based Open Building Information eXchange protocol.
Occupied mode of a space. See `docHaystack::Zones#occupancy` chapter.
Number of occupants in a space. See `docHaystack::Zones#occupancy` chapter.
People who use the built environment. See `docHaystack::Zones#occupancy` chapter.
Setpoint or sensor indicating occupancy of a space. See `docHaystack::Zones#occupancy` chapter.
Expected value type of a collection, reference, or choice
Operation for HTTP API. See `docHaystack::Ops` chapter.
Query basic information about the server. See `docHaystack::Ops#about` chapter.
Close the current session and cancel the auth bearer token. See `docHaystack::Ops#close` chapter.
Query the definitions in the current namespace. See `docHaystack::Ops#defs` chapter.
Query the filetype defs in the current namespace. See `docHaystack::Ops#filetypes` chapter.
Read historized time series data from a `his-point`. See `docHaystack::Ops#hisRead` chapter.
Write historized time series data from a `his-point`. See `docHaystack::Ops#hisWrite` chapter.
Invoke a user action on a target entity. See `docHaystack::Ops#invokeAction` chapter.
Query the lib defs in the current namespace. See `docHaystack::Ops#libs` chapter.
Query the navigation tree for discovery. See `docHaystack::Ops#nav` chapter.
Query the op defs in the current namespace. See `docHaystack::Ops#ops` chapter.
Read or command a `writable-point`. See `docHaystack::Ops#pointWrite` chapter.
Query the a set of entity records by id or by filter. See `docHaystack::Ops#read` chapter.
Poll a watch subscription. See `docHaystack::Ops#watchPoll` chapter.
Subscribe to entity data. See `docHaystack::Ops#watchSub` chapter.
Unsubscribe to entity data. See `docHaystack::Ops#watchUnsub` chapter.
Apply to str enum tags where the enumeration range is open ended. User interfaces should support data entry for arbitrary strings, but also provide a dropdown for the predefined enumeration.
Entity outputs a substance with flows to other entities
The entity outputs a substance to the referent. The value of this tag is what is supplied.
Duct to access fresh outside air for both ventilation and economizer.
Enclosure for electrical and control equipment. Panels may be used to isolate electrical connections and provide environmental protection.
Auxiliary heating points associated with a `vav`
Electric power factor; which is the ratio of active power to apparent power in an AC electric power system. Measured with values in the range of -1.0 to 1.0 or 0.0 to 1.0 without a unit. When the range of -1.0 to 1.0 is applied, a negative value for power factor indicates the electrical current leads the electrical voltage and a positive value indicates the electrical current lags the electrical voltage.
Displacement power factor, which accounts for the phase angle between voltage and current but excludes effects of nonlinear waveforms ( harmonic distortion).
Distortion power factor, which measures the component of power factor attributable to harmonic distortion in voltage and current waveforms.
Power factor according to the IEC convention defines a positive or negative sign based on the direction of active power flow. Power factor is positive when active power flows into a load. Power factor is negative when active power flows out of a load.
Power factor according to the IEEE convention defines a positive or negative sign based on whether the load is capacitive or inductive. Power factor is positive when the load is capacitive, or when voltage lags behind current. Power factor is negative when the load is inductive, or when current lags behind voltage.
Standard for interpreting power factor's positive or negative sign
True power factor, which includes effects of harmonic distortion. Power factor is assumed to be true power factor when `pfScope` is not defined. However, it is recommended to specify a scope for power factor to help avoid misinterpretation of data.
Greenhouse gas emission of perfluorocarbons into the air.
Phase measurement in a three-phase electrical system. This tag is deprecated in favor of more precise tags: - `lineVolt` - `phaseVolt` - `lineCurrent` - `phaseCurrent` - `linePower` - `phasePower` - `linePf` - `phasePf` - `lineEnergy` - `phaseEnergy` - `lineAvg` - `phaseAvg` - `neutral` - `ground`
- A: line-to-neutral measurement - B: line-to-neutral measurement - C: line-to-neutral measurement - AB: line-to-line measurement - BC: line-to-line measurement - CA: line-to-line measurement - N: neutral current
Phase average of single-phase electrical quantity measurements in an AC electric power system. When applied to a point entity that has the `elec` and `volt` tags, indicates the average of all available `phaseVolt` measurements. When applied to a point entity that has the `elec` and `current` tags, indicates the average of all available `phaseCurrent` measurements. When applied to a point entity that has the `elec` and `power` tags, indicates the average of all available `phasePower` measurements. When applied to a point entity that has the `elec` and `pf` tags, indicates the average of all available `phasePf` measurements. When applied to a point entity that has the `elec` and `energy` tags, indicates the average of all available `phaseEnergy` measurements.
Number of phases for an AC electrical power system or connected equipment: single-phase, split-phase, two-phase, or three-phase.
Single-phase current measured line-to-line in an AC electric power system. May also be referred to as a phase current measurement.
Single-phase energy measured line-to-neutral in an AC electric power system. Neutral might not be referenced, but implied.
Single-phase power factor measured line-to-neutral in an AC electric power system. Neutral might not be referenced, but implied.
Single-phase power measured line-to-neutral in an AC electric power system. May also be referred to as a phase power measurement. Neutral might not be referenced, but implied.
Single-phase voltage measured line-to-neutral in an AC electric power system. May also be referred to as a phase voltage measurement.
Aspect of scientific interest with measurable quantities
Telephone used for voice telecommunication.
Central plant used to generate a substance for a process. See `docHaystack::Plants`.
Plant piping loop: primary, secondary, or tertiary
Particulate matter 0.1; atmospheric pollutant of fine particles with an aerodynamic diameter of 0.1 micrometers or less
Concentration of particulate matter 0.1 in the air.
Particulate matter 10; atmospheric pollutant of fine particles with an aerodynamic diameter of 10 micrometers or less
Concentration of particulate matter 10 in the air
Particulate matter 2.5; atmospheric pollutant of fine particles with an aerodynamic diameter of 2.5 micrometers or less
Concentration of particulate matter 2.5 in the air.
Data point such as a sensor or actuator. See `docHaystack::Points` chapter.
Classifies the point as a sensor, command, or setpoint. See `docHaystack::Points#function` chapter.
Grouping of children points used by spaces and equipment
See `docHaystack::Synthetics#structure` chapter.
Post Office Protocol version 3 for retrieving email
A gateway or opening used to transfer a substance.
Converts one electrical waveform to another using power electronic circuitry. Involves the use of one or more power modules. May convert: - `ac` to `dc` - `ac` to `ac` - `dc` to `dc` - `dc` to `ac` Note: An AC/AC power converter performs the same task as a power transformer but using power electronics. Similarly, a DC/DC power converter transforms an input DC voltage to an output DC voltage at another level.
Amount of atmospheric water vapor fallen including rain, sleet, snow, and hail
Defines a preferred unit to be used with a quantity
VAV damper modulates to control space temp; dependent on duct pressure being maintained
VAV damper or a control valve that modulates to maintain desired flow setpoint; independent of the duct pressure
Primary function of building as US Energy Star key
Adult Education Ambulatory Surgical Center Aquarium Automobile Dealership Bank Branch Bar/Nightclub Barracks Bowling Alley Casino College/University Convenience Store with Gas Station Convenience Store without Gas Station Convention Center Courthouse Data Center Distribution Center Drinking Water Treatment & Distribution Enclosed Mall Energy/Power Station Fast Food Restaurant Financial Office Fire Station Fitness Center/Health Club/Gym Food Sales Food Service Hospital (General Medical & Surgical) Hotel Ice/Curling Rink Indoor Arena K-12 School Laboratory Library Lifestyle Center Mailing Center/Post Office Manufacturing/Industrial Plant Medical Office Mixed Use Property Movie Theater Multifamily Housing Museum Non-Refrigerated Warehouse Office Other - Education Other - Entertainment/Public Assembly Other - Lodging/Residential Other - Mall Other - Public Services Other - Recreation Other - Restaurant/Bar Other - Services Other - Stadium Other - Technology/Science Other - Utility Other Other/Specialty Hospital Outpatient Rehabilitation/Physical Therapy Parking Performing Arts Personal Services (Health/Beauty, Dry Cleaning, etc) Police Station Pre-school/Daycare Prison/Incarceration Race Track Refrigerated Warehouse Repair Services (Vehicle, Shoe, Locksmith, etc) Residence Hall/Dormitory Restaurant Retail Store Roller Rink Self-Storage Facility Senior Care Community Single Family Home Social/Meeting Hall Stadium (Closed) Stadium (Open) Strip Mall Supermarket/Grocery Store Swimming Pool Transportation Terminal/Station Urgent Care/Clinic/Other Outpatient Veterinary Office Vocational School Wastewater Treatment Plant Wholesale Club/Supercenter Worship Facility Zoo
Pipework which circulates closest to the energy source. In a central plant, the primary loop indicates the pipes and equipment within the central plant. In context of heat exchangers between the primary and secondary loops, this tag indicates the side closest to the plant.
By-product of natural gas processing and petroleum refining (C₃H₈)
Communication protocol used for devices on a network.
Motor used with a pump to move fluid. See `docHaystack::Motors` chapter.
Associated with a cleaning process to remove contaminants. Most commonly it indicates purging water or air by using a filter or by letting out a certain amount of the substance at a high flow rate.
Water expelled from a system to remove contaminants.
Quantity measured against standard metric
Quantities used to measure this phenomenon
Measurable property of a substance or phenomenon
Associates quantity as measurement of a phenomenon
Enclosure or chassis used to mount computer and networking gear. Devices are mounted to rails of a standard width, typically 19 or 23 inches. Height is measured in *rack units* where one 1U is 1.75 inches. A full rack has a height of 42U. See `docHaystack::DataCenters#racks` chapter.
HVAC equipment that conditions a space without forced air.
Heats a space using pipes or cables embedded beneath floor.
Heats a space using exposed pipes or coils. Hot water and steam radiators are often cast iron and installed directly in the space or along the baseboard. Electric radiators are typically installed on the baseboard.
Data specified by a manufacturer or rating organization. Typically this information is from the equipment data plate or cut sheet. Also see `design`.
Reactive energy in an AC eletrical power system. Integral of `reactive-power` over time.
Reactive power or imaginary power; represents energy that recirculates within an AC power system but does not contribute useful work.
Specifies the inverse of an association or relationships. See [Associations]`docHaystack::Associations#reciprocalOf` and [Relationships]`docHaystack::Relationships#reciprocalOf` chapter.
Reference to an entity. Ref values are ASCII strings limited to the following chars: a-z, A-Z, 0-9, underbar, colon, dash, dot, or tilde. See [Kinds chapter]`docHaystack::Kinds#ref`.
Fluid used in refrigeration and heat exchange. Refrigerants typically alternate between liquid and gas state.
Entity inputs refrigerant which flows from another entity
Entity outputs refrigerant to other entities
Refrigerant distribution to fulfill all or parts of a refrigeration cycle.
Refrigerant flows from the referent to this entity
Ref tags used to model entity-to-entity relationships. See [Relationships]`docHaystack::Relationships` chapter.
Singleton for remove operation. See [Kinds chapter]`docHaystack::Kinds#remove`.
The roof floor is the topmost level of a building. It is often where HVAC equipment is located such as rooftop AHUs.
Roof Top Unit: A unitary AHU that is weatherized for outdoor use. See `docHaystack::AHUs` chapter.
Primary on/off `point` of an `equip` especially used with a `vfd`. Run is used with Bool points where true indicates on and false indicates off. When paired with `cmd` this is the commanded state of the equipment. When paired with `sensor` this is the actual status of the equip. If the equipment also defines an `enable` point then both must be commanded on in order to run the equipment.
Pipework which circulates closest to the building or end use. In a central plant, the secondary loop indicates the pipes and equipment between the central plant and the building. In context of heat exchangers between the primary and secondary loops, this tag indicates the side closest to the building.
Point is a sensor, input, AI/BI. See `docHaystack::Points#function` chapter.
Hardware or software which provides services for other programs or devices.
General purpose computer used as a server. Typically servers are rack mounted.
Ratio of the maximum continuous output capacity at which a machine or system may operate without damage to the machine or system’s nominal output capacity.
Greenhouse gas emission of sulphur hexafluoride (SF₆) into the air.
Simulation point. See `docHaystack::Synthetics` chapter.
See `docHaystack::Synthetics#sims` chapter.
Single-phase AC electricity. Power is provided by a single AC voltage source with a 2-wire connection.
Site is a geographic location of the built environment. Typically site maps to one building with its own unique street address. See `docHaystack::Sites` chapter.
Reference to site which contains the entity
Simple Mail Transfer Protocol for sending email
Simple Network Management Protocol for managing IP devices
Energy received on surface of the earth from the sun
Substance with definite shape and volume
Sedona Framework UDP based communication protocol
Point is a setpoint, soft point, internal control variable, schedule. See `docHaystack::Points#function` chapter.
Space is a three-dimensional volume in the built environment. See `docHaystack::Spaces` chapter.
Reference to space which contains this entity
Time span as modeled encoded as XStr. This is a placeholder to eventually formalize the time range used by hisRead op.
Split-phase AC electricity. Power is provided by a single AC voltage source with a 3-wire connection, consisting of two hot wires (phases), separated from each other by a 180-degree phase angle, and one neutral wire. Despite having two labeled phases, split-phase AC electricity is not a true two-phase system.
Stage number of staged equipment operation such as coil or pump. The first stage is 1, second stage 2, etc.
State of charge (SoC) of an electric `battery`. Uses a percentage in the range of 0% to 100%, where no charge is indicated as 0% and full charge is indicated as 100%.
Entity inputs steam which flows from another entity
Plant used to generate steam for heating. See `docHaystack::Plants`.
System that circulates water in its vapor state for heating a space or process.
Steam flows from the referent to this entity
Unicode string of characters. See [Kinds chapter]`docHaystack::Kinds#str`.
Submeters measure usage of a sub-system or equipment within a site
Reference to parent meter which is immediately upstream of this meter
Matter in one the three states solid, liquid, or gas
Floor below ground level. Subterranean floors are also known as basements, lower levels, or cellars.
Device for toggling state or routing data
Symbol to a def. Symbol values are ASCII strings limited to the following chars: a-z, A-Z, 0-9, underbar, colon, dash, dot. See [Kinds chapter]`docHaystack::Kinds#symbol`.
Synthetic point with computed operational data. The computed data if classified as: - `ml` for machine learning - `sim` for simulation - `computed` as catch all for other computations See `docHaystack::Synthetics` chapter.
Grouping of related equipment dedicated to a single application. See `docHaystack::Systems` chapter.
Mobile device with touch screen for user input.
Tank used to store a substance for temporary holding
Pipework which circulates within the building.
Senses and controls temperature of space in HVAC system. Thermostats may provide an interface for setpoint control.
Three-phase AC electricity. Power is provided by three AC voltage sources, each separated from the others by a 120-degree phase angle. May have a 4-wire connection with a neutral (Wye) or a 3-wire connection without a neutral (Delta).
ISO 8601 time as hour, minute, seconds: '09:51:27.354'. See [Kinds chapter]`docHaystack::Kinds#time`.
Indicates a value tag which should not be persisted. Transient values often change frequently and do not provide long term informational value. Typyically they are stored only in RAM and should not be stored to durable storage.
This marker is applied to a `relationship` to indicate it is transitive. Transitivity requires that if the relationship applies to A,B and B,C then it also applies to A,C.
Three ducts: hotDeck, coldDeck, or neutralDeck
Concentration of total volatile organic compounds (TVOC) in the air
Two-phase AC electricity. Power is provided by two AC voltage sources, separated from each other by a 90-degree phase angle. Two-phase systems are extremely rare in modern buildings; they have been replaced by modern `threePhase` systems.
Timezone identifier from standard [timezone database]`docHaystack::TimeZones`
Abidjan Accra Adak Adelaide Algiers Almaty Amman Amsterdam Anadyr Anchorage Andorra Apia Aqtau Aqtobe Araguaina Ashgabat Astrakhan Asuncion Athens Atikokan Atyrau Auckland Azores Baghdad Bahia Bahia_Banderas Baku Bangkok Barbados Barnaul Beirut Belem Belgrade Belize Berlin Bermuda Beulah Bishkek Bissau Blanc-Sablon Boa_Vista Bogota Boise Bougainville Brisbane Broken_Hill Brunei Brussels Bucharest Budapest Buenos_Aires CET CST6CDT Cairo Cambridge_Bay Campo_Grande Canary Cancun Cape_Verde Caracas Casablanca Casey Catamarca Cayenne Center Ceuta Chagos Chatham Chicago Chihuahua Chisinau Chita Choibalsan Christmas Chuuk Cocos Colombo Copenhagen Cordoba Costa_Rica Creston Cuiaba Curacao Currie Damascus Danmarkshavn Darwin Davis Dawson Dawson_Creek Denver Detroit Dhaka Dili Dubai Dublin DumontDUrville Dushanbe EET EST EST5EDT Easter Edmonton Efate Eirunepe El_Aaiun El_Salvador Enderbury Eucla Fakaofo Famagusta Faroe Fiji Fort_Nelson Fortaleza Funafuti GMT GMT+1 GMT+10 GMT+11 GMT+12 GMT+2 GMT+3 GMT+4 GMT+5 GMT+6 GMT+7 GMT+8 GMT+9 GMT-1 GMT-10 GMT-11 GMT-12 GMT-13 GMT-14 GMT-2 GMT-3 GMT-4 GMT-5 GMT-6 GMT-7 GMT-8 GMT-9 Galapagos Gambier Gaza Gibraltar Glace_Bay Godthab Goose_Bay Grand_Turk Guadalcanal Guam Guatemala Guayaquil Guyana HST Halifax Havana Hebron Helsinki Hermosillo Ho_Chi_Minh Hobart Hong_Kong Honolulu Hovd Indianapolis Inuvik Iqaluit Irkutsk Istanbul Jakarta Jamaica Jayapura Jerusalem Johannesburg Juba Jujuy Juneau Kabul Kaliningrad Kamchatka Karachi Kathmandu Kerguelen Khandyga Khartoum Kiev Kiritimati Kirov Knox Kolkata Kosrae Krasnoyarsk Kuala_Lumpur Kuching Kwajalein La_Paz La_Rioja Lagos Lima Lindeman Lisbon London Lord_Howe Los_Angeles Louisville Luxembourg MET MST MST7MDT Macau Maceio Macquarie Madeira Madrid Magadan Mahe Majuro Makassar Maldives Malta Managua Manaus Manila Maputo Marengo Marquesas Martinique Matamoros Mauritius Mawson Mazatlan Melbourne Mendoza Menominee Merida Metlakatla Mexico_City Minsk Miquelon Monaco Moncton Monrovia Monterrey Montevideo Monticello Moscow Nairobi Nassau Nauru Ndjamena New_Salem New_York Nicosia Nipigon Niue Nome Norfolk Noronha Noumea Novokuznetsk Novosibirsk Ojinaga Omsk Oral Oslo PST8PDT Pago_Pago Palau Palmer Panama Pangnirtung Paramaribo Paris Perth Petersburg Phoenix Pitcairn Pohnpei Pontianak Port-au-Prince Port_Moresby Port_of_Spain Porto_Velho Prague Puerto_Rico Punta_Arenas Pyongyang Qatar Qostanay Qyzylorda Rainy_River Rankin_Inlet Rarotonga Recife Regina Rel Resolute Reunion Reykjavik Riga Rio_Branco Rio_Gallegos Riyadh Rome Rothera Sakhalin Salta Samara Samarkand San_Juan San_Luis Santarem Santiago Santo_Domingo Sao_Paulo Sao_Tome Saratov Scoresbysund Seoul Shanghai Simferopol Singapore Sitka Sofia South_Georgia Srednekolymsk St_Johns Stanley Stockholm Swift_Current Sydney Syowa Tahiti Taipei Tallinn Tarawa Tashkent Tbilisi Tegucigalpa Tehran Tell_City Thimphu Thule Thunder_Bay Tijuana Tirane Tokyo Tomsk Tongatapu Toronto Tripoli Troll Tucuman Tunis UTC Ulaanbaatar Ulyanovsk Urumqi Ushuaia Ust-Nera Uzhgorod Vancouver Vevay Vienna Vilnius Vincennes Vladivostok Volgograd Vostok WET Wake Wallis Warsaw Whitehorse Winamac Windhoek Winnipeg Yakutat Yakutsk Yangon Yekaterinburg Yellowknife Yerevan Zaporozhye Zurich
Unit identifier from standard unit database
- %: percent (dimensionless) - %RH: percent_relative_humidity (dimensionless) - px: pixel (dimensionless) - db: decibel (dimensionless) - pf: power_factor (dimensionless) - pH: ph (dimensionless) - gH₂O/kgAir: grams_of_water_per_kilogram_dry_air (dimensionless) - V/K: volts_per_degree_kelvin (dimensionless) - °daysC: degree_days_celsius (dimensionless) - °daysF: degree_days_fahrenheit (dimensionless) - %obsc/ft: percent_obscuration_per_foot (dimensionless) - %obsc/m: percent_obscuration_per_meter (dimensionless) - psi/°F: psi_per_degree_fahrenheit (dimensionless) - m²/N: square_meters_per_newton (dimensionless) - W/m²K: watts_per_square_meter_degree_kelvin (dimensionless) - dBmV: db_millivolt (dimensionless) - dBµV: db_microvolt (dimensionless) - ppu: parts_per_unit (dimensionless) - ppm: parts_per_million (dimensionless) - ppb: parts_per_billion (dimensionless) - g/kg: grams_per_kilogram (dimensionless) - rad: radian (dimensionless) - deg: degrees_angular (dimensionless) - degPh: degrees_phase (dimensionless) - sr: steradian (dimensionless) - ntu: nephelometric_turbidity_units (dimensionless) - fnu: formazin_nephelometric_unit (dimensionless) - PUE: power_usage_effectiveness (dimensionless) - DCIE: data_center_infrastructure_efficiency (dimensionless) - Af: afghani (currency) - DZD: algerian_dinar (currency) - ARS: argentine_peso (currency) - Դ: armenian_dram (currency) - ƒ: aruban_guilder_florin (currency) - AUD: australian_dollar (currency) - ман: azerbaijanian_manat (currency) - BSD: bahamian_dollar (currency) - BHD: bahraini_dinar (currency) - ฿: baht (currency) - PAB: balboa (currency) - BBD: barbados_dollar (currency) - Br: belarussian_ruble (currency) - BZD: belize_dollar (currency) - BMD: bermudian_dollar (currency) - VEF: bolivar_fuerte (currency) - BOB: boliviano (currency) - R$: brazilian_real (currency) - BND: brunei_dollar (currency) - лв: bulgarian_lev (currency) - BIF: burundi_franc (currency) - CAD: canadian_dollar (currency) - CVE: cape_verde_escudo (currency) - KYD: cayman_islands_dollar (currency) - ₵: cedi (currency) - XAF: cfa_franc_bceao (currency) - XPF: cfp_franc (currency) - CLP: chilean_peso (currency) - 元: chinese_yuan (currency) - CDF: congolese_franc (currency) - C$: cordoba_oro (currency) - ₡: costa_rican_colon (currency) - Kn: croatian_kuna (currency) - CUP: cuban_peso (currency) - Kč: czech_koruna (currency) - GMD: dalasi (currency) - kr: danish_krone (currency) - ден: denar (currency) - DJF: djibouti_franc (currency) - Db: dobra (currency) - DOP: dominican_peso (currency) - ₫: dong (currency) - XCD: east_caribbean_dollar (currency) - EGP: egyptian_pound (currency) - ETB: ethiopian_birr (currency) - €: euro (currency) - FKP: falkland_islands_pound (currency) - FJD: fiji_dollar (currency) - HUF: forint (currency) - GIP: gibraltar_pound (currency) - HTG: gourde (currency) - ₲: guarani (currency) - GNF: guinea_franc (currency) - GYD: guyana_dollar (currency) - HKD: hong_kong_dollar (currency) - ₴: hryvnia (currency) - Kr: iceland_krona (currency) - ₹: indian_rupee (currency) - IRR: iranian_rial (currency) - IQD: iraqi_dinar (currency) - JMD: jamaican_dollar (currency) - JOD: jordanian_dinar (currency) - Sh: kenyan_shilling (currency) - PGK: kina (currency) - ₭: kip (currency) - КМ: konvertibilna_marka (currency) - KWD: kuwaiti_dinar (currency) - MK: kwacha (currency) - Kz: kwanza (currency) - MMK: kyat (currency) - ლ: lari (currency) - LBP: lebanese_pound (currency) - ALL: lek (currency) - HNL: lempira (currency) - Le: leone (currency) - RON: leu (currency) - LRD: liberian_dollar (currency) - LYD: libyan_dinar (currency) - SZL: lilangeni (currency) - LSL: loti (currency) - MGA: malagasy_ariary (currency) - RM: malaysian_ringgit (currency) - TMT: manat (currency) - MUR: mauritius_rupee (currency) - MTn: metical (currency) - MXN: mexican_peso (currency) - MDL: moldavian_leu (currency) - MAD: moroccan_dirham (currency) - ₦: naira (currency) - Nfk: nakfa (currency) - NAD: namibia_dollar (currency) - NPR: nepalese_rupee (currency) - ₪: new_israeli_shekel (currency) - NZD: new_zealand_dollar (currency) - BTN: ngultrum (currency) - KPW: north_korean_won (currency) - NOK: norwegian_krone (currency) - PEN: nuevo_sol (currency) - UM: ouguiya (currency) - ₨: pakistan_rupee (currency) - MOP: pataca (currency) - UYU: peso_uruguayo (currency) - ₱: philippine_peso (currency) - £: pound_sterling (currency) - BWP: pula (currency) - zł: pzloty (currency) - QAR: qatari_rial (currency) - GTQ: quetzal (currency) - ZAR: rand (currency) - OMR: rial_omani (currency) - KHR: riel (currency) - MVR: rufiyaa (currency) - Rp: rupiah (currency) - RUB: russian_ruble (currency) - RWF: rwanda_franc (currency) - SHP: saint_helena_pound (currency) - SAR: saudi_riyal (currency) - din: serbian_dinar (currency) - SCR: seychelles_rupee (currency) - SGD: singapore_dollar (currency) - SBD: solomon_islands_dollar (currency) - KGS: som (currency) - SOS: somali_shilling (currency) - ЅМ: somoni (currency) - ₩: south_korean_won (currency) - Rs: sri_lanka_rupee (currency) - SDG: sudanese_pound (currency) - SRD: suriname_dollar (currency) - SEK: swedish_krona (currency) - SFr: swiss_franc (currency) - SYP: syrian_pound (currency) - TWD: taiwan_dollar (currency) - ৳: taka (currency) - WST: tala (currency) - TZS: tanzanian_shilling (currency) - 〒: tenge (currency) - TTD: trinidad_and_tobago_dollar (currency) - ₮: tugrik (currency) - TND: tunisian_dinar (currency) - ₤: turkish_lira (currency) - AED: uae_dirham (currency) - UGX: uganda_shilling (currency) - $: us_dollar (currency) - UZS: uzbekistan_sum (currency) - Vt: vatu (currency) - YER: yemeni_rial (currency) - ¥: yen (currency) - ZK: zambian_kwacha (currency) - ZWL: zimbabwe_dollar (currency) - m/s²: meters_per_second_squared (acceleration) - rad/s²: radians_per_second_squared (angular acceleration) - Js: joule_second (angular momentum) - rad/s: radians_per_second (angular velocity) - rpm: revolutions_per_minute (angular velocity) - m²: square_meter (area) - mm²: square_millimeter (area) - cm²: square_centimeter (area) - km²: square_kilometer (area) - in²: square_inch (area) - ft²: square_foot (area) - yd²: square_yard (area) - mile²: square_mile (area) - acre: acre (area) - F: farad (capacitance) - COP: coefficient_of_performance (cooling efficiency) - EER: energy_efficiency_ratio (cooling efficiency) - kW/ton: kilowatt_per_ton (cooling efficiency) - kg/m³: kilograms_per_cubic_meter (density) - g/m³: grams_per_cubic_meter (density) - mg/m³: milligrams_per_cubic_meter (density) - µg/m³: micrograms_per_cubic_meter (density) - kg/L: kilograms_per_liter (density) - mg/L: milligrams_per_liter (density) - C: coulomb (electric charge) - Ah: ampere_hour (electric charge) - S: siemens (electric conductance) - A: ampere (electric current) - mA: milliampere (electric current) - Am²: ampere_square_meter (electromagnetic moment) - A/m²: amperes_per_square_meter (electric current density) - V/m: volts_per_meter (electric field strength) - V: volt (electric potential) - mV: millivolt (electric potential) - kV: kilovolt (electric potential) - MV: megavolt (electric potential) - Ω: ohm (electric resistance) - kΩ: kilohm (electric resistance) - MΩ: megohm (electric resistance) - mΩ: milliohm (electric resistance) - S/m: siemens_per_meter (electrical conductivity) - Ωm: ohm_meter (electrical resistivity) - J: joule (energy) - kJ: kilojoule (energy) - Wh: watt_hour (energy) - kWh: kilowatt_hour (energy) - MWh: megawatt_hour (energy) - GWh: gigawatt_hour (energy) - BTU: btu (energy) - kBTU: kilobtu (energy) - MMBTU: megabtu (energy) - hph: horsepower_hour (energy) - cal: calorie (energy) - therm: therm (energy) - tonrefh: tons_refrigeration_hour (energy) - MJ: megajoule (energy) - GJ: gigajoule (energy) - Nm: newton_meter (energy) - m³_gas: cubic_meters_natural_gas (energy) - ft³_gas: cubic_feet_natural_gas (energy) - Hcf_natural_gas: hundred_cubic_feet_natural_gas (energy) - Ccf_natural_gas: centum_cubic_feet_natural_gas (energy) - Mcf_natural_gas: thousand_cubic_feet_natural_gas (energy) - MMcf_natural_gas: million_cubic_feet_natural_gas (energy) - VAh: volt_ampere_hour (apparent energy) - kVAh: kilovolt_ampere_hour (apparent energy) - MVAh: megavolt_ampere_hour (apparent energy) - VARh: volt_ampere_reactive_hour (reactive energy) - kVARh: kilovolt_ampere_reactive_hour (reactive energy) - MVARh: megavolt_ampere_reactive_hour (reactive energy) - J/m²: joules_per_square_meter (energy by area) - Wh/m²: watt_hours_per_square_meter (energy by area) - Wh/ft²: watt_hours_per_square_foot (energy by area) - kWh/m²: kilowatt_hours_per_square_meter (energy by area) - kWh/ft²: kilowatt_hours_per_square_foot (energy by area) - MWh/m²: megawatt_hours_per_square_meter (energy by area) - MWh/ft²: megawatt_hours_per_square_foot (energy by area) - MJ/m²: megajoules_per_square_meter (energy by area) - MJ/ft²: megajoules_per_square_foot (energy by area) - BTU/ft²: btu_per_square_foot (energy by area) - kBTU/ft²: kilobtu_per_square_foot (energy by area) - MBTU/ft²: megabtu_per_square_foot (energy by area) - J/m³: joules_per_cubic_meter (energy by volume) - GJ/m³: gigajoules_per_cubic_meter (energy by volume) - kWh/m³: kilowatt_hours_per_cubic_meter (energy by volume) - J/g: joules_per_gram (enthalpy) - J/kg: joules_per_kilogram (enthalpy) - J/kg_dry: joules_per_kilogram_dry_air (enthalpy) - BTU/lb: btu_per_pound (enthalpy) - btu/lb_dry: btus_per_pound_dry_air (enthalpy) - kJ/kg: kilojoules_per_kilogram (enthalpy) - kJ/kg_dry: kilojoules_per_kilogram_dry_air (enthalpy) - MJ/kg_dry: megajoules_per_kilogram_dry_air (enthalpy) - cal/g: calorie_per_gram (enthalpy) - J/°K: joules_per_degree_kelvin (entropy) - kJ/°K: kilojoules_per_degree_kelvin (entropy) - MJ/°K: megajoules_per_degree_kelvin (entropy) - N: newton (force) - lbf: pound_force (force) - Hz: hertz (frequency) - kHz: kilohertz (frequency) - cph: cycles_per_hour (frequency) - cpm: cycles_per_minute (frequency) - MHz: megahertz (frequency) - /min: per_minute (frequency) - /s: per_second (frequency) - /h: per_hour (frequency) - %/s: percent_per_second (frequency) - ACH: air_changes_per_hour (frequency) - kg/m²: kilograms_per_square_meter (grammage) - g/m²: grams_per_square_meter (grammage) - K/s: degrees_kelvin_per_second (heating rate) - °C/h: degrees_celsius_per_hour (heating rate) - °C/min: degrees_celsius_per_minute (heating rate) - °F/h: degrees_fahrenheit_per_hour (heating rate) - °F/min: degrees_fahrenheit_per_minute (heating rate) - K/h: degrees_kelvin_per_hour (heating rate) - K/min: degrees_kelvin_per_minute (heating rate) - lx: lux (illuminance) - fc: footcandle (illuminance) - phot: phot (illuminance) - H: henry (inductance) - W/m²_irr: watts_per_square_meter_irradiance (irradiance) - W/ft²_irr: watts_per_square_foot_irradiance (irradiance) - m: meter (length) - µm: micrometer (length) - mm: millimeter (length) - cm: centimeter (length) - km: kilometer (length) - in: inch (length) - ft: foot (length) - yd: yard (length) - mile: mile (length) - cd/m²: candelas_per_square_meter (luminance) - cd/ft²: candels_per_square_foot (luminance) - lm: lumen (luminous flux) - cd: candela (luminous intensity) - A/m: amperes_per_meter (magnetic field strength) - Wb: weber (magnetic flux) - T: tesla (magnetic flux density) - kg: kilogram (mass) - mg: milligram (mass) - g: gram (mass) - oz: ounce (mass) - lb: pound (mass) - klb: kilopound (mass) - ton: metric_ton (mass) - t: short_ton (mass) - kg/s: kilograms_per_second (mass flow) - kg/min: kilograms_per_minute (mass flow) - kg/h: kilograms_per_hour (mass flow) - lb/min: pounds_per_minute (mass flow) - lb/h: pounds_per_hour (mass flow) - lb/s: pounds_per_second (mass flow) - klb/h: kilopounds_per_hour (mass flow) - g/s: grams_per_second (mass flow) - g/min: grams_per_minute (mass flow) - ton/h: metric_tons_per_hour (mass flow) - Ns: newton_second (momentum) - W: watt (power) - mW: milliwatt (power) - kW: kilowatt (power) - MW: megawatt (power) - GW: gigawatt (power) - BTU/h: btus_per_hour (power) - therm/h: therms_per_hour (power) - hp: horsepower (power) - ftlbs/sec: foot_pounds_per_second (power) - tonref: tons_refrigeration (power) - kBTU/h: kilobtus_per_hour (power) - MMBTU/h: megabtus_per_hour (power) - J/h: joules_per_hour (power) - kJ/h: kilojoules_per_hour (power) - MJ/h: megajoules_per_hour (power) - GJ/h: gigajoules_per_hour (power) - W/m²: watts_per_square_meter (power by area) - W/ft²: watts_per_square_foot (power by area) - kW/m²: kilowatts_per_square_meter (power by area) - kW/ft²: kilowatts_per_square_foot (power by area) - kBTU/h/ft²: kilobtus_per_hour_per_square_foot (power by area) - W/m³/s: watts_per_cubic_meters_per_second (power by volumetric flow) - W/cfm: watts_per_cubic_feet_per_minute (power by volumetric flow) - kW/kcfm: kilowatts_per_kilocubic_feet_per_minute (power by volumetric flow) - kW/gal/min: kilowatts_per_gallons_per_minute (power by volumetric flow) - VA: volt_ampere (apparent power) - kVA: kilovolt_ampere (apparent power) - mVA: megavolt_ampere (apparent power) - VAR: volt_ampere_reactive (reactive power) - kVAR: kilovolt_ampere_reactive (reactive power) - MVAR: megavolt_ampere_reactive (reactive power) - Pa: pascal (pressure) - kPa: kilopascal (pressure) - bar: bar (pressure) - atm: atmosphere (pressure) - psi: pounds_per_square_inch (pressure) - cmH₂O: centimeters_of_water (pressure) - inH₂O: inches_of_water (pressure) - mmHg: millimeters_of_mercury (pressure) - cmHg: centimeters_of_mercury (pressure) - inHg: inches_of_mercury (pressure) - hPa: hectopascal (pressure) - mbar: millibar (pressure) - J/kg°K: joules_per_kilogram_degree_kelvin (specific entropy) - N/m: newtons_per_meter (surface tension) - °F: fahrenheit (temperature) - °C: celsius (temperature) - K: kelvin (temperature) - Δ°F: fahrenheit_degrees (temperature differential) - Δ°C: celsius_degrees (temperature differential) - ΔK: kelvin_degrees (temperature differential) - W/m°K: watts_per_meter_degree_kelvin (thermal conductivity) - ns: nanosecond (time) - µs: microsecond (time) - ms: millisecond (time) - cs: hundredths_second (time) - ds: tenths_second (time) - sec: second (time) - min: minute (time) - hr: hour (time) - day: day (time) - wk: week (time) - mo: julian_month (time) - yr: year (time) - m/s: meters_per_second (velocity) - km/s: kilometers_per_second (velocity) - km/h: kilometers_per_hour (velocity) - mph: miles_per_hour (velocity) - ft/s: feet_per_second (velocity) - ft/min: feet_per_minute (velocity) - in/h: inches_per_hour (velocity) - mm/s: millimeters_per_second (velocity) - mm/min: millimeters_per_minute (velocity) - mm/h: millimeters_per_hour (velocity) - m/min: meters_per_minute (velocity) - m/h: meters_per_hour (velocity) - knot: knot (velocity) - cfm/ft²: cubic_feet_per_minute_per_square_foot (velocity) - m³: cubic_meter (volume) - mm³: cubic_millimeter (volume) - cm³: cubic_centimeter (volume) - mL: milliliter (volume) - hL: hectoliter (volume) - L: liter (volume) - kL: kiloliter (volume) - in³: cubic_inch (volume) - ft³: cubic_foot (volume) - yd³: cubic_yard (volume) - gal: gallon (volume) - kgal: kilogallon (volume) - qt: quart (volume) - pt: pint (volume) - fl_oz: fluid_ounce (volume) - galUK: imperial_gallon (volume) - hft³: hecto_cubic_foot (volume) - Hcf: hundred_cubic_feet (volume) - Ccf: centum_cubic_feet (volume) - Mcf: thousand_cubic_feet (volume) - MMcf: million_cubic_feet (volume) - m³/s: cubic_meters_per_second (volumetric flow) - mL/s: milliliters_per_second (volumetric flow) - hL/s: hectoliters_per_second (volumetric flow) - L/s: liters_per_second (volumetric flow) - cfs: cubic_feet_per_second (volumetric flow) - cfm: cubic_feet_per_minute (volumetric flow) - cfh: cubic_feet_per_hour (volumetric flow) - kcfm: kilocubic_feet_per_minute (volumetric flow) - galUK/min: imperial_gallons_per_minute (volumetric flow) - L/min: liters_per_minute (volumetric flow) - gal/min: gallons_per_minute (volumetric flow) - gph: gallons_per_hour (volumetric flow) - L/h: liters_per_hour (volumetric flow) - m³/min: cubic_meters_per_minute (volumetric flow) - m³/h: cubic_meters_per_hour (volumetric flow) - byte: byte (bytes) - kB: kilobyte (bytes) - MB: megabyte (bytes) - GB: gigabyte (bytes) - TB: terabyte (bytes) - PB: petabyte (bytes)
Unit Ventilator: An FCU that has direct access to outside air to provide the space with ventilation. See `docHaystack::AHUs` chapter.
Unoccupied mode of a space. See `docHaystack::Zones#occupancy` chapter.
Universal resource identifier. See [Kinds chapter]`docHaystack::Kinds#uri`.
Delivers a variable volume of air flow. Most variable volume systems are powered by a VFD fan. However other techniques such as inlet vanes may be used in older systems.
Variable air volume terminal unit. VAV systems use a constant air temperature with a variable air flow rate. See `docHaystack::VAVs` chapter.
VAV pulls air from outside the primary air flow
How does VAV modulate the temp based on duct pressure
Duct to access fresh outside air only for ventilation, not economizing
Version string formatted as decimal integers separated by a dot
Variable-frequency drive. See `docHaystack::Motors` chapter.
VFD speed measured in "%"; 0% is off and 100% is the fastest speed.
Distance at which light can be clearly discerned
Electrical potential difference or electromotive force.
AC voltage phase imbalance. Also referred to as voltage unbalance.
Root-mean-square (RMS) magnitude of AC electrical voltage
Total harmonic distortion (THD) of AC voltage
Three dimensional space occupied by a substance
Variable refigerant flow. See `docHaystack::VRF` chapter.
Cooling only VRF system can only cool; heating is not available. See `docHaystack::VRF#types` chapter.
Equipment used in VRF systems. See `docHaystack::VRF#equip` chapter.
Heat pump VRF system can either heat, or cool, but not at the same time. See `docHaystack::VRF#types` chapter.
Heat recovery VRF system can operate cooling and heating by each indoor unit independently, at the same time. Heat recovery VRF systems have branch selectors to control how much, and which (hot gas or subcooled liquid) refrigerant goes to each indoor unit. See `docHaystack::VRF#types` chapter.
Indoor unit in a VRF system. Indoor units operate to satisfy a heating or cooling load. See `docHaystack::VRF#indoorUnits` chapter.
Indoor unit fan coil unit in a VRF system. This includes but is not limited to: ducted-type and non-ducted types such as wall-mount, floor-mount, ceiling-mount and cassettes. Indoor unit fan coils operate to satisfy a heating or cooling load in a zone based on a zone thermostat temperature set point.
Outdoor unit with one or more compressors in a VRF system. As each indoor unit sends a demand to the outdoor unit, outdoor unit delivers the amount of refrigerant needed to meet the individual requirements of each indoor unit. See `docHaystack::VRF#outdoorUnits` chapter.
Group of outdoor units in a VRF system. See `docHaystack::VRF#refrigPlant`.
Variable refigerant flow system. The system contains the indoor units, outdoor units, and branch selectors. See `docHaystack::VRF#types` chapter.
Relatively warm in comparison to another substance, without being actively heated. The substance can be used as a source of energy for a heating process, for example a warm water well in an `ates` system.
Relatively warm water without active heating
System that supplies or collects potable or non-potable water in any state.
Cooling using transfer of heat to water which is not explicitly chilled
Associated with atmospheric air or phenomenon. See `docHaystack::Weather` chapter.
Weather station observation point. See `docHaystack::Weather#points` chapter.
unknown clear partlyCloudy cloudy showers rain thunderstorms ice flurries snow
Logical weather station and its measurement points. See `docHaystack::Weather#stations` chapter.
{weather, air, feelsLike, sensor, point}
{weather, atmospheric, pressure, sensor, point}
{weather, solar, irradiance, sensor, point}
{weather, wind, direction, sensor, point}
Reference to weather station for to use this entity
A well is a source of groundwater and potentially thermal energy. When used within an [ATES]`docHaystack::ATES` system, the well facilitates thermal energy exchange with the ground warm and cool water sources. In this case, a well can be either a closed system that transports water through pipes in the ground, or an open system that pumps up and returns ground water.
Wet bulb air temperature. Temperature which the air would have if cooled to saturation by the evaporation of water into it.
Hyperlink to the subject's page on Wikipedia
Compass direction from which wind originates
Cabling used to convey electricity or data
Point with writable output using 16-level priority array. Writable points typically are a setpoint or actuator command. Haystack writable points are modeled on the BACnet 16-level priority array with a relinquish default which effectively acts as level 17. The following levels have special behavior: - **Level 1**: highest priority reserved for emergency overrides - **Level 8**: manual override with ability to set timer to expire back to auto - **Default**: implicitly acts as level 17 for relinquish default The priority array provides for contention resolution when many different control applications may be vying for control of a given point. Low level applications like scheduling typically control levels 14, 15, or 16. Then users can override at level 8. But a higher levels like 2 to 7 can be used to trump a user override (for example a demand response energy routine that requires higher priority). The actual value to write is resolved by starting at level 1 and working down to relinquish default to find the first non-null value. It is possible for all levels to be null, in which case the overall write output is null (which in turn may be auto/null to another system). Anytime a null value is written to a priority level, we say that level has been set to auto or released (this allows the next highest level to take command of the output). Also see `docHaystack::Points#writable` chapter.
Error description when `writeStatus` indicates error condition
Current priority level for `writeVal` as number between 1 and 17. The value 17 indicates the relinquish default value.
Current status of a writable point output
- unbound: writable point is not bound to any output - ok: last write was successful - down: connectivity/networking problem - see `writeErr` - fault: configuration or hardware error - see `writeErr` - disabled: manual disable of the point or connector - unknown: we don't know anything (typically boot state)
Current desired value to write to output. This is the current "winning" value of the priority array indicated by `writeLevel`. If this tag is missing then the winning value is null/auto.
Extended string - type name and string value encoding. See [Kinds chapter]`docHaystack::Kinds#xstr`.
Original year of construction as four digit year such as 1980
Low power wireless communication protocol for home automation
Related to spaces from a system perspective
Space associated with a specific system. See `docHaystack::Spaces#zones` and `docHaystack::Zones` chapters.