absorption
type: Class
subclass of: marker
comment: Cooling process using energy from heat source such as hot water
is: marker
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Absorption_refrigerator

ac
type: Class
subclass of: marker
comment: Relating to alternating current electricity
is: marker
lib: lib:phIoT

ac-elec
type: Class
subclass of: elec
comment: Alternating current electricity
is: elec
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Alternating_current

ac-elec-meter
type: Class
subclass of: elec-meter
children: point
  has tag: avg
  has tag: ac
  has tag: elec
  has tag: current
  has tag: angle
  has tag: sensor
  has tag: point
children: point
  has tag: avg
  has tag: ac
  has tag: elec
  has tag: current
  has tag: imbalance
  has tag: sensor
  has tag: point
children: point
  has tag: avg
  has tag: ac
  has tag: elec
  has tag: current
  has tag: magnitude
  has tag: sensor
  has tag: point
children: point
  has tag: avg
  has tag: ac
  has tag: elec
  has tag: current
  has tag: thd
  has tag: sensor
  has tag: point
children: point
  has tag: avg
  has tag: ac
  has tag: elec
  has tag: pf
  has tag: sensor
  has tag: point
children: point
  has tag: avg
  has tag: ac
  has tag: elec
  has tag: volt
  has tag: angle
  has tag: sensor
  has tag: point
children: point
  has tag: avg
  has tag: ac
  has tag: elec
  has tag: volt
  has tag: imbalance
  has tag: sensor
  has tag: point
children: point
  has tag: avg
  has tag: ac
  has tag: elec
  has tag: volt
  has tag: magnitude
  has tag: sensor
  has tag: point
children: point
  has tag: avg
  has tag: ac
  has tag: elec
  has tag: volt
  has tag: thd
  has tag: sensor
  has tag: point
children: equip
  has tag: equip
children: point
  has tag: ac
  has tag: elec
  has tag: current
  has tag: angle
  has tag: sensor
  has tag: point
  phase: A
children: point
  has tag: ac
  has tag: elec
  has tag: current
  has tag: imbalance
  has tag: sensor
  has tag: point
  phase: A
children: point
  has tag: ac
  has tag: elec
  has tag: current
  has tag: magnitude
  has tag: sensor
  has tag: point
  phase: A
children: point
  has tag: ac
  has tag: elec
  has tag: current
  has tag: thd
  has tag: sensor
  has tag: point
  phase: A
children: point
  has tag: ac
  has tag: elec
  has tag: pf
  has tag: sensor
  has tag: point
  phase: A
children: point
  has tag: ac
  has tag: elec
  has tag: volt
  has tag: angle
  has tag: sensor
  has tag: point
  phase: A
children: point
  has tag: ac
  has tag: elec
  has tag: volt
  has tag: imbalance
  has tag: sensor
  has tag: point
  phase: A
children: point
  has tag: ac
  has tag: elec
  has tag: volt
  has tag: magnitude
  has tag: sensor
  has tag: point
  phase: A
children: point
  has tag: ac
  has tag: elec
  has tag: volt
  has tag: thd
  has tag: sensor
  has tag: point
  phase: A
children: point
  has tag: active
  has tag: ac
  has tag: elec
  has tag: power
  has tag: sensor
  has tag: point
  phase: A
children: point
  has tag: apparent
  has tag: ac
  has tag: elec
  has tag: power
  has tag: sensor
  has tag: point
  phase: A
children: point
  has tag: net
  has tag: ac
  has tag: elec
  has tag: active
  has tag: energy
  has tag: sensor
  has tag: point
  phase: A
children: point
  has tag: reactive
  has tag: ac
  has tag: elec
  has tag: power
  has tag: sensor
  has tag: point
  phase: A
children: point
  has tag: point
children: point
  has tag: total
  has tag: ac
  has tag: elec
  has tag: demand
  has tag: sensor
  has tag: point
children: point
  has tag: total
  has tag: active
  has tag: ac
  has tag: elec
  has tag: power
  has tag: sensor
  has tag: point
children: point
  has tag: total
  has tag: apparent
  has tag: ac
  has tag: elec
  has tag: power
  has tag: sensor
  has tag: point
comment: AC Electricity meter. See `docHaystack::Meters` chapter.
is: elec-meter
lib: lib:phIoT

ac-evse-port
type: Class
subclass of: evse-port
children: point
  has tag: dc
  has tag: elec
  has tag: stateOfCharge
  has tag: sensor
  has tag: point
children: equip
  has tag: equip
children: cable
  type: evse-cable
  has tag: evse
  has tag: cable
  has tag: equip
children: point
  has tag: evse
  has tag: evseStatus
  has tag: sensor
  has tag: point
children: point
  has tag: import
  has tag: ac
  has tag: elec
  has tag: active
  has tag: energy
  has tag: hisTotalized
  has tag: sensor
  has tag: point
children: point
  has tag: import
  has tag: ac
  has tag: elec
  has tag: active
  has tag: power
  has tag: max
  has tag: sp
  has tag: point
children: point
  has tag: import
  has tag: ac
  has tag: elec
  has tag: active
  has tag: power
  has tag: sensor
  has tag: point
children: point
  has tag: import
  has tag: ac
  has tag: elec
  has tag: magnitude
  has tag: current
  has tag: max
  has tag: sp
  has tag: point
children: point
  has tag: import
  has tag: ac
  has tag: elec
  has tag: magnitude
  has tag: current
  has tag: sensor
  has tag: point
children: point
  has tag: import
  has tag: ac
  has tag: elec
  has tag: magnitude
  has tag: volt
  has tag: sensor
  has tag: point
children: point
  has tag: import
  has tag: ac
  has tag: elec
  has tag: pfScope
  has tag: pf
  has tag: sensor
  has tag: point
children: point
  has tag: point
comment: 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

ac-freq
type: Class
subclass of: freq
comment: Frequency of alternating current
is: freq
lib: lib:phIoT
prefUnit: Hz
quantityOf: ac-elec

accumulate
type: Class
subclass of: marker
comment: 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

active
type: Class
subclass of: marker
comment: Working, operative, effective
is: marker
lib: lib:phIoT

active-energy
type: Class
subclass of: elec-energy
comment: Integral of `active-power` over time
is: elec-energy
lib: lib:phIoT
prefUnit: kWh
quantityOf: ac-elec

active-power
type: Class
subclass of: elec-power
comment: Active power or real power; energy transfer that contributes useful work
is: elec-power
lib: lib:phIoT
prefUnit: kW
quantityOf: ac-elec

actuator
type: Class
subclass of: equip
subclass of: elec-input
children: equip
  has tag: equip
children: point
  has tag: point
comment: 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
is: elec-input
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Actuator

ahu
type: Class
subclass of: airHandlingEquip
children: point
  has tag: bypass
  has tag: damper
  has tag: cmd
  has tag: point
children: point
  has tag: cool
  has tag: cmd
  has tag: point
children: point
  has tag: dessicantDehumidifier
  has tag: cmd
  has tag: point
children: duct
  has tag: discharge
  has tag: duct
  has tag: equip
children: duct
  has tag: economizer
  has tag: duct
  has tag: equip
children: point
  has tag: economizing
  has tag: cmd
  has tag: point
children: equip
  has tag: equip
children: duct
  has tag: exhaust
  has tag: duct
  has tag: equip
children: point
  has tag: faceBypass
  has tag: cmd
  has tag: point
children: point
  has tag: filter
  has tag: sensor
  has tag: point
children: point
  has tag: freezeStat
  has tag: sensor
  has tag: point
children: point
  has tag: heat
  has tag: cmd
  has tag: point
children: point
  has tag: heatWheel
  has tag: cmd
  has tag: point
children: humidifier-equip
  has tag: humidifier
  has tag: equip
children: point
  has tag: hvacMode
  has tag: sp
  has tag: point
children: duct
  has tag: mixed
  has tag: duct
  has tag: equip
children: duct
  has tag: outside
  has tag: duct
  has tag: equip
children: point
  has tag: point
children: duct
  has tag: return
  has tag: duct
  has tag: equip
children: thermostat
  has tag: thermostat
  has tag: equip
children: duct
  has tag: ventilation
  has tag: duct
  has tag: equip
comment: 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: marker
wikipedia: https://en.wikipedia.org/wiki/Air_handler

ahuZoneDelivery
type: Class
subclass of: choice
comment: AHU delivery method of conditioned air to the zone
is: choice
lib: lib:phIoT
tagOn: airHandlingEquip

air
type: Class
subclass of: gas
comment: The mixture of gases which surrounds the earth
is: gas
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Atmosphere_of_Earth

air-conditioning-system
type: Class
subclass of: air-system
children: equip
  has tag: equip
children: point
  has tag: point
comment: 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

air-exhaust-system
type: Class
subclass of: air-system
children: equip
  has tag: equip
children: point
  has tag: point
comment: 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

air-input
type: Class
subclass of: input
comment: Entity inputs air which flows from another entity
is: input
lib: lib:phIoT

air-output
type: Class
subclass of: output
comment: Entity outputs air to other entities
is: output
lib: lib:phIoT

air-system
type: Class
subclass of: system
children: equip
  has tag: equip
children: point
  has tag: point
comment: System for moving air to maintain indoor thermal comfort and/or air quality.
is: system
lib: lib:phIoT

air-temp
type: Class
subclass of: temp
comment: Dry bulb temperature
is: temp
lib: lib:phScience
prefUnit: °C
prefUnit: °F
quantityOf: air
wikipedia: https://en.wikipedia.org/wiki/Temperature

air-velocity
type: Class
subclass of: quantity
comment: Rate of air movement as distance over time
is: quantity
lib: lib:phScience
prefUnit: m/sec
prefUnit: ft/min
quantityOf: air

air-ventilation-system
type: Class
subclass of: air-system
children: equip
  has tag: equip
children: point
  has tag: point
comment: 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

airCooling
type: Class
subclass of: coolingProcess
subclass of: air-input
comment: Cooling by dissipating heat into the surrounding air
is: coolingProcess
is: air-input
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Air_cooling

airHandlingEquip
type: Class
subclass of: equip
subclass of: air-output
subclass of: elec-input
children: point
  has tag: bypass
  has tag: damper
  has tag: cmd
  has tag: point
children: point
  has tag: cool
  has tag: cmd
  has tag: point
children: point
  has tag: dessicantDehumidifier
  has tag: cmd
  has tag: point
children: duct
  has tag: discharge
  has tag: duct
  has tag: equip
children: duct
  has tag: economizer
  has tag: duct
  has tag: equip
children: point
  has tag: economizing
  has tag: cmd
  has tag: point
children: equip
  has tag: equip
children: duct
  has tag: exhaust
  has tag: duct
  has tag: equip
children: point
  has tag: faceBypass
  has tag: cmd
  has tag: point
children: point
  has tag: filter
  has tag: sensor
  has tag: point
children: point
  has tag: freezeStat
  has tag: sensor
  has tag: point
children: point
  has tag: heat
  has tag: cmd
  has tag: point
children: point
  has tag: heatWheel
  has tag: cmd
  has tag: point
children: humidifier-equip
  has tag: humidifier
  has tag: equip
children: point
  has tag: hvacMode
  has tag: sp
  has tag: point
children: duct
  has tag: mixed
  has tag: duct
  has tag: equip
children: duct
  has tag: outside
  has tag: duct
  has tag: equip
children: point
  has tag: point
children: duct
  has tag: return
  has tag: duct
  has tag: equip
children: thermostat
  has tag: thermostat
  has tag: equip
children: duct
  has tag: ventilation
  has tag: duct
  has tag: equip
comment: 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
is: air-output
is: elec-input
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Air_handler

airQuality
type: Class
subclass of: concentration
comment: Concentration of contaminants in the air
is: concentration
lib: lib:phScience
quantityOf: air
wikipedia: https://en.wikipedia.org/wiki/Concentration

airQualityZonePoints
type: Class
subclass of: pointGroup
children: point
  has tag: zone
  has tag: air
  has tag: ch2o
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: co
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: co2
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: co2
  has tag: concentration
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: nh3
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: no2
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: o3
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: pm01
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: pm10
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: pm25
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: tvoc
  has tag: concentration
  has tag: sensor
  has tag: point
comment: Entity with logical grouping of zone air quality points. See `docHaystack::Zones#airQuality` chapter.
is: pointGroup
lib: lib:phIoT

airRef
type: ObjectProperty
domain: air-input
range: air-output
comment: Air flows from the referent to this entity
inputs: air
is: ref
lib: lib:phIoT
of: air-output
tagOn: air-input

airTerminalUnit
type: Class
subclass of: equip
subclass of: air-input
subclass of: air-output
subclass of: elec-input
children: duct
  has tag: discharge
  has tag: duct
  has tag: equip
children: equip
  has tag: equip
children: duct
  has tag: inlet
  has tag: duct
  has tag: equip
children: point
  has tag: point
children: thermostat
  has tag: thermostat
  has tag: equip
comment: 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
is: air-input
is: air-output
is: elec-input
lib: lib:phIoT

airVolumeAdjustability
type: Class
subclass of: choice
comment: Ability of air handling equip to adjust volume of air flow
is: choice
lib: lib:phIoT
tagOn: airHandlingEquip

alarm
type: Class
subclass of: marker
comment: Notification of a condition which requires attention
is: marker
lib: lib:phIoT

angle
type: Class
subclass of: marker
comment: Measurement of the relative difference in direction between two vectors or phasors
is: marker
lib: lib:phScience

apparent
type: Class
subclass of: marker
comment: Perceived quantity
is: marker
lib: lib:phScience

apparent-energy
type: Class
subclass of: quantity
comment: Integral of `apparent-power` over time
is: quantity
lib: lib:phIoT
quantityOf: ac-elec

apparent-power
type: Class
subclass of: quantity
comment: 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

area
type: DatatypeProperty
domain: site
domain: space
range: number
comment: Area of a shape or floor space
is: number
lib: lib:phIoT
prefUnit: ft²
prefUnit: m²
tagOn: site
tagOn: space

association
type: DatatypeProperty
range: list
comment: Associations model ontological relationships between definitions. See [Associations]`docHaystack::Associations` chapter.
docTaxonomy: marker
is: list
lib: lib:ph
of: symbol

ates
type: Class
subclass of: equip
children: flow-meter
  has tag: cool
  has tag: water
  has tag: flow
  has tag: thermal
  has tag: meter
  has tag: equip
children: well
  has tag: cool
  has tag: well
  has tag: equip
children: equip
  has tag: equip
children: well
  has tag: extraction
  has tag: well
  has tag: equip
children: flowInverter
  has tag: flowInverter
  has tag: equip
children: point
  has tag: ground
  has tag: water
  has tag: flow
  has tag: sensor
  has tag: point
children: point
  has tag: ground
  has tag: water
  has tag: pressure
  has tag: sensor
  has tag: point
children: point
  has tag: ground
  has tag: water
  has tag: volume
  has tag: sensor
  has tag: point
children: heatExchanger
  has tag: heatExchanger
  has tag: equip
children: well
  has tag: infiltration
  has tag: well
  has tag: equip
children: point
  has tag: point
children: point
  has tag: purge
  has tag: water
  has tag: flow
  has tag: sensor
  has tag: point
children: point
  has tag: purge
  has tag: water
  has tag: volume
  has tag: sensor
  has tag: point
children: flow-meter
  has tag: warm
  has tag: water
  has tag: flow
  has tag: thermal
  has tag: meter
  has tag: equip
children: well
  has tag: warm
  has tag: well
  has tag: equip
comment: Aquifer Thermal Energy Storage system. See `docHaystack::ATES` chapter.
is: equip
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Aquifer_thermal_energy_storage

atesClosedLoop
type: Class
subclass of: atesDesign
comment: 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

atesDesign
type: Class
subclass of: choice
comment: Design type of the ATES underground system.
is: choice
lib: lib:phIoT
tagOn: ates

atesDoublet
type: Class
subclass of: atesDesign
comment: The ATES has one or more pairs of a separate warm and cool well.
is: atesDesign
lib: lib:phIoT

atesDoubletPaired
type: Class
subclass of: atesDesign
comment: 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

atesMono
type: Class
subclass of: atesDesign
comment: The ATES has only one physical well. This well is deep enough to penetrate two layers of groundwater.
is: atesDesign
lib: lib:phIoT

atesUnidirectional
type: Class
subclass of: atesDesign
comment: Similar to a doublet, but water always flows in the same direction from the extraction to the infiltration well.
is: atesDesign
lib: lib:phIoT

atmospheric
type: Class
subclass of: marker
comment: Related to the atmosphere of the earth
is: marker
lib: lib:phScience

atmospheric-pressure
type: Class
subclass of: pressure
comment: Barometric pressure exerted by the weight of the atmosphere
is: pressure
lib: lib:phScience
prefUnit: millibar
prefUnit: inHg
quantityOf: weather
wikipedia: https://en.wikipedia.org/wiki/Pressure

avg
type: Class
subclass of: marker
comment: Average; central or typical value; median
is: marker
lib: lib:phScience

bacnet
type: Class
subclass of: protocol
comment: ASHRAE building automation and control protocol
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/BACnet

barometric
type: Class
subclass of: marker
comment: Relating atmospheric pressure
is: marker
lib: lib:phIoT

baseUri
type: DatatypeProperty
domain: lib
range: uri
comment: Base URI for normalizing relative URIs
is: uri
lib: lib:ph
tagOn: lib

battery
type: Class
subclass of: equip
subclass of: elec-output
children: equip
  has tag: equip
children: point
  has tag: point
comment: Equipment used to store electric energy
is: equip
is: elec-output
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Electric_battery

biomass
type: Class
subclass of: substance
comment: Plant or animal material used as fuel to produce electricity or heat
is: substance
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Biomass

biomassHeating
type: Class
subclass of: heatingProcess
comment: Heating by the combustion of biomass
is: heatingProcess
lib: lib:phIoT

blowdown
type: Class
subclass of: marker
comment: Removal from container or pipe
is: marker
lib: lib:phIoT

blowdown-water
type: Class
subclass of: water
comment: Water expelled from a system to remove mineral build up
is: water
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Water

blowdown-water-input
type: Class
subclass of: input
comment: Entity inputs blowdown water which flows from another entity
is: input
lib: lib:phIoT

blowdown-water-output
type: Class
subclass of: output
comment: Entity outputs blowdown water to other entities
is: output
lib: lib:phIoT

blowdownWaterRef
type: ObjectProperty
domain: blowdown-water-input
range: blowdown-water-output
comment: 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

bluetooth
type: Class
subclass of: protocol
comment: Short range wireless communication protocol
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Bluetooth

boiler
type: Class
subclass of: equip
subclass of: elec-input
children: point
  has tag: alarm
  has tag: sensor
  has tag: point
children: equip
  has tag: equip
children: point
  has tag: point
comment: Equipment to generate hot water or steam for heating
is: equip
is: elec-input
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Boiler

bool
type: DatatypeProperty
subclass of: boolean
comment: Boolean value 'true' or 'false'. See [Kinds chapter]`docHaystack::Kinds#bool`.
is: scalar
lib: lib:ph

branchSelector
type: Class
subclass of: vrf-equip
subclass of: refrig-input
children: equip
  has tag: equip
children: point
  has tag: point
comment: 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
is: refrig-input
lib: lib:phIoT

bypass
type: Class
subclass of: pipeSection
comment: Pipe used to bypass an equipment
is: pipeSection
lib: lib:phIoT

cable
type: Class
subclass of: equip
children: equip
  has tag: equip
children: point
  has tag: point
comment: An assembly of one or more insulated conductors.
is: equip
lib: lib:phIoT

cav
type: Class
subclass of: airTerminalUnit
children: duct
  has tag: discharge
  has tag: duct
  has tag: equip
children: equip
  has tag: equip
children: duct
  has tag: inlet
  has tag: duct
  has tag: equip
children: point
  has tag: point
children: thermostat
  has tag: thermostat
  has tag: equip
comment: 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

centrifugal
type: Class
subclass of: marker
comment: Compression via a continuous flow of fluid through an impeller
is: marker
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Centrifugal_compressor

ch2o
type: Class
subclass of: gas
comment: Formaldehyde (CH₂O)
is: gas
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Formaldehyde

ch2o-concentration
type: Class
subclass of: airQuality
comment: Concentration of formaldehyde (CH₂O) in the air.
is: airQuality
lib: lib:phScience
prefUnit: µg/m³
prefUnit: ppb
quantityOf: air
wikipedia: https://en.wikipedia.org/wiki/Concentration

ch4
type: Class
subclass of: gas
comment: Methane (CH₄)
is: gas
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Methane

ch4-emission
type: Class
subclass of: emission
comment: Greenhouse gas emission of methane (CH₄) into the air.
is: emission
lib: lib:phScience
prefUnit: kg
prefUnit: ton
prefUnit: lb
quantityOf: air

children
type: DatatypeProperty
range: list
accumulate: marker
comment: List of prototypes contained by this entity. See [Protos chapter]`docHaystack::Protos` for more details.
is: list
lib: lib:ph
of: dict

