Skip to content

lib-phIoT 库参考 ​

原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793816396/FIN+5.3.1+lib-phIoT 中文整理基于 FIN 5.3.1

导读: 物联网的Project Haystack定义

以下为 API 参考,保留英文以便对照源码;目录已列出(英文标题便于检索);概述已尽量中译。


目录(导读) ​


概述(中译) ​

物联网的Project Haystack定义


API 正文(英文) ​

tags ​

absorptionCooling process using energy from heat source such as hot water
acRelating to alternating current (AC) electricity
ac-elecAlternating current electricity
ac-elec-meterAC Electricity meter
ac-evse-portAn AC EVSE port delivers ac electricity to a single EV charging inlet at a time
ac-freqFrequency of an alternating current waveform
activeWorking, operative, effective
active-energyActive energy in an AC eletrical power system
active-powerActive power or real power
actuatorEquipment to move or control a mechanism
ahuAir Handling Unit
ahuZoneDeliveryAHU delivery method of conditioned air to the zone
air-conditioning-systemSystem for air treatment to control its temperature, humidity, cleanliness, and distribution to meet the requirements of a conditioned space
air-exhaust-systemSystem consisting of one or more fans that remove air from the building
air-inputEntity inputs air which flows from another entity
air-outputEntity outputs air to other entities
air-systemSystem for moving air to maintain indoor thermal comfort and/or air quality
air-ventilation-systemSystem that supplies or removes air by natural or mechanical means to or from any space in order to provide outdoor air to the space
airCoolingCooling by dissipating heat into the surrounding air
airHandlingEquipHVAC equipment that conditions and delivers air via one or more fans
airQualityZonePointsEntity with logical grouping of zone air quality points
airRefAir flows from the referent to this entity
airTerminalUnitEquipment in air distribution systems which terminate at the space
airVolumeAdjustabilityAbility of air handling equip to adjust volume of air flow
alarmNotification of a condition which requires attention
apparent-energyApparent energy in an AC eletrical power system
apparent-powerApparent power
areaArea of a shape or floor space
atesAquifer Thermal Energy Storage system
atesClosedLoopThe ATES uses closed piping to transport a water/glycol mixture through the ground
atesDesignDesign type of the ATES underground system
atesDoubletThe ATES has one or more pairs of a separate warm and cool well
atesDoubletPairedThe ATES is as a doublet, but with specific warm and cool wells linked together
atesMonoThe ATES has only one physical well
atesUnidirectionalSimilar to a doublet, but water always flows in the same direction from the extraction to the infiltration well
barometricRelating atmospheric pressure
batteryEquipment used to store electric energy
biomassPlant or animal material used as fuel to produce electricity or heat
biomassHeatingHeating by the combustion of biomass
blowdownRemoval from container or pipe
blowdown-waterWater expelled from a system to remove mineral build up
blowdown-water-inputEntity inputs blowdown water which flows from another entity
blowdown-water-outputEntity outputs blowdown water to other entities
blowdownWaterRefBlowdown water flows from the referent to this entity
boilerEquipment to generate hot water or steam for heating
branchSelectorBranch selector used for heat recovery in a VRF system
bypassPipe used to bypass an equipment
cableAn assembly of one or more insulated conductors
cavConstant air volume terminal unit
centrifugalCompression via a continuous flow of fluid through an impeller
chilledSubstance is cooled using cooling process
chilled-waterWater cooled for use in HVAC and industrial processes
chilled-water-inputEntity inputs chilled water which flows from another entity
chilled-water-outputEntity outputs chilled water to other entities
chilled-water-plantPlant used to generate chilled water for cooling
chilled-water-systemSystem that circulates water in its liquid state below ambient temperature for cooling a space or process
chilledBeamConditions a space using a heat exchanger integrated into the ceiling
chilledBeamZoneAHU supplies air to chilled beam terminal units
chilledWaterCoolingCooling using transfer of heat to chilled water
chilledWaterRefChilled water flows from the referent to this entity
chillerEquipment to remove heat from a liquid
chiller-absorptionCooling process using energy from heat source such as hot water
chiller-centrifugalCompression via a continuous flow of fluid through an impeller
chiller-reciprocalPiston compressor driven by a crankshaft
chiller-rotaryScrewRotary screw compression
chillerMechanismPrimary mechanism of chiller
circPipe used to circulate fluid through an equipment or system
circuitElectrical circuit and its associated components such as breakers
cmdPoint is a command, actuator, AO/BO
coalCombustible sedimentary rock
coalHeatingHeating by the combustion of coal
coilHeat exchanger used to heat or cool air
coldHaving low degree of heat
cold-waterWater supplied to cold taps
coldDeckDuct carries air for cooling
compressorDevice for mechanically increasing the pressure of a gas or refrigerant vapor by reducing its volume
computedComputed point
computed-pointSee Synthetics chapter
computedModelSee Synthetics chapter
condensateLiquid phase produced by the condensation of steam or other gas
condensate-inputEntity inputs condensate which flows from another entity
condensate-outputEntity outputs condensate to other entities
condensateRefCondensate flows from the referent to this entity
condenserDevice or related to process of condensation
condenser-waterWater used used to remove heat through condensation
condenser-water-inputEntity inputs condenser water which flows from another entity
condenser-water-outputEntity outputs condenser water to other entities
condenser-water-systemSystem that circulates water in its liquid state for rejecting heat from a space or process
condenserClosedLoopWorking fluid is kept separate from fluid used for heat transfer into the atmosphere
condenserCoolingRemoval of heat through the process of water condensation
condenserLoopOpen or closed loop for condenser working fluid
condenserOpenLoopUses working fluid itself for evaporation into the atmosphere
condenserWaterRefCondenser water flows from the referent to this entity
conditioningRelated to cleaning, heating, cooling, humidifying, dehumidifying, ventilating or circulating  air.
conduitDuct, pipe, or cable to convey a substance or phenomenon
constantAirVolumeDelivers a constant volume of air flow
controlsAssociated with the control system for an industrial process
coolAssocited with low temperature or cooling processes
cool-waterRelatively cool water without active chilling
coolingCooling mode or process
coolingCapacityMeasurement of a chiller ability to remove heat measured
coolingCoilCoil used to cool air
coolingOnlyEquipment without heating
coolingProcessProcessed used to cool a substance
coolingTowerEquipment to transfer waste heat into the atmosphere
cracComputer Room Air Conditioner
curSupports current value
cur-pointPoint with support to report a "real-time" current value
curErrError description when curStatus indicates error condition
curStatusStatus of point's current value reading
curValCurrent value of a point
current-angleAC current phase angle
current-imbalanceAC current phase imbalance
current-magnitudeRoot-mean-square (RMS) magnitude of AC electrical current
current-thdTotal harmonic distortion (THD) of AC current
damperDamper equipment or control point
damper-actuatorActuator to regulate the flow of air
dcRelating to direct current (DC) electricity
dc-elecDirect current electricity
dc-elec-meterDC Electricity meter
dc-evse-portA DC EVSE port delivers dc electricity to a single EV charging inlet at a time
deadbandThe range in a process where no changes to output are made
deltaDifferential of fluid between entering and leaving sensors
demandRate required for a process
designData related to intended design and operating conditions
dessicantDehumidifierDecreases humidity from air using a substance which absorbs moisture
dieselLiquid fuel specifically designed for use in diesel engines
directZoneAHU supplies air directly to the zone
dischargeDuct for air leaving an equipment
dispenserEquipment that releases a specific amount of a substance
divertingThree way valve which inputs one pipe and diverts between two output pipes
doasDedicated Outside Air System
domesticFor human use
domestic-cold-water-systemSystem that circulates potable cold water in its liquid state for purposes other than space cooling and process requirements
domestic-hot-water-systemSystem that circulates potable hot water in its liquid state for purposes other than space heating and process requirements
domestic-waterTap water for drinking, washing, cooking, and flushing of toilets
domestic-water-inputEntity inputs domestic water which flows from another entity
domestic-water-outputEntity outputs domestic water to other entities
domestic-water-systemSystem that circulates potable water in its liquid state for purposes other than space conditioning and process requirements
domesticWaterRefDomestic water flows from the referent to this entity
dualDuctTwo ducts
ductConduit used to convey air for HVAC
ductAreaConfig point on a vav for duct area measured in ft² or m²
ductConfigDuctwork configuration
ductDeckCold, hot, or neutral deck
ductSectionEquipment section of ductwork
dxCoolingCooling using direct expansion of a refrigerant vapor
dxHeatingHeating using direct expansion of a refrigerant vapor
economizerDuct to access fresh outside air only for economizing, not ventilation
economizingEnergy reduction mode which augments heating/cooling with outside air
effectiveCurrent control setpoint in effect taking into account other factors
efficiencyEfficiency point of a chiller measured in "COP" or "kW/ton"
elec-demandActive power averaged over a regular interval
elec-inputEntity inputs electricity which flows from another entity
elec-meterElectricity meter
elec-outputEntity outputs electricity to other entities
elec-panelPhysical housing for electrical circuits, fuses, and breakers
elec-systemSystem that generates, converts, distributes, and/or stores electricity
elecHeatingHeating by the conversion of electrical energy
elecLineSingle-phase line measurement of an electric quantity in a multi-phase AC electric power system
elecLineToLineSingle-phase electric quantity measured line-to-line in a multi-phase AC electric power system
elecLineToNeutralSingle-phase electric quantity measured line-to-neutral in a multi-phase AC electric power system
elecRefElectricity flows from the referent to this entity
elevatorEnclosure used to move people between floors
enableSecondary on/off point of an equip especially used with a vfd
enteringPipe conveys fluid into an equipment
equipEquipment asset
equipRefReference to equip which contains this entity
escalatorMoving staircase used to move people between floors
evaporatorMechanism used to convert a refrigerant from its liquid to gaseous state
evseElectric Vehicle Supply Equipment
evse-cableThe electrical cable between an evse-port and an EV charging inlet on a vehicle
evse-dispenserEquipment that dispenses electricity to an EV
evse-equipEquipment that supports the delivery of electricity to charging inlets located on EVs
evse-portAn EVSE port delivers electricity to a single EV charging inlet at a time
evse-powerConverterA power converter that has a dc electrical output applied to a dc-evse-port
evse-systemA system that supplies electricity to EVSE assembly equipment and its auxiliary loads
evseCableTypePhysical type of evse-cable
evseSessionDescribes an event during which an evse-port can deliver power to an EV
evseStatusStatus of one or more evse-port reported by an EVSE
exhaustDuct used to expel air back outside
exportSupplied out of a system
extractionTaking a substance out of another substance
faceBypassPoint of an ahu indicating air flow is by-passing the heating/cooling coils
fanFan equipment or control point
fan-motorMotor used with a fan to create air flow
fanPoweredDevice with a fan
fcuFan Coil Unit
filterRelated to an air or fluid filter
floorStorey of a building
floorNumUnitless integer indicating the floor's distance from ground level
flow-meterMeter to measure flow rate and total volume of fluid
flowInverterSystem to change direction of substance flow
flueDuct for exhausting combustion
freezeStatA boolean point of an ahu indicating a freezing condition
fuelOilPetroleum based oil burned for energy
fuelOil-inputEntity inputs fuel oil which flows from another entity
fuelOil-outputEntity outputs fuel oil to other entities
fuelOilHeatingHeating by the combustion of fuel oil
fuelOilRefFuel oil flows from the referent to this entity
fumeHoodVentilation equipment to limit exposure to hazardous fumes
gasolinePetroleum derived liquid used as a fuel source
gasoline-inputEntity inputs gasoline which flows from another entity
gasoline-outputEntity outputs gasoline to other entities
gasolineRefGasoline flows from the referent to this entity
groundRelated to the surface of the earth
ground-floorFloor at ground level
ground-waterWater present under the ground or from a well
headerPipe used as central connection or manifold for other piping runs
heatAssociated with a heating process
heatExchangerEquipment to transfer heat between two working fluids
heatPumpEquipment that employs a vapor compression cycle with a reversing valve to provide heating or cooling
heatRecoveryTransfer of heat from one substance to another to reduce energy consumption
heatWheelBoolean point indicating command state of AHU's heat wheel
heatingHeating mode or process
heatingCoilCoil used to heat air
heatingOnlyEquipment without cooling
heatingProcessProcessed used to heat a substance
hisSupports historization of data
his-pointHistorized point with a history log of timestamp/value pairs
hisErrError description when hisStatus indicates error condition
hisModeIndicates the way that history data is collected for a point
hisStatusStatus of point's history collection or synchronization
hisTotalizedIndicates values which are a continuous stream of totalization
hotHaving high degree of heat
hot-waterHot water used for HVAC heating or supplied to hot taps
hot-water-boilerBoiler which outputs hot water
hot-water-inputEntity inputs hot water which flows from another entity
hot-water-outputEntity outputs hot water to other entities
hot-water-plantPlant used to generate hot water for heating
hot-water-systemSystem that circulates water in its liquid state for heating a space or process
hotDeckDuct carries air for heating
hotWaterHeatingHeating using energy of hot water
hotWaterRefHot water flows from the referent to this entity
humidifierAdding moisture to air
humidifier-equipEquipment which adds moisture to air to increase humidity
hvacHeating, ventilation, and air conditioning
hvac-zone-spaceZone related to conditioning of a space's air temperature and quality
hvacModeOperational mode for HVAC equipment
hvacZonePointsEntity with logical grouping of zone HVAC air points
imbalanceLacking balance
importReceived into a system
indoorUnitOperates inside the conditioned space
infiltrationPermeation of a substance into another substance
inletDuct with air entering an equipment
isolationActuator used to isolate an equipment from a pipe or ductwork system
leavingPipe conveys fluid out of an equipment
lightingSystems associated with illumination in the built environment
lighting-systemSystem designed to provide lighting
lighting-zone-spaceZone related to lighting system
lightingZonePointsEntity with logical grouping of lighting points
lineAvgLine average of single-phase electrical quantity measurements in an AC electric power system
lineCurrentSingle-phase line current measured in an AC electric power system
lineEnergySingle-phase energy measured line-to-line in an AC electric power system
linePfSingle-phase power factor measured line-to-line in an AC electric power system
linePowerSingle-phase power measured line-to-line in an AC electric power system
lineVoltSingle-phase voltage measured line-to-line in an AC electric power system
loadChiller point to command or measure the chiller's load as a percentage from "0%" to "100%"
luminaireLight fixture using electricity to provide illumination
makeupRestore something missed or lost
makeup-waterWater used used to makeup water loss through leaks, evaporation, or blowdown
makeup-water-inputEntity inputs makeup water which flows from another entity
makeup-water-outputEntity outputs makeup water to other entities
makeupWaterRefMakeup water flows from the referent to this entity
mauMakeup Air Unit
mechAssociated with a machine or its mechanical force, torque, power, or energy
meterEquipment to meter a substance or phenomenon
meterScopeClassifies a meter as a main site meter or submeter
mixedDuct where fresh outside air and return air is mixed together
mixingThree way valve which inputs two pipes and outputs a mixture between the two to a single output pipe
mlMachine learning point
ml-pointSee Synthetics chapter
mlIdentificationPeriodTraining period description, known as the identification period or baseline, utilized during the model training process
mlInputVarRefsList of independent variables, also known as model inputs or features, associated with a machine learning model
mlModelSee Synthetics chapter
mlModelMetricsGoodness-of-fit metrics provided in the form of a simple dictionary
mlModelParametersResult 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
mlOutputVarRefDependent variable, also known as the model output or target, associated, with a machine learning model
mlVarMachine learning variable representing both model inputs and outputs
mlVarFilterFilter used for querying points by tags, providing more flexibility than mlVarPoint, although it is not mandatory
mlVarPointReference to a point associated with a machine learning variable, known as a machine learning variable point
mlVarRefReference to a machine learning variable
motorEquipment that converts electrical energy into mechanical energy
movingWalkwayConveyor to move people across a horizontal or inclined plane
multiZoneAHU discharge air is split into a duct per zone
naturalGasFossil fuel energy source consisting largely of methane and other hydrocarbons
naturalGas-inputEntity inputs natural gas which flows from another entity
naturalGas-outputEntity outputs natural gas to other entities
naturalGasHeatingHeating by the combustion of natural gas
naturalGasRefNatural gas flows from the referent to this entity
netDifference between import and export
neutralwhen applied to a point entity that has the elec and current tags, indicates electrical current being measured on an electrical neutral conductor
neutralDeckDuct carries air which by-passes both heating and cooling coils
occOccupied mode of a space
occupancyNumber of occupants in a space
occupantsPeople who use the built environment
occupiedSetpoint or sensor indicating occupancy of a space
outdoorUnitoperates outside the conditioned space
outsideDuct to access fresh outside air for both ventilation and economizer
panelEnclosure for electrical and control equipment
parallelCircuit with multiple paths of flow
perimeterHeatAuxiliary heating points associated with a vav
pfElectric power factor
pfDisplacementDisplacement power factor, which accounts for the phase angle between voltage and current but excludes effects of nonlinear waveforms ( harmonic distortion)
pfDistortionDistortion power factor, which measures the component of power factor attributable to harmonic distortion in voltage and current waveforms
pfIecPower factor according to the IEC convention defines a positive or negative sign based on the direction of active power flow
pfIeeePower factor according to the IEEE convention defines a positive or negative sign based on whether the load is capacitive or inductive
pfScopePower factor scope
pfStandardStandard for interpreting power factor's positive or negative sign
pfTrueTrue power factor, which includes effects of harmonic distortion
phasePhase measurement in a three-phase electrical system
phaseAvgPhase average of single-phase electrical quantity measurements in an AC electric power system
phaseCountNumber of phases for an AC electrical power system or connected equipment
phaseCurrentSingle-phase current measured line-to-line in an AC electric power system
phaseEnergySingle-phase energy measured line-to-neutral in an AC electric power system
phasePfSingle-phase power factor measured line-to-neutral in an AC electric power system
phasePowerSingle-phase power measured line-to-neutral in an AC electric power system
phaseVoltSingle-phase voltage measured line-to-neutral in an AC electric power system
pipeConduit used to convey a fluid
pipeFluidType of fluid conveyed by piping
pipeSectionEquipment section of piping
plantCentral plant used to generate a substance for a process
plantLoopPlant piping loop
pointData point such as a sensor or actuator
pointFunctionClassifies the point as a sensor, command, or setpoint
pointGroupGrouping of children points used by spaces and equipment
pointQuantityQuantity the point senses or controls
pointRefSee Synthetics chapter
pointSubjectWhat the point senses or controls
portA gateway or opening used to transfer a substance
powerConverterConverts one electrical waveform to another using power electronic circuitry
pressureDependentVAV damper modulates to control space temp
pressureIndependentVAV damper or a control valve that modulates to maintain desired flow setpoint
primaryFunctionPrimary function of building as US Energy Star key
primaryLoopPipework which circulates closest to the energy source
processIndustrial or HVAC process
propaneBy-product of natural gas processing and petroleum refining (C₃H₈)
propaneHeatingHeating by the combustion of propane
pumpPump equipment or control point
pump-motorMotor used with a pump to move fluid
purgeAssociated with a cleaning process to remove contaminants
purge-waterWater expelled from a system to remove contaminants
radiantEquipHVAC equipment that conditions a space without forced air
radiantFloorHeats a space using pipes or cables embedded beneath floor
radiatorHeats a space using exposed pipes or coils
ratedData specified by a manufacturer or rating organization
reactiveRelating to reactance
reactive-energyReactive energy in an AC eletrical power system
reactive-powerReactive power or imaginary power
reciprocalPiston compressor driven by a crankshaft
refrigFluid used in refrigeration and heat exchange
refrig-inputEntity inputs refrigerant which flows from another entity
refrig-outputEntity outputs refrigerant to other entities
refrig-systemRefrigerant distribution to fulfill all or parts of a refrigeration cycle
refrigRefRefrigerant flows from the referent to this entity
reheatCommand point for reheating process
returnDuct returning air back to equipment
roofEnvelope covering the top of a building
roof-floorThe roof floor is the topmost level of a building
roomEnclosed room of a building
rotaryScrewRotary screw compression
rtuRoof Top Unit
runPrimary on/off point of an equip especially used with a vfd
secondaryLoopPipework which circulates closest to the building or end use
sensorPoint is a sensor, input, AI/BI
seriesCircuit with single path of flow
serviceFactorRatio 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
simSimulation point
sim-pointSee Synthetics chapter
simBaselineSee Synthetics chapter
simModelSee Synthetics chapter
simOperationSee Synthetics chapter
simOptimumSee Synthetics chapter
simScenarioSee Synthetics chapter
singleDuctOne single duct
singlePhaseSingle-phase AC electricity
siteSite is a geographic location of the built environment
siteMeterMain meter for the associated site
siteRefReference to site which contains the entity
spPoint is a setpoint, soft point, internal control variable, schedule
spaceSpace is a three-dimensional volume in the built environment
spaceRefReference to space which contains this entity
splitPhaseSplit-phase AC electricity
stageStage number of staged equipment operation such as coil or pump
standbyReadiness mode of a space
stateOfChargeState of charge (SoC) of an electric battery
steam-boilerBoiler which outputs steam
steam-inputEntity inputs steam which flows from another entity
steam-outputEntity outputs steam to other entities
steam-plantPlant used to generate steam for heating
steam-systemSystem that circulates water in its vapor state for heating a space or process
steamHeatingHeating using energy of steam
steamRefSteam flows from the referent to this entity
submeterSubmeters measure usage of a sub-system or equipment within a site
submeterOfReference to parent meter which is immediately upstream of this meter
subterraneanBelow the surface of the earth
subterranean-floorFloor below ground level
switchDevice for toggling state or routing data
syntheticSynthetic point with computed operational data
synthetic-pointSee Synthetics chapter
syntheticModelSee Synthetics chapter
syntheticModelRefSee Synthetics chapter
systemGrouping of related equipment dedicated to a single application
systemRefReference to system
tankTank used to store a substance for temporary holding
tankSubstanceSubstance stored by a tank
tertiaryLoopPipework which circulates within the building
thdTotal harmonic distortion
thermalRelated to energy of heat
thermostatSenses and controls temperature of space in HVAC system
threePhaseThree-phase AC electricity
tripleDuctThree ducts
twoPhaseTwo-phase AC electricity
unitVentUnit Ventilator
unoccUnoccupied mode of a space
valveValve equipment or control point
valve-actuatorActuator to regulate the flow of fluid
variableAirVolumeDelivers a variable volume of air flow
vavVariable air volume terminal unit
vav-parallelVAV pulls air from outside the primary air flow
vav-seriesVAV pulls air from the primary air flow
vavAirCircuitHow does the VAV pull in air
vavModulationHow does VAV modulate the temp based on duct pressure
vavZoneAHU supplies air to VAV terminal units
ventilationDuct to access fresh outside air only for ventilation, not economizing
verticalTransportEquipment to move humans and materials
vfdVariable-frequency drive
vfd-freqVFD frequency measured in "Hz"
vfd-speedVFD speed measured in "%"
volt-angleAC voltage phase angle
volt-imbalanceAC voltage phase imbalance
volt-magnitudeRoot-mean-square (RMS) magnitude of AC electrical voltage
volt-thdTotal harmonic distortion (THD) of AC voltage
vrfVariable refigerant flow
vrf-coolingOnly-systemCooling only VRF system can only cool
vrf-equipEquipment used in VRF systems
vrf-heatPump-systemHeat pump VRF system can either heat, or cool, but not at the same time
vrf-heatRecovery-systemHeat recovery VRF system can operate cooling and heating by each indoor unit independently, at the same time
vrf-indoorUnitIndoor unit in a VRF system
vrf-indoorUnit-fcuIndoor unit fan coil unit in a VRF system
vrf-outdoorUnitOutdoor unit with one or more compressors in a VRF system
vrf-refrig-plantGroup of outdoor units in a VRF system
vrf-systemVariable refigerant flow system
warmRelatively warm in comparison to another substance, without being actively heated
warm-waterRelatively warm water without active heating
water-systemSystem that supplies or collects potable or non-potable water in any state
waterCoolingCooling using transfer of heat to water which is not explicitly chilled
weather-pointWeather station observation point
weatherStationLogical weather station and its measurement points
weatherStationRefReference to weather station for to use this entity
wellA well is a source of groundwater and potentially thermal energy
wireCabling used to convey electricity or data
writableSupports writing data
writable-pointPoint with writable output using 16-level priority array
writeErrError description when writeStatus indicates error condition
writeLevelCurrent priority level for writeVal as number between 1 and 17
writeStatusCurrent status of a writable point output
writeValCurrent desired value to write to output
yearBuiltOriginal year of construction as four digit year such as 1980
zoneRelated to spaces from a system perspective
zone-spaceSpace associated with a specific system

