外观
lib-phIoT 库参考（第 3 部分）
原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793849125/FIN+5.3.1+lib-phIoT+part+3 中文整理基于 FIN 5.3.1
导读： 用于暖通空调加热的热水或供应到热水龙头的热水
以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。
目录（导读）
概述（中译）
用于暖通空调加热的热水或供应到热水龙头的热水
API 正文（英文）
meta
| def | hot-water |
| is | water |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Water |
usage
| hot 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
hot
Having high degree of heat
meta
| def | hot |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
hotDeck
Duct carries air for heating
meta
| def | hotDeck |
| is | ductDeck |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| ductDeck | Cold, hot, or neutral deck |
def
hotWaterHeating
Heating using energy of hot water
meta
| def | hotWaterHeating |
| is | heatingProcess, hot-water-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 |
| hot-water-input | Entity inputs hot water which flows from another entity |
tags
| hotWaterRef | Hot water flows from the referent to this entity |
def
hotWaterRef
Hot water flows from the referent to this entity
meta
| def | hotWaterRef |
| inputs | hot-water |
| is | ref |
| lib | lib:phIoT |
| of | hot-water-output |
| tagOn | hot-water-input |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
humidifier-equip
Equipment which adds moisture to air to increase humidity
conjunct
| humidifier | Adding moisture to air |
| equip | Equipment asset |
meta
| childrenFlatten | |
| def | humidifier-equip |
| icon | EquipIcon |
| is | equip |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Humidifier |
usage
| humidifier 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
| humidifier enable cmd point | |
| humidifier run cmd point | |
| humidifier run cmd point | |
def
humidifier
Adding moisture to air
meta
| def | humidifier |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
hvac-zone-space
Zone related to conditioning of a space's air temperature and quality. See Spaces and Zones chapters.
conjunct
| hvac | Heating, ventilation, and air conditioning |
| zone | Related to spaces from a system perspective |
| space | Space is a three-dimensional volume in the built environment |
meta
| def | hvac-zone-space |
| is | zone-space, hvacZonePoints, airQualityZonePoints, air-input |
| lib | lib:phIoT |
usage
| hvac zone space |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| pointGroup | Grouping of children points used by spaces and equipment |
| airQualityZonePoints | Entity with logical grouping of zone air quality points |
| hvacZonePoints | Entity with logical grouping of zone HVAC air points |
| space | Space is a three-dimensional volume in the built environment |
| zone-space | Space associated with a specific system |
| input | Entity inputs a substance which flows from another entity |
| air-input | Entity inputs air which flows from another entity |
tags
| airRef | Air flows from the referent to this entity |
| area | Area of a shape or floor space |
| 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 |
| spaceRef | Reference to space which contains this entity |
children
def
hvac
Heating, ventilation, and air conditioning
meta
| def | hvac |
| is | marker |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/HVAC |
supertypes
| marker | Marker labels a dict with typing information |
def
hvacMode
Operational mode for HVAC equipment
meta
| def | hvacMode |
| enum | See below |
| is | marker |
| lib | lib:phIoT |
enum
| cooling | |
| heating | |
| reheat | |
| warmup | morning warmup where AHU is supplying warm air |
| purge | night purge when AHU is supplying 100% fresh air |
| pressurize | |
| depressurize | |
| manual |
supertypes
| marker | Marker labels a dict with typing information |
def
hvacZonePoints
Entity with logical grouping of zone HVAC air points. See Zones chapter.
meta
| def | hvacZonePoints |
| is | pointGroup |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| pointGroup | Grouping of children points used by spaces and equipment |
subtypes
| hvac-zone-space | Zone related to conditioning of a space's air temperature and quality |
| thermostat | Senses and controls temperature of space in HVAC system |
tags
| dis | Display name for an entity |
| id | Defines the unique identifier of an entity in system using a ref value type |
children
def
imbalance
Lacking balance
meta
| def | imbalance |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
import
Received into a system
meta
| def | import |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
indoorUnit
Operates inside the conditioned space
meta
| def | indoorUnit |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
infiltration
Permeation of a substance into another substance
meta
| def | infiltration |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
inlet
Duct with air entering an equipment
meta
| def | inlet |
| 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
isolation
Actuator used to isolate an equipment from a pipe or ductwork system
meta
| def | isolation |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
leaving
Pipe conveys fluid out of an equipment
meta
| def | leaving |
| 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
lighting-system
System designed to provide lighting.
conjunct
| lighting | Systems associated with illumination in the built environment |
| system | Grouping of related equipment dedicated to a single application |
meta
| def | lighting-system |
| is | elec-system |
| lib | lib:phIoT |
usage
| lighting 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
lighting-zone-space
Zone related to lighting system. See Spaces and Zones chapters.
conjunct
| lighting | Systems associated with illumination in the built environment |
| zone | Related to spaces from a system perspective |
| space | Space is a three-dimensional volume in the built environment |
meta
| def | lighting-zone-space |
| is | zone-space, lightingZonePoints |
| lib | lib:phIoT |
usage
| lighting zone space |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| pointGroup | Grouping of children points used by spaces and equipment |
| lightingZonePoints | Entity with logical grouping of lighting points |
| space | Space is a three-dimensional volume in the built environment |
| zone-space | Space associated with a specific system |
tags
| area | Area of a shape or floor space |
| 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 |
| spaceRef | Reference to space which contains this entity |
children
def
lighting
Systems associated with illumination in the built environment
meta
| def | lighting |
| is | marker |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Lighting |
supertypes
| marker | Marker labels a dict with typing information |
def
lightingZonePoints
Entity with logical grouping of lighting points. See Zones chapter.
meta
| def | lightingZonePoints |
| is | pointGroup |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| pointGroup | Grouping of children points used by spaces and equipment |
subtypes
| lighting-zone-space | Zone related to lighting system |
| luminaire | Light fixture using electricity to provide illumination |
tags
| dis | Display name for an entity |
| id | Defines the unique identifier of an entity in system using a ref value type |
children
| light level sensor point | |
| light level sp point | |
| light level sp point | |
| light illuminance sensor point | |
| light illuminance sensor point | |
| light luminous flux sensor point | |
| light luminous flux sensor point | |
def
lineAvg
Line average of single-phase electrical quantity measurements in an AC electric power system.
When applied to a point entity that has the elec and volt tags, indicates the average of all available lineVolt measurements.
When applied to a point entity that has the elec and current tags, indicates the average of all available lineCurrent measurements.
When applied to a point entity that has the elec and power tags, indicates the average of all available linePower measurements.
When applied to a point entity that has the elec and pf tags, indicates the average of all available linePf measurements.
When applied to a point entity that has the elec and energy tags, indicates the average of all available lineEnergy measurements.
meta
| def | lineAvg |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
lineCurrent
Single-phase line current measured in an AC electric power system.
meta
| def | lineCurrent |
| enum | See below |
| is | elecLine |
| 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 |
| elecLine | Single-phase line measurement of an electric quantity in a multi-phase AC electric power system |
def
lineEnergy
Single-phase energy measured line-to-line in an AC electric power system.
meta
| def | lineEnergy |
| enum | See below |
| is | elecLineToLine |
| 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 |
| elecLineToLine | Single-phase electric quantity measured line-to-line in a multi-phase AC electric power system |
def
linePf
Single-phase power factor measured line-to-line in an AC electric power system.
meta
| def | linePf |
| enum | See below |
| is | elecLineToLine |
| 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 |
| elecLineToLine | Single-phase electric quantity measured line-to-line in a multi-phase AC electric power system |
def
linePower
Single-phase power measured line-to-line in an AC electric power system. May also be referred to as a line power measurement.
meta
| def | linePower |
| enum | See below |
| is | elecLineToLine |
| 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 |
| elecLineToLine | Single-phase electric quantity measured line-to-line in a multi-phase AC electric power system |
def
lineVolt
Single-phase voltage measured line-to-line in an AC electric power system. May also be referred to as a line voltage measurement.
meta
| def | lineVolt |
| enum | See below |
| is | elecLineToLine |
| 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 |
| elecLineToLine | Single-phase electric quantity measured line-to-line in a multi-phase AC electric power system |
def
load
Chiller point to command or measure the chiller's load as a percentage from "0%" to "100%". When paired with cmd this models the chiller's load limit. When paired with sensor this models the chiller's current load factor.
meta
| def | load |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
luminaire
Light fixture using electricity to provide illumination
meta
| def | luminaire |
| icon | lightbulb |
| is | equip, lightingZonePoints, elec-input |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Light_fixture |
usage
| luminaire equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| pointGroup | Grouping of children points used by spaces and equipment |
| lightingZonePoints | Entity with logical grouping of lighting points |
| 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
| light illuminance sensor point | |
| light level sensor point | |
| light level sensor point | |
| light level sp point | |
| light level sp point | |
| light luminous flux sensor point | |
| light luminous flux sensor point | |
def
makeup-water-input
Entity inputs makeup water which flows from another entity
conjunct
| makeup | Restore something missed or lost |
| water | Water in its liquid form |
| input | Entity inputs a substance which flows from another entity |
meta
| def | makeup-water-input |
| is | input |
| lib | lib:phIoT |
usage
| makeup water input |
supertypes
| marker | Marker labels a dict with typing information |
| input | Entity inputs a substance which flows from another entity |
tags
| makeupWaterRef | Makeup water flows from the referent to this entity |
def
makeup-water-output
Entity outputs makeup water to other entities
conjunct
| makeup | Restore something missed or lost |
| water | Water in its liquid form |
| output | Entity outputs a substance with flows to other entities |
meta
| def | makeup-water-output |
| is | output |
| lib | lib:phIoT |
usage
| makeup water output |
supertypes
| marker | Marker labels a dict with typing information |
| output | Entity outputs a substance with flows to other entities |
def
makeup-water
Water used used to makeup water loss through leaks, evaporation, or blowdown
conjunct
| makeup | Restore something missed or lost |
| water | Water in its liquid form |
meta
| def | makeup-water |
| is | water |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Water |
usage
| makeup 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
makeup
Restore something missed or lost
meta
| def | makeup |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
makeupWaterRef
Makeup water flows from the referent to this entity
meta
| def | makeupWaterRef |
| inputs | makeup-water |
| is | ref |
| lib | lib:phIoT |
| of | makeup-water-output |
| tagOn | makeup-water-input |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
mau
Makeup Air Unit: A DOAS that provides make-up air for a separate, dedicated exhaust system. That is, this equip does not contain an exhaust air section. See AHUs chapter.
meta
| def | mau |
| icon | EquipIcon |
| is | doas |
| lib | lib:phIoT |
| navTarget | equip |
| wikipedia | https://en.wikipedia.org/wiki/Air_handler |
usage
| mau 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 |
| doas | Dedicated Outside Air System |
| 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
mech
Associated with a machine or its mechanical force, torque, power, or energy. This is often opposed to elec electrical energy.
meta
| def | mech |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
meter
Equipment to meter a substance or phenomenon. See Meters chapter.
meta
| def | meter |
| icon | bolt |
| is | equip |
| lib | lib:phIoT |
usage
| meter equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
subtypes
| 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 |
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
meterScope
Classifies a meter as a main site meter or submeter
meta
| def | meterScope |
| is | choice |
| lib | lib:phIoT |
| tagOn | meter |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
subtypes
| siteMeter | Main meter for the associated site |
| submeter | Submeters measure usage of a sub-system or equipment within a site |
def
mixed
Duct where fresh outside air and return air is mixed together
meta
| def | mixed |
| 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
mixing
Three way valve which inputs two pipes and outputs a mixture between the two to a single output pipe.
meta
| def | mixing |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
ml-point
See Synthetics chapter.
conjunct
| ml | Machine learning point |
| point | Data point such as a sensor or actuator |
meta
| def | ml-point |
| is | synthetic-point |
| lib | lib:phIoT |
usage
| ml 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 |
| synthetic-point | See Synthetics chapter |
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 |
| 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 |
| syntheticModelRef | See Synthetics chapter |
| systemRef | Reference to system |
| tz | Timezone identifier from standard timezone database |
| unit | Unit identifier from standard unit database |
| writable | Supports writing data |
def
ml
Machine learning point. See Synthetics chapter.
meta
| def | ml |
| is | synthetic |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
usage
| ml synthetic |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| pointFunction | Classifies the point as a sensor, command, or setpoint |
| synthetic | Synthetic point with computed operational data |
def
mlIdentificationPeriod
Training period description, known as the identification period or baseline, utilized during the model training process.
meta
| def | mlIdentificationPeriod |
| is | span |
| lib | lib:phIoT |
| tagOn | mlModel |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| xstr | Extended string - type name and string value encoding |
| span | Time span as modeled encoded as XStr |
def
mlInputVarRefs
List of independent variables, also known as model inputs or features, associated with a machine learning model.
meta
| def | mlInputVarRefs |
| is | list |
| lib | lib:phIoT |
| of | mlVarRef |
| tagOn | mlModel |
supertypes
| val | Data value type |
| list | Ordered list of zero or more values |
def
mlModel
See Synthetics chapter.
meta
| def | mlModel |
| is | syntheticModel |
| lib | lib:phIoT |
usage
| mlModel syntheticModel |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| syntheticModel | See Synthetics chapter |
tags
| dis | Display name for an entity |
| id | Defines the unique identifier of an entity in system using a ref value type |
| mlIdentificationPeriod | Training period description, known as the identification period or baseline, utilized during the model training process |
| mlInputVarRefs | List of independent variables, also known as model inputs or features, associated with a machine learning model |
| mlModelMetrics | Goodness-of-fit metrics provided in the form of a simple dictionary |
| mlModelParameters | Result of model identification, which may appear as a list of model parameters for simpler models or as a reference to a stored model, in the form of a file uri |
| mlOutputVarRef | Dependent variable, also known as the model output or target, associated, with a machine learning model |
def
mlModelMetrics
Goodness-of-fit metrics provided in the form of a simple dictionary. For example: {r2:0.7889, cvrmse:58}.
meta
| def | mlModelMetrics |
| is | dict |
| lib | lib:phIoT |
| tagOn | mlModel |
supertypes
| val | Data value type |
| dict | Map of name/value tag pairs |
def
mlModelParameters
Result of model identification, which may appear as a list of model parameters for simpler models or as a reference to a stored model, in the form of a file uri. The structure of the dict is user-specific.
meta
| def | mlModelParameters |
| is | dict |
| lib | lib:phIoT |
| tagOn | mlModel |
supertypes
| val | Data value type |
| dict | Map of name/value tag pairs |
def
mlOutputVarRef
Dependent variable, also known as the model output or target, associated, with a machine learning model. Represents the predicted outcome generated by the model.
meta
| def | mlOutputVarRef |
| is | ref |
| lib | lib:phIoT |
| of | mlVar |
| tagOn | mlModel |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
mlVar
Machine learning variable representing both model inputs and outputs.
meta
| def | mlVar |
| 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 |
| mlVarFilter | Filter used for querying points by tags, providing more flexibility than mlVarPoint, although it is not mandatory |
| mlVarPoint | Reference to a point associated with a machine learning variable, known as a machine learning variable point |
def
mlVarFilter
Filter used for querying points by tags, providing more flexibility than mlVarPoint, although it is not mandatory.
meta
| def | mlVarFilter |
| is | filterStr |
| lib | lib:phIoT |
| tagOn | mlVar |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
| filterStr | Haystack filter string |
def
mlVarPoint
Reference to a point associated with a machine learning variable, known as a machine learning variable point.
meta
| def | mlVarPoint |
| is | ref |
| lib | lib:phIoT |
| of | point |
| tagOn | mlVar |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
mlVarRef
Reference to a machine learning variable.
meta
| def | mlVarRef |
| is | ref |
| lib | lib:phIoT |
| of | mlVar |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
motor
Equipment that converts electrical energy into mechanical energy. See Motors chapter.
meta
| def | motor |
| icon | EquipIcon |
| is | equip, elec-input |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Electric_motor |
usage
| motor 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 |
subtypes
| fan-motor | Motor used with a fan to create air flow |
| pump-motor | Motor used with a pump to move fluid |
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 |
| 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
movingWalkway
Conveyor to move people across a horizontal or inclined plane.
meta
| def | movingWalkway |
| icon | EquipIcon |
| is | verticalTransport, elec-input |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Moving_walkway |
usage
| movingWalkway 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
multiZone
AHU discharge air is split into a duct per zone
meta
| def | multiZone |
| 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
naturalGas-input
Entity inputs natural gas which flows from another entity
conjunct
| naturalGas | Fossil fuel energy source consisting largely of methane and other hydrocarbons |
| input | Entity inputs a substance which flows from another entity |
meta
| def | naturalGas-input |
| is | input |
| lib | lib:phIoT |
usage
| naturalGas input |
supertypes
| marker | Marker labels a dict with typing information |
| input | Entity inputs a substance which flows from another entity |
subtypes
| naturalGasHeating | Heating by the combustion of natural gas |
tags
| naturalGasRef | Natural gas flows from the referent to this entity |
def
naturalGas-output
Entity outputs natural gas to other entities
conjunct
| naturalGas | Fossil fuel energy source consisting largely of methane and other hydrocarbons |
| output | Entity outputs a substance with flows to other entities |
meta
| def | naturalGas-output |
| is | output |
| lib | lib:phIoT |
usage
| naturalGas output |
supertypes
| marker | Marker labels a dict with typing information |
| output | Entity outputs a substance with flows to other entities |
def
naturalGas
Fossil fuel energy source consisting largely of methane and other hydrocarbons.
The energy content of natural gas varies by region within a range determined on impurities in the gas. You can find a table of these conversions here
meta
| def | naturalGas |
| disKey | ghgExt::fuelSource.naturalGas |
| ghgFuelSource | ✓ |
| is | gas |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Natural_gas |
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 |
| gas | Substance with neither definite volume nor shape |
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
naturalGasHeating
Heating by the combustion of natural gas
meta
| def | naturalGasHeating |
| is | heatingProcess, naturalGas-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 |
| naturalGas-input | Entity inputs natural gas which flows from another entity |
tags
| naturalGasRef | Natural gas flows from the referent to this entity |
def
naturalGasRef
Natural gas flows from the referent to this entity
meta
| def | naturalGasRef |
| inputs | naturalGas |
| is | ref |
| lib | lib:phIoT |
| of | naturalGas-output |
| tagOn | naturalGas-input |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
net
Difference between import and export
meta
| def | net |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
neutral
when applied to a point entity that has the elec and current tags, indicates electrical current being measured on an electrical neutral conductor.
meta
| def | neutral |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
neutralDeck
Duct carries air which by-passes both heating and cooling coils
meta
| def | neutralDeck |
| is | ductDeck |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| ductDeck | Cold, hot, or neutral deck |
def
occ
Occupied mode of a space. See Zones chapter.
meta
| def | occ |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
occupancy
Number of occupants in a space. See Zones chapter.
meta
| def | occupancy |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
occupants
People who use the built environment. See Zones chapter.
meta
| def | occupants |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
occupied
Setpoint or sensor indicating occupancy of a space. See Zones chapter.
meta
| def | occupied |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
op:hisRead
Read historized time series data from a his-point. See Ops chapter.
meta
| def | op:hisRead |
| is | op |
| lib | lib:phIoT |
| noSideEffects | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| op | Operation for HTTP API |
def
op:hisWrite
Write historized time series data from a his-point. See Ops chapter.
meta
| def | op:hisWrite |
| is | op |
| lib | lib:phIoT |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| op | Operation for HTTP API |
def
op:invokeAction
Invoke a user action on a target entity. See Ops chapter.
meta
| def | op:invokeAction |
| is | op |
| lib | lib:phIoT |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| op | Operation for HTTP API |
def
op:pointWrite
Read or command a writable-point. See Ops chapter.
meta
| def | op:pointWrite |
| is | op |
| lib | lib:phIoT |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| op | Operation for HTTP API |
def
outdoorUnit
operates outside the conditioned space
meta
| def | outdoorUnit |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
outside
Duct to access fresh outside air for both ventilation and economizer.
meta
| def | outside |
| 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
panel
Enclosure for electrical and control equipment. Panels may be used to isolate electrical connections and provide environmental protection.
meta
| def | panel |
| icon | EquipIcon |
| is | equip |
| lib | lib:phIoT |
usage
| panel equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
subtypes
| controls-panel | Panel housing controllers and networking gear |
| elec-panel | Physical housing for electrical circuits, fuses, and breakers |
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
parallel
Circuit with multiple paths of flow
meta
| def | parallel |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
perimeterHeat
Auxiliary heating points associated with a vav
meta
| def | perimeterHeat |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
pf
Electric power factor; which is the ratio of active power to apparent power in an AC electric power system. Measured with values in the range of -1.0 to 1.0 or 0.0 to 1.0 without a unit. When the range of -1.0 to 1.0 is applied, a negative value for power factor indicates the electrical current leads the electrical voltage and a positive value indicates the electrical current lags the electrical voltage.
meta
| def | pf |
| is | quantity |
| lib | lib:phIoT |
| prefUnit | pf |
| quantityOf | ac-elec |
| wikipedia | https://en.wikipedia.org/wiki/Power_factor |
supertypes
| marker | Marker labels a dict with typing information |
| quantity | Measurable property of a substance or phenomenon |
def
pfDisplacement
Displacement power factor, which accounts for the phase angle between voltage and current but excludes effects of nonlinear waveforms ( harmonic distortion).
meta
| def | pfDisplacement |
| is | pfScope |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| pfScope | Power factor scope |
def
pfDistortion
Distortion power factor, which measures the component of power factor attributable to harmonic distortion in voltage and current waveforms.
meta
| def | pfDistortion |
| is | pfScope |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
| wikipedia | https://en.wikipedia.org/wiki/Power_factor#Distortion_power_factor |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| pfScope | Power factor scope |
def
pfIec
Power factor according to the IEC convention defines a positive or negative sign based on the direction of active power flow. Power factor is positive when active power flows into a load. Power factor is negative when active power flows out of a load.
meta
| def | pfIec |
| is | pfStandard |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| pfStandard | Standard for interpreting power factor's positive or negative sign |
def
pfIeee
Power factor according to the IEEE convention defines a positive or negative sign based on whether the load is capacitive or inductive. Power factor is positive when the load is capacitive, or when voltage lags behind current. Power factor is negative when the load is inductive, or when current lags behind voltage.
meta
| def | pfIeee |
| is | pfStandard |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| pfStandard | Standard for interpreting power factor's positive or negative sign |
def
pfScope
Power factor scope
meta
| def | pfScope |
| is | choice |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
subtypes
| pfDisplacement | Displacement power factor, which accounts for the phase angle between voltage and current but excludes effects of nonlinear waveforms ( harmonic distortion) |
| pfDistortion | Distortion power factor, which measures the component of power factor attributable to harmonic distortion in voltage and current waveforms |
| pfTrue | True power factor, which includes effects of harmonic distortion |
def
pfStandard
Standard for interpreting power factor's positive or negative sign
meta
| def | pfStandard |
| is | choice |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
subtypes
| pfIec | Power factor according to the IEC convention defines a positive or negative sign based on the direction of active power flow |
| pfIeee | Power factor according to the IEEE convention defines a positive or negative sign based on whether the load is capacitive or inductive |
def
pfTrue
True power factor, which includes effects of harmonic distortion. Power factor is assumed to be true power factor when pfScope is not defined. However, it is recommended to specify a scope for power factor to help avoid misinterpretation of data.
meta
| def | pfTrue |
| is | pfScope |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| pfScope | Power factor scope |
def
phase
Phase measurement in a three-phase electrical system. This tag is deprecated in favor of more precise tags:
lineVoltphaseVoltlineCurrentphaseCurrentlinePowerphasePowerlinePfphasePflineEnergyphaseEnergylineAvgphaseAvgneutralground
meta
| def | phase |
| enum | See below |
| is | str |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Three-phase_electric_power |
enum
| A | line-to-neutral measurement |
| B | line-to-neutral measurement |
| C | line-to-neutral measurement |
| AB | line-to-line measurement |
| BC | line-to-line measurement |
| CA | line-to-line measurement |
| N | neutral current |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
phaseAvg
Phase average of single-phase electrical quantity measurements in an AC electric power system.
When applied to a point entity that has the elec and volt tags, indicates the average of all available phaseVolt measurements.
When applied to a point entity that has the elec and current tags, indicates the average of all available phaseCurrent measurements.
When applied to a point entity that has the elec and power tags, indicates the average of all available phasePower measurements.
When applied to a point entity that has the elec and pf tags, indicates the average of all available phasePf measurements.
When applied to a point entity that has the elec and energy tags, indicates the average of all available phaseEnergy measurements.
meta
| def | phaseAvg |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
phaseCount
Number of phases for an AC electrical power system or connected equipment: single-phase, split-phase, two-phase, or three-phase.
meta
| def | phaseCount |
| is | choice |
| lib | lib:phIoT |
| tagOn | ac-elec-meter, motor |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
subtypes
| singlePhase | Single-phase AC electricity |
| splitPhase | Split-phase AC electricity |
| threePhase | Three-phase AC electricity |
| twoPhase | Two-phase AC electricity |
def
phaseCurrent
Single-phase current measured line-to-line in an AC electric power system. May also be referred to as a phase current measurement.
meta
| def | phaseCurrent |
| enum | See below |
| is | elecLineToLine |
| 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 |
| elecLineToLine | Single-phase electric quantity measured line-to-line in a multi-phase AC electric power system |
def
phaseEnergy
Single-phase energy measured line-to-neutral in an AC electric power system. Neutral might not be referenced, but implied.
meta
| def | phaseEnergy |
| enum | See below |
| is | elecLine |
| 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 |
| elecLine | Single-phase line measurement of an electric quantity in a multi-phase AC electric power system |
def
phasePf
Single-phase power factor measured line-to-neutral in an AC electric power system. Neutral might not be referenced, but implied.
meta
| def | phasePf |
| enum | See below |
| is | elecLine |
| 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 |
| elecLine | Single-phase line measurement of an electric quantity in a multi-phase AC electric power system |
def
phasePower
Single-phase power measured line-to-neutral in an AC electric power system. May also be referred to as a phase power measurement. Neutral might not be referenced, but implied.
meta
| def | phasePower |
| enum | See below |
| is | elecLine |
| 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 |
| elecLine | Single-phase line measurement of an electric quantity in a multi-phase AC electric power system |
def
phaseVolt
Single-phase voltage measured line-to-neutral in an AC electric power system. May also be referred to as a phase voltage measurement.
meta
| def | phaseVolt |
| enum | See below |
| is | elecLineToNeutral |
| 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 |
| elecLineToNeutral | Single-phase electric quantity measured line-to-neutral in a multi-phase AC electric power system |
def
pipe
Conduit used to convey a fluid
meta
| childrenFlatten | fluid, pipeSection, plantLoop |
| def | pipe |
| icon | EquipIcon |
| is | conduit |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Pipe_(fluid_conveyance) |
usage
| pipe 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 |
| 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 |
| pipeFluid | Type of fluid conveyed by piping |
| pipeSection | Equipment section of piping |
| plantLoop | Plant piping loop |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
def
pipeFluid
Type of fluid conveyed by piping
meta
| def | pipeFluid |
| is | choice |
| lib | lib:phIoT |
| of | fluid |
| tagOn | pipe, valve-actuator, pump-motor |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
def
pipeSection
Equipment section of piping
meta
| def | pipeSection |
| is | choice |
| lib | lib:phIoT |
| tagOn | pipe, valve-actuator, pump-motor |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
subtypes
| bypass | Pipe used to bypass an equipment |
| circ | Pipe used to circulate fluid through an equipment or system |
| entering | Pipe conveys fluid into an equipment |
| header | Pipe used as central connection or manifold for other piping runs |
| leaving | Pipe conveys fluid out of an equipment |
def
plant
Central plant used to generate a substance for a process. See Plants.
meta
| def | plant |
| icon | EquipIcon |
| is | equip |
| lib | lib:phIoT |
usage
| plant equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
subtypes
| 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 |
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
| enable cmd point | |
def
plantLoop
Plant piping loop: primary, secondary, or tertiary
meta
| def | plantLoop |
| is | choice |
| lib | lib:phIoT |
| tagOn | pipe |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
subtypes
| primaryLoop | Pipework which circulates closest to the energy source |
| secondaryLoop | Pipework which circulates closest to the building or end use |
| tertiaryLoop | Pipework which circulates within the building |
def
point
Data point such as a sensor or actuator. See Points chapter.
meta
| def | point |
| icon | PointIcon |
| is | entity |
| lib | lib:phIoT |
| mandatory | ✓ |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
subtypes
| calendar | Marker tag for a calendar entity |
| connPoint | Point associated with a connector for data synchronization with a remote system |
| arcbeamPoint | Point which synchronizes data via a arcbeam connector |
| ecobeePoint | Point which synchronizes data via an Ecobee connector |
| haystackPoint | Point which synchronizes data via a Haystack connector |
| modbusPoint | Point which synchronizes data via a Haystack connector |
| mqttPoint | Point which synchronizes data via a MQTT connector |
| nestPoint | Point which synchronizes data via a Nest connector |
| obixPoint | Point which synchronizes data via a oBIX connector |
| opcPoint | Point which synchronizes data via an OPC connector |
| sedonaPoint | Point which synchronizes data via a Sedona connector |
| snmpPoint | Point which synchronizes data via an SNMP connector |
| sqlPoint | Point which synchronizes data via a SQL connector |
| tplTrendPoint | Point which synchronizes data via the TplTrend connector |
| cur-point | Point with support to report a "real-time" current value |
| his-point | Historized point with a history log of timestamp/value pairs |
| tariffHis | Identifies the tariff history point for a meter |
| schedule | Marker tag for a schedule entity |
| synthetic-point | See Synthetics chapter |
| computed-point | See Synthetics chapter |
| ml-point | See Synthetics chapter |
| sim-point | See Synthetics chapter |
| weather-point | Weather station observation point |
| writable-point | Point with writable output using 16-level priority array |
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 |
| 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
pointFunction
Classifies the point as a sensor, command, or setpoint. See Points chapter.
meta
| def | pointFunction |
| is | choice |
| lib | lib:phIoT |
| tagOn | point |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
subtypes
| cmd | Point is a command, actuator, AO/BO |
| sensor | Point is a sensor, input, AI/BI |
| sp | Point is a setpoint, soft point, internal control variable, schedule |
| synthetic | Synthetic point with computed operational data |
| computed | Computed point |
| ml | Machine learning point |
| sim | Simulation point |
def
pointGroup
Grouping of children points used by spaces and equipment
meta
| def | pointGroup |
| is | entity |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
subtypes
| airQualityZonePoints | Entity with logical grouping of zone air quality points |
| hvac-zone-space | Zone related to conditioning of a space's air temperature and quality |
| hvacZonePoints | Entity with logical grouping of zone HVAC air points |
| hvac-zone-space | Zone related to conditioning of a space's air temperature and quality |
| thermostat | Senses and controls temperature of space in HVAC system |
| lightingZonePoints | Entity with logical grouping of lighting points |
| lighting-zone-space | Zone related to lighting system |
| luminaire | Light fixture using electricity to provide illumination |
tags
| dis | Display name for an entity |
| id | Defines the unique identifier of an entity in system using a ref value type |
def
pointQuantity
Quantity the point senses or controls
meta
| def | pointQuantity |
| is | choice |
| lib | lib:phIoT |
| of | quantity |
| tagOn | point |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
def
pointRef
See Synthetics chapter.
meta
| def | pointRef |
| is | ref |
| lib | lib:phIoT |
| of | point |
| tagOn | sim-point |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
pointSubject
What the point senses or controls
meta
| def | pointSubject |
| is | choice |
| lib | lib:phIoT |
| of | phenomenon |
| tagOn | point |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
def
port
A gateway or opening used to transfer a substance.
meta
| def | port |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
powerConverter
Converts one electrical waveform to another using power electronic circuitry. Involves the use of one or more power modules.
May convert:
actodcactoacdctodcdctoac
Note: An AC/AC power converter performs the same task as a power transformer but using power electronics. Similarly, a DC/DC power converter transforms an input DC voltage to an output DC voltage at another level.
meta
| def | powerConverter |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
pressureDependent
VAV damper modulates to control space temp; dependent on duct pressure being maintained
meta
| def | pressureDependent |
| is | vavModulation |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| vavModulation | How does VAV modulate the temp based on duct pressure |
def
pressureIndependent
VAV damper or a control valve that modulates to maintain desired flow setpoint; independent of the duct pressure
meta
| def | pressureIndependent |
| is | vavModulation |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| vavModulation | How does VAV modulate the temp based on duct pressure |
def
primaryFunction
Primary function of building as US Energy Star key
meta
| def | primaryFunction |
| enum | See below |
| is | str |
| lib | lib:phIoT |
| tagOn | site |
enum
| Adult Education | |
| Ambulatory Surgical Center | |
| Aquarium | |
| Automobile Dealership | |
| Bank Branch | |
| Bar/Nightclub | |
| Barracks | |
| Bowling Alley | |
| Casino | |
| College/University | |
| Convenience Store with Gas Station | |
| Convenience Store without Gas Station | |
| Convention Center | |
| Courthouse | |
| Data Center | |
| Distribution Center | |
| Drinking Water Treatment & Distribution | |
| Enclosed Mall | |
| Energy/Power Station | |
| Fast Food Restaurant | |
| Financial Office | |
| Fire Station | |
| Fitness Center/Health Club/Gym | |
| Food Sales | |
| Food Service | |
| Hospital (General Medical & Surgical) | |
| Hotel | |
| Ice/Curling Rink | |
| Indoor Arena | |
| K-12 School | |
| Laboratory | |
| Library | |
| Lifestyle Center | |
| Mailing Center/Post Office | |
| Manufacturing/Industrial Plant | |
| Medical Office | |
| Mixed Use Property | |
| Movie Theater | |
| Multifamily Housing | |
| Museum | |
| Non-Refrigerated Warehouse | |
| Office | |
| Other - Education | |
| Other - Entertainment/Public Assembly | |
| Other - Lodging/Residential | |
| Other - Mall | |
| Other - Public Services | |
| Other - Recreation | |
| Other - Restaurant/Bar | |
| Other - Services | |
| Other - Stadium | |
| Other - Technology/Science | |
| Other - Utility | |
| Other | |
| Other/Specialty Hospital | |
| Outpatient Rehabilitation/Physical Therapy | |
| Parking | |
| Performing Arts | |
| Personal Services (Health/Beauty, Dry Cleaning, etc) | |
| Police Station | |
| Pre-school/Daycare | |
| Prison/Incarceration | |
| Race Track | |
| Refrigerated Warehouse | |
| Repair Services (Vehicle, Shoe, Locksmith, etc) | |
| Residence Hall/Dormitory | |
| Restaurant | |
| Retail Store | |
| Roller Rink | |
| Self-Storage Facility | |
| Senior Care Community | |
| Single Family Home | |
| Social/Meeting Hall | |
| Stadium (Closed) | |
| Stadium (Open) | |
| Strip Mall | |
| Supermarket/Grocery Store | |
| Swimming Pool | |
| Transportation Terminal/Station | |
| Urgent Care/Clinic/Other Outpatient | |
| Veterinary Office | |
| Vocational School | |
| Wastewater Treatment Plant | |
| Wholesale Club/Supercenter | |
| Worship Facility | |
| Zoo |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
primaryLoop
Pipework which circulates closest to the energy source. In a central plant, the primary loop indicates the pipes and equipment within the central plant. In context of heat exchangers between the primary and secondary loops, this tag indicates the side closest to the plant.
meta
| def | primaryLoop |
| is | plantLoop |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| plantLoop | Plant piping loop |
def
process
Industrial or HVAC process
meta
| def | process |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
propane
By-product of natural gas processing and petroleum refining (C₃H₈)
meta
| def | propane |
| disKey | ghgExt::fuelSource.propane |
| ghgFuelSource | ✓ |
| is | gas |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Propane |
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 |
| gas | Substance with neither definite volume nor shape |
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
propaneHeating
Heating by the combustion of propane
meta
| def | propaneHeating |
| 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
pump-motor
Motor used with a pump to move fluid. See Motors chapter.
conjunct
| pump | Pump equipment or control point |
| motor | Equipment that converts electrical energy into mechanical energy |
meta
| childrenFlatten | fluid, pipeSection, pump |
| def | pump-motor |
| icon | EquipIcon |
| is | motor |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Pump |
usage
| pump 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 |
| 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 |
| pipeFluid | Type of fluid conveyed by piping |
| pipeSection | Equipment section of piping |
| 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
pump
Pump equipment or control point
meta
| def | pump |
| is | marker |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Pump |
supertypes
| marker | Marker labels a dict with typing information |
def
purge-water
Water expelled from a system to remove contaminants.
conjunct
| purge | Associated with a cleaning process to remove contaminants |
| water | Water in its liquid form |
meta
| def | purge-water |
| is | water |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Water |
usage
| purge 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
purge
Associated with a cleaning process to remove contaminants. Most commonly it indicates purging water or air by using a filter or by letting out a certain amount of the substance at a high flow rate.
meta
| def | purge |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
radiantEquip
HVAC equipment that conditions a space without forced air.
meta
| def | radiantEquip |
| icon | EquipIcon |
| is | equip |
| lib | lib:phIoT |
usage
| radiantEquip equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
subtypes
| 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 |
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
radiantFloor
Heats a space using pipes or cables embedded beneath floor.
meta
| def | radiantFloor |
| icon | EquipIcon |
| is | radiantEquip |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Underfloor_heating |
usage
| radiantFloor equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| radiantEquip | HVAC equipment that conditions a space without forced 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
| equip | |
| point | |
| point | |
def
radiator
Heats a space using exposed pipes or coils. Hot water and steam radiators are often cast iron and installed directly in the space or along the baseboard. Electric radiators are typically installed on the baseboard.
meta
| def | radiator |
| icon | EquipIcon |
| is | radiantEquip |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Radiator_(heating) |
usage
| radiator equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| radiantEquip | HVAC equipment that conditions a space without forced 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
| equip | |
| point | |
| point | |
def
rated
Data specified by a manufacturer or rating organization. Typically this information is from the equipment data plate or cut sheet. Also see design.
meta
| def | rated |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
reactive-energy
Reactive energy in an AC eletrical power system. Integral of reactive-power over time.
conjunct
| reactive | Relating to reactance |
| energy | Measure of ability to do work |
meta
| def | reactive-energy |
| is | quantity |
| lib | lib:phIoT |
| quantityOf | ac-elec |
usage
| reactive energy |
supertypes
| marker | Marker labels a dict with typing information |
| quantity | Measurable property of a substance or phenomenon |
def
reactive-power
Reactive power or imaginary power; represents energy that recirculates within an AC power system but does not contribute useful work.
conjunct
| reactive | Relating to reactance |
| power | Energy consumed per unit time |
meta
| def | reactive-power |
| is | quantity |
| lib | lib:phIoT |
| prefUnit | kVAR |
| quantityOf | ac-elec |
usage
| reactive power |
supertypes
| marker | Marker labels a dict with typing information |
| quantity | Measurable property of a substance or phenomenon |
def
reactive
Relating to reactance
meta
| def | reactive |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
reciprocal
Piston compressor driven by a crankshaft
meta
| def | reciprocal |
| is | marker |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Reciprocating_compressor |
supertypes
| marker | Marker labels a dict with typing information |
subtypes
| chiller-reciprocal | Piston compressor driven by a crankshaft |
def
refrig-input
Entity inputs refrigerant which flows from another entity
conjunct
| refrig | Fluid used in refrigeration and heat exchange |
| input | Entity inputs a substance which flows from another entity |
meta
| def | refrig-input |
| is | input |
| lib | lib:phIoT |
usage
| refrig input |
supertypes
| marker | Marker labels a dict with typing information |
| input | Entity inputs a substance which flows from another entity |
subtypes
| 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 |
tags
| refrigRef | Refrigerant flows from the referent to this entity |
def
refrig-output
Entity outputs refrigerant to other entities
conjunct
| refrig | Fluid used in refrigeration and heat exchange |
| output | Entity outputs a substance with flows to other entities |
meta
| def | refrig-output |
| is | output |
| lib | lib:phIoT |
usage
| refrig output |
supertypes
| marker | Marker labels a dict with typing information |
| output | Entity outputs a substance with flows to other entities |
subtypes
| vrf-outdoorUnit | Outdoor unit with one or more compressors in a VRF system |
| vrf-refrig-plant | Group of outdoor units in a VRF system |
def
refrig-system
Refrigerant distribution to fulfill all or parts of a refrigeration cycle.
conjunct
| refrig | Fluid used in refrigeration and heat exchange |
| system | Grouping of related equipment dedicated to a single application |
meta
| def | refrig-system |
| is | system |
| lib | lib:phIoT |
usage
| refrig 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
| vrf-system | Variable refigerant flow system |
| vrf-coolingOnly-system | Cooling only VRF system can only cool |
| vrf-heatPump-system | Heat pump VRF system can either heat, or cool, but not at the same time |
| vrf-heatRecovery-system | Heat recovery VRF system can operate cooling and heating by each indoor unit independently, at the same time |
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
refrig
Fluid used in refrigeration and heat exchange. Refrigerants typically alternate between liquid and gas state.
meta
| def | refrig |
| is | fluid |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Refrigerant |
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 |
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
refrigRef
Refrigerant flows from the referent to this entity
meta
| def | refrigRef |
| inputs | refrig |
| is | ref |
| lib | lib:phIoT |
| of | refrig-output |
| tagOn | refrig-input |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
reheat
Command point for reheating process
meta
| def | reheat |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
return
Duct returning air back to equipment
meta
| def | return |
| 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
roof-floor
The roof floor is the topmost level of a building. It is often where HVAC equipment is located such as rooftop AHUs.
conjunct
| roof | Envelope covering the top of a building |
| floor | Storey of a building |
meta
| def | roof-floor |
| is | floor |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Storey |
usage
| roof 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
roof
Envelope covering the top of a building
meta
| def | roof |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
room
Enclosed room of a building
meta
| def | room |
| is | space |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Room |
usage
| room 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 |
tags
| area | Area of a shape or floor space |
| 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 |
| spaceRef | Reference to space which contains this entity |
children
| space | |
| equip | |
| equip | |
| point | |
| point | |
def
rotaryScrew
Rotary screw compression
meta
| def | rotaryScrew |
| is | marker |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Rotary-screw_compressor |
supertypes
| marker | Marker labels a dict with typing information |
subtypes
| chiller-rotaryScrew | Rotary screw compression |
def
rtu
Roof Top Unit: A unitary AHU that is weatherized for outdoor use. See AHUs chapter.
meta
| def | rtu |
| icon | EquipIcon |
| is | ahu |
| lib | lib:phIoT |
| navTarget | equip |
| wikipedia | https://en.wikipedia.org/wiki/Air_handler |
usage
| rtu 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 |
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
run
Primary on/off point of an equip especially used with a vfd. Run is used with Bool points where true indicates on and false indicates off. When paired with cmd this is the commanded state of the equipment. When paired with sensor this is the actual status of the equip. If the equipment also defines an enable point then both must be commanded on in order to run the equipment.
meta
| def | run |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
secondaryLoop
Pipework which circulates closest to the building or end use. In a central plant, the secondary loop indicates the pipes and equipment between the central plant and the building. In context of heat exchangers between the primary and secondary loops, this tag indicates the side closest to the building.
meta
| def | secondaryLoop |
| is | plantLoop |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| plantLoop | Plant piping loop |
def
sensor
Point is a sensor, input, AI/BI. See Points chapter.
meta
| def | sensor |
| is | pointFunction |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| pointFunction | Classifies the point as a sensor, command, or setpoint |
def
series
Circuit with single path of flow
meta
| def | series |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
serviceFactor
Ratio of the maximum continuous output capacity at which a machine or system may operate without damage to the machine or system’s nominal output capacity.
meta
| def | serviceFactor |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
sim-point
See Synthetics chapter.
conjunct
| sim | Simulation point |
| point | Data point such as a sensor or actuator |
meta
| def | sim-point |
| is | synthetic-point |
| lib | lib:phIoT |
usage
| sim 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 |
| synthetic-point | See Synthetics chapter |
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 |
| 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 |
| pointRef | See Synthetics chapter |
| pointSubject | What the point senses or controls |
| simScenario | See Synthetics chapter |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| syntheticModelRef | See Synthetics chapter |
| systemRef | Reference to system |
| tz | Timezone identifier from standard timezone database |
| unit | Unit identifier from standard unit database |
| writable | Supports writing data |
def
sim
Simulation point. See Synthetics chapter.
meta
| def | sim |
| is | synthetic |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
usage
| sim synthetic |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| pointFunction | Classifies the point as a sensor, command, or setpoint |
| synthetic | Synthetic point with computed operational data |
def
simBaseline
See Synthetics chapter.
meta
| def | simBaseline |
| dis | Baseline |
| is | simScenario |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| simScenario | See Synthetics chapter |
def
simModel
See Synthetics chapter.
meta
| def | simModel |
| is | syntheticModel |
| lib | lib:phIoT |
usage
| simModel syntheticModel |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| syntheticModel | See Synthetics chapter |
tags
| dis | Display name for an entity |
| id | Defines the unique identifier of an entity in system using a ref value type |
def
simOperation
See Synthetics chapter.
meta
| def | simOperation |
| dis | Operation |
| is | simScenario |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| simScenario | See Synthetics chapter |
def
simOptimum
See Synthetics chapter.
meta
| def | simOptimum |
| dis | Optimum |
| is | simScenario |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| simScenario | See Synthetics chapter |
def
simScenario
See Synthetics chapter.
meta
| def | simScenario |
| is | choice |
| lib | lib:phIoT |
| tagOn | sim-point |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
subtypes
| simBaseline | See Synthetics chapter |
| simOperation | See Synthetics chapter |
| simOptimum | See Synthetics chapter |
def
singleDuct
One single duct
meta
| def | singleDuct |
| 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
singlePhase
Single-phase AC electricity. Power is provided by a single AC voltage source with a 2-wire connection.
meta
| def | singlePhase |
| is | phaseCount |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
| wikipedia | https://en.wikipedia.org/wiki/Single-phase_electric_power |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| phaseCount | Number of phases for an AC electrical power system or connected equipment |
def
site
Site is a geographic location of the built environment. Typically site maps to one building with its own unique street address. See Sites chapter.
meta
| def | site |
| icon | SiteIcon |
| is | entity, geoPlace |
| lib | lib:phIoT |
| mandatory | ✓ |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| geoPlace | Geographic place |
tags
| area | Area of a shape or floor space |
| dis | Display name for an entity |
| energyStarSite | Tag applied to a site record which marks a site as mapped into Portfolio Manager |
| geoAddr | Free form street address |
| geoCity | Geographic city or locality name |
| geoCoord | Geographic coordinate as C(latitude,longitude) |
| geoCountry | Geographic country as ISO 3166-1 two letter code |
| geoCounty | Geographic subdivision of US state |
| geoElevation | Elevation above sea-level of the location |
| geoPostalCode | Geographic postal code |
| geoState | State or province name |
| geoStreet | Geographic street address and name |
| id | Defines the unique identifier of an entity in system using a ref value type |
| primaryFunction | Primary function of building as US Energy Star key |
| tz | Timezone identifier from standard timezone database |
| weatherStationRef | Reference to weather station for to use this entity |
| yearBuilt | Original year of construction as four digit year such as 1980 |
children
| space | |
| equip | |
| equip | |
def
siteMeter
Main meter for the associated site
meta
| def | siteMeter |
| is | meterScope |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| meterScope | Classifies a meter as a main site meter or submeter |
def
siteRef
Reference to site which contains the entity
meta
| containedBy | site |
| def | siteRef |
| is | ref |
| lib | lib:phIoT |
| of | site |
| tagOn | system, space, equip, point |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
sp
Point is a setpoint, soft point, internal control variable, schedule. See Points chapter.
meta
| def | sp |
| is | pointFunction |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| pointFunction | Classifies the point as a sensor, command, or setpoint |
def
space
Space is a three-dimensional volume in the built environment. See Spaces chapter.
meta
| def | space |
| is | entity |
| lib | lib:phIoT |
| mandatory | ✓ |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
subtypes
| dataCenter | Space used to house computer and networking gear |
| floor | Storey of a building |
| ground-floor | Floor at ground level |
| roof-floor | The roof floor is the topmost level of a building |
| subterranean-floor | Floor below ground level |
| room | Enclosed room of a building |
| zone-space | Space associated with a specific system |
| hvac-zone-space | Zone related to conditioning of a space's air temperature and quality |
| lighting-zone-space | Zone related to lighting system |
tags
| area | Area of a shape or floor space |
| 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 |
| spaceRef | Reference to space which contains this entity |
children
| space | |
| equip | |
| equip | |
| point | |
| point | |
def
spaceRef
Reference to space which contains this entity
meta
| containedBy | space |
| def | spaceRef |
| is | ref |
| lib | lib:phIoT |
| of | space |
| tagOn | space, equip, point |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
splitPhase
Split-phase AC electricity. Power is provided by a single AC voltage source with a 3-wire connection, consisting of two hot wires (phases), separated from each other by a 180-degree phase angle, and one neutral wire. Despite having two labeled phases, split-phase AC electricity is not a true two-phase system.
meta
| def | splitPhase |
| is | phaseCount |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
| wikipedia | https://en.wikipedia.org/wiki/Split-phase_electric_power |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| phaseCount | Number of phases for an AC electrical power system or connected equipment |
def
stage
Stage number of staged equipment operation such as coil or pump. The first stage is 1, second stage 2, etc.
meta
| def | stage |
| is | int |
| lib | lib:phIoT |
| minVal | 1 |
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
standby
Readiness mode of a space
meta
| def | standby |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |