Component models

A detailed specification of available component data models and their application.

Overview¶

Component data models are utilized to create virtual twins of building equipment. They are templates representing the correlation between data points and metadata of building equipment. To create such a virtual twin, a component data model gets added to a specific project, and data points and metadata get mapped to its pins (placeholders for data points) and attributes (placeholders for metadata).

This page offers specifications on the available component data models and available analytics functions for each component.

Alphanumeric IDs¶

Alphanumeric IDs are used to access component pins and attributes via the API. Each ID is unique and contains information about the pin/attribute and corresponding component. See component data models for more information on alphanumeric IDs of all pins, components, and attributes.

Available component data models¶

• Air cooler
• Air handling unit
• Air heater
• Boiler
• Building
• Cold meter
• Combined heat and power
• Compression chiller
• Cooling circuit
• Electricity meter
• Elevator
• Fan
• Filter
• Gas meter
• Heat meter
• Heat pump
• Heat transfer unit
• Heating circuit
• Humidifier
• Humidity conditioner
• Hybrid circuit
• Recooling plant
• Room
• System
• 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.

• 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.

Air handling unit¶

The Air handling unit component model represents typical air handling units from ventilation systems to full air conditioning including heat recovery and recirculation. Compose the air handling unit to the needs of the specific project by mapping the regarding pins of this component model from supply fan, exhaust fan, heat recovery system, air heater, air cooler, air re-heater, supply humidifier, exhaust humidifier, and recirculation damper. The alphanumeric ID for the component Air handling unit is AHU.

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.

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.

Building¶

The Building is a component model for a complete project. It's the base for our asset and facility cockpits, as well as the connected analysis functions. The alphanumeric ID for the component Building is B.

AnalysisPinsAttributes

• CO2 emissions
• Elevators Operating Time Analysis
• Energy consumption
• Energy cost
• Heat demand
• Technical Availability
• Wellbeing

No pins available.

