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¶
- Boiler
- Combined Heat and Power
- Fan
- Filter
- Heat Meter
- Heat Pump
- Humidity Conditioner
- Room
- Thermal Control Loop
- 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.
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+RATE_FUEL_CONSUM | Rate of fuel consumption | Measured fuel consumption of the device | default: kW |
BOI+EN_H | Heat | Measured heat delivered by boiler to heating loop | default: MWh |
BOI+POW_H | Heat flow | Measured heat flow delivered by boiler to heating loop | default: kW |
BOI+T_IN | Inlet temperature | Temperature of heat carrier fluid (water) entering the component. Also referred to as return temperature | °C |
BOI+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
BOI+T_OUT | Outlet temperature | Temperature of heat carrier fluid (water) exiting the component. Also referred to as supply temperature | °C |
BOI+T_OUT_SP | Outlet temperature setpoint | Setpoint temperature of heat carrier fluid ( water) exiting the component. Also referred to as supply temperature setpoint | °C |
BOI+PU+MSG_OPR | Pump operating message | Operational state of the pump: 1 = operating 0 = switched-off | binary |
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 | Heat flow unit | Allows to adapt the unit of the heat flow pin. | string | Allowed values: W; kW; MW; GW | |
BOI+U_POW_H | Heat unit | Allows to adapt the unit of the heat pin. | string | Allowed values: Wh; kWh; MWh; GWh | |
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 | Heat | Measured heat delivered by CHP to heating loop | MWh |
CHP+POW_H | Heat flow | Measured heat flow delivered by CHP to heating loop | kW |
CHP+T_IN | Inlet temperature | Temperature of heat carrier fluid (water) entering the component. Also referred to as return temperature. | °C |
CHP+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
CHP+T_OUT | Outlet temperature | Temperature of heat carrier fluid (water) exiting the component. Also referred to as supply temperature | °C |
CHP+T_OUT_SP | Outlet temperature setpoint | Setpoint temperature for heat carrier fluid ( water) exiting the component. Also referred to as supply temperature setpoint | °C |
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+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 | Fuel 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_POW_H | Heat flow unit | Allows to adapt the unit of the heat flow pin. | string | Allowed values: W; kW; MW; GW | |
CHP+U_EN_H | Heat unit | Allows to adapt the unit of the heat pin. | string | Allowed values: Wh; kWh; MWh; GWh | |
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 |
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+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
FAN+SPE | Speed | Current fan speed in relation to the nominal speed of the fan | % |
FAN+POW_EL | Electrical power | Measurement of electrical power | kW |
| 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+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 | None |
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 |
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 | Heat | Measured heat | MWh |
HM+POW_H | Heat flow | Measured heat flow | kW |
HM+T_IN | Inlet temperature | Temperature of heat carrier fluid (water) entering the heat meter | °C |
HM+T_OUT | Outlet 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_POW_H | Heat flow unit | Allows to adapt the unit of the heat flow pin. | string | Allowed values: W; kW; MW; GW | |
HM+U_EN_H | Heat unit | Allows to adapt the unit of the heat pin. | string | Allowed values: Wh; kWh; MWh; GWh |
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+COND+EN_H | Condenser heat | Measured heat delivered by the condenser to heating/recooling loop | MWh |
HP+COND+POW_H | Condenser heat flow | Measured heat flow delivered by the condenser to heating/recooling loop | kW |
HP+COND+T_IN | Condenser inlet temperature | Temperature of heat carrier fluid (water) entering the component. Also referred to as return temperature. Condenser side | °C |
HP+COND+T_OUT | Condenser outlet temperature | Temperature of heat carrier fluid (water) exiting the component. Also referred to as supply temperature. Condenser side | °C |
HP+COND+T_OUT_SP | Condenser outlet temperature setpoint | Setpoint temperature of heat carrier fluid (water) exiting the component. Also referred to as supply temperature setpoint. Condenser side | °C |
HP+COND+PU+MSG_OPR | Condenser pump operating message | Informs about operational state of the condenser pump 1 = operating 0 = switched-off | binary |
HP+COND+VF | Condenser volume flow | Volume flow of heat carrier fluid (water). Condenser side. | default: l/s use component attribute to adjust |
HP+EVAP+EN_H | Evaporator heat | Measured heat taken from cooling/heat source loop | MWh |
HP+EVAP+POW_H | Evaporator heat flow | Measured heat flow taken from cooling/heat source loop | kW |
HP+EVAP+T_IN | Evaporator inlet temperature | Temperature of heat carrier fluid (water) entering the component. Also referred to as return temperature. Evaporator side | °C |
HP+EVAP+T_OUT | Evaporator outlet temperature | Temperature of heat carrier fluid (water) exiting the component. Also referred to as supply temperature. Evaporator side | °C |
HP+EVAP+T_OUT_SP | Evaporator outlet temperature setpoint | Setpoint temperature of heat carrier fluid (water) exiting the component. Also referred to as supply temperature. Evaporator side | °C |
HP+EVAP+PU+MSG_OPR | Evaporator pump operating message | Informs about operational state of the evaporator pump 1 = operating 0 = switched-off | binary |
HP+EVAP+VF | Evaporator volume flow | Volume flow of heat carrier fluid (water). Evaporator side | default: l/s use component attribute to adjust |
HP+POW_EL | Electrical power | Measured electrical power consumed by the device | kW |
HP+MSG_OPR | Operating message | Informs about operational state of component 1 = operating 0 = switched-off | binary |
| 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+COND+T_OUT_SP_DEV_TOL | Condenser outlet temperature setpoint deviation tolerance | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | °C |
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+EVAP+T_OUT_SP_DEV_TOL | Evaporator outlet temperature setpoint deviation tolerance | Tolerance for deviation of actual temperature from setpoint. | float | 1.5 | °C |
HP+U_POW_H | Heat flow unit | Allows to adapt the unit of the heat flow pin. | string | Allowed values: W; kW; MW; GW | |
HP+U_EN_H | Heat unit | Allows to adapt the unit of the heat pin. | string | Allowed values: Wh; kWh; MWh; GWh | |
HP+H_NOM_PROD | Nominal heat production | Nominal heat production of the device. | float | 1200.0 | kW |
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 |
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 on this component.
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+T_AIR_ODA | 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. | 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 | Degree of valve opening 0 = fully closed 100 = fully opened | °C |
TH_CTRL_LOO+VAL_POS_SP | Valve position setpoint | Setpoint for degree of valve opening 0 = fully closed 100 = fully opened | °C |
| 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+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 | |
| 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_TYP | Valve type | For specific analysis functions it's important to know what kind of valve is used to regulate the outlet temperature of the thermal control loop. If required you can choose between a 2-way valve and a 3-way valve with this attribute. | string | "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 of the thermal control loop should start to operate. This is currently only used for 3-way valves. | float | 5 | % |
| TH_CTRL_LOO+T_OUT_SP_DEV_TOL | Outlet temperature setpoint deviation tolerance | float | 1.5 | °C |
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-01-06