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.

How to read the docs?

Component data model documentation is ordered in tabs, consisting of

Component Identifier

The component identifier is the string identifier for the component data model, used to identify the component via the aedifion API.

Pins

A pin is a generic placeholder for a datapoint within a component data model. A pin is used to map a datapoint and its time series to an instanced component within a specific project.

The tab lists all available pins for the specific component data model. Mind the expected unit of the pin.

Attributes

An attribute is a generic placeholder for meta data of a component data model. An attribute is used to map a meta data value to an instanced component within a specific project. Attributes are designed in analogy to tags.

The tab lists all available attributes for the specific component data model. Map attributes in respect to the analysis, which shall be run on an instanced component.

Analysis

Lists the available analysis functions for the component data model and links to their corresponding documentation.

Boiler

The Boiler is the component model of the heat conversion plant boiler including subcategories of boilers like condensing boilers.

Component Identifier
Pins
Attributes
Analysis
Component Identifier

boiler

Pins

Mind the units.

Name

Info

Unit

inlet temperature

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

°C

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

outlet temperature setpoint

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

°C

volume flow

Volume flow of heat carrier fluid (water)

default: l/s

use component attribute to adjust

Attributes

Custom Day Schedules

Overwrites basic schedule for specific days with an individual schedule. The json is flexibly expandable for any number of days

Key

Type

Example Value

custom_day_schedules

json

{ "2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"} }

Custom Holiday

Overwrites basic schedule for specific days. On a holiday plant operation is considered as unintentional. Add holidays to this parameter

Key

Type

Example Value

custom_holiday

json

["2020-01-02", "2020-01-28", "2020-04-07"]

Preconditioning

If the basic schedule is inherited from building usage times or opening hours, add a preconditioning attribute and thus a preconditioning period to the start time of the basic schedule. The operation of a particular plant before the start time is therefore evaluated as intended in the scope of the preconditioning time

Key

Type

Example Value

Unit

preconditioning

float (int is tolerated)

30.0

min

Regional Key

The regional key is used to automatically load regional holidays and overwrite the basic schedule with holidays accordingly. On a holiday plant operation is considered as unintentional. Utilize regional keys according ISO 3166-2

Key

Type

Example Value

regional_key

string

DE-NW

Schedule

Weekly repeated basic schedule the plant is intended to execute. Workday individual schedule. If a workday has none intentional operating times, do not add it to the schedule json

Key

Type

Example Value

schedule

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"}}

Schedule Timezone

Timezone of the schedule provided in IANA timezone codes. Default: UTC

Key

Type

Example Value

schedule_timezone

string

Europe/Berlin

Shutdown Flexibility

If the basic schedule is inherited from building usage times or opening hours, add a shutdown flexibility attribute and thus a shutdown flexibility period to the end time of the basic schedule. A shutdown of a plant prior to the end of the usage times of the building allows to consume the buffers of conditioned rooms within the limits of comfort or thermal energy of heat storages. The operation of a particular plant before the schedule end time is therefore evaluated as unintended in the scope of the shutdown flexibility

Key

Type

Example Value

Unit

shutdown_flexibility

float (int is tolerated)

30.0

min

Volume flow unit

This attribute allows to adapt the unit of the volume flow pin.

Key

Type

Available Values

volume_flow_unit

string

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.

Component Identifier
Pins
Attributes
Analysis
Component Identifier

combined heat and power

Pins

Mind the units.

Name

Info

Unit

inlet temperature

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

°C

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

outlet temperature setpoint

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

°C

volume flow

Volume flow of heat carrier fluid (water).

default: l/s

use component attribute to adjust

Attributes

Custom Day Schedules

Overwrites basic schedule for specific days with an individual schedule. The json is flexibly expandable for any number of days

Key

Type

Example Value

custom_day_schedules

json

{ "2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"} }

Custom Holiday

Overwrites basic schedule for specific days. On a holiday plant operation is considered as unintentional. Add holidays to this parameter

Key

Type

Example Value

custom_holiday

json

["2020-01-02", "2020-01-28", "2020-04-07"]

Preconditioning