ops ​

hisReadRead historized time series data from a his-point
hisWriteWrite historized time series data from a his-point
invokeActionInvoke a user action on a target entity
pointWriteRead or command a writable-point


def ​

absorption ​

Cooling process using energy from heat source such as hot water


meta ​

defabsorption
ismarker
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Absorption_refrigerator

supertypes ​

markerMarker labels a dict with typing information

subtypes ​

chiller-absorptionCooling process using energy from heat source such as hot water


def ​

ac-elec-meter ​

AC Electricity meter. See Meters chapter.


conjunct ​

acRelating to alternating current (AC) electricity
elecAssociated with electricity or with electrical force, power, or energy
meterEquipment to meter a substance or phenomenon

meta ​

defac-elec-meter
iconEquipIcon
iselec-meter
liblib:phIoT

usage ​

ac  elec  meter  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
meterEquipment to meter a substance or phenomenon
elec-meterElectricity meter
inputEntity inputs a substance which flows from another entity
elec-inputEntity inputs electricity which flows from another entity
outputEntity outputs a substance with flows to other entities
elec-outputEntity outputs electricity to other entities

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
elecRefElectricity flows from the referent to this entity
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
idDefines the unique identifier of an entity in system using a ref value type
meterScopeClassifies a meter as a main site meter or submeter
navNameNavigation name commonly used with disMacro to create computed display strings
phaseCountNumber of phases for an AC electrical power system or connected equipment
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
submeterOfReference to parent meter which is immediately upstream of this meter
systemRefReference to system
tariffHisRefIf multiple meters share the same tariff history, then you can use this tag to reference the "master" point containing the tariff history

