Component data models

Detailed specification of available component data models and their application.

Available component data models

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 an 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 required mappings.

Example Component

This example leads through our description of component data models by providing exemplary values and descriptions. The first paragraph of a component data model provides information regarding the component and the data model itself, special features, exceptions and so forth.

Component Identifier
Pins
Attributes
Available Functions
Component Identifier

example_component

The Component Identifier is the string identifier of the component. It is used as input parameter for some endpoints (example endpoint).

Pins

The Pins table lists basic information on each pin of the component.

Mind the units.

Name

Info

Unit

example pin

Placeholder for any information on the requested datapoint.

kW

...

...

...

Attributes

The Attributes table lists basic information on each attribute of the component.

The Key parameter is the string identifier of the attribute used for our API.

The Type parameter is the value type expected, e.g. float, string, json, etc.

The Unit parameter is the unit of the value expected.

Mind the units.

Example Attribute

Default Values are implemented within the analytics function themselves, they do not appear on API calls.

Attributes are starting with a short description.

Key

Type

Default Value

Unit

example_attribute

float or integer

42.0

kW

...

...

...

Another Example Attribute

...

Available Functions

The Available Functions tab provide a list of functions available for the component data model. For more information click the regarding function.

Exemplary specification of the function, if applied to this component.

Exemplary specification of the function, if applied to this component.

Boiler

The Boiler is the basic model of the heat conversion plant boiler. Further component data models like the Condensing Boiler and Low-Temperature Boiler inherit this component. Boilers burn fuels like oil, natural gas, pallets etc. to heat up a heat carrier fluid (water in general).

Component Identifier
Pins
Attributes
Available Functions
Component Identifier

boiler

Pins

Mind the units.

Name

Info

Unit

exhaust co

Carbon monoxide concentration in exhaust gas.

ppm

exhaust nox

Nitrogen oxide concentration in exhaust gas.

ppm

exhaust o2

Oxygen concentration in exhaust gas.

%

exhaust temperature

Temperature of exhaust gas.

°C

heat flow

Thermal power transferred to heat carrier fluid (water).

kW

heat meter

Thermal energy transferred to heat carrier fluid (water). Cumulating counter.

kWh

inlet temperature

Temperature of heat carrier fluid (water) entering the component. Also referred to as return temperature.

°C

malfunction message

Informs about technical availability of component.

1 = malfunction

0 = no malfunction

binary

operating message

Informs about operational state of component.

1 = operating

0 = switched-off

binary

outlet temperature

Temperature of heat carrier fluid (water) exiting the component. Also referred to as supply temperature.

°C

power consumption

Fuel power consumed by component.

kW

power consumption meter

Fuel energy consumed. Cumulating counter.

kWh

volume flow

Volume flow of heat carrier fluid (water).

l/s

Attributes

No attributes defined for this component data model.

Available Functions

Checks for appropriate cycle behavior and provides recommendation on how to improve.

Checks if plant is operated according to a provided schedule.

Condensing Boiler

The Condensing Boiler is a specific type of boiler. One of the flue gas components of fuel combustion is gaseous water. A condensing boiler liquefies the water from the flue gases. The condensate heat released is used to heat the heat carrier fluid.

Component Identifier
Pins
Attributes
Available Functions
Component Identifier

condensing_boiler

Pins

Mind the units.

Name

Info

Unit

exhaust co

Carbon monoxide concentration in exhaust gas.

ppm

exhaust nox

Nitrogen oxide concentration in exhaust gas.

ppm

exhaust o2

Oxygen concentration in exhaust gas.

%

exhaust temperature

Temperature of exhaust gas.

°C

heat flow

Thermal power transferred to heat carrier fluid (water).

kW

heat meter

Thermal energy transferred to heat carrier fluid (water). Cumulating counter.

kWh

inlet temperature

Temperature of heat carrier fluid (water) entering the component. Also referred to as return temperature.

°C

malfunction message

Informs about technical availability of component.

1 = malfunction

0 = no malfunction

binary

operating message

Informs about operational state of component.

1 = operating

0 = switched-off

binary

outlet temperature

Temperature of heat carrier fluid (water) exiting the component. Also referred to as supply temperature.

°C

power consumption

Fuel power consumed by component.

kW

power consumption meter