childrenFlatten
type: DatatypeProperty
range: list
comment: List of aspects to flatten into children prototypes. See [Protos chapter]`docHaystack::Protos` for more details.
is: list
lib: lib:ph
of: symbol

chilled
type: Class
subclass of: marker
comment: Substance is cooled using cooling process
is: marker
lib: lib:phIoT

chilled-water
type: Class
subclass of: water
comment: Water cooled for use in HVAC and industrial processes
is: water
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Chilled_water

chilled-water-input
type: Class
subclass of: input
comment: Entity inputs chilled water which flows from another entity
is: input
lib: lib:phIoT

chilled-water-output
type: Class
subclass of: output
comment: Entity outputs chilled water to other entities
is: output
lib: lib:phIoT

chilled-water-plant
type: Class
subclass of: plant
subclass of: chilled-water-output
children: pipe
  has tag: chilled
  has tag: water
  has tag: bypass
  has tag: pipe
  has tag: equip
children: point
  has tag: chilled
  has tag: water
  has tag: delta
  has tag: flow
  has tag: point
children: point
  has tag: chilled
  has tag: water
  has tag: delta
  has tag: pressure
  has tag: point
children: point
  has tag: chilled
  has tag: water
  has tag: delta
  has tag: temp
  has tag: point
children: pipe
  has tag: chilled
  has tag: water
  has tag: entering
  has tag: pipe
  has tag: equip
children: pipe
  has tag: chilled
  has tag: water
  has tag: header
  has tag: pipe
  has tag: equip
children: heatExchanger
  has tag: chilled
  has tag: water
  has tag: heatExchanger
  has tag: equip
children: pipe
  has tag: chilled
  has tag: water
  has tag: leaving
  has tag: pipe
  has tag: equip
children: point
  has tag: chilled
  has tag: water
  has tag: mixing
  has tag: valve
  has tag: cmd
  has tag: point
children: chiller
  has tag: chiller
  has tag: equip
children: pipe
  has tag: condenser
  has tag: water
  has tag: bypass
  has tag: pipe
  has tag: equip
children: point
  has tag: condenser
  has tag: water
  has tag: delta
  has tag: flow
  has tag: sensor
  has tag: point
children: point
  has tag: condenser
  has tag: water
  has tag: delta
  has tag: pressure
  has tag: sensor
  has tag: point
children: point
  has tag: condenser
  has tag: water
  has tag: delta
  has tag: temp
  has tag: sensor
  has tag: point
children: coolingTower
  has tag: coolingTower
  has tag: equip
children: point
  has tag: enable
  has tag: cmd
  has tag: point
children: equip
  has tag: equip
children: point
  has tag: point
comment: Plant used to generate chilled water for cooling. See `docHaystack::Plants`.
is: plant
is: chilled-water-output
lib: lib:phIoT

chilled-water-system
type: Class
subclass of: water-system
children: equip
  has tag: equip
children: point
  has tag: point
comment: System that circulates water in its liquid state below ambient temperature for cooling a space or process.
is: water-system
lib: lib:phIoT

chilledBeam
type: Class
subclass of: radiantEquip
children: equip
  has tag: equip
children: point
  has tag: point
comment: Conditions a space using a heat exchanger integrated into the ceiling
is: radiantEquip
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Chilled_beam

chilledBeamZone
type: Class
subclass of: ahuZoneDelivery
comment: AHU supplies air to chilled beam terminal units
is: ahuZoneDelivery
lib: lib:phIoT

chilledWaterCooling
type: Class
subclass of: coolingProcess
subclass of: chilled-water-input
comment: Cooling using transfer of heat to chilled water
is: coolingProcess
is: chilled-water-input
lib: lib:phIoT

chilledWaterRef
type: ObjectProperty
domain: chilled-water-input
range: chilled-water-output
comment: 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

chiller
type: Class
subclass of: equip
subclass of: elec-input
children: point
  has tag: alarm
  has tag: sensor
  has tag: point
children: point
  has tag: chilled
  has tag: water
  has tag: delta
  has tag: flow
  has tag: sensor
  has tag: point
children: point
  has tag: chilled
  has tag: water
  has tag: delta
  has tag: temp
  has tag: sensor
  has tag: point
children: pipe
  has tag: chilled
  has tag: water
  has tag: entering
  has tag: pipe
  has tag: equip
children: pipe
  has tag: chilled
  has tag: water
  has tag: leaving
  has tag: pipe
  has tag: equip
children: point
  has tag: chilled
  has tag: water
  has tag: valve
  has tag: isolation
  has tag: cmd
  has tag: point
children: point
  has tag: condenser
  has tag: refrig
  has tag: pressure
  has tag: sensor
  has tag: point
children: point
  has tag: condenser
  has tag: refrig
  has tag: temp
  has tag: sensor
  has tag: point
children: point
  has tag: condenser
  has tag: run
  has tag: cmd
  has tag: point
children: point
  has tag: condenser
  has tag: run
  has tag: sensor
  has tag: point
children: pipe
  has tag: condenser
  has tag: water
  has tag: entering
  has tag: pipe
  has tag: equip
children: pipe
  has tag: condenser
  has tag: water
  has tag: leaving
  has tag: pipe
  has tag: equip
children: point
  has tag: condenser
  has tag: water
  has tag: valve
  has tag: isolation
  has tag: cmd
  has tag: point
children: point
  has tag: efficiency
  has tag: sensor
  has tag: point
children: point
  has tag: enable
  has tag: cmd
  has tag: point
children: point
  has tag: enable
  has tag: sensor
  has tag: point
children: equip
  has tag: equip
children: point
  has tag: evaporator
  has tag: refrig
  has tag: pressure
  has tag: sensor
  has tag: point
children: point
  has tag: evaporator
  has tag: refrig
  has tag: temp
  has tag: sensor
  has tag: point
children: point
  has tag: load
  has tag: cmd
  has tag: point
children: point
  has tag: load
  has tag: sensor
  has tag: point
children: point
  has tag: point
children: point
  has tag: run
  has tag: cmd
  has tag: point
children: point
  has tag: run
  has tag: sensor
  has tag: point
comment: Equipment to remove heat from a liquid. Chillers typically use a vapor compression or an absorption refrigeration cycle.
is: equip
is: elec-input
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Chiller

chiller-absorption
type: Class
subclass of: absorption
subclass of: chillerMechanism
comment: Cooling process using energy from heat source such as hot water
is: absorption
is: chillerMechanism
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Absorption_refrigerator

chiller-centrifugal
type: Class
subclass of: centrifugal
subclass of: chillerMechanism
comment: Compression via a continuous flow of fluid through an impeller
is: centrifugal
is: chillerMechanism
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Centrifugal_compressor

chiller-reciprocal
type: Class
subclass of: reciprocal
subclass of: chillerMechanism
comment: Piston compressor driven by a crankshaft
is: reciprocal
is: chillerMechanism
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Reciprocating_compressor

chiller-rotaryScrew
type: Class
subclass of: rotaryScrew
subclass of: chillerMechanism
comment: Rotary screw compression
is: rotaryScrew
is: chillerMechanism
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Rotary-screw_compressor

chillerMechanism
type: Class
subclass of: choice
comment: Primary mechanism of chiller
is: choice
lib: lib:phIoT
tagOn: chiller

choice
type: Class
subclass of: marker
comment: Choice specifies an exclusive marker selection. See [Choices]`docHaystack::Choices` chapter.
docTaxonomy: marker
is: marker
lib: lib:ph

circ
type: Class
subclass of: pipeSection
comment: Pipe used to circulate fluid through an equipment or system
is: pipeSection
lib: lib:phIoT

circuit
type: Class
subclass of: equip
subclass of: elec-input
subclass of: elec-output
children: equip
  has tag: equip
children: point
  has tag: point
comment: Electrical circuit and its associated components such as breakers. See `docHaystack::ElecPanels#circuits` chapter.
is: equip
is: elec-input
is: elec-output
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Electrical_network

cloudage
type: Class
subclass of: quantity
comment: Percentage of sky obscured by clouds. This is also known as cloudiness, or cloud amount.
is: quantity
lib: lib:phScience
prefUnit: %
quantityOf: weather

cmd
type: Class
subclass of: pointFunction
comment: Point is a command, actuator, AO/BO. See `docHaystack::Points#function` chapter.
is: pointFunction
lib: lib:phIoT

co
type: Class
subclass of: gas
comment: Carbon monoxide (CO)
is: gas
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Carbon_monoxide

co-concentration
type: Class
subclass of: airQuality
comment: Concentration of carbon monoxide (CO) in the air.
is: airQuality
lib: lib:phScience
prefUnit: ppm
quantityOf: air
wikipedia: https://en.wikipedia.org/wiki/Concentration

co2
type: Class
subclass of: gas
comment: Carbon dioxide (CO₂)
is: gas
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Carbon_dioxide

co2-concentration
type: Class
subclass of: airQuality
comment: Concentration of carbon dioxide (CO₂) in the air.
is: airQuality
lib: lib:phScience
prefUnit: ppm
quantityOf: air
wikipedia: https://en.wikipedia.org/wiki/Concentration

co2-emission
type: Class
subclass of: emission
comment: Greenhouse gas emission of carbon dioxide (CO₂) into the air.
is: emission
lib: lib:phScience
prefUnit: kg
prefUnit: ton
prefUnit: lb
quantityOf: air

co2e
type: Class
subclass of: marker
comment: Carbon dioxide equivalent
is: marker
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Global_warming_potential

coal
type: Class
subclass of: solid
comment: Combustible sedimentary rock
is: solid
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Coal

coalHeating
type: Class
subclass of: heatingProcess
comment: Heating by the combustion of coal
is: heatingProcess
lib: lib:phIoT

coap
type: Class
subclass of: protocol
comment: Constrained Application Protocol
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Constrained_Application_Protocol

coil
type: Class
subclass of: heatExchanger
children: equip
  has tag: equip
children: point
  has tag: point
comment: 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

cold
type: Class
subclass of: marker
comment: Having low degree of heat
is: marker
lib: lib:phIoT

cold-water
type: Class
subclass of: water
comment: Water supplied to cold taps
is: water
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Water

coldDeck
type: Class
subclass of: ductDeck
comment: Duct carries air for cooling
is: ductDeck
lib: lib:phIoT

compressor
type: Class
subclass of: marker
comment: Device for mechanically increasing the pressure of a gas or refrigerant vapor by reducing its volume.
is: marker
lib: lib:phIoT

computed
type: Class
subclass of: synthetic
comment: Computed point. See `docHaystack::Synthetics` chapter.
is: synthetic
lib: lib:phIoT

computed-point
type: Class
subclass of: synthetic-point
comment: See `docHaystack::Synthetics` chapter.
is: synthetic-point
lib: lib:phIoT

computedFromReciprocal
type: Class
subclass of: marker
comment: Indicates a relationship that is computed from its reciprocal. Computed defs cannot be used as tags themselves.
is: marker
lib: lib:ph

computedModel
type: Class
subclass of: syntheticModel
comment: See `docHaystack::Synthetics` chapter.
is: syntheticModel
lib: lib:phIoT

computer
type: Class
subclass of: device
comment: General purpose computer.
is: device
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Computer

concentration
type: Class
subclass of: quantity
comment: Abundance of substance in the total volume of a mixture.
is: quantity
lib: lib:phScience
quantityOf: substance
wikipedia: https://en.wikipedia.org/wiki/Concentration

condensate
type: Class
subclass of: liquid
comment: Liquid phase produced by the condensation of steam or other gas
is: liquid
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Liquid

condensate-input
type: Class
subclass of: input
comment: Entity inputs condensate which flows from another entity
is: input
lib: lib:phIoT

condensate-output
type: Class
subclass of: output
comment: Entity outputs condensate to other entities
is: output
lib: lib:phIoT

condensateRef
type: ObjectProperty
domain: condensate-input
range: condensate-output
comment: Condensate flows from the referent to this entity
inputs: condensate
is: ref
lib: lib:phIoT
of: condensate-output
tagOn: condensate-input

condenser
type: Class
subclass of: marker
comment: Device or related to process of condensation
is: marker
lib: lib:phIoT

condenser-water
type: Class
subclass of: water
comment: Water used used to remove heat through condensation
is: water
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Water

condenser-water-input
type: Class
subclass of: input
comment: Entity inputs condenser water which flows from another entity
is: input
lib: lib:phIoT

condenser-water-output
type: Class
subclass of: output
comment: Entity outputs condenser water to other entities
is: output
lib: lib:phIoT

condenser-water-system
type: Class
subclass of: water-system
children: equip
  has tag: equip
children: point
  has tag: point
comment: System that circulates water in its liquid state for rejecting heat from a space or process.
is: water-system
lib: lib:phIoT

condenserClosedLoop
type: Class
subclass of: condenserLoop
comment: Working fluid is kept separate from fluid used for heat transfer into the atmosphere
is: condenserLoop
lib: lib:phIoT

condenserCooling
type: Class
subclass of: coolingProcess
comment: Removal of heat through the process of water condensation
is: coolingProcess
lib: lib:phIoT

condenserLoop
type: Class
subclass of: choice
comment: Open or closed loop for condenser working fluid
is: choice
lib: lib:phIoT
tagOn: chilled-water-plant

condenserOpenLoop
type: Class
subclass of: condenserLoop
comment: Uses working fluid itself for evaporation into the atmosphere
is: condenserLoop
lib: lib:phIoT

condenserWaterRef
type: ObjectProperty
domain: condenser-water-input
range: condenser-water-output
comment: 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

conditioning
type: Class
subclass of: marker
comment: Related to cleaning, heating, cooling, humidifying, dehumidifying, ventilating or circulating air.
is: marker
lib: lib:phIoT

conduit
type: Class
subclass of: equip
children: equip
  has tag: equip
children: point
  has tag: point
comment: Duct, pipe, or cable to convey a substance or phenomenon
is: equip
lib: lib:phIoT

constantAirVolume
type: Class
subclass of: airVolumeAdjustability
comment: Delivers a constant volume of air flow. Typically this means equipment with a single speed fan.
is: airVolumeAdjustability
lib: lib:phIoT

containedBy
type: DatatypeProperty
range: symbol
comment: The entity is logically contained by the referent.
is: relationship
lib: lib:ph
reciprocalOf: contains
transitive: marker

contains
type: DatatypeProperty
range: symbol
computedFromReciprocal: marker
comment: Entities logically contained by this entity
is: relationship
lib: lib:ph
reciprocalOf: containedBy
transitive: marker

controller
type: Class
subclass of: device
comment: 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

controls
type: Class
subclass of: marker
comment: Associated with the control system for an industrial process
is: marker
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Control_system

controls-panel
type: Class
subclass of: panel
children: controller
  has tag: controller
  has tag: device
children: equip
  has tag: equip
children: networking-device
  has tag: networking
  has tag: device
children: point
  has tag: point
comment: Panel housing controllers and networking gear
is: panel
lib: lib:phIct

cool
type: Class
subclass of: marker
comment: 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

cool-water
type: Class
subclass of: water
comment: Relatively cool water without active chilling
is: water
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Water

cooling
type: Class
subclass of: marker
comment: Cooling mode or process
is: marker
lib: lib:phIoT

coolingCapacity
type: DatatypeProperty
domain: chiller
range: number
comment: Measurement of a chiller ability to remove heat measured
is: number
lib: lib:phIoT
prefUnit: tonref
prefUnit: BTU/h
prefUnit: kW
tagOn: chiller

coolingCoil
type: Class
subclass of: coil
children: point
  has tag: chilled
  has tag: water
  has tag: cool
  has tag: valve
  has tag: cmd
  has tag: point
children: equip
  has tag: equip
children: point
  has tag: point
children: point
  has tag: cool
  has tag: run
  has tag: cmd
  has tag: point
  stage: 1
childrenFlatten: ductDeck
childrenFlatten: ductSection
comment: Coil used to cool air.
is: coil
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Heat_exchanger#HVAC_air_coils

coolingOnly
type: Class
subclass of: marker
comment: Equipment without heating
is: marker
lib: lib:phIoT

coolingProcess
type: Class
subclass of: choice
comment: Processed used to cool a substance
is: choice
lib: lib:phIoT
tagOn: airHandlingEquip
tagOn: chilledBeam
tagOn: coolingCoil

coolingTower
type: Class
subclass of: equip
subclass of: elec-input
children: pipe
  has tag: condenser
  has tag: water
  has tag: entering
  has tag: pipe
  has tag: equip
children: pipe
  has tag: condenser
  has tag: water
  has tag: leaving
  has tag: pipe
  has tag: equip
children: equip
  has tag: equip
children: fan-motor
  has tag: fan
  has tag: motor
  has tag: equip
children: point
  has tag: point
comment: Equipment to transfer waste heat into the atmosphere
is: equip
is: elec-input
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Cooling_tower

coord
type: DatatypeProperty
subclass of: string
comment: Geographic coordinate in latitude/longitude in decimal degrees. See [Kinds chapter]`docHaystack::Kinds#coord`.
is: scalar
lib: lib:ph

crac
type: Class
subclass of: fcu
children: point
  has tag: bypass
  has tag: damper
  has tag: cmd
  has tag: point
children: point
  has tag: cool
  has tag: cmd
  has tag: point
children: point
  has tag: dessicantDehumidifier
  has tag: cmd
  has tag: point
children: duct
  has tag: discharge
  has tag: duct
  has tag: equip
children: duct
  has tag: economizer
  has tag: duct
  has tag: equip
children: point
  has tag: economizing
  has tag: cmd
  has tag: point
children: equip
  has tag: equip
children: duct
  has tag: exhaust
  has tag: duct
  has tag: equip
children: point
  has tag: faceBypass
  has tag: cmd
  has tag: point
children: point
  has tag: filter
  has tag: sensor
  has tag: point
children: point
  has tag: freezeStat
  has tag: sensor
  has tag: point
children: point
  has tag: heat
  has tag: cmd
  has tag: point
children: point
  has tag: heatWheel
  has tag: cmd
  has tag: point
children: humidifier-equip
  has tag: humidifier
  has tag: equip
children: point
  has tag: hvacMode
  has tag: sp
  has tag: point
children: duct
  has tag: mixed
  has tag: duct
  has tag: equip
children: duct
  has tag: outside
  has tag: duct
  has tag: equip
children: point
  has tag: point
children: duct
  has tag: return
  has tag: duct
  has tag: equip
children: thermostat
  has tag: thermostat
  has tag: equip
children: duct
  has tag: ventilation
  has tag: duct
  has tag: equip
comment: 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

cur
type: Class
subclass of: marker
comment: Supports current value
is: marker
lib: lib:phIoT
tagOn: point

cur-point
type: Class
subclass of: point
comment: 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

curErr
type: DatatypeProperty
domain: cur-point
range: str
comment: Error description when `curStatus` indicates error condition
is: str
lib: lib:phIoT
tagOn: cur-point
transient: marker

curStatus
type: DatatypeProperty
domain: cur-point
range: str
comment: 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: marker

curVal
type: DatatypeProperty
subclass of: Literal
comment: 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: marker

current
type: Class
subclass of: marker
comment: Movement of fluid or electricity
is: marker
lib: lib:phScience

current-angle
type: Class
subclass of: quantity
comment: AC current phase angle
is: quantity
lib: lib:phIoT
prefUnit: deg
quantityOf: ac-elec

current-imbalance
type: Class
subclass of: quantity
comment: Current phase imbalance in a multiphase AC system
is: quantity
lib: lib:phIoT
prefUnit: %
quantityOf: ac-elec

current-magnitude
type: Class
subclass of: elec-current
comment: Magnitude of electrical current
is: elec-current
lib: lib:phIoT
prefUnit: A
quantityOf: ac-elec

current-thd
type: Class
subclass of: quantity
comment: Total harmonic current distortion
is: quantity
lib: lib:phIoT
prefUnit: %
quantityOf: ac-elec

dali
type: Class
subclass of: protocol
comment: Digital Addressable Lighting Interface protocol for lighting
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Digital_Addressable_Lighting_Interface

damper
type: Class
subclass of: marker
comment: Damper equipment or control point.
is: marker
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Damper_(flow)

damper-actuator
type: Class
subclass of: actuator
children: point
  has tag: damper
  has tag: cmd
  has tag: point
children: point
  has tag: damper
  has tag: sensor
  has tag: point
children: equip
  has tag: equip
children: point
  has tag: point
childrenFlatten: ductSection
comment: Actuator to regulate the flow of air.
is: actuator
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Damper_(flow)

dataCenter
type: Class
subclass of: space
children: crac
  has tag: crac
  has tag: fcu
  has tag: equip
children: equip
  has tag: equip
children: point
  has tag: point
children: rack
  has tag: rack
  has tag: equip
children: space
  has tag: space
comment: 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

date
type: DatatypeProperty
subclass of: date
comment: ISO 8601 date as year, month, day: '2011-06-07'. See [Kinds chapter]`docHaystack::Kinds#date`.
is: scalar
lib: lib:ph