children ​

avg ac elec current angle sensor point
avg ac elec current imbalance sensor point
avg ac elec current imbalance sensor point
avg ac elec current magnitude sensor point
avg ac elec current magnitude sensor point
avg ac elec current thd sensor point
avg ac elec current thd sensor point
avg ac elec pf sensor point
avg ac elec pf sensor point
avg ac elec volt angle sensor point
avg ac elec volt angle sensor point
avg ac elec volt imbalance sensor point
avg ac elec volt imbalance sensor point
avg ac elec volt magnitude sensor point
avg ac elec volt magnitude sensor point
avg ac elec volt thd sensor point
avg ac elec volt thd sensor point
phase:"A" ac elec current angle sensor point
phase:"A" ac elec current angle sensor point
phase:"A" ac elec current imbalance sensor point
phase:"A" ac elec current imbalance sensor point
phase:"A" ac elec current magnitude sensor point
phase:"A" ac elec current magnitude sensor point
phase:"A" ac elec current thd sensor point
phase:"A" ac elec current thd sensor point
phase:"A" ac elec pf sensor point
phase:"A" ac elec pf sensor point
phase:"A" ac elec volt angle sensor point
phase:"A" ac elec volt angle sensor point
phase:"A" ac elec volt imbalance sensor point
phase:"A" ac elec volt imbalance sensor point
phase:"A" ac elec volt magnitude sensor point
phase:"A" ac elec volt magnitude sensor point
phase:"A" ac elec volt thd sensor point
phase:"A" ac elec volt thd sensor point
phase:"A" active ac elec power sensor point
phase:"A" active ac elec power sensor point
phase:"A" apparent ac elec power sensor point
phase:"A" apparent ac elec power sensor point
phase:"A" net ac elec active energy sensor point
phase:"A" net ac elec active energy sensor point
phase:"A" reactive ac elec power sensor point
phase:"A" reactive ac elec power sensor point
total ac elec demand sensor point
total ac elec demand sensor point
total active ac elec power sensor point
total active ac elec power sensor point
total apparent ac elec power sensor point
total apparent ac elec power sensor point
total export ac elec active energy sensor point
total export ac elec active energy sensor point
total import ac elec active energy sensor point
total import ac elec active energy sensor point
total net ac elec active energy sensor point
total net ac elec active energy sensor point
total reactive ac elec power sensor point
total reactive ac elec power sensor point


def ​

ac-elec ​

Alternating current electricity


conjunct ​

acRelating to alternating current (AC) electricity
elecAssociated with electricity or with electrical force, power, or energy

meta ​

defac-elec
iselec
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Alternating_current

usage ​

ac  elec

supertypes ​

markerMarker labels a dict with typing information
phenomenonAspect of scientific interest with measurable quantities
elecAssociated with electricity or with electrical force, power, or energy

quantities ​

ac-freqFrequency of an alternating current waveform
active-energyActive energy in an AC eletrical power system
active-powerActive power or real power
apparent-energyApparent energy in an AC eletrical power system
apparent-powerApparent power
current-angleAC current phase angle
current-imbalanceAC current phase imbalance
current-magnitudeRoot-mean-square (RMS) magnitude of AC electrical current
current-thdTotal harmonic distortion (THD) of AC current
elec-currentElectrical current
elec-energyElectrical energy
elec-powerRate of electrical energy transfer
elec-voltElectrical voltage, potential difference
pfElectric power factor
reactive-energyReactive energy in an AC eletrical power system
reactive-powerReactive power or imaginary power
volt-angleAC voltage phase angle
volt-imbalanceAC voltage phase imbalance
volt-magnitudeRoot-mean-square (RMS) magnitude of AC electrical voltage
volt-thdTotal harmonic distortion (THD) of AC voltage


def ​

ac-evse-port ​

An AC EVSE port delivers ac electricity to a single EV charging inlet at a time. See EVSE 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 Meters chapter for more details.


conjunct ​