alphanumeric_id	Name	Info	Type	Example Value	Unit
B+AHU	Air handling units	Information regarding the air handling units.	string	2 AHUs units without humidification
B+ASSET_MANAGER	Asset manager	Name of the asset manager.	string	John Smith
B+ASSET_OWNER	Asset owner	Name of the asset owner.	string	John Smith
B+CERTS_BREEAM	BREEAM	BREEAM certification.	string	excellent	Allowed values: outstanding; excellent; very good; good; pass; unclassified;
B+BA_BRAND	Building automation brand	Name of the building automation brand.	string	My automation brand
B+BA_CNSTR	Building automation constructor	Name of the building automation constructor.	string	My respectable BA constructor
B+BA_PROT	Building automation protocol	Name of the building automation protocol.	string	BACnet
B+CERTS	Building certifications	Please use specific building certificate attributes, e.g., "LEED" instead.	json	{"DGNB": {"grade": {"de": "Gold", "en": "Gold"}}, "WiredScore": {"grade": {"de": "Platinum", "en": "Platinum"}}}
B+BMS_BRAND	Building management system brand	Name of the building management system brand.	string	My fancy building management
B+CO2E+SIG_COLO_R	CO2 emissions limit red	Overwrite the red limit for the CO2 emissions KPI for this building.	float	8.5	kg/m2/M
B+CO2E+SIG_COLO_Y	CO2 emissions limit yellow	Overwrite the yellow limit for the CO2 emissions KPI for this building.	float	7.0	kg/m2/M
B_PRIC_CO2	CO2 price	Set the default price for CO2 of this building.	float	7.0	€/kg
B_COUNT_CAR_MAX	Car park capacity	Maximum number of cars the car park can accommodate.	float	200
B+CS	Cooling system	Information regarding the cooling system.	string	1 compression chiller and 3 cooling circuits
B+CERTS_DGNB	DGNB	DGNB certification.	string	gold	Allowed values: platinum; gold; silver; bronze;
B+CERTS_ECORE	Ecore	Ecore certification which is evaluated on a scale of 1 to 100.	float	75
B_EFZ	Efficiency zones	Benchmarks for evaluating efficiency criteria of buildings on a color scale.	json	{"benchmark_electricity_consumption": {"green": [0, 120], "red": [160, 200]}, "benchmark_heat_consumption": {"green": [0, 40], "red": [70, 120]}, "benchmark_co2_emissions": {"green": [0, 40], "red": [70, 100]}, "benchmark_water_consumption": {"green": [0, 180], "red": [250, 350]}, "benchmark_energy_generation": {"green": [0, 150], "red": [0.0, 50.0]}}
B+PRIC_EL	Electricity price	Set the default price for electricity of this building.	float	0.2	€/kWh
B+EN_CONSUM+SIG_COLO_R	Energy consumption limit red	Overwrite the red limit for the energy consumption KPI for this building.	float	8.33	kWh/m2/M
B+EN_CONSUM+SIG_COLO_Y	Energy consumption limit yellow	Overwrite the yellow limit for the energy consumption KPI for this building.	float	10.83	kWh/m2/M
B+EC+SIG_COLO_R	Energy cost limit red	Overwrite the red limit for the energy cost KPI for this building.	float	1.0	€/m2/M
B+EC+SIG_COLO_Y	Energy cost limit yellow	Overwrite the red limit for the energy cost KPI for this building.	float	0.7	€/m2/M
B+CERTS_ESTAR	EnergyStar	EnergyStar certification which is evaluated on a scale of 1 to 100.	float	75
B_EVS	Events	Define the most important alarming events in a building. Alarms can be linked to an event by "category", while "activate":True indicates at least one linked alarm. The key "icon" allows to individualize frontend-sided rendering of the event.	json	[{"name": {"en": "FIRE DAMPERS", "de": "BRANDSCHUTZKLAPPEN"}, "category": "BSK", "icon": "fal fa-fire", "active": true}, {"name": {"en": "ELEVATOR", "de": "AUFZUG"}, "category": "availability", "icon": "far fa-sort-circle", "active": true}]
B+FACILITY_MANAGER	Facility manager	Name of the facility manager.	string	John Smith
B+CERTS_GRESB	GRESB	GRESB certification which is evaluated on a scale of 1 to 100.	float	75
B+GOA	Goals	Set SMART goals to optimize your building! "period": Make it time-bound. "names": Formulate your goal specific, achievable, and relevant. "bar_chart": Make it measurable and track it.	json	{"period": {"de": "Im Jahr 2022", "en": "Within year 2022"}, "goals": [{"names": {"de": "CO2 Reduktion um 20%", "en": "Reduce CO2 by 20%"}, "bar_chart": {"min": 0.0, "act": 20.0, "max": 20.0}}, {"names": {"de": "Identifiziere Maßnahmen für 25% Energieeinsparungen", "en": "Identify measures for 25% energy savings"}, "bar_chart": {"min": 0.0, "act": 23.0, "max": 25.0}}]}
B+T_H_LIM	Heating limit temperature upper limit	Temperature limit where the heating system is not active	float	20	°C
B+HS	Heating system	Information regarding the heating system.	string		1 boiler, 1 heat pump and four heating circuits
B+ICT	ICT contact person	Name of the ICT contact person.	string	John Smith
B+HS+CO2_EMIS_F_DSG	Investment - CO2 emission factor current energy system	CO2 emissions per energy unit for current heating system	float	0.2	kg/kWh
B+HP+CO2_EMIS_F_INST_DSG	Investment - CO2 emission factor new energy system	CO2 emissions per energy unit for new heating system	float	0.2	kg/kWh
B+HP+TYPE_DSG	Investment - Heat pump type	Distinguished in Water/Water and Air/Water	string	remeha_aw_168, vaillant_arotherm_plus, viessmann_vitocal_300_g
B+HS+USA_DUR_DSG	Investment - depreciation period new energy system	Depreciation period to consider the tax effect	float	10	a
B+HS+T_SUP_DSG	Investment - design temperature heating system	Design supply temperature of the heating system (usually maximum supply temperature)	float	60	°C
B+HP+PRIC_EL_DSG	Investment - electricity price heat pump	Energy price new heating system	float	0.25	€/kWh
B+INR_DSG	Investment - interest rate	Calculation interest rate to discount the annual cash flow	float	12	%
B+HS+PRIC_H_DSG	Investment - specific energy price current heating system	Current energy price	float	0.25	€/kWh
B+HP+PRIC_INST_DSG	Investment - specific installation price new energy system	Specific installation price for the heat pump	float	1000	€/kW
B+CERTS_LEED	LEED	LEED certification.	string	gold	Allowed values: platinum; gold; silver; certified;
B+LINK	Link	Link	Hyperlink to external resources	string
B+LOC	Location of building	Location or address of the building.	string	Hohenzollernring 72, 50672 Köln
B+POW_H_LIM_LOW	Lower limit total heat power	Heat power cutoff	float	2	kW
B_GFA_AV	Mean gross floor area	The mean area of each floor.	float	270	m2
B+M	Meters	Information regarding the meters.	string	4 heat meters and 6 electricity meters
B+NFA	Net floor area	The net floor area of the building.	float	14834	m2
B+DP_COUNT	Number of datapoints	Number of datapoints in the project.	float	13000
B_COUNT_PEO_MAX	Occupancy capacity	Total number of people the building can accommodate.	float	580
B+PROP_MANA	Property management	Property management company or person.	string	Property management inc.
B+REFE_STOP	Reference period end	End of the reference period to calculate model	string	2022-01-01
B+REFE_STRT	Reference period start	Start of the reference period to calculate model	string	2023-01-01
B_TAR_CO2_EMI	Targeted CO2 emissions	Value of desired total CO2 emissions	float	54000.0	kg
B_TAR_EN_EL_CONSUM_MAX	Targeted electricity consumption max	Maximum of the desired electricity consumption	float	60.0	MWh
B_TAR_EN_EL_GEN_MAX	Targeted energy generation max	Maximum of the desired electricity generation	float	30.0	MWh
B_TAR_EN_H_CONSUM_MAX	Targeted heat consumption max	Maximum of the desired heat consumption	float	120.0	MWh
B_TAR_WS_FRESH_CONSUM	Targeted water consumption	Value of the desired total water consumption	float	80000.0	l
B+POW_H_BASE_LOA	Thermal base load	Power consumption independent of heat demand	float	10	kW
B+TYP	Type	The usage type of building.	string	office	Allowed values: office; retail;
B+CERTS_WSCORE	WiredScore	WiredScore certification.	string	gold	Allowed values: platinum; gold; silver; certified;
B+BUILD_YEAR	Year of construction	Year of building construction.	float	1984
B+RENOV_YEAR	Year of the last renovation	Year of the last renovation of the building.	string	1984