dateTime
type: DatatypeProperty
subclass of: dateTime
comment: ISO 8601 timestamp followed by timezone identifier. See [Kinds chapter]`docHaystack::Kinds#dateTime`.
is: scalar
lib: lib:ph

daytime
type: Class
subclass of: quantity
comment: 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

dc
type: Class
subclass of: marker
comment: Relating to direct current electricity
is: marker
lib: lib:phIoT

dc-elec
type: Class
subclass of: elec
comment: Direct current electricity
is: elec
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Direct_current

dc-elec-meter
type: Class
subclass of: elec-meter
children: equip
  has tag: equip
children: point
  has tag: point
comment: DC Electricity meter. See `docHaystack::Meters` chapter.
is: elec-meter
lib: lib:phIoT

dc-evse-port
type: Class
subclass of: evse-port
children: point
  has tag: dc
  has tag: elec
  has tag: stateOfCharge
  has tag: sensor
  has tag: point
children: equip
  has tag: equip
children: cable
  type: evse-cable
  has tag: evse
  has tag: cable
  has tag: equip
children: point
  has tag: evse
  has tag: evseStatus
  has tag: sensor
  has tag: point
children: point
  has tag: import
  has tag: dc
  has tag: elec
  has tag: current
  has tag: max
  has tag: sp
  has tag: point
children: point
  has tag: import
  has tag: dc
  has tag: elec
  has tag: current
  has tag: sensor
  has tag: point
children: point
  has tag: import
  has tag: dc
  has tag: elec
  has tag: energy
  has tag: hisTotalized
  has tag: sensor
  has tag: point
children: point
  has tag: import
  has tag: dc
  has tag: elec
  has tag: power
  has tag: max
  has tag: sp
  has tag: point
children: point
  has tag: import
  has tag: dc
  has tag: elec
  has tag: power
  has tag: sensor
  has tag: point
children: point
  has tag: import
  has tag: dc
  has tag: elec
  has tag: volt
  has tag: sensor
  has tag: point
children: point
  has tag: point
comment: 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

deadband
type: Class
subclass of: marker
comment: 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
type: DatatypeProperty
range: symbol
comment: Create a new definition bound to the given symbol. See [Defs chapter]`docHaystack::Defs`.
is: symbol
lib: lib:ph

defx
type: DatatypeProperty
range: symbol
comment: Extends the given definition with additional meta tags. See [Normalization]`docHaystack::Normalization#defx`.
is: symbol
lib: lib:ph

delta
type: Class
subclass of: marker
comment: Differential of fluid between entering and leaving sensors.
is: marker
lib: lib:phIoT

demand
type: Class
subclass of: marker
comment: Rate required for a process.
is: marker
lib: lib:phIoT

depends
type: DatatypeProperty
domain: lib
range: list
comment: 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

deprecated
type: Class
subclass of: marker
comment: Obsoleted
is: marker
lib: lib:ph

design
type: Class
subclass of: marker
comment: 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

dessicantDehumidifier
type: Class
subclass of: marker
comment: Decreases humidity from air using a substance which absorbs moisture.
is: marker
lib: lib:phIoT

device
type: Class
subclass of: entity
comment: 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: marker
is: entity
lib: lib:phIct
mandatory: marker

deviceRef
type: ObjectProperty
range: device
comment: Device which controls a monitors this entity
is: ref
lib: lib:phIct
of: device

dewPoint
type: Class
subclass of: quantity
comment: Dew point temperature at which water vapor will form dew
is: quantity
lib: lib:phScience
prefUnit: °C
prefUnit: °F
quantityOf: air

dict
type: DatatypeProperty
comment: Map of name/value tag pairs. See [Kinds chapter]`docHaystack::Kinds#dict`.
is: val
lib: lib:ph

diesel
type: Class
subclass of: liquid
comment: Liquid fuel specifically designed for use in diesel engines
is: liquid
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Diesel_fuel

directZone
type: Class
subclass of: ahuZoneDelivery
comment: AHU supplies air directly to the zone
is: ahuZoneDelivery
lib: lib:phIoT

direction
type: Class
subclass of: quantity
comment: Compass direction measured in degrees: North: 0° = 360°, East: 90°, South: 180°, West: 270°
is: quantity
lib: lib:phScience
prefUnit: deg

dis
type: DatatypeProperty
domain: entity
range: str
comment: Display name for an entity. See `docHaystack::Ontology#entities` chapter.
is: str
lib: lib:ph
tagOn: entity

discharge
type: Class
subclass of: ductSection
comment: Duct for air leaving an equipment
is: ductSection
lib: lib:phIoT

dispenser
type: Class
subclass of: marker
comment: Equipment that releases a specific amount of a substance.
is: marker
lib: lib:phIoT

diverting
type: Class
subclass of: marker
comment: Three way valve which inputs one pipe and diverts between two output pipes.
is: marker
lib: lib:phIoT

doas
type: Class
subclass of: ahu
children: point
  has tag: bypass
  has tag: damper
  has tag: cmd
  has tag: point
children: point
  has tag: cool
  has tag: cmd
  has tag: point
children: point
  has tag: dessicantDehumidifier
  has tag: cmd
  has tag: point
children: duct
  has tag: discharge
  has tag: duct
  has tag: equip
children: duct
  has tag: economizer
  has tag: duct
  has tag: equip
children: point
  has tag: economizing
  has tag: cmd
  has tag: point
children: equip
  has tag: equip
children: duct
  has tag: exhaust
  has tag: duct
  has tag: equip
children: point
  has tag: faceBypass
  has tag: cmd
  has tag: point
children: point
  has tag: filter
  has tag: sensor
  has tag: point
children: point
  has tag: freezeStat
  has tag: sensor
  has tag: point
children: point
  has tag: heat
  has tag: cmd
  has tag: point
children: point
  has tag: heatWheel
  has tag: cmd
  has tag: point
children: humidifier-equip
  has tag: humidifier
  has tag: equip
children: point
  has tag: hvacMode
  has tag: sp
  has tag: point
children: duct
  has tag: mixed
  has tag: duct
  has tag: equip
children: duct
  has tag: outside
  has tag: duct
  has tag: equip
children: point
  has tag: point
children: duct
  has tag: return
  has tag: duct
  has tag: equip
children: thermostat
  has tag: thermostat
  has tag: equip
children: duct
  has tag: ventilation
  has tag: duct
  has tag: equip
comment: 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

doc
type: DatatypeProperty
domain: def
range: str
comment: 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"
is: str
lib: lib:ph
tagOn: def

docAssociations
type: Class
subclass of: marker
comment: Generate a section in the docs for this association.
is: marker
lib: lib:ph

docTaxonomy
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:ph
notInherited: marker

domestic
type: Class
subclass of: marker
comment: For human use
is: marker
lib: lib:phIoT

domestic-cold-water-system
type: Class
subclass of: domestic-water-system
children: equip
  has tag: equip
children: point
  has tag: point
comment: System that circulates potable cold water in its liquid state for purposes other than space cooling and process requirements.
is: domestic-water-system
lib: lib:phIoT

domestic-hot-water-system
type: Class
subclass of: domestic-water-system
children: equip
  has tag: equip
children: point
  has tag: point
comment: System that circulates potable hot water in its liquid state for purposes other than space heating and process requirements.
is: domestic-water-system
lib: lib:phIoT

domestic-water
type: Class
subclass of: water
comment: Tap water for drinking, washing, cooking, and flushing of toilets
is: water
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Water

domestic-water-input
type: Class
subclass of: input
comment: Entity inputs domestic water which flows from another entity
is: input
lib: lib:phIoT

domestic-water-output
type: Class
subclass of: output
comment: Entity outputs domestic water to other entities
is: output
lib: lib:phIoT

domestic-water-system
type: Class
subclass of: water-system
children: equip
  has tag: equip
children: point
  has tag: point
comment: System that circulates potable water in its liquid state for purposes other than space conditioning and process requirements.
is: water-system
lib: lib:phIoT

domesticWaterRef
type: ObjectProperty
domain: domestic-water-input
range: domestic-water-output
comment: Domestic water flows from the referent to this entity
inputs: domestic-water
is: ref
lib: lib:phIoT
of: domestic-water-output
tagOn: domestic-water-input

dualDuct
type: Class
subclass of: ductConfig
comment: Two ducts: combination of hotDeck, coldDeck, or neutralDeck
is: ductConfig
lib: lib:phIoT

duct
type: Class
subclass of: conduit
children: point
  has tag: air
  has tag: co2
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: air
  has tag: co2
  has tag: concentration
  has tag: sp
  has tag: point
children: point
  has tag: air
  has tag: dewPoint
  has tag: sensor
  has tag: point
children: point
  has tag: air
  has tag: dewPoint
  has tag: sp
  has tag: point
children: point
  has tag: air
  has tag: enthalpy
  has tag: sensor
  has tag: point
children: point
  has tag: air
  has tag: enthalpy
  has tag: sp
  has tag: point
children: point
  has tag: air
  has tag: flow
  has tag: sensor
  has tag: point
children: point
  has tag: air
  has tag: flow
  has tag: sp
  has tag: point
children: point
  has tag: air
  has tag: humidity
  has tag: sensor
  has tag: point
children: point
  has tag: air
  has tag: humidity
  has tag: sp
  has tag: point
children: point
  has tag: air
  has tag: pressure
  has tag: sensor
  has tag: point
children: point
  has tag: air
  has tag: pressure
  has tag: sp
  has tag: point
children: point
  has tag: air
  has tag: temp
  has tag: sensor
  has tag: point
children: point
  has tag: air
  has tag: temp
  has tag: sp
  has tag: point
children: coolingCoil
  has tag: coolingCoil
  has tag: equip
children: damper-actuator
  has tag: damper
  has tag: actuator
  has tag: equip
children: equip
  has tag: equip
children: fan-motor
  has tag: fan
  has tag: motor
  has tag: equip
children: heatingCoil
  has tag: heatingCoil
  has tag: equip
children: point
  has tag: point
childrenFlatten: ductDeck
childrenFlatten: ductSection
comment: Conduit used to convey air for HVAC
is: conduit
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Duct_(flow)

ductArea
type: Class
subclass of: marker
comment: Config point on a `vav` for duct area measured in ft² or m²
is: marker
lib: lib:phIoT

ductConfig
type: Class
subclass of: choice
comment: Ductwork configuration
is: choice
lib: lib:phIoT
tagOn: airHandlingEquip
tagOn: airTerminalUnit

ductDeck
type: Class
subclass of: choice
comment: 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.
is: choice
lib: lib:phIoT
tagOn: duct
tagOn: airHandlingEquip

ductSection
type: Class
subclass of: choice
comment: Equipment section of ductwork
is: choice
lib: lib:phIoT
tagOn: duct
tagOn: damper-actuator
tagOn: fan-motor

duration
type: DatatypeProperty
range: number
comment: Number with a unit of time
is: number
lib: lib:ph

dxCooling
type: Class
subclass of: coolingProcess
comment: Cooling using direct expansion of a refrigerant vapor. Also see `dxHeating` and `heatPump`.
is: coolingProcess
lib: lib:phIoT

dxHeating
type: Class
subclass of: heatingProcess
comment: Heating using direct expansion of a refrigerant vapor. Also see `dxCooling` and `heatPump`.
is: heatingProcess
lib: lib:phIoT

economizer
type: Class
subclass of: ductSection
comment: Duct to access fresh outside air only for economizing, not ventilation
is: ductSection
lib: lib:phIoT

economizing
type: Class
subclass of: marker
comment: Energy reduction mode which augments heating/cooling with outside air.
is: marker
lib: lib:phIoT

effective
type: Class
subclass of: marker
comment: Current control setpoint in effect taking into account other factors
is: marker
lib: lib:phIoT

efficiency
type: Class
subclass of: marker
comment: Efficiency point of a chiller measured in "COP" or "kW/ton".
is: marker
lib: lib:phIoT

elec
type: Class
subclass of: phenomenon
comment: Associated with electricity or with electrical force, power, or energy. This is often opposed to `mech` mechanical energy.
is: phenomenon
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Electricity

elec-current
type: Class
subclass of: quantity
comment: Electrical current
is: quantity
lib: lib:phScience
quantityOf: elec

elec-demand
type: Class
subclass of: active-power
comment: Active power averaged over a rolling interval. For utility meters the demand interval is based on the billing period.
is: active-power
lib: lib:phIoT
prefUnit: kW
quantityOf: ac-elec

elec-energy
type: Class
subclass of: energy
comment: Electrical energy consumed
is: energy
lib: lib:phScience
prefUnit: kWh
quantityOf: elec

elec-input
type: Class
subclass of: input
comment: Entity inputs electricity which flows from another entity
is: input
lib: lib:phIoT

elec-meter
type: Class
subclass of: meter
subclass of: elec-input
subclass of: elec-output
children: equip
  has tag: equip
children: point
  has tag: point
comment: Electricity meter
is: meter
is: elec-input
is: elec-output
lib: lib:phIoT

elec-output
type: Class
subclass of: output
comment: Entity outputs electricity to other entities
is: output
lib: lib:phIoT

elec-panel
type: Class
subclass of: panel
subclass of: elec-input
subclass of: elec-output
children: equip
  has tag: equip
children: point
  has tag: point
comment: Physical housing for electrical circuits, fuses, and breakers. See `docHaystack::ElecPanels#panels` chapter.
is: panel
is: elec-input
is: elec-output
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Distribution_board

elec-power
type: Class
subclass of: power
comment: Electrical energy consumed per unit time
is: power
lib: lib:phScience
prefUnit: kW
quantityOf: elec

elec-system
type: Class
subclass of: system
children: equip
  has tag: equip
children: point
  has tag: point
comment: System that generates, converts, distributes, and/or stores electricity.
is: system
lib: lib:phIoT

elec-volt
type: Class
subclass of: quantity
comment: Electrical voltage, potential difference
is: quantity
lib: lib:phScience
quantityOf: elec

elecHeating
type: Class
subclass of: heatingProcess
subclass of: elec-input
comment: Heating by the conversion of electrical energy
is: heatingProcess
is: elec-input
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Electric_heating

elecLine
type: DatatypeProperty
range: str
comment: Single-phase line measurement of an electric quantity in an AC electric power system.
enum: - L1: line 1 measurement - L2: line 2 measurement - L3: line 3 measurement
is: str
lib: lib:phIoT

elecLineToLine
type: DatatypeProperty
range: str
comment: Single-phase electric quantity measured line-to-line in an AC electric power system.
enum: - L1-L2: line 1 to line 2 measurement - L2-L3: line 2 to line 3 measurement - L3-L1: line 3 to line 1 measurement
is: str
lib: lib:phIoT

elecLineToNeutral
type: DatatypeProperty
range: str
comment: Single-phase electric quantity measured line-to-neutral in an AC electric power system.
enum: - L1-N: line 1 to neutral measurement - L2-N: line 2 to neutral measurement - L3-N: line 3 to neutral measurement
is: str
lib: lib:phIoT

elecRef
type: ObjectProperty
domain: elec-input
range: elec-output
comment: Electricity flows from the referent to this entity
inputs: elec
is: ref
lib: lib:phIoT
of: elec-output
tagOn: elec-input

elevator
type: Class
subclass of: verticalTransport
subclass of: elec-input
children: equip
  has tag: equip
children: point
  has tag: point
comment: Enclosure used to move people between floors.
is: verticalTransport
is: elec-input
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Elevator

emission
type: Class
subclass of: quantity
comment: Amount of a substance discharged into the air
is: quantity
lib: lib:phScience
quantityOf: air

enable
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:phIoT

energy
type: Class
subclass of: quantity
comment: Measure of ability to do work
is: quantity
lib: lib:phScience

entering
type: Class
subclass of: pipeSection
comment: Pipe conveys fluid into an equipment
is: pipeSection
lib: lib:phIoT

enthalpy
type: Class
subclass of: quantity
comment: Total heat content of a system. It is defined as internal energy of the system plus the product of pressure and volume.
is: quantity
lib: lib:phScience
prefUnit: kJ/kg
prefUnit: BTU/lb
quantityOf: air

entity
type: Class
subclass of: marker
comment: Top-level dicts with a unique identifier. See `docHaystack::Ontology#entities` chapter.
is: marker
lib: lib:ph

enum
type: DatatypeProperty
domain: def
domain: point
comment: 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.
is: val
lib: lib:ph
tagOn: def
tagOn: point

equip
type: Class
subclass of: entity
children: equip
  has tag: equip
children: point
  has tag: point
comment: Equipment asset. See `docHaystack::Equips` chapter.
docTaxonomy: marker
is: entity
lib: lib:phIoT
mandatory: marker

equipRef
type: ObjectProperty
domain: controller
domain: equip
domain: point
range: equip
containedBy: equip
comment: Reference to equip which contains this entity
is: ref
lib: lib:phIoT
of: equip
tagOn: controller
tagOn: equip
tagOn: point

escalator
type: Class
subclass of: verticalTransport
subclass of: elec-input
children: equip
  has tag: equip
children: point
  has tag: point
comment: Moving staircase used to move people between floors.
is: verticalTransport
is: elec-input
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Escalator

evaporator
type: Class
subclass of: marker
comment: Mechanism used to convert a refrigerant from its liquid to gaseous state.
is: marker
lib: lib:phIoT

evse
type: Class
subclass of: marker
comment: Electric Vehicle Supply Equipment. See `docHaystack::EVSE` chapter.
is: marker
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Charging_station

evse-cable
type: Class
subclass of: evse-equip
children: equip
  has tag: equip
children: point
  has tag: point
comment: 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.
is: evse-equip
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Charging_station

evse-dispenser
type: Class
subclass of: evse-equip
children: equip
  has tag: equip
children: point
  has tag: evse
  has tag: evseStatus
  has tag: sensor
  has tag: point
children: evse-port
  has tag: evse
  has tag: port
  has tag: equip
children: point
  has tag: import
  has tag: ac
  has tag: elec
  has tag: magnitude
  has tag: current
  has tag: max
  has tag: sp
  has tag: point
children: point
  has tag: import
  has tag: dc
  has tag: elec
  has tag: power
  has tag: max
  has tag: sp
  has tag: point
children: point
  has tag: point
comment: 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.
is: evse-equip
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Charging_station

evse-equip
type: Class
subclass of: equip
subclass of: elec-input
subclass of: elec-output
children: equip
  has tag: equip
children: point
  has tag: point
comment: Equipment that supports the delivery of electricity to charging inlets located on EVs. See `docHaystack::EVSE` chapter.
is: equip
is: elec-input
is: elec-output
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Charging_station

evse-port
type: Class
subclass of: evse-equip
subclass of: elec-meter
children: equip
  has tag: equip
children: cable
  type: evse-cable
  has tag: evse
  has tag: cable
  has tag: equip
children: point
  has tag: evse
  has tag: evseStatus
  has tag: sensor
  has tag: point
children: point
  has tag: point
comment: 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.
is: evse-equip
is: elec-meter
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Charging_station

evse-powerConverter
type: Class
subclass of: evse-equip
children: equip
  has tag: equip
children: point
  has tag: evse
  has tag: evseStatus
  has tag: sensor
  has tag: point
children: evse-port
  has tag: evse
  has tag: port
  has tag: equip
children: point
  has tag: import
  has tag: dc
  has tag: elec
  has tag: power
  has tag: max
  has tag: sp
  has tag: point
children: point
  has tag: point
comment: 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.
is: evse-equip
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Charging_station

evse-system
type: Class
subclass of: elec-system
children: equip
  has tag: equip
children: point
  has tag: point
comment: A system that supplies electricity to EVSE assembly equipment and its auxiliary loads.
is: elec-system
lib: lib:phIoT

evseCableType
type: DatatypeProperty
domain: evse-cable
range: str
comment: Physical type of `evse-cable`.
enum: - 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
is: str
lib: lib:phIoT
tagOn: evse-cable

evseSession
type: Class
subclass of: entity
comment: 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.
is: entity
lib: lib:phIoT
mandatory: marker

evseStatus
type: DatatypeProperty
range: str
comment: 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.
enum: - 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: …
is: str
lib: lib:phIoT

exhaust
type: Class
subclass of: ductSection
comment: Duct used to expel air back outside
is: ductSection
lib: lib:phIoT

export
type: Class
subclass of: marker
comment: Supplied out of a system
is: marker
lib: lib:phIoT

extraction
type: Class
subclass of: marker
comment: Taking a substance out of another substance
is: marker
lib: lib:phIoT

faceBypass
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:phIoT

fan
type: Class
subclass of: marker
comment: Fan equipment or control point
is: marker
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Fan_(machine)

fan-motor
type: Class
subclass of: motor
children: point
  has tag: alarm
  has tag: sensor
  has tag: point
children: point
  has tag: enable
  has tag: cmd
  has tag: point
children: point
  has tag: enable
  has tag: sensor
  has tag: point