acRelating to alternating current (AC) electricity
evseElectric Vehicle Supply Equipment
portA gateway or opening used to transfer a substance

meta ​

defac-evse-port
iconbolt
isevse-port
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Charging_station

usage ​

ac  evse  port  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
evse-equipEquipment that supports the delivery of electricity to charging inlets located on EVs
evse-portAn EVSE port delivers electricity to a single EV charging inlet at a time
meterEquipment to meter a substance or phenomenon
elec-meterElectricity meter
inputEntity inputs a substance which flows from another entity
elec-inputEntity inputs electricity which flows from another entity
outputEntity outputs a substance with flows to other entities
elec-outputEntity outputs electricity to other entities

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
elecRefElectricity flows from the referent to this entity
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
idDefines the unique identifier of an entity in system using a ref value type
meterScopeClassifies a meter as a main site meter or submeter
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
submeterOfReference to parent meter which is immediately upstream of this meter
systemRefReference to system
tariffHisRefIf multiple meters share the same tariff history, then you can use this tag to reference the "master" point containing the tariff history

children ​

dc elec stateOfCharge sensor point
evse cable equip
evse cable equip
evse evseStatus sensor point
evse evseStatus sensor point
import ac elec active energy hisTotalized sensor point
import ac elec active energy hisTotalized sensor point
import ac elec active power max sp point
import ac elec active power max sp point
import ac elec active power sensor point
import ac elec active power sensor point
import ac elec magnitude current max sp point
import ac elec magnitude current max sp point
import ac elec magnitude current sensor point
import ac elec magnitude current sensor point
import ac elec magnitude volt sensor point
import ac elec magnitude volt sensor point
import ac elec pfScope pf sensor point
import ac elec pfScope pf sensor point


def ​

ac-freq ​

Frequency of an alternating current waveform


conjunct ​

acRelating to alternating current (AC) electricity
freqOccurrences per unit time

meta ​

defac-freq
isfreq
liblib:phIoT
prefUnitHz
quantityOfac-elec

usage ​

ac  freq

supertypes ​

markerMarker labels a dict with typing information
quantityMeasurable property of a substance or phenomenon
freqOccurrences per unit time


def ​

ac ​

Relating to alternating current (AC) electricity


meta ​

defac
ismarker
liblib:phIoT

supertypes ​

markerMarker labels a dict with typing information


def ​

active-energy ​

Active energy in an AC eletrical power system. Integral of active-power over time.


conjunct ​

activeWorking, operative, effective
energyMeasure of ability to do work

meta ​

defactive-energy
iselec-energy
liblib:phIoT
prefUnitkWh
quantityOfac-elec
wikipediahttps://en.wikipedia.org/wiki/Electrical_energy

usage ​

active  energy

supertypes ​

markerMarker labels a dict with typing information
quantityMeasurable property of a substance or phenomenon
energyMeasure of ability to do work
elec-energyElectrical energy


def ​

active-power ​

Active power or real power; represents energy transfer that contributes useful work.


conjunct ​

activeWorking, operative, effective
powerEnergy consumed per unit time

meta ​

defactive-power
iselec-power
liblib:phIoT
prefUnitkW
quantityOfac-elec
wikipediahttps://en.wikipedia.org/wiki/Electric_power

usage ​

active  power

supertypes ​

markerMarker labels a dict with typing information
quantityMeasurable property of a substance or phenomenon
powerEnergy consumed per unit time
elec-powerRate of electrical energy transfer

subtypes ​

elec-demandActive power averaged over a regular interval


def ​

active ​

Working, operative, effective


meta ​

defactive
ismarker
liblib:phIoT

supertypes ​

markerMarker labels a dict with typing information


def ​

actuator ​

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.


meta ​

defactuator
iconEquipIcon
isequip, elec-input
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Actuator

usage ​

actuator  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
inputEntity inputs a substance which flows from another entity
elec-inputEntity inputs electricity which flows from another entity

subtypes ​

damper-actuatorActuator to regulate the flow of air
valve-actuatorActuator to regulate the flow of fluid

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
elecRefElectricity flows from the referent to this entity
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

equip
point
point


def ​

ahu ​

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 AHUs chapter.


meta ​

defahu
iconEquipIcon
isairHandlingEquip
liblib:phIoT
mandatory✓
navTargetequip
wikipediahttps://en.wikipedia.org/wiki/Air_handler

usage ​

ahu  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
airHandlingEquipHVAC equipment that conditions and delivers air via one or more fans
inputEntity inputs a substance which flows from another entity
elec-inputEntity inputs electricity which flows from another entity
outputEntity outputs a substance with flows to other entities
air-outputEntity outputs air to other entities

subtypes ​

doasDedicated Outside Air System
mauMakeup Air Unit
rtuRoof Top Unit

tags ​

ahuZoneDeliveryAHU delivery method of conditioned air to the zone
airVolumeAdjustabilityAbility of air handling equip to adjust volume of air flow
coolingProcessProcessed used to cool a substance
disDisplay name for an entity
disMacroDisplay name using macro syntax
ductConfigDuctwork configuration
ductDeckCold, hot, or neutral deck
elecRefElectricity flows from the referent to this entity
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
heatingProcessProcessed used to heat a substance
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

bypass damper cmd point
cool cmd point
cool cmd point
dessicantDehumidifier cmd point
dessicantDehumidifier cmd point
discharge duct equip
discharge duct equip
economizer duct equip
economizer duct equip
economizing cmd point
economizing cmd point
exhaust duct equip
exhaust duct equip
faceBypass cmd point
faceBypass cmd point
filter sensor point
filter sensor point
freezeStat sensor point
freezeStat sensor point
heat cmd point
heat cmd point
heatWheel cmd point
heatWheel cmd point
humidifier equip
humidifier equip
hvacMode sp point
hvacMode sp point
mixed duct equip
mixed duct equip
outside duct equip
outside duct equip
return duct equip
return duct equip
thermostat equip
thermostat equip
ventilation duct equip
ventilation duct equip


def ​

ahuZoneDelivery ​

AHU delivery method of conditioned air to the zone


meta ​

defahuZoneDelivery
ischoice
liblib:phIoT
tagOnairHandlingEquip
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection

subtypes ​

chilledBeamZoneAHU supplies air to chilled beam terminal units
directZoneAHU supplies air directly to the zone
multiZoneAHU discharge air is split into a duct per zone
vavZoneAHU supplies air to VAV terminal units


def ​

air-conditioning-system ​

System for air treatment to control its temperature, humidity, cleanliness, and distribution to meet the requirements of a conditioned space.


conjunct ​

airThe mixture of gases which surrounds the earth
conditioningRelated to cleaning, heating, cooling, humidifying, dehumidifying, ventilating or circulating  air.
systemGrouping of related equipment dedicated to a single application

meta ​

defair-conditioning-system
isair-system
liblib:phIoT

usage ​

air  conditioning  system

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
systemGrouping of related equipment dedicated to a single application
air-systemSystem for moving air to maintain indoor thermal comfort and/or air quality

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
systemRefReference to system

children ​

equip
point
point


def ​

air-exhaust-system ​

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.


conjunct ​

airThe mixture of gases which surrounds the earth
exhaustDuct used to expel air back outside
systemGrouping of related equipment dedicated to a single application

meta ​

defair-exhaust-system
isair-system
liblib:phIoT

usage ​

air  exhaust  system

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
systemGrouping of related equipment dedicated to a single application
air-systemSystem for moving air to maintain indoor thermal comfort and/or air quality

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
systemRefReference to system

children ​

equip
point
point


def ​

air-input ​

Entity inputs air which flows from another entity


conjunct ​

airThe mixture of gases which surrounds the earth
inputEntity inputs a substance which flows from another entity

meta ​

defair-input
isinput
liblib:phIoT

usage ​

air  input

supertypes ​

markerMarker labels a dict with typing information
inputEntity inputs a substance which flows from another entity

subtypes ​

airCoolingCooling by dissipating heat into the surrounding air
airTerminalUnitEquipment in air distribution systems which terminate at the space
cavConstant air volume terminal unit
vavVariable air volume terminal unit
hvac-zone-spaceZone related to conditioning of a space's air temperature and quality

tags ​

airRefAir flows from the referent to this entity


def ​

air-output ​

Entity outputs air to other entities


conjunct ​

airThe mixture of gases which surrounds the earth
outputEntity outputs a substance with flows to other entities

meta ​

defair-output
isoutput
liblib:phIoT

usage ​

air  output

supertypes ​

markerMarker labels a dict with typing information
outputEntity outputs a substance with flows to other entities

subtypes ​

airHandlingEquipHVAC equipment that conditions and delivers air via one or more fans
ahuAir Handling Unit
doasDedicated Outside Air System
mauMakeup Air Unit
rtuRoof Top Unit
fcuFan Coil Unit
cracComputer Room Air Conditioner
unitVentUnit Ventilator
vrf-indoorUnit-fcuIndoor unit fan coil unit in a VRF system
airTerminalUnitEquipment in air distribution systems which terminate at the space
cavConstant air volume terminal unit
vavVariable air volume terminal unit


def ​

air-system ​

System for moving air to maintain indoor thermal comfort and/or air quality.


conjunct ​

airThe mixture of gases which surrounds the earth
systemGrouping of related equipment dedicated to a single application

meta ​

defair-system
issystem
liblib:phIoT

usage ​

air  system

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
systemGrouping of related equipment dedicated to a single application

subtypes ​

air-conditioning-systemSystem for air treatment to control its temperature, humidity, cleanliness, and distribution to meet the requirements of a conditioned space
air-exhaust-systemSystem consisting of one or more fans that remove air from the building
air-ventilation-systemSystem that supplies or removes air by natural or mechanical means to or from any space in order to provide outdoor air to the space

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
systemRefReference to system

children ​

equip
point
point


def ​

air-ventilation-system ​

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.


conjunct ​

airThe mixture of gases which surrounds the earth
ventilationDuct to access fresh outside air only for ventilation, not economizing
systemGrouping of related equipment dedicated to a single application

meta ​

defair-ventilation-system
isair-system
liblib:phIoT

usage ​