Fuel energy consumed. Cumulating counter.

kWh

volume flow

Volume flow of heat carrier fluid (water).

l/s

Attributes

No attributes defined for this component data model.

Available Functions

Checks for appropriate cycle behavior and provides recommendation on how to improve.

Checks if plant is operated according to a provided schedule.

Low-Temperature Boiler

The Low-Temperature Boiler is a specific type of boiler. It is defined by the low temperature level of the supply temperature output provided by the boiler.

Component Identifier
Pins
Attributes
Available Functions
Component Identifier

low-temperature_boiler

Pins

Mind the units.

Name

Info

Unit

exhaust co

Carbon monoxide concentration in exhaust gas.

ppm

exhaust nox

Nitrogen oxide concentration in exhaust gas.

ppm

exhaust o2

Oxygen concentration in exhaust gas.

%

exhaust temperature

Temperature of exhaust gas.

°C

heat flow

Thermal power transferred to heat carrier fluid (water).

kW

heat meter

Thermal energy transferred to heat carrier fluid (water). Cumulating counter.

kWh

inlet temperature

Temperature of heat carrier fluid (water) entering the component. Also referred to as return temperature.

°C

malfunction message

Informs about technical availability of component.

1 = malfunction

0 = no malfunction

binary

operating message

Informs about operational state of component.

1 = operating

0 = switched-off

binary

outlet temperature

Temperature of heat carrier fluid (water) exiting the component. Also referred to as supply temperature.

°C

power consumption

Fuel power consumed by component.

kW

power consumption meter

Fuel energy consumed. Cumulating counter.

kWh

volume flow

Volume flow of heat carrier fluid (water).

l/s

Attributes

No attributes defined for this component data model.

Available Functions

Checks for appropriate cycle behavior and provides recommendation on how to improve.

Checks if plant is operated according to a provided schedule.

Combined Heat and Power

The Combined Heat and Power component data model represents various kinds of combined heat and power generation. It does not differ in the method of energy conversion.

Component Identifier
Pins
Attributes
Available Functions
Component Identifier

combined_heat_and_power

Pins

Mind the units.

Name

Info

Unit

exhaust co

Carbon monoxide concentration in exhaust gas.

ppm

exhaust nox

Nitrogen oxide concentration in exhaust gas.

ppm

exhaust o2

Oxygen concentration in exhaust gas.

%

exhaust temperature

Temperature of exhaust gas.

°C

heat flow

Thermal power transferred to heat carrier fluid (water).

kW

heat meter

Thermal energy transferred to heat carrier fluid (water). Cumulating counter.

kWh

inlet temperature

Temperature of heat carrier fluid (water) entering the component. Also referred to as return temperature.

°C

malfunction message

Informs about technical availability of component.

1 = malfunction

0 = no malfunction

binary

operating message

Informs about operational state of component.

1 = operating

0 = switched-off

binary

outlet temperature

Temperature of heat carrier fluid (water) exiting the component. Also referred to as supply temperature.

°C

power consumption

Fuel power consumed by component.

kW

power consumption meter

Fuel energy consumed. Cumulating counter.

kWh

power generation

Net electrical power generation by component.

kW

power generation meter

Net electricity production. Cumulating counter.

kWh

volume flow

Volume flow of heat carrier fluid (water).

l/s

Attributes

No attributes defined for this component data model.

Available Functions

Checks for appropriate cycle behavior and provides recommendation on how to improve.

Checks if plant is operated according to a provided schedule.

Fan

The Fan component data model represents various kinds of fans.

Component Identifier
Pins
Attributes
Available Functions
Component Identifier

fan

Pins

Mind the units.

Name

Info

Unit

differential pressure

Pressure increase by fan. static pressure difference.

Pa

inverter speed

Represents fan speed and ventilation partial load.

%

malfunction message

Informs about technical availability of component.

1 = malfunction

0 = no malfunction

binary

operating message

Informs about operational state of component.

1 = operating

0 = switched-off

binary

power consumption

Electrical power consumed by component.

kW

power consumption meter

Electrical energy consumed. Cumulating counter.

kWh

volume flow

Air flow rate.

m³/h

Attributes

No attributes defined for this component data model.

Available Functions

Checks for appropriate cycle behavior and provides recommendation on how to improve.

