Component models
A detailed specification of available component data models and their application.
Overview¶
Component data models are utilized to create virtual twins of building equipment. They are templates representing the correlation between data points and metadata of building equipment. To create such a virtual twin, a component data model gets added to a specific project, and data points and metadata get mapped to its pins (placeholders for data points) and attributes (placeholders for metadata).
This page offers specifications on the available component data models and available analytics functions for each component.
Alphanumeric IDs¶
Alphanumeric IDs are used to access component pins and attributes via the API. Each ID is unique and contains information about the pin/attribute and corresponding component. See component data models for more information on alphanumeric IDs of all pins, components, and attributes.
Categories of components¶
Components are grouped into the following categories by their respective functions in the building.
| Category ID | Name | Description |
|---|---|---|
VNT | Ventilation | Any component used for ventilation of the building. |
H | Heating | Any component used for heating the building. |
C | Cooling | Any component used for cooling the building. |
RA | Room automation | Any component used for the automation of the rooms. |
CVYS | Conveyor systems | Any component used for conveyance. |
ELS | Electrical systems | Any component that belongs to the electrical systems. |
MISC | Miscellaneous | Any component not assigned to other trades. |
Available component data models¶
- Air cooler
- Air handling unit
- Air heater
- Boiler
- Building
- Charging station
- Cold meter
- Combined heat and power
- Compression chiller
- Cooling circuit
- Electricity meter
- Elevator
- Fan
- Filter
- Gas meter
- Heat meter
- Heat pump
- Heat transfer unit
- Heating circuit
- Humidifier
- Humidity conditioner
- Hybrid circuit
- Lighting system
- Recooling plant
- Room
- System
- Thermal control loop
- Thermal energy storage
- Waste meter
- Water meter
- Weather station
Application notes¶
Hints for a smooth application of component data models and their mapping.
- 1-to-n mapping: One datapoint can be mapped to several instantiated components to allow data models of different granularity.
- Unit sensitivity: Algorithms are unit sensitive. Every pin and attribute is specified with a unit. Please select the right unit when entering attributes and check the set unit for datapoints.
If unit conventions are disregarded, this can lead to errors and even misleading results of algorithms.
- Incomplete mapping: Pins and attributes, are placeholders which might or might not be mapped to data. Algorithms will work on incomplete mapped components, they require mapping for specific placeholders though. Check the algorithm documentation for the required mappings.
Component data models¶
The individual component data models are described below.
Air cooler¶
Category: Ventilation
The Air cooler component represents generic air coolers that use water as the cooling medium. The alphanumeric ID for the component is C_CM.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
C_CM+C_CRC+EN_C | Cooling energy - water side | Measured cooling energy of the cooling circuit | energy |
C_CM+C_CRC+POW_C | Cooling power - water side | Measured cooling power of the cooling circuit | power |
C_CM+C_CRC+PU+CTRL | Pump - operation control signal | Value representing the pump control signal or pump speed | frequency |
C_CM+C_CRC+PU+MSG_OPR | Pump - operating message | Operational state of the air cooler pump: 1 = operating, 0 = switched-off | dimensionless-quantities |
C_CM+C_CRC+T_IN | Supply temperature - water side | Temperature of the fluid entering the cooling circuit of the air cooler | temperature |
C_CM+C_CRC+T_OUT | Return temperature - water side | Temperature of the fluid exiting the cooling circuit of the air cooler | temperature |
C_CM+C_CRC+VAL_POS | Valve position | Actual position of air cooler valve opening: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
C_CM+C_CRC+VAL_POS_SP | Valve control signal | Control signal of the air cooler valve: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
C_CM+C_CRC+VF | Volume flow - water side | Volume flow of heat carrier fluid (water) | volumetric-flow-rate |
C_CM+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm, 0 = no alarm | dimensionless-quantities |
C_CM+MSG_OPR | Operating message | Informs about operational state of air cooler: 1 = operating, 0 = switched-off | dimensionless-quantities |
C_CM+T_AIR_IN | Inlet air temperature | Temperature of the air entering the air cooler | temperature |
C_CM+T_AIR_ODA | Outside air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | temperature |
C_CM+T_AIR_OUT | Outlet air temperature | Temperature of the air exiting the air cooler | temperature |
C_CM+T_AIR_OUT_SP | Outlet air temperature setpoint | Temperature setpoint of the air exiting the air cooler | temperature |
C_CM+VF_AIR | Volume flow - ventilation side | Volume flow through the ventilation duct | volumetric-flow-rate |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
C_CM+CUS_DAY_SHD | Custom day schedules | Overwrites basic schedule for specific days with an individual schedule. The JSON is flexibly expandable for any number of days. | json | None | generic |
C_CM+CUS_HOLI | Custom holiday | On a holiday, plant operation is considered as unintentional. Adds custom holidays to the schedule. | json | None | generic |
C_CM+C_CRC+C_T_RET_DSG | Design return temperature | Return temperature that was used to design the energy system at maximum load. | float | 16.0 | degrees-celsius |
C_CM+C_CRC+C_T_SPR_MIN_DSG | Minimal temperature spread | Minimal expected temperature spread for the water side. | float | 2.0 | delta-degrees-celsius |
C_CM+C_CRC+C_T_SUP_DSG | Design supply temperature | Supply temperature that was used to design the energy system at maximum load. | float | 10.0 | degrees-celsius |
C_CM+LINK | Link | Hyperlink to external resources | link | None | generic |
C_CM+NOM_POW | Nominal cooling power | Nominal cooling power of the air cooler | float | None | kilowatts |
C_CM+NOM_VF | Nominal volume flow - water side | Water volume flow at design conditions. | float | None | cubic-meters-per-hour |
C_CM+NOM_VF_AIR | Nominal volume flow - ventilation side | Air volume flow at design conditions. | float | None | cubic-meters-per-hour |
C_CM+PRECON | Pre-conditioning period | Adds a preconditioning period to the start time of the schedule. Operation before the start time is therefore evaluated as intended within the additional preconditioning time. | float | 0 | hours |
C_CM+REG_KEY | Regional holiday key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE | generic |
C_CM+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | json | None | generic |
C_CM+SHDO_FLX | Shutdown flexibility | Adds a shutdown flexibility to the end time of the schedule. Operation before the schedule end time is therefore evaluated as unintended during the shutdown flexibility. | float | 0 | hours |
C_CM+SHD_TIMZ | Schedule timezone | Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | generic |
C_CM+T_AIR_OUT_SP_DEV_TOL | Outlet air temperature setpoint deviation tolerance | Tolerance for deviation of actual outlet air temperature from setpoint | float | 1.5 | delta-degrees-celsius |
C_CM+VAL_POS_SP_DEV_TOL | Valve position setpoint deviation tolerance | Tolerance for deviation of the valve position from the air cooler valve control signal | float | 10.0 | percent |
C_CM+VAL_THR | Valve threshold | For specific analysis functions it's important to know above what valve position the feeding pump should start to operate. | float | 5 | percent |
C_CM+VAL_TYP | Valve type | For specific analysis functions it's important to know what kind of valve is used to regulate the outlet temperature. If required you can choose between a 2-way valve and a 3-way valve with this attribute. | enum | 2-way-valve | generic |
Air handling unit¶
Category: Ventilation
The Air Handling Unit component model represents typical units from ventilation systems to full air conditioning including heat recovery and recirculation. Compose the air handling unit to the needs of the specific project by mapping the regarding pins of this component model from supply fan, exhaust fan, heat recovery system, air heater, air cooler, air re-heater, supply humidifier, exhaust humidifier, and recirculation damper. The alphanumeric ID for the component is AHU.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
AHU+AED_CTRL_ACT | AI controls active | The operational state of an aedifion .controls app | dimensionless-quantities |
AHU+COM_SWI_MN | Main switching command | Value which describes the "on mode" of main switching command pin, especially for multi-state variables | dimensionless-quantities |
AHU+C_CM+C_CRC+PU+MSG_OPR | Air cooler - pump - operating message | Operational state of the air cooler pump: 1 = operating, 0 = switched-off | dimensionless-quantities |
AHU+C_CM+C_CRC+T_IN | Air cooler - water supply temperature | Supply temperature for the air cooler | temperature |
AHU+C_CM+C_CRC+T_OUT | Air cooler - water return temperature | Return temperature for the air cooler | temperature |
AHU+C_CM+C_CRC+VAL_POS | Air cooler - valve position | Actual position of air cooler valve opening: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
AHU+C_CM+C_CRC+VAL_POS_SP | Air cooler - valve control signal | Control signal of the air cooler valve: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
AHU+C_CM+MSG_OPR | Air cooler - operating message | Informs about operational state of air cooler: 1 = operating, 0 = switched-off | dimensionless-quantities |
AHU+C_CM+T_AIR_IN | Air cooler - Inlet air temperature | Temperature of the air entering the air cooler | temperature |
AHU+C_CM+T_AIR_OUT | Air cooler - Outlet air temperature | Temperature of the air exiting the air cooler | temperature |
AHU+DAMP_RCA+POS | Recirculation damper - position | Actual position of the recirculation damper: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
AHU+DAMP_RCA+POS_SP | Recirculation damper - control signal | Control signal of the recirculation damper position | dimensionless-quantities |
AHU+EHA_T_AIR | Exhaust air temperature | Temperature of the exhaust airflow | temperature |
AHU+EN_C | Total cooling energy | The aggregated thermal cooling energy consumed by the AHU | energy |
AHU+EN_EL_ACT | Total electrical energy | The aggregated electrical energy consumed by the AHU | energy |
AHU+EN_H | Total heating energy | The aggregated thermal heating energy consumed by the AHU | energy |
AHU+ETA_CO2 | Return air CO2 | CO2 concentration in the return airflow. | dimensionless-quantities |
AHU+ETA_CO2_SP | Return air CO2 setpoint | Setpoint for CO2 concentration in the return airflow. | dimensionless-quantities |
AHU+ETA_T_AIR_SP_MAX | Return air temperature setpoint maximum | Setpoint for the maximum temperature of the return airflow | temperature |
AHU+ETA_T_AIR_SP_MIN | Return air temperature setpoint minimum | Setpoint for the minimum temperature of the return airflow | temperature |
AHU+EXH_P_DIF | Return air duct pressure | Pressure difference between ambient pressure and pressure inside the return air duct | pressure |
AHU+EXH_P_DIF_SP | Return air duct pressure setpoint | Setpoint of the pressure difference between ambient pressure and pressure inside the return air duct | pressure |
AHU+EXH_T_AIR | Return air temperature | Temperature of the return airflow | temperature |
AHU+EXH_T_AIR_SP | Return air temperature setpoint | Return air temperature setpoint | temperature |
AHU+FAN.EXH+MSG_OPR | Return air fan - operating message | Informs about operational state of return air fan: 1 = operating, 0 = switched-off | dimensionless-quantities |
AHU+FAN.EXH+POW_EL | Return air fan - electrical power | Electrical power of the return air fan | power |
AHU+FAN.EXH+P_DIF | Return air fan - pressure | Pressure difference over the return air fan | pressure |
AHU+FAN.EXH+P_DIF_SP | Return air fan - pressure setpoint | Setpoint of the pressure difference over the return air fan | pressure |
AHU+FAN.EXH+SPE | Return air fan - speed | Current fan speed in relation to the nominal speed of the return air fan | dimensionless-quantities |
AHU+FAN.EXH+VF | Return air fan - volume flow | Volume flow through the return air duct, generated by the return air fan | volumetric-flow-rate |
AHU+FAN.SUP+MSG_OPR | Supply air fan - operating message | Informs about operational state of supply fan: 1 = operating, 0 = switched-off | dimensionless-quantities |
AHU+FAN.SUP+POW_EL | Supply air fan - electrical power | Electrical power of the supply fan | power |
AHU+FAN.SUP+P_DIF | Supply air fan - pressure | Pressure difference over the supply fan | pressure |
AHU+FAN.SUP+P_DIF_SP | Supply air fan - pressure setpoint | Setpoint of the pressure difference over the supply fan | pressure |
AHU+FAN.SUP+SPE | Supply air fan - speed | Current fan speed in relation to the nominal speed of the supply fan | dimensionless-quantities |
AHU+FAN.SUP+VF | Supply air fan - volume flow | Volume flow through the supply duct, generated by the supply fan | volumetric-flow-rate |
AHU+FIL+MSG_ALARM | Filter - alarm message | Boolean alarm message, critical alerts are preferred 1 = alarm, 0 = no alarm | dimensionless-quantities |
AHU+HRCS+MSG_OPR | Heat recovery system - operating message | Informs about operational state of heat recovery system: 1 = operating, 0 = switched-off | dimensionless-quantities |
AHU+HRCS+UTIL_LEV | Heat recovery system - position | Utilization level of the heat recovery system: 0 = not active, 100 = fully active | dimensionless-quantities |
AHU+HRCS+UTIL_LEV_SP | Heat recovery system - control signal | Control signal for the utilization level of the heat recovery system | dimensionless-quantities |
AHU+HUM.EXH+MSG_OPR | Return air humidifier - operating message | Informs about operational state of return air humidifier: 1 = operating, 0 = switched-off | dimensionless-quantities |
AHU+HUM.SUP+MSG_OPR | Supply humidifier - operating message | Informs about operational state of supply humidifier: 1 = operating, 0 = switched-off | dimensionless-quantities |
AHU+HUM_REL_AIR_ODA | Outside air relative humidity | Relative humidity of the inlet airflow. Typically the relative humidity of the outside air | dimensionless-quantities |
AHU+H_CM+H_CRC+PU+MSG_OPR | Air heater - pump - operating message | Operational state of the air heater pump: 1 = operating, 0 = switched-off | dimensionless-quantities |
AHU+H_CM+H_CRC+T_IN | Air heater - water supply temperature | Supply temperature for the air heater | temperature |
AHU+H_CM+H_CRC+T_OUT | Air heater - water return temperature | Return temperature for the air heater | temperature |
AHU+H_CM+H_CRC+T_OUT_MIN | Air heater - minimal water return temperature | Lower Limit for the return temperature for the air heater | temperature |
AHU+H_CM+H_CRC+VAL_POS | Air heater - valve position | Actual position of air heater valve opening: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
AHU+H_CM+H_CRC+VAL_POS_SP | Air heater - valve control signal | Control signal of the air heater valve: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
AHU+H_CM+MSG_OPR | Air heater - operating message | Informs about operational state of air heater: 1 = operating, 0 = switched-off | dimensionless-quantities |
AHU+H_CM.RE+H_CRC+PU+MSG_OPR | Air re-heater - pump - operating message | Operational state of the air re-heater pump: 1 = operating, 0 = switched-off | dimensionless-quantities |
AHU+H_CM.RE+H_CRC+T_IN | Air re-heater - water supply temperature | Supply temperature for the air re-heater | temperature |
AHU+H_CM.RE+H_CRC+T_OUT | Air re-heater - water return temperature | Return temperature for the air re-heater | temperature |
AHU+H_CM.RE+H_CRC+T_OUT_MIN | Air re-heater - minimal water return temperature | Lower Limit for the return temperature for the air re-heater | temperature |
AHU+H_CM.RE+H_CRC+VAL_POS | Air re-heater - valve position | Actual position of air re-heater valve opening: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
AHU+H_CM.RE+H_CRC+VAL_POS_SP | Air re-heater - valve control signal | Control signal of the air re-heater valve: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
AHU+H_CM.RE+MSG_OPR | Air re-heater - operating message | Informs about operational state of air re-heater: 1 = operating, 0 = switched-off | dimensionless-quantities |
AHU+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred: 1 = alarm, 0 = no alarm | dimensionless-quantities |
AHU+MSG_OPR | Operating message | Informs about operational state of air handling unit: 1 = operating, 0 = switched-off | dimensionless-quantities |
AHU+MSG_RELE | Release message | Informs if the component is released: 1 = released, 0 = not released | dimensionless-quantities |
AHU+MSG_REQ | Request message | Informs if the component is requested: 1 = requested, 0 = not requested | dimensionless-quantities |
AHU+OPR_MOD | Operation mode feedback | Operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
AHU+OPR_MOD_SW_AUTO | Operation mode automatic switch | Switch for the operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
AHU+POW_C | Total cooling power | The aggregated thermal cooling power used by the AHU | power |
AHU+POW_EL | Total electrical power | The aggregated electrical power used by the AHU | power |
AHU+POW_H | Total heating power | The aggregated thermal heating power used by the AHU | power |
AHU+SUP_HUM_REL_AIR | Supply air relative humidity | Relative humidity of the supply airflow | dimensionless-quantities |
AHU+SUP_P_DIF | Supply duct pressure | Pressure difference between ambient pressure and pressure inside the supply duct | pressure |
AHU+SUP_P_DIF_SP | Supply duct pressure setpoint | Setpoint of the pressure difference between ambient pressure and pressure inside the supply duct | pressure |
AHU+SUP_T_AIR | Supply air temperature | Temperature of supply air | temperature |
AHU+SUP_T_AIR_AF_HRCS | Heat recovery system - outlet supply air temperature | Air temperature in the supply duct downstream after the heat recovery system | temperature |
AHU+SUP_T_AIR_SP | Supply air temperature setpoint | Supply air temperature setpoint | temperature |
AHU+SUP_T_AIR_SP_MAX | Supply air temperature setpoint maximum | Upper limit of the supply air temperature setpoint | temperature |
AHU+SUP_T_AIR_SP_MIN | Supply air temperature setpoint minimum | Lower limit of the supply air temperature setpoint | temperature |
AHU+T_AIR_ODA | Outside air temperature (weather station) | Temperature of the outside air. Typically the temperature of a weather station. | temperature |
AHU+T_AIR_ODA_AHU | Outside air temperature (AHU) | Air temperature in the intake duct of the air handling unit | temperature |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
AHU+ARA.ETA_T_AIR_SP | ARA .controls App - Return air temperature setpoint | Return air temperature setpoint for the ARA .controls App | float | None | degrees-celsius |
AHU+CO2_EMIS_F_C | CO2 emission factor cold | CO2 emission factor for cold energy | float | 0.3 | kilograms-per-kilowatt-hours |
AHU+CO2_EMIS_F_EL | CO2 emission factor electricity | CO2 emission factor for electric energy | float | 0.56 | kilograms-per-kilowatt-hours |
AHU+CO2_EMIS_F_H | CO2 emission factor heat | CO2 emission factor for heat energy | float | 0.24 | kilograms-per-kilowatt-hours |
AHU+COM_SWI_MN_OFF | Main switching command - off | Value which describes the "off mode" of main switching command pin, especially for multi-state variables | float | None | generic |
AHU+COM_SWI_MN_ON | Main switching command - on | Value which describes the "on mode" of main switching command pin, especially for multi-state variables | float | None | generic |
AHU+CUS_DAY_SHD | Custom day schedules | Overwrites basic schedule for specific days with an individual schedule. The JSON is flexibly expandable for any number of days. | json | None | generic |
AHU+CUS_HOLI | Custom holiday | On a holiday, plant operation is considered as unintentional. Adds custom holidays to the schedule. | json | None | generic |
AHU+C_CM+CNCTN | Air cooler installed | Is an air cooler installed? (True/False). The automatic detection within the setpoint deviation analysis can be overwritten with this attribute. | boolean | None | generic |
AHU+C_CM+NOM_POW | Air cooler - nominal thermal power | Nominal cooling power of the air cooler | float | None | kilowatts |
AHU+C_CM+VAL_POS_SP_DEV_TOL | Air cooler - valve position setpoint deviation tolerance | Tolerance for deviation of the valve position from the air cooler valve control signal | float | 10.0 | percent |
AHU+DAMP_RCA+POS_SP_DEV_TOL | Recirculation damper - position setpoint deviation tolerance | Tolarance for the position of the recirculation damper | float | 10.0 | percent |
AHU+ETA_CO2_SP_DEV_TOL | Return air CO2 setpoint deviation tolerance | Tolerance for deviation of actual CO2 concentration in the return airflow from setpoint. | float | 0 | parts-per-million |
AHU+ETA_T_AIR_SP_MAX_AED | Return air temperature setpoint maximum | Upper limit of the return air temperature setpoint used for aedifion services | float | 25.0 | degrees-celsius |
AHU+ETA_T_AIR_SP_MIN_AED | Return air temperature setpoint minimum | Lower limit of the return air temperature setpoint used for aedifion services | float | 20.0 | degrees-celsius |
AHU+EXH_T_AIR_SP_DEV_TOL | Return air temperature setpoint deviation tolerance | Tolerance for deviation of actual return air temperature from setpoint | float | 1.5 | delta-degrees-celsius |
AHU+EXH_T_AIR_SU | Return air temperature summer case | Typical temperature of return air in summer | float | 24.0 | degrees-celsius |
AHU+EXH_T_AIR_WI | Return air temperature winter case | Typical temperature of return air in winter | float | 21.0 | degrees-celsius |
AHU+FAN.EXH+NOM_VF | Return air fan - nominal volume flow | Nominal volume flow of return air fan | float | None | cubic-meters-per-hour |
AHU+FAN.EXH+POW_NOM_CONSUM | Return air fan - nominal power | Nominal electrical power of the return air fan | float | None | kilowatts |
AHU+FAN.EXH+SPE_DFLT | Return air fan - Default speed | Default fan speed used when speed pin is not connected. Range: 0-100% | float | 90 | percent |
AHU+FAN.EXH+SPE_STD_THLD | Return air fan - fan speed standard deviation threshold | Overwrites the default standard deviation threshold for the yellow limit | float | 0.5 | percent |
AHU+FAN.EXH+SPFI_POW_FAN | Return air fan - specific fan power | Quantifies the energy-efficiency of return air fan | float | 2000.0 | watts-per-cubic-meter-per-second |
AHU+FAN.SUP+NOM_VF | Supply air fan - nominal volume flow | Nominal volume flow of supply fan | float | None | cubic-meters-per-hour |
AHU+FAN.SUP+POW_NOM_CONSUM | Supply air fan - nominal power | Nominal electrical power of the supply fan | float | None | kilowatts |
AHU+FAN.SUP+SPE_DFLT | Supply air fan - Default speed | Default fan speed used when speed pin is not connected. Range: 0-100% | float | 90 | percent |
AHU+FAN.SUP+SPE_STD_THLD | Supply air fan - fan speed standard deviation threshold | Overwrites the default standard deviation threshold for the yellow limit | float | 0.5 | percent |
AHU+FAN.SUP+SPFI_POW_FAN | Supply air fan - specific fan power | Quantifies the energy-efficiency of the supply fan | float | 2000.0 | watts-per-cubic-meter-per-second |
AHU+FAN.SUP+T_DIF | Supply air fan temperature increase | Estimated increase in temperature of the supply air due to the supply fan | float | None | delta-degrees-celsius |
AHU+HRCS+EF | Heat recovery system efficiency | Typical efficiency of the heat recovery system | float | 0.75 | generic |
AHU+HRCS+UTIL_LEV_SP_DEV_TOL | Heat recovery system - utilization level control signal deviation tolerance | Tolerance for deviation of the utilization level of the heat recovery system | float | 10.0 | percent |
AHU+HRCS_ACT_C | Heat recovery system active during cooling | "True", if the heat recovery system is active during cooling (Summer), "False" if it is not active during cooling. | boolean | False | generic |
AHU+HRCS_ACT_H | Heat recovery system active during heating | "True", if the heat recovery system is active during heating (Winter), "False" if it is not active during heating. | boolean | True | generic |
AHU+HRCS_LEA | Heat recovery system leakage | Overwrites the percentage of leakage between supply and exhaust air flows. Set according to the data sheet. | float | 0.0 | percent |
AHU+H_CM+NOM_POW | Air heater - nominal thermal power | Nominal heating power of the air heater | float | None | kilowatts |
AHU+H_CM+VAL_POS_SP_DEV_TOL | Air heater - valve position setpoint deviation tolerance | Tolerance for deviation of the valve position from the air heater valve control signal | float | 10.0 | percent |
AHU+H_CM.RE+VAL_POS_SP_DEV_TOL | Air re-heater - valve position setpoint deviation tolerance | Tolerance for deviation of the valve position from the air re-heater valve control signal | float | 10.0 | percent |
AHU+LINK | Link | Hyperlink to external resources | link | None | generic |
AHU+PRIC_EL | Electricity price | Price of electric energy | float | 0.25 | euro-per-kilowatt-hours |
AHU+PRIC_EN_C | Cold price | Price of cold energy | float | 0.1 | euro-per-kilowatt-hours |
AHU+PRIC_EN_H | Heat price | Price of heat energy | float | 0.14 | euro-per-kilowatt-hours |
AHU+P_DIF_SP_DEV_TOL | Pressure setpoint deviation tolerance | Tolarance for the pressure setpoints supply/return duct and Fan | float | 20.0 | pascals |
AHU+REFE_STOP | Reference period end | End of the reference period for estimating the saving potential by the HERO .controls App | string | None | generic |
AHU+REFE_STRT | Reference period start | Start of the reference period for estimating the saving potential by the HERO .controls App | string | None | generic |
AHU+REG_KEY | Regional holiday key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE | generic |
AHU+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | json | None | generic |
AHU+SHD_TIMZ | Schedule timezone | Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | generic |
AHU+SUP_T_AIR_SP_DEV_TOL | Supply air temperature setpoint deviation tolerance | Tolerance for deviation of actual supply air temperature from setpoint | float | 1.5 | delta-degrees-celsius |
AHU+SUP_T_AIR_SP_MAX | Supply air temperature setpoint maximum | Upper limit of the supply air temperature setpoint for aedifion services | float | 25.0 | degrees-celsius |
AHU+SUP_T_AIR_SP_MIN | Supply air temperature setpoint minimum | Lower limit of the supply air temperature setpoint for aedifion services | float | 17.0 | degrees-celsius |
AHU+SUP_T_AIR_SU | Supply temperature summer case | Typical temperature of supply air in summer | float | 24.0 | degrees-celsius |
AHU+SUP_T_AIR_WI | Supply temperature winter case | Typical temperature of supply air in winter | float | 21.0 | degrees-celsius |
AHU+T_EF_SIG_COLO_R | Temperature efficiency red limit | Overwrites the red limit for the temperature efficiency analysis. Adjust according to the data sheet. | float | 30.0 | percent |
AHU+T_EF_SIG_COLO_Y | Temperature efficiency yellow limit | Overwrites the yellow limit for the temperature efficiency analysis. Adjust according to the data sheet. | float | 70.0 | percent |
Air heater¶
Category: Ventilation
The Air heater component represents generic air heaters that use water as the heating medium. The alphanumeric ID for the component is H_CM.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
H_CM+H_CRC+EN_H | Heating energy - water side | Measured heating energy of the heating circuit | energy |
H_CM+H_CRC+POW_H | Heating power - water side | Measured heating power of the heating circuit | power |
H_CM+H_CRC+PU+CTRL | Pump - operation control signal | Value representing the pump control signal or pump speed | frequency |
H_CM+H_CRC+PU+MSG_OPR | Pump - operating message | Operational state of the pump: 1 = operating, 0 = switched-off | dimensionless-quantities |
H_CM+H_CRC+T_IN | Supply temperature - water side | Temperature of the fluid entering the heating circuit of the air heater | temperature |
H_CM+H_CRC+T_OUT | Return temperature - water side | Temperature of the fluid exiting the heating circuit of the air heater | temperature |
H_CM+H_CRC+VAL_POS | Valve position | Actual position of valve opening 0 = fully closed, 100 = fully opened | dimensionless-quantities |
H_CM+H_CRC+VAL_POS_SP | Valve control signal | Control signal of the valve 0 = fully closed, 100 = fully opened | dimensionless-quantities |
H_CM+H_CRC+VF | Volume flow - water side | Volume flow of heat carrier fluid (water) | volumetric-flow-rate |
H_CM+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred, 1 = alarm, 0 = no alarm | dimensionless-quantities |
H_CM+MSG_OPR | Operating message | Informs about operational state of air heater: 1 = operating, 0 = switched-off | dimensionless-quantities |
H_CM+T_AIR_IN | Inlet air temperature | Temperature of the air entering the air heater | temperature |
H_CM+T_AIR_ODA | Outside air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | temperature |
H_CM+T_AIR_OUT | Outlet air temperature | Temperature of the air exiting the air heater | temperature |
H_CM+T_AIR_OUT_SP | Outlet air temperature setpoint | Temperature setpoint of the air exiting the air heater | temperature |
H_CM+VF_AIR | Volume flow - ventilation side | Volume flow through the ventilation duct | volumetric-flow-rate |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
H_CM+CUS_DAY_SHD | Custom day schedules | Overwrites basic schedule for specific days with an individual schedule. The JSON is flexibly expandable for any number of days. | json | None | generic |
H_CM+CUS_HOLI | Custom holiday | On a holiday, plant operation is considered as unintentional. Adds custom holidays to the schedule. | json | None | generic |
H_CM+H_CRC+H_T_RET_DSG | Design return temperature | Return temperature that was used to design the energy system at maximum load. | float | 40.0 | degrees-celsius |
H_CM+H_CRC+H_T_SPR_MIN_DSG | Minimal temperature spread | Minimal expected temperature spread for the water side. | float | 5.0 | delta-degrees-celsius |
H_CM+H_CRC+H_T_SUP_DSG | Design supply temperature | Supply temperature that was used to design the energy system at maximum load. | float | 60.0 | degrees-celsius |
H_CM+LINK | Link | Hyperlink to external resources | link | None | generic |
H_CM+NOM_POW | Nominal cooling power | Nominal cooling power of the air cooler | float | None | kilowatts |
H_CM+NOM_VF | Nominal volume flow - water side | Water volume flow at design conditions. | float | None | cubic-meters-per-hour |
H_CM+NOM_VF_AIR | Nominal volume flow - ventilation side | Air volume flow at design conditions. | float | None | cubic-meters-per-hour |
H_CM+PRECON | Pre-conditioning period | Adds a preconditioning period to the start time of the schedule. Operation before the start time is therefore evaluated as intended within the additional preconditioning time. | float | 0 | hours |
H_CM+REG_KEY | Regional holiday key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE | generic |
H_CM+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | json | None | generic |
H_CM+SHDO_FLX | Shutdown flexibility | Adds a shutdown flexibility to the end time of the schedule. Operation before the schedule end time is therefore evaluated as unintended during the shutdown flexibility. | float | 0 | hours |
H_CM+SHD_TIMZ | Schedule timezone | Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | generic |
H_CM+T_AIR_OUT_SP_DEV_TOL | Outlet air temperature setpoint deviation tolerance | Tolerance for deviation of actual outlet air temperature from setpoint | float | 1.5 | delta-degrees-celsius |
H_CM+VAL_POS_SP_DEV_TOL | Valve position setpoint deviation tolerance | Tolerance for deviation of the valve position from the air cooler valve control signal | float | 10.0 | percent |
H_CM+VAL_THR | Valve threshold | For specific analysis functions it's important to know above what valve position the feeding pump should start to operate. | float | 5 | percent |
H_CM+VAL_TYP | Valve type | For specific analysis functions it's important to know what kind of valve is used to regulate the outlet temperature. If required you can choose between a 2-way valve and a 3-way valve with this attribute. | enum | 3-way-valve | generic |
Boiler¶
Category: Heating
The Boiler is the component model of the heat conversion plant boiler including subcategories of boilers like condensing boilers. The alphanumeric ID for the component is BOI.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
BOI+COM_SWI_MN | Main switching command | Value which describes the "on mode" of main switching command pin, especially for multi-state variables | dimensionless-quantities |
BOI+EN_H | Heating energy | Measured heating energy delivered by boiler to heating loop | energy |
BOI+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm, 0 = no alarm | dimensionless-quantities |
BOI+MSG_OPR | Operating message | Informs about operational state of boiler: 1 = operating, 0 = switched-off | dimensionless-quantities |
BOI+MSG_RELE | Release message | Informs if the component is released: 1 = released, 0 = not released | dimensionless-quantities |
BOI+MSG_REQ | Request message | Informs if the component is requested: 1 = requested, 0 = not requested | dimensionless-quantities |
BOI+OPR_MOD | Operation mode feedback | Operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
BOI+OPR_MOD_SW_AUTO | Operation mode automatic switch | Switch for the operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
BOI+POW_H | Heating power | Measured heating power delivered by boiler to heating loop | power |
BOI+PU+COM_SWI | Pump - switching command | Command to switch the pump on or off | dimensionless-quantities |
BOI+PU+CTRL | Pump - operation control signal | Value representing the pump control signal or pump speed | frequency |
BOI+PU+CTRL_FB | Pump - operation position feedback | Feedback of the pump control signal or pump speed | frequency |
BOI+PU+MSG_OPR | Pump - operating message | Operational state of the pump: 1 = operating, 0 = switched-off | dimensionless-quantities |
BOI+RATE_FUEL_CONSUM | Rate of fuel consumption | Measured fuel consumption of the device | power |
BOI+T_AIR_ODA | Outside air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | temperature |
BOI+T_AIR_ODA_OVR | Outside air temperature overwrite | Overwrite input for the outside air temperature | temperature |
BOI+T_IN | Return temperature | Temperature of heat carrier fluid (water) entering the component. | temperature |
BOI+T_OUT | Supply temperature | Temperature of heat carrier fluid (water) exiting the component. | temperature |
BOI+T_OUT_SP | Supply temperature setpoint | Setpoint temperature of heat carrier fluid (water) exiting the component. | temperature |
BOI+VF | Volume flow | Volume flow of heat carrier fluid (water) | volumetric-flow-rate |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
BOI+CC_BP | Heating curve - base points | Defines the base points for the piecewise linear heating curve, as values seperated by comma, pairs seperated by semicolon. | string | None | degrees-celsius |
BOI+COM_SWI_MN_OFF | Main switching command - off | Value which describes the "off mode" of main switching command pin, especially for multi-state variables | float | None | generic |
BOI+COM_SWI_MN_ON | Main switching command - on | Value which describes the "on mode" of main switching command pin, especially for multi-state variables | float | None | generic |
BOI+CUS_DAY_SHD | Custom day schedules | Overwrites basic schedule for specific days with an individual schedule. The JSON is flexibly expandable for any number of days. | json | None | generic |
BOI+CUS_HOLI | Custom holiday | On a holiday, plant operation is considered as unintentional. Adds custom holidays to the schedule. | json | None | generic |
BOI+EF | Efficiency | Averaged efficiencny of the energy conversion from fuel energy to thermal energy. The efficiency can be a manufacturer's information, based on own calculations or measurements or it could be a rough estimation of the efficiency. | float | 0.915 | generic |
BOI+H_NOM_PROD | Nominal heat production | Nominal heat production of the device. | float | None | kilowatt-hours |
BOI+H_T_RET_DSG | Design return temperature | Return temperature that was used to design the energy system at maximum load. | float | 50.0 | degrees-celsius |
BOI+H_T_SPR_MIN_DSG | Minimal temperature spread | Minimal expected temperature spread. | float | 5.0 | delta-degrees-celsius |
BOI+H_T_SUP_DSG | Design supply temperature | Supply temperature that was used to design the energy system at maximum load. | float | 70.0 | degrees-celsius |
BOI+LINK | Link | Hyperlink to external resources | link | None | generic |
BOI+NIG_REDU | Heating curve - night time reduction | The night reduction that will be applied to the calculated set point from the heating curve | float | 0 | degrees-celsius |
BOI+PRECON | Pre-conditioning period | Adds a preconditioning period to the start time of the schedule. Operation before the start time is therefore evaluated as intended within the additional preconditioning time. | float | 0 | hours |
BOI+PRIC_FUEL | Fuel price | Price of the used fuel. | float | 0.06 | euro-per-kilowatt-hours |
BOI+PRIC_STUP | Start-up costs | The power specific costs of one start-up. | float | 0.01 | euro-per-kilowatt |
BOI+REG_KEY | Regional holiday key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE | generic |
BOI+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | json | None | generic |
BOI+SHDO_FLX | Shutdown flexibility | Adds a shutdown flexibility to the end time of the schedule. Operation before the schedule end time is therefore evaluated as unintended during the shutdown flexibility. | float | 0 | hours |
BOI+SHD_TIMZ | Schedule timezone | Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | generic |
BOI+T_SP_DEV_TOL | Temperature setpoint deviation tolerance | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | degrees-celsius |
Building¶
Category: Miscellaneous
The Building is a component model for a complete project. It's the base for our asset and facility overviews, as well as the connected analysis functions. The alphanumeric ID for the component is B.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
B+AIR_COMP_MALFS | Compressed air fault indicator | None | dimensionless-quantities |
B+COUNT_PEO | Number of occupants | None | dimensionless-quantities |
B+CS_MALFS | Cold system fault indicator | None | dimensionless-quantities |
B+ELE_MALFS | Elevators fault indicator | None | dimensionless-quantities |
B+ELS+CST_EN_EL_CONSUM_SUM | Charging stations electricity consumption | None | energy |
B+ELS+CST_TIM_USA_SUM | Charging stations usage time | None | time |
B+ELS+DOOR_MN_MALFS | Main doors fault indicator | None | dimensionless-quantities |
B+ELS+ELE_AVAIL_MON | Elevators availability monthly | None | time |
B+ELS+ELE_AVAIL_YEA | Elevators availability yearly | None | time |
B+ELS+EN_EL_CONSUM_SUM | Electricity consumption | None | energy |
B+ELS+EN_EL_CONSUM_SUM_15m | Electricity consumption 15m | None | energy |
B+ELS+EN_EL_CONSUM_SUM_PRJ | Electricity consumption projection | None | energy |
B+ELS+EN_EL_GEN_SUM | Electricity generation | None | energy |
B+ELS+EN_EL_GEN_SUM_15m | Electricity generation 15m | None | energy |
B+ELS+EN_EL_GEN_SUM_PRJ | Electricity generation projection | None | energy |
B+ELS+EN_EL_PGR_FE_IN | Electrical grid feed-in | None | energy |
B+ELS+GPS_MALFS | Power supply fault indicator | None | dimensionless-quantities |
B+ELS+PV_CO2_EMI_AVD | Emission avoidance from photovoltaics | None | mass |
B+ELS+PV_EL_GEN_SUM | Photovoltaics electricity generation | None | energy |
B+ELS+PV_EL_GEN_SUM_15m | Photovoltaics electricity generation 15m | None | energy |
B+ELS+REM_EL_CONSUM | Electricity consumption loss / not measured | None | energy |
B+ELS+REM_EL_GEN | Electricity generation loss / not measured | None | energy |
B+ELS+SHA_MALFS | Shading system fault indicator | None | dimensionless-quantities |
B+ELS+SLIGS_MALFS | Safety lighting fault indicator | None | dimensionless-quantities |
B+ELS+TUS_MALFS | Turnstiles fault indicator | None | dimensionless-quantities |
B+EL_CO2_EMI | Electricity-related co2 emissions | None | mass |
B+EL_CO2_EMI_PRJ | Electricity-related co2 emissions projection | None | mass |
B+EN_H_CONSUM_SUM | Heat consumption | None | energy |
B+EN_H_CONSUM_SUM_15m | Heat consumption 15m | None | energy |
B+EN_H_CONSUM_SUM_PRJ | Heat consumption projection | None | energy |
B+FALS_MALFS | Fire alarm system fault indicator | None | dimensionless-quantities |
B+GALS_MALFS | Gas warning system fault indicator | None | dimensionless-quantities |
B+GATS_MALFS | Gate systems fault indicator | None | dimensionless-quantities |
B+HS+BOI_EN_H_GEN_FLH | Boilers full load hours | None | time |
B+HS+BOI_EN_H_GEN_SUM | Boilers heat generation | None | energy |
B+HS+CHP_CO2_EMI_AVD_SUM | Emission avoidance from chp | None | mass |
B+HS+CHP_EN_EL_GEN_FLH | Chp electricity full load hours | None | time |
B+HS+CHP_EN_EL_GEN_SUM | Chp electricity generation | None | energy |
B+HS+CHP_EN_H_GEN_FLH | Chp heat full load hours | None | time |
B+HS+CHP_EN_H_GEN_SUM | Chp heat generation | None | energy |
B+HS+EN_H_GEN_SUM | Thermal energy generation | None | energy |
B+HS+EN_H_GEN_SUM_15m | Thermal energy generation 15m | None | energy |
B+HS+EN_H_GEN_SUM_PRJ | Thermal energy generation projection | None | energy |
B+HS+HP_CO2_EMI_AVD_SUM | Emission avoidance from heat pump | None | mass |
B+HS+HP_EN_EL_CONSUM_SUM | Heat pump electricity consumption | None | energy |
B+HS+HP_EN_H_GEN_SUM | Heat pump heat generation | None | energy |
B+HS+REM_H_CONSUM | Heat consumption loss / not measured | None | energy |
B+HS+REM_H_GEN | Heat generation loss / not measured | None | energy |
B+HS+SOL_CO2_EMI_AVD | Emission avoidance from solar heat | None | mass |
B+HS+SOL_EN_EL_CONSUM_PU_SUM | Solar heat generation pump electricity consumption | None | energy |
B+HS+SOL_EN_H_GEN_SUM | Solar heat generation | None | energy |
B+HS+VOL_GAS_CONSUM | Total volume natural gas consumption | None | volume |
B+HS_MALFS | Heating system fault indicator | None | dimensionless-quantities |
B+H_CO2_EMI_SUM | Heat-related co2 emissions | None | mass |
B+H_CO2_EMI_SUM_PRJ | Heat-related co2 emissions projection | None | mass |
B+H_DISCT+EN_H_CONSUM | District heating heat consumption | None | energy |
B+H_DISCT+EN_H_CONSUM_15m | District heating heat consumption 15m | None | energy |
B+T_AIR_ODA | Outside air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | temperature |
B+VEH_PRKG+COUNT_CAR | Number of cars | None | dimensionless-quantities |
B+VENS_MALFS | Ventilation systems fault indicator | None | dimensionless-quantities |
B+WAS+RAIN_WS_CONSUM | Rain water consumption | None | volume |
B+WAS+RAIN_WS_CONSUM_PRJ | Rain water consumption projection | None | volume |
B+WAS+WS_FRESH_CONSUM | Fresh water consumption | None | volume |
B+WAS+WS_FRESH_CONSUM_PRJ | Fresh water consumption projection | None | volume |
B+WAS+WS_GRAY_CONSUM | Gray water consumption | None | volume |
B+WAS+WS_GRAY_CONSUM_PRJ | Gray water consumption projection | None | volume |
B+WAS+WS_LEV_MALFS | Water level detector fault indicator | None | dimensionless-quantities |
B+WAS+WS_PBS_MALFS | Pressure boosting system fault indicator | None | dimensionless-quantities |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
B+AHU | Air handling units | Information regarding the air handling units. | string | None | generic |
B+AR_TYP | Area type | Specifies the type of the calculation area. Gross External Area is the area of a building measured externally at each floor level. Gross Internal Area is the area of a building measured to the internal face of the perimeter walls. Net Internal Area is the usable area within a building measured to the internal face of the perimeter walls. The Rentable Area is the area allocated to a tenant. | enum | gross-external-area | generic |
B+ASSET_MANAGER | Asset manager | Name of the asset manager. | string | None | generic |
B+ASSET_OWNER | Asset owner | Name of the asset owner. | string | None | generic |
B+BA_BRAND | Building automation brand | Name of the building automation brand. | string | None | generic |
B+BA_CNSTR | Building automation constructor | Name of the building automation constructor. | string | None | generic |
B+BA_PROT | Building automation protocol | Name of the building automation protocol. | string | None | generic |
B+BMS_BRAND | Building management system brand | Name of the building management system brand. | string | None | generic |
B+BUILD_YEAR | Year of construction | Year of building construction. | float | None | generic |
B+CC | Heating or cooling curve | Indicator there is a properly set heating or cooling curve in this buiding | enum | automatic | generic |
B+CERTS | Building certifications | Please use specific building certificate attributes, e.g., "LEED" instead. | json | None | generic |
B+CERTS_BREEAM | BREEAM | BREEAM certification. | string | None | generic |
B+CERTS_DGNB | DGNB | DGNB certification. | string | None | generic |
B+CERTS_ECORE | Ecore | Ecore certification which is evaluated on a scale of 1 to 100. | float | None | generic |
B+CERTS_ESTAR | EnergyStar | EnergyStar certification which is evaluated on a scale of 1 to 100. | float | None | generic |
B+CERTS_GRESB | GRESB | GRESB certification which is evaluated on a scale of 1 to 100. | float | None | generic |
B+CERTS_LEED | LEED | LEED certification. | string | None | generic |
B+CERTS_WSCORE | WiredScore | WiredScore certification. | string | None | generic |
B+CO2E+SIG_COLO_R | CO2 emissions limit red | Overwrites the red limit for the CO2 emissions KPI for this building. | float | 8.5 | kilograms-per-square-meter-per-month |
B+CO2E+SIG_COLO_Y | CO2 emissions limit yellow | Overwrites the yellow limit of the CO2 emissions KPI for this building. | float | 7.0 | kilograms-per-square-meter-per-month |
B+CO2_EMIS_F_C | CO2 emission factor cold | CO2 emission factor for cold energy | float | 0.3 | kilograms-per-kilowatt-hours |
B+CO2_EMIS_F_EL | CO2 emission factor electricity | CO2 emission factor for electric energy | float | 0.56 | kilograms-per-kilowatt-hours |
B+CO2_EMIS_F_H | CO2 emission factor heat | CO2 emission factor for heat energy | float | 0.24 | kilograms-per-kilowatt-hours |
B+CO2_EMIS_PRIC_DSG | Investment - CO2 emission price | CO2 emission price for new heating system | float | 45.0 | euro-per-metric-ton |
B+CO2_EMIS_PRIC_RATE_DSG | Investment - CO2 emission price change rate | CO2 emission change rate for new heating system | float | 0.0 | percent |
B+CS | Cooling system | Information regarding the cooling system. | string | None | generic |
B+DP_COUNT | Number of datapoints | Number of datapoints in the project. | float | None | generic |
B+EC+SIG_COLO_R | Energy cost limit red | Overwrites the red limit of the energy cost KPI for this building. | float | 1.0 | euro-per-square-meter-per-month |
B+EC+SIG_COLO_Y | Energy cost limit yellow | Overwrites the yellow limit for the energy cost KPI for this building. | float | 0.7 | euro-per-square-meter-per-month |
B+EN_CONSUM+SIG_COLO_R | Energy consumption limit red | Overwrites the red limit for the energy consumption KPI for this building. | float | 10.833 | kilowatt-hours-per-square-meter-per-month |
B+EN_CONSUM+SIG_COLO_Y | Energy consumption limit yellow | Overwrites the yellow limit of the energy consumption KPI for this building. | float | 8.333 | kilowatt-hours-per-square-meter-per-month |
B+FACILITY_MANAGER | Facility manager | Name of the facility manager. | string | None | generic |
B+GOA | Goals | Set SMART goals to optimize your building! "period": Make it time-bound. "names": Formulate your goal specific, achievable, and relevant. "bar_chart": Make it measurable and track it. | json | None | generic |
B+HP+CO2_EMIS_F_INST_DSG | Investment - CO2 emission factor new energy system | CO2 emissions per energy unit for new heating system | float | 0.3 | kilograms-per-kilowatt-hours |
B+HP+PRIC_EL_DSG | Investment - electricity price heat pump | Energy price new heating system | float | 0.3 | euro-per-kilowatt-hours |
B+HP+PRIC_EL_RATE_DSG | Investment - electricity price change rate heat pump | Change rate of the electricity price for the new energy system | float | 0.0 | percent |
B+HP+PRIC_INST_DSG | Investment - specific installation price new energy system | Specific installation price for the heat pump | float | 1000.0 | euro-per-kilowatt |
B+HP+TYPE_DSG | Investment - Heat pump type | Distinguished in Water/Water and Air/Water | enum | remeha_aw_168 | generic |
B+HS | Heating system | Information regarding the heating system. | string | None | generic |
B+HS+CO2_EMIS_F_DSG | Investment - CO2 emission factor current energy system | CO2 emissions per energy unit for current heating system | float | 0.2 | kilograms-per-kilowatt-hours |
B+HS+DEP_DUR_DSG | Investment - depreciation period new energy system | Depreciation period of the new energy system | float | inf | years |
B+HS+EF_DSG | Investment - efficiency current heat source | Efficiency of the current heat source | float | 100.0 | percent |
B+HS+PRIC_H_DSG | Investment - specific energy price current heating system | Current energy price | float | 0.12 | euro-per-kilowatt-hours |
B+HS+PRIC_H_RATE_DSG | Investment - specific energy price change rate current heat source | Change rate of the electricity price for the current energy system | float | 0.0 | percent |
B+HS+T_SUP_DSG | Investment - design temperature heating system | Design supply temperature of the heating system (usually maximum supply temperature) | float | 60.0 | degrees-celsius |
B+HS+USA_DUR_DSG | Investment - usage period new energy system | Depreciation period to consider the tax effect | float | 20.0 | years |
B+ICT | ICT contact person | Name of the ICT contact person. | string | None | generic |
B+INR_DSG | Investment - interest rate | Calculation interest rate to discount the annual cash flow | float | 12.0 | percent |
B+LINK | Link | Hyperlink to external resources | link | None | generic |
B+LOC | Location of building | Location or address of the building. | string | None | generic |
B+M | Meters | Information regarding the meters. | string | None | generic |
B+NFA | Calculation area | Area used for calculations. | float | None | square-meters |
B+NIG_REDU | Night reduction | Indicator there is a night reduction (heating) or night increase (cooling) in this buiding | enum | automatic | generic |
B+OPR_MOD | Operating mode | Distinction of heating and cooling mode for evaluation of temperature adjustment | enum | heating | generic |
B+POW_H_BASE_LOA | Thermal base load | Heat power consumption independent of outside air temperature | float | 0.0 | kilowatts |
B+POW_H_LIM_LOW | Lower limit total heat power | Heat power cutoff | float | 10.0 | kilowatts |
B+PRIC_EL | Electricity price | Price of electric energy | float | 0.25 | euro-per-kilowatt-hours |
B+PRIC_EN_C | Cold price | Price of cold energy | float | 0.1 | euro-per-kilowatt-hours |
B+PRIC_EN_H | Heat price | Price of heat energy | float | 0.14 | euro-per-kilowatt-hours |
B+PROP_MANA | Property management | Property management company or person. | string | None | generic |
B+REFE_EN_C_SPFI_AR_CONSUM | Reference specific cold consumption | Overwrite the specific cold consumption for the savings calculation | float | 20.0 | kilowatt-hours-per-square-meter |
B+REFE_EN_H_SPFI_AR_CONSUM | Reference specific heat consumption | Overwrite the specific heat consumption for the savings calculation | float | 60.0 | kilowatt-hours-per-square-meter |
B+REFE_ROOM_T_AIR | Reference room temperature | Overwrite the room temperature of the reference period for savings calculation | float | None | degrees-celsius |
B+REFE_ROOM_T_AIR_OPT | Reference optimum room temperature | Overwrite the optimum room temperature of the reference period for savings calculation | float | None | degrees-celsius |
B+REFE_ROOM_T_DIF_MIN | Minimal temperature difference | Minimal expected temperature change (absolute value) through optimization, related to the reference period. | float | 0.5 | delta-degrees-celsius |
B+REFE_ROOM_T_SPR_MIN | Minimal temperature spread | Minimal expected temperature spread (absolute value) through night-time setback, related to the reference period. | float | 1.0 | delta-degrees-celsius |
B+REFE_STOP | Reference period end | End of the reference period to calculate model | string | None | generic |
B+REFE_STRT | Reference period start | Start of the reference period to calculate model | string | None | generic |
B+REFE_T_C_LIM | Reference cooling limit temperature | Set the temperature limit of the reference period at which cooling is considered for savings calculations | float | 24.0 | degrees-celsius |
B+REFE_T_H_LIM | Reference heating limit temperature | Set the temperature limit of the reference period at which heating is considered for savings calculations | float | 20.0 | degrees-celsius |
B+RENOV_YEAR | Year of the last renovation | Year of the last renovation of the building. | float | None | generic |
B+ROOM_T_AIR | Room temperature | Overwrite the room temperature of the analysis period for savings calculation | float | None | degrees-celsius |
B+ROOM_T_AIR_OPT | Optimum room temperature | Overwrite the optimum room temperature of the analysis period for savings calculation | float | 20.0 | degrees-celsius |
B+TYP | Type | The usage type of building. | enum | None | generic |
B+T_C_LIM | Cooling limit temperature | Set the temperature limit of the analysis period at which cooling is considered for savings calculations | float | 24.0 | degrees-celsius |
B+T_H_LIM | Heating limit temperature upper limit | Temperature limit where the heating system is not active | float | 20.0 | degrees-celsius |
B+WASP | WASP | Indicator there is a WASP .controls app in this buiding | enum | automatic | generic |
B_COUNT_CAR_MAX | Car park capacity | Maximum number of cars the car park can accommodate. | float | None | generic |
B_COUNT_PEO_MAX | Occupancy capacity | Total number of people the building can accommodate. | float | None | generic |
B_EFZ | Efficiency zones | Benchmarks for evaluating efficiency criteria of buildings on a color scale. | json | None | generic |
B_EVS | Events | Define the most important alarming events in a building. [Alarms] can be linked to an event by "category", while "activate":True indicates at least one linked alarm. The key "icon" allows to individualize frontend-sided rendering of the event. | json | None | generic |
B_GFA_AV | Mean gross floor area (Not used anymore!) | The mean area of each floor. | float | None | square-meters |
B_PRIC_CO2 | CO2 price | Set the default price for CO2 of this building. | float | None | euro-per-kilogram |
B_TAR_CO2_EMI | Targeted CO2 emissions | Value of desired total CO2 emissions | float | None | kilograms |
B_TAR_EN_EL_CONSUM_MAX | Targeted electricity consumption max | Maximum of the desired electricity consumption | float | None | kilowatt-hours |
B_TAR_EN_EL_GEN_MAX | Targeted energy generation max | Maximum of the desired electricity generation | float | None | kilowatt-hours |
B_TAR_EN_H_CONSUM_MAX | Targeted heat consumption max | Maximum of the desired heat consumption | float | None | kilowatt-hours |
B_TAR_WS_FRESH_CONSUM | Targeted water consumption | Value of the desired total water consumption | float | None | cubic-meters |
Charging station¶
Category: Electrical systems
The alphanumeric ID for the component is CST.
No analysis available.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
CST+EN_EL_CONSUM | Energy consumption | None | energy |
CST+POW_EL_CONSUM | Power consumption | None | power |
CST+STAT_OPR | Operational state | None | dimensionless-quantities |
CST+TIM_USA | Usage time | None | time |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
CST+LINK | Link | Hyperlink to external resources | link | None | generic |
Cold meter¶
Category: Miscellaneous
The Cold meter component data model represents a heat meter that will count cooling energy. It can be physically present in the energy system or virtually on the aedifion platform. The alphanumeric ID for the component is CM.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
CM+CO2_EMIS_F | CO2 emission factor | CO2 emission factor for the underlying energy. If the attribute is set the corresponding pin is not considered inside the analysis. | emission-intensity |
CM+EN_C | Cooling energy | Measured cooling energy | energy |
CM+EN_C_INV | Cooling energy per interval | Measured cooling energy within the interval | energy |
CM+POW_C | Cooling power | Measured cooling power | power |
CM+PRIC_EN | Cold price | Specific price for the underlying energy. If the attribute is set the corresponding pin is not considered inside the analysis. | cost-per-energy-unit |
CM+T_IN | Supply temperature | Temperature of heat carrier fluid (water) entering the cold meter | temperature |
CM+T_OUT | Return temperature | Temperature of heat carrier fluid (water) exiting the cold meter | temperature |
CM+VF | Volume flow | Volume flow of heat carrier fluid (water) | volumetric-flow-rate |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
CM+CALC_COST | Cost measurement device | Indicator if this component is used in the asset cockpit analysis for energy cost and CO2 emissions | boolean | False | generic |
CM+CO2_EMIS_F | CO2 emission factor | CO2 emission factor for the underlying energy. If the attribute is set the corresponding pin is not considered inside the analysis. | float | 0.3 | kilograms-per-kilowatt-hours |
CM+DATA_SRC | Data source | Define how the data for pins of this component was written into the database. | string | system | generic |
CM+LINK | Link | Hyperlink to external resources | link | None | generic |
CM+M_NUM | Meter number | Meter number used for billing and identification purposes. | string | None | generic |
CM+PRIC_EN | Cold price | Specific price for the underlying energy. If the attribute is set the corresponding pin is not considered inside the analysis. | float | 0.1 | euro-per-kilowatt-hours |
CM+WTH_CMPS | Weather compensation | Indicator as to whether the energy consumption should also be weather-adjusted. | boolean | True | generic |
Combined heat and power¶
Category: Heating
The Combined Heat and Power component data model represents various kinds of combined heat and power generation. The alphanumeric ID for the component is CHP.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
CHP+EN_H | Heating energy | Measured heating energy delivered by CHP to heating loop | energy |
CHP+GEN+POW_EL | Generator power | Measured electricity output of the device | power |
CHP+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm, 0 = no alarm | dimensionless-quantities |
CHP+MSG_OPR | Operating message | Informs about operational state of component: 1 = operating, 0 = switched-off | dimensionless-quantities |
CHP+MSG_RELE | Release message | Informs if the component is released: 1 = released, 0 = not released | dimensionless-quantities |
CHP+MSG_REQ | Request message | Informs if the component is requested: 1 = requested, 0 = not requested | dimensionless-quantities |
CHP+OPR_MOD | Operation mode feedback | Operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
CHP+OPR_MOD_SW_AUTO | Operation mode automatic switch | Switch for the operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
CHP+POW_H | Heating power | Measured heating power delivered by CHP to heating loop | power |
CHP+PU+COM_SWI | Pump - switching command | Command to switch the pump on or off | dimensionless-quantities |
CHP+PU+CTRL | Pump - operation control signal | Value representing the pump control signal or pump speed | frequency |
CHP+PU+CTRL_FB | Pump - operation position feedback | Feedback of the pump control signal or pump speed | frequency |
CHP+PU+MSG_OPR | Pump - operating message | Operational state of the pump: 1 = operating, 0 = switched-off | dimensionless-quantities |
CHP+RATE_FUEL_CONSUM | Rate of fuel consumption | Rate of fuel consumption of the device | power |
CHP+T_AIR_ODA | Outside air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | temperature |
CHP+T_IN | Return temperature | Temperature of heat carrier fluid (water) entering the component. | temperature |
CHP+T_OUT | Supply temperature | Temperature for heat carrier fluid ( water) exiting the component. | temperature |
CHP+T_OUT_SP | Supply temperature setpoint | Setpoint temperature for heat carrier fluid ( water) exiting the component. | temperature |
CHP+VF | Volume flow | Volume flow of heat carrier fluid (water) | volumetric-flow-rate |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
CHP+CC_BP | Heating curve - base points | Defines the base points for the piecewise linear heating curve, as values seperated by comma, pairs seperated by semicolon. | string | None | degrees-celsius |
CHP+CUS_DAY_SHD | Custom day schedules | Overwrites basic schedule for specific days with an individual schedule. The JSON is flexibly expandable for any number of days. | json | None | generic |
CHP+CUS_HOLI | Custom holiday | On a holiday, plant operation is considered as unintentional. Adds custom holidays to the schedule. | json | None | generic |
CHP+FUEL_UTIL_F | Fuel utiltzation factor | Overall efficiency of the CHP. It is considered to be the sum of thermal and electrical efficiency. The fuel utilization factor can be a manufacturer's information, based on own calculations or measurements or it could be a rough estimation of the fuel utilization factor. | float | None | generic |
CHP+GEN+POW_NOM | Generator nominal power | Nominal power output of the generator from CHP. | float | None | kilowatts |
CHP+H_NOM_PROD | Nominal heat production | Nominal heat production of the device. | float | None | kilowatt-hours |
CHP+H_T_RET_DSG | Design return temperature | Return temperature that was used to design the energy system at maximum load. | float | 50.0 | degrees-celsius |
CHP+H_T_SPR_MIN_DSG | Minimal temperature spread | Minimal expected temperature spread. | float | 5.0 | delta-degrees-celsius |
CHP+H_T_SUP_DSG | Design supply temperature | Supply temperature that was used to design the energy system at maximum load. | float | 70.0 | degrees-celsius |
CHP+LINK | Link | Hyperlink to external resources | link | None | generic |
CHP+NIG_REDU | Heating curve - night time reduction | The night reduction that will be applied to the calculated set point from the heating curve | float | 0 | degrees-celsius |
CHP+PRECON | Pre-conditioning period | Adds a preconditioning period to the start time of the schedule. Operation before the start time is therefore evaluated as intended within the additional preconditioning time. | float | 0 | minutes |
CHP+PRIC_EL | Electricity price | Price of the electricity used in the CHP. | float | 0.25 | euro-per-kilowatt-hours |
CHP+PRIC_FUEL | Fuel price | Price of the fuel used in the CHP. | float | 0.06 | euro-per-kilowatt-hours |
CHP+PRIC_H_EN | Heat price | Price of the heat used in the CHP. | float | 0.065 | euro-per-kilowatt-hours |
CHP+PRIC_STUP | Start-up costs | The power specific costs of one start-up. | float | 0.02 | euro-per-kilowatt |
CHP+REG_KEY | Regional holiday key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE | generic |
CHP+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | json | None | generic |
CHP+SHDO_FLX | Shutdown flexibility | Adds a shutdown flexibility to the end time of the schedule. Operation before the schedule end time is therefore evaluated as unintended during the shutdown flexibility. | float | 0 | minutes |
CHP+SHD_TIMZ | Schedule timezone | Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | generic |
CHP+TH_EF | Thermal efficiency | Efficiency of the device for turning fuel energy into thermal energy. The thermal efficiency can be a manufacturer's information, based on own calculations or measurements or it could be a rough estimation of the thermal efficiency. | float | None | generic |
CHP+T_SP_DEV_TOL | Temperature setpoint deviation tolerance | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | degrees-celsius |
Compression chiller¶
Category: Cooling
The Compression chiller component represents a generic compression chiller with an electric compression unit. A customer can use the evaporator side for cooling. Excess heat is dissipated on the condenser side of the system. The alphanumeric ID for the component is CH_COMP.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
CH_COMP+COND+PU+CTRL | Condenser - pump - operation control signal | Value representing the pump control signal or pump speed | frequency |
CH_COMP+COND+PU+MSG_OPR | Condenser - pump - operating message | Informs about operational state of the condenser pump 1 = operating, 0 = switched-off | dimensionless-quantities |
CH_COMP+COND+T_IN | Inlet temperature - condenser | Temperature of heat carrier fluid (water) entering the component. Condenser side. | temperature |
CH_COMP+COND+T_OUT | Outlet temperature - condenser | Temperature of heat carrier fluid (water) exiting the component. Condenser side. | temperature |
CH_COMP+COND+T_OUT_SP | Outlet temperature setpoint - condenser | Setpoint temperature of heat carrier fluid (water) exiting the component. Condenser side. | temperature |
CH_COMP+EVAP+EN_C | Cooling energy - evaporator | Measured cooling energy taken from heat source loop. | energy |
CH_COMP+EVAP+POW_C | Cooling power - evaporator | Measured cooling power taken from heat source loop. | power |
CH_COMP+EVAP+PU+CTRL | Evaporator - pump - operation control signal | Value representing the pump control signal or pump speed | frequency |
CH_COMP+EVAP+PU+MSG_OPR | Evaporator - pump - operating message | Informs about operational state of the evaporator pump 1 = operating, 0 = switched-off | dimensionless-quantities |
CH_COMP+EVAP+T_IN | Inlet temperature - evaporator | Temperature of heat carrier fluid (water) entering the component. Evaporator side. | temperature |
CH_COMP+EVAP+T_OUT | Outlet temperature - evaporator | Temperature of heat carrier fluid (water) entering the component. Evaporator side. | temperature |
CH_COMP+EVAP+T_OUT_SP | Outlet temperature setpoint - evaporator | Setpoint temperature of heat carrier fluid (water) entering the component. Evaporator side. | temperature |
CH_COMP+EVAP+VF | Volume flow - evaporator | Volume flow of heat carrier fluid (water). Evaporator side. | volumetric-flow-rate |
CH_COMP+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm, 0 = no alarm | dimensionless-quantities |
CH_COMP+MSG_OPR | Operating message | Informs about operational state of component 1 = operating, 0 = switched-off | dimensionless-quantities |
CH_COMP+MSG_RELE | Release message | Informs if the component is released: 1 = released, 0 = not released | dimensionless-quantities |
CH_COMP+MSG_REQ | Request message | Informs if the component is requested: 1 = requested, 0 = not requested | dimensionless-quantities |
CH_COMP+OPR_COUNT | Operating starts | Total number of starts | dimensionless-quantities |
CH_COMP+OPR_MOD | Operation mode feedback | Operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
CH_COMP+OPR_MOD_SW_AUTO | Operation mode automatic switch | Switch for the operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
CH_COMP+OPR_TIM | Operating hours | Total hours of operation | time |
CH_COMP+POW_EL | Electrical power | Measured electrical power consumed by the device. | power |
CH_COMP+T_AIR_ODA | Outside air temperature | Outside air temperature | temperature |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
CH_COMP+COND+C_T_RET_DSG | Condenser cooling - design return temperature | Return temperature that was used to design the condenser at maximum load during cooling operation. | float | 50.0 | degrees-celsius |
CH_COMP+COND+C_T_SPR_MIN_DSG | Condenser cooling - minimal temperature spread | Minimal expected temperature spread for the condenser when cooling. | float | 2.0 | delta-degrees-celsius |
CH_COMP+COND+C_T_SUP_DSG | Condenser cooling - design supply temperature | Supply temperature that was used to design the evaporator at maximum load during cooling operation. | float | 44.0 | degrees-celsius |
CH_COMP+COND+H_T_RET_DSG | Condenser heating - design return temperature (Not used anymore!) | Return temperature that was used to design the condenser at maximum load during heating operation.(Not used anymore!) | float | 44.0 | degrees-celsius |
CH_COMP+COND+H_T_SPR_MIN_DSG | Condenser heating - minimal temperature spread (Not used anymore!) | Minimal expected temperature spread for the condenser during heating.(Not used anymore!) | float | 2.0 | delta-degrees-celsius |
CH_COMP+COND+H_T_SUP_DSG | Condenser heating - design supply temperature (Not used anymore!) | Supply temperature that was used to design the condenser at maximum load during heating operation.(Not used anymore!) | float | 50.0 | degrees-celsius |
CH_COMP+COND+T_OUT_SP_DEV_TOL | Outlet temperature setpoint deviation tolerance - condenser | Tolerance for deviation of actual temperature from setpoint. Condensor side. | float | 1.5 | degrees-celsius |
CH_COMP+COP | Coefficient of performance | The coefficient of performance (cop) describes the efficiency of the compression chiller. The cop can be a manufacturer's information, based on own calculations or measurements or it could be a rough estimation of the efficiency. | float | 4.0 | generic |
CH_COMP+CUS_DAY_SHD | Custom day schedules | Overwrites basic schedule for specific days with an individual schedule. The JSON is flexibly expandable for any number of days. | json | None | generic |
CH_COMP+CUS_HOLI | Custom holiday | On a holiday, plant operation is considered as unintentional. Adds custom holidays to the schedule. | json | None | generic |
CH_COMP+C_NOM_PROD | Nominal cooling production | Nominal cooling production of the device. | float | None | kilowatt-hours |
CH_COMP+EVAP+C_T_RET_DSG | Evaporator - design return temperature | Return temperature that was used to design the evaporator at maximum load. | float | 16.0 | degrees-celsius |
CH_COMP+EVAP+C_T_SPR_MIN_DSG | Evaporator - minimal temperature spread | Minimal expected temperature spread for the evaporator. | float | 2.0 | delta-degrees-celsius |
CH_COMP+EVAP+C_T_SUP_DSG | Evaporator - design supply temperature | Supply temperature that was used to design the evaporator at maximum load. | float | 8.0 | degrees-celsius |
CH_COMP+EVAP+T_OUT_SP_DEV_TOL | Outlet temperature setpoint deviation tolerance - evaporator | Tolerance for deviation of actual temperature from setpoint. Evaporator side. | float | 1.5 | degrees-celsius |
CH_COMP+LINK | Link | Hyperlink to external resources | link | None | generic |
CH_COMP+PRECON | Pre-conditioning period | Adds a preconditioning period to the start time of the schedule. Operation before the start time is therefore evaluated as intended within the additional preconditioning time. | float | 0 | hours |
CH_COMP+PRIC_EL | Electricity price | Price for used electricity. | float | 0.25 | euro-per-kilowatt-hours |
CH_COMP+REG_KEY | Regional holiday key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE | generic |
CH_COMP+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | string | None | generic |
CH_COMP+SHDO_FLX | Shutdown flexibility | Adds a shutdown flexibility to the end time of the schedule. Operation before the schedule end time is therefore evaluated as unintended during the shutdown flexibility. | float | 0 | hours |
CH_COMP+SHD_TIMZ | Schedule timezone | Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | generic |
Cooling circuit¶
Category: Cooling
The Cooling Circuit component represents generic cooling circuits that can be found in buildings. The alphanumeric ID for the component is C_CRC.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
C_CRC+COM_SWI_MN | Main switching command | Value which describes the "on mode" of main switching command pin, especially for multi-state variables | dimensionless-quantities |
C_CRC+CTRL_SV_UP | Cooling limit | Cooling limit based on ambient temperature, if ambient temperature is below cooling limit the circuit turns off | temperature |
C_CRC+EN_C | Cooling energy | Measured cooling energy consumed by the cooling circuit | energy |
C_CRC+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm, 0 = no alarm | dimensionless-quantities |
C_CRC+MSG_OPR | Operating message | Informs about operational state of component: 1 = operating, 0 = switched-off | dimensionless-quantities |
C_CRC+MSG_RELE | Release message | Informs if the component is released: 1 = released, 0 = not released | dimensionless-quantities |
C_CRC+MSG_REQ | Request message | Informs if the component is requested: 1 = requested, 0 = not requested | dimensionless-quantities |
C_CRC+OPR_MOD | Operation mode feedback | Operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
C_CRC+OPR_MOD_SW_AUTO | Operation mode automatic switch | Switch for the operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
C_CRC+POW_C | Cooling power | Measured cooling power consumed by the cooling circuit | power |
C_CRC+PU+COM_SWI | Pump - switching command | Command to switch the pump on or off | dimensionless-quantities |
C_CRC+PU+CTRL | Pump - operation control signal | Value representing the pump control signal or pump speed | frequency |
C_CRC+PU+CTRL_FB | Pump - operation position feedback | Feedback of the pump control signal or pump speed | frequency |
C_CRC+PU+MSG_OPR | Pump - operating message | Operational state of the pump: 1 = operating, 0 = switched-off | dimensionless-quantities |
C_CRC+T_AIR_ODA | Outside air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | temperature |
C_CRC+T_IN | Supply temperature | Temperature of the fluid entering the cooling circuit | temperature |
C_CRC+T_IN_SP | Supply temperature setpoint | Temperature setpoint of the fluid entering the cooling circuit | temperature |
C_CRC+T_IN_SP_MAX | Supply temperature setpoint maximum | Setpoint for the maximum supply temperature | temperature |
C_CRC+T_IN_SP_MIN | Supply temperature setpoint minimum | Setpoint for the minimum supply temperature | temperature |
C_CRC+T_OUT | Return temperature | Temperature of the fluid leaving the cooling circuit | temperature |
C_CRC+T_SRC | Cold water temperature | Temperature of the water coming from the cold source | temperature |
C_CRC+VAL_POS | Valve position | Actual position of valve opening: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
C_CRC+VAL_POS_SP | Valve control signal | Control signal of the valve: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
C_CRC+VF | Volume flow | Volume flow of heat carrier fluid (water) | volumetric-flow-rate |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
C_CRC+CC_BP | Heating curve - base points | Defines the base points for the piecewise linear heating curve, as values seperated by comma, pairs seperated by semicolon. | string | None | degrees-celsius |
C_CRC+COM_SWI_MN_OFF | Main switching command - off | Value which describes the "off mode" of main switching command pin, especially for multi-state variables | float | None | generic |
C_CRC+COM_SWI_MN_ON | Main switching command - on | Value which describes the "on mode" of main switching command pin, especially for multi-state variables | float | None | generic |
C_CRC+CUS_DAY_SHD | Custom day schedules | Overwrites basic schedule for specific days with an individual schedule. The JSON is flexibly expandable for any number of days. | json | None | generic |
C_CRC+CUS_HOLI | Custom holiday | On a holiday, plant operation is considered as unintentional. Adds custom holidays to the schedule. | json | None | generic |
C_CRC+C_T_RET_DSG | Design return temperature | Return temperature that was used to design the water side at maximum load. | float | 16.0 | degrees-celsius |
C_CRC+C_T_SPR_MIN_DSG | Minimal temperature spread | Minimal expected temperature spread. | float | 2.0 | delta-degrees-celsius |
C_CRC+C_T_SUP_DSG | Design supply temperature | Supply temperature that was used to design the water side at maximum load. | float | 10.0 | degrees-celsius |
C_CRC+LINK | Link | Hyperlink to external resources | link | None | generic |
C_CRC+NIG_REDU | Heating curve - night time reduction | The night reduction that will be applied to the calculated set point from the heating curve | float | 0 | degrees-celsius |
C_CRC+NOM_POW_C | Nominal power | Nominal cooling power of the cooling circuit | float | None | kilowatts |
C_CRC+NOM_VF | Nominal volume flow | Nominal volume flow of the cooling circuit | float | None | cubic-meters-per-hour |
C_CRC+OPR_MOD_CMF | Operation mode - comfort | Value which describes the "comfort mode" of operation mode pin | float | None | generic |
C_CRC+OPR_MOD_ECO | Operation mode - economy | Value which describes the "economy mode" of operation mode pin | float | None | generic |
C_CRC+PRECON | Pre-conditioning period | Adds a preconditioning period to the start time of the schedule. Operation before the start time is therefore evaluated as intended within the additional preconditioning time. | float | 0 | hours |
C_CRC+REG_KEY | Regional holiday key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE | generic |
C_CRC+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | json | None | generic |
C_CRC+SHDO_FLX | Shutdown flexibility | Adds a shutdown flexibility to the end time of the schedule. Operation before the schedule end time is therefore evaluated as unintended during the shutdown flexibility. | float | 0 | hours |
C_CRC+SHD_TIMZ | Schedule timezone | Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | generic |
C_CRC+T_OUT_SP_DEV_TOL | Supply temperature setpoint deviation tolerance | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | degrees-celsius |
C_CRC+VAL_POS_SP_DEV_TOL | Valve position setpoint deviation tolerance | Tolerance for deviation of the valve position from the valve control signal. | float | 10.0 | percent |
C_CRC+VAL_THR | Valve threshold | For specific analysis functions it's important to know above what valve position the feeding pump should start to operate. | float | 5 | percent |
C_CRC+VAL_TYP | Valve type | For specific analysis functions it's important to know what kind of valve is used to regulate the outlet temperature. If required you can choose between a 2-way valve and a 3-way valve with this attribute. | enum | 2-way-valve | generic |
C_CRC+WASP.NIG_RAI | WASP .controls App - cooling limit nighttime raise | The night raise that will be applied to the cooling limit | float | 0 | degrees-celsius |
Electricity meter¶
Category: Miscellaneous
The Electricity Meter component model represents a common meter that measures active and reactive power of a system, as well as active and reactive energy. The alphanumeric ID for the component is ELM.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
ELM+CO2_EMIS_F | CO2 emission factor | CO2 emission factor for the underlying energy. If the attribute is set the corresponding pin is not considered inside the analysis. | emission-intensity |
ELM+EN_EL_ACT | Active energy | The part of total electric energy that is converted into work and heat. A typical electricity meter will record this energy. | energy |
ELM+EN_EL_ACT_INV | Active energy per interval | The part of total electric energy that was converted into work and heat within the interval. | energy |
ELM+EN_EL_REA | Reactive energy | Industry customers also have to pay for reactive energy. Reactive energy is recorded for large systems. | reactive-energy |
ELM+POW_EL_ACT | Active power | Electrical Power that is used for work. A typical electricity meter will record this as "electrical power". | power |
ELM+POW_EL_REA | Reactive power | The part of electrical power that is applied to compensate for high inductive loads. | reactive-power |
ELM+PRIC_EL | Electricity price | Specific price for the underlying energy. If the attribute is set the corresponding pin is not considered inside the analysis. | cost-per-energy-unit |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
ELM+CALC_COST | Cost measurement device | Indicator if this component is used in the asset cockpit analysis for energy cost and CO2 emissions | boolean | False | generic |
ELM+CO2_EMIS_F | CO2 emission factor | CO2 emission factor for the underlying energy. If the attribute is set the corresponding pin is not considered inside the analysis. | float | 0.56 | kilograms-per-kilowatt-hours |
ELM+DATA_SRC | Data source | Define how the data for pins of this component was written into the database. | string | system | generic |
ELM+EN_APP | Energy application | Indicator for which energy application this component measures electricity | enum | general-use | generic |
ELM+LINK | Link | Hyperlink to external resources | link | None | generic |
ELM+M_NUM | Meter number | Meter number used for billing and identification purposes. | string | None | generic |
ELM+PRIC_EL | Electricity price | Specific price for the underlying energy. If the attribute is set the corresponding pin is not considered inside the analysis. | float | 0.25 | euro-per-kilowatt-hours |
ELM+WTH_CMPS | Weather compensation | Indicator as to whether the energy consumption should also be weather-adjusted. If true, the attribute Energy application has to be set to Cold or Heat application. | boolean | False | generic |
Elevator¶
Category: Conveyor systems
The Elevator component represents an elevator. The alphanumeric ID for the component is ELE.
No analysis available.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
ELE+STAT_OPR | Operational state | Operational state according to documentation | dimensionless-quantities |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
ELE+LINK | Link | Hyperlink to external resources | link | None | generic |
Fan¶
Category: Ventilation
The Fan component data model represents various kinds of fans. The alphanumeric ID for the component is FAN.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
FAN+AED_CTRL_ACT | AI controls active | The operational state of an aedifion .controls app | dimensionless-quantities |
FAN+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm, 0 = no alarm | dimensionless-quantities |
FAN+MSG_OPR | Operating message | Informs about operational state of the fan 1 = operating, 0 = switched-off | dimensionless-quantities |
FAN+POW_EL | Electrical power | Measurement of electrical power | power |
FAN+P_DIF | Pressure difference | Pressure difference over the fan | pressure |
FAN+P_DIF_SP | Pressure difference setpoint | Setpoint of the pressure difference over the fan | pressure |
FAN+SPE | Speed | Current fan speed in relation to the nominal speed of the fan | dimensionless-quantities |
FAN+VF | Volume flow | Volume flow generated by the fan | volumetric-flow-rate |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
FAN+CUS_DAY_SHD | Custom day schedules | Overwrites basic schedule for specific days with an individual schedule. The JSON is flexibly expandable for any number of days. | json | None | generic |
FAN+CUS_HOLI | Custom holiday | On a holiday, plant operation is considered as unintentional. Adds custom holidays to the schedule. | json | None | generic |
FAN+LINK | Link | Hyperlink to external resources | link | None | generic |
FAN+NOM_VF | Nominal volume flow | Estimate for the nominal volume flow of the fan | float | None | cubic-meters-per-hour |
FAN+POW_NOM_CONSUM | Nominal power consumption | Nominal power consumption of the fan. | float | None | kilowatts |
FAN+PRECON | Pre-conditioning period | Adds a preconditioning period to the start time of the schedule. Operation before the start time is therefore evaluated as intended within the additional preconditioning time. | float | 0 | hours |
FAN+PRIC_EL | Electricity price | Price for used electricity. | float | 0.25 | euro-per-kilowatt-hours |
FAN+P_DIF_SP_DEV_TOL | Pressure difference setpoint deviation tolerance | Tolerance for deviation of actual pressure difference from its setpoint. | float | 20.0 | pascals |
FAN+REG_KEY | Regional holiday key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE | generic |
FAN+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | json | None | generic |
FAN+SHDO_FLX | Shutdown flexibility | Adds a shutdown flexibility to the end time of the schedule. Operation before the schedule end time is therefore evaluated as unintended during the shutdown flexibility. | float | 0 | hours |
FAN+SHD_TIMZ | Schedule timezone | Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | generic |
FAN+SPE_STD_THLD | Fan speed standard deviation threshold | Tolerance for deviation of speed from its setpoint. | float | 0.5 | percent |
FAN+SPFI_POW_FAN | Specific fan power | Quantifies the energy-efficiency of fan | float | 2000.0 | watts-per-cubic-meter-per-second |
Filter¶
Category: Ventilation
The Filter component data model represents various kinds of filters. The alphanumeric ID for the component is AHU_FIL.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
AHU_FIL+FIL_CONTA | Filter contamination | The extent to which a filter is contaminated measured from 0% (uncontaminated) to 100% (fully contaminated). | dimensionless-quantities |
AHU_FIL+P_DIF | Pressure difference | Pressure differenc ewhen filter is uncontaminated | pressure |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
AHU_FIL+FIL_TYP | Filter Type | Filter type, also known as "filter class". | enum | F9 | generic |
AHU_FIL+LINK | Link | Hyperlink to external resources | link | None | generic |
AHU_FIL+P_DIF_FIN | Pressure difference final | Pressure difference when filter is fully contaminated. | float | None | pascals |
AHU_FIL+P_DIF_INIT | Pressure difference initial | Pressure differenc ewhen filter is uncontaminated | float | None | pascals |
Gas meter¶
Category: Miscellaneous
The Gas Meter component represents a device to counter a volume of gas. The alphanumeric ID for the component is GASM.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
GASM+CO2_EMIS_F | CO2 emission factor | CO2 emission factor for the underlying energy. If the attribute is set the corresponding pin is not considered inside the analysis. | emission-intensity |
GASM+EN_H_INV | Heating energy per interval | Measured heating energy within the interval | energy |
GASM+PRIC_FUEL | Fuel price | Specific price for the underlying energy. If the attribute is set the corresponding pin is not considered inside the analysis. | cost-per-energy-unit |
GASM+VF | Volume flow | Volume flow of gas | volumetric-flow-rate |
GASM+VOL | Gas quantity | Increasing volume counter for gas consumption | volume |
GASM+VOL_INV | Gas quantity per interval | Measured gas consumption within the interval | volume |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
GASM+CALC_COST | Cost measurement device | Indicator if this component is used in the asset cockpit analysis for energy cost and CO2 emissions | boolean | False | generic |
GASM+CALO_VALU_GAS | Calorific value of natural gas | Calorific value of delivered natural gas at termination point. | float | 13.0 | kilowatt-hours-per-cubic-meter |
GASM+CO2_EMIS_F | CO2 emission factor | CO2 emission factor for the underlying energy. If the attribute is set the corresponding pin is not considered inside the analysis. | float | 0.56 | kilograms-per-kilowatt-hours |
GASM+DATA_SRC | Data source | Define how the data for pins of this component was written into the database. | string | system | generic |
GASM+GAS_P_CMPS | Pressure compensation factor of natural gas | Factor used to compensate for elevation and line pressure at the termination point. | float | 1.0 | generic |
GASM+LINK | Link | Hyperlink to external resources | link | None | generic |
GASM+M_NUM | Meter number | Meter number used for billing and identification purposes. | string | None | generic |
GASM+PRIC_FUEL | Fuel price | Specific price for the underlying energy. If the attribute is set the corresponding pin is not considered inside the analysis. | float | 0.06 | euro-per-kilowatt-hours |
GASM+WTH_CMPS | Weather compensation | Indicator as to whether the energy consumption should also be weather-adjusted. | boolean | True | generic |
Heat meter¶
Category: Miscellaneous
The Heat Meter component data model represents a heat meter. It can be physically present in the energy system or virtually on the aedifion platform. The alphanumeric ID for the component is HM.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
HM+CO2_EMIS_F | CO2 emission factor | CO2 emission factor for the underlying energy. If the attribute is set the corresponding pin is not considered inside the analysis. | emission-intensity |
HM+EN_H | Heating energy | Measured heating energy | energy |
HM+EN_H_INV | Heating energy per interval | Measured heating energy within the interval | energy |
HM+POW_H | Heating power | Measured heating power | power |
HM+PRIC_EN | Heat price | Specific price for the underlying energy. If the attribute is set the corresponding pin is not considered inside the analysis. | cost-per-energy-unit |
HM+T_IN | Supply temperature | Temperature of heat carrier fluid (water) entering the heat meter | temperature |
HM+T_OUT | Return temperature | Temperature of heat carrier fluid (water) exiting the heat meter | temperature |
HM+VF | Volume flow | Volume flow of heat carrier fluid (water) | volumetric-flow-rate |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
HM+CALC_COST | Cost measurement device | Indicator if this component is used in the asset cockpit analysis for energy cost and CO2 emissions | boolean | False | generic |
HM+CO2_EMIS_F | CO2 emission factor | CO2 emission factor for the underlying energy. If the attribute is set the corresponding pin is not considered inside the analysis. | float | 0.24 | kilograms-per-kilowatt-hours |
HM+DATA_SRC | Data source | Define how the data for pins of this component was written into the database. | string | system | generic |
HM+LINK | Link | Hyperlink to external resources | link | None | generic |
HM+M_NUM | Meter number | Meter number used for billing and identification purposes. | string | None | generic |
HM+PRIC_EN | Heat price | Specific price for the underlying energy. If the attribute is set the corresponding pin is not considered inside the analysis. | float | 0.14 | euro-per-kilowatt-hours |
HM+WTH_CMPS | Weather compensation | Indicator as to whether the energy consumption should also be weather-adjusted. | boolean | True | generic |
Heat pump¶
Category: Heating
The Heat Pump component data model is representative of components that can raise the temperature level between two heat carrier loops (water/water) via thermal compression. The alphanumeric ID for the component is HP.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
HP+COM_SWI_MN | Main switching command | Value which describes the "on mode" of main switching command pin, especially for multi-state variables | dimensionless-quantities |
HP+COND+EN_H | Heating energy - condenser | Measured heating energy taken from or delivered to the heating/recooling loop. | energy |
HP+COND+POW_H | Heating power - condenser | Measured heating power taken from or delivered to the heating/recooling loop. | power |
HP+COND+PU+CTRL | Condenser - pump - operation control signal | Value representing the pump control signal or pump speed | frequency |
HP+COND+PU+MSG_OPR | Condenser - pump - operating message | Informs about operational state of the condenser pump 1 = operating, 0 = switched-off | dimensionless-quantities |
HP+COND+T_IN | Inlet temperature - condenser | Temperature of heat carrier fluid (water) entering the component. Condenser side. | temperature |
HP+COND+T_OUT | Outlet temperature - condenser | Temperature of heat carrier fluid (water) exiting the component. Condenser side. | temperature |
HP+COND+T_OUT_SP | Outlet temperature setpoint - condenser | Setpoint temperature of heat carrier fluid (water) exiting the component. Condenser side. | temperature |
HP+COND+VF | Condenser - Volume flow | Volume flow of heat carrier fluid (water). Condenser side. | volumetric-flow-rate |
HP+EVAP+EN_H | Heating energy - evaporator | Measured heat taken from cooling/heat source loop. | energy |
HP+EVAP+POW_H | Heating power - evaporator | Measured heat flow taken from cooling/heat source loop | power |
HP+EVAP+PU+CTRL | Evaporator - pump - operation control signal | Value representing the pump control signal or pump speed | frequency |
HP+EVAP+PU+MSG_OPR | Evaporator - pump - operating message | Informs about operational state of the evaporator pump 1 = operating, 0 = switched-off | dimensionless-quantities |
HP+EVAP+T_IN | Inlet temperature - evaporator | Temperature of heat carrier fluid (water) entering the component. Evaporator side. | temperature |
HP+EVAP+T_OUT | Outlet temperature - evaporator | Temperature of heat carrier fluid (water) exiting the component. Evaporator side. | temperature |
HP+EVAP+T_OUT_SP | Outlet temperature setpoint - evaporator | Setpoint temperature of heat carrier fluid (water) exiting the component. Evaporator side. | temperature |
HP+EVAP+VF | Evaporator - Volume flow | Volume flow of heat carrier fluid (water). Evaporator side. | volumetric-flow-rate |
HP+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm, 0 = no alarm | dimensionless-quantities |
HP+MSG_OPR | Operating message | Informs about operational state of component 1 = operating, 0 = switched-off | dimensionless-quantities |
HP+MSG_RELE | Release message | Informs if the component is released: 1 = released, 0 = not released | dimensionless-quantities |
HP+MSG_REQ | Request message | Informs if the component is requested: 1 = requested, 0 = not requested | dimensionless-quantities |
HP+OPR_MOD | Operation mode feedback | Operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
HP+OPR_MOD_SW_AUTO | Operation mode automatic switch | Switch for the operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
HP+POW_EL | Electrical power | Measured electrical power consumed by the device. | power |
HP+T_AIR_ODA | Outside air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | temperature |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
HP+CC_BP | Heating curve - base points | Defines the base points for the piecewise linear heating curve, as values seperated by comma, pairs seperated by semicolon. | string | None | degrees-celsius |
HP+COM_SWI_MN_OFF | Main switching command - off | Value which describes the "off mode" of main switching command pin, especially for multi-state variables | float | None | generic |
HP+COM_SWI_MN_ON | Main switching command - on | Value which describes the "on mode" of main switching command pin, especially for multi-state variables | float | None | generic |
HP+COND+C_T_RET_DSG | Condenser cooling - design return temperature | Return temperature that was used to design the secondary side at maximum load during cooling operation. | float | 16.0 | degrees-celsius |
HP+COND+C_T_SPR_MIN_DSG | Condenser cooling - minimal temperature spread | Minimal expected temperature spread for the condenser when cooling. | float | 2.0 | delta-degrees-celsius |
HP+COND+C_T_SUP_DSG | Condenser cooling - design supply temperature | Supply temperature that was used to design the secondary side at maximum load during cooling operation. | float | 8.0 | degrees-celsius |
HP+COND+H_T_RET_DSG | Condenser heating - design return temperature | Return temperature that was used to design the secondary side at maximum load during heating operation. | float | 44.0 | degrees-celsius |
HP+COND+H_T_SPR_MIN_DSG | Condenser heating - minimal temperature spread | Minimal expected temperature spread for condenser when heating. | float | 2.0 | delta-degrees-celsius |
HP+COND+H_T_SUP_DSG | Condenser heating - design supply temperature | Supply temperature that was used to design the secondary side at maximum load during heating operation. | float | 50.0 | degrees-celsius |
HP+COND+T_OUT_SP_DEV_TOL | Outlet temperature setpoint deviation tolerance - condenser | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | degrees-celsius |
HP+COP | Coefficient of performance | The coefficient of performance (cop) describes the efficiency of the heat pump. The cop can be a manufacturer's information, based on own calculations or measurements or it could be a rough estimation of the efficiency. | float | 4.0 | generic |
HP+CUS_DAY_SHD | Custom day schedules | Overwrites basic schedule for specific days with an individual schedule. The JSON is flexibly expandable for any number of days. | json | None | generic |
HP+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | json | None | generic |
HP+EVAP+C_T_RET_DSG | Evaporator cooling - design return temperature | Return temperature that was used to design the primary side at maximum load during heating operation. | float | 16.0 | degrees-celsius |
HP+EVAP+C_T_SPR_MIN_DSG | Evaporator cooling - minimal temperature spread | Minimal expected temperature spread for evaporator when cooling. | float | 2.0 | delta-degrees-celsius |
HP+EVAP+C_T_SUP_DSG | Evaporator cooling - design supply temperature | Supply temperature that was used to design the primary side at maximum load during heating operation. | float | 8.0 | degrees-celsius |
HP+EVAP+H_T_RET_DSG | Evaporator heating - design return temperature | Return temperature that was used to design the primary side at maximum load during cooling operation. | float | 44.0 | degrees-celsius |
HP+EVAP+H_T_SPR_MIN_DSG | Evaporator heating - minimal temperature spread | Minimal expected temperature spread for evaporator when heating. | float | 2.0 | delta-degrees-celsius |
HP+EVAP+H_T_SUP_DSG | Evaporator heating - design supply temperature | Supply temperature that was used to design the primary side at maximum load during cooling operation. | float | 50.0 | degrees-celsius |
HP+EVAP+T_OUT_SP_DEV_TOL | Outlet temperature setpoint deviation tolerance - evaporator | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | degrees-celsius |
HP+H_NOM_PROD | Nominal heat production | Nominal heat production of the device. | float | None | kilowatt-hours |
HP+LINK | Link | Hyperlink to external resources | link | None | generic |
HP+NIG_REDU | Heating curve - night time reduction | The night reduction that will be applied to the calculated set point from the heating curve | float | 0 | degrees-celsius |
HP+OPR_MOD_DSG | Overall operating mode | Expected overall operating mode of component. | enum | heating_mode | generic |
HP+PRECON | Pre-conditioning period | Adds a preconditioning period to the start time of the schedule. Operation before the start time is therefore evaluated as intended within the additional preconditioning time. | float | 0 | hours |
HP+PRIC_EL | Electricity price | Price for used electricity. | float | 0.25 | euro-per-kilowatt-hours |
HP+REG_KEY | Regional holiday key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE | generic |
HP+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | json | None | generic |
HP+SHDO_FLX | Shutdown flexibility | Adds a shutdown flexibility to the end time of the schedule. Operation before the schedule end time is therefore evaluated as unintended during the shutdown flexibility. | float | 0 | hours |
HP+SHD_TIMZ | Schedule timezone | Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | generic |
Heat transfer unit¶
Category: Heating
The Heat Transfer Unit component represents the combination of heat exchangers, pumps and valves which allow heat to be transferred from a heating network to a building. The alphanumeric ID for the component is H_TRA_ST.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
H_TRA_ST+CHO+VAL_POS | Valve position - changeover valve | Actual position of valve opening: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
H_TRA_ST+CHO+VAL_POS_SP | Valve control signal - changeover valve | Control signal of the valve: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
H_TRA_ST+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm, 0 = no alarm | dimensionless-quantities |
H_TRA_ST+MSG_OPR | Operating message | Informs about the operational state of component 1 = operating, 0 = switched-off | dimensionless-quantities |
H_TRA_ST+MSG_RELE | Release message | Informs if the component is released: 1 = released, 0 = not released | dimensionless-quantities |
H_TRA_ST+MSG_REQ | Request message | Informs if the component is requested: 1 = requested, 0 = not requested | dimensionless-quantities |
H_TRA_ST+OPR_MOD | Operation mode feedback | Operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
H_TRA_ST+OPR_MOD_SW_AUTO | Operation mode automatic switch | Switch for the operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
H_TRA_ST+PRIM+EN_H | Heating energy - primary | Measured heating energy of the heat transfer unit on the side of the heating network | energy |
H_TRA_ST+PRIM+POW_H | Heating power - primary | Measured heating power of the heat transfer unit on the side of the heating network | power |
H_TRA_ST+PRIM+PU+CTRL | Pump - control signal - primary | Value representing the pump control signal or pump speed | dimensionless-quantities |
H_TRA_ST+PRIM+PU+MSG_OPR | Pump - operating message - primary | Operational state of the pump: 1 = operating, 0 = switched-off | dimensionless-quantities |
H_TRA_ST+PRIM+T_IN | Supply temperature - primary | Temperature of the fluid entering the heat transfer unit from the heating network | temperature |
H_TRA_ST+PRIM+T_OUT | Return temperature - primary | Temperature of the fluid exiting the heat transfer unit to the heating network | temperature |
H_TRA_ST+PRIM+VAL_POS | Valve position - primary | Actual position of valve opening: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
H_TRA_ST+PRIM+VAL_POS_SP | Valve control signal - primary | Control signal of the valve: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
H_TRA_ST+PRIM+VF | Volume flow - primary | Volume flow of heat carrier fluid (water) | volumetric-flow-rate |
H_TRA_ST+SEC+PU+CTRL | Pump - control signal - secondary | Value representing the pump control signal or pump speed | dimensionless-quantities |
H_TRA_ST+SEC+PU+MSG_OPR | Pump - operating message - secondary | Operational state of the pump: 1 = operating, 0 = switched-off | dimensionless-quantities |
H_TRA_ST+SEC+T_IN | Return temperature - secondary | Temperature of the fluid entering the heat transfer unit from the building | temperature |
H_TRA_ST+SEC+T_OUT | Supply temperature - secondary | Temperature of the fluid exiting the heat transfer unit to the building | temperature |
H_TRA_ST+SEC+T_OUT_SP | Supply temperature setpoint - secondary | Temperature setpoint of the fluid exiting the heat transfer unit to the building | temperature |
H_TRA_ST+SEC+VAL_POS | Valve position - secondary | Actual position of valve opening: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
H_TRA_ST+SEC+VAL_POS_SP | Valve control signal - secondary | Control signal of the valve: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
H_TRA_ST+T_AIR_ODA | Outside air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | temperature |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
H_TRA_ST+CC_BP | Heating curve - base points | Defines the base points for the piecewise linear heating curve, as values seperated by comma, pairs seperated by semicolon. | string | None | degrees-celsius |
H_TRA_ST+CUS_DAY_SHD | Custom day schedules | Overwrites basic schedule for specific days with an individual schedule. The JSON is flexibly expandable for any number of days. | json | None | generic |
H_TRA_ST+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | json | None | generic |
H_TRA_ST+LINK | Link | Hyperlink to external resources | link | None | generic |
H_TRA_ST+NIG_REDU | Heating curve - night time reduction | The night reduction that will be applied to the calculated set point from the heating curve | float | 0 | degrees-celsius |
H_TRA_ST+OPR_MOD_DSG | Overall operating mode | Expected overall operating mode of component. | enum | heating_mode | generic |
H_TRA_ST+PRECON | Pre-conditioning period | Adds a preconditioning period to the start time of the schedule. Operation before the start time is therefore evaluated as intended within the additional preconditioning time. | float | 0 | hours |
H_TRA_ST+PRIM+C_T_RET_DSG | Primary cooling - design return temperature | Return temperature that was used to design the primary side at maximum load during cooling operation. | float | 14.0 | degrees-celsius |
H_TRA_ST+PRIM+C_T_SPR_MIN_DSG | Primary cooling - minimal temperature spread | Minimal expected temperature spread for the primary side when primary is cooling. | float | 2.0 | delta-degrees-celsius |
H_TRA_ST+PRIM+C_T_SUP_DSG | Primary cooling - design supply temperature | Supply temperature that was used to design the primary side at maximum load during cooling operation. | float | 8.0 | degrees-celsius |
H_TRA_ST+PRIM+H_T_RET_DSG | Primary heating - design return temperature | Return temperature that was used to design the primary side at maximum load during heating operation. | float | 65.0 | degrees-celsius |
H_TRA_ST+PRIM+H_T_SPR_MIN_DSG | Primary heating - minimal temperature spread | Minimal expected temperature spread for the primary side when primary is heating. | float | 10.0 | delta-degrees-celsius |
H_TRA_ST+PRIM+H_T_SUP_DSG | Primary heating - design supply temperature | Supply temperature that was used to design the primary side at maximum load during heating operation. | float | 125.0 | degrees-celsius |
H_TRA_ST+PRIM+VAL_POS_SP_DEV_TOL | Valve position setpoint deviation tolerance - primary | Tolerance for deviation of the valve position from the valve control signal. | float | 10.0 | percent |
H_TRA_ST+PRIM+VAL_THR | Valve threshold - Primary | For specific analysis functions it's important to know above what valve position the feeding pump should start to operate. | float | 5 | percent |
H_TRA_ST+PRIM+VAL_TYP | Valve type - Primary | For specific analysis functions it's important to know what kind of valve is used to regulate the outlet temperature. If required you can choose between a 2-way valve and a 3-way valve with this attribute. | enum | 2-way-valve | generic |
H_TRA_ST+REG_KEY | Regional holiday key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE | generic |
H_TRA_ST+SEC+C_T_RET_DSG | Secondary cooling - design return temperature | Return temperature that was used to design the secondary side at maximum load during cooling operation. | float | 16.0 | degrees-celsius |
H_TRA_ST+SEC+C_T_SPR_MIN_DSG | Secondary cooling - minimal temperature spread | Minimal expected temperature spread for secondary side when secondary is cooling. | float | 2.0 | delta-degrees-celsius |
H_TRA_ST+SEC+C_T_SUP_DSG | Secondary cooling - design supply temperature | Supply temperature that was used to design the secondary side at maximum load during cooling operation. | float | 10.0 | degrees-celsius |
H_TRA_ST+SEC+H_T_RET_DSG | Secondary heating - design return temperature | Return temperature that was used to design the secondary side at maximum load during heating operation. | float | 35.0 | degrees-celsius |
H_TRA_ST+SEC+H_T_SPR_MIN_DSG | Secondary heating - minimal temperature spread | Minimal expected temperature spread for secondary side when secondary is heating. | float | 5.0 | delta-degrees-celsius |
H_TRA_ST+SEC+H_T_SUP_DSG | Secondary heating - design supply temperature | Supply temperature that was used to design the secondary side at maximum load during heating operation. | float | 70.0 | degrees-celsius |
H_TRA_ST+SEC+T_OUT_SP_DEV_TOL | Supply temperature setpoint deviation tolerance - secondary | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | degrees-celsius |
H_TRA_ST+SEC+VAL_THR | Valve threshold - Secondary | For specific analysis functions it's important to know above what valve position the feeding pump should start to operate. | float | 5 | percent |
H_TRA_ST+SEC+VAL_TYP | Valve type - Secondary | For specific analysis functions it's important to know what kind of valve is used to regulate the outlet temperature. If required you can choose between a 2-way valve and a 3-way valve with this attribute. | enum | 2-way-valve | generic |
H_TRA_ST+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | json | None | generic |
H_TRA_ST+SHDO_FLX | Shutdown flexibility | Adds a shutdown flexibility to the end time of the schedule. Operation before the schedule end time is therefore evaluated as unintended during the shutdown flexibility. | float | 0 | hours |
H_TRA_ST+SHD_TIMZ | Schedule timezone | Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | generic |
Heating circuit¶
Category: Heating
The Heating Circuit component represents generic heating circuits that can be found in buildings. The alphanumeric ID for the component is H_CRC.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
H_CRC+COM_SWI_MN | Main switching command | Value which describes the "on mode" of main switching command pin, especially for multi-state variables | dimensionless-quantities |
H_CRC+CTRL_SV_UP | Heating limit | Heating limit based on ambient temperature, if ambient temperature is above heating limit the circuit turns off | temperature |
H_CRC+EN_H | Heating energy | Measured heating energy consumed by the heating circuit | energy |
H_CRC+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm, 0 = no alarm | dimensionless-quantities |
H_CRC+MSG_OPR | Operating message | Informs about operational state of component 1 = operating, 0 = switched-off | dimensionless-quantities |
H_CRC+MSG_RELE | Release message | Informs if the component is released: 1 = released, 0 = not released | dimensionless-quantities |
H_CRC+MSG_REQ | Request message | Informs if the component is requested: 1 = requested, 0 = not requested | dimensionless-quantities |
H_CRC+OPR_MOD | Operation mode feedback | Operation mode of the system | dimensionless-quantities |
H_CRC+OPR_MOD_SW_AUTO | Operation mode automatic switch | Switch for the operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
H_CRC+POW_H | Heating power | Measured heating power consumed by the heating circuit | power |
H_CRC+PU+COM_SWI | Pump - switching command | Command to switch the pump on or off | dimensionless-quantities |
H_CRC+PU+CTRL | Pump - operation control signal | Value representing the pump control signal or pump speed | frequency |
H_CRC+PU+CTRL_FB | Pump - operation position feedback | Feedback of the pump control signal or pump speed | frequency |
H_CRC+PU+MSG_OPR | Pump - operating message | Operational state of the pump: 1 = operating, 0 = switched-off | dimensionless-quantities |
H_CRC+T_AIR_ODA | Outside air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | temperature |
H_CRC+T_IN | Supply temperature | Temperature of the fluid entering the heating circuit | temperature |
H_CRC+T_IN_SP | Supply temperature setpoint | Temperature setpoint of the fluid entering the heating circuit | temperature |
H_CRC+T_IN_SP_MAX | Supply temperature setpoint maximum | Setpoint for the maximum supply temperature | temperature |
H_CRC+T_IN_SP_MIN | Supply temperature setpoint minimum | Setpoint for the minimum supply temperature | temperature |
H_CRC+T_OUT | Return temperature | Tolerance for deviation of actual temperature from setpoint. | temperature |
H_CRC+T_SRC | Hot water temperature | Temperature of the water coming from the heat source | temperature |
H_CRC+VAL_POS | Valve position | Actual position of valve opening: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
H_CRC+VAL_POS_SP | Valve control signal | Control signal of the valve: 0 = fully closed, 100 = fully opened | dimensionless-quantities |
H_CRC+VF | Volume flow | Volume flow of heat carrier fluid (water) | volumetric-flow-rate |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
H_CRC+CC_BP | Heating curve - base points | Defines the base points for the piecewise linear heating curve, as values seperated by comma, pairs seperated by semicolon. | string | None | degrees-celsius |
H_CRC+COM_SWI_MN_OFF | Main switching command - off | Value which describes the "off mode" of main switching command pin, especially for multi-state variables | float | None | generic |
H_CRC+COM_SWI_MN_ON | Main switching command - on | Value which describes the "on mode" of main switching command pin, especially for multi-state variables | float | None | generic |
H_CRC+CUS_DAY_SHD | Custom day schedules | Overwrites basic schedule for specific days with an individual schedule. The JSON is flexibly expandable for any number of days. | json | None | generic |
H_CRC+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | json | None | generic |
H_CRC+H_T_RET_DSG | Design return temperature | Return temperature that was used to design the energy system at maximum load. | float | 50.0 | degrees-celsius |
H_CRC+H_T_SPR_MIN_DSG | Minimal temperature spread | Minimal expected temperature spread. | float | 5.0 | delta-degrees-celsius |
H_CRC+H_T_SUP_DSG | Design supply temperature | Supply temperature that was used to design the energy system at maximum load. | float | 70.0 | degrees-celsius |
H_CRC+LINK | Link | Hyperlink to external resources | link | None | generic |
H_CRC+NIG_REDU | Heating curve - night time reduction | The night reduction that will be applied to the calculated set point from the heating curve | float | 0 | degrees-celsius |
H_CRC+NOM_POW_H | Nominal power | Nominal heating power of the heating circuit | float | None | kilowatts |
H_CRC+NOM_VF | Nominal volume flow | Nominal volume flow of the heating circuit | float | None | cubic-meters-per-hour |
H_CRC+OPR_MOD_CMF | Operation mode - comfort | Value which describes the "comfort mode" of operation mode pin | float | None | generic |
H_CRC+OPR_MOD_ECO | Operation mode - economy | Value which describes the "economy mode" of operation mode pin | float | None | generic |
H_CRC+PRECON | Pre-conditioning period | Adds a preconditioning period to the start time of the schedule. Operation before the start time is therefore evaluated as intended within the additional preconditioning time. | float | 0 | hours |
H_CRC+REG_KEY | Regional holiday key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE | generic |
H_CRC+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | json | None | generic |
H_CRC+SHDO_FLX | Shutdown flexibility | Adds a shutdown flexibility to the end time of the schedule. Operation before the schedule end time is therefore evaluated as unintended during the shutdown flexibility. | float | 0 | hours |
H_CRC+SHD_TIMZ | Schedule timezone | Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | generic |
H_CRC+T_OUT_SP_DEV_TOL | Supply temperature setpoint deviation tolerance | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | degrees-celsius |
H_CRC+VAL_POS_SP_DEV_TOL | Valve position setpoint deviation tolerance | Tolerance for deviation of the valve position from the valve control signal. | float | 10.0 | percent |
H_CRC+VAL_THR | Valve threshold | For specific analysis functions it's important to know above what valve position the feeding pump should start to operate. | float | 5 | percent |
H_CRC+VAL_TYP | Valve type | For specific analysis functions it's important to know what kind of valve is used to regulate the outlet temperature If required you can choose between a 2-way valve and a 3-way valve with this attribute. | enum | 3-way-valve | generic |
H_CRC+WASP.NIG_REDU | WASP .controls App - heating limit nighttime reduction | The night reduction that will be applied to the heating limit | float | 0 | degrees-celsius |
Humidifier¶
Category: Ventilation
The Humidifier component represents a steam-powered or electric powered device used to humidify the air in an air conditioning system. The alphanumeric ID for the component is HUM.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
HUM+MSG_OPR | Operating message | Informs about operational state of the humidifier 1 = operating, 0 = switched-off | dimensionless-quantities |
HUM+VAL_POS | Valve position | Actual opening position of the valve 0 = fully closed, 100 = fully opened | dimensionless-quantities |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
HUM+LINK | Link | Hyperlink to external resources | link | None | generic |
HUM+MF_NOM | Nominal mass flow | The mass flow that is fed into the ventilation system at design conditions. | float | None | kilograms-per-second |
Humidity conditioner¶
Category: Ventilation
The Humidity Conditioner component data model is representative for a subset of an AHU with humidity conditioning. It is useful to analyze AHU performance regarding the change of the water load/humidity of the airflow. The alphanumeric ID for the component is AHU_HUM_CODI.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
AHU_HUM_CODI+HUM_REL_AIR_ODA | Outside air relative humidity | Relative humidity of the inlet airflow. Typically the relative humidity of the outside air | dimensionless-quantities |
AHU_HUM_CODI+MSG_OPR | Operating message | Informs about operational state of component 1 = operating, 0 = switched-off | dimensionless-quantities |
AHU_HUM_CODI+SUP_HUM_REL_AIR | Supply air relative humidity | Relative humidity of the supply airflow | dimensionless-quantities |
AHU_HUM_CODI+SUP_T_AIR | Supply air temperature | Temperature of the supply airflow | temperature |
AHU_HUM_CODI+T_AIR_ODA | Outside air temperature | Temperature of the inlet airflow. Typically the temperature outside of the outside air | temperature |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
AHU_HUM_CODI+LINK | Link | Hyperlink to external resources | link | None | generic |
Hybrid circuit¶
Category: Heating
The Hybrid Circuit component represents generic circuits that can both heat and cool. In contrast, heating circuits and cooling circuits can either heat or cool. In cases where one valve is present in the circuit, map everything to the heating pins, e.g. "Heating valve position". The alphanumeric ID for the component is HY_CRC.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
HY_CRC+COM_SWI_MN | Main switching command | Value which describes the "on mode" of main switching command pin, especially for multi-state variables | dimensionless-quantities |
HY_CRC+CTRL_SV_UP_C | Cooling limit | Cooling limit based on ambient temperature, if ambient temperature is below cooling limit the circuit turns off | temperature |
HY_CRC+CTRL_SV_UP_H | Heating limit | Heating limit based on ambient temperature, if ambient temperature is above heating limit the circuit turns off | temperature |
HY_CRC+EN_C | Cooling energy | Measured cooling energy consumed by the cooling circuit | energy |
HY_CRC+EN_H | Heating energy | Measured heating energy consumed by the heating circuit | energy |
HY_CRC+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm, 0 = no alarm | dimensionless-quantities |
HY_CRC+MSG_OPR | Operating message | Informs about operational state of component: 1 = operating, 0 = switched-off | dimensionless-quantities |
HY_CRC+MSG_RELE | Release message | Informs if the component is released: 1 = released, 0 = not released | dimensionless-quantities |
HY_CRC+MSG_REQ | Request message | Informs if the component is requested: 1 = requested, 0 = not requested | dimensionless-quantities |
HY_CRC+OPR_MOD | Operation mode feedback | Allows to adapt the value of neutral mode | dimensionless-quantities |
HY_CRC+OPR_MOD_SW_AUTO | Operation mode automatic switch | Switch for the operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
HY_CRC+POW_C | Cooling power | Measured cooling power consumed by the cooling circuit | power |
HY_CRC+POW_H | Heating power | Measured heating power consumed by the heating circuit | power |
HY_CRC+PU+CTRL | Pump - operation control signal | Value representing the pump control signal or pump speed | frequency |
HY_CRC+PU+MSG_OPR | Pump - operating message | Operational state of the pump: 1 = operating, 0 = switched-off | dimensionless-quantities |
HY_CRC+PU+MSG_OPR_C | Cooling pump - operating message | Operational state of the cooling pump: 1 = operating, 0 = switched-off | dimensionless-quantities |
HY_CRC+PU+MSG_OPR_H | Heating pump - operating message | Operational state of the heating pump: 1 = operating, 0 = switched-off | dimensionless-quantities |
HY_CRC+T_AIR_ODA | Outside air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | temperature |
HY_CRC+T_IN_C | Cooling supply temperature | Temperature of the fluid entering the cooling circuit | temperature |
HY_CRC+T_IN_H | Heating supply temperature | Temperature of the fluid entering the heating circuit | temperature |
HY_CRC+T_IN_SP_C | Cooling supply temperature setpoint | Setpoint for the minimum supply temperature of the cooling circuit | temperature |
HY_CRC+T_IN_SP_C_MAX | Cooling supply temperature setpoint maximum | Setpoint for the maximum supply temperature of the cooling circuit | temperature |
HY_CRC+T_IN_SP_C_MIN | Cooling supply temperature setpoint minimum | Setpoint for the minimum supply temperature of the cooling circuit | temperature |
HY_CRC+T_IN_SP_H | Heating supply temperature setpoint | Setpoint for the minimum supply temperature of the heating circuit | temperature |
HY_CRC+T_IN_SP_H_MAX | Heating supply temperature setpoint maximum | Setpoint for the maximum supply temperature of the heating circuit | temperature |
HY_CRC+T_IN_SP_H_MIN | Heating supply temperature setpoint minimum | Setpoint for the minimum supply temperature of the heating circuit | temperature |
HY_CRC+T_OUT_C | Cooling return temperature | Temperature of the fluid leaving the cooling circuit | temperature |
HY_CRC+T_OUT_H | Heating return temperature | Temperature of the fluid leaving the heating circuit | temperature |
HY_CRC+T_SRC_C | Cool water temperature | Temperature of the water coming from the cooling source | temperature |
HY_CRC+T_SRC_H | Hot water temperature | Temperature of the water coming from the heat source | temperature |
HY_CRC+VAL_POS_C | Cooling valve position | Actual position of cooling valve opening 0 = fully closed, 100 = fully opened | dimensionless-quantities |
HY_CRC+VAL_POS_H | Heating valve position | Actual position of heating valve opening 0 = fully closed, 100 = fully opened | dimensionless-quantities |
HY_CRC+VAL_POS_SP_C | Cooling Valve control signal | Control signal of the cooling valve 0 = fully closed, 100 = fully opened | dimensionless-quantities |
HY_CRC+VAL_POS_SP_H | Heating valve control signal | Control signal of the heating valve 0 = fully closed, 100 = fully opened | dimensionless-quantities |
HY_CRC+VF_C | Cooling volume flow | Volume flow of the cooling circuit | volumetric-flow-rate |
HY_CRC+VF_H | Heating volume flow | Volume flow of the heating circuit | volumetric-flow-rate |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
HY_CRC+CC_BP | Heating curve - base points | Defines the base points for the piecewise linear heating curve, as values seperated by comma, pairs seperated by semicolon. | string | None | degrees-celsius |
HY_CRC+COM_SWI_MN_OFF | Main switching command - off | Value which describes the "off mode" of main switching command pin, especially for multi-state variables | float | None | generic |
HY_CRC+COM_SWI_MN_ON | Main switching command - on | Value which describes the "on mode" of main switching command pin, especially for multi-state variables | float | None | generic |
HY_CRC+LINK | Link | Hyperlink to external resources | link | None | generic |
HY_CRC+NIG_REDU | Heating curve - night time reduction | The night reduction that will be applied to the calculated set point from the heating curve | float | 0 | degrees-celsius |
HY_CRC+NOM_POW_C | Nominal cooling power | Cooling power at design conditions | float | None | kilowatts |
HY_CRC+NOM_POW_H | Nominal heating power | Heating power at design conditions | float | None | kilowatts |
HY_CRC+NOM_VF_C | Nominal cooling volume flow | Volume flow at design conditions | float | None | cubic-meters-per-hour |
HY_CRC+NOM_VF_H | Nominal heating volume flow | Volume flow at design conditions | float | None | cubic-meters-per-hour |
HY_CRC+OPR_MOD_C | Operation mode - cooling | Allows to adapt the value of cooling mode | float | None | generic |
HY_CRC+OPR_MOD_H | Operation mode - heating | Allows to adapt the value of heating mode | float | None | generic |
HY_CRC+OPR_MOD_N | Operation mode - neutral | Allows to adapt the value of neutral mode | float | None | generic |
HY_CRC+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | json | None | generic |
HY_CRC+SHD_TIMZ | Schedule timezone | Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | generic |
HY_CRC+WASP.NIG_RAI | WASP .controls App - cooling limit nighttime raise | The night raise that will be applied to the cooling limit | float | 0 | degrees-celsius |
HY_CRC+WASP.NIG_REDU | WASP .controls App - heating limit nighttime reduction | The night reduction that will be applied to the heating limit | float | 0 | degrees-celsius |
Lighting system¶
Category: Electrical systems
The alphanumeric ID for the component is LIG.
No analysis available.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
LIG+EN_EL_CONSUM | Energy consumption | None | energy |
LIG+POW_EL_CONSUM | Power consumption | None | power |
LIG+STAT_OPR | Operational state | None | dimensionless-quantities |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
LIG+LINK | Link | Hyperlink to external resources | link | None | generic |
Recooling plant¶
Category: Cooling
The Recooling Plant component represents a generic plant that transfers excess heat to the environment. The alphanumeric ID for the component is PLNT_C_RE.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
PLNT_C_RE+EN_C | Cooling energy | Measured cooling energy of the recooling plant | energy |
PLNT_C_RE+EN_EL | Electrical energy | Electrical energy counter of the recooling plant | energy |
PLNT_C_RE+FAN+MSG_OPR | Fan - operating message | Informs about operational state of the fan 1 = operating, 0 = switched-off | dimensionless-quantities |
PLNT_C_RE+FAN+SPE | Speed - fan | Current fan speed in relation to the nominal speed of the fan | dimensionless-quantities |
PLNT_C_RE+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm, 0 = no alarm | dimensionless-quantities |
PLNT_C_RE+MSG_OPR | Operating message | Informs about operational state of component 1 = operating, 0 = switched-off | dimensionless-quantities |
PLNT_C_RE+MSG_RELE | Release message | Informs if the component is released: 1 = released, 0 = not released | dimensionless-quantities |
PLNT_C_RE+MSG_REQ | Request message | Informs if the component is requested: 1 = requested, 0 = not requested | dimensionless-quantities |
PLNT_C_RE+OPR_MOD | Operation mode feedback | Operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
PLNT_C_RE+OPR_MOD_SW_AUTO | Operation mode automatic switch | Switch for the operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
PLNT_C_RE+POW_C | Cooling power | Measured cooling power of the recooling plant | power |
PLNT_C_RE+POW_EL | Electrical power | Electrical power consumption of the recooling plant | power |
PLNT_C_RE+T_AIR_ODA | Outside air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | temperature |
PLNT_C_RE+T_IN | Return temperature | Temperature of carrier fluid entering the recooling plant. | temperature |
PLNT_C_RE+T_OUT | Supply temperature | Temperature of carrier fluid leaving the recooling plant. | temperature |
PLNT_C_RE+VF | Volume flow | Volume flow of carrier fluid (water) on secondary side | volumetric-flow-rate |
PLNT_C_RE+VOL_WS | Water quantity | Counter for volume of used water in the recooling plant | dimensionless-quantities |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
PLNT_C_RE+C_T_RET_DSG | Cooling - design return temperature | Return temperature at maximum load during cooling operation. | float | 50.0 | degrees-celsius |
PLNT_C_RE+C_T_SPR_MIN_DSG | Cooling - minimal temperature spread | Minimal expected temperature spread for cooling mode. | float | 2.0 | delta-degrees-celsius |
PLNT_C_RE+C_T_SUP_DSG | Cooling - design supply temperature | Supply temperature at maximum load during cooling operation. | float | 44.0 | degrees-celsius |
PLNT_C_RE+H_T_RET_DSG | Heating - design return temperature | Return temperature at maximum load during heating operation. | float | 10.0 | degrees-celsius |
PLNT_C_RE+H_T_SPR_MIN_DSG | Heating - minimal temperature spread | Minimal expected temperature spread for heating mode. | float | 2.0 | delta-degrees-celsius |
PLNT_C_RE+H_T_SUP_DSG | Heating - design supply temperature | Supply temperature at maximum load during heating operation. | float | 16.0 | degrees-celsius |
PLNT_C_RE+LINK | Link | Hyperlink to external resources | link | None | generic |
Room¶
Category: Room automation
The Room component data model is the basic component model for rooms. The alphanumeric ID for the component is ROOM.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
ROOM+AED_CTRL_ACT | AI controls active | The operational state of an aedifion .controls app | dimensionless-quantities |
ROOM+CO2 | CO2 | CO2 concentration in the room air. | dimensionless-quantities |
ROOM+CO2_SP | CO2 setpoint | Setpoint for CO2 concentration in the room air. | dimensionless-quantities |
ROOM+COM_SWI_MN | Main switching command | Value which describes the "on mode" of main switching command pin, especially for multi-state variables | dimensionless-quantities |
ROOM+C_VAL_POS | Valve position - cooling | Actual opening position of the cooling valve 0 = fully closed, 100 = fully opened | dimensionless-quantities |
ROOM+EXH_AIR_VAL_POS | Volume flow controller position - return air | Actual opening position of return air damper 0 = fully closed, 100 = fully opened | dimensionless-quantities |
ROOM+EXH_AIR_VF | Volume flow - return air | Room return air volume flow | volumetric-flow-rate |
ROOM+EXH_AIR_VF_SP | Volume flow setpoint - return air | Setpoint of the return air volume flow exiting the room | volumetric-flow-rate |
ROOM+HUM_REL | Relative room air humidity | Relative humidity of indoor air | dimensionless-quantities |
ROOM+HUM_REL_ODA | Outside air relative humidity | Outside air relative humidity, datapoint can be mapped from a weather station on site | dimensionless-quantities |
ROOM+H_VAL_POS | Valve position - heating | Actual opening position of the heating valve 0 = fully closed, 100 = fully opened | dimensionless-quantities |
ROOM+LI_MSG_OPR | Lighting operating message | Operating message of the lighting system of the room 1 = switched-on, 0 = switched-off | dimensionless-quantities |
ROOM+MSG_DP_ALARM | Dew point alarm message | Alarm which indicates a high risk of condensation | dimensionless-quantities |
ROOM+MSG_OPR | Operating message | Operating message of room control 1 = operating, 0 = switched-off | dimensionless-quantities |
ROOM+PRES | Presence | Presence of one or more persons inside the room 1 = presence, 0 = no presence | dimensionless-quantities |
ROOM+SUN_POS | Sunlight protection - position | Position of the sun protection to decrease the entry of solar radiation into the room | dimensionless-quantities |
ROOM+SUP_AIR_VAL_POS | Volume flow controller position - supply air | Actual opening position of supply air damper 0 = fully closed, 100 = fully opened | dimensionless-quantities |
ROOM+SUP_AIR_VF | Volume flow - supply air | Room supply air volume flow | volumetric-flow-rate |
ROOM+SUP_AIR_VF_SP | Volume flow setpoint - supply air | Setpoint of the supply air volume flow entering the room | volumetric-flow-rate |
ROOM+T_AIR | Room air temperature | Inside air temperature in the room | temperature |
ROOM+T_AIR_ODA | Outside air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | temperature |
ROOM+T_AIR_SP | Room air temperature setpoint (calculated) | Default room temperature setpoint of the room | temperature |
ROOM+T_AIR_SP_ADJ | Temperature setpoint adjustment | It's used as an indication for the room temperature desired by the user. The adjustment is a temperature delta that is added to the basis setpoint. | temperature |
ROOM+T_AIR_SP_BASE | Room air temperature base setpoint | Setpoint for the air temperature inside a room. Typically used in conjunction with setpoint adjustment. | temperature |
ROOM+T_AIR_SP_C | Temperature setpoint cooling | Air temperature setpoint for room operating mode cooling | temperature |
ROOM+T_AIR_SP_H | Temperature setpoint heating | Air temperature setpoint for room operating mode heating | temperature |
ROOM+T_COMF_T_AIR | Comfort temperature | Comfort temperature for the room used by the thermal comfort analysis | temperature |
ROOM+WIN_POS | Window opening | Position of the window 0 = closed, 1 = opened | dimensionless-quantities |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
ROOM+AR | Area | Area of the room | float | None | square-meters |
ROOM+AV_SAL | Average salary | Average hourly salary of employees in the room. | float | None | euro |
ROOM+CALC_SATI | Calculation of user satisfaction | "True" if this room should be used in the calculation the wellbeing analysis function, "False" if this room should not be used | boolean | False | generic |
ROOM+CO2_SIG_COL_R | Room air quality red limit | Overwrites the red limit for the room air quality analysis | float | 1500.0 | parts-per-million |
ROOM+CO2_SIG_COL_Y | Room air quality yellow limit | Overwrites the yellow limit for the room air quality analysis | float | 750.0 | parts-per-million |
ROOM+CO2_SP_DEV_TOL | CO2 setpoint deviation tolerance | Tolerance for deviation of actual CO2 concentration from setpoint. | float | 0 | parts-per-million |
ROOM+COM_SWI_MN_OFF | Main switching command - off | Value which describes the "off mode" of main switching command pin, especially for multi-state variables | float | None | generic |
ROOM+COM_SWI_MN_ON | Main switching command - on | Value which describes the "on mode" of main switching command pin, especially for multi-state variables | float | None | generic |
ROOM+CUS_DAY_SHD | Custom day schedules | Overwrites basic schedule for specific days with an individual schedule. The JSON is flexibly expandable for any number of days. | json | None | generic |
ROOM+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | json | None | generic |
ROOM+EXH_AIR_VF_SP_DEV_TOL | Return air volume flow setpoint deviation tolerance | Tolerance for deviation of the volume flow from the return air volume flow control signal. | float | 10 | cubic-meters-per-hour |
ROOM+LINK | Link | Hyperlink to external resources | link | None | generic |
ROOM+OCC_MAX | Maximum occupation of the room | Maximum number of people in the room. | float | None | generic |
ROOM+ORC.T_AIR_ADJ_LIM | ORC .controls App - temperature offset limit | Maximum temperature offset for the ORC .controls App | float | None | degrees-celsius |
ROOM+ORC.T_AIR_TIM_LIM | ORC .controls App - time limit | Time limit for the ORC .controls App | float | None | seconds |
ROOM+PEO_COUNT | People in the room | Expected number of people in room | float | None | generic |
ROOM+PRECON | Pre-conditioning period | Adds a preconditioning period to the start time of the schedule. Operation before the start time is therefore evaluated as intended within the additional preconditioning time. | float | 0 | hours |
ROOM+RAQ_CO2_LOW | CO2 curve - lower point 2 CO2 | Adjusts the target CO2 value at the lower point 2 of the CO2 curve | float | 2000.0 | parts-per-million |
ROOM+RAQ_CO2_UPP | CO2 curve - upper point 1 CO2 | Adjusts the target CO2 value at the upper point 1 of the CO2 curve | float | 500.0 | parts-per-million |
ROOM+RAQ_PERC_LOW | CO2 curve - lower point 2 percent | Adjusts the target percentage value at the lower point 2 of the CO2 curve | float | 0.0 | generic |
ROOM+RAQ_PERC_UPP | CO2 curve - upper point 1 percent | Adjusts the target percentage value at the upper point 1 of the CO2 curve | float | 1 | generic |
ROOM+RAQ_TIME_PERC | Percentage time for room air quality calculation | Percentile of normalised time at which the CO2 value of the ordered and corrected time series is used to calculate the overall air quality | float | 0.015 | generic |
ROOM+REG_KEY | Regional holiday key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE | generic |
ROOM+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | json | None | generic |
ROOM+SHDO_FLX | Shutdown flexibility | Adds a shutdown flexibility to the end time of the schedule. Operation before the schedule end time is therefore evaluated as unintended during the shutdown flexibility. | float | 0 | hours |
ROOM+SHD_TIMZ | Schedule timezone | Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | generic |
ROOM+SUP_AIR_VF_SP_DEV_TOL | Supply air volume flow setpoint deviation tolerance | Tolerance for deviation of the volume flow from the supply air volume flow control signal. | float | 10 | cubic-meters-per-hour |
ROOM+TH_COMF_EVL_THR | Thermal comfort evaluation threshold in hours per week | Maximum time that the room temperature can be above or below the cut-off temperature limits before the signal color turns red. | float | 4.0 | hours |
ROOM+TH_COMF_SIG_COLO_R | Thermal comfort red limit | Overwrites the red limit for the thermal comfort analysis. | float | 3.0 | kelvin |
ROOM+TH_COMF_SIG_COLO_Y | Thermal comfort yellow limit | Overwrites the yellow limit for the thermal comfort analysis. | float | 1.5 | kelvin |
ROOM+TYP | Type of the room | Type of the room to get an estimation of the percentual occupation based on E DIN EN 16798 and in combination with pins "Presence" or "Operating message". If the calculations should only be based on pins "Presence" or "Operating Message" without any reductions, enter "24/7-full-occupancy". | enum | None | generic |
ROOM+T_AIR_LIM_LOW | Lower limit for room temperature | lower cut-off temperature limit, which triggers a red signal color if fallen short of for a certain amount of time. | float | None | degrees-celsius |
ROOM+T_AIR_LIM_UPP | Upper limit for room temperature | Upper cut-off temperature limit, which triggers a red signal color if exceeded for a certain amount of time. | float | None | degrees-celsius |
ROOM+T_AIR_SP_DFLT | Default room temperature setpoint | Default room temperature setpoint of the room | float | None | degrees-celsius |
ROOM+T_COMF_LOW_T_AIR | Comfort temperature curve - lower point 1 Room temperature | Adjusts the value for the outside air temperature at the lower point 1 of the comfort temperature curve. | float | 22.0 | degrees-celsius |
ROOM+T_COMF_LOW_T_AIR_ODA | Comfort temperature curve - lower point 1 outside air temperature | Adjusts the value for the outside air temperature at the lower point 1 of the comfort temperature curve. | float | 16.0 | degrees-celsius |
ROOM+T_COMF_UPP_T_AIR | Comfort temperature curve - upper point 2 Room temperature | Adjusts the value for the outside air temperature at the upper point 2 of the comfort temperature curve. | float | 26.0 | degrees-celsius |
ROOM+T_COMF_UPP_T_AIR_ODA | Comfort temperature curve - upper point 2 outside air temperature | Adjusts the value for the outside air temperature at the upper point 2 of the comfort temperature curve. | float | 32.0 | degrees-celsius |
ROOM+T_SP_DEV_TOL | Temperature setpoint deviation tolerance | Tolerance for deviation of actual temperature from setpoint. | float | 2.5 | degrees-celsius |
System¶
Category: Miscellaneous
The System component represents a generic system. It is required to represent the status of equipment on the Status & Alerts. The alphanumeric ID for the component is S.
No analysis available.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
S+STAT_OPR | Operational state | Operational state according to aedifion multi-state definition | dimensionless-quantities |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
S+ICON | Icon | Icon string according to v5 of fontawesome.com | string | None | generic |
S+LINK | Link | URL link to support navigation to further resources | link | None | generic |
Thermal control loop¶
Category: Heating
The Thermal Control Loop component data model is representative of thermal control loops. It can be utilized to model thermal control loops of the conversion, distribution, and acceptance layer. The alphanumeric ID for the component is TH_CTRL_LOO.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
TH_CTRL_LOO+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm, 0 = no alarm | dimensionless-quantities |
TH_CTRL_LOO+MSG_OPR | Operating message | Informs about operational state of component 1 = operating, 0 = switched-off | dimensionless-quantities |
TH_CTRL_LOO+PU+COM_SWI | Pump - switching command | Command to switch the pump on or off | dimensionless-quantities |
TH_CTRL_LOO+PU+CTRL | Pump - operation control signal | Value representing the pump control signal or pump speed | frequency |
TH_CTRL_LOO+PU+CTRL_FB | Pump - operation position feedback | Feedback of the pump control signal or pump speed | frequency |
TH_CTRL_LOO+PU+MSG_OPR | Pump - operating message | Operating message of pump within the control loop 1 = operating, 0 = switched-off | dimensionless-quantities |
TH_CTRL_LOO+T_IN | Inlet temperature | Temperature of heat carrier fluid (water, brine) entering the control loop. Also referred to as uncontrolled supply temperature of the control loop | temperature |
TH_CTRL_LOO+T_OUT | Outlet temperature | Temperature of heat carrier fluid (water, brine) exiting the control loop. Also referred to as controlled supply temperature, or consumer supply temperature. | temperature |
TH_CTRL_LOO+T_OUT_SP | Outlet temperature setpoint | Setpoint temperature of heat carrier fluid (water, brine) exiting the control loop. Also referred to as setpoint of supply temperature. | temperature |
TH_CTRL_LOO+T_RCA | Inlet temperature recirculation | Temperature of heat carrier fluid (water, brine) returning from consumer circuit. Also referred to as consumer return temperature and modeled as inlet temperature recirculation | temperature |
TH_CTRL_LOO+VAL_POS | Valve position | Tolerance for deviation of the valve position from the valve control signal. | dimensionless-quantities |
TH_CTRL_LOO+VAL_POS_SP | Valve control signal | Tolerance for deviation of the valve position from the valve control signal. | dimensionless-quantities |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
TH_CTRL_LOO+CUS_DAY_SHD | Custom day schedules | Overwrites basic schedule for specific days with an individual schedule. The JSON is flexibly expandable for any number of days. | json | None | generic |
TH_CTRL_LOO+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | json | None | generic |
TH_CTRL_LOO+LINK | Link | Hyperlink to external resources | link | None | generic |
TH_CTRL_LOO+PRECON | Pre-conditioning period | Adds a preconditioning period to the start time of the schedule. Operation before the start time is therefore evaluated as intended within the additional preconditioning time. | float | 0 | minutes |
TH_CTRL_LOO+REG_KEY | Regional holiday key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE | generic |
TH_CTRL_LOO+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | json | None | generic |
TH_CTRL_LOO+SHDO_FLX | Shutdown flexibility | Adds a shutdown flexibility to the end time of the schedule. Operation before the schedule end time is therefore evaluated as unintended during the shutdown flexibility. | float | 0 | minutes |
TH_CTRL_LOO+SHD_TIMZ | Schedule timezone | Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | generic |
TH_CTRL_LOO+T_OUT_SP_DEV_TOL | Outlet temperature setpoint deviation tolerance | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | degrees-celsius |
TH_CTRL_LOO+VAL_POS_SP_DEV_TOL | Valve position setpoint deviation tolerance | Tolerance for deviation of the valve position from the valve control signal. | float | 10.0 | percent |
TH_CTRL_LOO+VAL_THR | Valve threshold | For specific analysis functions it's important to know above what valve position the feeding pump should start to operate. | float | 5 | percent |
TH_CTRL_LOO+VAL_TYP | Valve type | For specific analysis functions it's important to know what kind of valve is used to regulate the outlet temperature. If required you can choose between a 2-way valve and a 3-way valve with this attribute. | enum | 3-way-valve | generic |
Thermal energy storage¶
Category: Cooling
The Thermal Energy Storage component represents a generic thermal storage for warm or cold water. The alphanumeric ID for the component is STO_TH.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
STO_TH+MSG_RELE | Release message | Informs if the component is released: 1 = released, 0 = not released | dimensionless-quantities |
STO_TH+MSG_REQ | Request message | Informs if the component is requested: 1 = requested, 0 = not requested | dimensionless-quantities |
STO_TH+OPR_MOD | Operation mode feedback | Operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
STO_TH+OPR_MOD_SW_AUTO | Operation mode automatic switch | Switch for the operation mode of the system, e.g. 'emergency off', 'off', 'on', 'freezing' | dimensionless-quantities |
STO_TH+PRIM+PU+MSG_OPR | Pump - operating message - primary | Informs about operational state of the pump on the charging side of the, tank 1 = operating, 0 = switched-off | dimensionless-quantities |
STO_TH+SEC+PU+MSG_OPR | Pump - operating message - secondary | Informs about operational state of the pump on discharging side of the tank 1 = operating, 0 = switched-off | dimensionless-quantities |
STO_TH+T_AIR_ODA | Outside air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | temperature |
STO_TH+T_STO_LOW | Lower storage temperature | Measurement point for the water temperature inside the tank at the lowest location | temperature |
STO_TH+T_STO_UPP | Upper storage temperature | Measurement point for the water temperature inside the tank at the highest location | temperature |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
STO_TH+LINK | Link | Hyperlink to external resources | link | None | generic |
Waste meter¶
Category: Miscellaneous
The alphanumeric ID for the component is WASTM.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
WASTM+MA | Cumulated weight | Amount of waste accumulated. | mass |
WASTM+MF | Average mass flow rate | Mass flow rate of waste. | mass-flow |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
WASTM+DATA_SRC | Data source | Define how the data for pins of this component was written into the database. | string | system | generic |
WASTM+LINK | Link | Hyperlink to external resources | link | None | generic |
WASTM+M_NUM | ID number | Meter number used for billing and identification purposes. | string | None | generic |
Water meter¶
Category: Miscellaneous
The Water Meter is a component model that represents the measurement of volumes and volume flows of water. The alphanumeric ID for the component is WSM.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
WSM+VF | Volume flow | Volume flow of water | volumetric-flow-rate |
WSM+VOL | Water quantity | Increasing volume counter for gas consumption | volume |
WSM+VOL_INV | Water quantity per interval | Measured water quantity within the interval | volume |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
WSM+DATA_SRC | Data source | Define how the data for pins of this component was written into the database. | string | system | generic |
WSM+LINK | Link | Hyperlink to external resources | link | None | generic |
WSM+M_NUM | Meter number | Meter number used for billing and identification purposes. | string | None | generic |
Weather station¶
Category: Miscellaneous
The Weather Station component data model links weather sensors and correlating data points. The alphanumeric ID for the component is WST.
| alphanumeric_id | Name | Description | Unit type |
|---|---|---|---|
WST+HUM_REL_AIR_ODA | Outside air relative humidity | Relative humidity of outside air | dimensionless-quantities |
WST+REFE_HUM_REL_AIR_ODA | Reference outside air relative humidity | Reference relative humidity from online databases which is used for outdoor air relative humidity sensor checkup | dimensionless-quantities |
WST+REFE_T_AIR_ODA | Reference outside air temperature | Reference temperature from online databases which is used for outdoor air temperature sensor checkup | temperature |
WST+T_AIR_ODA | Outside air temperature | Temperature of outside air | temperature |
| alphanumeric_id | Name | Description | Type | Default Value | Default Unit |
|---|---|---|---|---|---|
WST+ANA | analytics basis | Select the weather station that is considered in analytics calculations | boolean | True | generic |
WST+LAT | Latitude | Geographical latitude of weather station. This attribute will be deprecated in the future. | float | None | generic |
WST+LINK | Link | Hyperlink to external resources | link | None | generic |
WST+LON | Longitude | Geographical longitude of weather station. This attribute will be deprecated in the future. | float | None | generic |
Information¶
The library of component data models is constantly expanding. If you are missing a component data model, or want us to implement it for you, feel free to contact us.