air  ventilation  system

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
systemGrouping of related equipment dedicated to a single application
air-systemSystem for moving air to maintain indoor thermal comfort and/or air quality

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
systemRefReference to system

children ​

equip
point
point


def ​

airCooling ​

Cooling by dissipating heat into the surrounding air


meta ​

defairCooling
iscoolingProcess, air-input
liblib:phIoT
uiInputui::ChoiceInput
wikipediahttps://en.wikipedia.org/wiki/Air_cooling

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
coolingProcessProcessed used to cool a substance
inputEntity inputs a substance which flows from another entity
air-inputEntity inputs air which flows from another entity

tags ​

airRefAir flows from the referent to this entity


def ​

airHandlingEquip ​

HVAC equipment that conditions and delivers air via one or more fans. Conditioning of air includes heating, cooling, humidification, dehumidification, and ventilation. See AHUs chapter.


meta ​

defairHandlingEquip
iconfan
isequip, air-output, elec-input
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Air_handler

usage ​

airHandlingEquip  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
inputEntity inputs a substance which flows from another entity
elec-inputEntity inputs electricity which flows from another entity
outputEntity outputs a substance with flows to other entities
air-outputEntity outputs air to other entities

subtypes ​

ahuAir Handling Unit
doasDedicated Outside Air System
mauMakeup Air Unit
rtuRoof Top Unit
fcuFan Coil Unit
cracComputer Room Air Conditioner
unitVentUnit Ventilator
vrf-indoorUnit-fcuIndoor unit fan coil unit in a VRF system

tags ​

ahuZoneDeliveryAHU delivery method of conditioned air to the zone
airVolumeAdjustabilityAbility of air handling equip to adjust volume of air flow
coolingProcessProcessed used to cool a substance
disDisplay name for an entity
disMacroDisplay name using macro syntax
ductConfigDuctwork configuration
ductDeckCold, hot, or neutral deck
elecRefElectricity flows from the referent to this entity
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
heatingProcessProcessed used to heat a substance
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

bypass damper cmd point
cool cmd point
cool cmd point
dessicantDehumidifier cmd point
dessicantDehumidifier cmd point
discharge duct equip
discharge duct equip
economizer duct equip
economizer duct equip
economizing cmd point
economizing cmd point
exhaust duct equip
exhaust duct equip
faceBypass cmd point
faceBypass cmd point
filter sensor point
filter sensor point
freezeStat sensor point
freezeStat sensor point
heat cmd point
heat cmd point
heatWheel cmd point
heatWheel cmd point
humidifier equip
humidifier equip
hvacMode sp point
hvacMode sp point
mixed duct equip
mixed duct equip
outside duct equip
outside duct equip
return duct equip
return duct equip
thermostat equip
thermostat equip
ventilation duct equip
ventilation duct equip


def ​

airQualityZonePoints ​

Entity with logical grouping of zone air quality points. See Zones chapter.


meta ​

defairQualityZonePoints
ispointGroup
liblib:phIoT

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
pointGroupGrouping of children points used by spaces and equipment

subtypes ​

hvac-zone-spaceZone related to conditioning of a space's air temperature and quality

tags ​

disDisplay name for an entity
idDefines the unique identifier of an entity in system using a ref value type

children ​

zone air ch2o concentration sensor point
zone air co concentration sensor point
zone air co concentration sensor point
zone air co2 concentration sensor point
zone air co2 concentration sensor point
zone air co2 concentration sp point
zone air co2 concentration sp point
zone air nh3 concentration sensor point
zone air nh3 concentration sensor point
zone air no2 concentration sensor point
zone air no2 concentration sensor point
zone air o3 concentration sensor point
zone air o3 concentration sensor point
zone air pm01 concentration sensor point
zone air pm01 concentration sensor point
zone air pm10 concentration sensor point
zone air pm10 concentration sensor point
zone air pm25 concentration sensor point
zone air pm25 concentration sensor point
zone air tvoc concentration sensor point
zone air tvoc concentration sensor point


def ​

airRef ​

Air flows from the referent to this entity


meta ​

defairRef
inputsair
isref
liblib:phIoT
ofair-output
tagOnair-input

supertypes ​

valData value type
scalarScalar is an atomic value kind
refReference to an entity


def ​

airTerminalUnit ​

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.


meta ​

defairTerminalUnit
iconfan
isequip, air-input, air-output, elec-input
liblib:phIoT

usage ​

airTerminalUnit  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
inputEntity inputs a substance which flows from another entity
air-inputEntity inputs air which flows from another entity
elec-inputEntity inputs electricity which flows from another entity
outputEntity outputs a substance with flows to other entities
air-outputEntity outputs air to other entities

subtypes ​

cavConstant air volume terminal unit
vavVariable air volume terminal unit

tags ​

airRefAir flows from the referent to this entity
disDisplay name for an entity
disMacroDisplay name using macro syntax
ductConfigDuctwork configuration
elecRefElectricity flows from the referent to this entity
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

discharge duct equip
inlet duct equip
inlet duct equip
thermostat equip
thermostat equip


def ​

airVolumeAdjustability ​

Ability of air handling equip to adjust volume of air flow


meta ​

defairVolumeAdjustability
ischoice
liblib:phIoT
tagOnairHandlingEquip
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection

subtypes ​

constantAirVolumeDelivers a constant volume of air flow
variableAirVolumeDelivers a variable volume of air flow


def ​

alarm ​

Notification of a condition which requires attention


meta ​

defalarm
ismarker
liblib:phIoT

supertypes ​

markerMarker labels a dict with typing information

subtypes ​

alarmHistoryAlarm history record

tags ​

ackErrThis tag is set when there is an error acknowledging alarm and contains the reason for the error
ackInProgressThis alarm is current being acknowledged
ackMessageMessage or reason for acknowledgement
ackMessageRequiredThis alarm requires a message when acknowledging
ackRequiredThis alarm requires acknowledgement
ackedTime that the alarm was acknowledged
ackedByWho acknowledged the alarm
createdThe timestamp when entity was created
curStatusStatus of point's current value reading
curValCurrent value of a point
messageMessage describing the alarm or reason for the alarm
metadataInformation related to the alarm that will live with the lifecycle of the alarm
occurredDate/Time that the alarm actually occurred
sourceRefReference to the source of the alarm
stateState of the alarm


def ​

apparent-energy ​

Apparent energy in an AC eletrical power system. Integral of apparent-power over time.


conjunct ​

apparentPerceived quantity
energyMeasure of ability to do work

meta ​

defapparent-energy
isquantity
liblib:phIoT
quantityOfac-elec

usage ​

apparent  energy

supertypes ​

markerMarker labels a dict with typing information
quantityMeasurable property of a substance or phenomenon


def ​

apparent-power ​

Apparent power; the perceived magnitude of electric power transfer in an AC electric system due to the combination of active and reactive power.


conjunct ​

apparentPerceived quantity
powerEnergy consumed per unit time

meta ​

defapparent-power
isquantity
liblib:phIoT
prefUnitkVA
quantityOfac-elec

usage ​

apparent  power

supertypes ​

markerMarker labels a dict with typing information
quantityMeasurable property of a substance or phenomenon


def ​

area ​

Area of a shape or floor space


meta ​

defarea
isnumber
liblib:phIoT
prefUnitft², m²
tagOnsite, space

supertypes ​

valData value type
scalarScalar is an atomic value kind
numberInteger or floating point numbers annotated with an optional unit


def ​

ates ​

Aquifer Thermal Energy Storage system. See ATES chapter.


meta ​

defates
iconEquipIcon
isequip
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Aquifer_thermal_energy_storage

usage ​

ates  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset

tags ​

atesDesignDesign type of the ATES underground system
disDisplay name for an entity
disMacroDisplay name using macro syntax
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

cool water flow thermal meter equip
cool well equip
cool well equip
extraction well equip
extraction well equip
flowInverter equip
flowInverter equip
ground water flow sensor point
ground water flow sensor point
ground water pressure sensor point
ground water pressure sensor point
ground water volume sensor point
ground water volume sensor point
heatExchanger equip
heatExchanger equip
infiltration well equip
infiltration well equip
purge water flow sensor point
purge water flow sensor point
purge water volume sensor point
purge water volume sensor point
warm water flow thermal meter equip
warm water flow thermal meter equip
warm well equip
warm well equip


def ​

atesClosedLoop ​

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.


meta ​

defatesClosedLoop
isatesDesign
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
atesDesignDesign type of the ATES underground system


def ​

atesDesign ​

Design type of the ATES underground system.


meta ​

defatesDesign
ischoice
liblib:phIoT
tagOnates
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection

subtypes ​

atesClosedLoopThe ATES uses closed piping to transport a water/glycol mixture through the ground
atesDoubletThe ATES has one or more pairs of a separate warm and cool well
atesDoubletPairedThe ATES is as a doublet, but with specific warm and cool wells linked together
atesMonoThe ATES has only one physical well
atesUnidirectionalSimilar to a doublet, but water always flows in the same direction from the extraction to the infiltration well


def ​

atesDoublet ​

The ATES has one or more pairs of a separate warm and cool well.


meta ​

defatesDoublet
isatesDesign
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
atesDesignDesign type of the ATES underground system


def ​

atesDoubletPaired ​

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.


meta ​

defatesDoubletPaired
isatesDesign
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
atesDesignDesign type of the ATES underground system


def ​

atesMono ​

The ATES has only one physical well. This well is deep enough to penetrate two layers of groundwater.


meta ​

defatesMono
isatesDesign
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
atesDesignDesign type of the ATES underground system


def ​

atesUnidirectional ​

Similar to a doublet, but water always flows in the same direction from the extraction to the infiltration well.


meta ​

defatesUnidirectional
isatesDesign
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
atesDesignDesign type of the ATES underground system


def ​

barometric ​

Relating atmospheric pressure


meta ​

defbarometric
ismarker
liblib:phIoT

supertypes ​

markerMarker labels a dict with typing information


def ​

battery ​

Equipment used to store electric energy


meta ​

defbattery
iconEquipIcon
isequip, elec-output
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Electric_battery

usage ​

battery  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
outputEntity outputs a substance with flows to other entities
elec-outputEntity outputs electricity to other entities

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

equip
point
point


def ​

biomass ​

