def:^absorption doc:Cooling process using energy from heat source such as hot water is:[^marker] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Absorption_refrigerator` --- def:^ac doc:Relating to alternating current electricity is:[^marker] lib:^lib:phIoT --- def:^ac-elec doc:Alternating current electricity is:[^elec] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Alternating_current` --- children:[{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 pf 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},{equip},{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 pf 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},{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}] def:^ac-elec-meter doc: AC Electricity meter. See `docHaystack::Meters` chapter. is:[^elec-meter] lib:^lib:phIoT --- children:[{dc elec stateOfCharge sensor point},{equip},{evse cable equip},{evse evseStatus 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},{point}] def:^ac-evse-port doc: 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. is:[^evse-port] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Charging_station` --- def:^ac-freq doc:Frequency of alternating current is:[^freq] lib:^lib:phIoT prefUnit:["Hz"] quantityOf:[^ac-elec] --- def:^accumulate doc: 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. is:[^marker] lib:^lib:ph --- def:^active doc:"Working, operative, effective" is:[^marker] lib:^lib:phIoT --- def:^active-energy doc:"Integral of `active-power` over time" is:[^elec-energy] lib:^lib:phIoT prefUnit:["kWh"] quantityOf:[^ac-elec] --- def:^active-power doc:"Active power or real power; energy transfer that contributes useful work" is:[^elec-power] lib:^lib:phIoT prefUnit:["kW"] quantityOf:[^ac-elec] --- children:[{equip},{point}] def:^actuator doc: 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. is:[^equip,^elec-input] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Actuator` --- children:[{bypass damper cmd point},{cool cmd point},{dessicantDehumidifier cmd point},{discharge duct equip},{economizer duct equip},{economizing cmd point},{equip},{exhaust duct equip},{faceBypass cmd point},{filter sensor point},{freezeStat sensor point},{heat cmd point},{heatWheel cmd point},{humidifier equip},{hvacMode sp point},{mixed duct equip},{outside duct equip},{point},{return duct equip},{thermostat equip},{ventilation duct equip}] def:^ahu doc: 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. is:[^airHandlingEquip] lib:^lib:phIoT mandatory wikipedia:`https://en.wikipedia.org/wiki/Air_handler` --- def:^ahuZoneDelivery doc:AHU delivery method of conditioned air to the zone is:[^choice] lib:^lib:phIoT tagOn:[^airHandlingEquip] --- def:^air doc:The mixture of gases which surrounds the earth is:[^gas] lib:^lib:phScience wikipedia:`https://en.wikipedia.org/wiki/Atmosphere_of_Earth` --- children:[{equip},{point}] def:^air-conditioning-system doc: System for air treatment to control its temperature, humidity, cleanliness, and distribution to meet the requirements of a conditioned space. is:[^air-system] lib:^lib:phIoT --- children:[{equip},{point}] def:^air-exhaust-system doc: 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. is:[^air-system] lib:^lib:phIoT --- def:^air-input doc:Entity inputs air which flows from another entity is:[^input] lib:^lib:phIoT --- def:^air-output doc:Entity outputs air to other entities is:[^output] lib:^lib:phIoT --- children:[{equip},{point}] def:^air-system doc:"System for moving air to maintain indoor thermal comfort and/or air quality." is:[^system] lib:^lib:phIoT --- def:^air-temp doc:Dry bulb temperature is:[^temp] lib:^lib:phScience prefUnit:["°C","°F"] quantityOf:[^air] wikipedia:`https://en.wikipedia.org/wiki/Temperature` --- def:^air-velocity doc:Rate of air movement as distance over time is:[^quantity] lib:^lib:phScience prefUnit:["m/sec","ft/min"] quantityOf:[^air] --- children:[{equip},{point}] def:^air-ventilation-system doc: 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. is:[^air-system] lib:^lib:phIoT --- def:^airCooling doc:Cooling by dissipating heat into the surrounding air is:[^coolingProcess,^air-input] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Air_cooling` --- children:[{bypass damper cmd point},{cool cmd point},{dessicantDehumidifier cmd point},{discharge duct equip},{economizer duct equip},{economizing cmd point},{equip},{exhaust duct equip},{faceBypass cmd point},{filter sensor point},{freezeStat sensor point},{heat cmd point},{heatWheel cmd point},{humidifier equip},{hvacMode sp point},{mixed duct equip},{outside duct equip},{point},{return duct equip},{thermostat equip},{ventilation duct equip}] def:^airHandlingEquip doc: 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. is:[^equip,^air-output,^elec-input] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Air_handler` --- def:^airQuality doc:Concentration of contaminants in the air is:[^concentration] lib:^lib:phScience quantityOf:[^air] wikipedia:`https://en.wikipedia.org/wiki/Concentration` --- children:[{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}] def:^airQualityZonePoints doc: Entity with logical grouping of zone air quality points. See `docHaystack::Zones#airQuality` chapter. is:[^pointGroup] lib:^lib:phIoT --- def:^airRef doc:Air flows from the referent to this entity inputs:^air is:[^ref] lib:^lib:phIoT of:^air-output tagOn:[^air-input] --- children:[{discharge duct equip},{equip},{inlet duct equip},{point},{thermostat equip}] def:^airTerminalUnit doc: 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. is:[^equip,^air-input,^air-output,^elec-input] lib:^lib:phIoT --- def:^airVolumeAdjustability doc:Ability of air handling equip to adjust volume of air flow is:[^choice] lib:^lib:phIoT tagOn:[^airHandlingEquip] --- def:^alarm doc:Notification of a condition which requires attention is:[^marker] lib:^lib:phIoT --- def:^angle doc:Measurement of the relative difference in direction between two vectors or phasors is:[^marker] lib:^lib:phScience --- def:^apparent doc:Perceived quantity is:[^marker] lib:^lib:phScience --- def:^apparent-energy doc:"Integral of `apparent-power` over time" is:[^quantity] lib:^lib:phIoT quantityOf:[^ac-elec] --- def:^apparent-power doc:Apparent power is perceived magnitude of power due to the combination of active and reactive power is:[^quantity] lib:^lib:phIoT prefUnit:["kVA"] quantityOf:[^ac-elec] --- def:^area doc:Area of a shape or floor space is:[^number] lib:^lib:phIoT prefUnit:["ft²","m²"] tagOn:[^site,^space] --- def:^association doc: Associations model ontological relationships between definitions. See [Associations]`docHaystack::Associations` chapter. docTaxonomy is:[^list] lib:^lib:ph of:^symbol --- children:[{cool water flow thermal meter equip},{cool well equip},{equip},{extraction well equip},{flowInverter equip},{ground water flow sensor point},{ground water pressure sensor point},{ground water volume sensor point},{heatExchanger equip},{infiltration well equip},{point},{purge water flow sensor point},{purge water volume sensor point},{warm water flow thermal meter equip},{warm well equip}] def:^ates doc: Aquifer Thermal Energy Storage system. See `docHaystack::ATES` chapter. is:[^equip] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Aquifer_thermal_energy_storage` --- def:^atesClosedLoop doc: 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. is:[^atesDesign] lib:^lib:phIoT --- def:^atesDesign doc:"Design type of the ATES underground system." is:[^choice] lib:^lib:phIoT tagOn:[^ates] --- def:^atesDoublet doc:"The ATES has one or more pairs of a separate warm and cool well." is:[^atesDesign] lib:^lib:phIoT --- def:^atesDoubletPaired doc: 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. is:[^atesDesign] lib:^lib:phIoT --- def:^atesMono doc: The ATES has only one physical well. This well is deep enough to penetrate two layers of groundwater. is:[^atesDesign] lib:^lib:phIoT --- def:^atesUnidirectional doc: Similar to a doublet, but water always flows in the same direction from the extraction to the infiltration well. is:[^atesDesign] lib:^lib:phIoT --- def:^atmospheric doc:Related to the atmosphere of the earth is:[^marker] lib:^lib:phScience --- def:^atmospheric-pressure doc:Barometric pressure exerted by the weight of the atmosphere is:[^pressure] lib:^lib:phScience prefUnit:["millibar","inHg"] quantityOf:[^weather] wikipedia:`https://en.wikipedia.org/wiki/Pressure` --- def:^avg doc:"Average; central or typical value; median" is:[^marker] lib:^lib:phScience --- def:^bacnet doc:ASHRAE building automation and control protocol is:[^protocol] lib:^lib:phIct wikipedia:`https://en.wikipedia.org/wiki/BACnet` --- def:^barometric doc:Relating atmospheric pressure is:[^marker] lib:^lib:phIoT --- def:^baseUri doc:Base URI for normalizing relative URIs is:[^uri] lib:^lib:ph tagOn:[^lib] --- children:[{equip},{point}] def:^battery doc:Equipment used to store electric energy is:[^equip,^elec-output] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Electric_battery` --- def:^biomass doc:Plant or animal material used as fuel to produce electricity or heat is:[^substance] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Biomass` --- def:^biomassHeating doc:Heating by the combustion of biomass is:[^heatingProcess] lib:^lib:phIoT --- def:^blowdown doc:Removal from container or pipe is:[^marker] lib:^lib:phIoT --- def:^blowdown-water doc:Water expelled from a system to remove mineral build up is:[^water] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Water` --- def:^blowdown-water-input doc:Entity inputs blowdown water which flows from another entity is:[^input] lib:^lib:phIoT --- def:^blowdown-water-output doc:Entity outputs blowdown water to other entities is:[^output] lib:^lib:phIoT --- def:^blowdownWaterRef doc:Blowdown water flows from the referent to this entity inputs:^blowdown-water is:[^ref] lib:^lib:phIoT of:^blowdown-water-output tagOn:[^blowdown-water-input] --- def:^bluetooth doc:Short range wireless communication protocol is:[^protocol] lib:^lib:phIct wikipedia:`https://en.wikipedia.org/wiki/Bluetooth` --- children:[{alarm sensor point},{equip},{point}] def:^boiler doc:Equipment to generate hot water or steam for heating is:[^equip,^elec-input] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Boiler` --- def:^bool doc: Boolean value 'true' or 'false'. See [Kinds chapter]`docHaystack::Kinds#bool`. is:[^scalar] lib:^lib:ph --- children:[{equip},{point}] def:^branchSelector doc: 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. is:[^vrf-equip,^refrig-input] lib:^lib:phIoT --- def:^bypass doc:Pipe used to bypass an equipment is:[^pipeSection] lib:^lib:phIoT --- children:[{equip},{point}] def:^cable doc:"An assembly of one or more insulated conductors." is:[^equip] lib:^lib:phIoT --- children:[{discharge duct equip},{equip},{inlet duct equip},{point},{thermostat equip}] def:^cav doc: Constant air volume terminal unit. CAV systems use a constant air flow rate with a variable air temperature. is:[^airTerminalUnit] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Constant_air_volume` --- def:^centrifugal doc:Compression via a continuous flow of fluid through an impeller is:[^marker] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Centrifugal_compressor` --- def:^ch2o doc:"Formaldehyde (CH₂O)" is:[^gas] lib:^lib:phScience wikipedia:`https://en.wikipedia.org/wiki/Formaldehyde` --- def:^ch2o-concentration doc:"Concentration of formaldehyde (CH₂O) in the air." is:[^airQuality] lib:^lib:phScience prefUnit:["µg/m³","ppb"] quantityOf:[^air] wikipedia:`https://en.wikipedia.org/wiki/Concentration` --- def:^ch4 doc:"Methane (CH₄)" is:[^gas] lib:^lib:phScience wikipedia:`https://en.wikipedia.org/wiki/Methane` --- def:^ch4-emission doc:"Greenhouse gas emission of methane (CH₄) into the air." is:[^emission] lib:^lib:phScience prefUnit:["kg","ton","lb"] quantityOf:[^air] --- accumulate def:^children doc: List of prototypes contained by this entity. See [Protos chapter]`docHaystack::Protos` for more details. is:[^list] lib:^lib:ph of:^dict --- def:^childrenFlatten doc: List of aspects to flatten into children prototypes. See [Protos chapter]`docHaystack::Protos` for more details. is:[^list] lib:^lib:ph of:^symbol --- def:^chilled doc:Substance is cooled using cooling process is:[^marker] lib:^lib:phIoT --- def:^chilled-water doc:Water cooled for use in HVAC and industrial processes is:[^water] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Chilled_water` --- def:^chilled-water-input doc:Entity inputs chilled water which flows from another entity is:[^input] lib:^lib:phIoT --- def:^chilled-water-output doc:Entity outputs chilled water to other entities is:[^output] lib:^lib:phIoT --- children:[{chilled water bypass pipe equip},{chilled water delta flow point},{chilled water delta pressure point},{chilled water delta temp point},{chilled water entering pipe equip},{chilled water header pipe equip},{chilled water heatExchanger equip},{chilled water leaving pipe equip},{chilled water mixing valve cmd point},{chiller equip},{condenser water bypass pipe equip},{condenser water delta flow sensor point},{condenser water delta pressure sensor point},{condenser water delta temp sensor point},{coolingTower equip},{enable cmd point},{equip},{point}] def:^chilled-water-plant doc: Plant used to generate chilled water for cooling. See `docHaystack::Plants`. is:[^plant,^chilled-water-output] lib:^lib:phIoT --- children:[{equip},{point}] def:^chilled-water-system doc: System that circulates water in its liquid state below ambient temperature for cooling a space or process. is:[^water-system] lib:^lib:phIoT --- children:[{equip},{point}] def:^chilledBeam doc:Conditions a space using a heat exchanger integrated into the ceiling is:[^radiantEquip] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Chilled_beam` --- def:^chilledBeamZone doc:AHU supplies air to chilled beam terminal units is:[^ahuZoneDelivery] lib:^lib:phIoT --- def:^chilledWaterCooling doc:Cooling using transfer of heat to chilled water is:[^coolingProcess,^chilled-water-input] lib:^lib:phIoT --- def:^chilledWaterRef doc:Chilled water flows from the referent to this entity inputs:^chilled-water is:[^ref] lib:^lib:phIoT of:^chilled-water-output tagOn:[^chilled-water-input] --- children:[{alarm sensor point},{chilled water delta flow sensor point},{chilled water delta temp sensor point},{chilled water entering pipe equip},{chilled water leaving pipe equip},{chilled water valve isolation cmd point},{condenser refrig pressure sensor point},{condenser refrig temp sensor point},{condenser run cmd point},{condenser run sensor point},{condenser water entering pipe equip},{condenser water leaving pipe equip},{condenser water valve isolation cmd point},{efficiency sensor point},{enable cmd point},{enable sensor point},{equip},{evaporator refrig pressure sensor point},{evaporator refrig temp sensor point},{load cmd point},{load sensor point},{point},{run cmd point},{run sensor point}] def:^chiller doc: Equipment to remove heat from a liquid. Chillers typically use a vapor compression or an absorption refrigeration cycle. is:[^equip,^elec-input] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Chiller` --- def:^chiller-absorption doc:Cooling process using energy from heat source such as hot water is:[^absorption,^chillerMechanism] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Absorption_refrigerator` --- def:^chiller-centrifugal doc:Compression via a continuous flow of fluid through an impeller is:[^centrifugal,^chillerMechanism] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Centrifugal_compressor` --- def:^chiller-reciprocal doc:Piston compressor driven by a crankshaft is:[^reciprocal,^chillerMechanism] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Reciprocating_compressor` --- def:^chiller-rotaryScrew doc:Rotary screw compression is:[^rotaryScrew,^chillerMechanism] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Rotary-screw_compressor` --- def:^chillerMechanism doc:Primary mechanism of chiller is:[^choice] lib:^lib:phIoT tagOn:[^chiller] --- def:^choice doc: Choice specifies an exclusive marker selection. See [Choices]`docHaystack::Choices` chapter. docTaxonomy is:[^marker] lib:^lib:ph --- def:^circ doc:Pipe used to circulate fluid through an equipment or system is:[^pipeSection] lib:^lib:phIoT --- children:[{equip},{point}] def:^circuit doc: Electrical circuit and its associated components such as breakers. See `docHaystack::ElecPanels#circuits` chapter. is:[^equip,^elec-input,^elec-output] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Electrical_network` --- def:^cloudage doc:"Percentage of sky obscured by clouds. This is also known as cloudiness, or cloud amount." is:[^quantity] lib:^lib:phScience prefUnit:["%"] quantityOf:[^weather] --- def:^cmd doc: Point is a command, actuator, AO/BO. See `docHaystack::Points#function` chapter. is:[^pointFunction] lib:^lib:phIoT --- def:^co doc:"Carbon monoxide (CO)" is:[^gas] lib:^lib:phScience wikipedia:`https://en.wikipedia.org/wiki/Carbon_monoxide` --- def:^co-concentration doc:"Concentration of carbon monoxide (CO) in the air." is:[^airQuality] lib:^lib:phScience prefUnit:["ppm"] quantityOf:[^air] wikipedia:`https://en.wikipedia.org/wiki/Concentration` --- def:^co2 doc:"Carbon dioxide (CO₂)" is:[^gas] lib:^lib:phScience wikipedia:`https://en.wikipedia.org/wiki/Carbon_dioxide` --- def:^co2-concentration doc:"Concentration of carbon dioxide (CO₂) in the air." is:[^airQuality] lib:^lib:phScience prefUnit:["ppm"] quantityOf:[^air] wikipedia:`https://en.wikipedia.org/wiki/Concentration` --- def:^co2-emission doc:"Greenhouse gas emission of carbon dioxide (CO₂) into the air." is:[^emission] lib:^lib:phScience prefUnit:["kg","ton","lb"] quantityOf:[^air] --- def:^co2e doc:Carbon dioxide equivalent is:[^marker] lib:^lib:phScience wikipedia:`https://en.wikipedia.org/wiki/Global_warming_potential` --- def:^coal doc:Combustible sedimentary rock is:[^solid] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Coal` --- def:^coalHeating doc:Heating by the combustion of coal is:[^heatingProcess] lib:^lib:phIoT --- def:^coap doc:Constrained Application Protocol is:[^protocol] lib:^lib:phIct wikipedia:`https://en.wikipedia.org/wiki/Constrained_Application_Protocol` --- children:[{equip},{point}] def:^coil doc: Heat exchanger used to heat or cool air. Coils are sub-components of HVAC equipment such as `airHandlingEquip`. is:[^heatExchanger] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Heat_exchanger#HVAC_air_coils` --- def:^cold doc:Having low degree of heat is:[^marker] lib:^lib:phIoT --- def:^cold-water doc:Water supplied to cold taps is:[^water] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Water` --- def:^coldDeck doc:Duct carries air for cooling is:[^ductDeck] lib:^lib:phIoT --- def:^compressor doc: Device for mechanically increasing the pressure of a gas or refrigerant vapor by reducing its volume. is:[^marker] lib:^lib:phIoT --- def:^computed doc:"Computed point. See `docHaystack::Synthetics` chapter." is:[^synthetic] lib:^lib:phIoT --- def:^computed-point doc:"See `docHaystack::Synthetics` chapter." is:[^synthetic-point] lib:^lib:phIoT --- def:^computedFromReciprocal doc: Indicates a relationship that is computed from its reciprocal. Computed defs cannot be used as tags themselves. is:[^marker] lib:^lib:ph --- def:^computedModel doc:"See `docHaystack::Synthetics` chapter." is:[^syntheticModel] lib:^lib:phIoT --- def:^computer doc:"General purpose computer." is:[^device] lib:^lib:phIct wikipedia:`https://en.wikipedia.org/wiki/Computer` --- def:^concentration doc:"Abundance of substance in the total volume of a mixture." is:[^quantity] lib:^lib:phScience quantityOf:[^substance] wikipedia:`https://en.wikipedia.org/wiki/Concentration` --- def:^condensate doc:Liquid phase produced by the condensation of steam or other gas is:[^liquid] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Liquid` --- def:^condensate-input doc:Entity inputs condensate which flows from another entity is:[^input] lib:^lib:phIoT --- def:^condensate-output doc:Entity outputs condensate to other entities is:[^output] lib:^lib:phIoT --- def:^condensateRef doc:Condensate flows from the referent to this entity inputs:^condensate is:[^ref] lib:^lib:phIoT of:^condensate-output tagOn:[^condensate-input] --- def:^condenser doc:Device or related to process of condensation is:[^marker] lib:^lib:phIoT --- def:^condenser-water doc:Water used used to remove heat through condensation is:[^water] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Water` --- def:^condenser-water-input doc:Entity inputs condenser water which flows from another entity is:[^input] lib:^lib:phIoT --- def:^condenser-water-output doc:Entity outputs condenser water to other entities is:[^output] lib:^lib:phIoT --- children:[{equip},{point}] def:^condenser-water-system doc: System that circulates water in its liquid state for rejecting heat from a space or process. is:[^water-system] lib:^lib:phIoT --- def:^condenserClosedLoop doc:Working fluid is kept separate from fluid used for heat transfer into the atmosphere is:[^condenserLoop] lib:^lib:phIoT --- def:^condenserCooling doc:Removal of heat through the process of water condensation is:[^coolingProcess] lib:^lib:phIoT --- def:^condenserLoop doc:Open or closed loop for condenser working fluid is:[^choice] lib:^lib:phIoT tagOn:[^chilled-water-plant] --- def:^condenserOpenLoop doc:Uses working fluid itself for evaporation into the atmosphere is:[^condenserLoop] lib:^lib:phIoT --- def:^condenserWaterRef doc:Condenser water flows from the referent to this entity inputs:^condenser-water is:[^ref] lib:^lib:phIoT of:^condenser-water-output tagOn:[^condenser-water-input] --- def:^conditioning doc: Related to cleaning, heating, cooling, humidifying, dehumidifying, ventilating or circulating  air.  is:[^marker] lib:^lib:phIoT --- children:[{equip},{point}] def:^conduit doc:"Duct, pipe, or cable to convey a substance or phenomenon" is:[^equip] lib:^lib:phIoT --- def:^constantAirVolume doc: Delivers a constant volume of air flow. Typically this means equipment with a single speed fan. is:[^airVolumeAdjustability] lib:^lib:phIoT --- def:^containedBy doc:"The entity is logically contained by the referent." is:[^relationship] lib:^lib:ph reciprocalOf:^contains transitive --- computedFromReciprocal def:^contains doc:Entities logically contained by this entity is:[^relationship] lib:^lib:ph reciprocalOf:^containedBy transitive --- def:^controller doc: 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`. is:[^device] lib:^lib:phIct --- def:^controls doc:Associated with the control system for an industrial process is:[^marker] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Control_system` --- children:[{controller device},{equip},{networking device},{point}] def:^controls-panel doc:Panel housing controllers and networking gear is:[^panel] lib:^lib:phIct --- def:^cool doc: 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. is:[^marker] lib:^lib:phIoT --- def:^cool-water doc:Relatively cool water without active chilling is:[^water] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Water` --- def:^cooling doc:Cooling mode or process is:[^marker] lib:^lib:phIoT --- def:^coolingCapacity doc:Measurement of a chiller ability to remove heat measured is:[^number] lib:^lib:phIoT prefUnit:["tonref","BTU/h","kW"] tagOn:[^chiller] --- children:[{chilled water cool valve cmd point},{equip},{point},{stage:1 cool run cmd point}] childrenFlatten:[^ductDeck,^ductSection] def:^coolingCoil doc:"Coil used to cool air." is:[^coil] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Heat_exchanger#HVAC_air_coils` --- def:^coolingOnly doc:Equipment without heating is:[^marker] lib:^lib:phIoT --- def:^coolingProcess doc:Processed used to cool a substance is:[^choice] lib:^lib:phIoT tagOn:[^airHandlingEquip,^chilledBeam,^coolingCoil] --- children:[{condenser water entering pipe equip},{condenser water leaving pipe equip},{equip},{fan motor equip},{point}] def:^coolingTower doc:Equipment to transfer waste heat into the atmosphere is:[^equip,^elec-input] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Cooling_tower` --- def:^coord doc: Geographic coordinate in latitude/longitude in decimal degrees. See [Kinds chapter]`docHaystack::Kinds#coord`. is:[^scalar] lib:^lib:ph --- children:[{bypass damper cmd point},{cool cmd point},{dessicantDehumidifier cmd point},{discharge duct equip},{economizer duct equip},{economizing cmd point},{equip},{exhaust duct equip},{faceBypass cmd point},{filter sensor point},{freezeStat sensor point},{heat cmd point},{heatWheel cmd point},{humidifier equip},{hvacMode sp point},{mixed duct equip},{outside duct equip},{point},{return duct equip},{thermostat equip},{ventilation duct equip}] def:^crac doc: Computer Room Air Conditioner: An FCU designed to condition a computer room. See `docHaystack::AHUs` and `docHaystack::DataCenters` chapters. is:[^fcu] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Fan_coil_unit` --- def:^cur doc:Supports current value is:[^marker] lib:^lib:phIoT tagOn:[^point] --- def:^cur-point doc: 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. is:[^point] lib:^lib:phIoT --- def:^curErr doc:"Error description when `curStatus` indicates error condition" is:[^str] lib:^lib:phIoT tagOn:[^cur-point] transient --- def:^curStatus doc: 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". enum: - 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 is:[^str] lib:^lib:phIoT tagOn:[^cur-point] transient --- def:^curVal doc: Current value of a point. The current value is only available when the `curStatus` is "ok" or "stale". is:[^scalar] lib:^lib:phIoT tagOn:[^cur-point] transient --- def:^current doc:Movement of fluid or electricity is:[^marker] lib:^lib:phScience --- def:^current-angle doc:AC current phase angle is:[^quantity] lib:^lib:phIoT prefUnit:["deg"] quantityOf:[^ac-elec] --- def:^current-imbalance doc:Current phase imbalance in a multiphase AC system is:[^quantity] lib:^lib:phIoT prefUnit:["%"] quantityOf:[^ac-elec] --- def:^current-magnitude doc:Magnitude of electrical current is:[^elec-current] lib:^lib:phIoT prefUnit:["A"] quantityOf:[^ac-elec] --- def:^current-thd doc:Total harmonic current distortion is:[^quantity] lib:^lib:phIoT prefUnit:["%"] quantityOf:[^ac-elec] --- def:^dali doc:Digital Addressable Lighting Interface protocol for lighting is:[^protocol] lib:^lib:phIct wikipedia:`https://en.wikipedia.org/wiki/Digital_Addressable_Lighting_Interface` --- def:^damper doc:"Damper equipment or control point." is:[^marker] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Damper_(flow)` --- children:[{damper cmd point},{damper sensor point},{equip},{point}] childrenFlatten:[^ductSection] def:^damper-actuator doc:"Actuator to regulate the flow of air." is:[^actuator] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Damper_(flow)` --- children:[{crac fcu equip},{equip},{point},{rack equip},{space}] def:^dataCenter doc: Space used to house computer and networking gear. See `docHaystack::DataCenters` chapter. is:[^space] lib:^lib:phIct wikipedia:`https://en.wikipedia.org/wiki/Data_center` --- def:^date doc: ISO 8601 date as year, month, day: '2011-06-07'. See [Kinds chapter]`docHaystack::Kinds#date`. is:[^scalar] lib:^lib:ph --- def:^dateTime doc: ISO 8601 timestamp followed by timezone identifier. See [Kinds chapter]`docHaystack::Kinds#dateTime`. is:[^scalar] lib:^lib:ph --- def:^daytime doc:Time between sunrise and sunset enum: - nighttime: false indicates sun is below horizon - daytime: true indicates sun is above horizon is:[^quantity] lib:^lib:phScience quantityOf:[^weather] --- def:^dc doc:Relating to direct current electricity is:[^marker] lib:^lib:phIoT --- def:^dc-elec doc:Direct current electricity is:[^elec] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Direct_current` --- children:[{equip},{point}] def:^dc-elec-meter doc: DC Electricity meter. See `docHaystack::Meters` chapter. is:[^elec-meter] lib:^lib:phIoT --- children:[{dc elec stateOfCharge sensor point},{equip},{evse cable equip},{evse evseStatus sensor point},{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},{import dc elec volt sensor point},{point}] def:^dc-evse-port doc: 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. is:[^evse-port] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Charging_station` --- def:^deadband doc: The range in a process where no changes to output are made. May also indicate the difference between a base setpoint and effective setpoint. is:[^marker] lib:^lib:phIoT --- def:^def doc: Create a new definition bound to the given symbol. See [Defs chapter]`docHaystack::Defs`. is:[^symbol] lib:^lib:ph --- def:^defx doc: Extends the given definition with additional meta tags. See [Normalization]`docHaystack::Normalization#defx`. is:[^symbol] lib:^lib:ph --- def:^delta doc:"Differential of fluid between entering and leaving sensors." is:[^marker] lib:^lib:phIoT --- def:^demand doc:"Rate required for a process." is:[^marker] lib:^lib:phIoT --- def:^depends doc: List of this library's dependencies. The dependent libs define the [lib namespace]`docHaystack::Namespaces#lib`. Also see [Normalization]`docHaystack::Normalization#resolve`. is:[^list] lib:^lib:ph of:^ref tagOn:[^lib] --- def:^deprecated doc:Obsoleted is:[^marker] lib:^lib:ph --- def:^design doc: Data related to intended design and operating conditions. This includes sizing and other data specified by design engineers and engineered drawings. Also see `rated`. is:[^marker] lib:^lib:phIoT --- def:^dessicantDehumidifier doc:"Decreases humidity from air using a substance which absorbs moisture." is:[^marker] lib:^lib:phIoT --- def:^device doc: Microprocessor based hardware device. This is the general term for all computers, mobile phones, controllers, and I/O modules. See `docHaystack::Devices#networks` chapter. docTaxonomy is:[^entity] lib:^lib:phIct mandatory --- def:^deviceRef doc:Device which controls a monitors this entity is:[^ref] lib:^lib:phIct of:^device --- def:^dewPoint doc:Dew point temperature at which water vapor will form dew is:[^quantity] lib:^lib:phScience prefUnit:["°C","°F"] quantityOf:[^air] --- def:^dict doc: Map of name/value tag pairs. See [Kinds chapter]`docHaystack::Kinds#dict`. is:[^val] lib:^lib:ph --- def:^diesel doc:Liquid fuel specifically designed for use in diesel engines is:[^liquid] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Diesel_fuel` --- def:^directZone doc:AHU supplies air directly to the zone is:[^ahuZoneDelivery] lib:^lib:phIoT --- def:^direction doc:"Compass direction measured in degrees: North: 0° = 360°, East: 90°, South: 180°, West: 270°" is:[^quantity] lib:^lib:phScience prefUnit:["deg"] --- def:^dis doc: Display name for an entity. See `docHaystack::Ontology#entities` chapter. is:[^str] lib:^lib:ph tagOn:[^entity] --- def:^discharge doc:Duct for air leaving an equipment is:[^ductSection] lib:^lib:phIoT --- def:^dispenser doc:"Equipment that releases a specific amount of a substance." is:[^marker] lib:^lib:phIoT --- def:^diverting doc:"Three way valve which inputs one pipe and diverts between two output pipes." is:[^marker] lib:^lib:phIoT --- children:[{bypass damper cmd point},{cool cmd point},{dessicantDehumidifier cmd point},{discharge duct equip},{economizer duct equip},{economizing cmd point},{equip},{exhaust duct equip},{faceBypass cmd point},{filter sensor point},{freezeStat sensor point},{heat cmd point},{heatWheel cmd point},{humidifier equip},{hvacMode sp point},{mixed duct equip},{outside duct equip},{point},{return duct equip},{thermostat equip},{ventilation duct equip}] def:^doas doc: 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. is:[^ahu] lib:^lib:phIoT wikipedia:`https://en.wikipedia.org/wiki/Air_handler` --- def:^doc doc: 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