Component data 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 datapoints and metadata of building equipment. To create such a virtual twin, a component data model gets added to a specific project, and datapoints and metadata get mapped to its pins (placeholders for datapoints) 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.
Available component data models¶
- Air cooler
- Air heater
- Boiler
- Combined heat and power
- Compression chiller
- Cooling circuit
- Electricity meter
- Fan
- Filter
- Gas meter
- Heat meter
- Heat pump
- Heat transfer unit
- Heating circuit
- Humidity conditioner
- Recooling plant
- Room
- Thermal control loop
- Thermal energy storage
- 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: To this state, our algorithms are unit sensitive. Every pin and attribute is specified with a unit. Mind the specifications.
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¶
The Air cooler component represents generic air coolers that use water as the cooling medium. The alphanumeric ID for the component Air cooler is C_CM.
Mind the units.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
C_CM+C_CRC+EN_C | Cooling energy - water side | Measured cooling energy of the cooling circuit | default: MWh use component attribute to adjust |
C_CM+C_CRC+POW_C | Cooling power - water side | Measured cooling power of the cooling circuit | default: kW use component attribute to adjust |
C_CM+T_AIR_IN | Inlet air temperature | Temperature of the air entering the air cooler | °C |
C_CM+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
C_CM+T_AIR_ODA | Outdoor air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | °C |
C_CM+T_AIR_OUT | Outlet air temperature | Temperature of the air exiting the air cooler | °C |
C_CM+C_CRC+PU+MSG_OPR | Pump operating message | Operational state of the pump: 1 = operating 0 = switched-off | binary |
C_CM+C_CRC+T_OUT | Return temperature - water side | Temperature of the fluid exiting the cooling circuit of the air cooler | °C |
C_CM+C_CRC+T_IN | Supply temperature - water side | Temperature of the fluid entering the cooling circuit of the air cooler | °C |
C_CM+C_CRC+VAL_POS_SP | Valve control signal | Control signal of the valve 0 = fully closed 100 = fully opened | % |
C_CM+C_CRC+VAL_POS | Valve position | Actual position of valve opening 0 = fully closed 100 = fully opened | % |
C_CM+C_CRC+VF | Volume flow - water side | Volume flow of heat carrier fluid (water) | default: l/s use component attribute to adjust |
| alphanumeric_id | Name | Info | Type | Example Value | Unit |
|---|---|---|---|---|---|
C_CM+U_EN_C | Cooling energy unit - water side | Allows to adapt the unit of the cooling energy pin. | string | Allowed values: Wh; kWh; MWh; GWh | |
C_CM+U_POW_C | Cooling power unit - water side | Allows to adapt the unit of the cooling power pin. | string | Allowed values: W; kW; MW; GW | |
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 | {"2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"}} | |
C_CM+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | JSON | ["2020-01-02", "2020-01-28", "2020-04-07"] | |
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 | 30.0 | min |
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-NW | |
C_CM+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | JSON | {"Mon":{"start":"10:00", "end":"20:00"},"Tue":{"start":"10:00", "end":"20:00"},"Wed":{"start":"10:00", "end":"20:00"}, "Thu":{"start":"10:00", "end":"20:00"},"Fri":{"start":"10:00", "end":"20:00"},"Sat":{"start":"10:00", "end":"20:00"},"Sun":{"start":"10:00","end":"20:00"}} | |
C_CM+SHD_TIMZ | Schedule timezone | Default: UTC. Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | |
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 | 30.0 | min |
C_CM+VAL_POS_SP_DEV_TOL | Valve position setpoint deviation tolerance | Tolerance for deviation of the valve position from the valve control signal. | float | 10 | % |
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. This is currently only used for 3-way valves. | float | 5 | % |
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. | string | Allowed values: "2-way valve"; "3-way valve" | |
C_CM+U_VF | Volume flow unit - water side | Allows to adapt the unit of the volume flow pin. | string | Allowed values: litersPerSecond; litersPerMinute; litersPerHour; cubicMetersPerSecond; cubicMetersPerMinute; cubicMetersPerHour |
Air heater¶
The Air heater component represents generic air heaters that use water as the heating medium. The alphanumeric ID for the component Air heater is H_CM.
Mind the units.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
H_CM+H_CRC+EN_H | Heating energy - water side | Measured heating energy of the heating circuit | default: MWh use component attribute to adjust |
H_CM+H_CRC+POW_H | Heating power - water side | Measured heating power of the heating circuit | default: kW use component attribute to adjust |
H_CM+T_AIR_IN | Inlet air temperature | Temperature of the air entering the air heater | °C |
H_CM+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
H_CM+T_AIR_ODA | Outdoor air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | °C |
H_CM+T_AIR_OUT | Outlet air temperature | Temperature of the air exiting the air heater | °C |
H_CM+H_CRC+PU+MSG_OPR | Pump operating message | Operational state of the pump: 1 = operating 0 = switched-off | binary |
H_CM+H_CRC+T_OUT | Return temperature - water side | Temperature of the fluid exiting the heating circuit of the air heater | °C |
H_CM+H_CRC+T_IN | Supply temperature - water side | Temperature of the fluid entering the heating circuit of the air heater | °C |
H_CM+H_CRC+VAL_POS_SP | Valve control signal | Control signal of the valve 0 = fully closed 100 = fully opened | % |
H_CM+H_CRC+VAL_POS | Valve position | Actual position of valve opening 0 = fully closed 100 = fully opened | % |
H_CM+H_CRC+VF | Volume flow - water side | Volume flow of heat carrier fluid (water) | default: l/s use component attribute to adjust |
| alphanumeric_id | Name | Info | Type | Example Value | 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 | {"2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"}} | |
H_CM+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | JSON | ["2020-01-02", "2020-01-28", "2020-04-07"] | |
H_CM+U_EN_H | Heating energy unit - water side | Allows to adapt the unit of the heating energy pin. | string | Allowed values: Wh; kWh; MWh; GWh | |
H_CM+U_POW_H | Heating power unit - water side | Allows to adapt the unit of the heating power pin. | string | Allowed values: W; kW; MW; GW | |
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 | 30.0 | min |
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-NW | |
H_CM+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | JSON | {"Mon":{"start":"10:00", "end":"20:00"},"Tue":{"start":"10:00", "end":"20:00"},"Wed":{"start":"10:00", "end":"20:00"}, "Thu":{"start":"10:00", "end":"20:00"},"Fri":{"start":"10:00", "end":"20:00"},"Sat":{"start":"10:00", "end":"20:00"},"Sun":{"start":"10:00","end":"20:00"}} | |
H_CM+SHD_TIMZ | Schedule timezone | Default: UTC. Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | |
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 | 30.0 | min |
H_CM+VAL_POS_SP_DEV_TOL | Valve position setpoint deviation tolerance | Tolerance for deviation of the valve position from the valve control signal. | float | 10 | % |
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. This is currently only used for 3-way valves. | float | 5 | % |
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. | string | Allowed values: "2-way valve"; "3-way valve" | |
H_CM+U_VF | Volume flow unit - water side | Allows to adapt the unit of the volume flow pin. | string | Allowed values: litersPerSecond; litersPerMinute; litersPerHour; cubicMetersPerSecond; cubicMetersPerMinute; cubicMetersPerHour |
Boiler¶
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 Boiler is BOI.
Mind the units.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
BOI+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm 0 = no alarm | binary |
BOI+EN_H | Heating energy | Measured heating energy delivered by boiler to heating loop | default: MWh |
BOI+POW_H | Heating power | Measured heating power delivered by boiler to heating loop | default: kW |
BOI+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
BOI+PU+MSG_OPR | Pump operating message | Operational state of the pump: 1 = operating 0 = switched-off | binary |
BOI+RATE_FUEL_CONSUM | Rate of fuel consumption | Measured fuel consumption of the device | default: kW |
BOI+T_IN | Return temperature | Temperature of heat carrier fluid (water) entering the component. | °C |
BOI+T_OUT | Supply temperature | Temperature of heat carrier fluid (water) exiting the component. | °C |
BOI+T_OUT_SP | Supply temperature setpoint | Setpoint temperature of heat carrier fluid ( water) exiting the component. | °C |
BOI+VF | Volume flow | Volume flow of heat carrier fluid (water) | default: l/s use component attribute to adjust |
| alphanumeric_id | Name | Info | Type | Example Value | Unit |
|---|---|---|---|---|---|
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 | {"2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"}} | |
BOI+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | JSON | ["2020-01-02", "2020-01-28", "2020-04-07"] | |
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 | - |
BOI+PRIC_FUEL | Fuel price | Price of the used fuel. | float | 0.06 | €/kWh |
BOI+U_EN_H | Heating energy unit | Allows to adapt the unit of the heating energy pin. | string | Allowed values: Wh; kWh; MWh; GWh | |
BOI+U_POW_H | Heating power unit | Allows to adapt the unit of the heating power pin. | string | Allowed values: W; kW; MW; GW | |
BOI+H_NOM_PROD | Nominal heat production | Nominal heat production of the device. | float | 1200.0 | kW |
BOI+PRECON | Preconditioning | 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 | 30.0 | min |
BOI+REG_KEY | Regional key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE-NW | |
BOI+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | JSON | {"Mon":{"start":"10:00", "end":"20:00"},"Tue":{"start":"10:00", "end":"20:00"},"Wed":{"start":"10:00", "end":"20:00"}, "Thu":{"start":"10:00", "end":"20:00"},"Fri":{"start":"10:00", "end":"20:00"},"Sat":{"start":"10:00", "end":"20:00"},"Sun":{"start":"10:00","end":"20:00"}} | |
BOI+SHD_TIMZ | Schedule timezone | Default: UTC. Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | |
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 | 30.0 | min |
BOI+T_SP_DEV_TOL | Temperature setpoint deviation tolerance | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | °C |
BOI+PRIC_STUP | Start-up costs | The power specific costs of one start-up. | float | 0.01 | €/kW |
BOI+U_VF | Volume flow Unit | Allows to adapt the unit of the volume flow pin. | string | Allowed values: litersPerSecond; litersPerMinute; litersPerHour; cubicMetersPerSecond; cubicMetersPerMinute; cubicMetersPerHour |
Combined heat and power¶
The Combined heat and power component data model represents various kinds of combined heat and power generation. The alphanumeric ID for the component Combined heat and power is CHP.
Mind the units.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
CHP+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm 0 = no alarm | binary |
CHP+GEN+POW_EL | Generator power | Measured electricity output of the device | kW |
CHP+EN_H | Heating energy | Measured heating energy delivered by CHP to heating loop | MWh |
CHP+POW_H | Heating power | Measured heating power delivered by CHP to heating loop | kW |
CHP+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
CHP+PU+MSG_OPR | Pump operating message | Operational state of the pump: 1 = operating 0 = switched-off | binary |
CHP+RATE_FUEL_CONSUM | Rate of fuel consumption | Rate of fuel consumption of the device | kW |
CHP+T_IN | Return temperature | Temperature of heat carrier fluid (water) entering the component. | °C |
CHP+T_OUT | Supply temperature | Temperature of heat carrier fluid (water) exiting the component. | °C |
CHP+T_OUT_SP | Supply temperature setpoint | Setpoint temperature for heat carrier fluid ( water) exiting the component. | °C |
CHP+VF | Volume flow | Volume flow of heat carrier fluid (water) | default: l/s use component attribute to adjust |
| alphanumeric_id | Name | Info | Type | Example Value | Unit |
|---|---|---|---|---|---|
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 | {"2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"}} | |
CHP+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | JSON | ["2020-01-02", "2020-01-28", "2020-04-07"] | |
CHP+PRIC_EL | Electricity price | Price of the used electricity in the CHP. | float | 0.18 | €/kWh |
CHP+FUEL_UTIL_F | Fuel utilization 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 | 0.85 | - |
CHP+PRIC_FUEL | Fuel price | Price of the used fuel in the CHP. | float | 0.06 | €/kWh |
CHP+GEN+POW_NOM | Generator nominal power | Nominal power output of the generator from CHP. | float | 800 | kW |
CHP+U_EN_H | Heating energy unit | Allows to adapt the unit of the heating energy pin. | string | Allowed values: Wh; kWh; MWh; GWh | |
CHP+U_POW_H | Heating power unit | Allows to adapt the unit of the heating power pin. | string | Allowed values: W; kW; MW; GW | |
CHP+PRIC_H_EN | Heat price | Price of the used heat in the CHP. | float | €/kWh | 0,08 |
CHP+H_NOM_PROD | Nominal heat production | Nominal heat production of the device. | float | 1 | kW |
CHP+PRECON | Pre-conditioning period | Unit: minutes. 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 | 30.0 | min |
CHP+REG_KEY | Regional key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE-NW | |
CHP+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | JSON | {"Mon":{"start":"10:00", "end":"20:00"},"Tue":{"start":"10:00", "end":"20:00"},"Wed":{"start":"10:00", "end":"20:00"}, "Thu":{"start":"10:00", "end":"20:00"},"Fri":{"start":"10:00", "end":"20:00"},"Sat":{"start":"10:00", "end":"20:00"},"Sun":{"start":"10:00","end":"20:00"}} | |
CHP+SHD_TIMZ | Schedule timezone | Default: UTC. Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | |
CHP+SHDO_FLX | Shutdown flexibility | Unit: minutes. 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 | 30.0 | min |
CHP+PRIC_STUP | Start-up costs | The power specific costs of one start-up. | float | 0.02 | €/kW |
CHP+T_SP_DEV_TOL | Temperature setpoint deviation tolerance | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | °C |
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 | 0.45 | - |
CHP+U_VF | Volume flow unit | Allows to adapt the unit of the volume flow pin. | string | Allowed values: litersPerSecond; litersPerMinute; litersPerHour; cubicMetersPerSecond; cubicMetersPerMinute; cubicMetersPerHour |
Cooling circuit¶
The Cooling circuit component represents generic cooling circuits that can be found in buildings. The alphanumeric ID for the component Cooling circuit is C_CRC.
Mind the units.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
C_CRC+EN_C | Cooling energy | Measured cooling energy consumed by the cooling circuit | default: MWh use component attribute to adjust |
C_CRC+POW_C | Cooling power | Measured cooling power consumed by the cooling circuit | default: kW use component attribute to adjust |
C_CRC+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
C_CRC+T_AIR_ODA | Outdoor air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | °C |
C_CRC+PU+MSG_OPR | Pump operating message | Operational state of the pump: 1 = operating 0 = switched-off | binary |
C_CRC+T_OUT | Return temperature | Temperature of the fluid leaving the cooling circuit | °C |
C_CRC+T_IN | Supply temperature | Temperature of the fluid entering the cooling circuit | °C |
C_CRC+T_IN_SP | Supply temperature setpoint | Temperature setpoint of the fluid entering the cooling circuit | °C |
C_CRC+VAL_POS_SP | Valve control signal | Control signal of the valve 0 = fully closed 100 = fully opened | % |
C_CRC+VAL_POS | Valve position | Actual position of valve opening 0 = fully closed 100 = fully opened | % |
C_CRC+VF | Volume flow | Volume flow of heat carrier fluid (water) | default: l/s use component attribute to adjust |
| alphanumeric_id | Name | Info | Type | Example Value | Unit |
|---|---|---|---|---|---|
C_CRC+U_EN_C | Cooling energy unit | Allows to adapt the unit of the cooling energy pin. | string | Allowed values: Wh; kWh; MWh; GWh | |
C_CRC+U_POW_C | Cooling power unit | Allows to adapt the unit of the cooling power pin. | string | Allowed values: W; kW; MW; GW | |
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 | {"2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"}} | |
C_CRC+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | JSON | ["2020-01-02", "2020-01-28", "2020-04-07"] | |
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 | 30.0 | min |
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-NW | |
C_CRC+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | JSON | {"Mon":{"start":"10:00", "end":"20:00"},"Tue":{"start":"10:00", "end":"20:00"},"Wed":{"start":"10:00", "end":"20:00"}, "Thu":{"start":"10:00", "end":"20:00"},"Fri":{"start":"10:00", "end":"20:00"},"Sat":{"start":"10:00", "end":"20:00"},"Sun":{"start":"10:00","end":"20:00"}} | |
C_CRC+SHD_TIMZ | Schedule timezone | Default: UTC. Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | |
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 | 30.0 | min |
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. | string | Allowed values: "2-way valve"; "3-way valve" | |
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. This is currently only used for 3-way valves. | float | 5 | % |
C_CRC+T_OUT_SP_DEV_TOL | Supply temperature setpoint deviation tolerance | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | °C |
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 | % |
C_CRC+U_VF | Volume flow unit | Allows to adapt the unit of the volume flow pin. | string | Allowed values: litersPerSecond; litersPerMinute; litersPerHour; cubicMetersPerSecond; cubicMetersPerMinute; cubicMetersPerHour |
Compression chiller¶
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 Compression chiller is CH_COMP.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
CH_COMP+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm 0 = no alarm | binary |
CH_COMP+EVAP+EN_C | Cooling energy - evaporator | Measured cooling energy taken from heat source loop. | MWh |
CH_COMP+EVAP+POW_C | Cooling power - evaporator | Measured cooling power taken from heat source loop. | kW |
CH_COMP+POW_EL | Electrical power | Measured electrical power consumed by the device. | kW |
CH_COMP+COND+T_IN | Inlet temperature - condenser | Temperature of heat carrier fluid (water) entering the component. Condenser side. | °C |
CH_COMP+EVAP+T_IN | Inlet temperature - evaporator | Temperature of heat carrier fluid (water) entering the component. Evaporator side. | °C |
CH_COMP+OPR_TIM | Operating hours | Total hours of operation | h |
CH_COMP+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
CH_COMP+COND+PU+MSG_OPR | Operating message pump - condenser | Informs about operational state of the condenser pump 1 = operating 0 = switched-off | binary |
CH_COMP+EVAP+PU+MSG_OPR | Operating message pump - evaporator | Informs about operational state of the evaporator pump 1 = operating 0 = switched-off | binary |
CH_COMP+OPR_COUNT | Operating starts | Total number of starts | - |
CH_COMP+T_AIR_ODA | Outdoor air temperature | Outdoor air temperature | Outside air temperature, datapoint can be mapped from a weather station on site |
CH_COMP+COND+T_OUT | Outlet temperature - condenser | Temperature of heat carrier fluid (water) exiting the component. Condenser side. | °C |
CH_COMP+EVAP+T_OUT | Outlet temperature - evaporator | Temperature of heat carrier fluid (water) exiting the component. Evaporator side | °C |
CH_COMP+COND+T_OUT_SP | Outlet temperature setpoint - condenser | Setpoint temperature of heat carrier fluid (water) exiting the component. Condenser side. | °C |
CH_COMP+EVAP+T_OUT_SP | Outlet temperature setpoint - evaporator | Setpoint temperature of heat carrier fluid (water) exiting the component. Evaporator side | °C |
CH_COMP+EVAP+VF | Volume flow evaporator | Volume flow of heat carrier fluid (water). Evaporator side. | default: l/s use component attribute to adjust |
| alphanumeric_id | Name | Info | Type | Example Value | Unit |
|---|---|---|---|---|---|
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.5 | - |
CH_COMP+U_EN_C | Cooling energy unit | Allows to adapt the unit of the cooling energy pin. | string | Allowed values: Wh; kWh; MWh; GWh | |
CH_COMP+U_POW_C | Cooling power unit | Allows to adapt the unit of the cooling power pin. | string | Allowed values: W; kW; MW; GW | |
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 | {"2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"}} | |
CH_COMP+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | JSON | ["2020-01-02", "2020-01-28", "2020-04-07"] | |
CH_COMP+PRIC_EL | Electricity price | Price for used electricity. | float | 0.18 | €/kWh |
CH_COMP+C_NOM_PROD | Nominal cooling production | Nominal cooling production of the device. | float | 1200.0 | kW |
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 | °C |
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 | °C |
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 | 30.0 | min |
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-NW | |
CH_COMP+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | JSON | {"Mon":{"start":"10:00", "end":"20:00"},"Tue":{"start":"10:00", "end":"20:00"},"Wed":{"start":"10:00", "end":"20:00"}, "Thu":{"start":"10:00", "end":"20:00"},"Fri":{"start":"10:00", "end":"20:00"},"Sat":{"start":"10:00", "end":"20:00"},"Sun":{"start":"10:00","end":"20:00"}} | |
CH_COMP+SHD_TIMZ | Schedule timezone | Default: UTC. Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | |
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 | 30.0 | min |
CH_COMP+U_VF | Volume flow unit | Allows to adapt the unit of the volume flow pin. | string | Allowed values: litersPerSecond; litersPerMinute; litersPerHour; cubicMetersPerSecond; cubicMetersPerMinute; cubicMetersPerHour |
Electricity meter¶
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 Electricity meter is ELM.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
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. | MWh |
ELM+POW_EL_ACT | Active power | Electrical Power that is used for work. A typical electricity meter will record this as "electrical power". | kW |
ELM+EN_EL_REA | Reactive energy | Industry customers also have to pay for reactive energy. Reactive energy is recorded for large systems. | MVarh |
ELM+POW_EL_REA | Reactive power | The part of electrical power that is applied to compensate for high inductive loads. | kVar |
No attributes for this component.
Fan¶
The Fan component data model represents various kinds of fans. The alphanumeric ID for the component Fan is FAN.
Mind the units.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
FAN+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm 0 = no alarm | binary |
FAN+POW_EL | Electrical power | Measurement of electrical power | kW |
FAN+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
FAN+P_DIF | Pressure difference | Pressure difference over the fan | Pa |
FAN+P_DIF_SP | Pressure difference setpoint | Setpoint of the pressure difference over the fan | Pa |
FAN+SPE | Speed | Current fan speed in relation to the nominal speed of the fan | % |
| alphanumeric_id | Name | Info | Type | Example Value | 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 | {"2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"}} | |
FAN+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | JSON | ["2020-01-02", "2020-01-28", "2020-04-07"] | |
FAN+PRIC_EL | Electricity price | Price for used electricity. | float | 0.18 | €/kWh |
FAN+POW_NOM_CONSUM | Nominal power consumption | Nominal power consumption of the fan. | float | 800 | kW |
FAN+PRECON | Preconditioning | 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 | 30.0 | min |
FAN+P_DIF_SP_DEV_TOL | Pressure difference setpoint deviation tolerance | Tolerance for deviation of actual pressure difference from its setpoint. | float | 1.5 | °C |
FAN+REG_KEY | Regional key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE-NW | |
FAN+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | JSON | {"Mon":{"start":"10:00", "end":"20:00"},"Tue":{"start":"10:00", "end":"20:00"},"Wed":{"start":"10:00", "end":"20:00"}, "Thu":{"start":"10:00", "end":"20:00"},"Fri":{"start":"10:00", "end":"20:00"},"Sat":{"start":"10:00", "end":"20:00"},"Sun":{"start":"10:00","end":"20:00"}} | |
FAN+SHD_TIMZ | Schedule timezone | Default: UTC. Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | |
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 | 30.0 | min |
Filter¶
The Filter component data model represents various kinds of filters. The alphanumeric ID for the component Filter is AHU_FIL.
Mind the units.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
AHU_FIL+FIL_CONTA | Filter contamination | The extent to which a filter is contaminated measured from 0% (uncontaminated) to 100% (fully contaminated). | % |
AHU_FIL+P_DIF | Pressure difference | Pressure difference over the filter. | Pa |
| alphanumeric_id | Name | Info | Type | Example Value | Unit |
|---|---|---|---|---|---|
AHU_FIL+FIL_TYP | Filter type | Filter type, also known as "filter class". | string | Allowed values: F7 F9 E11 H13 G4 M5 M6 | |
AHU_FIL+P_DIF_FIN | Pressure difference final | Pressure difference when filter is fully contaminated. | float | 150 | Pa |
AHU_FIL+P_DIF_INIT | Pressure difference initial | Pressure differenc ewhen filter is uncontaminated | float | 50 | Pa |
Gas meter¶
The Gas meter component represents a device to counter a volume of gas. The alphanumeric ID for the component Gas meter is GASM.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
GASM+VOL | Gas quantity | Increasing volume counter for gas consumption | m^3 |
GASM+VF | Volume flow | Volume flow of gas | m^3/h |
| alphanumeric_id | Name | Info | Type | Example Value | Unit |
|---|---|---|---|---|---|
GASM+U_VF | Volume flow unit | Allows to adapt the unit of the volume flow pin. | string | Allowed values: litersPerSecond; litersPerMinute; litersPerHour; cubicMetersPerSecond; cubicMetersPerMinute; cubicMetersPerHour |
Heat meter¶
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 Heat meter is HM.
Mind the units.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
HM+EN_H | Heating energy | Measured heating energy | MWh |
HM+POW_H | Heating power | Measured heating power | kW |
HM+T_IN | Supply temperature | Temperature of heat carrier fluid (water) entering the heat meter | °C |
HM+T_OUT | Return temperature | Temperature of heat carrier fluid (water) exiting the heat meter | °C |
HM+VF | Volume flow | Volume flow of heat carrier fluid (water) | default: l/s use component attribute to adjust |
Volume flow unit
| alphanumeric_id | Name | Info | Type | Example Value | Unit |
|---|---|---|---|---|---|
HM+U_VF | Volume flow unit | Allows to adapt the unit of the volume flow pin. | string | Allowed values: litersPerSecond; litersPerMinute; litersPerHour; cubicMetersPerSecond; cubicMetersPerMinute; cubicMetersPerHour | |
HM+U_EN_H | Heating energy unit | Allows to adapt the unit of the heating energy pin. | string | Allowed values: Wh; kWh; MWh; GWh | |
HM+U_POW_H | Heating power unit | Allows to adapt the unit of the heating power pin. | string | Allowed values: W; kW; MW; GW |
Heat pump¶
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 Heat pump is HP.
Mind the units.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
HP+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm 0 = no alarm | binary |
HP+POW_EL | Electrical power | Measured electrical power consumed by the device. | kW |
HP+COND+EN_H | Heating energy - condenser | Measured heating energy taken from or delivered to the heating/recooling loop. | MWh |
HP+EVAP+EN_H | Heating energy - evaporator | Measured heat taken from cooling/heat source loop. | MWh |
HP+COND+POW_H | Heating power - condenser | Measured heating power taken from or delivered to the heating/recooling loop. | kW |
HP+EVAP+POW_H | Heating power - evaporator | Measured heat flow taken from cooling/heat source loop | kW |
HP+COND+T_IN | Inlet temperature - condenser | Temperature of heat carrier fluid (water) entering the component. Condenser side. | °C |
HP+EVAP+T_IN | Inlet temperature - evaporator | Temperature of heat carrier fluid (water) entering the component. Evaporator side. | °C |
HP+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
HP+COND+PU+MSG_OPR | Operating message pump - condenser | Informs about operational state of the condenser pump 1 = operating 0 = switched-off | binary |
HP+EVAP+PU+MSG_OPR | Operating message pump - evaporator | Informs about operational state of the evaporator pump 1 = operating 0 = switched-off | binary |
HP+COND+T_OUT | Outlet temperature - condenser | Temperature of heat carrier fluid (water) exiting the component. Condenser side. | °C |
HP+EVAP+T_OUT | Outlet temperature - evaporator | Temperature of heat carrier fluid (water) exiting the component. Evaporator side | °C |
HP+COND+T_OUT_SP | Outlet temperature setpoint - condenser | Setpoint temperature of heat carrier fluid (water) exiting the component. Condenser side. | °C |
HP+EVAP+T_OUT_SP | Outlet temperature setpoint - evaporator | Setpoint temperature of heat carrier fluid (water) exiting the component. Evaporator side | °C |
HP+COND+VF | Volume flow - condenser | Volume flow of heat carrier fluid (water). Condenser side. | default: l/s use component attribute to adjust |
HP+EVAP+VF | Volume flow - evaporator | Volume flow of heat carrier fluid (water). Evaporator side. | default: l/s use component attribute to adjust |
| alphanumeric_id | Name | Info | Type | Example Value | Unit |
|---|---|---|---|---|---|
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.5 | - |
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 | {"2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"}} | |
HP+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | JSON | ["2020-01-02", "2020-01-28", "2020-04-07"] | |
HP+PRIC_EL | Electricity price | Price for used electricity. | float | 0.18 | €/kWh |
HP+U_EN_H | Heating energy unit | Allows to adapt the unit of the heating energy pin. | string | Allowed values: Wh; kWh; MWh; GWh | |
HP+U_POW_H | Heating power unit | Allows to adapt the unit of the heating power pin. | string | Allowed values: W; kW; MW; GW | |
HP+H_NOM_PROD | Nominal heat production | Nominal heat production of the device. | float | 1200.0 | kW |
HP+COND+T_OUT_SP_DEV_TOL | Outlet temperature setpoint deviation tolerance - condenser | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | °C |
HP+EVAP+T_OUT_SP_DEV_TOL | Outlet temperature setpoint deviation tolerance - evaporator | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | °C |
HP+PRECON | Preconditioning | 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 | 30.0 | min |
HP+REG_KEY | Regional key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE-NW | |
HP+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | JSON | {"Mon":{"start":"10:00", "end":"20:00"},"Tue":{"start":"10:00", "end":"20:00"},"Wed":{"start":"10:00", "end":"20:00"}, "Thu":{"start":"10:00", "end":"20:00"},"Fri":{"start":"10:00", "end":"20:00"},"Sat":{"start":"10:00", "end":"20:00"},"Sun":{"start":"10:00","end":"20:00"}} | |
HP+SHD_TIMZ | Schedule timezone | Default: UTC. Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | |
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 | 30.0 | min |
HP+U_VF | Volume flow unit | Allows to adapt the unit of the volume flow pin. | string | Allowed values: litersPerSecond; litersPerMinute; litersPerHour; cubicMetersPerSecond; cubicMetersPerMinute; cubicMetersPerHour |
Heat transfer unit¶
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 Heat transfer unit is H_TRA_ST.
Mind the units.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
H_TRA_ST+PRIM+EN_H | Heating energy - primary | Measured heating energy of the heat transfer unit on the side of the heating network | default: MWh use component attribute to adjust |
H_TRA_ST+PRIM+POW_H | Heating power - primary | Measured heating power of the heat transfer unit on the side of the heating network | default: kW use component attribute to adjust |
H_TRA_ST+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
H_TRA_ST+T_AIR_ODA | Outdoor air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | °C |
H_TRA_ST+SEC+PU+MSG_OPR | Pump operating message - secondary | Pump operating message | Operational state of the pump: 1 = operating 0 = switched-off |
H_TRA_ST+PRIM+T_OUT | Return temperature - primary | Temperature of the fluid exiting the heat transfer unit to the heating network | °C |
H_TRA_ST+SEC+T_IN | Return temperature - secondary | Temperature of the fluid entering the heat transfer unit from the building | °C |
H_TRA_ST+PRIM+T_IN | Supply temperature - primary | Temperature of the fluid entering the heat transfer unit from the heating network | °C |
H_TRA_ST+SEC+T_OUT | Supply temperature - secondary | Temperature of the fluid exiting the heat transfer unit to the building | °C |
H_TRA_ST+SEC+T_OUT_SP | Supply temperature setpoint - secondary | Temperature setpoint of the fluid exiting the heat transfer unit to the building | °C |
H_TRA_ST+PRIM+VAL_POS_SP | Valve control signal - primary | Control signal of the valve 0 = fully closed 100 = fully opened | % |
H_TRA_ST+PRIM+VAL_POS | Valve position - primary | Actual position of valve opening 0 = fully closed 100 = fully opened | % |
H_TRA_ST+PRIM+VF | Volume flow - primary | Volume flow of heat carrier fluid (water) | default: l/s use component attribute to adjust |
| alphanumeric_id | Name | Info | Type | Example Value | Unit |
|---|---|---|---|---|---|
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 | {"2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"}} | |
H_TRA_ST+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | JSON | ["2020-01-02", "2020-01-28", "2020-04-07"] | |
H_TRA_ST+PRIM+U_EN_H | Heating energy unit - primary | Allows to adapt the unit of the heating energy pin. | string | Allowed values: Wh; kWh; MWh; GWh | |
H_TRA_ST+PRIM+U_POW_H | Heating power unit - primary | Allows to adapt the unit of the heating power pin. | string | Allowed values: W; kW; MW; GW | |
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 | 30.0 | min |
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-NW | |
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 | {"Mon":{"start":"10:00", "end":"20:00"},"Tue":{"start":"10:00", "end":"20:00"},"Wed":{"start":"10:00", "end":"20:00"}, "Thu":{"start":"10:00", "end":"20:00"},"Fri":{"start":"10:00", "end":"20:00"},"Sat":{"start":"10:00", "end":"20:00"},"Sun":{"start":"10:00","end":"20:00"}} | |
H_TRA_ST+SHD_TIMZ | Schedule timezone | Default: UTC. Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | |
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 | 30.0 | min |
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 | °C |
H_TRA_ST+PRIM+VAL_POS_SP_DEV_TOL | Valve position setpoint deviation tolerance | Tolerance for deviation of the valve position from the valve control signal. | float | 10 | % |
H_TRA_ST+PRIM+VAL_THR | Valve threshold | For specific analysis functions it's important to know above what valve position the feeding pump should start to operate. This is currently only used for 3-way valves. | float | 5 | % |
H_TRA_ST+PRIM+U_VF | Volume flow unit - primary | Allows to adapt the unit of the volume flow pin. | string | Allowed values: litersPerSecond; litersPerMinute; litersPerHour; cubicMetersPerSecond; cubicMetersPerMinute; cubicMetersPerHour |
Heating circuit¶
The Heating circuit component represents generic heating circuits that can be found in buildings. The alphanumeric ID for the component Heating circuit is H_CRC.
Mind the units.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
H_CRC+EN_H | Heating energy | Measured heating energy consumed by the heating circuit | default: MWh use component attribute to adjust |
H_CRC+POW_H | Heating power flow | Measured heating power consumed by the heating circuit | default: kW use component attribute to adjust |
H_CRC+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
H_CRC+T_AIR_ODA | Outdoor air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | °C |
H_CRC+PU+MSG_OPR | Pump operating message | Operational state of the pump: 1 = operating 0 = switched-off | binary |
H_CRC+T_OUT | Return temperature | Temperature of the fluid leaving the heating circuit | °C |
H_CRC+T_IN | Supply temperature | Temperature of the fluid entering the heating circuit | °C |
H_CRC+T_IN_SP | Supply temperature setpoint | Temperature setpoint of the fluid entering the heating circuit | °C |
H_CRC+VAL_POS_SP | Valve control signal | Control signal of the valve 0 = fully closed 100 = fully opened | % |
H_CRC+VAL_POS | Valve position | Actual position of valve opening 0 = fully closed 100 = fully opened | % |
H_CRC+VF | Volume flow | Volume flow of heat carrier fluid (water) | default: l/s use component attribute to adjust |
| alphanumeric_id | Name | Info | Type | Example Value | Unit |
|---|---|---|---|---|---|
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 | {"2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"}} | |
H_CRC+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | JSON | ["2020-01-02", "2020-01-28", "2020-04-07"] | |
H_CRC+U_EN_H | Heating energy unit | Allows to adapt the unit of the heating energy pin. | string | Allowed values: Wh; kWh; MWh; GWh | |
H_CRC+U_POW_H | Heating power unit | Allows to adapt the unit of the heating power pin. | string | Allowed values: W; kW; MW; GW | |
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 | 30.0 | min |
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-NW | |
H_CRC+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | JSON | {"Mon":{"start":"10:00", "end":"20:00"},"Tue":{"start":"10:00", "end":"20:00"},"Wed":{"start":"10:00", "end":"20:00"}, "Thu":{"start":"10:00", "end":"20:00"},"Fri":{"start":"10:00", "end":"20:00"},"Sat":{"start":"10:00", "end":"20:00"},"Sun":{"start":"10:00","end":"20:00"}} | |
H_CRC+SHD_TIMZ | Schedule timezone | Default: UTC. Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | |
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 | 30.0 | min |
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. | string | Allowed values: "2-way valve"; "3-way valve" | |
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. This is currently only used for 3-way valves. | float | 5 | % |
H_CRC+T_OUT_SP_DEV_TOL | Supply temperature setpoint deviation tolerance | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | °C |
H_CRC+U_VF | Volume flow unit | Allows to adapt the unit of the volume flow pin. | string | Allowed values: litersPerSecond; litersPerMinute; litersPerHour; cubicMetersPerSecond; cubicMetersPerMinute; cubicMetersPerHour | |
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 | % |
Humidity conditioner¶
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 Humidity conditioner is AHU_HUM_CODI.
Mind the units.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
AHU_HUM_CODI+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
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 | % |
AHU_HUM_CODI+T_AIR_ODA | Outside air temperature | Temperature of the inlet airflow. Typically the temperature outside of the outside air | °C |
AHU_HUM_CODI+SUP_HUM_REL_AIR | Supply air relative humidity | Relative humidity of the supply airflow | % |
AHU_HUM_CODI+SUP_T_AIR | Supply air temperature | Temperature of the supply airflow | °C |
No attributes for this component.
Recooling plant¶
The Recooling plant component represents a generic plant that transfers excess heat to the environment. The alphanumeric ID for the component Recooling plant is PLNT_C_RE.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
PLNT_C_RE+EN_C | Cooling energy | Measured cooling energy of the recooling plant | default: MWh use component attribute to adjust |
PLNT_C_RE+POW_C | Cooling power | Measured cooling power of the recooling plant | default: kW use component attribute to adjust |
PLNT_C_RE+EN_EL | Electrical energy | Electrical energy counter of the recooling plant | default: kWh |
PLNT_C_RE+POW_EL | Electrical power | Electrical power consumption of the recooling plant | default: kW |
PLNT_C_RE+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
PLNT_C_RE+FAN+MSG_OPR | Operating message - fan | Informs about operational state of the fan 1 = operating 0 = switched-off | binary |
PLNT_C_RE+T_AIR_ODA | Outdoor air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | °C |
PLNT_C_RE+T_IN | Return temperature | Temperature of carrier fluid entering the recooling plant. | °C |
PLNT_C_RE+FAN+SPE | Speed - fan | Current fan speed in relation to the nominal speed of the fan | % |
PLNT_C_RE+T_OUT | Supply temperature | Temperature of carrier fluid leaving the recooling plant. | °C |
PLNT_C_RE+VF | Volume flow | Volume flow of carrier fluid (water) on secondary side | default: l/s use component attribute to adjust |
PLNT_C_RE+VOL_WS | Water quantity | Counter for volume of used water in the recooling plant | m^3 |
| alphanumeric_id | Name | Info | Type | Example Value | Unit |
|---|---|---|---|---|---|
PLNT_C_RE+U_EN_C | Cooling energy unit | Allows to adapt the unit of the cooling energy pin. | string | Allowed values: Wh; kWh; MWh; GWh | |
PLNT_C_RE+U_POW_C | Cooling power unit | Allows to adapt the unit of the cooling power pin. | string | Allowed values: W; kW; MW; GW | |
PLNT_C_RE+U_VF | Volume flow unit | Allows to adapt the unit of the volume flow pin. | string | Allowed values: litersPerSecond; litersPerMinute; litersPerHour; cubicMetersPerSecond; cubicMetersPerMinute; cubicMetersPerHour |
Room¶
The Room component data model is the basic component model for rooms. The alphanumeric ID for the component Room is ROOM.
Mind the units.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
ROOM+CO2 | CO2 | CO2 concentration in the room air | ppm |
ROOM+CO2_SP | CO2 setpoint | Setpoint for CO2 concentration in room | ppm |
ROOM+HUM_REL | Humidity | Relative humidity of indoor air | % |
ROOM+MSG_OPR | Operating message | Operating message of room control 1 = operating 0 = switched-off | binary |
ROOM+T_AIR_ODA | Outside air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | °C |
ROOM+PRES | Presence | Presence of one or more persons inside the room 1 = presence 0 = no presence | binary |
ROOM+T_AIR | Temperature | Inside air temperature in the room | °C |
ROOM+T_AIR_SP | Temperature setpoint | Setpoint of the inside air temperature in the room | °C |
| alphanumeric_id | Name | Info | Type | Example Value | Unit |
|---|---|---|---|---|---|
ROOM+AV_SAL | Average salary | Average hourly salary of employees in the room. | float | 40.0 | €/person |
ROOM+CO2_SP_DEV_TOL | CO2 setpoint deviation tolerance | Tolerance for deviation of actual CO2 concentration from setpoint. | float | 100.0 | ppm |
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 | {"2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"}} | |
ROOM+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | JSON | ["2020-01-02", "2020-01-28", "2020-04-07"] | |
ROOM+OCC_MAX | Maximum occupation of the room | Maximum number of people in the room. | int | 10.0 | persons/room |
ROOM+PEO_COUNT | People in room | Expected number of people in room | ínt | 5 | people |
ROOM+PRECON | Preconditioning | 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 | 30.0 | min |
ROOM+REG_KEY | Regional key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE-NW | |
ROOM+SHD | Schedule | Weekly, workday individual schedule. Do not add a workday to the JSON, unless it has times of intended operation. | JSON | {"Mon":{"start":"10:00", "end":"20:00"},"Tue":{"start":"10:00", "end":"20:00"},"Wed":{"start":"10:00", "end":"20:00"}, "Thu":{"start":"10:00", "end":"20:00"},"Fri":{"start":"10:00", "end":"20:00"},"Sat":{"start":"10:00", "end":"20:00"},"Sun":{"start":"10:00","end":"20:00"}} | |
ROOM+SHD_TIMZ | Schedule timezone | Default: UTC. Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | |
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 | 30.0 | min |
ROOM+T_SP_DEV_TOL | Temperature setpoint deviation tolerance | Tolerance for deviation of actual temperature from setpoint. | float | 2.5 | °C |
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 ‘operating message’ or ‘presence’ without any reductions, enter "24/7 full occupancy". | Allowed values: classroom; single person office; multi persons office; store; restaurant; conference room; kindergarten |
Thermal control loop¶
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 Thermal control loop is TH_CTRL_LOO.
Mind the units.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
TH_CTRL_LOO+MSG_ALARM | Alarm message | Any boolean alarm message, critical alerts are preferred 1 = alarm 0 = no alarm | binary |
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 | °C |
TH_CTRL_LOO+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
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 | °C |
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 | binary |
TH_CTRL_LOO+PU+MSG_OPR | Pump operating message | Operating message of pump within the control loop 1 = operating 0 = switched-off | binary |
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 | °C |
TH_CTRL_LOO+VAL_POS | Valve position | Actual position of valve opening 0 = fully closed 100 = fully opened | % |
TH_CTRL_LOO+VAL_POS_SP | Valve control signal | Control signal of the valve 0 = fully closed 100 = fully opened | % |
| alphanumeric_id | Name | Info | Type | Example Value | 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 | {"2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"}} | |
TH_CTRL_LOO+CUS_HOLI | Custom holiday | On a holiday plant operation is considered as unintentional. Adds holidays to the schedule. | JSON | ["2020-01-02", "2020-01-28", "2020-04-07"] | |
TH_CTRL_LOO+T_OUT_SP_DEV_TOL | Outlet temperature setpoint deviation tolerance | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | °C |
TH_CTRL_LOO+PRECON | Pre-conditioning period | Unit: minutes. 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 | 30.0 | min |
TH_CTRL_LOO+REG_KEY | Regional key | Adds regional holidays where operation is not intended to the schedule. Localization by regional keys from ISO 3166-2. | string | DE-NW | |
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 | {"Mon":{"start":"10:00", "end":"20:00"},"Tue":{"start":"10:00", "end":"20:00"},"Wed":{"start":"10:00", "end":"20:00"}, "Thu":{"start":"10:00", "end":"20:00"},"Fri":{"start":"10:00", "end":"20:00"},"Sat":{"start":"10:00", "end":"20:00"},"Sun":{"start":"10:00","end":"20:00"}} | |
TH_CTRL_LOO+SHD_TIMZ | Schedule timezone | Default: UTC. Timezone of the schedule provided in IANA timezone codes. | string | Europe/Berlin | |
TH_CTRL_LOO+SHDO_FLX | Shutdown flexibility | Unit: minutes. 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 | 30.0 | |
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 | % |
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. | string | Allowed values: "2-way valve"; "3-way valve" | |
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. This is currently only used for 3-way valves. | float | 5 | % |
Thermal energy storage¶
The Thermal energy storage component represents a generic thermal storage for warm or cold water. The alphanumeric ID for the component Thermal energy storage is STO_TH.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
STO_TH+T_STO_LOW | Lower storage temperature | Measurement point for the water temperature inside the tank at the lowest location | °C |
STO_TH+T_AIR_ODA | Outdoor air temperature | Outside air temperature, datapoint can be mapped from a weather station on site | °C |
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 | binary |
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 | binary |
STO_TH+T_STO_UPP | Upper storage temperature | Measurement point for the water temperature inside the tank at the highest location | °C |
No attributes for this component.
Water meter¶
The Water meter is a component model that represents the measurement of volumes and volume flows of water. The alphanumeric ID for the component Water meter is WSM.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
WSM+VF | Volume flow | Volume flow of water | l/s |
WSM+VOL | Water quantity | Increasing volume counter for gas consumption | m^3 |
| alphanumeric_id | Name | Info | Type | Example Value | Unit |
|---|---|---|---|---|---|
WSM+U_VF | Volume flow unit | Allows to adapt the unit of the volume flow pin | string | 4 | l/min dm3/min l/h dm3/h |
Weather station¶
The Weather station (WST) component data model links weather sensors and correlating data points. The alphanumeric ID for the component Weather station is WST.
Mind the units.
| alphanumeric_id | Name | Info | Unit |
|---|---|---|---|
WST+T_AIR_ODA | Temperature | Temperature of outside air | °C |
WST+REFE_T_AIR_ODA | Reference temperature | Reference temperature from online databases which is used for outdoor air temperature sensor checkup | °C |
WST+HUM_REL_AIR_ODA | Relative humidity | Relative humidity of outside air | % |
WST+REFE_HUM_REL_AIR_ODA | Reference relative humidity | Reference relative humidity from online databases which is used for outdoor air relative humidity sensor checkup | % |
| alphanumeric_id | Name | Info | Type | Example Value | Unit |
|---|---|---|---|---|---|
WST+LAT | Latitude | Geographical latitude of weather station. | float | 6.9403 | degrees |
WST+LON | Longitude | Geographical longitude of weather station. | float | 50.9407 | degrees |
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.
Last update: 2021-03-17