Plant or animal material used as fuel to produce electricity or heat


meta ​

defbiomass
issubstance
liblib:phIoT
tagOnghgDirectSource
wikipediahttps://en.wikipedia.org/wiki/Biomass

supertypes ​

markerMarker labels a dict with typing information
phenomenonAspect of scientific interest with measurable quantities
substanceMatter in one the three states solid, liquid, or gas

quantities ​

concentrationAbundance of substance in the total volume of a mixture
tempTemperature - measure of hot and cold
volumeThree dimensional space occupied by a substance


def ​

biomassHeating ​

Heating by the combustion of biomass


meta ​

defbiomassHeating
isheatingProcess
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
heatingProcessProcessed used to heat a substance


def ​

blowdown-water-input ​

Entity inputs blowdown water which flows from another entity


conjunct ​

blowdownRemoval from container or pipe
waterWater in its liquid form
inputEntity inputs a substance which flows from another entity

meta ​

defblowdown-water-input
isinput
liblib:phIoT

usage ​

blowdown  water  input

supertypes ​

markerMarker labels a dict with typing information
inputEntity inputs a substance which flows from another entity

tags ​

blowdownWaterRefBlowdown water flows from the referent to this entity


def ​

blowdown-water-output ​

Entity outputs blowdown water to other entities


conjunct ​

blowdownRemoval from container or pipe
waterWater in its liquid form
outputEntity outputs a substance with flows to other entities

meta ​

defblowdown-water-output
isoutput
liblib:phIoT

usage ​

blowdown  water  output

supertypes ​

markerMarker labels a dict with typing information
outputEntity outputs a substance with flows to other entities


def ​

blowdown-water ​

Water expelled from a system to remove mineral build up


conjunct ​

blowdownRemoval from container or pipe
waterWater in its liquid form

meta ​

defblowdown-water
iswater
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Water

usage ​

blowdown  water

supertypes ​

markerMarker labels a dict with typing information
phenomenonAspect of scientific interest with measurable quantities
substanceMatter in one the three states solid, liquid, or gas
fluidLiquid or gas
liquidSubstance with definite volume but takes the shape of its container
waterWater in its liquid form

quantities ​

concentrationAbundance of substance in the total volume of a mixture
flowMeasure of volumetric flow of fluid
levelRange from 0% to 100%
pressureMeasure of force applied
tempTemperature - measure of hot and cold
volumeThree dimensional space occupied by a substance


def ​

blowdown ​

Removal from container or pipe


meta ​

defblowdown
ismarker
liblib:phIoT

supertypes ​

markerMarker labels a dict with typing information


def ​

blowdownWaterRef ​

Blowdown water flows from the referent to this entity


meta ​

defblowdownWaterRef
inputsblowdown-water
isref
liblib:phIoT
ofblowdown-water-output
tagOnblowdown-water-input

supertypes ​

valData value type
scalarScalar is an atomic value kind
refReference to an entity


def ​

boiler ​

Equipment to generate hot water or steam for heating


meta ​

defboiler
iconEquipIcon
isequip, elec-input
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Boiler

usage ​

boiler  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
inputEntity inputs a substance which flows from another entity
elec-inputEntity inputs electricity which flows from another entity

subtypes ​

hot-water-boilerBoiler which outputs hot water
steam-boilerBoiler which outputs steam

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
elecRefElectricity flows from the referent to this entity
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
heatingProcessProcessed used to heat a substance
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

alarm sensor point


def ​

branchSelector ​

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 VRF chapter.


meta ​

defbranchSelector
isvrf-equip, refrig-input
liblib:phIoT

usage ​

branchSelector  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
vrf-equipEquipment used in VRF systems
inputEntity inputs a substance which flows from another entity
refrig-inputEntity inputs refrigerant which flows from another entity

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
refrigRefRefrigerant flows from the referent to this entity
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

equip
point
point


def ​

bypass ​

Pipe used to bypass an equipment


meta ​

defbypass
ispipeSection
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
pipeSectionEquipment section of piping


def ​

cable ​

An assembly of one or more insulated conductors.


meta ​

defcable
isequip
liblib:phIoT

usage ​

cable  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

equip
point
point


def ​

cav ​

Constant air volume terminal unit. CAV systems use a constant air flow rate with a variable air temperature.


meta ​

defcav
iconEquipIcon
isairTerminalUnit
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Constant_air_volume

usage ​

cav  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
airTerminalUnitEquipment in air distribution systems which terminate at the space
inputEntity inputs a substance which flows from another entity
air-inputEntity inputs air which flows from another entity
elec-inputEntity inputs electricity which flows from another entity
outputEntity outputs a substance with flows to other entities
air-outputEntity outputs air to other entities

tags ​

airRefAir flows from the referent to this entity
disDisplay name for an entity
disMacroDisplay name using macro syntax
ductConfigDuctwork configuration
elecRefElectricity flows from the referent to this entity
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

discharge duct equip
inlet duct equip
inlet duct equip
thermostat equip
thermostat equip


def ​

centrifugal ​

Compression via a continuous flow of fluid through an impeller


meta ​

defcentrifugal
ismarker
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Centrifugal_compressor

supertypes ​

markerMarker labels a dict with typing information

subtypes ​

chiller-centrifugalCompression via a continuous flow of fluid through an impeller


def ​

chilled-water-input ​

Entity inputs chilled water which flows from another entity


conjunct ​

chilledSubstance is cooled using cooling process
waterWater in its liquid form
inputEntity inputs a substance which flows from another entity

meta ​

defchilled-water-input
isinput
liblib:phIoT

usage ​

chilled  water  input

supertypes ​

markerMarker labels a dict with typing information
inputEntity inputs a substance which flows from another entity

subtypes ​

chilledWaterCoolingCooling using transfer of heat to chilled water

tags ​

chilledWaterRefChilled water flows from the referent to this entity


def ​

chilled-water-output ​

Entity outputs chilled water to other entities


conjunct ​

chilledSubstance is cooled using cooling process
waterWater in its liquid form
outputEntity outputs a substance with flows to other entities

meta ​

defchilled-water-output
isoutput
liblib:phIoT

usage ​

chilled  water  output

supertypes ​

markerMarker labels a dict with typing information
outputEntity outputs a substance with flows to other entities

subtypes ​

chilled-water-plantPlant used to generate chilled water for cooling


def ​

chilled-water-plant ​

Plant used to generate chilled water for cooling. See Plants.


conjunct ​

chilledSubstance is cooled using cooling process
waterWater in its liquid form
plantCentral plant used to generate a substance for a process

meta ​

defchilled-water-plant
iconEquipIcon
isplant, chilled-water-output
liblib:phIoT

usage ​

chilled  water  plant  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
plantCentral plant used to generate a substance for a process
outputEntity outputs a substance with flows to other entities
chilled-water-outputEntity outputs chilled water to other entities

tags ​

condenserLoopOpen or closed loop for condenser working fluid
disDisplay name for an entity
disMacroDisplay name using macro syntax
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

chilled water bypass pipe equip
chilled water delta flow point
chilled water delta flow point
chilled water delta pressure point
chilled water delta pressure point
chilled water delta temp point
chilled water delta temp point
chilled water entering pipe equip
chilled water entering pipe equip
chilled water header pipe equip
chilled water header pipe equip
chilled water heatExchanger equip
chilled water heatExchanger equip
chilled water leaving pipe equip
chilled water leaving pipe equip
chilled water mixing valve cmd point
chilled water mixing valve cmd point
chiller equip
chiller equip
condenser water bypass pipe equip
condenser water bypass pipe equip
condenser water delta flow sensor point
condenser water delta flow sensor point
condenser water delta pressure sensor point
condenser water delta pressure sensor point
condenser water delta temp sensor point
condenser water delta temp sensor point
coolingTower equip
coolingTower equip
enable cmd point
enable cmd point


def ​

chilled-water-system ​

System that circulates water in its liquid state below ambient temperature for cooling a space or process.


conjunct ​

chilledSubstance is cooled using cooling process
waterWater in its liquid form
systemGrouping of related equipment dedicated to a single application

meta ​

defchilled-water-system
iswater-system
liblib:phIoT

usage ​

chilled  water  system

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
systemGrouping of related equipment dedicated to a single application
water-systemSystem that supplies or collects potable or non-potable water in any state

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
systemRefReference to system

children ​

equip
point
point


def ​

chilled-water ​

Water cooled for use in HVAC and industrial processes


conjunct ​

chilledSubstance is cooled using cooling process
waterWater in its liquid form

meta ​

defchilled-water
iswater
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Chilled_water

usage ​

chilled  water

supertypes ​

markerMarker labels a dict with typing information
phenomenonAspect of scientific interest with measurable quantities
substanceMatter in one the three states solid, liquid, or gas
fluidLiquid or gas
liquidSubstance with definite volume but takes the shape of its container
waterWater in its liquid form

quantities ​

concentrationAbundance of substance in the total volume of a mixture
flowMeasure of volumetric flow of fluid
levelRange from 0% to 100%
pressureMeasure of force applied
tempTemperature - measure of hot and cold
volumeThree dimensional space occupied by a substance


def ​

chilled ​

Substance is cooled using cooling process


meta ​

defchilled
ismarker
liblib:phIoT

supertypes ​

markerMarker labels a dict with typing information


def ​

chilledBeam ​

Conditions a space using a heat exchanger integrated into the ceiling


meta ​

defchilledBeam
iconEquipIcon
isradiantEquip
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Chilled_beam

usage ​

chilledBeam  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
radiantEquipHVAC equipment that conditions a space without forced air

tags ​

coolingProcessProcessed used to cool a substance
disDisplay name for an entity
disMacroDisplay name using macro syntax
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
heatingProcessProcessed used to heat a substance
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

equip
point
point


def ​

chilledBeamZone ​

AHU supplies air to chilled beam terminal units


meta ​

defchilledBeamZone
isahuZoneDelivery
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
ahuZoneDeliveryAHU delivery method of conditioned air to the zone


def ​

chilledWaterCooling ​

Cooling using transfer of heat to chilled water


meta ​

defchilledWaterCooling
iscoolingProcess, chilled-water-input
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
coolingProcessProcessed used to cool a substance
inputEntity inputs a substance which flows from another entity
chilled-water-inputEntity inputs chilled water which flows from another entity