If the basic schedule is inherited from building usage times or opening hours, add a preconditioning attribute and thus a preconditioning period to the start time of the basic schedule. The operation of a particular plant before the start time is therefore evaluated as intended in the scope of the preconditioning time

Key

Type

Example Value

Unit

preconditioning

float (int is tolerated)

30.0

min

Regional Key

The regional key is used to automatically load regional holidays and overwrite the basic schedule with holidays accordingly. On a holiday plant operation is considered as unintentional. Utilize regional keys according ISO 3166-2

Key

Type

Example Value

regional_key

string

DE-NW

Schedule

Weekly repeated basic schedule the plant is intended to execute. Workday individual schedule. If a workday has none intentional operating times, do not add it to the schedule json

Key

Type

Example Value

schedule

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"}}

Schedule Timezone

Timezone of the schedule provided in IANA timezone codes. Default: UTC

Key

Type

Example Value

schedule_timezone

string

Europe/Berlin

Shutdown Flexibility

If the basic schedule is inherited from building usage times or opening hours, add a shutdown flexibility attribute and thus a shutdown flexibility period to the end time of the basic schedule. A shutdown of a plant prior to the end of the usage times of the building allows to consume the buffers of conditioned rooms within the limits of comfort or thermal energy of heat storages. The operation of a particular plant before the schedule end time is therefore evaluated as unintended in the scope of the shutdown flexibility

Key

Type

Example Value

Unit

shutdown_flexibility

float (int is tolerated)

30.0

min

Volume flow unit

This attribute allows to adapt the unit of the volume flow pin.

Key

Type

Available Values

volume_flow_unit

string

litersPerSecond litersPerMinute

litersPerHour cubicMetersPerSecond

cubicMetersPerMinute

cubicMetersPerHour

Fan

The Fan component data model represents various kinds of fans.

Component Identifier
Pins
Attributes
Analysis
Component Identifier

fan

Pins

Mind the units.

Name

Info

Unit

operating message

Informs about operational state of component

1 = operating

0 = switched-off

binary

Attributes

Custom Day Schedules

Overwrites basic schedule for specific days with an individual schedule. The json is flexibly expandable for any number of days

Key

Type

Example Value

custom_day_schedules

json

{ "2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"} }

Custom Holiday

Overwrites basic schedule for specific days. On a holiday plant operation is considered as unintentional. Add holidays to this parameter

Key

Type

Example Value

custom_holiday

json

["2020-01-02", "2020-01-28", "2020-04-07"]

Preconditioning

If the basic schedule is inherited from building usage times or opening hours, add a preconditioning attribute and thus a preconditioning period to the start time of the basic schedule. The operation of a particular plant before the start time is therefore evaluated as intended in the scope of the preconditioning time

Key

Type

Example Value

Unit

preconditioning

float (int is tolerated)

30.0

min

Regional Key

The regional key is used to automatically load regional holidays and overwrite the basic schedule with holidays accordingly. On a holiday plant operation is considered as unintentional. Utilize regional keys according ISO 3166-2

Key

Type

Example Value

regional_key

string

DE-NW

Schedule

Weekly repeated basic schedule the plant is intended to execute. Workday individual schedule. If a workday has none intentional operating times, do not add it to the schedule json

Key

Type

Example Value

schedule

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"}}

Schedule Timezone

Timezone of the schedule provided in IANA timezone codes. Default: UTC

Key

Type

Example Value

schedule_timezone

string

Europe/Berlin

Shutdown Flexibility

If the basic schedule is inherited from building usage times or opening hours, add a shutdown flexibility attribute and thus a shutdown flexibility period to the end time of the basic schedule. A shutdown of a plant prior to the end of the usage times of the building allows to consume the buffers of conditioned rooms within the limits of comfort or thermal energy of heat storages. The operation of a particular plant before the schedule end time is therefore evaluated as unintended in the scope of the shutdown flexibility

Key

Type

Example Value

Unit

shutdown_flexibility

float (int is tolerated)

30.0

min

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
Analysis
Component Identifier

heat meter

Pins

Mind the units.

Name

Info

Unit

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)

default: l/s

use component attribute to adjust

Attributes

Volume flow unit

This attribute allows to adapt the unit of the volume flow pin.