children: equip
  has tag: equip
children: point
  has tag: point
children: point
  has tag: run
  has tag: cmd
  has tag: point
children: point
  has tag: run
  has tag: sensor
  has tag: point
children: point
  has tag: vfd
  has tag: freq
  has tag: cmd
  has tag: point
children: point
  has tag: vfd
  has tag: freq
  has tag: sensor
  has tag: point
children: point
  has tag: vfd
  has tag: speed
  has tag: cmd
  has tag: point
children: point
  has tag: vfd
  has tag: speed
  has tag: sensor
  has tag: point
childrenFlatten: ductSection
childrenFlatten: fan
comment: Motor used with a fan to create air flow. See `docHaystack::Motors` chapter.
is: motor
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Fan_(machine)

fanPowered
type: Class
subclass of: marker
comment: Device with a fan
is: marker
lib: lib:phIoT

fcu
type: Class
subclass of: airHandlingEquip
children: point
  has tag: bypass
  has tag: damper
  has tag: cmd
  has tag: point
children: point
  has tag: cool
  has tag: cmd
  has tag: point
children: point
  has tag: dessicantDehumidifier
  has tag: cmd
  has tag: point
children: duct
  has tag: discharge
  has tag: duct
  has tag: equip
children: duct
  has tag: economizer
  has tag: duct
  has tag: equip
children: point
  has tag: economizing
  has tag: cmd
  has tag: point
children: equip
  has tag: equip
children: duct
  has tag: exhaust
  has tag: duct
  has tag: equip
children: point
  has tag: faceBypass
  has tag: cmd
  has tag: point
children: point
  has tag: filter
  has tag: sensor
  has tag: point
children: point
  has tag: freezeStat
  has tag: sensor
  has tag: point
children: point
  has tag: heat
  has tag: cmd
  has tag: point
children: point
  has tag: heatWheel
  has tag: cmd
  has tag: point
children: humidifier-equip
  has tag: humidifier
  has tag: equip
children: point
  has tag: hvacMode
  has tag: sp
  has tag: point
children: duct
  has tag: mixed
  has tag: duct
  has tag: equip
children: duct
  has tag: outside
  has tag: duct
  has tag: equip
children: point
  has tag: point
children: duct
  has tag: return
  has tag: duct
  has tag: equip
children: thermostat
  has tag: thermostat
  has tag: equip
children: duct
  has tag: ventilation
  has tag: duct
  has tag: equip
comment: 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.
is: airHandlingEquip
lib: lib:phIoT
mandatory: marker
wikipedia: https://en.wikipedia.org/wiki/Fan_coil_unit

feature
comment: Feature namespace of definitions formatted as 'feature:name'
docTaxonomy: marker
lib: lib:ph

feelsLike
type: Class
subclass of: quantity
comment: Apparent temperature perceived when considering humidity, wind chill, and heat index
is: quantity
lib: lib:phScience
prefUnit: °C
prefUnit: °F
quantityOf: air

fileExt
type: DatatypeProperty
domain: filetype
range: str
comment: Filename extension such as "csv"
is: str
lib: lib:ph
tagOn: filetype

filetype
comment: File format type definition
is: feature
lib: lib:ph

CSV
dis: CSV
comment: Comma Separated Values - see `docHaystack::Csv`
fileExt: csv
is: filetype
lib: lib:ph
mime: text/csv
wikipedia: https://wikipedia.org/wiki/Comma-separated_values

JSON
dis: JSON
comment: Haystack JavaScript Object Notation format - see `docHaystack::Json`
fileExt: json
is: filetype
lib: lib:ph
mime: application/json
wikipedia: https://wikipedia.org/wiki/JSON

JSON-LD
dis: JSON-LD
comment: JavaScript Object Notation for Linked Data - see `docHaystack::Rdf`
fileExt: jsonld
is: filetype
lib: lib:ph
mime: application/ld+json
wikipedia: https://wikipedia.org/wiki/JSON-LD

Trio
dis: Trio
comment: Haystack Tag Record Input Output - see `docHaystack::Trio`
fileExt: trio
is: filetype
lib: lib:ph
mime: text/trio

Turtle
dis: Turtle
comment: RDF Turtle - see `docHaystack::Rdf`
fileExt: ttl
is: filetype
lib: lib:ph
mime: text/turtle
wikipedia: https://wikipedia.org/wiki/Turtle_(syntax)

Zinc
dis: Zinc
comment: Haystack typed CSV format - see `docHaystack::Zinc`
fileExt: zinc
is: filetype
lib: lib:ph
mime: text/zinc

filter
type: Class
subclass of: marker
comment: Related to an air or fluid filter.
is: marker
lib: lib:phIoT

filterStr
type: DatatypeProperty
range: str
comment: Haystack filter string. See `docHaystack::Filters`
is: str
lib: lib:ph

floor
type: Class
subclass of: space
children: equip
  has tag: equip
children: point
  has tag: point
children: space
  has tag: space
comment: Storey of a building. See `docHaystack::Spaces#floors` chapter.
is: space
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Storey

floorNum
type: DatatypeProperty
domain: floor
range: number
comment: 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.
is: int
lib: lib:phIoT
tagOn: floor

flow
type: Class
subclass of: quantity
comment: Measure of volumetric flow of fluid
is: quantity
lib: lib:phScience
prefUnit: m³/s
prefUnit: gal/min
quantityOf: fluid
wikipedia: https://en.wikipedia.org/wiki/Fluid_dynamics

flow-meter
type: Class
subclass of: meter
children: equip
  has tag: equip
children: point
  has tag: point
comment: Meter to measure flow rate and total volume of fluid. See `docHaystack::Meters` chapter.
is: meter
lib: lib:phIoT

flowInverter
type: Class
subclass of: equip
children: equip
  has tag: equip
children: point
  has tag: point
comment: System to change direction of substance flow
is: equip
lib: lib:phIoT

flue
type: Class
subclass of: ductSection
comment: Duct for exhausting combustion
is: ductSection
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Flue

fluid
type: Class
subclass of: substance
comment: Liquid or gas
is: substance
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Fluid

flux
type: Class
subclass of: marker
comment: Measurement through a given surface
is: marker
lib: lib:phScience

freezeStat
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:phIoT

freq
type: Class
subclass of: quantity
comment: Occurrences per unit time
is: quantity
lib: lib:phScience
prefUnit: Hz

ftp
type: Class
subclass of: protocol
comment: File Transfer Protocol
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/File_Transfer_Protocol

fuelOil
type: Class
subclass of: liquid
comment: Petroleum based oil burned for energy
is: liquid
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Fuel_oil

fuelOil-input
type: Class
subclass of: input
comment: Entity inputs fuel oil which flows from another entity
is: input
lib: lib:phIoT

fuelOil-output
type: Class
subclass of: output
comment: Entity outputs fuel oil to other entities
is: output
lib: lib:phIoT

fuelOilHeating
type: Class
subclass of: heatingProcess
subclass of: fuelOil-input
comment: Heating by the combustion of fuel oil
is: heatingProcess
is: fuelOil-input
lib: lib:phIoT

fuelOilRef
type: ObjectProperty
domain: fuelOil-input
range: fuelOil-output
comment: Fuel oil flows from the referent to this entity
inputs: fuelOil
is: ref
lib: lib:phIoT
of: fuelOil-output
tagOn: fuelOil-input

fumeHood
type: Class
subclass of: equip
subclass of: elec-input
children: point
  has tag: air
  has tag: flow
  has tag: sensor
  has tag: point
children: point
  has tag: air
  has tag: flow
  has tag: sp
  has tag: point
children: point
  has tag: air
  has tag: velocity
  has tag: sensor
  has tag: point
children: point
  has tag: air
  has tag: velocity
  has tag: sp
  has tag: point
children: point
  has tag: alarm
  has tag: sensor
  has tag: point
children: equip
  has tag: equip
children: point
  has tag: point
comment: Ventilation equipment to limit exposure to hazardous fumes.
is: equip
is: elec-input
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Fume_hood

gas
type: Class
subclass of: fluid
comment: Substance with neither definite volume nor shape
is: fluid
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Gas

gasoline
type: Class
subclass of: liquid
comment: Petroleum derived liquid used as a fuel source
is: liquid
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Gasoline

gasoline-input
type: Class
subclass of: input
comment: Entity inputs gasoline which flows from another entity
is: input
lib: lib:phIoT

gasoline-output
type: Class
subclass of: output
comment: Entity outputs gasoline to other entities
is: output
lib: lib:phIoT

gasolineRef
type: ObjectProperty
domain: gasoline-input
range: gasoline-output
comment: Gasoline flows from the referent to this entity
inputs: gasoline
is: ref
lib: lib:phIoT
of: gasoline-output
tagOn: gasoline-input

geoAddr
type: DatatypeProperty
domain: geoPlace
range: str
comment: 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"
is: str
lib: lib:ph
tagOn: geoPlace

geoCity
type: DatatypeProperty
domain: geoPlace
range: str
comment: Geographic city or locality name
is: str
lib: lib:ph
tagOn: geoPlace

geoCoord
type: DatatypeProperty
domain: geoPlace
range: coord
comment: Geographic coordinate as 'C(latitude,longitude)'
is: coord
lib: lib:ph
tagOn: geoPlace

geoCountry
type: DatatypeProperty
domain: geoPlace
range: str
comment: Geographic country as [ISO 3166-1]`http://en.wikipedia.org/wiki/ISO_3166-1` two letter code
enum: - 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 - J…
is: str
lib: lib:ph
tagOn: geoPlace

geoCounty
type: DatatypeProperty
domain: geoPlace
range: str
comment: Geographic subdivision of US state
is: str
lib: lib:ph
tagOn: geoPlace

geoElevation
type: DatatypeProperty
domain: geoPlace
range: number
comment: Elevation above sea-level of the location
is: number
lib: lib:ph
tagOn: geoPlace

geoPlace
type: Class
subclass of: marker
comment: Geographic place
is: marker
lib: lib:ph

geoPostalCode
type: DatatypeProperty
domain: geoPlace
range: str
comment: Geographic postal code; for US this is a five digit zip code
is: str
lib: lib:ph
tagOn: geoPlace

geoState
type: DatatypeProperty
domain: geoPlace
range: str
comment: 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.
enum: - 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
is: str
lib: lib:ph
openEnum: marker
tagOn: geoPlace

geoStreet
type: DatatypeProperty
domain: geoPlace
range: str
comment: Geographic street address and name
is: str
lib: lib:ph
tagOn: geoPlace

grid
type: DatatypeProperty
comment: Two dimension table of columns and rows. See [Kinds chapter]`docHaystack::Kinds#grid`.
is: val
lib: lib:ph

ground
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:phIoT

ground-floor
type: Class
subclass of: floor
children: equip
  has tag: equip
children: point
  has tag: point
children: space
  has tag: space
comment: 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.
is: floor
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Storey

ground-water
type: Class
subclass of: water
comment: Water present under the ground or from a well
is: water
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Groundwater

haystack
type: Class
subclass of: protocol
comment: Haystack HTTP protocol for exchanging tagged data
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Communication_protocol

header
type: Class
subclass of: pipeSection
comment: Pipe used as central connection or manifold for other piping runs.
is: pipeSection
lib: lib:phIoT

heat
type: Class
subclass of: marker
comment: Associated with a heating process. When used on a point, this tag is associated with the control of heating.
is: marker
lib: lib:phIoT

heatExchanger
type: Class
subclass of: equip
children: equip
  has tag: equip
children: point
  has tag: point
comment: Equipment to transfer heat between two working fluids.
is: equip
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Heat_exchanger

heatPump
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Heat_pump

heatRecovery
type: Class
subclass of: marker
comment: Transfer of heat from one substance to another to reduce energy consumption.
is: marker
lib: lib:phIoT

heatWheel
type: Class
subclass of: marker
comment: Boolean point indicating command state of AHU's heat wheel.
is: marker
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Thermal_wheel

heating
type: Class
subclass of: marker
comment: Heating mode or process
is: marker
lib: lib:phIoT

heatingCoil
type: Class
subclass of: coil
children: equip
  has tag: equip
children: point
  has tag: hot
  has tag: water
  has tag: heat
  has tag: valve
  has tag: cmd
  has tag: point
children: point
  has tag: point
children: point
  has tag: heat
  has tag: run
  has tag: cmd
  has tag: point
  stage: 1
children: point
  has tag: steam
  has tag: heat
  has tag: valve
  has tag: cmd
  has tag: point
childrenFlatten: ductDeck
childrenFlatten: ductSection
comment: Coil used to heat air.
is: coil
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Heat_exchanger#HVAC_air_coils

heatingOnly
type: Class
subclass of: marker
comment: Equipment without cooling
is: marker
lib: lib:phIoT

heatingProcess
type: Class
subclass of: choice
comment: Processed used to heat a substance
is: choice
lib: lib:phIoT
tagOn: airHandlingEquip
tagOn: boiler
tagOn: chilledBeam
tagOn: heatingCoil
tagOn: radiator
tagOn: radiantFloor
tagOn: vav

hfc
type: Class
subclass of: gas
comment: Hydrofluorocarbons
is: gas
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Hydrofluorocarbon

hfc-emission
type: Class
subclass of: emission
comment: Greenhouse gas emission of hydrofluorocarbons into the air.
is: emission
lib: lib:phScience
prefUnit: kg
prefUnit: ton
prefUnit: lb
quantityOf: air

his
type: Class
subclass of: marker
comment: Supports historization of data
is: marker
lib: lib:phIoT
tagOn: point

his-point
type: Class
subclass of: point
comment: 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.
is: point
lib: lib:phIoT

hisErr
type: DatatypeProperty
domain: his-point
range: str
comment: Error description when `hisStatus` indicates error condition
is: str
lib: lib:phIoT
tagOn: his-point
transient: marker

hisMode
type: DatatypeProperty
domain: his-point
range: str
comment: Indicates the way that history data is collected for a point.
enum: - 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.
is: str
lib: lib:phIoT
tagOn: his-point

hisStatus
type: DatatypeProperty
domain: his-point
range: str
comment: Status of point's history collection or synchronization
enum: - 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
is: str
lib: lib:phIoT
tagOn: his-point
transient: marker

hisTotalized
type: Class
subclass of: marker
comment: Indicates values which are a continuous stream of totalization. History data reads and should be normalized by computing the delta.
is: marker
lib: lib:phIoT
tagOn: his-point

hot
type: Class
subclass of: marker
comment: Having high degree of heat
is: marker
lib: lib:phIoT

hot-water
type: Class
subclass of: water
comment: Hot water used for HVAC heating or supplied to hot taps
is: water
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Water

hot-water-boiler
type: Class
subclass of: boiler
subclass of: hot-water-output
children: point
  has tag: alarm
  has tag: sensor
  has tag: point
children: pipe
  has tag: circ
  has tag: pipe
  has tag: equip
children: equip
  has tag: equip
children: duct
  has tag: flue
  has tag: duct
  has tag: equip
children: pipe
  has tag: hot
  has tag: water
  has tag: entering
  has tag: pipe
  has tag: equip
children: pipe
  has tag: hot
  has tag: water
  has tag: leaving
  has tag: pipe
  has tag: equip
children: pipe
  has tag: makeup
  has tag: water
  has tag: entering
  has tag: pipe
  has tag: equip
children: duct
  has tag: outside
  has tag: duct
  has tag: equip
children: point
  has tag: point
comment: Boiler which outputs hot water
is: boiler
is: hot-water-output
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Boiler

hot-water-input
type: Class
subclass of: input
comment: Entity inputs hot water which flows from another entity
is: input
lib: lib:phIoT

hot-water-output
type: Class
subclass of: output
comment: Entity outputs hot water to other entities
is: output
lib: lib:phIoT

hot-water-plant
type: Class
subclass of: plant
subclass of: hot-water-output
children: point
  has tag: enable
  has tag: cmd
  has tag: point
children: equip
  has tag: equip
children: duct
  has tag: flue
  has tag: duct
  has tag: equip
children: hot-water-boiler
  has tag: hot
  has tag: water
  has tag: boiler
  has tag: equip
children: pipe
  has tag: hot
  has tag: water
  has tag: bypass
  has tag: pipe
  has tag: equip
children: point
  has tag: hot
  has tag: water
  has tag: delta
  has tag: flow
  has tag: sensor
  has tag: point
children: point
  has tag: hot
  has tag: water
  has tag: delta
  has tag: pressure
  has tag: sensor
  has tag: point
children: point
  has tag: hot
  has tag: water
  has tag: delta
  has tag: temp
  has tag: sensor
  has tag: point
children: pipe
  has tag: hot
  has tag: water
  has tag: entering
  has tag: pipe
  has tag: equip
children: pipe
  has tag: hot
  has tag: water
  has tag: header
  has tag: pipe
  has tag: equip
children: heatExchanger
  has tag: hot
  has tag: water
  has tag: heatExchanger
  has tag: equip
children: pipe
  has tag: hot
  has tag: water
  has tag: leaving
  has tag: pipe
  has tag: equip
children: point
  has tag: hot
  has tag: water
  has tag: mixing
  has tag: valve
  has tag: cmd
  has tag: point
children: pipe
  has tag: makeup
  has tag: water
  has tag: entering
  has tag: pipe
  has tag: equip
children: duct
  has tag: outside
  has tag: duct
  has tag: equip
children: point
  has tag: point
comment: Plant used to generate hot water for heating. See `docHaystack::Plants`.
is: plant
is: hot-water-output
lib: lib:phIoT

hot-water-system
type: Class
subclass of: water-system
children: equip
  has tag: equip
children: point
  has tag: point
comment: System that circulates water in its liquid state for heating a space or process.
is: water-system
lib: lib:phIoT

hotDeck
type: Class
subclass of: ductDeck
comment: Duct carries air for heating
is: ductDeck
lib: lib:phIoT

hotWaterHeating
type: Class
subclass of: heatingProcess
subclass of: hot-water-input
comment: Heating using energy of hot water
is: heatingProcess
is: hot-water-input
lib: lib:phIoT

hotWaterRef
type: ObjectProperty
domain: hot-water-input
range: hot-water-output
comment: Hot water flows from the referent to this entity
inputs: hot-water
is: ref
lib: lib:phIoT
of: hot-water-output
tagOn: hot-water-input

http
type: Class
subclass of: protocol
comment: Hypertext Transfer Protocol which is foundation of the web
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol

humidifier
type: Class
subclass of: marker
comment: Adding moisture to air
is: marker
lib: lib:phIoT

humidifier-equip
type: Class
subclass of: equip
children: equip
  has tag: equip
children: point
  has tag: humidifier
  has tag: enable
  has tag: cmd
  has tag: point
children: point
  has tag: humidifier
  has tag: run
  has tag: cmd
  has tag: point
children: point
  has tag: point
comment: Equipment which adds moisture to air to increase humidity
is: equip
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Humidifier

humidity
type: Class
subclass of: quantity
comment: Percent relative humidity; measure of moisture in the air
is: quantity
lib: lib:phScience
prefUnit: %RH
quantityOf: air

hvac
type: Class
subclass of: marker
comment: Heating, ventilation, and air conditioning
is: marker
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/HVAC

hvac-zone-space
type: Class
subclass of: zone-space
subclass of: hvacZonePoints
subclass of: airQualityZonePoints
subclass of: air-input
children: equip
  has tag: equip
children: point
  has tag: occupancy
  has tag: sensor
  has tag: point
children: point
  has tag: occupied
  has tag: sensor
  has tag: point
children: point
  has tag: occupied
  has tag: sp
  has tag: point
children: point
  has tag: point
children: space
  has tag: space
children: point
  has tag: zone
  has tag: air
  has tag: ch2o
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: co
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: co2
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: co2
  has tag: concentration
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: dewPoint
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: dewPoint
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: enthalpy
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: enthalpy
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: humidity
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: humidity
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: hvacMode
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: nh3
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: no2
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: o3
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: pm01
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: pm10
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: pm25
  has tag: concentration
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: pressure
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: pressure
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: effective
  has tag: cooling
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: effective
  has tag: heating
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: effective
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: occ
  has tag: cooling
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: occ
  has tag: heating
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: standby
  has tag: cooling
  has tag: sp
  has tag: point
comment: Zone related to conditioning of a space's air temperature and quality. See `docHaystack::Spaces#zones` and `docHaystack::Zones#hvac` chapters.
is: zone-space
is: hvacZonePoints
is: airQualityZonePoints
is: air-input
lib: lib:phIoT

hvacMode
type: Class
subclass of: marker
comment: Operational mode for HVAC equipment
enum: - 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:
is: marker
lib: lib:phIoT

hvacZonePoints
type: Class
subclass of: pointGroup
children: point
  has tag: zone
  has tag: air
  has tag: hvacMode
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: effective
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: effective
  has tag: cooling
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: effective
  has tag: heating
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: occ
  has tag: cooling
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: occ
  has tag: heating
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: unocc
  has tag: cooling
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: unocc
  has tag: heating
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: standby
  has tag: cooling
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: standby
  has tag: heating
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: pressure
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: pressure
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: humidity
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: humidity
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: dewPoint
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: dewPoint
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: enthalpy
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: enthalpy
  has tag: sp
  has tag: point