Checks if plant is operated according to a provided schedule.

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.

Component Identifier
Pins
Attributes
Available Functions
Component Identifier

heat_meter

Pins

Mind the units.

Name

Info

Unit

heat flow

kW

heat meter

Thermal energy transferred to heat carrier fluid (water). Cumulating counter.

kWh

inlet temperature

Temperature of heat carrier fluid (water) entering the heat meter.

°C

outlet temperature

Temperature of heat carrier fluid (water) exiting the heat meter.

°C

volume flow

Volume flow of heat carrier fluid (water).

l/s

Attributes

Mind the units.

No attributes defined for this component data model.

Available Functions

under construction

Heat Pump

The Heat Pump component data model is representative for components which are able to raise the temperature level between two heat carrier loops (water/water) via thermal compression.

Component Identifier
Pins
Attributes
Available Functions
Component Identifier

heat_pump

Pins

Mind the units.

Name

Info

Unit

condenser heat flow

Thermal power transferred to heat carrier fluid (water). Condenser side.

kW

condenser heat meter

Thermal energy transferred to heat carrier fluid (water). Cumulating counter. Condenser side.

kWh

condenser inlet temperature

Temperature of heat carrier fluid (water) entering the component. Also referred to as return temperature. Condenser side.

°C

condenser outlet temperature

Temperature of heat carrier fluid (water) exiting the component. Also referred to as supply temperature. Condenser side.

°C

condenser volume flow

Volume flow of heat carrier fluid (water). Condenser side.

l/s

evaporator heat flow

Thermal power transferred to heat carrier fluid (water). Condenser side.

kW

evaporator heat meter

Thermal energy transferred to heat carrier fluid (water). Cumulating counter. Condenser side.

kWh

evaporator inlet temperature

Temperature of heat carrier fluid (water) entering the component. Also referred to as return temperature. Condenser side.

°C

evaporator outlet temperature

Temperature of heat carrier fluid (water) exiting the component. Also referred to as supply temperature. Condenser side.

°C

evaporator volume flow

Volume flow of heat carrier fluid (water). Condenser side.

l/s

malfunction message

Informs about technical availability of component.

1 = malfunction

0 = no malfunction

binary

operating message

Informs about operational state of component.

1 = operating

0 = switched-off

binary

power consumption

Electrical power consumed by component.

kW

power consumption meter

Electrical energy consumed. Cumulating counter.

kWh

Attributes

No attributes defined for this component data model.

Available Functions

Checks for appropriate cycle behavior and provides recommendation on how to improve.

Checks if plant is operated according to a provided schedule.

Room

The Room component data model is the basis component model for rooms.

Component Identifier
Pins
Attributes
Available Functions
Component Identifier

room

Pins

Mind the units.

Name

Info

Unit

co2

CO2 concentration in the room air.

ppm

co2 setpoint

Setpoint of the CO2 concentration in the room air.

ppm

dew point alarm

Alarm in case room conditions reach dew risk.

0 = no alarm

1 = alarm

binary

humidity

Relative humidity of the room air.

%

operating message

Operating message of room control.

1 = operating

0 = switched-off

binary

outside air temperature

Temperature of outside air.

°C

presence

Presence of one or more persons inside the room.

1 = presence

0 = no presence

binary

temperature

Inside air temperature in the room.

°C

temperature setpoint

Setpoint of the inside air temperature in the room.

°C

voc

Volatile organic compound concentration in the room air.

ppm

window opening

Status if window is opened or not.

1 = window open

0 = window closed

binary

Attributes

Mind the units.No attributes defined for this component data model.

Available Functions

under construction

Thermal Control Loop

The Thermal Control Loop component data model is representative for thermal control loops. It is not agnostic of its controller output like valve position or pump revolution speed.

Component Identifier
Description
Pins
Attributes
Available Functions
Component Identifier

thermal_control_loop

Description

Pins

Mind the units.

Name

Info

Unit

heat flow

Thermal power transferred to consumer circuit.

kW

heat meter

Thermal energy transferred to consumer circuit. Cumulating counter.

kWh

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

operating message

Informs about operational state of component.

1 = operating

0 = switched-off

binary

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

outlet temperature setpoint

Setpoint temperature of heat carrier fluid (water, brine) exiting the control loop. Also referred to as setpoint of supply temperature.

°C

outside air temperature

Temperature of outside air.

°C

pump operating message

Operating message of pump within the control loop.

1 = operating

0 = switched-off

binary

pump revolution speed

Revolution speed of pump within the control loop.

rpm

return temperature

Temperature of heat carrier fluid (water, brine) returning from consumer circuit. Also referred to as consumer return temperature.

°C

valve position

Degree of valve opening.

0 = fully closed

100 = fully opened

%

valve position setpoint

Setpoint for degree of valve opening.

0 = fully closed

100 = fully opened

%

volume flow

Volume flow of heat carrier fluid (water, brine).

l/s

Attributes

Do not map the attribute Cooling activation limit and Heating activation limit for the same instanced component.

Mind the units.

Reference curve

In case the Thermal Control Loop is controlled in respect to the outside air temperature: The Reference curve represents the dependency of outlet temperature setpoint on outside air temperature. It can be used for cooling as well as heating. In case the Thermal Control Loop is used for heating, the reference curve is also referred to as heat curve.

Definition Reference Curve

The Reference curve is created from two points. It is a linear curve. Copy-past the example json and fill in the numbers to specify the Reference curve for the instanced Thermal Control Loop.

Key

Type

Default Value

Unit

reference_curve

json

{

"p1_outside_air_temperature": "-12.0", "p1_outlet_temperature_setpoint": "70.0", "p2_outside_air_temperature": "18", "p2_outlet_temperature_setpoint": "35"

}

°C

The json values are float formatted strings.

Cooling activation limit

In case the Thermal Control Loop is controlled in respect to the outside air temperature: Cooling is activated for outside air temperature above the threshold mapped to the attribute Cooling activation limit. Mapping this attribute implicitly defines the component as Cooling Loop. Do not map the attribute Cooling activation limit and Heating activation limit for the same instanced component.

Key

Type

Default Value

Unit

cooling_activation_limit

float or integer

26.0

°C

Heating activation limit

In case the Thermal Control Loop is controlled in respect to the outside air temperature: Heating is activated for outside air temperature below this threshold. Mapping this attribute implicitly defines the component as Heating Loop. Do not map the attribute Cooling activation limit and Heating activation limit for the same instanced component.

Definition Heating activation limit

Key

Type

Default Value

Unit

heating_activation_limit

float or integer

18.0

°C

Upper/Lower deviation tolerance

Definition Upper/Lower deviation tolerance

Upper deviation tolerance

The Upper deviation tolerance is an optional parameter to override the default values for tolerable overshoots of the actual outlet temperature above its setpoint. The default value is 2.0 °C.

Key

Type

Default Value

Unit

upper_deviation_tolerance

float or integer

5.0

°C

Lower deviation tolerance

The Lower deviation tolerance is an optional parameter to override the default values for tolerable undercuts of the actual outlet temperature below its setpoint. The default value is 2.0 °C.

Key

Type

Default Value

Unit

lower_deviation_tolerance

float or integer

5.0

°C

Available Functions

Checks for quality of heat curve control and provides recommendation on how to improve.

Checks if control loop is operated according to a provided schedule.

Weather Station

The Weather Station component data model links weather sensors and correlating data points.

Component Identifier
Pins
Attributes
Available Functions
Component Identifier

weather_station

Pins

Mind the units.

Name

Info

Unit

cloud cover

Percent of sky covered by clouds. Measurement in order to e.g. differentiate between direct and indirect solar irradiation.

%

co2

CO2 concentration of outside air.

ppm

dew point

Dew point temperature of outside air.

°C

global solar irradiation

Current lobal solar irradiation.

W/m²

humidity

Relative humidity of outside air.

%

temperature

Temperature of outside air.

°C

voc

Volatile organic compounds concentration of outside air.

ppm

Attributes

Mind the units.

Latitude

Geographical latitude of weather station.

Key

Type

Default Value

Unit

latitude

float

6.9403

°

Longitude

Geographical longitude of weather station.

Key

Type

Default Value

Unit

longitude

float

50.9407

°

Available Functions

Outside air sensor checkup is under construction.

Information

The library of component data models is constantly expanded. If you are missing a component data model, or want us to implement it for you, feel free to contact us.