Key

Type

Available Values

Unit

volume_flow_unit

string

litersPerSecond litersPerMinute

litersPerHour cubicMetersPerSecond

cubicMetersPerMinute

cubicMetersPerHour

None

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
Analysis
Component Identifier

heat pump

Pins

Mind the units.

Name

Info

Unit

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 outlet temperature setpoint

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

default: l/s

use component attribute to adjust

evaporator inlet temperature

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

°C

evaporator outlet temperature

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

°C

evaporator outlet temperature setpoint

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

evaporator volume flow

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

default: l/s

use component attribute to adjust

operating message

Informs about operational state of component

1 = operating

0 = switched-off

binary

Attributes

Custom Day Schedules

Overwrites basic schedule for specific days with an individual schedule. The json is flexibly expandable for any number of days

Key

Type

Example Value

custom_day_schedules

json

{ "2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"} }

Custom Holiday

Overwrites basic schedule for specific days. On a holiday plant operation is considered as unintentional. Add holidays to this parameter

Key

Type

Example Value

custom_holiday

json

["2020-01-02", "2020-01-28", "2020-04-07"]

Preconditioning

If the basic schedule is inherited from building usage times or opening hours, add a preconditioning attribute and thus a preconditioning period to the start time of the basic schedule. The operation of a particular plant before the start time is therefore evaluated as intended in the scope of the preconditioning time

Key

Type

Example Value

Unit

preconditioning

float (int is tolerated)

30.0

min

Regional Key

The regional key is used to automatically load regional holidays and overwrite the basic schedule with holidays accordingly. On a holiday plant operation is considered as unintentional. Utilize regional keys according ISO 3166-2

Key

Type

Example Value

regional_key

string

DE-NW

Schedule

Weekly repeated basic schedule the plant is intended to execute. Workday individual schedule. If a workday has none intentional operating times, do not add it to the schedule json

Key

Type

Example Value

schedule

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"}}

Schedule Timezone

Timezone of the schedule provided in IANA timezone codes. Default: UTC

Key

Type

Example Value

schedule_timezone

string

Europe/Berlin

Shutdown Flexibility

If the basic schedule is inherited from building usage times or opening hours, add a shutdown flexibility attribute and thus a shutdown flexibility period to the end time of the basic schedule. A shutdown of a plant prior to the end of the usage times of the building allows to consume the buffers of conditioned rooms within the limits of comfort or thermal energy of heat storages. The operation of a particular plant before the schedule end time is therefore evaluated as unintended in the scope of the shutdown flexibility

Key

Type

Example Value

Unit

shutdown_flexibility

float (int is tolerated)

30.0

min

Volume flow unit

This attribute allows to adapt the unit of the volume flow pin.

The attribute adjusts the volume flow pin unit on the condenser as well as the evaporator side of the heat pump.

Key

Type

Available Values

Unit

volume_flow_unit

string

litersPerSecond litersPerMinute

litersPerHour cubicMetersPerSecond

cubicMetersPerMinute

cubicMetersPerHour

None

Room

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

Component Identifier
Pins
Attributes
Analysis
Component Identifier

room

Pins

Mind the units.

Name

Info

Unit

co2

CO2 concentration in the room air

ppm

operating message

Operating message of room control

1 = operating

0 = switched-off

binary

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

Attributes

Custom Day Schedules

Overwrites basic schedule for specific days with an individual schedule. The json is flexibly expandable for any number of days

Key

Type

Example Value

custom_day_schedules

json

{ "2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"} }

Custom Holiday

Overwrites basic schedule for specific days. On a holiday plant operation is considered as unintentional. Add holidays to this parameter

Key

Type

Example Value

custom_holiday

json

["2020-01-02", "2020-01-28", "2020-04-07"]

Preconditioning

If the basic schedule is inherited from building usage times or opening hours, add a preconditioning attribute and thus a preconditioning period to the start time of the basic schedule. The operation of a particular plant before the start time is therefore evaluated as intended in the scope of the preconditioning time

Key

Type

Example Value

Unit

preconditioning

float (int is tolerated)

30.0

min

Regional Key