Cold Meter¶

The Cold meter component data model represents a heat meter that will count cooling energy. It can be physically present in the energy system or virtually on the aedifion platform. The alphanumeric ID for the component Cold meter is CM.

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.

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.

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.

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.

Elevator¶

The Elevator component represents an elevator. The alphanumeric ID for the component Elevator is ELE.

Fan¶

The Fan component data model represents various kinds of fans. The alphanumeric ID for the component Fan is FAN.

Filter¶

The Filter component data model represents various kinds of filters. The alphanumeric ID for the component Filter is AHU_FIL.

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.

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.

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.

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.

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.

Humidifier¶

The Humidifier component represents a steam-powered or electric powered device used to humidify the air in an air conditioning system. The alphanumeric ID for the component Humidifier is HUM.

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.

Hybrid circuit¶

The Hybrid circuit component represents generic circuits that can both heat and cool. In contrast, heating circuits and cooling circuits can either heat or cool. In cases where one valve is present in the circuit, map everything to the heating pins, e.g. "Heating valve position". The alphanumeric ID for the component Hybrid circuits is HY_CRC.

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.

Room¶

The Room component data model is the basic component model for rooms. The alphanumeric ID for the component Room is ROOM.

System¶

The System component represents a generic system. It is required to represent the status of equipment on the Status & Alerts. The alphanumeric ID for the component System is S.

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.

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.

Waste Meter¶

The Waste Meter component model represents a meter that measures the amount of waste generated by a system. The alphanumeric ID for the component Waste meter is WASTM.

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.

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.

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.