外观
lib-phIoT 库参考（第 4 部分）
原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793325351/FIN+5.3.1+lib-phIoT+part+4 中文整理基于 FIN 5.3.1
导读： 电池的充电状态（SoC）。使用0%到100%的百分比，其中0%表示没有电，100%表示充满电。
以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。
目录（导读）
概述（中译）
电池的充电状态（SoC）。使用0%到100%的百分比，其中0%表示没有电，100%表示充满电。
API 正文（英文）
supertypes
| marker | Marker labels a dict with typing information |
| quantity | Measurable property of a substance or phenomenon |
def
steam-boiler
Boiler which outputs steam
conjunct
| steam | Water in its gas form |
| boiler | Equipment to generate hot water or steam for heating |
meta
| def | steam-boiler |
| icon | EquipIcon |
| is | boiler, steam-output |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Boiler |
usage
| steam boiler equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| boiler | Equipment to generate hot water or steam for heating |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
| output | Entity outputs a substance with flows to other entities |
| steam-output | Entity outputs steam to other entities |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| heatingProcess | Processed used to heat a substance |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
def
steam-input
Entity inputs steam which flows from another entity
conjunct
| steam | Water in its gas form |
| input | Entity inputs a substance which flows from another entity |
meta
| def | steam-input |
| is | input |
| lib | lib:phIoT |
usage
| steam input |
supertypes
| marker | Marker labels a dict with typing information |
| input | Entity inputs a substance which flows from another entity |
subtypes
| steamHeating | Heating using energy of steam |
tags
| steamRef | Steam flows from the referent to this entity |
def
steam-output
Entity outputs steam to other entities
conjunct
| steam | Water in its gas form |
| output | Entity outputs a substance with flows to other entities |
meta
| def | steam-output |
| is | output |
| lib | lib:phIoT |
usage
| steam output |
supertypes
| marker | Marker labels a dict with typing information |
| output | Entity outputs a substance with flows to other entities |
subtypes
| steam-boiler | Boiler which outputs steam |
| steam-plant | Plant used to generate steam for heating |
def
steam-plant
Plant used to generate steam for heating. See Plants.
conjunct
| steam | Water in its gas form |
| plant | Central plant used to generate a substance for a process |
meta
| def | steam-plant |
| icon | EquipIcon |
| is | plant, steam-output |
| lib | lib:phIoT |
usage
| steam plant equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| plant | Central plant used to generate a substance for a process |
| output | Entity outputs a substance with flows to other entities |
| steam-output | Entity outputs steam to other entities |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
def
steam-system
System that circulates water in its vapor state for heating a space or process.
conjunct
| steam | Water in its gas form |
| system | Grouping of related equipment dedicated to a single application |
meta
| def | steam-system |
| is | water-system |
| lib | lib:phIoT |
usage
| steam system |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| system | Grouping of related equipment dedicated to a single application |
| water-system | System that supplies or collects potable or non-potable water in any state |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| systemRef | Reference to system |
children
| equip | |
| point | |
| point | |
def
steamHeating
Heating using energy of steam
meta
| def | steamHeating |
| is | heatingProcess, steam-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 |
| steam-input | Entity inputs steam which flows from another entity |
tags
| steamRef | Steam flows from the referent to this entity |
def
steamRef
Steam flows from the referent to this entity
meta
| def | steamRef |
| inputs | steam |
| is | ref |
| lib | lib:phIoT |
| of | steam-output |
| tagOn | steam-input |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
submeter
Submeters measure usage of a sub-system or equipment within a site
meta
| def | submeter |
| 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
submeterOf
Reference to parent meter which is immediately upstream of this meter
meta
| def | submeterOf |
| is | ref |
| lib | lib:phIoT |
| of | meter |
| tagOn | meter |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
subterranean-floor
Floor below ground level. Subterranean floors are also known as basements, lower levels, or cellars.
conjunct
| subterranean | Below the surface of the earth |
| floor | Storey of a building |
meta
| def | subterranean-floor |
| is | floor |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Storey |
usage
| subterranean 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
subterranean
Below the surface of the earth
meta
| def | subterranean |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
switch
Device for toggling state or routing data
meta
| def | switch |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
synthetic-point
See Synthetics chapter.
conjunct
| synthetic | Synthetic point with computed operational data |
| point | Data point such as a sensor or actuator |
meta
| def | synthetic-point |
| is | point |
| lib | lib:phIoT |
usage
| synthetic point |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| point | Data point such as a sensor or actuator |
subtypes
| computed-point | See Synthetics chapter |
| ml-point | See Synthetics chapter |
| sim-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
synthetic
Synthetic point with computed operational data. The computed data if classified as:
mlfor machine learningsimfor simulationcomputedas catch all for other computations
See Synthetics chapter.
meta
| def | synthetic |
| is | pointFunction |
| lib | lib:phIoT |
| mandatory | ✓ |
| tagOn | point |
| 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 |
subtypes
| computed | Computed point |
| ml | Machine learning point |
| sim | Simulation point |
def
syntheticModel
See Synthetics chapter.
meta
| def | syntheticModel |
| is | entity |
| lib | lib:phIoT |
| mandatory | ✓ |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
subtypes
| computedModel | See Synthetics chapter |
| mlModel | See Synthetics chapter |
| simModel | 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
syntheticModelRef
See Synthetics chapter.
meta
| def | syntheticModelRef |
| is | ref |
| lib | lib:phIoT |
| of | syntheticModel |
| tagOn | synthetic-point |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
system
Grouping of related equipment dedicated to a single application. See Systems chapter.
meta
| def | system |
| is | entity |
| lib | lib:phIoT |
| mandatory | ✓ |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
subtypes
| air-system | System for moving air to maintain indoor thermal comfort and/or air quality |
| air-conditioning-system | System for air treatment to control its temperature, humidity, cleanliness, and distribution to meet the requirements of a conditioned space |
| air-exhaust-system | System consisting of one or more fans that remove air from the building |
| air-ventilation-system | System that supplies or removes air by natural or mechanical means to or from any space in order to provide outdoor air to the space |
| elec-system | System that generates, converts, distributes, and/or stores electricity |
| evse-system | A system that supplies electricity to EVSE assembly equipment and its auxiliary loads |
| lighting-system | System designed to provide lighting |
| refrig-system | Refrigerant distribution to fulfill all or parts of a refrigeration cycle |
| 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 |
| water-system | System that supplies or collects potable or non-potable water in any state |
| chilled-water-system | System that circulates water in its liquid state below ambient temperature for cooling a space or process |
| condenser-water-system | System that circulates water in its liquid state for rejecting heat from a space or process |
| domestic-water-system | System that circulates potable water in its liquid state for purposes other than space conditioning and process requirements |
| domestic-cold-water-system | System that circulates potable cold water in its liquid state for purposes other than space cooling and process requirements |
| domestic-hot-water-system | System that circulates potable hot water in its liquid state for purposes other than space heating and process requirements |
| hot-water-system | System that circulates water in its liquid state for heating a space or process |
| steam-system | System that circulates water in its vapor state for heating a space or process |
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
systemRef
Reference to system
meta
| def | systemRef |
| is | ref |
| lib | lib:phIoT |
| of | system |
| tagOn | equip, point, system |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
tank
Tank used to store a substance for temporary holding
meta
| childrenFlatten | substance |
| def | tank |
| icon | EquipIcon |
| is | equip |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Storage_tank |
usage
| tank 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 |
| tankSubstance | Substance stored by a tank |
children
| level sensor point | |
| pressure sensor point | |
| pressure sensor point | |
| temp sensor point | |
| temp sensor point | |
def
tankSubstance
Substance stored by a tank
meta
| def | tankSubstance |
| is | choice |
| lib | lib:phIoT |
| of | substance |
| tagOn | tank |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
def
tertiaryLoop
Pipework which circulates within the building.
meta
| def | tertiaryLoop |
| 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
thd
Total harmonic distortion
meta
| def | thd |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
thermal
Related to energy of heat
meta
| def | thermal |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
thermostat
Senses and controls temperature of space in HVAC system. Thermostats may provide an interface for setpoint control.
meta
| def | thermostat |
| icon | EquipIcon |
| is | equip, hvacZonePoints |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Thermostat |
usage
| thermostat 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 |
| hvacZonePoints | Entity with logical grouping of zone HVAC air points |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
def
threePhase
Three-phase AC electricity. Power is provided by three AC voltage sources, each separated from the others by a 120-degree phase angle. May have a 4-wire connection with a neutral (Wye) or a 3-wire connection without a neutral (Delta).
meta
| def | threePhase |
| is | phaseCount |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
| wikipedia | https://en.wikipedia.org/wiki/Three-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
tripleDuct
Three ducts: hotDeck, coldDeck, or neutralDeck
meta
| def | tripleDuct |
| 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
twoPhase
Two-phase AC electricity. Power is provided by two AC voltage sources, separated from each other by a 90-degree phase angle. Two-phase systems are extremely rare in modern buildings; they have been replaced by modern threePhase systems.
meta
| def | twoPhase |
| is | phaseCount |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
| wikipedia | https://en.wikipedia.org/wiki/Two-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
unitVent
Unit Ventilator: An FCU that has direct access to outside air to provide the space with ventilation. See AHUs chapter.
meta
| def | unitVent |
| icon | EquipIcon |
| is | fcu |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Fan_coil_unit |
usage
| unitVent fcu equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| airHandlingEquip | HVAC equipment that conditions and delivers air via one or more fans |
| fcu | Fan Coil Unit |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
| output | Entity outputs a substance with flows to other entities |
| air-output | Entity outputs air to other entities |
tags
| ahuZoneDelivery | AHU delivery method of conditioned air to the zone |
| airVolumeAdjustability | Ability of air handling equip to adjust volume of air flow |
| coolingProcess | Processed used to cool a substance |
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| ductConfig | Ductwork configuration |
| ductDeck | Cold, hot, or neutral deck |
| elecRef | Electricity flows from the referent to this entity |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| heatingProcess | Processed used to heat a substance |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
def
unocc
Unoccupied mode of a space. See Zones chapter.
meta
| def | unocc |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
valve-actuator
Actuator to regulate the flow of fluid.
conjunct
| valve | Valve equipment or control point |
| actuator | Equipment to move or control a mechanism |
meta
| childrenFlatten | fluid, pipeSection |
| def | valve-actuator |
| icon | EquipIcon |
| is | actuator |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Valve |
usage
| valve actuator equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| actuator | Equipment to move or control a mechanism |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| 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 |
| 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 |
children
| valve cmd point | |
| valve sensor point | |
| valve sensor point | |
def
valve
Valve equipment or control point
meta
| def | valve |
| is | marker |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Valve |
supertypes
| marker | Marker labels a dict with typing information |
def
variableAirVolume
Delivers a variable volume of air flow. Most variable volume systems are powered by a VFD fan. However other techniques such as inlet vanes may be used in older systems.
meta
| def | variableAirVolume |
| is | airVolumeAdjustability |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| airVolumeAdjustability | Ability of air handling equip to adjust volume of air flow |
def
vav-parallel
VAV pulls air from outside the primary air flow
conjunct
| vav | Variable air volume terminal unit |
| parallel | Circuit with multiple paths of flow |
meta
| def | vav-parallel |
| is | vavAirCircuit |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
usage
| vav parallel |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| vavAirCircuit | How does the VAV pull in air |
def
vav-series
VAV pulls air from the primary air flow
conjunct
| vav | Variable air volume terminal unit |
| series | Circuit with single path of flow |
meta
| def | vav-series |
| is | vavAirCircuit |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
usage
| vav series |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| vavAirCircuit | How does the VAV pull in air |
def
vav
Variable air volume terminal unit. VAV systems use a constant air temperature with a variable air flow rate. See VAVs chapter.
meta
| def | vav |
| icon | EquipIcon |
| is | airTerminalUnit |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Variable_air_volume |
usage
| vav equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| airTerminalUnit | Equipment in air distribution systems which terminate at the space |
| input | Entity inputs a substance which flows from another entity |
| air-input | Entity inputs air 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
| airRef | Air flows from the referent to this entity |
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| ductConfig | Ductwork configuration |
| 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 |
| vavAirCircuit | How does the VAV pull in air |
| vavModulation | How does VAV modulate the temp based on duct pressure |
children
def
vavAirCircuit
How does the VAV pull in air
meta
| def | vavAirCircuit |
| is | choice |
| lib | lib:phIoT |
| tagOn | vav |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
subtypes
| vav-parallel | VAV pulls air from outside the primary air flow |
| vav-series | VAV pulls air from the primary air flow |
def
vavModulation
How does VAV modulate the temp based on duct pressure
meta
| def | vavModulation |
| is | choice |
| lib | lib:phIoT |
| tagOn | vav |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
subtypes
| pressureDependent | VAV damper modulates to control space temp |
| pressureIndependent | VAV damper or a control valve that modulates to maintain desired flow setpoint |
def
vavZone
AHU supplies air to VAV terminal units
meta
| def | vavZone |
| 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
ventilation
Duct to access fresh outside air only for ventilation, not economizing
meta
| def | ventilation |
| 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
verticalTransport
Equipment to move humans and materials
meta
| def | verticalTransport |
| icon | EquipIcon |
| is | equip |
| lib | lib:phIoT |
usage
| verticalTransport equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
subtypes
| elevator | Enclosure used to move people between floors |
| escalator | Moving staircase used to move people between floors |
| movingWalkway | Conveyor to move people across a horizontal or inclined plane |
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
vfd-freq
VFD frequency measured in "Hz".
conjunct
| vfd | Variable-frequency drive |
| freq | Occurrences per unit time |
meta
| def | vfd-freq |
| is | quantity |
| lib | lib:phIoT |
| prefUnit | Hz |
usage
| vfd freq |
supertypes
| marker | Marker labels a dict with typing information |
| quantity | Measurable property of a substance or phenomenon |
def
vfd-speed
VFD speed measured in "%"; 0% is off and 100% is the fastest speed.
conjunct
| vfd | Variable-frequency drive |
| speed | Distance per unit time |
meta
| def | vfd-speed |
| is | quantity |
| lib | lib:phIoT |
| prefUnit | % |
usage
| vfd speed |
supertypes
| marker | Marker labels a dict with typing information |
| quantity | Measurable property of a substance or phenomenon |
def
vfd
Variable-frequency drive. See Motors chapter.
meta
| def | vfd |
| is | marker |
| lib | lib:phIoT |
| tagOn | motor |
| wikipedia | https://en.wikipedia.org/wiki/Variable-frequency_drive |
supertypes
| marker | Marker labels a dict with typing information |
def
volt-angle
AC voltage phase angle
conjunct
| volt | Electrical potential difference or electromotive force |
| angle | Measurement of the relative difference in direction between two vectors or phasors |
meta
| def | volt-angle |
| is | quantity |
| lib | lib:phIoT |
| prefUnit | deg |
| quantityOf | ac-elec |
usage
| volt angle |
supertypes
| marker | Marker labels a dict with typing information |
| quantity | Measurable property of a substance or phenomenon |
def
volt-imbalance
AC voltage phase imbalance. Also referred to as voltage unbalance.
conjunct
| volt | Electrical potential difference or electromotive force |
| imbalance | Lacking balance |
meta
| def | volt-imbalance |
| is | quantity |
| lib | lib:phIoT |
| prefUnit | % |
| quantityOf | ac-elec |
usage
| volt imbalance |
supertypes
| marker | Marker labels a dict with typing information |
| quantity | Measurable property of a substance or phenomenon |
def
volt-magnitude
Root-mean-square (RMS) magnitude of AC electrical voltage
conjunct
| volt | Electrical potential difference or electromotive force |
| magnitude | Size or extent |
meta
| def | volt-magnitude |
| is | elec-volt |
| lib | lib:phIoT |
| prefUnit | A |
| quantityOf | ac-elec |
usage
| volt magnitude |
supertypes
| marker | Marker labels a dict with typing information |
| quantity | Measurable property of a substance or phenomenon |
| elec-volt | Electrical voltage, potential difference |
def
volt-thd
Total harmonic distortion (THD) of AC voltage
conjunct
| volt | Electrical potential difference or electromotive force |
| thd | Total harmonic distortion |
meta
| def | volt-thd |
| is | quantity |
| lib | lib:phIoT |
| prefUnit | % |
| quantityOf | ac-elec |
usage
| volt thd |
supertypes
| marker | Marker labels a dict with typing information |
| quantity | Measurable property of a substance or phenomenon |
def
vrf-coolingOnly-system
Cooling only VRF system can only cool; heating is not available. See VRF chapter.
conjunct
| vrf | Variable refigerant flow |
| coolingOnly | Equipment without heating |
| system | Grouping of related equipment dedicated to a single application |
meta
| def | vrf-coolingOnly-system |
| is | vrf-system |
| lib | lib:phIoT |
usage
| vrf coolingOnly 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 |
| refrig-system | Refrigerant distribution to fulfill all or parts of a refrigeration cycle |
| vrf-system | Variable refigerant flow system |
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
| vrf indoorUnit equip | |
| vrf outdoorUnit equip | |
| vrf outdoorUnit equip | |
| vrf refrig plant equip | |
| vrf refrig plant equip | |
def
vrf-equip
Equipment used in VRF systems. See VRF chapter.
conjunct
| vrf | Variable refigerant flow |
| equip | Equipment asset |
meta
| def | vrf-equip |
| is | equip |
| lib | lib:phIoT |
usage
| vrf equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
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 |
| vrf-outdoorUnit | Outdoor unit with one or more compressors 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
| equip | |
| point | |
| point | |
def
vrf-heatPump-system
Heat pump VRF system can either heat, or cool, but not at the same time. See VRF chapter.
conjunct
| vrf | Variable refigerant flow |
| heatPump | Equipment that employs a vapor compression cycle with a reversing valve to provide heating or cooling |
| system | Grouping of related equipment dedicated to a single application |
meta
| def | vrf-heatPump-system |
| is | vrf-system |
| lib | lib:phIoT |
usage
| vrf heatPump 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 |
| refrig-system | Refrigerant distribution to fulfill all or parts of a refrigeration cycle |
| vrf-system | Variable refigerant flow system |
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
| vrf indoorUnit equip | |
| vrf outdoorUnit equip | |
| vrf outdoorUnit equip | |
| vrf refrig plant equip | |
| vrf refrig plant equip | |
def
vrf-heatRecovery-system
Heat recovery VRF system can operate cooling and heating by each indoor unit independently, at the same time. Heat recovery VRF systems have branch selectors to control how much, and which (hot gas or subcooled liquid) refrigerant goes to each indoor unit. See VRF chapter.
conjunct
| vrf | Variable refigerant flow |
| heatRecovery | Transfer of heat from one substance to another to reduce energy consumption |
| system | Grouping of related equipment dedicated to a single application |
meta
| def | vrf-heatRecovery-system |
| is | vrf-system |
| lib | lib:phIoT |
usage
| vrf heatRecovery 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 |
| refrig-system | Refrigerant distribution to fulfill all or parts of a refrigeration cycle |
| vrf-system | Variable refigerant flow system |
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
| vrf branchSelector equip | |
| vrf indoorUnit equip | |
| vrf indoorUnit equip | |
| vrf outdoorUnit equip | |
| vrf outdoorUnit equip | |
| vrf refrig plant equip | |
| vrf refrig plant equip | |
def
vrf-indoorUnit-fcu
Indoor unit fan coil unit in a VRF system. This includes but is not limited to: ducted-type and non-ducted types such as wall-mount, floor-mount, ceiling-mount and cassettes. Indoor unit fan coils operate to satisfy a heating or cooling load in a zone based on a zone thermostat temperature set point.
conjunct
| vrf | Variable refigerant flow |
| indoorUnit | Operates inside the conditioned space |
| fcu | Fan Coil Unit |
meta
| def | vrf-indoorUnit-fcu |
| icon | fan |
| is | vrf-indoorUnit, fcu |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Fan_coil_unit |
usage
| vrf indoorUnit fcu equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| airHandlingEquip | HVAC equipment that conditions and delivers air via one or more fans |
| fcu | Fan Coil Unit |
| vrf-equip | Equipment used in VRF systems |
| vrf-indoorUnit | Indoor unit in a VRF system |
| input | Entity inputs a substance which flows from another entity |
| elec-input | Entity inputs electricity which flows from another entity |
| refrig-input | Entity inputs refrigerant 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 |
| refrigRef | Refrigerant flows from the referent to this entity |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
def
vrf-indoorUnit
Indoor unit in a VRF system. Indoor units operate to satisfy a heating or cooling load. See VRF chapter.
conjunct
| vrf | Variable refigerant flow |
| indoorUnit | Operates inside the conditioned space |
meta
| def | vrf-indoorUnit |
| is | vrf-equip, refrig-input |
| lib | lib:phIoT |
usage
| vrf indoorUnit equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| vrf-equip | Equipment used in VRF systems |
| input | Entity inputs a substance which flows from another entity |
| refrig-input | Entity inputs refrigerant which flows from another entity |
subtypes
| vrf-indoorUnit-fcu | Indoor unit fan coil unit 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 |
| refrigRef | Refrigerant flows from the referent to this entity |
| 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
vrf-outdoorUnit
Outdoor unit with one or more compressors in a VRF system. As each indoor unit sends a demand to the outdoor unit, outdoor unit delivers the amount of refrigerant needed to meet the individual requirements of each indoor unit. See VRF chapter.
conjunct
| vrf | Variable refigerant flow |
| outdoorUnit | operates outside the conditioned space |
meta
| def | vrf-outdoorUnit |
| is | vrf-equip, refrig-output |
| lib | lib:phIoT |
usage
| vrf outdoorUnit equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| vrf-equip | Equipment used in VRF systems |
| output | Entity outputs a substance with flows to other entities |
| refrig-output | Entity outputs refrigerant to other entities |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
| equip | |
| point | |
| point | |
def
vrf-refrig-plant
Group of outdoor units in a VRF system. See VRF.
conjunct
| vrf | Variable refigerant flow |
| refrig | Fluid used in refrigeration and heat exchange |
| plant | Central plant used to generate a substance for a process |
meta
| def | vrf-refrig-plant |
| is | plant, refrig-output |
| lib | lib:phIoT |
usage
| vrf refrig plant equip |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| equip | Equipment asset |
| plant | Central plant used to generate a substance for a process |
| output | Entity outputs a substance with flows to other entities |
| refrig-output | Entity outputs refrigerant to other entities |
tags
| dis | Display name for an entity |
| disMacro | Display name using macro syntax |
| equipRef | Reference to equip which contains this entity |
| ghgSourceRef | Ref to the emission source used to calculate Greenhouse Gas Emissions |
| id | Defines the unique identifier of an entity in system using a ref value type |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| siteRef | Reference to site which contains the entity |
| spaceRef | Reference to space which contains this entity |
| systemRef | Reference to system |
children
| enable cmd point | |
| vrf outdoorUnit equip | |
| vrf outdoorUnit equip | |
def
vrf-system
Variable refigerant flow system. The system contains the indoor units, outdoor units, and branch selectors. See VRF chapter.
conjunct
| vrf | Variable refigerant flow |
| system | Grouping of related equipment dedicated to a single application |
meta
| def | vrf-system |
| is | refrig-system |
| lib | lib:phIoT |
usage
| vrf 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 |
| refrig-system | Refrigerant distribution to fulfill all or parts of a refrigeration cycle |
subtypes
| 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
| vrf indoorUnit equip | |
| vrf outdoorUnit equip | |
| vrf outdoorUnit equip | |
| vrf refrig plant equip | |
| vrf refrig plant equip | |
def
vrf
Variable refigerant flow. See VRF chapter.
meta
| def | vrf |
| is | marker |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Variable_refrigerant_flow |
supertypes
| marker | Marker labels a dict with typing information |
def
warm-water
Relatively warm water without active heating
conjunct
| warm | Relatively warm in comparison to another substance, without being actively heated |
| water | Water in its liquid form |
meta
| def | warm-water |
| is | water |
| lib | lib:phIoT |
| wikipedia | https://en.wikipedia.org/wiki/Water |
usage
| warm 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
warm
Relatively warm in comparison to another substance, without being actively heated. The substance can be used as a source of energy for a heating process, for example a warm water well in an ates system.
meta
| def | warm |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |
def
water-system
System that supplies or collects potable or non-potable water in any state.
conjunct
| water | Water in its liquid form |
| system | Grouping of related equipment dedicated to a single application |
meta
| def | water-system |
| is | system |
| lib | lib:phIoT |
usage
| water system |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| system | Grouping of related equipment dedicated to a single application |
subtypes
| chilled-water-system | System that circulates water in its liquid state below ambient temperature for cooling a space or process |
| condenser-water-system | System that circulates water in its liquid state for rejecting heat from a space or process |
| domestic-water-system | System that circulates potable water in its liquid state for purposes other than space conditioning and process requirements |
| domestic-cold-water-system | System that circulates potable cold water in its liquid state for purposes other than space cooling and process requirements |
| domestic-hot-water-system | System that circulates potable hot water in its liquid state for purposes other than space heating and process requirements |
| hot-water-system | System that circulates water in its liquid state for heating a space or process |
| steam-system | System that circulates water in its vapor state for heating a space or process |
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
waterCooling
Cooling using transfer of heat to water which is not explicitly chilled
meta
| def | waterCooling |
| is | coolingProcess |
| lib | lib:phIoT |
| uiInput | ui::ChoiceInput |
| wikipedia | https://en.wikipedia.org/wiki/Water_cooling |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| coolingProcess | Processed used to cool a substance |
def
weather-point
Weather station observation point. See Weather chapter.
conjunct
| weather | Associated with atmospheric air or phenomenon |
| point | Data point such as a sensor or actuator |
meta
| def | weather-point |
| is | point |
| lib | lib:phIoT |
usage
| weather point |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| point | Data point such as a sensor or actuator |
tags
| cur | Supports current value |
| 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 |
| weatherStationRef | Reference to weather station for to use this entity |
| writable | Supports writing data |
def
weatherStation
Logical weather station and its measurement points. See Weather chapter.
meta
| def | weatherStation |
| icon | CloudOutlined |
| is | entity, geoPlace |
| lib | lib:phIoT |
| mandatory | ✓ |
| wikipedia | https://en.wikipedia.org/wiki/Weather_station |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| geoPlace | Geographic place |
tags
| dis | Display name for an entity |
| 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 |
| tz | Timezone identifier from standard timezone database |
| weatherAutoSyncForecast | Applied to a weatherStation to indicate that the weather forecast should be automatically synchronized using built-in weather subscription |
| weatherAutoSyncHis | Applied to a weatherStation to indicate that point histories should automatically be synchronized with built-in weather subscription |
| weatherSyncIds | Applied to a weatherStation to indicate which weather points to sync for that station |
children
def
weatherStationRef
Reference to weather station for to use this entity
meta
| def | weatherStationRef |
| is | ref |
| lib | lib:phIoT |
| of | weatherStation |
| tagOn | site, weather-point |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
well
A well is a source of groundwater and potentially thermal energy. When used within an ATES system, the well facilitates thermal energy exchange with the ground warm and cool water sources. In this case, a well can be either a closed system that transports water through pipes in the ground, or an open system that pumps up and returns ground water.
meta
| def | well |
| icon | EquipIcon |
| is | equip |
| lib | lib:phIoT |
usage
| well 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
def
wire
Cabling used to convey electricity or data
meta
| def | wire |
| icon | EquipIcon |
| is | conduit |
| lib | lib:phIoT |
usage
| wire 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 |
| 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
writable-point
Point with writable output using 16-level priority array. Writable points typically are a setpoint or actuator command. Haystack writable points are modeled on the BACnet 16-level priority array with a relinquish default which effectively acts as level 17.
The following levels have special behavior:
- Level 1: highest priority reserved for emergency overrides
- Level 8: manual override with ability to set timer to expire back to auto
- Default: implicitly acts as level 17 for relinquish default
The priority array provides for contention resolution when many different control applications may be vying for control of a given point. Low level applications like scheduling typically control levels 14, 15, or 16. Then users can override at level 8. But a higher levels like 2 to 7 can be used to trump a user override (for example a demand response energy routine that requires higher priority).
The actual value to write is resolved by starting at level 1 and working down to relinquish default to find the first non-null value. It is possible for all levels to be null, in which case the overall write output is null (which in turn may be auto/null to another system). Anytime a null value is written to a priority level, we say that level has been set to auto or released (this allows the next highest level to take command of the output).
Also see Points chapter.
conjunct
| writable | Supports writing data |
| point | Data point such as a sensor or actuator |
meta
| def | writable-point |
| is | point |
| lib | lib:phIoT |
usage
| writable point |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| point | Data point such as a sensor or actuator |
tags
| cur | Supports current value |
| 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 |
| scheduleRef | Associates a schedulable with its schedule |
| 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 |
| writeErr | Error description when writeStatus indicates error condition |
| writeLevel | Current priority level for writeVal as number between 1 and 17 |
| writeStatus | Current status of a writable point output |
| writeVal | Current desired value to write to output |
def
writable
Supports writing data
meta
| def | writable |
| is | marker |
| lib | lib:phIoT |
| tagOn | point |
supertypes
| marker | Marker labels a dict with typing information |
def
writeErr
Error description when writeStatus indicates error condition
meta
| def | writeErr |
| is | str |
| lib | lib:phIoT |
| tagOn | writable-point |
| transient | ✓ |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
writeLevel
Current priority level for writeVal as number between 1 and 17. The value 17 indicates the relinquish default value.
meta
| def | writeLevel |
| is | int |
| lib | lib:phIoT |
| maxVal | 17 |
| minVal | 1 |
| tagOn | alarmRoute, writable-point |
| transient | ✓ |
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
writeStatus
Current status of a writable point output
meta
| def | writeStatus |
| enum | See below |
| is | str |
| lib | lib:phIoT |
| tagOn | writable-point |
| transient | ✓ |
enum
| unbound | writable point is not bound to any output |
| ok | last write was successful |
| down | connectivity/networking problem - see writeErr |
| fault | configuration or hardware error - see writeErr |
| disabled | manual disable of the point or connector |
| unknown | we don't know anything (typically boot state) |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
writeVal
Current desired value to write to output. This is the current "winning" value of the priority array indicated by writeLevel. If this tag is missing then the winning value is null/auto.
meta
| def | writeVal |
| is | scalar |
| lib | lib:phIoT |
| tagOn | writable-point |
| transient | ✓ |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
def
yearBuilt
Original year of construction as four digit year such as 1980
meta
| def | yearBuilt |
| is | int |
| lib | lib:phIoT |
| tagOn | site |
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
zone-space
Space associated with a specific system. See Spaces and Zones chapters.
conjunct
| zone | Related to spaces from a system perspective |
| space | Space is a three-dimensional volume in the built environment |
meta
| def | zone-space |
| is | space |
| lib | lib:phIoT |
usage
| zone space |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| space | Space is a three-dimensional volume in the built environment |
subtypes
| 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
| occupancy sensor point | |
| occupied sensor point | |
| occupied sensor point | |
| occupied sp point | |
| occupied sp point | |
def
zone
Related to spaces from a system perspective
meta
| def | zone |
| is | marker |
| lib | lib:phIoT |
supertypes
| marker | Marker labels a dict with typing information |