comment: Entity with logical grouping of zone HVAC air points. See `docHaystack::Zones#hvac` chapter.
is: pointGroup
lib: lib:phIoT

ice
type: Class
subclass of: solid
comment: Water in its solid form
is: solid
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Ice

id
type: ObjectProperty
domain: entity
range: entity
comment: 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.
is: ref
lib: lib:ph
tagOn: entity

illuminance
type: Class
subclass of: quantity
comment: Luminous flux hitting the inside of the sphere at a specific point. Also see [ies.org]`https://www.ies.org/definitions/illuminance/`
is: quantity
lib: lib:phScience
prefUnit: lux
prefUnit: footcandle
prefUnit: phot
quantityOf: light
wikipedia: https://en.wikipedia.org/wiki/Illuminance

imap
type: Class
subclass of: protocol
comment: Internet Message Access Protocol for retrieving email
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol

imbalance
type: Class
subclass of: marker
comment: Lacking balance
is: marker
lib: lib:phIoT

import
type: Class
subclass of: marker
comment: Received into a system
is: marker
lib: lib:phIoT

indoorUnit
type: Class
subclass of: marker
comment: Operates inside the conditioned space
is: marker
lib: lib:phIoT

infiltration
type: Class
subclass of: marker
comment: Permeation of a substance into another substance
is: marker
lib: lib:phIoT

inlet
type: Class
subclass of: ductSection
comment: Duct with air entering an equipment
is: ductSection
lib: lib:phIoT

input
type: Class
subclass of: marker
comment: Entity inputs a substance which flows from another entity
is: marker
lib: lib:ph

inputs
type: DatatypeProperty
range: symbol
comment: The entity inputs a substance from the referent. The value of this tag is what is received.
is: relationship
lib: lib:ph
reciprocalOf: outputs
transitive: marker

int
type: DatatypeProperty
range: number
comment: Unitless integer number
is: number
lib: lib:ph

intensity
type: Class
subclass of: marker
comment: Measure of an electromagnetic field
is: marker
lib: lib:phScience

irradiance
type: Class
subclass of: quantity
comment: Energy received at a surface by area
is: quantity
lib: lib:phScience

is
type: DatatypeProperty
domain: def
range: list
comment: Defines one or more supertypes of a subtyping relationship. See [Subtyping]`docHaystack::Subtyping` chapter.
is: association
lib: lib:ph
of: symbol
tagOn: def

isolation
type: Class
subclass of: marker
comment: Actuator used to isolate an equipment from a pipe or ductwork system
is: marker
lib: lib:phIoT

kind
type: DatatypeProperty
domain: point
range: str
comment: Kind name used to identity a value data type
enum: - 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
is: str
lib: lib:ph
tagOn: point

knx
type: Class
subclass of: protocol
comment: KNX protocol commonly used for lighting systems
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/KNX_(standard)

laptop
type: Class
subclass of: computer
comment: Portable laptop computer.
is: computer
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Laptop

leaving
type: Class
subclass of: pipeSection
comment: Pipe conveys fluid out of an equipment
is: pipeSection
lib: lib:phIoT

level
type: Class
subclass of: quantity
comment: Range from 0% to 100%. When paired with a fluid this implies a fill level where 0% is empty and 100% is full.
is: quantity
lib: lib:phScience
prefUnit: %
quantityOf: fluid

lib
comment: Library module of symbolic definitions. See `docHaystack::Namespaces#libs` chapter.
is: feature
lib: lib:ph

lib:ph
baseUri: https://project-haystack.org/def/ph/
comment: Project Haystack core definitions
is: lib
version: 3.9.15

lib:phIct
baseUri: https://project-haystack.org/def/phIct/
depends: lib:ph
depends: lib:phIoT
comment: Project Haystack definitions for Information and Communications Technology. This includes microprocessor based hardware, software, and networking technologies.
is: lib
version: 3.9.15
wikipedia: https://en.wikipedia.org/wiki/Information_and_communications_technology

lib:phIoT
baseUri: https://project-haystack.org/def/phIoT/
depends: lib:ph
depends: lib:phScience
comment: Project Haystack definitions for Internet of Things
is: lib
version: 3.9.15
wikipedia: https://en.wikipedia.org/wiki/Internet_of_things

lib:phScience
baseUri: https://project-haystack.org/def/phScience/
depends: lib:ph
comment: Project Haystack scientific definitions
is: lib
version: 3.9.15

light
type: Class
subclass of: phenomenon
comment: Electromagnetic radiation in the visible spectrum
is: phenomenon
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Light

light-level
type: Class
subclass of: level
comment: Sensed or controlled dimming level of electrical lighting. Level is measured as a percentage where 0% is off and 100% is full brightness.
is: level
lib: lib:phScience
prefUnit: %
quantityOf: light

lighting
type: Class
subclass of: marker
comment: Systems associated with illumination in the built environment
is: marker
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Lighting

lighting-system
type: Class
subclass of: elec-system
children: equip
  has tag: equip
children: point
  has tag: point
comment: System designed to provide lighting.
is: elec-system
lib: lib:phIoT

lighting-zone-space
type: Class
subclass of: zone-space
subclass of: lightingZonePoints
children: equip
  has tag: equip
children: point
  has tag: light
  has tag: illuminance
  has tag: sensor
  has tag: point
children: point
  has tag: light
  has tag: level
  has tag: sensor
  has tag: point
children: point
  has tag: light
  has tag: level
  has tag: sp
  has tag: point
children: point
  has tag: light
  has tag: luminous
  has tag: flux
  has tag: sensor
  has tag: point
children: point
  has tag: occupancy
  has tag: sensor
  has tag: point
children: point
  has tag: occupied
  has tag: sensor
  has tag: point
children: point
  has tag: occupied
  has tag: sp
  has tag: point
children: point
  has tag: point
children: space
  has tag: space
comment: Zone related to lighting system. See `docHaystack::Spaces#zones` and `docHaystack::Zones#lighting` chapters.
is: zone-space
is: lightingZonePoints
lib: lib:phIoT

lightingZonePoints
type: Class
subclass of: pointGroup
children: point
  has tag: light
  has tag: level
  has tag: sensor
  has tag: point
children: point
  has tag: light
  has tag: level
  has tag: sp
  has tag: point
children: point
  has tag: light
  has tag: illuminance
  has tag: sensor
  has tag: point
children: point
  has tag: light
  has tag: luminous
  has tag: flux
  has tag: sensor
  has tag: point
comment: Entity with logical grouping of lighting points. See `docHaystack::Zones#lighting` chapter.
is: pointGroup
lib: lib:phIoT

lineAvg
type: Class
subclass of: marker
comment: 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 measurements defined in `lineVolt`. When applied to a point entity that has the `elec` and `current` tags, indicates the average of all measurements defined in `lineCurrent`. When applied to a point entity that has the `elec` and `power` tags, indicates the average of all measurements defined in `linePower`. When applied to a point entity that has the `elec` and `pf` tags, indicates the average of all measurements defined in `linePf`. When applied to a point entity that has the `elec` and `energy` tags, indicates the average of all measurements defined in `lineEnergy`.
is: marker
lib: lib:phIoT

lineCurrent
type: DatatypeProperty
range: str
comment: Single-phase line current measured in an AC electric power system.
enum: - L1: line 1 measurement - L2: line 2 measurement - L3: line 3 measurement
is: elecLine
lib: lib:phIoT

lineEnergy
type: DatatypeProperty
range: str
comment: Single-phase energy measured line-to-line in an AC electric power system.
enum: - L1-L2: line 1 to line 2 measurement - L2-L3: line 2 to line 3 measurement - L3-L1: line 3 to line 1 measurement
is: elecLineToLine
lib: lib:phIoT

linePf
type: DatatypeProperty
range: str
comment: Single-phase power factor measured line-to-line in an AC electric power system.
enum: - L1-L2: line 1 to line 2 measurement - L2-L3: line 2 to line 3 measurement - L3-L1: line 3 to line 1 measurement
is: elecLineToLine
lib: lib:phIoT

linePower
type: DatatypeProperty
range: str
comment: Single-phase power measured line-to-line in an AC electric power system. May also be referred to as a line power measurement.
enum: - L1-L2: line 1 to line 2 measurement - L2-L3: line 2 to line 3 measurement - L3-L1: line 3 to line 1 measurement
is: elecLineToLine
lib: lib:phIoT

lineVolt
type: DatatypeProperty
range: str
comment: Single-phase voltage measured line-to-line in an AC electric power system. May also be referred to as a line voltage measurement.
enum: - L1-L2: line 1 to line 2 measurement - L2-L3: line 2 to line 3 measurement - L3-L1: line 3 to line 1 measurement
is: elecLineToLine
lib: lib:phIoT

liquid
type: Class
subclass of: fluid
comment: Substance with definite volume but takes the shape of its container
is: fluid
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Liquid

list
type: DatatypeProperty
comment: Ordered list of zero or more values. See [Kinds chapter]`docHaystack::Kinds#list`.
is: val
lib: lib:ph

load
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:phIoT

luminaire
type: Class
subclass of: equip
subclass of: lightingZonePoints
subclass of: elec-input
children: equip
  has tag: equip
children: point
  has tag: light
  has tag: illuminance
  has tag: sensor
  has tag: point
children: point
  has tag: light
  has tag: level
  has tag: sensor
  has tag: point
children: point
  has tag: light
  has tag: level
  has tag: sp
  has tag: point
children: point
  has tag: light
  has tag: luminous
  has tag: flux
  has tag: sensor
  has tag: point
children: point
  has tag: point
comment: Light fixture using electricity to provide illumination
is: equip
is: lightingZonePoints
is: elec-input
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Light_fixture

luminance
type: Class
subclass of: quantity
comment: Energy of light in a given direction. Also see [ies.org]`https://www.ies.org/definitions/luminance/`
is: quantity
lib: lib:phScience
prefUnit: candelas_per_square_meter
prefUnit: candelas_per_square_foot
quantityOf: light
wikipedia: https://en.wikipedia.org/wiki/Luminance

luminous
type: Class
subclass of: marker
comment: Relating to light as perceived by the eye
is: marker
lib: lib:phScience

luminous-flux
type: Class
subclass of: quantity
comment: Total perceived light in all directions. Also see [ies.org]`https://www.ies.org/definitions/luminous-flux/`
is: quantity
lib: lib:phScience
prefUnit: lumen
quantityOf: light
wikipedia: https://en.wikipedia.org/wiki/Luminous_flux

luminous-intensity
type: Class
subclass of: quantity
comment: Perceived light in a particular direction per unit solid angle. Also see [ies.org]`https://www.ies.org/definitions/luminous-intensity/`
is: quantity
lib: lib:phScience
prefUnit: candela
quantityOf: light
wikipedia: https://en.wikipedia.org/wiki/Luminous_intensity

magnitude
type: Class
subclass of: marker
comment: Size or extent
is: marker
lib: lib:phScience

makeup
type: Class
subclass of: marker
comment: Restore something missed or lost
is: marker
lib: lib:phIoT

makeup-water
type: Class
subclass of: water
comment: Water used used to makeup water loss through leaks, evaporation, or blowdown
is: water
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Water

makeup-water-input
type: Class
subclass of: input
comment: Entity inputs makeup water which flows from another entity
is: input
lib: lib:phIoT

makeup-water-output
type: Class
subclass of: output
comment: Entity outputs makeup water to other entities
is: output
lib: lib:phIoT

makeupWaterRef
type: ObjectProperty
domain: makeup-water-input
range: makeup-water-output
comment: Makeup water flows from the referent to this entity
inputs: makeup-water
is: ref
lib: lib:phIoT
of: makeup-water-output
tagOn: makeup-water-input

mandatory
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:ph
notInherited: marker
tagOn: def

marker
type: Class
comment: Marker labels a dict with typing information. See [Kinds chapter]`docHaystack::Kinds#marker`.
lib: lib:ph

mau
type: Class
subclass of: doas
children: point
  has tag: bypass
  has tag: damper
  has tag: cmd
  has tag: point
children: point
  has tag: cool
  has tag: cmd
  has tag: point
children: point
  has tag: dessicantDehumidifier
  has tag: cmd
  has tag: point
children: duct
  has tag: discharge
  has tag: duct
  has tag: equip
children: duct
  has tag: economizer
  has tag: duct
  has tag: equip
children: point
  has tag: economizing
  has tag: cmd
  has tag: point
children: equip
  has tag: equip
children: duct
  has tag: exhaust
  has tag: duct
  has tag: equip
children: point
  has tag: faceBypass
  has tag: cmd
  has tag: point
children: point
  has tag: filter
  has tag: sensor
  has tag: point
children: point
  has tag: freezeStat
  has tag: sensor
  has tag: point
children: point
  has tag: heat
  has tag: cmd
  has tag: point
children: point
  has tag: heatWheel
  has tag: cmd
  has tag: point
children: humidifier-equip
  has tag: humidifier
  has tag: equip
children: point
  has tag: hvacMode
  has tag: sp
  has tag: point
children: duct
  has tag: mixed
  has tag: duct
  has tag: equip
children: duct
  has tag: outside
  has tag: duct
  has tag: equip
children: point
  has tag: point
children: duct
  has tag: return
  has tag: duct
  has tag: equip
children: thermostat
  has tag: thermostat
  has tag: equip
children: duct
  has tag: ventilation
  has tag: duct
  has tag: equip
comment: 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.
is: doas
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Air_handler

max
type: Class
subclass of: marker
comment: Maximum
is: marker
lib: lib:ph

maxVal
type: DatatypeProperty
domain: def
domain: point
range: number
comment: Inclusive maximum for a numeric value.
is: number
lib: lib:ph
tagOn: def
tagOn: point

mech
type: Class
subclass of: marker
comment: Associated with a machine or its mechanical force, torque, power, or energy. This is often opposed to `elec` electrical energy.
is: marker
lib: lib:phIoT

meter
type: Class
subclass of: equip
children: equip
  has tag: equip
children: point
  has tag: point
comment: Equipment to meter a substance or phenomenon. See `docHaystack::Meters` chapter.
is: equip
lib: lib:phIoT

meterScope
type: Class
subclass of: choice
comment: Classifies a meter as a main site meter or submeter
is: choice
lib: lib:phIoT
tagOn: meter

mime
type: DatatypeProperty
domain: filetype
range: str
comment: Mime type formatted as type/subtype
is: str
lib: lib:ph
tagOn: filetype

min
type: Class
subclass of: marker
comment: Minimum
is: marker
lib: lib:ph

minVal
type: DatatypeProperty
domain: def
domain: point
range: number
comment: Inclusive minimum for a numeric value.
is: number
lib: lib:ph
tagOn: def
tagOn: point

mixed
type: Class
subclass of: ductSection
comment: Duct where fresh outside air and return air is mixed together
is: ductSection
lib: lib:phIoT

mixing
type: Class
subclass of: marker
comment: Three way valve which inputs two pipes and outputs a mixture between the two to a single output pipe.
is: marker
lib: lib:phIoT

ml
type: Class
subclass of: synthetic
comment: Machine learning point. See `docHaystack::Synthetics` chapter.
is: synthetic
lib: lib:phIoT

ml-point
type: Class
subclass of: synthetic-point
comment: See `docHaystack::Synthetics` chapter.
is: synthetic-point
lib: lib:phIoT

mlIdentificationPeriod
type: DatatypeProperty
domain: mlModel
range: xstr
comment: Training period description, known as the identification period or baseline, utilized during the model training process.
is: span
lib: lib:phIoT
tagOn: mlModel

mlInputVarRefs
type: DatatypeProperty
domain: mlModel
range: list
comment: List of independent variables, also known as model inputs or features, associated with a machine learning model.
is: list
lib: lib:phIoT
of: mlVarRef
tagOn: mlModel

mlModel
type: Class
subclass of: syntheticModel
comment: See `docHaystack::Synthetics` chapter.
is: syntheticModel
lib: lib:phIoT

mlModelMetrics
type: DatatypeProperty
domain: mlModel
range: dict
comment: Goodness-of-fit metrics provided in the form of a simple dictionary. For example: {r2:0.7889, cvrmse:58}.
is: dict
lib: lib:phIoT
tagOn: mlModel

mlModelParameters
type: DatatypeProperty
domain: mlModel
range: dict
comment: 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.
is: dict
lib: lib:phIoT
tagOn: mlModel

mlOutputVarRef
type: ObjectProperty
domain: mlModel
range: mlVar
comment: Dependent variable, also known as the model output or target, associated, with a machine learning model. Represents the predicted outcome generated by the model.
is: ref
lib: lib:phIoT
of: mlVar
tagOn: mlModel

mlVar
type: Class
subclass of: entity
comment: Machine learning variable representing both model inputs and outputs.
is: entity
lib: lib:phIoT
mandatory: marker

mlVarFilter
type: DatatypeProperty
domain: mlVar
range: str
comment: Filter used for querying points by tags, providing more flexibility than mlVarPoint, although it is not mandatory.
is: filterStr
lib: lib:phIoT
tagOn: mlVar

mlVarPoint
type: ObjectProperty
domain: mlVar
range: point
comment: Reference to a point associated with a machine learning variable, known as a machine learning variable point.
is: ref
lib: lib:phIoT
of: point
tagOn: mlVar

mlVarRef
type: ObjectProperty
range: mlVar
comment: Reference to a machine learning variable.
is: ref
lib: lib:phIoT
of: mlVar

mobile
type: Class
subclass of: marker
comment: Relating to mobile phones, hand-held computers, and similar technology
is: marker
lib: lib:phIct

mobile-phone
type: Class
subclass of: phone
comment: Cellular phone providing telecommunication over radio links.
is: phone
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Mobile_phone

modbus
type: Class
subclass of: protocol
comment: Register based communication protocol used with industrial devices.
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Modbus

motor
type: Class
subclass of: equip
subclass of: elec-input
children: point
  has tag: alarm
  has tag: sensor
  has tag: point
children: point
  has tag: enable
  has tag: cmd
  has tag: point
children: point
  has tag: enable
  has tag: sensor
  has tag: point
children: equip
  has tag: equip
children: point
  has tag: point
children: point
  has tag: run
  has tag: cmd
  has tag: point
children: point
  has tag: run
  has tag: sensor
  has tag: point
children: point
  has tag: vfd
  has tag: freq
  has tag: cmd
  has tag: point
children: point
  has tag: vfd
  has tag: freq
  has tag: sensor
  has tag: point
children: point
  has tag: vfd
  has tag: speed
  has tag: cmd
  has tag: point
children: point
  has tag: vfd
  has tag: speed
  has tag: sensor
  has tag: point
comment: Equipment that converts electrical energy into mechanical energy. See `docHaystack::Motors` chapter.
is: equip
is: elec-input
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Electric_motor

movingWalkway
type: Class
subclass of: verticalTransport
subclass of: elec-input
children: equip
  has tag: equip
children: point
  has tag: point
comment: Conveyor to move people across a horizontal or inclined plane.
is: verticalTransport
is: elec-input
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Moving_walkway

mqtt
type: Class
subclass of: protocol
comment: Message Queuing Telemetry Transport publish/subscribe protocol
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/MQTT

multiZone
type: Class
subclass of: ahuZoneDelivery
comment: AHU discharge air is split into a duct per zone
is: ahuZoneDelivery
lib: lib:phIoT

n2o
type: Class
subclass of: gas
comment: Nitrous oxide (N₂O)
is: gas
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Nitrous_oxide

n2o-emission
type: Class
subclass of: emission
comment: Greenhouse gas emission of nitrous oxide (N₂O) into the air.
is: emission
lib: lib:phScience
prefUnit: kg
prefUnit: ton
prefUnit: lb
quantityOf: air

na
type: DatatypeProperty
subclass of: string
comment: Not available used to indicate invalid or missing data. See [Kinds chapter]`docHaystack::Kinds#na`.
is: scalar
lib: lib:ph

naturalGas
type: Class
subclass of: gas
comment: 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`
is: gas
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Natural_gas

naturalGas-input
type: Class
subclass of: input
comment: Entity inputs natural gas which flows from another entity
is: input
lib: lib:phIoT

naturalGas-output
type: Class
subclass of: output
comment: Entity outputs natural gas to other entities
is: output
lib: lib:phIoT

naturalGasHeating
type: Class
subclass of: heatingProcess
subclass of: naturalGas-input
comment: Heating by the combustion of natural gas
is: heatingProcess
is: naturalGas-input
lib: lib:phIoT

naturalGasRef
type: ObjectProperty
domain: naturalGas-input
range: naturalGas-output
comment: Natural gas flows from the referent to this entity
inputs: naturalGas
is: ref
lib: lib:phIoT
of: naturalGas-output
tagOn: naturalGas-input

net
type: Class
subclass of: marker
comment: Difference between import and export
is: marker
lib: lib:phIoT

network
type: Class
subclass of: entity
comment: Logical communications network between two or more devices. See `docHaystack::Devices#networks` chapter.
is: entity
lib: lib:phIct

networkRef
type: ObjectProperty
range: network
comment: Associates a device which communicates on specific a network.
is: ref
lib: lib:phIct
of: network

networking
type: Class
subclass of: marker
comment: Related to data communication networks
is: marker
lib: lib:phIct

networking-device
type: Class
subclass of: device
comment: Microprocessor device used to establish networks.
is: device
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Networking_hardware

networking-router
type: Class
subclass of: networking-device
comment: Networking device used to route data between different networks.
is: networking-device
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Router_(computing)

networking-switch
type: Class
subclass of: networking-device
comment: Networking device used to connect devices on the same network.
is: networking-device
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Network_switch

neutral
type: Class
subclass of: marker
comment: Used to indicate electrical current being measured on an electrical neutral conductor when applied to a point entity that has the `elec` and `current` tags.
is: marker
lib: lib:phIoT

neutralDeck
type: Class
subclass of: ductDeck
comment: Duct carries air which by-passes both heating and cooling coils
is: ductDeck
lib: lib:phIoT

nf3
type: Class
subclass of: gas
comment: Nitrogen trifluoride (NF₃)
is: gas
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Nitrogen_trifluoride

nf3-emission
type: Class
subclass of: emission
comment: Greenhouse gas emission of nitrogen trifluoride (NF₃) into the air.
is: emission
lib: lib:phScience
prefUnit: kg
prefUnit: ton
prefUnit: lb
quantityOf: air

nh3
type: Class
subclass of: gas
comment: Ammonia (NH₃)
is: gas
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Ammonia

nh3-concentration
type: Class
subclass of: airQuality
comment: Concentration of ammonia (NH₃) in the air
is: airQuality
lib: lib:phScience
prefUnit: µg/m³
prefUnit: ppb
quantityOf: air
wikipedia: https://en.wikipedia.org/wiki/Concentration

no2
type: Class
subclass of: gas
comment: Nitrogen dioxide (NO₂)
is: gas
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Nitrogen_dioxide

no2-concentration
type: Class
subclass of: airQuality
comment: Concentration of nitrogen dioxide (NO₂) in the air
is: airQuality
lib: lib:phScience
prefUnit: µg/m³
prefUnit: ppb
quantityOf: air
wikipedia: https://en.wikipedia.org/wiki/Concentration

noSideEffects
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:ph
wikipedia: https://en.wikipedia.org/wiki/Side_effect_(computer_science)

nodoc
type: Class
subclass of: marker
comment: Undocumented and not officially supported
is: marker
lib: lib:ph

nosrc
type: Class
subclass of: marker
comment: Do not include source code in documentation
is: marker
lib: lib:ph

notInherited
type: Class
subclass of: marker
comment: Marker applied to a def to indicate that is not inherited into subtype definitions.
is: marker
lib: lib:ph
tagOn: def

number
type: DatatypeProperty
subclass of: double
comment: Integer or floating point numbers annotated with an optional unit. See [Kinds chapter]`docHaystack::Kinds#number`.
is: scalar
lib: lib:ph

o2
type: Class
subclass of: gas
comment: Oxygen (O₂) - the common dioxygen allotrope in the air
is: gas
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Oxygen

o3
type: Class
subclass of: gas
comment: Ozone (O₃)
is: gas
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Ozone

o3-concentration
type: Class
subclass of: airQuality
comment: Concentration of ozone (O₃) in the air
is: airQuality
lib: lib:phScience
prefUnit: ppm
quantityOf: air
wikipedia: https://en.wikipedia.org/wiki/Concentration

obix
type: Class
subclass of: protocol
comment: XML based Open Building Information eXchange protocol.
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/OBIX

occ
type: Class
subclass of: marker
comment: Occupied mode of a space. See `docHaystack::Zones#occupancy` chapter.
is: marker
lib: lib:phIoT

occupancy
type: Class
subclass of: marker
comment: Number of occupants in a space. See `docHaystack::Zones#occupancy` chapter.
is: marker
lib: lib:phIoT

occupants
type: Class
subclass of: marker
comment: People who use the built environment. See `docHaystack::Zones#occupancy` chapter.
is: marker
lib: lib:phIoT

occupied
type: Class
subclass of: marker
comment: Setpoint or sensor indicating occupancy of a space. See `docHaystack::Zones#occupancy` chapter.
is: marker
lib: lib:phIoT

of
type: DatatypeProperty
domain: def
range: symbol
comment: Expected value type of a collection, reference, or choice
is: symbol
lib: lib:ph
tagOn: def

op
comment: Operation for HTTP API. See `docHaystack::Ops` chapter.
is: feature
lib: lib:ph

op:about
comment: Query basic information about the server. See `docHaystack::Ops#about` chapter.
is: op
lib: lib:ph
noSideEffects: marker

op:close
comment: Close the current session and cancel the auth bearer token. See `docHaystack::Ops#close` chapter.
is: op
lib: lib:ph

op:defs
comment: Query the definitions in the current namespace. See `docHaystack::Ops#defs` chapter.
is: op
lib: lib:ph
noSideEffects: marker

op:filetypes
comment: Query the filetype defs in the current namespace. See `docHaystack::Ops#filetypes` chapter.
is: op
lib: lib:ph
noSideEffects: marker

op:hisRead
comment: Read historized time series data from a `his-point`. See `docHaystack::Ops#hisRead` chapter.
is: op
lib: lib:phIoT
noSideEffects: marker

op:hisWrite
comment: Write historized time series data from a `his-point`. See `docHaystack::Ops#hisWrite` chapter.
is: op
lib: lib:phIoT

op:invokeAction
comment: Invoke a user action on a target entity. See `docHaystack::Ops#invokeAction` chapter.
is: op
lib: lib:phIoT

op:libs
comment: Query the lib defs in the current namespace. See `docHaystack::Ops#libs` chapter.
is: op
lib: lib:ph
noSideEffects: marker

op:nav
comment: Query the navigation tree for discovery. See `docHaystack::Ops#nav` chapter.
is: op
lib: lib:ph
noSideEffects: marker

op:ops
comment: Query the op defs in the current namespace. See `docHaystack::Ops#ops` chapter.
is: op
lib: lib:ph
noSideEffects: marker

op:pointWrite
comment: Read or command a `writable-point`. See `docHaystack::Ops#pointWrite` chapter.
is: op
lib: lib:phIoT

op:read
comment: Query the a set of entity records by id or by filter. See `docHaystack::Ops#read` chapter.
is: op
lib: lib:ph
noSideEffects: marker

op:watchPoll
comment: Poll a watch subscription. See `docHaystack::Ops#watchPoll` chapter.
is: op
lib: lib:ph

op:watchSub
comment: Subscribe to entity data. See `docHaystack::Ops#watchSub` chapter.
is: op
lib: lib:ph

op:watchUnsub
comment: Unsubscribe to entity data. See `docHaystack::Ops#watchUnsub` chapter.
is: op
lib: lib:ph

openEnum
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:ph

outdoorUnit
type: Class
subclass of: marker
comment: operates outside the conditioned space
is: marker
lib: lib:phIoT

output
type: Class
subclass of: marker
comment: Entity outputs a substance with flows to other entities
is: marker
lib: lib:ph

outputs
type: DatatypeProperty
range: symbol
comment: The entity outputs a substance to the referent. The value of this tag is what is supplied.
is: relationship
lib: lib:ph
reciprocalOf: inputs
transitive: marker

outside
type: Class
subclass of: ductSection
comment: Duct to access fresh outside air for both ventilation and economizer.
is: ductSection
lib: lib:phIoT

panel
type: Class
subclass of: equip
children: equip
  has tag: equip
children: point
  has tag: point
comment: Enclosure for electrical and control equipment. Panels may be used to isolate electrical connections and provide environmental protection.
is: equip
lib: lib:phIoT

parallel
type: Class
subclass of: marker
comment: Circuit with multiple paths of flow
is: marker
lib: lib:phIoT

perimeterHeat
type: Class
subclass of: marker
comment: Auxiliary heating points associated with a `vav`
is: marker
lib: lib:phIoT

pf
type: Class
subclass of: quantity
comment: Electrical power factor; unitless number between 0.0 and 1.0 which is ratio of active to apparent power in an AC power system.
is: quantity
lib: lib:phIoT
prefUnit: pf
quantityOf: ac-elec

pfDisplacement
type: Class
subclass of: pfScope
comment: Displacement power factor, which excludes effects of harmonic distortion.
is: pfScope
lib: lib:phIoT

pfDistortion
type: Class
subclass of: pfScope
comment: Distortion power factor
is: pfScope
lib: lib:phIoT

pfScope
type: Class
subclass of: choice
comment: Power factor scope
is: choice
lib: lib:phIoT

pfTrue
type: Class
subclass of: pfScope
comment: 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.
is: pfScope
lib: lib:phIoT

pfc
type: Class
subclass of: gas
comment: Perfluorocarbons
is: gas
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Fluorocarbon

pfc-emission
type: Class
subclass of: emission
comment: Greenhouse gas emission of perfluorocarbons into the air.
is: emission
lib: lib:phScience
prefUnit: kg
prefUnit: ton
prefUnit: lb
quantityOf: air

phase
type: DatatypeProperty
range: str
comment: Phase measurement in a three-phase electrical system. Phase is deprecated in favor of more explicit tags: - `lineVolt` - `phaseVolt` - `lineCurrent` - `phaseCurrent` - `linePower` - `phasePower` - `linePf` - `phasePf` - `lineEnergy` - `phaseEnergy` - `lineAvg` - `phaseAvg` - `neutral` - `ground`
enum: - 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
is: str
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Three-phase_electric_power

phaseAvg
type: Class
subclass of: marker
comment: 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 measurements defined in `phaseVolt`. When applied to a point entity that has the `elec` and `current` tags, indicates the average of all measurements defined in `phaseCurrent`. When applied to a point entity that has the `elec` and `power` tags, indicates the average of all measurements defined in `phasePower`. When applied to a point entity that has the `elec` and `pf` tags, indicates the average of all measurements defined in `phasePf`. When applied to a point entity that has the `elec` and `energy` tags, indicates the average of all measurements defined in `phaseEnergy`.
is: marker
lib: lib:phIoT

phaseCount
type: Class
subclass of: choice
comment: Number of phases for an AC electrical power system or connected equipment: single-phase or three-phase.
is: choice
lib: lib:phIoT
tagOn: ac-elec-meter
tagOn: motor

phaseCurrent
type: DatatypeProperty
range: str
comment: Single-phase current measured line-to-line in an AC electric power system. May also be referred to as a phase current measurement.
enum: - L1-L2: line 1 to line 2 measurement - L2-L3: line 2 to line 3 measurement - L3-L1: line 3 to line 1 measurement
is: elecLineToLine
lib: lib:phIoT

phaseEnergy
type: DatatypeProperty
range: str
comment: Single-phase energy measured line-to-neutral in an AC electric power system. Neutral might not be referenced, but implied.
enum: - L1: line 1 measurement - L2: line 2 measurement - L3: line 3 measurement
is: elecLine
lib: lib:phIoT

phasePf
type: DatatypeProperty
range: str
comment: Single-phase power factor measured line-to-neutral in an AC electric power system. Neutral might not be referenced, but implied.
enum: - L1: line 1 measurement - L2: line 2 measurement - L3: line 3 measurement
is: elecLine
lib: lib:phIoT

phasePower
type: DatatypeProperty
range: str
comment: Single-phase power measured line-to-neutral in an AC electric power system. May also be referred to as a phase power measurement.
enum: - L1: line 1 measurement - L2: line 2 measurement - L3: line 3 measurement
is: elecLine
lib: lib:phIoT

phaseVolt
type: DatatypeProperty
range: str
comment: Single-phase voltage measured line-to-neutral in an AC electric power system. May also be referred to as a phase voltage measurement.
enum: - L1-N: line 1 to neutral measurement - L2-N: line 2 to neutral measurement - L3-N: line 3 to neutral measurement
is: elecLineToNeutral
lib: lib:phIoT

phenomenon
type: Class
subclass of: marker
comment: Aspect of scientific interest with measurable quantities
docTaxonomy: marker
is: marker
lib: lib:phScience

phone
type: Class
subclass of: device
comment: Telephone used for voice telecommunication.
is: device
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Telephone

pipe
type: Class
subclass of: conduit
children: equip
  has tag: equip
children: point
  has tag: flow
  has tag: sensor
  has tag: point
children: point
  has tag: flow
  has tag: sp
  has tag: point
children: point
  has tag: point
children: point
  has tag: pressure
  has tag: sensor
  has tag: point
children: point
  has tag: pressure
  has tag: sp
  has tag: point
children: pump-motor
  has tag: pump
  has tag: motor
  has tag: equip
children: point
  has tag: temp
  has tag: sensor
  has tag: point
children: point
  has tag: temp
  has tag: sp
  has tag: point
children: valve-actuator
  has tag: valve
  has tag: actuator
  has tag: equip
childrenFlatten: fluid
childrenFlatten: pipeSection
childrenFlatten: plantLoop
comment: Conduit used to convey a fluid
is: conduit
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Pipe_(fluid_conveyance)

pipeFluid
type: Class
subclass of: choice
comment: Type of fluid conveyed by piping
is: choice
lib: lib:phIoT
of: fluid
tagOn: pipe
tagOn: valve-actuator
tagOn: pump-motor

pipeSection
type: Class
subclass of: choice
comment: Equipment section of piping
is: choice
lib: lib:phIoT
tagOn: pipe
tagOn: valve-actuator
tagOn: pump-motor

plant
type: Class
subclass of: equip
children: point
  has tag: enable
  has tag: cmd
  has tag: point
children: equip
  has tag: equip
children: point
  has tag: point
comment: Central plant used to generate a substance for a process. See `docHaystack::Plants`.
is: equip
lib: lib:phIoT

plantLoop
type: Class
subclass of: choice
comment: Plant piping loop: primary, secondary, or tertiary
is: choice
lib: lib:phIoT
tagOn: pipe

pm01
type: Class
subclass of: solid
comment: Particulate matter 0.1; atmospheric pollutant of fine particles with an aerodynamic diameter of 0.1 micrometers or less
is: solid
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Particulates

pm01-concentration
type: Class
subclass of: airQuality
comment: Concentration of particulate matter 0.1 in the air.
is: airQuality
lib: lib:phScience
prefUnit: µg/m³
prefUnit: ppb
quantityOf: air
wikipedia: https://en.wikipedia.org/wiki/Concentration

pm10
type: Class
subclass of: solid
comment: Particulate matter 10; atmospheric pollutant of fine particles with an aerodynamic diameter of 10 micrometers or less
is: solid
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Particulates

pm10-concentration
type: Class
subclass of: airQuality
comment: Concentration of particulate matter 10 in the air
is: airQuality
lib: lib:phScience
prefUnit: µg/m³
prefUnit: ppb
quantityOf: air
wikipedia: https://en.wikipedia.org/wiki/Concentration

pm25
type: Class
subclass of: solid
comment: Particulate matter 2.5; atmospheric pollutant of fine particles with an aerodynamic diameter of 2.5 micrometers or less
is: solid
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Particulates

pm25-concentration
type: Class
subclass of: airQuality
comment: Concentration of particulate matter 2.5 in the air.
is: airQuality
lib: lib:phScience
prefUnit: µg/m³
prefUnit: ppb
quantityOf: air
wikipedia: https://en.wikipedia.org/wiki/Concentration

point
type: Class
subclass of: entity
comment: Data point such as a sensor or actuator. See `docHaystack::Points` chapter.
docTaxonomy: marker
is: entity
lib: lib:phIoT
mandatory: marker

pointFunction
type: Class
subclass of: choice
comment: Classifies the point as a sensor, command, or setpoint. See `docHaystack::Points#function` chapter.
is: choice
lib: lib:phIoT
tagOn: point

pointGroup
type: Class
subclass of: entity
comment: Grouping of children points used by spaces and equipment
is: entity
lib: lib:phIoT

pointQuantity
type: Class
subclass of: choice
comment: Quantity the point senses or controls
is: choice
lib: lib:phIoT
of: quantity
tagOn: point

pointRef
type: ObjectProperty
domain: sim-point
range: point
comment: See `docHaystack::Synthetics#structure` chapter.
is: ref
lib: lib:phIoT
of: point
tagOn: sim-point

pointSubject
type: Class
subclass of: choice
comment: What the point senses or controls
is: choice
lib: lib:phIoT
of: phenomenon
tagOn: point

pop3
type: Class
subclass of: protocol
comment: Post Office Protocol version 3 for retrieving email
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Post_Office_Protocol

port
type: Class
subclass of: marker
comment: A gateway or opening used to transfer a substance.
is: marker
lib: lib:phIoT

power
type: Class
subclass of: quantity
comment: Energy consumed per unit time
is: quantity
lib: lib:phScience

powerConverter
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:phIoT

precipitation
type: Class
subclass of: quantity
comment: Amount of atmospheric water vapor fallen including rain, sleet, snow, and hail
is: quantity
lib: lib:phScience
prefUnit: mm
prefUnit: in
quantityOf: weather

prefUnit
type: DatatypeProperty
range: list
comment: Defines a preferred unit to be used with a quantity
is: list
lib: lib:phScience
of: unit

pressure
type: Class
subclass of: quantity
comment: Measure of force applied
is: quantity
lib: lib:phScience
prefUnit: kPa
prefUnit: psi
quantityOf: fluid
wikipedia: https://en.wikipedia.org/wiki/Pressure

pressureDependent
type: Class
subclass of: vavModulation
comment: VAV damper modulates to control space temp; dependent on duct pressure being maintained
is: vavModulation
lib: lib:phIoT

pressureIndependent
type: Class
subclass of: vavModulation
comment: VAV damper or a control valve that modulates to maintain desired flow setpoint; independent of the duct pressure
is: vavModulation
lib: lib:phIoT

primaryFunction
type: DatatypeProperty
domain: site
range: str
comment: Primary function of building as US Energy Star key
enum: 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
is: str
lib: lib:phIoT
tagOn: site

primaryLoop
type: Class
subclass of: plantLoop
comment: 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.
is: plantLoop
lib: lib:phIoT

process
type: Class
subclass of: marker
comment: Industrial or HVAC process
docTaxonomy: marker
is: marker
lib: lib:phIoT

propane
type: Class
subclass of: gas
comment: By-product of natural gas processing and petroleum refining (C₃H₈)
is: gas
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Propane

propaneHeating
type: Class
subclass of: heatingProcess
comment: Heating by the combustion of propane
is: heatingProcess
lib: lib:phIoT

protocol
type: Class
subclass of: marker
comment: Communication protocol used for devices on a network.
docTaxonomy: marker
is: marker
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Communication_protocol

pump
type: Class
subclass of: marker
comment: Pump equipment or control point
is: marker
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Pump

pump-motor
type: Class
subclass of: motor
children: point
  has tag: alarm
  has tag: sensor
  has tag: point
children: point
  has tag: enable
  has tag: cmd
  has tag: point
children: point
  has tag: enable
  has tag: sensor
  has tag: point
children: equip
  has tag: equip
children: point
  has tag: point
children: point
  has tag: run
  has tag: cmd
  has tag: point
children: point
  has tag: run
  has tag: sensor
  has tag: point
children: point
  has tag: vfd
  has tag: freq
  has tag: cmd
  has tag: point
children: point
  has tag: vfd
  has tag: freq
  has tag: sensor
  has tag: point
children: point
  has tag: vfd
  has tag: speed
  has tag: cmd
  has tag: point
children: point
  has tag: vfd
  has tag: speed
  has tag: sensor
  has tag: point
childrenFlatten: fluid
childrenFlatten: pipeSection
childrenFlatten: pump
comment: Motor used with a pump to move fluid. See `docHaystack::Motors` chapter.
is: motor
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Pump

purge
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:phIoT

purge-water
type: Class
subclass of: water
comment: Water expelled from a system to remove contaminants.
is: water
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Water

quality
type: Class
subclass of: marker
comment: Quantity measured against standard metric
is: marker
lib: lib:phScience

quantities
type: DatatypeProperty
range: list
computedFromReciprocal: marker
comment: Quantities used to measure this phenomenon
docAssociations: marker
is: association
lib: lib:phScience
of: symbol
reciprocalOf: quantityOf

quantity
type: Class
subclass of: marker
comment: Measurable property of a substance or phenomenon
docTaxonomy: marker
is: marker
lib: lib:phScience

quantityOf
type: DatatypeProperty
range: list
comment: Associates quantity as measurement of a phenomenon
is: association
lib: lib:phScience
of: phenomenon
reciprocalOf: quantities

rack
type: Class
subclass of: equip
children: equip
  has tag: equip
children: networking-device
  has tag: networking
  has tag: device
children: point
  has tag: point