tags ​

chilledWaterRefChilled water flows from the referent to this entity


def ​

chilledWaterRef ​

Chilled water flows from the referent to this entity


meta ​

defchilledWaterRef
inputschilled-water
isref
liblib:phIoT
ofchilled-water-output
tagOnchilled-water-input

supertypes ​

valData value type
scalarScalar is an atomic value kind
refReference to an entity


def ​

chiller-absorption ​

Cooling process using energy from heat source such as hot water


conjunct ​

chillerEquipment to remove heat from a liquid
absorptionCooling process using energy from heat source such as hot water

meta ​

defchiller-absorption
isabsorption, chillerMechanism
liblib:phIoT
uiInputui::ChoiceInput
wikipediahttps://en.wikipedia.org/wiki/Absorption_refrigerator

usage ​

chiller  absorption

supertypes ​

markerMarker labels a dict with typing information
absorptionCooling process using energy from heat source such as hot water
choiceChoice specifies an exclusive marker selection
chillerMechanismPrimary mechanism of chiller


def ​

chiller-centrifugal ​

Compression via a continuous flow of fluid through an impeller


conjunct ​

chillerEquipment to remove heat from a liquid
centrifugalCompression via a continuous flow of fluid through an impeller

meta ​

defchiller-centrifugal
iscentrifugal, chillerMechanism
liblib:phIoT
uiInputui::ChoiceInput
wikipediahttps://en.wikipedia.org/wiki/Centrifugal_compressor

usage ​

chiller  centrifugal

supertypes ​

markerMarker labels a dict with typing information
centrifugalCompression via a continuous flow of fluid through an impeller
choiceChoice specifies an exclusive marker selection
chillerMechanismPrimary mechanism of chiller


def ​

chiller-reciprocal ​

Piston compressor driven by a crankshaft


conjunct ​

chillerEquipment to remove heat from a liquid
reciprocalPiston compressor driven by a crankshaft

meta ​

defchiller-reciprocal
isreciprocal, chillerMechanism
liblib:phIoT
uiInputui::ChoiceInput
wikipediahttps://en.wikipedia.org/wiki/Reciprocating_compressor

usage ​

chiller  reciprocal

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
chillerMechanismPrimary mechanism of chiller
reciprocalPiston compressor driven by a crankshaft


def ​

chiller-rotaryScrew ​

Rotary screw compression


conjunct ​

chillerEquipment to remove heat from a liquid
rotaryScrewRotary screw compression

meta ​

defchiller-rotaryScrew
isrotaryScrew, chillerMechanism
liblib:phIoT
uiInputui::ChoiceInput
wikipediahttps://en.wikipedia.org/wiki/Rotary-screw_compressor

usage ​

chiller  rotaryScrew

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
chillerMechanismPrimary mechanism of chiller
rotaryScrewRotary screw compression


def ​

chiller ​

Equipment to remove heat from a liquid. Chillers typically use a vapor compression or an absorption refrigeration cycle.


meta ​

defchiller
iconEquipIcon
isequip, elec-input
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Chiller

usage ​

chiller  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
inputEntity inputs a substance which flows from another entity
elec-inputEntity inputs electricity which flows from another entity

tags ​

chillerMechanismPrimary mechanism of chiller
coolingCapacityMeasurement of a chiller ability to remove heat measured
disDisplay name for an entity
disMacroDisplay name using macro syntax
elecRefElectricity flows from the referent to this entity
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

alarm sensor point
chilled water delta flow sensor point
chilled water delta flow sensor point
chilled water delta temp sensor point
chilled water delta temp sensor point
chilled water entering pipe equip
chilled water entering pipe equip
chilled water leaving pipe equip
chilled water leaving pipe equip
chilled water valve isolation cmd point
chilled water valve isolation cmd point
condenser refrig pressure sensor point
condenser refrig pressure sensor point
condenser refrig temp sensor point
condenser refrig temp sensor point
condenser run cmd point
condenser run cmd point
condenser run sensor point
condenser run sensor point
condenser water entering pipe equip
condenser water entering pipe equip
condenser water leaving pipe equip
condenser water leaving pipe equip
condenser water valve isolation cmd point
condenser water valve isolation cmd point
efficiency sensor point
efficiency sensor point
enable cmd point
enable cmd point
enable sensor point
enable sensor point
evaporator refrig pressure sensor point
evaporator refrig pressure sensor point
evaporator refrig temp sensor point
evaporator refrig temp sensor point
load cmd point
load cmd point
load sensor point
load sensor point
run cmd point
run cmd point
run sensor point
run sensor point


def ​

chillerMechanism ​

Primary mechanism of chiller


meta ​

defchillerMechanism
ischoice
liblib:phIoT
tagOnchiller
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection

subtypes ​

chiller-absorptionCooling process using energy from heat source such as hot water
chiller-centrifugalCompression via a continuous flow of fluid through an impeller
chiller-reciprocalPiston compressor driven by a crankshaft
chiller-rotaryScrewRotary screw compression


def ​

circ ​

Pipe used to circulate fluid through an equipment or system


meta ​

defcirc
ispipeSection
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
pipeSectionEquipment section of piping


def ​

circuit ​

Electrical circuit and its associated components such as breakers. See Elec Panels chapter.


meta ​

defcircuit
iconEquipIcon
isequip, elec-input, elec-output
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Electrical_network

usage ​

circuit  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
inputEntity inputs a substance which flows from another entity
elec-inputEntity inputs electricity which flows from another entity
outputEntity outputs a substance with flows to other entities
elec-outputEntity outputs electricity to other entities

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
elecRefElectricity flows from the referent to this entity
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

equip
point
point


def ​

cmd ​

Point is a command, actuator, AO/BO. See Points chapter.


meta ​

defcmd
ispointFunction
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
pointFunctionClassifies the point as a sensor, command, or setpoint


def ​

coal ​

Combustible sedimentary rock


meta ​

defcoal
issolid
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Coal

supertypes ​

markerMarker labels a dict with typing information
phenomenonAspect of scientific interest with measurable quantities
substanceMatter in one the three states solid, liquid, or gas
solidSubstance with definite shape and volume

quantities ​

concentrationAbundance of substance in the total volume of a mixture
tempTemperature - measure of hot and cold
volumeThree dimensional space occupied by a substance


def ​

coalHeating ​

Heating by the combustion of coal


meta ​

defcoalHeating
isheatingProcess
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
heatingProcessProcessed used to heat a substance


def ​

coil ​

Heat exchanger used to heat or cool air. Coils are sub-components of HVAC equipment such as airHandlingEquip.


meta ​

defcoil
iconEquipIcon
isheatExchanger
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Heat_exchanger#HVAC_air_coils

usage ​

coil  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
heatExchangerEquipment to transfer heat between two working fluids

subtypes ​

coolingCoilCoil used to cool air
heatingCoilCoil used to heat air

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

equip
point
point


def ​

cold-water ​

Water supplied to cold taps


conjunct ​

coldHaving low degree of heat
waterWater in its liquid form

meta ​

defcold-water
iswater
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Water

usage ​

cold  water

supertypes ​

markerMarker labels a dict with typing information
phenomenonAspect of scientific interest with measurable quantities
substanceMatter in one the three states solid, liquid, or gas
fluidLiquid or gas
liquidSubstance with definite volume but takes the shape of its container
waterWater in its liquid form

quantities ​

concentrationAbundance of substance in the total volume of a mixture
flowMeasure of volumetric flow of fluid
levelRange from 0% to 100%
pressureMeasure of force applied
tempTemperature - measure of hot and cold
volumeThree dimensional space occupied by a substance


def ​

cold ​

Having low degree of heat


meta ​

defcold
ismarker
liblib:phIoT

supertypes ​

markerMarker labels a dict with typing information


def ​

coldDeck ​

Duct carries air for cooling


meta ​

defcoldDeck
isductDeck
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
ductDeckCold, hot, or neutral deck


def ​

compressor ​

Device for mechanically increasing the pressure of a gas or refrigerant vapor by reducing its volume.


meta ​

defcompressor
ismarker
liblib:phIoT

supertypes ​

markerMarker labels a dict with typing information


def ​

computed-point ​

See Synthetics chapter.


conjunct ​

computedComputed point
pointData point such as a sensor or actuator

meta ​

defcomputed-point
issynthetic-point
liblib:phIoT

usage ​

computed  point

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
pointData point such as a sensor or actuator
synthetic-pointSee Synthetics chapter

tags ​

curSupports current value
disDisplay name for an entity
disMacroDisplay name using macro syntax
disabledIndicates the entity is in a disabled state
enumDefines an eumeration of string key names
equipRefReference to equip which contains this entity
ghgFactorHisIdentifies point record with interval emission factor data that the Greenhouse Gas Emission Engine uses to calculate emissions
hisSupports historization of data
idDefines the unique identifier of an entity in system using a ref value type
kindKind name used to identity a value data type
maxValInclusive maximum for a numeric value
minValInclusive minimum for a numeric value
navNameNavigation name commonly used with disMacro to create computed display strings
pointFunctionClassifies the point as a sensor, command, or setpoint
pointQuantityQuantity the point senses or controls
pointSubjectWhat the point senses or controls
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
syntheticModelRefSee Synthetics chapter
systemRefReference to system
tzTimezone identifier from standard timezone database
unitUnit identifier from standard unit database
writableSupports writing data


def ​

computed ​

Computed point. See Synthetics chapter.


meta ​

defcomputed
issynthetic
liblib:phIoT
uiInputui::ChoiceInput

usage ​

computed  synthetic

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
pointFunctionClassifies the point as a sensor, command, or setpoint
syntheticSynthetic point with computed operational data


def ​

computedModel ​

See Synthetics chapter.


meta ​

defcomputedModel
issyntheticModel
liblib:phIoT

usage ​

computedModel  syntheticModel

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
syntheticModelSee Synthetics chapter

tags ​

disDisplay name for an entity
idDefines the unique identifier of an entity in system using a ref value type


def ​

condensate-input ​

Entity inputs condensate which flows from another entity


conjunct ​

condensateLiquid phase produced by the condensation of steam or other gas
inputEntity inputs a substance which flows from another entity