The regional key is used to automatically load regional holidays and overwrite the basic schedule with holidays accordingly. On a holiday plant operation is considered as unintentional. Utilize regional keys according ISO 3166-2

Key

Type

Example Value

regional_key

string

DE-NW

Schedule

Weekly repeated basic schedule the plant is intended to execute. Workday individual schedule. If a workday has none intentional operating times, do not add it to the schedule json

Key

Type

Example Value

schedule

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"}}

Schedule Timezone

Timezone of the schedule provided in IANA timezone codes. Default: UTC

Key

Type

Example Value

schedule_timezone

string

Europe/Berlin

Shutdown Flexibility

If the basic schedule is inherited from building usage times or opening hours, add a shutdown flexibility attribute and thus a shutdown flexibility period to the end time of the basic schedule. A shutdown of a plant prior to the end of the usage times of the building allows to consume the buffers of conditioned rooms within the limits of comfort or thermal energy of heat storages. The operation of a particular plant before the schedule end time is therefore evaluated as unintended in the scope of the shutdown flexibility

Key

Type

Example Value

Unit

shutdown_flexibility

float (int is tolerated)

30.0

min

Thermal Control Loop

The Thermal Control Loop component data model is representative for thermal control loops. It can be utilized to model thermal control loops of the conversion, distribution, and acceptance layer.

Component Identifier
Pins
Attributes
Analysis
Component Identifier

thermal control loop

Pins

Mind the units.

Name

Info

Unit

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

pump operating message

Operating message of pump within the control loop

1 = operating

0 = switched-off

binary

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

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

%

Attributes

Custom Day Schedules

Overwrites basic schedule for specific days with an individual schedule. The json is flexibly expandable for any number of days

Key

Type

Example Value

custom_day_schedules

json

{ "2020-02-28":{"start":"09:00", "end":"18:00"}, "2020-02-29":{"start":"09:00", "end":"18:00"} }

Custom Holiday

Overwrites basic schedule for specific days. On a holiday plant operation is considered as unintentional. Add holidays to this parameter

Key

Type

Example Value

custom_holiday

json

["2020-01-02", "2020-01-28", "2020-04-07"]

Preconditioning

If the basic schedule is inherited from building usage times or opening hours, add a preconditioning attribute and thus a preconditioning period to the start time of the basic schedule. The operation of a particular plant before the start time is therefore evaluated as intended in the scope of the preconditioning time

Key

Type

Example Value

Unit

preconditioning

float (int is tolerated)

30.0

min

Regional Key

The regional key is used to automatically load regional holidays and overwrite the basic schedule with holidays accordingly. On a holiday plant operation is considered as unintentional. Utilize regional keys according ISO 3166-2

Key

Type

Example Value

regional_key

string

DE-NW

Schedule

Weekly repeated basic schedule the plant is intended to execute. Workday individual schedule. If a workday has none intentional operating times, do not add it to the schedule json

Key

Type

Example Value

schedule

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"}}

Schedule Timezone

Timezone of the schedule provided in IANA timezone codes. Default: UTC

Key

Type

Example Value

schedule_timezone

string

Europe/Berlin

Shutdown Flexibility

If the basic schedule is inherited from building usage times or opening hours, add a shutdown flexibility attribute and thus a shutdown flexibility period to the end time of the basic schedule. A shutdown of a plant prior to the end of the usage times of the building allows to consume the buffers of conditioned rooms within the limits of comfort or thermal energy of heat storages. The operation of a particular plant before the schedule end time is therefore evaluated as unintended in the scope of the shutdown flexibility

Key

Type

Example Value

Unit

shutdown_flexibility

float (int is tolerated)

30.0

min

Weather Station

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

Component Identifier
Pins
Attributes
Analysis
Component Identifier

weather station

Pins

Mind the units.

Name

Info

Unit

temperature

Temperature of outside air

°C

reference temperature

Reference temperature from online databases which is used for outdoor air temperature sensor checkup

°C

Attributes

Latitude

Geographical latitude of weather station.

Key

Type

Example Value

Unit

latitude

float

6.9403

°

Longitude

Geographical longitude of weather station.

Key

Type

Example Value

Unit

longitude

float

50.9407

°

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.