外观
lib-phIoT 库参考（第 2 部分）
原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793882230/FIN+5.3.1+lib-phIoT+part+2 中文整理基于 FIN 5.3.1
导读： 本页为
lib-phIoT的 API / 标签 / 函数参考文档。
以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。
目录（导读）
概述（中译）
计算机房空调：一种用于调节计算机房环境的风机盘管。参见空气处理单元和数据中心章节。
API 正文（英文）
usage
| crac fcu equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| airHandlingEquip | HVAC equipment that conditions and delivers air via one or more fans |
| fcu | Fan Coil Unit |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
| output | Entity outputs a substance with flows to other entities |
| air-output | Entity outputs air to other entities |
tags
| ahuZoneDelivery | AHU delivery method of conditioned air to the zone |
| airVolumeAdjustability | Ability of air handling equip to adjust volume of air flow |
| coolingProcess | Processed used to cool a substance |
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| ductConfig | Ductwork configuration |
| ductDeck | Cold, hot, or neutral deck |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| heatingProcess | Processed used to heat a substance |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
def
cur-point
Point with support to report a "real-time" current value. By real-time we typically mean freshness within the order of a few seconds or at most a few minutes. For systems with direct I/O the current value is typically driven by the I/O scan rate. For overlay systems which acquire data via a protocol such as BACnet or Modbus then the current value is typically refreshed using polling or subscription over a network. Also see Points chapter.
conjunct
| cur | Supports current value |
| point | Data point such as a sensor or actuator |
meta
| def | cur-point |
| is | point |
| lib | lib:phIoT |
usage
| cur point |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| point | Data point such as a sensor or actuator |
tags
| cur | Supports current value |
| curErr | Error description when curStatus indicates error condition |
| curStatus | Status of point's current value reading |
| curTracksWrite | When configured curVal automatically tracks changes to writeVal and curStatus is set to "ok" |
| curVal | Current value of a point |
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| disabled | Indicates the entity is in a disabled state |
| enum | Defines an eumeration of string key names |
| equipRef | Reference to equip which contains this entity |
| ghgFactorHis | Identifies point record with interval emission factor data that the Greenhouse Gas Emission Engine uses to calculate emissions |
| his | Supports historization of data |
| id | Defines the unique identifier of an entity in system using a ref value type |
| kind | Kind name used to identity a value data type |
| maxVal | Inclusive maximum for a numeric value |
| minVal | Inclusive minimum for a numeric value |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| pointFunction | Classifies the point as a sensor, command, or setpoint |
| pointQuantity | Quantity the point senses or controls |
| pointSubject | What the point senses or controls |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
| tz | Timezone identifier from standard timezone database |
| unit | Unit identifier from standard unit database |
| writable | Supports writing data |
def
cur
Supports current value
meta
| def | cur |
| is | marker |
| lib | lib:phIoT |
| tagOn | point |
supertypes
| marker | Marker labels a dict with typing information |
def
curErr
Error description when curStatus indicates error condition
meta
| def | curErr |
| is | str |
| lib | lib:phIoT |
| tagOn | cur-point |
| transient | ✓ |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
curStatus
Status of point's current value reading. The curVal is only available when curStatus is "ok" or "stale". However a "stale" value should be used with caution since the local system does not have a fresh value. It is recommended that the curVal tag is removed from a point when the curStatus is not "ok" nor "stale".
meta
| def | curStatus |
| enum | See below |
| is | str |
| lib | lib:phIoT |
| tagOn | alarm, cur-point |
| transient | ✓ |
enum
| ok | all is okay |
| stale | the point's curVal is not fresh data |
| fault | a configuration or hardware problem - see curErr |
| down | a communication or network problem - see curErr |
| disabled | manual disable of the point or connector |
| unknown | we don't know anything (usually boot state) |
| remoteFault | point in remote system is fault |
| remoteDown | point in remote system is down |
| remoteDisabled | point in remote system is disabled |
| remoteUnknown | point in remote system is unknown |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
curVal
Current value of a point. The current value is only available when the curStatus is "ok" or "stale".
meta
| def | curVal |
| is | scalar |
| lib | lib:phIoT |
| tagOn | alarm, cur-point |
| transient | ✓ |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
def
current-angle
AC current phase angle
conjunct
| current | Movement of fluid or electricity |
| angle | Measurement of the relative difference in direction between two vectors or phasors |
meta
| def | current-angle |
| is | quantity |
| lib | lib:phIoT |
| prefUnit | deg |
| quantityOf | ac-elec |
usage
| current angle |
supertypes
| marker | Marker labels a dict with typing information |
| quantity | Measurable property of a substance or phenomenon |
def
current-imbalance
AC current phase imbalance. Also referred to as current unbalance.
conjunct
| current | Movement of fluid or electricity |
| imbalance | Lacking balance |
meta
| def | current-imbalance |
| is | quantity |
| lib | lib:phIoT |
| prefUnit | % |
| quantityOf | ac-elec |
usage
| current imbalance |
supertypes
| marker | Marker labels a dict with typing information |
| quantity | Measurable property of a substance or phenomenon |
def
current-magnitude
Root-mean-square (RMS) magnitude of AC electrical current
conjunct
| current | Movement of fluid or electricity |
| magnitude | Size or extent |
meta
| def | current-magnitude |
| is | elec-current |
| lib | lib:phIoT |
| prefUnit | A |
| quantityOf | ac-elec |
usage
| current magnitude |
supertypes
| marker | Marker labels a dict with typing information |
| quantity | Measurable property of a substance or phenomenon |
| elec-current | Electrical current |
def
current-thd
Total harmonic distortion (THD) of AC current
conjunct
| current | Movement of fluid or electricity |
| thd | Total harmonic distortion |
meta
| def | current-thd |
| is | quantity |
| lib | lib:phIoT |
| prefUnit | % |
| quantityOf | ac-elec |
usage
| current thd |
supertypes
| marker | Marker labels a dict with typing information |
| quantity | Measurable property of a substance or phenomenon |
def
damper-actuator
Actuator to regulate the flow of air.
conjunct
| damper | Damper equipment or control point |
| actuator | Equipment to move or control a mechanism |
meta
| childrenFlatten | ductSection |
| def | damper-actuator |
| icon | EquipIcon |
| is | actuator |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Damper_(flow) |
usage
| damper actuator equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| actuator | Equipment to move or control a mechanism |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| ductSection | Equipment section of ductwork |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
| damper cmd point | |
| damper sensor point | |
| damper sensor point | |
def
damper
Damper equipment or control point.
meta
| def | damper |
| is | marker |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Damper_(flow) |
supertypes
| marker | Marker labels a dict with typing information |
def
dc-elec-meter
DC Electricity meter. See Meters chapter.
conjunct
| dc | Relating to direct current (DC) electricity |
| elec | Associated with electricity or with electrical force, power, or energy |
| meter | Equipment to meter a substance or phenomenon |
meta
| def | dc-elec-meter |
| icon | EquipIcon |
| is | elec-meter |
| lib | lib:phIoT |
usage
| dc elec meter equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| meter | Equipment to meter a substance or phenomenon |
| elec-meter | Electricity meter |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
| output | Entity outputs a substance with flows to other entities |
| elec-output | Entity outputs electricity to other entities |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| meterScope | Classifies a meter as a main site meter or submeter |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| submeterOf | Reference to parent meter which is immediately upstream of this meter |
| systemRef | Reference to system |
| tariffHisRef | If multiple meters share the same tariff history, then you can use this tag to reference the "master" point containing the tariff history |
children
| equip | |
| point | |
| point | |
def
dc-elec
Direct current electricity
conjunct
| dc | Relating to direct current (DC) electricity |
| elec | Associated with electricity or with electrical force, power, or energy |
meta
| def | dc-elec |
| is | elec |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Direct_current |
usage
| dc elec |
supertypes
| marker | Marker labels a dict with typing information |
| phenomenon | Aspect of scientific interest with measurable quantities |
| elec | Associated with electricity or with electrical force, power, or energy |
quantities
| elec-current | Electrical current |
| elec-energy | Electrical energy |
| elec-power | Rate of electrical energy transfer |
| elec-volt | Electrical voltage, potential difference |
| stateOfCharge | State of charge (SoC) of an electric battery |
def
dc-evse-port
A DC EVSE port delivers dc electricity to a single EV charging inlet at a time. See EVSE chapter.
Typically a max current or max power setpoint should reference a DC EVSE port, but not both. Usually it is preferred to control a DC EVSE port using a max power setpoint.
conjunct
| dc | Relating to direct current (DC) electricity |
| evse | Electric Vehicle Supply Equipment |
| port | A gateway or opening used to transfer a substance |
meta
| def | dc-evse-port |
| icon | bolt |
| is | evse-port |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Charging_station |
usage
| dc evse port equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| evse-equip | Equipment that supports the delivery of electricity to charging inlets located on EVs |
| evse-port | An EVSE port delivers electricity to a single EV charging inlet at a time |
| meter | Equipment to meter a substance or phenomenon |
| elec-meter | Electricity meter |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
| output | Entity outputs a substance with flows to other entities |
| elec-output | Entity outputs electricity to other entities |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| meterScope | Classifies a meter as a main site meter or submeter |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| submeterOf | Reference to parent meter which is immediately upstream of this meter |
| systemRef | Reference to system |
| tariffHisRef | If multiple meters share the same tariff history, then you can use this tag to reference the "master" point containing the tariff history |
children
def
dc
Relating to direct current (DC) electricity
meta
| def | dc |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
deadband
The range in a process where no changes to output are made. May also indicate the difference between a base setpoint and effective setpoint.
meta
| def | deadband |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
delta
Differential of fluid between entering and leaving sensors.
meta
| def | delta |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
demand
Rate required for a process.
meta
| def | demand |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
design
Data related to intended design and operating conditions. This includes sizing and other data specified by design engineers and engineered drawings. Also see rated.
meta
| def | design |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
dessicantDehumidifier
Decreases humidity from air using a substance which absorbs moisture.
meta
| def | dessicantDehumidifier |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
diesel
Liquid fuel specifically designed for use in diesel engines
meta
| def | diesel |
| is | liquid |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Diesel_fuel |
supertypes
| marker | Marker labels a dict with typing information |
| phenomenon | Aspect of scientific interest with measurable quantities |
| substance | Matter in one the three states solid, liquid, or gas |
| fluid | Liquid or gas |
| liquid | Substance with definite volume but takes the shape of its container |
quantities
| concentration | Abundance of substance in the total volume of a mixture |
| flow | Measure of volumetric flow of fluid |
| level | Range from 0% to 100% |
| pressure | Measure of force applied |
| temp | Temperature - measure of hot and cold |
| volume | Three dimensional space occupied by a substance |
def
directZone
AHU supplies air directly to the zone
meta
| def | directZone |
| is | ahuZoneDelivery |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| ahuZoneDelivery | AHU delivery method of conditioned air to the zone |
def
discharge
Duct for air leaving an equipment
meta
| def | discharge |
| is | ductSection |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| ductSection | Equipment section of ductwork |
def
dispenser
Equipment that releases a specific amount of a substance.
meta
| def | dispenser |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
diverting
Three way valve which inputs one pipe and diverts between two output pipes.
meta
| def | diverting |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
doas
Dedicated Outside Air System: An AHU that brings in 100% outside air and no recirculated air in order to provide ventilation to spaces. See AHUs chapter.
meta
| def | doas |
| icon | EquipIcon |
| is | ahu |
| lib | lib:phIoT |
| navTarget | equip |
| wikipedia | https://en.wikipedia.org/wiki/Air_handler |
usage
| doas ahu equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| airHandlingEquip | HVAC equipment that conditions and delivers air via one or more fans |
| ahu | Air Handling Unit |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
| output | Entity outputs a substance with flows to other entities |
| air-output | Entity outputs air to other entities |
subtypes
| mau | Makeup Air Unit |
tags
| ahuZoneDelivery | AHU delivery method of conditioned air to the zone |
| airVolumeAdjustability | Ability of air handling equip to adjust volume of air flow |
| coolingProcess | Processed used to cool a substance |
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| ductConfig | Ductwork configuration |
| ductDeck | Cold, hot, or neutral deck |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| heatingProcess | Processed used to heat a substance |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
def
domestic-cold-water-system
System that circulates potable cold water in its liquid state for purposes other than space cooling and process requirements.
conjunct
| domestic | For human use |
| cold | Having low degree of heat |
| water | Water in its liquid form |
| system | Grouping of related equipment dedicated to a single application |
meta
| def | domestic-cold-water-system |
| is | domestic-water-system |
| lib | lib:phIoT |
usage
| domestic cold water system |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| system | Grouping of related equipment dedicated to a single application |
| water-system | System that supplies or collects potable or non-potable water in any state |
| domestic-water-system | System that circulates potable water in its liquid state for purposes other than space conditioning and process requirements |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| systemRef | Reference to system |
children
| equip | |
| point | |
| point | |
def
domestic-hot-water-system
System that circulates potable hot water in its liquid state for purposes other than space heating and process requirements.
conjunct
| domestic | For human use |
| hot | Having high degree of heat |
| water | Water in its liquid form |
| system | Grouping of related equipment dedicated to a single application |
meta
| def | domestic-hot-water-system |
| is | domestic-water-system |
| lib | lib:phIoT |
usage
| domestic hot water system |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| system | Grouping of related equipment dedicated to a single application |
| water-system | System that supplies or collects potable or non-potable water in any state |
| domestic-water-system | System that circulates potable water in its liquid state for purposes other than space conditioning and process requirements |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| systemRef | Reference to system |
children
| equip | |
| point | |
| point | |
def
domestic-water-input
Entity inputs domestic water which flows from another entity
conjunct
| domestic | For human use |
| water | Water in its liquid form |
| input | Entity inputs a substance which flows from another entity |
meta
| def | domestic-water-input |
| is | input |
| lib | lib:phIoT |
usage
| domestic water input |
supertypes
| marker | Marker labels a dict with typing information |
| input | Entity inputs a substance which flows from another entity |
tags
| domesticWaterRef | Domestic water flows from the referent to this entity |
def
domestic-water-output
Entity outputs domestic water to other entities
conjunct
| domestic | For human use |
| water | Water in its liquid form |
| output | Entity outputs a substance with flows to other entities |
meta
| def | domestic-water-output |
| is | output |
| lib | lib:phIoT |
usage
| domestic water output |
supertypes
| marker | Marker labels a dict with typing information |
| output | Entity outputs a substance with flows to other entities |
def
domestic-water-system
System that circulates potable water in its liquid state for purposes other than space conditioning and process requirements.
conjunct
| domestic | For human use |
| water | Water in its liquid form |
| system | Grouping of related equipment dedicated to a single application |
meta
| def | domestic-water-system |
| is | water-system |
| lib | lib:phIoT |
usage
| domestic water system |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| system | Grouping of related equipment dedicated to a single application |
| water-system | System that supplies or collects potable or non-potable water in any state |
subtypes
| domestic-cold-water-system | System that circulates potable cold water in its liquid state for purposes other than space cooling and process requirements |
| domestic-hot-water-system | System that circulates potable hot water in its liquid state for purposes other than space heating and process requirements |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| systemRef | Reference to system |
children
| equip | |
| point | |
| point | |
def
domestic-water
Tap water for drinking, washing, cooking, and flushing of toilets
conjunct
| domestic | For human use |
| water | Water in its liquid form |
meta
| def | domestic-water |
| is | water |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Water |
usage
| domestic water |
supertypes
| marker | Marker labels a dict with typing information |
| phenomenon | Aspect of scientific interest with measurable quantities |
| substance | Matter in one the three states solid, liquid, or gas |
| fluid | Liquid or gas |
| liquid | Substance with definite volume but takes the shape of its container |
| water | Water in its liquid form |
quantities
| concentration | Abundance of substance in the total volume of a mixture |
| flow | Measure of volumetric flow of fluid |
| level | Range from 0% to 100% |
| pressure | Measure of force applied |
| temp | Temperature - measure of hot and cold |
| volume | Three dimensional space occupied by a substance |
def
domestic
For human use
meta
| def | domestic |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
domesticWaterRef
Domestic water flows from the referent to this entity
meta
| def | domesticWaterRef |
| inputs | domestic-water |
| is | ref |
| lib | lib:phIoT |
| of | domestic-water-output |
| tagOn | domestic-water-input |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
dualDuct
Two ducts: combination of hotDeck, coldDeck, or neutralDeck
meta
| def | dualDuct |
| is | ductConfig |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| ductConfig | Ductwork configuration |
def
duct
Conduit used to convey air for HVAC
meta
| childrenFlatten | ductDeck, ductSection |
| def | duct |
| icon | EquipIcon |
| is | conduit |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Duct_(flow) |
usage
| duct equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| conduit | Duct, pipe, or cable to convey a substance or phenomenon |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| ductDeck | Cold, hot, or neutral deck |
| ductSection | Equipment section of ductwork |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
def
ductArea
Config point on a vav for duct area measured in ft² or m²
meta
| def | ductArea |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
ductConfig
Ductwork configuration
meta
| def | ductConfig |
| is | choice |
| lib | lib:phIoT |
| tagOn | airHandlingEquip, airTerminalUnit |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
subtypes
| dualDuct | Two ducts |
| singleDuct | One single duct |
| tripleDuct | Three ducts |
def
ductDeck
Cold, hot, or neutral deck. Can be applied to ahu equip if the AHU is part of a dualDuct or tripleDuct system but only serves a single deck type.
meta
| def | ductDeck |
| is | choice |
| lib | lib:phIoT |
| tagOn | duct, airHandlingEquip |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
subtypes
| coldDeck | Duct carries air for cooling |
| hotDeck | Duct carries air for heating |
| neutralDeck | Duct carries air which by-passes both heating and cooling coils |
def
ductSection
Equipment section of ductwork
meta
| def | ductSection |
| is | choice |
| lib | lib:phIoT |
| tagOn | duct, damper-actuator, fan-motor |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
subtypes
| discharge | Duct for air leaving an equipment |
| economizer | Duct to access fresh outside air only for economizing, not ventilation |
| exhaust | Duct used to expel air back outside |
| flue | Duct for exhausting combustion |
| inlet | Duct with air entering an equipment |
| mixed | Duct where fresh outside air and return air is mixed together |
| outside | Duct to access fresh outside air for both ventilation and economizer |
| return | Duct returning air back to equipment |
| ventilation | Duct to access fresh outside air only for ventilation, not economizing |
def
dxCooling
Cooling using direct expansion of a refrigerant vapor. Also see dxHeating and heatPump.
meta
| def | dxCooling |
| is | coolingProcess |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| coolingProcess | Processed used to cool a substance |
def
dxHeating
Heating using direct expansion of a refrigerant vapor. Also see dxCooling and heatPump.
meta
| def | dxHeating |
| is | heatingProcess |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| heatingProcess | Processed used to heat a substance |
def
economizer
Duct to access fresh outside air only for economizing, not ventilation
meta
| def | economizer |
| is | ductSection |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| ductSection | Equipment section of ductwork |
def
economizing
Energy reduction mode which augments heating/cooling with outside air.
meta
| def | economizing |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
effective
Current control setpoint in effect taking into account other factors
meta
| def | effective |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
efficiency
Efficiency point of a chiller measured in "COP" or "kW/ton".
meta
| def | efficiency |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
elec-demand
Active power averaged over a regular interval. For utility meters the demand interval is based on the billing period.
conjunct
| elec | Associated with electricity or with electrical force, power, or energy |
| demand | Rate required for a process |
meta
| def | elec-demand |
| is | active-power |
| lib | lib:phIoT |
| prefUnit | kW |
| quantityOf | ac-elec |
| wikipedia | https://en.wikipedia.org/wiki/Electric_power |
usage
| elec demand |
supertypes
| marker | Marker labels a dict with typing information |
| quantity | Measurable property of a substance or phenomenon |
| power | Energy consumed per unit time |
| elec-power | Rate of electrical energy transfer |
| active-power | Active power or real power |
def
elec-input
Entity inputs electricity which flows from another entity
conjunct
| elec | Associated with electricity or with electrical force, power, or energy |
| input | Entity inputs a substance which flows from another entity |
meta
| def | elec-input |
| is | input |
| lib | lib:phIoT |
usage
| elec input |
supertypes
| marker | Marker labels a dict with typing information |
| input | Entity inputs a substance which flows from another entity |
subtypes
| actuator | Equipment to move or control a mechanism |
| damper-actuator | Actuator to regulate the flow of air |
| valve-actuator | Actuator to regulate the flow of fluid |
| airHandlingEquip | HVAC equipment that conditions and delivers air via one or more fans |
| ahu | Air Handling Unit |
| doas | Dedicated Outside Air System |
| mau | Makeup Air Unit |
| rtu | Roof Top Unit |
| fcu | Fan Coil Unit |
| crac | Computer Room Air Conditioner |
| unitVent | Unit Ventilator |
| vrf-indoorUnit-fcu | Indoor unit fan coil unit in a VRF system |
| airTerminalUnit | Equipment in air distribution systems which terminate at the space |
| cav | Constant air volume terminal unit |
| vav | Variable air volume terminal unit |
| boiler | Equipment to generate hot water or steam for heating |
| hot-water-boiler | Boiler which outputs hot water |
| steam-boiler | Boiler which outputs steam |
| chiller | Equipment to remove heat from a liquid |
| circuit | Electrical circuit and its associated components such as breakers |
| coolingTower | Equipment to transfer waste heat into the atmosphere |
| elec-meter | Electricity meter |
| ac-elec-meter | AC Electricity meter |
| dc-elec-meter | DC Electricity meter |
| evse-port | An EVSE port delivers electricity to a single EV charging inlet at a time |
| ac-evse-port | An AC EVSE port delivers ac electricity to a single EV charging inlet at a time |
| dc-evse-port | A DC EVSE port delivers dc electricity to a single EV charging inlet at a time |
| elec-panel | Physical housing for electrical circuits, fuses, and breakers |
| elecHeating | Heating by the conversion of electrical energy |
| elevator | Enclosure used to move people between floors |
| escalator | Moving staircase used to move people between floors |
| evse-equip | Equipment that supports the delivery of electricity to charging inlets located on EVs |
| evse-cable | The electrical cable between an evse-port and an EV charging inlet on a vehicle |
| evse-dispenser | Equipment that dispenses electricity to an EV |
| evse-port | An EVSE port delivers electricity to a single EV charging inlet at a time |
| ac-evse-port | An AC EVSE port delivers ac electricity to a single EV charging inlet at a time |
| dc-evse-port | A DC EVSE port delivers dc electricity to a single EV charging inlet at a time |
| evse-powerConverter | A power converter that has a dc electrical output applied to a dc-evse-port |
| fumeHood | Ventilation equipment to limit exposure to hazardous fumes |
| luminaire | Light fixture using electricity to provide illumination |
| motor | Equipment that converts electrical energy into mechanical energy |
| fan-motor | Motor used with a fan to create air flow |
| pump-motor | Motor used with a pump to move fluid |
| movingWalkway | Conveyor to move people across a horizontal or inclined plane |
tags
| elecRef | Electricity flows from the referent to this entity |
def
elec-meter
Electricity meter
conjunct
| elec | Associated with electricity or with electrical force, power, or energy |
| meter | Equipment to meter a substance or phenomenon |
meta
| def | elec-meter |
| icon | EquipIcon |
| is | meter, elec-input, elec-output |
| lib | lib:phIoT |
usage
| elec meter equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| meter | Equipment to meter a substance or phenomenon |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
| output | Entity outputs a substance with flows to other entities |
| elec-output | Entity outputs electricity to other entities |
subtypes
| ac-elec-meter | AC Electricity meter |
| dc-elec-meter | DC Electricity meter |
| evse-port | An EVSE port delivers electricity to a single EV charging inlet at a time |
| ac-evse-port | An AC EVSE port delivers ac electricity to a single EV charging inlet at a time |
| dc-evse-port | A DC EVSE port delivers dc electricity to a single EV charging inlet at a time |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| meterScope | Classifies a meter as a main site meter or submeter |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| submeterOf | Reference to parent meter which is immediately upstream of this meter |
| systemRef | Reference to system |
| tariffHisRef | If multiple meters share the same tariff history, then you can use this tag to reference the "master" point containing the tariff history |
children
| equip | |
| point | |
| point | |
def
elec-output
Entity outputs electricity to other entities
conjunct
| elec | Associated with electricity or with electrical force, power, or energy |
| output | Entity outputs a substance with flows to other entities |
meta
| def | elec-output |
| is | output |
| lib | lib:phIoT |
usage
| elec output |
supertypes
| marker | Marker labels a dict with typing information |
| output | Entity outputs a substance with flows to other entities |
subtypes
| battery | Equipment used to store electric energy |
| circuit | Electrical circuit and its associated components such as breakers |
| elec-meter | Electricity meter |
| ac-elec-meter | AC Electricity meter |
| dc-elec-meter | DC Electricity meter |
| evse-port | An EVSE port delivers electricity to a single EV charging inlet at a time |
| ac-evse-port | An AC EVSE port delivers ac electricity to a single EV charging inlet at a time |
| dc-evse-port | A DC EVSE port delivers dc electricity to a single EV charging inlet at a time |
| elec-panel | Physical housing for electrical circuits, fuses, and breakers |
| evse-equip | Equipment that supports the delivery of electricity to charging inlets located on EVs |
| evse-cable | The electrical cable between an evse-port and an EV charging inlet on a vehicle |
| evse-dispenser | Equipment that dispenses electricity to an EV |
| evse-port | An EVSE port delivers electricity to a single EV charging inlet at a time |
| ac-evse-port | An AC EVSE port delivers ac electricity to a single EV charging inlet at a time |
| dc-evse-port | A DC EVSE port delivers dc electricity to a single EV charging inlet at a time |
| evse-powerConverter | A power converter that has a dc electrical output applied to a dc-evse-port |
def
elec-panel
Physical housing for electrical circuits, fuses, and breakers. See Elec Panels chapter.
conjunct
| elec | Associated with electricity or with electrical force, power, or energy |
| panel | Enclosure for electrical and control equipment |
meta
| def | elec-panel |
| icon | EquipIcon |
| is | panel, elec-input, elec-output |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Distribution_board |
usage
| elec panel equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| panel | Enclosure for electrical and control equipment |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
| output | Entity outputs a substance with flows to other entities |
| elec-output | Entity outputs electricity to other entities |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
| equip | |
| point | |
| point | |
def
elec-system
System that generates, converts, distributes, and/or stores electricity.
conjunct
| elec | Associated with electricity or with electrical force, power, or energy |
| system | Grouping of related equipment dedicated to a single application |
meta
| def | elec-system |
| is | system |
| lib | lib:phIoT |
usage
| elec system |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| system | Grouping of related equipment dedicated to a single application |
subtypes
| evse-system | A system that supplies electricity to EVSE assembly equipment and its auxiliary loads |
| lighting-system | System designed to provide lighting |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| systemRef | Reference to system |
children
| equip | |
| point | |
| point | |
def
elecHeating
Heating by the conversion of electrical energy
meta
| def | elecHeating |
| is | heatingProcess, elec-input |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
| wikipedia | https://en.wikipedia.org/wiki/Electric_heating |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| heatingProcess | Processed used to heat a substance |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
tags
| elecRef | Electricity flows from the referent to this entity |
def
elecLine
Single-phase line measurement of an electric quantity in a multi-phase AC electric power system.
meta
| def | elecLine |
| enum | See below |
| is | str |
| lib | lib:phIoT |
enum
| L1 | line 1 measurement |
| L2 | line 2 measurement |
| L3 | line 3 measurement |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
subtypes
| lineCurrent | Single-phase line current measured in an AC electric power system |
| phaseEnergy | Single-phase energy measured line-to-neutral in an AC electric power system |
| phasePf | Single-phase power factor measured line-to-neutral in an AC electric power system |
| phasePower | Single-phase power measured line-to-neutral in an AC electric power system |
def
elecLineToLine
Single-phase electric quantity measured line-to-line in a multi-phase AC electric power system.
meta
| def | elecLineToLine |
| enum | See below |
| is | str |
| lib | lib:phIoT |
enum
| L1-L2 | line 1 to line 2 measurement |
| L2-L3 | line 2 to line 3 measurement |
| L3-L1 | line 3 to line 1 measurement |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
subtypes
| lineEnergy | Single-phase energy measured line-to-line in an AC electric power system |
| linePf | Single-phase power factor measured line-to-line in an AC electric power system |
| linePower | Single-phase power measured line-to-line in an AC electric power system |
| lineVolt | Single-phase voltage measured line-to-line in an AC electric power system |
| phaseCurrent | Single-phase current measured line-to-line in an AC electric power system |
def
elecLineToNeutral
Single-phase electric quantity measured line-to-neutral in a multi-phase AC electric power system.
meta
| def | elecLineToNeutral |
| enum | See below |
| is | str |
| lib | lib:phIoT |
enum
| L1-N | line 1 to neutral measurement |
| L2-N | line 2 to neutral measurement |
| L3-N | line 3 to neutral measurement |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
subtypes
| phaseVolt | Single-phase voltage measured line-to-neutral in an AC electric power system |
def
elecRef
Electricity flows from the referent to this entity
meta
| def | elecRef |
| inputs | elec |
| is | ref |
| lib | lib:phIoT |
| of | elec-output |
| tagOn | elec-input |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
elevator
Enclosure used to move people between floors.
meta
| def | elevator |
| icon | EquipIcon |
| is | verticalTransport, elec-input |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Elevator |
usage
| elevator equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| verticalTransport | Equipment to move humans and materials |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
| equip | |
| point | |
| point | |
def
enable
Secondary on/off point of an equip especially used with a vfd. Enable is used with Bool points where true indicates on and false indicates off. Equip with an enable should always also define a run point which indicates the primary on/off state of the equipment.
meta
| def | enable |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
entering
Pipe conveys fluid into an equipment
meta
| def | entering |
| is | pipeSection |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| pipeSection | Equipment section of piping |
def
equip
Equipment asset. See Equips chapter.
meta
| def | equip |
| icon | EquipIcon |
| is | entity |
| lib | lib:phIoT |
| mandatory | ✓ |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
subtypes
| actuator | Equipment to move or control a mechanism |
| damper-actuator | Actuator to regulate the flow of air |
| valve-actuator | Actuator to regulate the flow of fluid |
| airHandlingEquip | HVAC equipment that conditions and delivers air via one or more fans |
| ahu | Air Handling Unit |
| doas | Dedicated Outside Air System |
| mau | Makeup Air Unit |
| rtu | Roof Top Unit |
| fcu | Fan Coil Unit |
| crac | Computer Room Air Conditioner |
| unitVent | Unit Ventilator |
| vrf-indoorUnit-fcu | Indoor unit fan coil unit in a VRF system |
| airTerminalUnit | Equipment in air distribution systems which terminate at the space |
| cav | Constant air volume terminal unit |
| vav | Variable air volume terminal unit |
| ates | Aquifer Thermal Energy Storage system |
| battery | Equipment used to store electric energy |
| boiler | Equipment to generate hot water or steam for heating |
| hot-water-boiler | Boiler which outputs hot water |
| steam-boiler | Boiler which outputs steam |
| cable | An assembly of one or more insulated conductors |
| chiller | Equipment to remove heat from a liquid |
| circuit | Electrical circuit and its associated components such as breakers |
| conduit | Duct, pipe, or cable to convey a substance or phenomenon |
| duct | Conduit used to convey air for HVAC |
| pipe | Conduit used to convey a fluid |
| wire | Cabling used to convey electricity or data |
| coolingTower | Equipment to transfer waste heat into the atmosphere |
| evse-equip | Equipment that supports the delivery of electricity to charging inlets located on EVs |
| evse-cable | The electrical cable between an evse-port and an EV charging inlet on a vehicle |
| evse-dispenser | Equipment that dispenses electricity to an EV |
| evse-port | An EVSE port delivers electricity to a single EV charging inlet at a time |
| ac-evse-port | An AC EVSE port delivers ac electricity to a single EV charging inlet at a time |
| dc-evse-port | A DC EVSE port delivers dc electricity to a single EV charging inlet at a time |
| evse-powerConverter | A power converter that has a dc electrical output applied to a dc-evse-port |
| flowInverter | System to change direction of substance flow |
| fumeHood | Ventilation equipment to limit exposure to hazardous fumes |
| heatExchanger | Equipment to transfer heat between two working fluids |
| coil | Heat exchanger used to heat or cool air |
| coolingCoil | Coil used to cool air |
| heatingCoil | Coil used to heat air |
| humidifier-equip | Equipment which adds moisture to air to increase humidity |
| luminaire | Light fixture using electricity to provide illumination |
| meter | Equipment to meter a substance or phenomenon |
| elec-meter | Electricity meter |
| ac-elec-meter | AC Electricity meter |
| dc-elec-meter | DC Electricity meter |
| evse-port | An EVSE port delivers electricity to a single EV charging inlet at a time |
| ac-evse-port | An AC EVSE port delivers ac electricity to a single EV charging inlet at a time |
| dc-evse-port | A DC EVSE port delivers dc electricity to a single EV charging inlet at a time |
| flow-meter | Meter to measure flow rate and total volume of fluid |
| motor | Equipment that converts electrical energy into mechanical energy |
| fan-motor | Motor used with a fan to create air flow |
| pump-motor | Motor used with a pump to move fluid |
| panel | Enclosure for electrical and control equipment |
| controls-panel | Panel housing controllers and networking gear |
| elec-panel | Physical housing for electrical circuits, fuses, and breakers |
| plant | Central plant used to generate a substance for a process |
| chilled-water-plant | Plant used to generate chilled water for cooling |
| hot-water-plant | Plant used to generate hot water for heating |
| steam-plant | Plant used to generate steam for heating |
| vrf-refrig-plant | Group of outdoor units in a VRF system |
| rack | Enclosure or chassis used to mount computer and networking gear |
| radiantEquip | HVAC equipment that conditions a space without forced air |
| chilledBeam | Conditions a space using a heat exchanger integrated into the ceiling |
| radiantFloor | Heats a space using pipes or cables embedded beneath floor |
| radiator | Heats a space using exposed pipes or coils |
| tank | Tank used to store a substance for temporary holding |
| thermostat | Senses and controls temperature of space in HVAC system |
| ups | Uninterruptible power supply |
| verticalTransport | Equipment to move humans and materials |
| elevator | Enclosure used to move people between floors |
| escalator | Moving staircase used to move people between floors |
| movingWalkway | Conveyor to move people across a horizontal or inclined plane |
| vrf-equip | Equipment used in VRF systems |
| branchSelector | Branch selector used for heat recovery in a VRF system |
| vrf-indoorUnit | Indoor unit in a VRF system |
| vrf-indoorUnit-fcu | Indoor unit fan coil unit in a VRF system |
| vrf-outdoorUnit | Outdoor unit with one or more compressors in a VRF system |
| well | A well is a source of groundwater and potentially thermal energy |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
| equip | |
| point | |
| point | |
def
equipRef
Reference to equip which contains this entity
meta
| containedBy | equip |
| def | equipRef |
| is | ref |
| lib | lib:phIoT |
| of | equip |
| tagOn | controller, equip, point |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
escalator
Moving staircase used to move people between floors.
meta
| def | escalator |
| icon | EquipIcon |
| is | verticalTransport, elec-input |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Escalator |
usage
| escalator equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| verticalTransport | Equipment to move humans and materials |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
| equip | |
| point | |
| point | |
def
evaporator
Mechanism used to convert a refrigerant from its liquid to gaseous state.
meta
| def | evaporator |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
evse-cable
The electrical cable between an evse-port and an EV charging inlet on a vehicle. The evseCableType tag distinguishes the type of cable. See EVSE chapter.
conjunct
| evse | Electric Vehicle Supply Equipment |
| cable | An assembly of one or more insulated conductors |
meta
| def | evse-cable |
| is | evse-equip |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Charging_station |
usage
| evse cable equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| evse-equip | Equipment that supports the delivery of electricity to charging inlets located on EVs |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
| output | Entity outputs a substance with flows to other entities |
| elec-output | Entity outputs electricity to other entities |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| evseCableType | Physical type of evse-cable |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
| equip | |
| point | |
| point | |
def
evse-dispenser
Equipment that dispenses electricity to an EV. It consists of a physical EVSE enclosure and its contents to which an evse-cable attaches. An evse-dispenser can contain zero or more evse-port.
Children points are used to describe or control one or more evse-port within the EVSE manufacturer's package.
See EVSE chapter.
conjunct
| evse | Electric Vehicle Supply Equipment |
| dispenser | Equipment that releases a specific amount of a substance |
meta
| def | evse-dispenser |
| is | evse-equip |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Charging_station |
usage
| evse dispenser equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| evse-equip | Equipment that supports the delivery of electricity to charging inlets located on EVs |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
| output | Entity outputs a substance with flows to other entities |
| elec-output | Entity outputs electricity to other entities |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
def
evse-equip
Equipment that supports the delivery of electricity to charging inlets located on EVs. See EVSE chapter.
conjunct
| evse | Electric Vehicle Supply Equipment |
| equip | Equipment asset |
meta
| def | evse-equip |
| is | equip, elec-input, elec-output |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Charging_station |
usage
| evse equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
| output | Entity outputs a substance with flows to other entities |
| elec-output | Entity outputs electricity to other entities |
subtypes
| evse-cable | The electrical cable between an evse-port and an EV charging inlet on a vehicle |
| evse-dispenser | Equipment that dispenses electricity to an EV |
| evse-port | An EVSE port delivers electricity to a single EV charging inlet at a time |
| ac-evse-port | An AC EVSE port delivers ac electricity to a single EV charging inlet at a time |
| dc-evse-port | A DC EVSE port delivers dc electricity to a single EV charging inlet at a time |
| evse-powerConverter | A power converter that has a dc electrical output applied to a dc-evse-port |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
| equip | |
| point | |
| point | |
def
evse-port
An EVSE port delivers electricity to a single EV charging inlet at a time. Comprised of a software-controlled electrical contactor or circuit breaker. Typically contained within an evse-dispenser, but may be contained within an evse-powerConverter. More than one evse-cable may be connected to a single evse-port, however, only one may be energized at any given time.
Note: In the future we might add an entity that describes evse-port contained in an AC distribution panel. This scenario is not common.
See EVSE chapter.
conjunct
| evse | Electric Vehicle Supply Equipment |
| port | A gateway or opening used to transfer a substance |
meta
| def | evse-port |
| icon | bolt |
| is | evse-equip, elec-meter |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Charging_station |
usage
| evse port equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| evse-equip | Equipment that supports the delivery of electricity to charging inlets located on EVs |
| meter | Equipment to meter a substance or phenomenon |
| elec-meter | Electricity meter |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
| output | Entity outputs a substance with flows to other entities |
| elec-output | Entity outputs electricity to other entities |
subtypes
| ac-evse-port | An AC EVSE port delivers ac electricity to a single EV charging inlet at a time |
| dc-evse-port | A DC EVSE port delivers dc electricity to a single EV charging inlet at a time |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| meterScope | Classifies a meter as a main site meter or submeter |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| submeterOf | Reference to parent meter which is immediately upstream of this meter |
| systemRef | Reference to system |
| tariffHisRef | If multiple meters share the same tariff history, then you can use this tag to reference the "master" point containing the tariff history |
children
| evse cable equip | |
| evse evseStatus sensor point | |
| evse evseStatus sensor point | |
def
evse-powerConverter
A power converter that has a dc electrical output applied to a dc-evse-port. May be contained within an evse-dispenser or in a separate dedicated equipment enclosure.
Children points are used to describe or control one or more evse-port within the EVSE manufacturer's package.
See EVSE chapter.
conjunct
| evse | Electric Vehicle Supply Equipment |
| powerConverter | Converts one electrical waveform to another using power electronic circuitry |
meta
| def | evse-powerConverter |
| is | evse-equip |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Charging_station |
usage
| evse powerConverter equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| evse-equip | Equipment that supports the delivery of electricity to charging inlets located on EVs |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
| output | Entity outputs a substance with flows to other entities |
| elec-output | Entity outputs electricity to other entities |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
| evse evseStatus sensor point | |
| evse port equip | |
| evse port equip | |
| import dc elec power max sp point | |
| import dc elec power max sp point | |
def
evse-system
A system that supplies electricity to EVSE assembly equipment and its auxiliary loads.
conjunct
| evse | Electric Vehicle Supply Equipment |
| system | Grouping of related equipment dedicated to a single application |
meta
| def | evse-system |
| is | elec-system |
| lib | lib:phIoT |
usage
| evse system |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| system | Grouping of related equipment dedicated to a single application |
| elec-system | System that generates, converts, distributes, and/or stores electricity |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| systemRef | Reference to system |
children
| equip | |
| point | |
| point | |
def
evse
Electric Vehicle Supply Equipment. See EVSE chapter.
meta
| def | evse |
| is | marker |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Charging_station |
supertypes
| marker | Marker labels a dict with typing information |
def
evseCableType
Physical type of evse-cable.
meta
| def | evseCableType |
| enum | See below |
| is | str |
| lib | lib:phIoT |
| tagOn | evse-cable |
enum
| ccs1 | CCS1 charging cable |
| ccs2 | CCS2 charging cable |
| chademo | CHAdeMO charging cable |
| saeJ3400 | SAE J3400 charging cable |
| saeJ1772 | SAE J1772 charging cable |
| saeJ3068 | SAE J3068 charging cable |
| iecType2 | IEC 62196 Type 2 charging cable |
| mcs | Megawatt Charging System charging cable |
| gbt | GB/T charging cable |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
evseSession
Describes an event during which an evse-port can deliver power to an EV. The EVSE may need to authorize a user to initiate an evseSession.
At minimum has the following data:
- ts: when the event was logged by the system of record
- started: when the event started
- stopped: when the event stopped
- tx: transaction ID for the event
- targetRef: reference to the
evse-port - energyDelivered: energy delivered during the
evseSession - event: marker tag
- meterStart: meter register's value at the beginning of the
evseSession
In the future additional data might be included, such as the means of EV charging session authorization.
meta
| def | evseSession |
| is | entity |
| lib | lib:phIoT |
| mandatory | ✓ |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
tags
| dis | Display name for an entity |
| id | Defines the unique identifier of an entity in system using a ref value type |
def
evseStatus
Status of one or more evse-port reported by an EVSE.
When applied to an evse-port, indicates the status of an EVSE port.
When applied to an evse-dispenser or evse-powerConverter, indicates the status of one or more evse-port within an EVSE manufacturer's package. In this case only the enum values available, unavailable, and fault apply.
meta
| def | evseStatus |
| enum | See below |
| is | str |
| lib | lib:phIoT |
enum
| available | When the point references an evse-port, indicates the evse-port is available for recharging a vehicle. During this condition none of the evse-cable that reference the evse-port are plugged into a vehicle charging inlet. Also, a parked vehicle may prohibit another vehicle from recharging. When the point references evse-dispenser or evse-powerConverter, indicates evse-port within the EVSE manufacturer's package are available for an evseSession and may actively be in one. Also, an evse-port may have another evseStatus based on its condition. |
| preparing | After an evse-port is no longer available and before an evseSession begins. Typically this condition applies during the authorization of an evseSession. This value is deprecated in favor of the occupied value. |
| charging | When there is an active evseSession and the contactor for the evse-port is closed. This value is deprecated in favor of the occupied value. |
| suspendedEVSE | When the evse-port is occupied and not within an active evseSession due to inavailability of power to deliver to the vehicle or an unsuccessful attempt to establish an evseSession. This value is deprecated in favor of the occupied value. |
| suspendedEV | When a vehicle does not accept power being offered by the evse-port during an active evseSession. This value is deprecated in favor of the occupied value. |
| finishing | After an evseSession when the evse-port is still occupied. This value is deprecated in favor of the occupied value. |
| occupied | When an evse-cable that references the evse-port is plugged into a vehicle's charging inlet. During this condition the evse-port may or may not be within an active evseSession. |
| reserved | When the evse-port is dedicated to a specific user. During this condition only the intended user can authorize an evseSession with their vehicle. An unauthorized user and their parked vehicle may prohibit an authorized user from recharging. |
| unavailable | When the EVSE prohibits EV charging on the evse-port due to an applied software setting for the evse-port or EVSE manufacturer's package. |
| fault | When the EVSE prohibits EV charging on the evse-port due to a fault condition within the evse-port or EVSE manufacturer's package. |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
exhaust
Duct used to expel air back outside
meta
| def | exhaust |
| is | ductSection |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| ductSection | Equipment section of ductwork |
def
export
Supplied out of a system
meta
| def | export |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
extraction
Taking a substance out of another substance
meta
| def | extraction |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
faceBypass
Point of an ahu indicating air flow is by-passing the heating/cooling coils. If a boolean point, then true indicates the unit is in by-pass mode and false indicates by-pass is disabled. If the point is an analog point then 100% indicates full by-pass mode and 0% indicates by-pass is completely disabled.
meta
| def | faceBypass |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
fan-motor
Motor used with a fan to create air flow. See Motors chapter.
conjunct
| fan | Fan equipment or control point |
| motor | Equipment that converts electrical energy into mechanical energy |
meta
| childrenFlatten | ductSection, fan |
| def | fan-motor |
| icon | EquipIcon |
| is | motor |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Fan_(machine) |
usage
| fan motor equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| motor | Equipment that converts electrical energy into mechanical energy |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| ductSection | Equipment section of ductwork |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| phaseCount | Number of phases for an AC electrical power system or connected equipment |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
| vfd | Variable-frequency drive |
children
def
fan
Fan equipment or control point
meta
| def | fan |
| icon | fan |
| is | marker |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Fan_(machine) |
supertypes
| marker | Marker labels a dict with typing information |
def
fanPowered
Device with a fan
meta
| def | fanPowered |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
fcu
Fan Coil Unit: A unitary, factory-made enclosure with a fan and coil that recirculates air in a space and performs one or more of the functions of cleaning, heating, cooling, humidifying, dehumidifying, or ventilating the air. Unit heaters are examples of FCUs. See AHUs chapter.
meta
| def | fcu |
| icon | EquipIcon |
| is | airHandlingEquip |
| lib | lib:phIoT |
| mandatory | ✓ |
| wikipedia | https://en.wikipedia.org/wiki/Fan_coil_unit |
usage
| fcu equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| airHandlingEquip | HVAC equipment that conditions and delivers air via one or more fans |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
| output | Entity outputs a substance with flows to other entities |
| air-output | Entity outputs air to other entities |
subtypes
| crac | Computer Room Air Conditioner |
| unitVent | Unit Ventilator |
| vrf-indoorUnit-fcu | Indoor unit fan coil unit in a VRF system |
tags
| ahuZoneDelivery | AHU delivery method of conditioned air to the zone |
| airVolumeAdjustability | Ability of air handling equip to adjust volume of air flow |
| coolingProcess | Processed used to cool a substance |
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| ductConfig | Ductwork configuration |
| ductDeck | Cold, hot, or neutral deck |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| heatingProcess | Processed used to heat a substance |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
def
filter
Related to an air or fluid filter.
meta
| def | filter |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
floor
Storey of a building. See Spaces chapter.
meta
| def | floor |
| icon | FloorsIcon |
| is | space |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Storey |
usage
| floor space |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| space | Space is a three-dimensional volume in the built environment |
subtypes
| ground-floor | Floor at ground level |
| roof-floor | The roof floor is the topmost level of a building |
| subterranean-floor | Floor below ground level |
tags
| area | Area of a shape or floor space |
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| floorNum | Unitless integer indicating the floor's distance from ground level |
| floorRef | A legacy deprecated floor reference |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
children
| equip | |
| point | |
| point | |
| space | |
| space | |
def
floorNum
Unitless integer indicating the floor's distance from ground level. The ground floor is always defined as zero. Additional floors above ground are numbered 1, 2, 3, etc. Subterranean floors are numbered -1, -2, -3, etc. This convention is consistent with how most European buildings number floors. In North America its common to label the ground floor as the first floor; however Haystack requires the ground level to be assigned a floorNum of 0.
meta
| def | floorNum |
| is | int |
| lib | lib:phIoT |
| tagOn | floor |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| number | Integer or floating point numbers annotated with an optional unit |
| int | Unitless integer number |
def
flow-meter
Meter to measure flow rate and total volume of fluid. See Meters chapter.
conjunct
| flow | Measure of volumetric flow of fluid |
| meter | Equipment to meter a substance or phenomenon |
meta
| def | flow-meter |
| icon | EquipIcon |
| is | meter |
| lib | lib:phIoT |
usage
| flow meter equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| meter | Equipment to meter a substance or phenomenon |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| meterScope | Classifies a meter as a main site meter or submeter |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| submeterOf | Reference to parent meter which is immediately upstream of this meter |
| systemRef | Reference to system |
| tariffHisRef | If multiple meters share the same tariff history, then you can use this tag to reference the "master" point containing the tariff history |
children
| equip | |
| point | |
| point | |
def
flowInverter
System to change direction of substance flow
meta
| def | flowInverter |
| icon | EquipIcon |
| is | equip |
| lib | lib:phIoT |
usage
| flowInverter equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
| equip | |
| point | |
| point | |
def
flue
Duct for exhausting combustion
meta
| def | flue |
| is | ductSection |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
| wikipedia | https://en.wikipedia.org/wiki/Flue |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| ductSection | Equipment section of ductwork |
def
freezeStat
A boolean point of an ahu indicating a freezing condition. This might require a control sequence to protect the equipment. If true then a freeze condition is detected, or false if not.
meta
| def | freezeStat |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
fuelOil-input
Entity inputs fuel oil which flows from another entity
conjunct
| fuelOil | Petroleum based oil burned for energy |
| input | Entity inputs a substance which flows from another entity |
meta
| def | fuelOil-input |
| is | input |
| lib | lib:phIoT |
usage
| fuelOil input |
supertypes
| marker | Marker labels a dict with typing information |
| input | Entity inputs a substance which flows from another entity |
subtypes
| fuelOilHeating | Heating by the combustion of fuel oil |
tags
| fuelOilRef | Fuel oil flows from the referent to this entity |
def
fuelOil-output
Entity outputs fuel oil to other entities
conjunct
| fuelOil | Petroleum based oil burned for energy |
| output | Entity outputs a substance with flows to other entities |
meta
| def | fuelOil-output |
| is | output |
| lib | lib:phIoT |
usage
| fuelOil output |
supertypes
| marker | Marker labels a dict with typing information |
| output | Entity outputs a substance with flows to other entities |
def
fuelOil
Petroleum based oil burned for energy
meta
| def | fuelOil |
| is | liquid |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Fuel_oil |
supertypes
| marker | Marker labels a dict with typing information |
| phenomenon | Aspect of scientific interest with measurable quantities |
| substance | Matter in one the three states solid, liquid, or gas |
| fluid | Liquid or gas |
| liquid | Substance with definite volume but takes the shape of its container |
quantities
| concentration | Abundance of substance in the total volume of a mixture |
| flow | Measure of volumetric flow of fluid |
| level | Range from 0% to 100% |
| pressure | Measure of force applied |
| temp | Temperature - measure of hot and cold |
| volume | Three dimensional space occupied by a substance |
def
fuelOilHeating
Heating by the combustion of fuel oil
meta
| def | fuelOilHeating |
| is | heatingProcess, fuelOil-input |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| heatingProcess | Processed used to heat a substance |
| input | Entity inputs a substance which flows from another entity |
| fuelOil-input | Entity inputs fuel oil which flows from another entity |
tags
| fuelOilRef | Fuel oil flows from the referent to this entity |
def
fuelOilRef
Fuel oil flows from the referent to this entity
meta
| def | fuelOilRef |
| inputs | fuelOil |
| is | ref |
| lib | lib:phIoT |
| of | fuelOil-output |
| tagOn | fuelOil-input |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
fumeHood
Ventilation equipment to limit exposure to hazardous fumes.
meta
| def | fumeHood |
| icon | EquipIcon |
| is | equip, elec-input |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Fume_hood |
usage
| fumeHood equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
| air flow sensor point | |
| air flow sp point | |
| air flow sp point | |
| air velocity sensor point | |
| air velocity sensor point | |
| air velocity sp point | |
| air velocity sp point | |
| alarm sensor point | |
| alarm sensor point | |
def
gasoline-input
Entity inputs gasoline which flows from another entity
conjunct
| gasoline | Petroleum derived liquid used as a fuel source |
| input | Entity inputs a substance which flows from another entity |
meta
| def | gasoline-input |
| is | input |
| lib | lib:phIoT |
usage
| gasoline input |
supertypes
| marker | Marker labels a dict with typing information |
| input | Entity inputs a substance which flows from another entity |
tags
| gasolineRef | Gasoline flows from the referent to this entity |
def
gasoline-output
Entity outputs gasoline to other entities
conjunct
| gasoline | Petroleum derived liquid used as a fuel source |
| output | Entity outputs a substance with flows to other entities |
meta
| def | gasoline-output |
| is | output |
| lib | lib:phIoT |
usage
| gasoline output |
supertypes
| marker | Marker labels a dict with typing information |
| output | Entity outputs a substance with flows to other entities |
def
gasoline
Petroleum derived liquid used as a fuel source
meta
| def | gasoline |
| is | liquid |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Gasoline |
supertypes
| marker | Marker labels a dict with typing information |
| phenomenon | Aspect of scientific interest with measurable quantities |
| substance | Matter in one the three states solid, liquid, or gas |
| fluid | Liquid or gas |
| liquid | Substance with definite volume but takes the shape of its container |
quantities
| concentration | Abundance of substance in the total volume of a mixture |
| flow | Measure of volumetric flow of fluid |
| level | Range from 0% to 100% |
| pressure | Measure of force applied |
| temp | Temperature - measure of hot and cold |
| volume | Three dimensional space occupied by a substance |
def
gasolineRef
Gasoline flows from the referent to this entity
meta
| def | gasolineRef |
| inputs | gasoline |
| is | ref |
| lib | lib:phIoT |
| of | gasoline-output |
| tagOn | gasoline-input |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
ground-floor
Floor at ground level. In North America this is typically called the first floor, but in Europe its often labeled as floor zero. If floorNum is defined, then it must be set to zero.
conjunct
| ground | Related to the surface of the earth |
| floor | Storey of a building |
meta
| def | ground-floor |
| is | floor |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Storey |
usage
| ground floor space |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| space | Space is a three-dimensional volume in the built environment |
| floor | Storey of a building |
tags
| area | Area of a shape or floor space |
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| floorNum | Unitless integer indicating the floor's distance from ground level |
| floorRef | A legacy deprecated floor reference |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
children
| equip | |
| point | |
| point | |
| space | |
| space | |
def
ground-water
Water present under the ground or from a well
conjunct
| ground | Related to the surface of the earth |
| water | Water in its liquid form |
meta
| def | ground-water |
| is | water |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Groundwater |
usage
| ground water |
supertypes
| marker | Marker labels a dict with typing information |
| phenomenon | Aspect of scientific interest with measurable quantities |
| substance | Matter in one the three states solid, liquid, or gas |
| fluid | Liquid or gas |
| liquid | Substance with definite volume but takes the shape of its container |
| water | Water in its liquid form |
quantities
| concentration | Abundance of substance in the total volume of a mixture |
| flow | Measure of volumetric flow of fluid |
| level | Range from 0% to 100% |
| pressure | Measure of force applied |
| temp | Temperature - measure of hot and cold |
| volume | Three dimensional space occupied by a substance |
def
ground
Related to the surface of the earth. Used to indicate electrical current being measured on an electrical ground conductor when applied to a point entity that has the elec and current tags.
meta
| def | ground |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
header
Pipe used as central connection or manifold for other piping runs.
meta
| def | header |
| is | pipeSection |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| pipeSection | Equipment section of piping |
def
heat
Associated with a heating process. When used on a point, this tag is associated with the control of heating.
meta
| def | heat |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
heatExchanger
Equipment to transfer heat between two working fluids.
meta
| def | heatExchanger |
| icon | EquipIcon |
| is | equip |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Heat_exchanger |
usage
| heatExchanger equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
subtypes
| coil | Heat exchanger used to heat or cool air |
| coolingCoil | Coil used to cool air |
| heatingCoil | Coil used to heat air |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
| equip | |
| point | |
| point | |
def
heatPump
Equipment that employs a vapor compression cycle with a reversing valve to provide heating or cooling. For vapor compression heating without a reversing valve, such as for a heat pump water heater, see dxHeating which should be used.
meta
| def | heatPump |
| icon | EquipIcon |
| is | marker |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Heat_pump |
supertypes
| marker | Marker labels a dict with typing information |
def
heatRecovery
Transfer of heat from one substance to another to reduce energy consumption.
meta
| def | heatRecovery |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
heatWheel
Boolean point indicating command state of AHU's heat wheel.
meta
| def | heatWheel |
| is | marker |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Thermal_wheel |
supertypes
| marker | Marker labels a dict with typing information |
def
heating
Heating mode or process
meta
| def | heating |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
heatingCoil
Coil used to heat air.
meta
| childrenFlatten | ductDeck, ductSection |
| def | heatingCoil |
| icon | EquipIcon |
| is | coil |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Heat_exchanger#HVAC_air_coils |
usage
| heatingCoil equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| heatExchanger | Equipment to transfer heat between two working fluids |
| coil | Heat exchanger used to heat or cool air |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| heatingProcess | Processed used to heat a substance |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
| hot water heat valve cmd point | |
| stage:1 heat run cmd point | |
| stage:1 heat run cmd point | |
| steam heat valve cmd point | |
| steam heat valve cmd point | |
def
heatingOnly
Equipment without cooling
meta
| def | heatingOnly |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
heatingProcess
Processed used to heat a substance
meta
| def | heatingProcess |
| is | choice |
| lib | lib:phIoT |
| tagOn | airHandlingEquip, boiler, chilledBeam, heatingCoil, radiator, radiantFloor, vav |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
subtypes
| biomassHeating | Heating by the combustion of biomass |
| coalHeating | Heating by the combustion of coal |
| dxHeating | Heating using direct expansion of a refrigerant vapor |
| elecHeating | Heating by the conversion of electrical energy |
| fuelOilHeating | Heating by the combustion of fuel oil |
| hotWaterHeating | Heating using energy of hot water |
| naturalGasHeating | Heating by the combustion of natural gas |
| propaneHeating | Heating by the combustion of propane |
| steamHeating | Heating using energy of steam |
def
his-point
Historized point with a history log of timestamp/value pairs. Points marked as historized indicate the system can response to queries via the hisRead operation to return a trend log of timestamp/value pairs.
There are typically two mechanisms for historization:
- the local system performs the historization by logging the point's
curValto local storage - in overlay systems a downstream device performs the historization and the local system synchronizes the history data in batch on a periodic basis
Also see Points chapter.
conjunct
| his | Supports historization of data |
| point | Data point such as a sensor or actuator |
meta
| def | his-point |
| is | point |
| lib | lib:phIoT |
usage
| his point |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| point | Data point such as a sensor or actuator |
subtypes
| tariffHis | Identifies the tariff history point for a meter |
tags
| cur | Supports current value |
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| disabled | Indicates the entity is in a disabled state |
| enum | Defines an eumeration of string key names |
| equipRef | Reference to equip which contains this entity |
| ghgFactorHis | Identifies point record with interval emission factor data that the Greenhouse Gas Emission Engine uses to calculate emissions |
| his | Supports historization of data |
| hisAppendNA | Specifies the amount of time after a history point's hisEnd that the hisRead() function should append an NA |
| hisCollectCov | Enables COV history collection of the curVal |
| hisCollectCovRateLimit | Rate limits the frequency for hisCollectCov |
| hisCollectInterval | Enables interval history collection of the curVal |
| hisCollectNA | Historize the NA value whenever the curVal is null or curStatus is not equal to "ok" |
| hisCollectWriteFreq | This tag configures how long to buffer collected history items in memory before flushing them to the historian |
| hisEnd | Timestamp of newest item in history |
| hisErr | Error description when hisStatus indicates error condition |
| hisInterpolateMode | Explicitly configures the interpolation mode to use for this point |
| hisMode | Indicates the way that history data is collected for a point |
| hisRollupAutoMinInterval | Forces hisRollupAuto() to do a rollup using this interval when none is specified and the range of the source history grid is less than 2 days |
| hisSize | Approximate number of timestamp/value pairs stored in history |
| hisStart | Timestamp of oldest item in history |
| hisStatus | Status of point's history collection or synchronization |
| hisTotalized | Indicates values which are a continuous stream of totalization |
| id | Defines the unique identifier of an entity in system using a ref value type |
| kind | Kind name used to identity a value data type |
| maxVal | Inclusive maximum for a numeric value |
| minVal | Inclusive minimum for a numeric value |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| pointFunction | Classifies the point as a sensor, command, or setpoint |
| pointQuantity | Quantity the point senses or controls |
| pointSubject | What the point senses or controls |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
| tz | Timezone identifier from standard timezone database |
| unit | Unit identifier from standard unit database |
| writable | Supports writing data |
def
his
Supports historization of data
meta
| def | his |
| is | marker |
| lib | lib:phIoT |
| tagOn | point |
supertypes
| marker | Marker labels a dict with typing information |
def
hisErr
Error description when hisStatus indicates error condition
meta
| def | hisErr |
| is | str |
| lib | lib:phIoT |
| tagOn | his-point |
| transient | ✓ |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
hisMode
Indicates the way that history data is collected for a point.
meta
| def | hisMode |
| enum | See below |
| is | str |
| lib | lib:phIoT |
| tagOn | his-point |
enum
| sampled | Data is sampled on a regular interval. The timestamp indicates exactly when the sample was taken, and we assume linear interpolation between samples. |
| cov | Data is logged when it changes. The means the timestamp indicates exactly when it changed (inclusive) and it remains that value until the next sample's timestamp (exclusive). |
| consumption | Integral data is sampled on a regular interval and logged at the end of the interval. The timestamp indicates the end of the interval. Therefore, the raw data is logged as start exclusive, end inclusive. This is mode is typical for consumption meters. |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
hisStatus
Status of point's history collection or synchronization
meta
| def | hisStatus |
| enum | See below |
| is | str |
| lib | lib:phIoT |
| tagOn | his-point |
| transient | ✓ |
enum
| ok | last sync attempt was successful |
| fault | a configuration problem - see hisErr |
| down | a communication or network problem - see hisErr |
| disabled | manual disable of the point or parent connector |
| unknown | we don't know anything (usually boot state) |
| pending | sync has been scheduled and is waiting to running |
| syncing | sync is currently running |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
hisTotalized
Indicates values which are a continuous stream of totalization. History data reads and should be normalized by computing the delta.
meta
| def | hisTotalized |
| is | marker |
| lib | lib:phIoT |
| tagOn | his-point |
supertypes
| marker | Marker labels a dict with typing information |
def
hot-water-boiler
Boiler which outputs hot water
conjunct
| hot | Having high degree of heat |
| water | Water in its liquid form |
| boiler | Equipment to generate hot water or steam for heating |
meta
| def | hot-water-boiler |
| icon | EquipIcon |
| is | boiler, hot-water-output |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Boiler |
usage
| hot water boiler equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| boiler | Equipment to generate hot water or steam for heating |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
| output | Entity outputs a substance with flows to other entities |
| hot-water-output | Entity outputs hot water to other entities |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| heatingProcess | Processed used to heat a substance |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
def
hot-water-input
Entity inputs hot water which flows from another entity
conjunct
| hot | Having high degree of heat |
| water | Water in its liquid form |
| input | Entity inputs a substance which flows from another entity |
meta
| def | hot-water-input |
| is | input |
| lib | lib:phIoT |
usage
| hot water input |
supertypes
| marker | Marker labels a dict with typing information |
| input | Entity inputs a substance which flows from another entity |
subtypes
| hotWaterHeating | Heating using energy of hot water |
tags
| hotWaterRef | Hot water flows from the referent to this entity |
def
hot-water-output
Entity outputs hot water to other entities
conjunct
| hot | Having high degree of heat |
| water | Water in its liquid form |
| output | Entity outputs a substance with flows to other entities |
meta
| def | hot-water-output |
| is | output |
| lib | lib:phIoT |
usage
| hot water output |
supertypes
| marker | Marker labels a dict with typing information |
| output | Entity outputs a substance with flows to other entities |
subtypes
| hot-water-boiler | Boiler which outputs hot water |
| hot-water-plant | Plant used to generate hot water for heating |
def
hot-water-plant
Plant used to generate hot water for heating. See Plants.
conjunct
| hot | Having high degree of heat |
| water | Water in its liquid form |
| plant | Central plant used to generate a substance for a process |
meta
| def | hot-water-plant |
| icon | EquipIcon |
| is | plant, hot-water-output |
| lib | lib:phIoT |
usage
| hot water plant equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| plant | Central plant used to generate a substance for a process |
| output | Entity outputs a substance with flows to other entities |
| hot-water-output | Entity outputs hot water to other entities |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
def
hot-water-system
System that circulates water in its liquid state for heating a space or process.
conjunct
| hot | Having high degree of heat |
| water | Water in its liquid form |
| system | Grouping of related equipment dedicated to a single application |
meta
| def | hot-water-system |
| is | water-system |
| lib | lib:phIoT |
usage
| hot water system |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| system | Grouping of related equipment dedicated to a single application |
| water-system | System that supplies or collects potable or non-potable water in any state |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| systemRef | Reference to system |
children
| equip | |
| point | |
| point | |