children: device
  has tag: server
  has tag: device
comment: 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.
is: equip
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/19-inch_rack

radiantEquip
type: Class
subclass of: equip
children: equip
  has tag: equip
children: point
  has tag: point
comment: HVAC equipment that conditions a space without forced air.
is: equip
lib: lib:phIoT

radiantFloor
type: Class
subclass of: radiantEquip
children: equip
  has tag: equip
children: point
  has tag: point
comment: Heats a space using pipes or cables embedded beneath floor.
is: radiantEquip
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Underfloor_heating

radiator
type: Class
subclass of: radiantEquip
children: equip
  has tag: equip
children: point
  has tag: point
comment: 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.
is: radiantEquip
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Radiator_(heating)

rated
type: Class
subclass of: marker
comment: Data specified by a manufacturer or rating organization. Typically this information is from the equipment data plate or cut sheet. Also see `design`.
is: marker
lib: lib:phIoT

reactive
type: Class
subclass of: marker
comment: Relating to reactance
is: marker
lib: lib:phIoT

reactive-energy
type: Class
subclass of: quantity
comment: Integral of `reactive-power` over time
is: quantity
lib: lib:phIoT
quantityOf: ac-elec

reactive-power
type: Class
subclass of: quantity
comment: Reactive power or imaginary power; energy transfer that contributes useful work
is: quantity
lib: lib:phIoT
prefUnit: kVAR
quantityOf: ac-elec

reciprocal
type: Class
subclass of: marker
comment: Piston compressor driven by a crankshaft
is: marker
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Reciprocating_compressor

reciprocalOf
type: DatatypeProperty
range: symbol
comment: Specifies the inverse of an association or relationships. See [Associations]`docHaystack::Associations#reciprocalOf` and [Relationships]`docHaystack::Relationships#reciprocalOf` chapter.
is: symbol
lib: lib:ph

ref
type: DatatypeProperty
subclass of: anyURI
comment: 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`.
is: scalar
lib: lib:ph

refrig
type: Class
subclass of: fluid
comment: Fluid used in refrigeration and heat exchange. Refrigerants typically alternate between liquid and gas state.
is: fluid
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Refrigerant

refrig-input
type: Class
subclass of: input
comment: Entity inputs refrigerant which flows from another entity
is: input
lib: lib:phIoT

refrig-output
type: Class
subclass of: output
comment: Entity outputs refrigerant to other entities
is: output
lib: lib:phIoT

refrig-system
type: Class
subclass of: system
children: equip
  has tag: equip
children: point
  has tag: point
comment: Refrigerant distribution to fulfill all or parts of a refrigeration cycle.
is: system
lib: lib:phIoT

refrigRef
type: ObjectProperty
domain: refrig-input
range: refrig-output
comment: Refrigerant flows from the referent to this entity
inputs: refrig
is: ref
lib: lib:phIoT
of: refrig-output
tagOn: refrig-input

reheat
type: Class
subclass of: marker
comment: Command point for reheating process
is: marker
lib: lib:phIoT

relationship
type: DatatypeProperty
range: symbol
comment: Ref tags used to model entity-to-entity relationships. See [Relationships]`docHaystack::Relationships` chapter.
docTaxonomy: marker
is: symbol
lib: lib:ph

remove
type: DatatypeProperty
subclass of: string
comment: Singleton for remove operation. See [Kinds chapter]`docHaystack::Kinds#remove`.
is: scalar
lib: lib:ph

return
type: Class
subclass of: ductSection
comment: Duct returning air back to equipment
is: ductSection
lib: lib:phIoT

roof
type: Class
subclass of: marker
comment: Envelope covering the top of a building
is: marker
lib: lib:phIoT

roof-floor
type: Class
subclass of: floor
children: equip
  has tag: equip
children: point
  has tag: point
children: space
  has tag: space
comment: The roof floor is the topmost level of a building. It is often where HVAC equipment is located such as rooftop AHUs.
is: floor
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Storey

room
type: Class
subclass of: space
children: space
  has tag: space
children: equip
  has tag: equip
children: point
  has tag: point
comment: Enclosed room of a building
is: space
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Room

rotaryScrew
type: Class
subclass of: marker
comment: Rotary screw compression
is: marker
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Rotary-screw_compressor

router
type: Class
subclass of: marker
comment: Device used to route data packets
is: marker
lib: lib:phIct

rtu
type: Class
subclass of: ahu
children: point
  has tag: bypass
  has tag: damper
  has tag: cmd
  has tag: point
children: point
  has tag: cool
  has tag: cmd
  has tag: point
children: point
  has tag: dessicantDehumidifier
  has tag: cmd
  has tag: point
children: duct
  has tag: discharge
  has tag: duct
  has tag: equip
children: duct
  has tag: economizer
  has tag: duct
  has tag: equip
children: point
  has tag: economizing
  has tag: cmd
  has tag: point
children: equip
  has tag: equip
children: duct
  has tag: exhaust
  has tag: duct
  has tag: equip
children: point
  has tag: faceBypass
  has tag: cmd
  has tag: point
children: point
  has tag: filter
  has tag: sensor
  has tag: point
children: point
  has tag: freezeStat
  has tag: sensor
  has tag: point
children: point
  has tag: heat
  has tag: cmd
  has tag: point
children: point
  has tag: heatWheel
  has tag: cmd
  has tag: point
children: humidifier-equip
  has tag: humidifier
  has tag: equip
children: point
  has tag: hvacMode
  has tag: sp
  has tag: point
children: duct
  has tag: mixed
  has tag: duct
  has tag: equip
children: duct
  has tag: outside
  has tag: duct
  has tag: equip
children: point
  has tag: point
children: duct
  has tag: return
  has tag: duct
  has tag: equip
children: thermostat
  has tag: thermostat
  has tag: equip
children: duct
  has tag: ventilation
  has tag: duct
  has tag: equip
comment: Roof Top Unit: A unitary AHU that is weatherized for outdoor use. See `docHaystack::AHUs` chapter.
is: ahu
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Air_handler

run
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:phIoT

scalar
type: DatatypeProperty
comment: Scalar is an atomic value kind
is: val
lib: lib:ph

secondaryLoop
type: Class
subclass of: plantLoop
comment: 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.
is: plantLoop
lib: lib:phIoT

sensor
type: Class
subclass of: pointFunction
comment: Point is a sensor, input, AI/BI. See `docHaystack::Points#function` chapter.
is: pointFunction
lib: lib:phIoT

series
type: Class
subclass of: marker
comment: Circuit with single path of flow
is: marker
lib: lib:phIoT

server
type: Class
subclass of: marker
comment: Hardware or software which provides services for other programs or devices.
is: marker
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Server_(computing)

server-computer
type: Class
subclass of: computer
comment: General purpose computer used as a server. Typically servers are rack mounted.
is: computer
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Server_(computing)

serviceFactor
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:phIoT

sf6
type: Class
subclass of: gas
comment: Sulphur hexafluoride (SF₆)
is: gas
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Sulfur_hexafluoride

sf6-emission
type: Class
subclass of: emission
comment: Greenhouse gas emission of sulphur hexafluoride (SF₆) into the air.
is: emission
lib: lib:phScience
prefUnit: kg
prefUnit: ton
prefUnit: lb
quantityOf: air

sim
type: Class
subclass of: synthetic
comment: Simulation point. See `docHaystack::Synthetics` chapter.
is: synthetic
lib: lib:phIoT

sim-point
type: Class
subclass of: synthetic-point
comment: See `docHaystack::Synthetics` chapter.
is: synthetic-point
lib: lib:phIoT

Baseline
type: Class
subclass of: simScenario
dis: Baseline
comment: See `docHaystack::Synthetics#sims` chapter.
is: simScenario
lib: lib:phIoT

simModel
type: Class
subclass of: syntheticModel
comment: See `docHaystack::Synthetics` chapter.
is: syntheticModel
lib: lib:phIoT

Operation
type: Class
subclass of: simScenario
dis: Operation
comment: See `docHaystack::Synthetics#sims` chapter.
is: simScenario
lib: lib:phIoT

Optimum
type: Class
subclass of: simScenario
dis: Optimum
comment: See `docHaystack::Synthetics#sims` chapter.
is: simScenario
lib: lib:phIoT

simScenario
type: Class
subclass of: choice
comment: See `docHaystack::Synthetics#sims` chapter.
is: choice
lib: lib:phIoT
tagOn: sim-point

singleDuct
type: Class
subclass of: ductConfig
comment: One single duct
is: ductConfig
lib: lib:phIoT

singlePhase
type: Class
subclass of: phaseCount
comment: Single-phase AC electrical power. Power is provided by a single AC voltage source.
is: phaseCount
lib: lib:phIoT

site
type: Class
subclass of: entity
subclass of: geoPlace
children: space
  has tag: space
children: equip
  has tag: equip
comment: 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.
docTaxonomy: marker
is: entity
is: geoPlace
lib: lib:phIoT
mandatory: marker

siteMeter
type: Class
subclass of: meterScope
comment: Main meter for the associated site
is: meterScope
lib: lib:phIoT

siteRef
type: ObjectProperty
domain: system
domain: space
domain: equip
domain: point
range: site
containedBy: site
comment: Reference to site which contains the entity
is: ref
lib: lib:phIoT
of: site
tagOn: system
tagOn: space
tagOn: equip
tagOn: point

smtp
type: Class
subclass of: protocol
comment: Simple Mail Transfer Protocol for sending email
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol

snmp
type: Class
subclass of: protocol
comment: Simple Network Management Protocol for managing IP devices
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol

solar
type: Class
subclass of: phenomenon
comment: Relating to energy from the sun
is: phenomenon
lib: lib:phScience

solar-irradiance
type: Class
subclass of: irradiance
comment: Energy received on surface of the earth from the sun
is: irradiance
lib: lib:phScience
prefUnit: W/m²
quantityOf: solar

solid
type: Class
subclass of: substance
comment: Substance with definite shape and volume
is: substance
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Solid

sox
type: Class
subclass of: protocol
comment: Sedona Framework UDP based communication protocol
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Communication_protocol

sp
type: Class
subclass of: pointFunction
comment: Point is a setpoint, soft point, internal control variable, schedule. See `docHaystack::Points#function` chapter.
is: pointFunction
lib: lib:phIoT

space
type: Class
subclass of: entity
children: space
  has tag: space
children: equip
  has tag: equip
children: point
  has tag: point
comment: Space is a three-dimensional volume in the built environment. See `docHaystack::Spaces` chapter.
docTaxonomy: marker
is: entity
lib: lib:phIoT
mandatory: marker

spaceRef
type: ObjectProperty
domain: space
domain: equip
domain: point
range: space
containedBy: space
comment: Reference to space which contains this entity
is: ref
lib: lib:phIoT
of: space
tagOn: space
tagOn: equip
tagOn: point

span
type: DatatypeProperty
range: xstr
comment: Time span as modeled encoded as XStr. This is a placeholder to eventually formalize the time range used by hisRead op.
is: xstr
lib: lib:ph

speed
type: Class
subclass of: quantity
comment: Distance per unit time
is: quantity
lib: lib:phScience
prefUnit: km/h
prefUnit: mph

stage
type: DatatypeProperty
range: number
comment: Stage number of staged equipment operation such as coil or pump. The first stage is 1, second stage 2, etc.
is: int
lib: lib:phIoT
minVal: 1

standby
type: Class
subclass of: marker
comment: Readiness mode of a space
is: marker
lib: lib:phIoT

stateOfCharge
type: Class
subclass of: quantity
comment: 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%.
is: quantity
lib: lib:phIoT
prefUnit: %
quantityOf: dc-elec
wikipedia: https://en.wikipedia.org/wiki/State_of_charge

steam
type: Class
subclass of: gas
comment: Water in its gas form
is: gas
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Steam

steam-boiler
type: Class
subclass of: boiler
subclass of: steam-output
children: point
  has tag: alarm
  has tag: sensor
  has tag: point
children: pipe
  has tag: circ
  has tag: pipe
  has tag: equip
children: pipe
  has tag: condensate
  has tag: entering
  has tag: pipe
  has tag: equip
children: equip
  has tag: equip
children: duct
  has tag: flue
  has tag: duct
  has tag: equip
children: pipe
  has tag: makeup
  has tag: water
  has tag: entering
  has tag: pipe
  has tag: equip
children: duct
  has tag: outside
  has tag: duct
  has tag: equip
children: point
  has tag: point
children: pipe
  has tag: steam
  has tag: leaving
  has tag: pipe
  has tag: equip
comment: Boiler which outputs steam
is: boiler
is: steam-output
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Boiler

steam-input
type: Class
subclass of: input
comment: Entity inputs steam which flows from another entity
is: input
lib: lib:phIoT

steam-output
type: Class
subclass of: output
comment: Entity outputs steam to other entities
is: output
lib: lib:phIoT

steam-plant
type: Class
subclass of: plant
subclass of: steam-output
children: pipe
  has tag: condensate
  has tag: entering
  has tag: pipe
  has tag: equip
children: point
  has tag: enable
  has tag: cmd
  has tag: point
children: equip
  has tag: equip
children: duct
  has tag: flue
  has tag: duct
  has tag: equip
children: pipe
  has tag: makeup
  has tag: water
  has tag: entering
  has tag: pipe
  has tag: equip
children: duct
  has tag: outside
  has tag: duct
  has tag: equip
children: point
  has tag: point
children: steam-boiler
  has tag: steam
  has tag: boiler
  has tag: equip
children: pipe
  has tag: steam
  has tag: bypass
  has tag: pipe
  has tag: equip
children: point
  has tag: steam
  has tag: delta
  has tag: flow
  has tag: sensor
  has tag: point
children: point
  has tag: steam
  has tag: delta
  has tag: pressure
  has tag: sensor
  has tag: point
children: point
  has tag: steam
  has tag: delta
  has tag: temp
  has tag: sensor
  has tag: point
children: pipe
  has tag: steam
  has tag: header
  has tag: pipe
  has tag: equip
children: heatExchanger
  has tag: steam
  has tag: heatExchanger
  has tag: equip
children: pipe
  has tag: steam
  has tag: leaving
  has tag: pipe
  has tag: equip
children: point
  has tag: steam
  has tag: mixing
  has tag: valve
  has tag: cmd
  has tag: point
comment: Plant used to generate steam for heating. See `docHaystack::Plants`.
is: plant
is: steam-output
lib: lib:phIoT

steam-system
type: Class
subclass of: water-system
children: equip
  has tag: equip
children: point
  has tag: point
comment: System that circulates water in its vapor state for heating a space or process.
is: water-system
lib: lib:phIoT

steamHeating
type: Class
subclass of: heatingProcess
subclass of: steam-input
comment: Heating using energy of steam
is: heatingProcess
is: steam-input
lib: lib:phIoT

steamRef
type: ObjectProperty
domain: steam-input
range: steam-output
comment: Steam flows from the referent to this entity
inputs: steam
is: ref
lib: lib:phIoT
of: steam-output
tagOn: steam-input

str
type: DatatypeProperty
subclass of: string
comment: Unicode string of characters. See [Kinds chapter]`docHaystack::Kinds#str`.
is: scalar
lib: lib:ph

submeter
type: Class
subclass of: meterScope
comment: Submeters measure usage of a sub-system or equipment within a site
is: meterScope
lib: lib:phIoT

submeterOf
type: ObjectProperty
domain: meter
range: meter
comment: Reference to parent meter which is immediately upstream of this meter
is: ref
lib: lib:phIoT
of: meter
tagOn: meter

substance
type: Class
subclass of: phenomenon
comment: Matter in one the three states solid, liquid, or gas
is: phenomenon
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Matter

subterranean
type: Class
subclass of: marker
comment: Below the surface of the earth
is: marker
lib: lib:phIoT

subterranean-floor
type: Class
subclass of: floor
children: equip
  has tag: equip
children: point
  has tag: point
children: space
  has tag: space
comment: Floor below ground level. Subterranean floors are also known as basements, lower levels, or cellars.
is: floor
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Storey

switch
type: Class
subclass of: marker
comment: Device for toggling state or routing data
is: marker
lib: lib:phIoT

symbol
type: DatatypeProperty
subclass of: anyURI
comment: 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`.
is: scalar
lib: lib:ph

synthetic
type: Class
subclass of: pointFunction
comment: 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.
is: pointFunction
lib: lib:phIoT
mandatory: marker
tagOn: point

synthetic-point
type: Class
subclass of: point
comment: See `docHaystack::Synthetics` chapter.
is: point
lib: lib:phIoT

syntheticModel
type: Class
subclass of: entity
comment: See `docHaystack::Synthetics` chapter.
is: entity
lib: lib:phIoT
mandatory: marker

syntheticModelRef
type: ObjectProperty
domain: synthetic-point
range: syntheticModel
comment: See `docHaystack::Synthetics` chapter.
is: ref
lib: lib:phIoT
of: syntheticModel
tagOn: synthetic-point

system
type: Class
subclass of: entity
children: equip
  has tag: equip
children: point
  has tag: point
comment: Grouping of related equipment dedicated to a single application. See `docHaystack::Systems` chapter.
docTaxonomy: marker
is: entity
lib: lib:phIoT
mandatory: marker

systemRef
type: ObjectProperty
domain: equip
domain: point
domain: system
range: system
comment: Reference to system
is: ref
lib: lib:phIoT
of: system
tagOn: equip
tagOn: point
tagOn: system

tablet
type: Class
subclass of: device
comment: Mobile device with touch screen for user input.
is: device
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Tablet_computer

tagOn
type: DatatypeProperty
domain: def
range: list
accumulate: marker
comment: This tag is used on the given entity
is: association
lib: lib:ph
notInherited: marker
of: symbol
reciprocalOf: tags
tagOn: def

tags
type: DatatypeProperty
range: list
computedFromReciprocal: marker
comment: Tags used with this entity
docAssociations: marker
is: association
lib: lib:ph
of: symbol
reciprocalOf: tagOn

tank
type: Class
subclass of: equip
children: equip
  has tag: equip
children: point
  has tag: level
  has tag: sensor
  has tag: point
children: point
  has tag: point
children: point
  has tag: pressure
  has tag: sensor
  has tag: point
children: point
  has tag: temp
  has tag: sensor
  has tag: point
childrenFlatten: substance
comment: Tank used to store a substance for temporary holding
is: equip
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Storage_tank

tankSubstance
type: Class
subclass of: choice
comment: Substance stored by a tank
is: choice
lib: lib:phIoT
of: substance
tagOn: tank

temp
type: Class
subclass of: quantity
comment: Temperature - measure of hot and cold
is: quantity
lib: lib:phScience
prefUnit: °C
prefUnit: °F
quantityOf: substance
wikipedia: https://en.wikipedia.org/wiki/Temperature

tertiaryLoop
type: Class
subclass of: plantLoop
comment: Pipework which circulates within the building.
is: plantLoop
lib: lib:phIoT

thd
type: Class
subclass of: marker
comment: Total harmonic distortion
is: marker
lib: lib:phIoT

thermal
type: Class
subclass of: marker
comment: Related to energy of heat
is: marker
lib: lib:phIoT

thermostat
type: Class
subclass of: equip
subclass of: hvacZonePoints
children: equip
  has tag: equip
children: point
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: dewPoint
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: dewPoint
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: enthalpy
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: enthalpy
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: humidity
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: humidity
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: hvacMode
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: pressure
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: pressure
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: effective
  has tag: cooling
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: effective
  has tag: heating
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: effective
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: occ
  has tag: cooling
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: occ
  has tag: heating
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: sensor
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: standby
  has tag: cooling
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: standby
  has tag: heating
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: unocc
  has tag: cooling
  has tag: sp
  has tag: point
children: point
  has tag: zone
  has tag: air
  has tag: temp
  has tag: unocc
  has tag: heating
  has tag: sp
  has tag: point
comment: Senses and controls temperature of space in HVAC system. Thermostats may provide an interface for setpoint control.
is: equip
is: hvacZonePoints
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Thermostat

threePhase
type: Class
subclass of: phaseCount
comment: Three-phase AC electrical power. Power is provided by three AC voltage sources, each separated from the others by a 120-degree phase angle.
is: phaseCount
lib: lib:phIoT

time
type: DatatypeProperty
subclass of: time
comment: ISO 8601 time as hour, minute, seconds: '09:51:27.354'. See [Kinds chapter]`docHaystack::Kinds#time`.
is: scalar
lib: lib:ph

total
type: Class
subclass of: marker
comment: Complete or absolute
is: marker
lib: lib:phScience

transient
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:ph
tagOn: def

transitive
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:ph

tripleDuct
type: Class
subclass of: ductConfig
comment: Three ducts: hotDeck, coldDeck, or neutralDeck
is: ductConfig
lib: lib:phIoT

tvoc
type: Class
subclass of: gas
comment: Total volatile organic compound (TVOC).
is: gas
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Volatile_organic_compound