meta ​

defcondensate-input
isinput
liblib:phIoT

usage ​

condensate  input

supertypes ​

markerMarker labels a dict with typing information
inputEntity inputs a substance which flows from another entity

tags ​

condensateRefCondensate flows from the referent to this entity


def ​

condensate-output ​

Entity outputs condensate to other entities


conjunct ​

condensateLiquid phase produced by the condensation of steam or other gas
outputEntity outputs a substance with flows to other entities

meta ​

defcondensate-output
isoutput
liblib:phIoT

usage ​

condensate  output

supertypes ​

markerMarker labels a dict with typing information
outputEntity outputs a substance with flows to other entities


def ​

condensate ​

Liquid phase produced by the condensation of steam or other gas


meta ​

defcondensate
isliquid
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Liquid

supertypes ​

markerMarker labels a dict with typing information
phenomenonAspect of scientific interest with measurable quantities
substanceMatter in one the three states solid, liquid, or gas
fluidLiquid or gas
liquidSubstance with definite volume but takes the shape of its container

quantities ​

concentrationAbundance of substance in the total volume of a mixture
flowMeasure of volumetric flow of fluid
levelRange from 0% to 100%
pressureMeasure of force applied
tempTemperature - measure of hot and cold
volumeThree dimensional space occupied by a substance


def ​

condensateRef ​

Condensate flows from the referent to this entity


meta ​

defcondensateRef
inputscondensate
isref
liblib:phIoT
ofcondensate-output
tagOncondensate-input

supertypes ​

valData value type
scalarScalar is an atomic value kind
refReference to an entity


def ​

condenser-water-input ​

Entity inputs condenser water which flows from another entity


conjunct ​

condenserDevice or related to process of condensation
waterWater in its liquid form
inputEntity inputs a substance which flows from another entity

meta ​

defcondenser-water-input
isinput
liblib:phIoT

usage ​

condenser  water  input

supertypes ​

markerMarker labels a dict with typing information
inputEntity inputs a substance which flows from another entity

tags ​

condenserWaterRefCondenser water flows from the referent to this entity


def ​

condenser-water-output ​

Entity outputs condenser water to other entities


conjunct ​

condenserDevice or related to process of condensation
waterWater in its liquid form
outputEntity outputs a substance with flows to other entities

meta ​

defcondenser-water-output
isoutput
liblib:phIoT

usage ​

condenser  water  output

supertypes ​

markerMarker labels a dict with typing information
outputEntity outputs a substance with flows to other entities


def ​

condenser-water-system ​

System that circulates water in its liquid state for rejecting heat from a space or process.


conjunct ​

condenserDevice or related to process of condensation
waterWater in its liquid form
systemGrouping of related equipment dedicated to a single application

meta ​

defcondenser-water-system
iswater-system
liblib:phIoT

usage ​

condenser  water  system

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
systemGrouping of related equipment dedicated to a single application
water-systemSystem that supplies or collects potable or non-potable water in any state

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
systemRefReference to system

children ​

equip
point
point


def ​

condenser-water ​

Water used used to remove heat through condensation


conjunct ​

condenserDevice or related to process of condensation
waterWater in its liquid form

meta ​

defcondenser-water
iswater
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Water

usage ​

condenser  water

supertypes ​

markerMarker labels a dict with typing information
phenomenonAspect of scientific interest with measurable quantities
substanceMatter in one the three states solid, liquid, or gas
fluidLiquid or gas
liquidSubstance with definite volume but takes the shape of its container
waterWater in its liquid form

quantities ​

concentrationAbundance of substance in the total volume of a mixture
flowMeasure of volumetric flow of fluid
levelRange from 0% to 100%
pressureMeasure of force applied
tempTemperature - measure of hot and cold
volumeThree dimensional space occupied by a substance


def ​

condenser ​

Device or related to process of condensation


meta ​

defcondenser
ismarker
liblib:phIoT

supertypes ​

markerMarker labels a dict with typing information


def ​

condenserClosedLoop ​

Working fluid is kept separate from fluid used for heat transfer into the atmosphere


meta ​

defcondenserClosedLoop
iscondenserLoop
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
condenserLoopOpen or closed loop for condenser working fluid


def ​

condenserCooling ​

Removal of heat through the process of water condensation


meta ​

defcondenserCooling
iscoolingProcess
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
coolingProcessProcessed used to cool a substance


def ​

condenserLoop ​

Open or closed loop for condenser working fluid


meta ​

defcondenserLoop
ischoice
liblib:phIoT
tagOnchilled-water-plant
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection

subtypes ​

condenserClosedLoopWorking fluid is kept separate from fluid used for heat transfer into the atmosphere
condenserOpenLoopUses working fluid itself for evaporation into the atmosphere


def ​

condenserOpenLoop ​

Uses working fluid itself for evaporation into the atmosphere


meta ​

defcondenserOpenLoop
iscondenserLoop
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
condenserLoopOpen or closed loop for condenser working fluid


def ​

condenserWaterRef ​

Condenser water flows from the referent to this entity


meta ​

defcondenserWaterRef
inputscondenser-water
isref
liblib:phIoT
ofcondenser-water-output
tagOncondenser-water-input

supertypes ​

valData value type
scalarScalar is an atomic value kind
refReference to an entity


def ​

conditioning ​

Related to cleaning, heating, cooling, humidifying, dehumidifying, ventilating or circulating  air.


meta ​

defconditioning
ismarker
liblib:phIoT

supertypes ​

markerMarker labels a dict with typing information


def ​

conduit ​

Duct, pipe, or cable to convey a substance or phenomenon


meta ​

defconduit
iconEquipIcon
isequip
liblib:phIoT

usage ​

conduit  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset

subtypes ​

ductConduit used to convey air for HVAC
pipeConduit used to convey a fluid
wireCabling used to convey electricity or data

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

equip
point
point


def ​

constantAirVolume ​

Delivers a constant volume of air flow. Typically this means equipment with a single speed fan.


meta ​

defconstantAirVolume
isairVolumeAdjustability
liblib:phIoT
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection
airVolumeAdjustabilityAbility of air handling equip to adjust volume of air flow


def ​

controls ​

Associated with the control system for an industrial process


meta ​

defcontrols
ismarker
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Control_system

supertypes ​

markerMarker labels a dict with typing information


def ​

cool-water ​

Relatively cool water without active chilling


conjunct ​

coolAssocited with low temperature or cooling processes
waterWater in its liquid form

meta ​

defcool-water
iswater
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Water

usage ​

cool  water

supertypes ​

markerMarker labels a dict with typing information
phenomenonAspect of scientific interest with measurable quantities
substanceMatter in one the three states solid, liquid, or gas
fluidLiquid or gas
liquidSubstance with definite volume but takes the shape of its container
waterWater in its liquid form

quantities ​

concentrationAbundance of substance in the total volume of a mixture
flowMeasure of volumetric flow of fluid
levelRange from 0% to 100%
pressureMeasure of force applied
tempTemperature - measure of hot and cold
volumeThree dimensional space occupied by a substance


def ​

cool ​

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.


meta ​

defcool
ismarker
liblib:phIoT

supertypes ​

markerMarker labels a dict with typing information


def ​

cooling ​

Cooling mode or process


meta ​

defcooling
ismarker
liblib:phIoT

supertypes ​

markerMarker labels a dict with typing information


def ​

coolingCapacity ​

Measurement of a chiller ability to remove heat measured


meta ​

defcoolingCapacity
isnumber
liblib:phIoT
prefUnittonref, BTU/h, kW
tagOnchiller

supertypes ​

valData value type
scalarScalar is an atomic value kind
numberInteger or floating point numbers annotated with an optional unit


def ​

coolingCoil ​

Coil used to cool air.


meta ​

childrenFlattenductDeck, ductSection
defcoolingCoil
iconEquipIcon
iscoil
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Heat_exchanger#HVAC_air_coils

usage ​

coolingCoil  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
heatExchangerEquipment to transfer heat between two working fluids
coilHeat exchanger used to heat or cool air

tags ​

coolingProcessProcessed used to cool a substance
disDisplay name for an entity
disMacroDisplay name using macro syntax
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

chilled water cool valve cmd point
stage:1 cool run cmd point
stage:1 cool run cmd point


def ​

coolingOnly ​

Equipment without heating


meta ​

defcoolingOnly
ismarker
liblib:phIoT

supertypes ​

markerMarker labels a dict with typing information


def ​

coolingProcess ​

Processed used to cool a substance


meta ​

defcoolingProcess
ischoice
liblib:phIoT
tagOnairHandlingEquip, chilledBeam, coolingCoil
uiInputui::ChoiceInput

supertypes ​

markerMarker labels a dict with typing information
choiceChoice specifies an exclusive marker selection

subtypes ​

airCoolingCooling by dissipating heat into the surrounding air
chilledWaterCoolingCooling using transfer of heat to chilled water
condenserCoolingRemoval of heat through the process of water condensation
dxCoolingCooling using direct expansion of a refrigerant vapor
waterCoolingCooling using transfer of heat to water which is not explicitly chilled


def ​

coolingTower ​

Equipment to transfer waste heat into the atmosphere


meta ​

defcoolingTower
iconEquipIcon
isequip, elec-input
liblib:phIoT
wikipediahttps://en.wikipedia.org/wiki/Cooling_tower

usage ​

coolingTower  equip

supertypes ​

markerMarker labels a dict with typing information
entityTop-level dicts with a unique identifier
equipEquipment asset
inputEntity inputs a substance which flows from another entity
elec-inputEntity inputs electricity which flows from another entity

tags ​

disDisplay name for an entity
disMacroDisplay name using macro syntax
elecRefElectricity flows from the referent to this entity
equipRefReference to equip which contains this entity
ghgSourceRefRef to the emission source used to calculate Greenhouse Gas Emissions
idDefines the unique identifier of an entity in system using a ref value type
navNameNavigation name commonly used with disMacro to create computed display strings
siteRefReference to site which contains the entity
spaceRefReference to space which contains this entity
systemRefReference to system

children ​

condenser water entering pipe equip
condenser water leaving pipe equip
condenser water leaving pipe equip
fan motor equip
fan motor equip