tvoc-concentration
type: Class
subclass of: airQuality
comment: Concentration of total volatile organic compounds (TVOC) in the air
is: airQuality
lib: lib:phScience
prefUnit: µg/m³
prefUnit: ppb
quantityOf: air
wikipedia: https://en.wikipedia.org/wiki/Concentration

tz
type: DatatypeProperty
domain: point
domain: site
domain: weatherStation
range: str
comment: Timezone identifier from standard [timezone database]`docHaystack::TimeZones`
enum: 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 Monte…
is: str
lib: lib:ph
tagOn: point
tagOn: site
tagOn: weatherStation

unit
type: DatatypeProperty
domain: point
range: str
comment: Unit identifier from standard unit database
enum: - %: 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_escud…
is: str
lib: lib:ph
tagOn: point

unitVent
type: Class
subclass of: fcu
children: point
  has tag: bypass
  has tag: damper
  has tag: cmd
  has tag: point
children: point
  has tag: cool
  has tag: cmd
  has tag: point
children: point
  has tag: dessicantDehumidifier
  has tag: cmd
  has tag: point
children: duct
  has tag: discharge
  has tag: duct
  has tag: equip
children: duct
  has tag: economizer
  has tag: duct
  has tag: equip
children: point
  has tag: economizing
  has tag: cmd
  has tag: point
children: equip
  has tag: equip
children: duct
  has tag: exhaust
  has tag: duct
  has tag: equip
children: point
  has tag: faceBypass
  has tag: cmd
  has tag: point
children: point
  has tag: filter
  has tag: sensor
  has tag: point
children: point
  has tag: freezeStat
  has tag: sensor
  has tag: point
children: point
  has tag: heat
  has tag: cmd
  has tag: point
children: point
  has tag: heatWheel
  has tag: cmd
  has tag: point
children: humidifier-equip
  has tag: humidifier
  has tag: equip
children: point
  has tag: hvacMode
  has tag: sp
  has tag: point
children: duct
  has tag: mixed
  has tag: duct
  has tag: equip
children: duct
  has tag: outside
  has tag: duct
  has tag: equip
children: point
  has tag: point
children: duct
  has tag: return
  has tag: duct
  has tag: equip
children: thermostat
  has tag: thermostat
  has tag: equip
children: duct
  has tag: ventilation
  has tag: duct
  has tag: equip
comment: Unit Ventilator: An FCU that has direct access to outside air to provide the space with ventilation. See `docHaystack::AHUs` chapter.
is: fcu
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Fan_coil_unit

unocc
type: Class
subclass of: marker
comment: Unoccupied mode of a space. See `docHaystack::Zones#occupancy` chapter.
is: marker
lib: lib:phIoT

ups
type: Class
subclass of: equip
children: equip
  has tag: equip
children: point
  has tag: point
comment: Uninterruptible power supply
is: equip
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Uninterruptible_power_supply

uri
type: DatatypeProperty
subclass of: anyURI
comment: Universal resource identifier. See [Kinds chapter]`docHaystack::Kinds#uri`.
is: scalar
lib: lib:ph

val
comment: Data value type
docTaxonomy: marker
lib: lib:ph

valve
type: Class
subclass of: marker
comment: Valve equipment or control point
is: marker
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Valve

valve-actuator
type: Class
subclass of: actuator
children: equip
  has tag: equip
children: point
  has tag: point
children: point
  has tag: valve
  has tag: cmd
  has tag: point
children: point
  has tag: valve
  has tag: sensor
  has tag: point
childrenFlatten: fluid
childrenFlatten: pipeSection
comment: Actuator to regulate the flow of fluid.
is: actuator
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Valve

variableAirVolume
type: Class
subclass of: airVolumeAdjustability
comment: 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.
is: airVolumeAdjustability
lib: lib:phIoT

vav
type: Class
subclass of: airTerminalUnit
children: duct
  has tag: discharge
  has tag: duct
  has tag: equip
children: point
  has tag: ductArea
  has tag: sp
  has tag: point
children: equip
  has tag: equip
children: point
  has tag: hvacMode
  has tag: sp
  has tag: point
children: duct
  has tag: inlet
  has tag: duct
  has tag: equip
children: point
  has tag: perimeterHeat
  has tag: cmd
  has tag: point
children: point
  has tag: point
children: point
  has tag: reheat
  has tag: cmd
  has tag: point
children: thermostat
  has tag: thermostat
  has tag: equip
comment: Variable air volume terminal unit. VAV systems use a constant air temperature with a variable air flow rate. See `docHaystack::VAVs` chapter.
is: airTerminalUnit
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Variable_air_volume

vav-parallel
type: Class
subclass of: vavAirCircuit
comment: VAV pulls air from outside the primary air flow
is: vavAirCircuit
lib: lib:phIoT

vav-series
type: Class
subclass of: vavAirCircuit
comment: VAV pulls air from the primary air flow
is: vavAirCircuit
lib: lib:phIoT

vavAirCircuit
type: Class
subclass of: choice
comment: How does the VAV pull in air
is: choice
lib: lib:phIoT
tagOn: vav

vavModulation
type: Class
subclass of: choice
comment: How does VAV modulate the temp based on duct pressure
is: choice
lib: lib:phIoT
tagOn: vav

vavZone
type: Class
subclass of: ahuZoneDelivery
comment: AHU supplies air to VAV terminal units
is: ahuZoneDelivery
lib: lib:phIoT

velocity
type: Class
subclass of: marker
comment: Speed in a given direction
is: marker
lib: lib:phScience

ventilation
type: Class
subclass of: ductSection
comment: Duct to access fresh outside air only for ventilation, not economizing
is: ductSection
lib: lib:phIoT

version
type: DatatypeProperty
domain: lib
range: str
comment: Version string formatted as decimal integers separated by a dot
is: str
lib: lib:ph
tagOn: lib

verticalTransport
type: Class
subclass of: equip
children: equip
  has tag: equip
children: point
  has tag: point
comment: Equipment to move humans and materials
is: equip
lib: lib:phIoT

vfd
type: Class
subclass of: marker
comment: Variable-frequency drive. See `docHaystack::Motors` chapter.
is: marker
lib: lib:phIoT
tagOn: motor
wikipedia: https://en.wikipedia.org/wiki/Variable-frequency_drive

vfd-freq
type: Class
subclass of: quantity
comment: VFD frequency measured in "Hz".
is: quantity
lib: lib:phIoT
prefUnit: Hz

vfd-speed
type: Class
subclass of: quantity
comment: VFD speed measured in "%"; 0% is off and 100% is the fastest speed.
is: quantity
lib: lib:phIoT
prefUnit: %

visibility
type: Class
subclass of: quantity
comment: Distance at which light can be clearly discerned
is: quantity
lib: lib:phScience
prefUnit: km
prefUnit: mile
quantityOf: weather

volt
type: Class
subclass of: marker
comment: Electrical potential difference or electromotive force.
is: marker
lib: lib:phScience

volt-angle
type: Class
subclass of: quantity
comment: AC voltage phase angle
is: quantity
lib: lib:phIoT
prefUnit: deg
quantityOf: ac-elec

volt-imbalance
type: Class
subclass of: quantity
comment: AC voltage phase imbalance
is: quantity
lib: lib:phIoT
prefUnit: %
quantityOf: ac-elec

volt-magnitude
type: Class
subclass of: elec-volt
comment: Magnitude of electrical voltage
is: elec-volt
lib: lib:phIoT
prefUnit: A
quantityOf: ac-elec

volume
type: Class
subclass of: quantity
comment: Three dimensional space occupied by a substance
is: quantity
lib: lib:phScience
prefUnit: m³
prefUnit: ft³
prefUnit: L
prefUnit: gal
quantityOf: substance
wikipedia: https://en.wikipedia.org/wiki/Volume

vrf
type: Class
subclass of: marker
comment: Variable refigerant flow. See `docHaystack::VRF` chapter.
is: marker
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Variable_refrigerant_flow

vrf-coolingOnly-system
type: Class
subclass of: vrf-system
children: equip
  has tag: equip
children: point
  has tag: point
children: vrf-indoorUnit
  has tag: vrf
  has tag: indoorUnit
  has tag: equip
children: vrf-outdoorUnit
  has tag: vrf
  has tag: outdoorUnit
  has tag: equip
children: vrf-equip
  type: vrf-refrig-plant
  has tag: vrf
  has tag: refrig
  has tag: plant
  has tag: equip
comment: Cooling only VRF system can only cool; heating is not available. See `docHaystack::VRF#types` chapter.
is: vrf-system
lib: lib:phIoT

vrf-equip
type: Class
subclass of: equip
children: equip
  has tag: equip
children: point
  has tag: point
comment: Equipment used in VRF systems. See `docHaystack::VRF#equip` chapter.
is: equip
lib: lib:phIoT

vrf-heatPump-system
type: Class
subclass of: vrf-system
children: equip
  has tag: equip
children: point
  has tag: point
children: vrf-indoorUnit
  has tag: vrf
  has tag: indoorUnit
  has tag: equip
children: vrf-outdoorUnit
  has tag: vrf
  has tag: outdoorUnit
  has tag: equip
children: vrf-equip
  type: vrf-refrig-plant
  has tag: vrf
  has tag: refrig
  has tag: plant
  has tag: equip
comment: Heat pump VRF system can either heat, or cool, but not at the same time. See `docHaystack::VRF#types` chapter.
is: vrf-system
lib: lib:phIoT

vrf-heatRecovery-system
type: Class
subclass of: vrf-system
children: equip
  has tag: equip
children: point
  has tag: point
children: branchSelector
  has tag: vrf
  has tag: branchSelector
  has tag: equip
children: vrf-indoorUnit
  has tag: vrf
  has tag: indoorUnit
  has tag: equip
children: vrf-outdoorUnit
  has tag: vrf
  has tag: outdoorUnit
  has tag: equip
children: vrf-equip
  type: vrf-refrig-plant
  has tag: vrf
  has tag: refrig
  has tag: plant
  has tag: equip
comment: 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.
is: vrf-system
lib: lib:phIoT

vrf-indoorUnit
type: Class
subclass of: vrf-equip
subclass of: refrig-input
children: equip
  has tag: equip
children: point
  has tag: point
comment: Indoor unit in a VRF system. Indoor units operate to satisfy a heating or cooling load. See `docHaystack::VRF#indoorUnits` chapter.
is: vrf-equip
is: refrig-input
lib: lib:phIoT

vrf-indoorUnit-fcu
type: Class
subclass of: vrf-indoorUnit
subclass of: fcu
children: point
  has tag: bypass
  has tag: damper
  has tag: cmd
  has tag: point
children: point
  has tag: cool
  has tag: cmd
  has tag: point
children: point
  has tag: dessicantDehumidifier
  has tag: cmd
  has tag: point
children: duct
  has tag: discharge
  has tag: duct
  has tag: equip
children: duct
  has tag: economizer
  has tag: duct
  has tag: equip
children: point
  has tag: economizing
  has tag: cmd
  has tag: point
children: equip
  has tag: equip
children: duct
  has tag: exhaust
  has tag: duct
  has tag: equip
children: point
  has tag: faceBypass
  has tag: cmd
  has tag: point
children: point
  has tag: filter
  has tag: sensor
  has tag: point
children: point
  has tag: freezeStat
  has tag: sensor
  has tag: point
children: point
  has tag: heat
  has tag: cmd
  has tag: point
children: point
  has tag: heatWheel
  has tag: cmd
  has tag: point
children: humidifier-equip
  has tag: humidifier
  has tag: equip
children: point
  has tag: hvacMode
  has tag: sp
  has tag: point
children: duct
  has tag: mixed
  has tag: duct
  has tag: equip
children: duct
  has tag: outside
  has tag: duct
  has tag: equip
children: point
  has tag: point
children: duct
  has tag: return
  has tag: duct
  has tag: equip
children: thermostat
  has tag: thermostat
  has tag: equip
children: duct
  has tag: ventilation
  has tag: duct
  has tag: equip
comment: 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.
is: vrf-indoorUnit
is: fcu
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Fan_coil_unit

vrf-outdoorUnit
type: Class
subclass of: vrf-equip
subclass of: refrig-output
children: equip
  has tag: equip
children: point
  has tag: point
comment: 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.
is: vrf-equip
is: refrig-output
lib: lib:phIoT

vrf-refrig-plant
type: Class
subclass of: plant
subclass of: refrig-output
children: point
  has tag: enable
  has tag: cmd
  has tag: point
children: equip
  has tag: equip
children: point
  has tag: point
children: vrf-outdoorUnit
  has tag: vrf
  has tag: outdoorUnit
  has tag: equip
comment: Group of outdoor units in a VRF system. See `docHaystack::VRF#refrigPlant`.
is: plant
is: refrig-output
lib: lib:phIoT

vrf-system
type: Class
subclass of: refrig-system
children: equip
  has tag: equip
children: point
  has tag: point
children: vrf-indoorUnit
  has tag: vrf
  has tag: indoorUnit
  has tag: equip
children: vrf-outdoorUnit
  has tag: vrf
  has tag: outdoorUnit
  has tag: equip
children: vrf-equip
  type: vrf-refrig-plant
  has tag: vrf
  has tag: refrig
  has tag: plant
  has tag: equip
comment: Variable refigerant flow system. The system contains the indoor units, outdoor units, and branch selectors. See `docHaystack::VRF#types` chapter.
is: refrig-system
lib: lib:phIoT

warm
type: Class
subclass of: marker
comment: 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.
is: marker
lib: lib:phIoT

warm-water
type: Class
subclass of: water
comment: Relatively warm water without active heating
is: water
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Water

water
type: Class
subclass of: liquid
comment: Water in its liquid form
is: liquid
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Water

water-system
type: Class
subclass of: system
children: equip
  has tag: equip
children: point
  has tag: point
comment: System that supplies or collects potable or non-potable water in any state.
is: system
lib: lib:phIoT

waterCooling
type: Class
subclass of: coolingProcess
comment: Cooling using transfer of heat to water which is not explicitly chilled
is: coolingProcess
lib: lib:phIoT
wikipedia: https://en.wikipedia.org/wiki/Water_cooling

weather
type: Class
subclass of: phenomenon
comment: Associated with atmospheric air or phenomenon. See `docHaystack::Weather` chapter.
is: phenomenon
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Weather

weather-point
type: Class
subclass of: point
comment: Weather station observation point. See `docHaystack::Weather#points` chapter.
is: point
lib: lib:phIoT

weatherCond
type: Class
subclass of: quantity
comment: Enumeration of weather conditions
enum: unknown clear partlyCloudy cloudy showers rain thunderstorms ice flurries snow
is: quantity
lib: lib:phScience
quantityOf: weather

weatherStation
type: Class
subclass of: entity
subclass of: geoPlace
children: weather-point
  has tag: weather
  has tag: air
  has tag: temp
  has tag: sensor
  has tag: point
children: weather-point
  has tag: weather
  has tag: air
  has tag: wetBulb
  has tag: sensor
  has tag: point
children: weather-point
  has tag: weather
  has tag: air
  has tag: feelsLike
  has tag: sensor
  has tag: point
children: weather-point
  has tag: weather
  has tag: air
  has tag: dewPoint
  has tag: sensor
  has tag: point
children: weather-point
  has tag: weather
  has tag: air
  has tag: humidity
  has tag: sensor
  has tag: point
children: weather-point
  has tag: weather
  has tag: air
  has tag: enthalpy
  has tag: sensor
  has tag: point
children: weather-point
  has tag: weather
  has tag: atmospheric
  has tag: pressure
  has tag: sensor
  has tag: point
children: weather-point
  has tag: weather
  has tag: cloudage
  has tag: sensor
  has tag: point
children: weather-point
  has tag: weather
  has tag: daytime
  has tag: sensor
  has tag: point
children: weather-point
  has tag: weather
  has tag: precipitation
  has tag: sensor
  has tag: point
children: weather-point
  has tag: weather
  has tag: solar
  has tag: irradiance
  has tag: sensor
  has tag: point
children: weather-point
  has tag: weather
  has tag: weatherCond
  has tag: sensor
  has tag: point
children: weather-point
  has tag: weather
  has tag: wind
  has tag: speed
  has tag: sensor
  has tag: point
children: weather-point
  has tag: weather
  has tag: wind
  has tag: direction
  has tag: sensor
  has tag: point
children: weather-point
  has tag: weather
  has tag: visibility
  has tag: sensor
  has tag: point
comment: Logical weather station and its measurement points. See `docHaystack::Weather#stations` chapter.
is: entity
is: geoPlace
lib: lib:phIoT
mandatory: marker
wikipedia: https://en.wikipedia.org/wiki/Weather_station

weatherStationRef
type: ObjectProperty
domain: site
domain: weather-point
range: weatherStation
comment: Reference to weather station for to use this entity
is: ref
lib: lib:phIoT
of: weatherStation
tagOn: site
tagOn: weather-point

well
type: Class
subclass of: equip
children: equip
  has tag: equip
children: point
  has tag: point
children: point
  has tag: water
  has tag: flow
  has tag: sensor
  has tag: point
children: point
  has tag: water
  has tag: level
  has tag: sensor
  has tag: point
children: point
  has tag: water
  has tag: pressure
  has tag: sensor
  has tag: point
children: pump-motor
  has tag: water
  has tag: pump
  has tag: motor
  has tag: equip
children: point
  has tag: water
  has tag: temp
  has tag: sensor
  has tag: point
children: point
  has tag: water
  has tag: volume
  has tag: sensor
  has tag: point
comment: 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.
is: equip
lib: lib:phIoT

wetBulb
type: Class
subclass of: quantity
comment: Wet bulb air temperature. Temperature which the air would have if cooled to saturation by the evaporation of water into it.
is: quantity
lib: lib:phScience
prefUnit: °C
prefUnit: °F
quantityOf: air

wikipedia
type: DatatypeProperty
domain: def
range: uri
comment: Hyperlink to the subject's page on Wikipedia
is: uri
lib: lib:ph
tagOn: def

wind
type: Class
subclass of: phenomenon
comment: Flow of air on surface of the Earth
is: phenomenon
lib: lib:phScience
wikipedia: https://en.wikipedia.org/wiki/Wind

wind-direction
type: Class
subclass of: direction
comment: Compass direction from which wind originates
is: direction
lib: lib:phScience
prefUnit: deg
quantityOf: wind

wind-speed
type: Class
subclass of: speed
comment: Wind flow speed
is: speed
lib: lib:phScience
prefUnit: km/h
prefUnit: mph
quantityOf: wind

wire
type: Class
subclass of: conduit
children: equip
  has tag: equip
children: point
  has tag: point
comment: Cabling used to convey electricity or data
is: conduit
lib: lib:phIoT

writable
type: Class
subclass of: marker
comment: Supports writing data
is: marker
lib: lib:phIoT
tagOn: point

writable-point
type: Class
subclass of: point
comment: 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.
is: point
lib: lib:phIoT

writeErr
type: DatatypeProperty
domain: writable-point
range: str
comment: Error description when `writeStatus` indicates error condition
is: str
lib: lib:phIoT
tagOn: writable-point
transient: marker

writeLevel
type: DatatypeProperty
domain: writable-point
range: number
comment: Current priority level for `writeVal` as number between 1 and 17. The value 17 indicates the relinquish default value.
is: int
lib: lib:phIoT
maxVal: 17
minVal: 1
tagOn: writable-point
transient: marker

writeStatus
type: DatatypeProperty
domain: writable-point
range: str
comment: Current status of a writable point output
enum: - 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)
is: str
lib: lib:phIoT
tagOn: writable-point
transient: marker

writeVal
type: DatatypeProperty
subclass of: Literal
comment: 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.
is: scalar
lib: lib:phIoT
tagOn: writable-point
transient: marker

xstr
type: DatatypeProperty
subclass of: string
comment: Extended string - type name and string value encoding. See [Kinds chapter]`docHaystack::Kinds#xstr`.
is: scalar
lib: lib:ph

yearBuilt
type: DatatypeProperty
domain: site
range: number
comment: Original year of construction as four digit year such as 1980
is: int
lib: lib:phIoT
tagOn: site

zigbee
type: Class
subclass of: protocol
comment: Low power wireless communication protocol for home automation
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Zigbee

zone
type: Class
subclass of: marker
comment: Related to spaces from a system perspective
is: marker
lib: lib:phIoT

zone-space
type: Class
subclass of: space
children: equip
  has tag: equip
children: point
  has tag: occupancy
  has tag: sensor
  has tag: point
children: point
  has tag: occupied
  has tag: sensor
  has tag: point
children: point
  has tag: occupied
  has tag: sp
  has tag: point
children: point
  has tag: point
children: space
  has tag: space
comment: Space associated with a specific system. See `docHaystack::Spaces#zones` and `docHaystack::Zones` chapters.
is: space
lib: lib:phIoT

zwave
type: Class
subclass of: protocol
comment: Low power wireless communication protocol for home automation
is: protocol
lib: lib:phIct
wikipedia: https://en.wikipedia.org/wiki/Z-Wave