tweflex_data_model/twe_flex_data_modell.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Data Modell for Project TWE-Flex"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Import Python Dependencies"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [],
   "source": [
    "from pydantic import ConfigDict, BaseModel\n",
    "from pydantic.fields import Field, FieldInfo\n",
    "from typing import Any, Optional\n",
    "\n",
    "from filip.models import FiwareHeader\n",
    "from filip.models.ngsi_v2.context import ContextEntityKeyValues\n",
    "from filip.clients.ngsi_v2.cb import ContextBrokerClient\n",
    "\n",
    "import json\n",
    "from pprint import pprint"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Definition of the data models"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Data model for temperature maintenance band"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [],
   "source": [
    "class TemperatureMaintenanceBand(BaseModel):\n",
    "    \"\"\"\n",
    "    Model for a temperature maintenance band / pipe heating system entity\n",
    "    \"\"\"\n",
    "    model_config = ConfigDict(populate_by_name=True, coerce_numbers_to_str=True)\n",
    "\n",
    "    electrical_input__resistance: float = Field(\n",
    "        alias=\"electrical_input__resistance\",\n",
    "        description=\"Electrical resistance of the THB\",\n",
    "        default=None,\n",
    "    )\n",
    "    electrical_input__voltage: float = Field(\n",
    "        alias=\"electrical_input__voltage\",\n",
    "        description=\"Voltage of the THB\",\n",
    "        default=None,\n",
    "    )\n",
    "    electrical_input__current: float = Field(\n",
    "        alias=\"electrical_input__current\",\n",
    "        description=\"Current of the THB\",\n",
    "        default=None,\n",
    "    )\n",
    "    electrical_input__power: float = Field(\n",
    "        alias=\"electrical_input__power\",\n",
    "        description=\"Power of the THB\",\n",
    "        default=None,\n",
    "    )\n",
    "    electrical_input__energy: float = Field(\n",
    "        alias=\"electrical_input__energy\",\n",
    "        description=\"Energy consumption of the THB\",\n",
    "        default=None,\n",
    "    )\n",
    "    operation__status: float = Field(\n",
    "        alias=\"operation__status\",\n",
    "        description=\"Operational status of the THB (monitoring or external control)\",\n",
    "        default=None,\n",
    "    )\n",
    "    operation__error: float = Field(\n",
    "        alias=\"operation__error\",\n",
    "        description=\"Error code\",\n",
    "        default=None,\n",
    "    )\n",
    "    operation__warning: float = Field(\n",
    "        alias=\"operation__warning\",\n",
    "        description=\"Code for warnings\",\n",
    "        default=None,\n",
    "    )\n",
    "    operation__duty_cycle__length: float = Field(\n",
    "        alias=\"operation__duty_cycle__length\",\n",
    "        description=\"Length of the operating interval\",\n",
    "        default=None,\n",
    "    )\n",
    "    operation__duty_cycle__active: float = Field(\n",
    "        alias=\"operation__duty_cycle__active\",\n",
    "        description=\"Active operating part / duty cycle (monitoring or external control)\",\n",
    "        default=None,\n",
    "    )\n",
    "    calculation_coefficient__length: float = Field(\n",
    "        alias=\"calculation_coefficient__length\",\n",
    "        description=\"Length of the THB\",\n",
    "        default=None,\n",
    "    )\n",
    "    calculation_coefficient__resistance: dict = Field(\n",
    "        alias=\"calculation_coefficient__resistance\",\n",
    "        description=\"Coefficients for calculating the temperature of the tmb\",\n",
    "        default=None,\n",
    "    )\n",
    "    calculation_coefficient__temperature: dict = Field(\n",
    "        alias=\"calculation_coefficient__temperature\",\n",
    "        description=\"Coefficients for calculating the temperature of the dhw\",\n",
    "        default=None,\n",
    "    )\n",
    "    dhw__temperature: float = Field(\n",
    "        alias=\"dhw__temperature\",\n",
    "        description=\"temperature of the dhw\",\n",
    "        default=None,\n",
    "    )"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Data model for dhw installation  "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [],
   "source": [
    "class DHWInstallation(BaseModel):\n",
    "    \"\"\"\n",
    "    Model for a DHW (domestic hot water) installation entity\n",
    "    \"\"\"\n",
    "    model_config = ConfigDict(populate_by_name=True, coerce_numbers_to_str=True)\n",
    "    \n",
    "    dhw__temperature__in: float = Field(\n",
    "        alias=\"dhw__temperature__in\",\n",
    "        description=\"Inlet temperature of the DHW\",\n",
    "        default=None,\n",
    "    )\n",
    "    dhw__temperature__out: float = Field(\n",
    "        alias=\"dhw__temperature__out\",\n",
    "        description=\"Outlet temperature of the DHW\",\n",
    "        default=None,\n",
    "    )\n",
    "    dhw__temperature__x: float = Field(\n",
    "        alias=\"dhw__temperature__x\",\n",
    "        description=\"DHW temperature at a specific position\",\n",
    "        default=None,\n",
    "    )\n",
    "    dhw__volumeflow: float = Field(\n",
    "        alias=\"dhw__volumeflow\",\n",
    "        description=\"Volume flow of the DHW in the pipe (position determination possible)\",\n",
    "        default=None,\n",
    "    )\n",
    "    \n",
    "class DHWMeasuringSection(BaseModel):\n",
    "    \"\"\"\n",
    "    Model for a DHW measuring section entity (lab use only)\n",
    "    \"\"\"\n",
    "    model_config = ConfigDict(populate_by_name=True, coerce_numbers_to_str=True)\n",
    "    \n",
    "    dhw__status__volumeflow: float = Field(\n",
    "        alias=\"dhw__status__volumeflow\",\n",
    "        description=\"Status indicating which volumetric flow meter is used\",\n",
    "        default=None,\n",
    "    )\n",
    "    tmb__temperature__x: float = Field(\n",
    "        alias=\"tmb__temperature__x\",\n",
    "        description=\"Temperature of the temperature maintenance band (position determination possible)\",\n",
    "        default=None,\n",
    "    )\n",
    "    ambient__temperature__x: float = Field(\n",
    "        alias=\"ambient__temperature__x\",\n",
    "        description=\"Ambient temperature (position determination possible)\",\n",
    "        default=None,\n",
    "    )\n",
    "    \n",
    "class DHWDistribution(BaseModel):\n",
    "    \"\"\"\n",
    "    Model for a DHW distribution entity (lab use only)\n",
    "    \"\"\"\n",
    "    model_config = ConfigDict(populate_by_name=True, coerce_numbers_to_str=True)\n",
    "    \n",
    "    dhw__temperature__setpoint_attribute: float = Field(\n",
    "        alias=\"dhw__temperature__setpoint\",\n",
    "        description=\"Value of the setpoint temperature (monitoring or external control)\",\n",
    "        default=None,\n",
    "    )\n",
    "\n",
    "    dhw__status__measuring_section: float = Field(\n",
    "        alias=\"dhw__status__measuring_section\",\n",
    "        description=\"Status indicating whether the measuring section is being flowed through\",\n",
    "        default=None,\n",
    "    )\n",
    "    dhw__status__bypass: float = Field(\n",
    "        alias=\"dhw__status__bypass\",\n",
    "        description=\"Status indicating whether the bypass is being flowed through\",\n",
    "        default=None,\n",
    "    )\n",
    "    dhw__volumeflow__setpoint_attribute: float = Field(\n",
    "        alias=\"dhw__volumeflow__setpoint\",\n",
    "        description=\"Value of the volumetric flow setpoint (monitoring or external control)\",\n",
    "        default=None,\n",
    "    )\n",
    "    \n",
    "class DHWCalculation(BaseModel):\n",
    "    \"\"\"\n",
    "    Model for a DHW calculation entity\n",
    "    \"\"\"\n",
    "    model_config = ConfigDict(populate_by_name=True, coerce_numbers_to_str=True)\n",
    "    \n",
    "    dhw__temperature__mean: float = Field(\n",
    "        alias=\"dhw__temperature__mean\",\n",
    "        description=\"Calculated temperature of the DHW\",\n",
    "        default=None,\n",
    "    )\n",
    "    dhw__tapping: float = Field(\n",
    "        alias=\"dhw__tapping\",\n",
    "        description=\"Detection of tapping events\",\n",
    "        default=None,\n",
    "    )\n",
    "    calculation__time__temperature: float = Field(\n",
    "        alias=\"calculation__time__temperature\",\n",
    "        description=\"Calculation time for determining the DHW temperature (lab use only)\",\n",
    "        default=None,\n",
    "    )\n",
    "    calculation__time__tapping: float = Field(\n",
    "        alias=\"calculation__time__tapping\",\n",
    "        description=\"Calculation time for detecting tapping events (lab use only)\",\n",
    "        default=None,\n",
    "    )"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Data model for thermal storage"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {},
   "outputs": [],
   "source": [
    "class ThermalStorage(BaseModel):\n",
    "    \"\"\"\n",
    "    Model for a thermal storage entity\n",
    "    \"\"\"\n",
    "    model_config = ConfigDict(populate_by_name=True, coerce_numbers_to_str=True)\n",
    "\n",
    "    hw_temperature__20: float = Field(\n",
    "        alias=\"hw_temperature__20\",\n",
    "        description=\"Temperature of the heating water in position at 20 per cent of the high of the thermal storage tank\",\n",
    "        default=None,\n",
    "    )\n",
    "    hw_temperature__50: float = Field(\n",
    "        alias=\"hw_temperature__50\",\n",
    "        description=\"Temperature of the heating water in position at 50 per cent of the high of the thermal storage tank\",\n",
    "        default=None,\n",
    "    )\n",
    "    hw_temperature__80: float = Field(\n",
    "        alias=\"hw_temperature__80\",\n",
    "        description=\"Temperature of the heating water in position at 80 per cent of the high of the thermal storage tank\",\n",
    "        default=None,\n",
    "    )\n",
    "    hw_volume: float = Field(\n",
    "        alias=\"hw_volume\",\n",
    "        description=\"volume of the heating water water in the thermal storage\",\n",
    "        default=None,\n",
    "    )"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Data model for heat meter"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {},
   "outputs": [],
   "source": [
    "class HeatMeter(BaseModel):\n",
    "    \"\"\"\n",
    "    Model for a heat meter\n",
    "    \"\"\"\n",
    "    model_config = ConfigDict(populate_by_name=True, coerce_numbers_to_str=True)\n",
    "\n",
    "    heat__temperature__in: float = Field(\n",
    "        alias=\"heat__temperature__in\",\n",
    "        description=\"Inlet temperature sensor of the heat meter\",\n",
    "        default=None,\n",
    "    )\n",
    "    heat__temperature__out: float = Field(\n",
    "        alias=\"heat__temperature__out\",\n",
    "        description=\"Outlet temperature sensor of the heat meter\",\n",
    "        default=None,\n",
    "    )\n",
    "    heat__volumeflow: float = Field(\n",
    "        alias=\"heat__volumeflow\",\n",
    "        description=\"Volumeflow sensor of the heat meter\",\n",
    "        default=None,\n",
    "    )\n",
    "    heat__power: Optional[float] = Field(\n",
    "        alias=\"heat__power\",\n",
    "        description=\"Heating power measured by the heat meter\",\n",
    "        default=None,\n",
    "    )\n",
    "    heat__energy: float = Field(\n",
    "        alias=\"heat__energy\",\n",
    "        description=\"Heat energy measured by the heat meter\",\n",
    "        default=None,\n",
    "    )"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Example of use with FIWARE"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Create FIWARE entity"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Merge models with simplified entity model\n",
    "class ThermalStorageFIWARE(ThermalStorage, ContextEntityKeyValues):\n",
    "    # add default for type if not explicitly set\n",
    "    type: str = FieldInfo.merge_field_infos(\n",
    "        # Field info of the general FIWARE data model in FiLiP\n",
    "        ContextEntityKeyValues.model_fields[\"type\"],\n",
    "        # set the default value\n",
    "        default=\"ThermalStorage\",\n",
    "        description=\"Type of the thermal storage\",\n",
    "    )"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Initialising the FIWARE API client"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {},
   "outputs": [],
   "source": [
    "CB_URL = \"http://localhost:1026\"\n",
    "SERVICE = 'tweflex_datamodel_test'\n",
    "SERVICE_PATH = '/'\n",
    "fiware_header = FiwareHeader(service=SERVICE,\n",
    "                             service_path=SERVICE_PATH)\n",
    "cb_client = ContextBrokerClient(url=CB_URL,\n",
    "                                fiware_header=fiware_header)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Post the entity"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "'/v2/entities/hw_storage:001?type=ThermalStorage'"
      ]
     },
     "execution_count": 8,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "thermal_storage = ThermalStorageFIWARE(\n",
    "    id=\"hw_storage:001\",\n",
    "    hw_temperature__20 = 60.0,\n",
    "    hw_temperature__50 = 70.0,\n",
    "    hw_temperature__80 = 80.0,\n",
    "    hw_volume= 1000\n",
    ")\n",
    "\n",
    "cb_client.post_entity(entity=thermal_storage, key_values=True, update=True)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Data retrieval of the entity"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "id='hw_storage:001' type='ThermalStorage' hw_temperature__20=60 hw_temperature__50=70 hw_temperature__80=80 hw_volume=1000\n"
     ]
    }
   ],
   "source": [
    "# Test with heat transfer station\n",
    "\n",
    "hw_storage = cb_client.get_entity(entity_id=thermal_storage.id, response_format=\"keyValues\")\n",
    "\n",
    "print(hw_storage)\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Delete the entity\n",
    "to ensure a clean test"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "metadata": {},
   "outputs": [],
   "source": [
    "cb_client.delete_entity(entity_id=hw_storage.id, entity_type=hw_storage.type)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Export the data modells"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "metadata": {},
   "outputs": [],
   "source": [
    "file_path = \"./schemes\""
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 12,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Data Model temperature maintenance band\n",
      "{'description': 'Model for a temperature maintenance band / pipe heating '\n",
      "                'system entity',\n",
      " 'properties': {'calculation_coefficient__length': {'default': None,\n",
      "                                                    'description': 'Length of '\n",
      "                                                                   'the THB',\n",
      "                                                    'title': 'Calculation '\n",
      "                                                             'Coefficient  '\n",
      "                                                             'Length',\n",
      "                                                    'type': 'number'},\n",
      "                'calculation_coefficient__resistance': {'default': None,\n",
      "                                                        'description': 'Coefficients '\n",
      "                                                                       'for '\n",
      "                                                                       'calculating '\n",
      "                                                                       'the '\n",
      "                                                                       'temperature '\n",
      "                                                                       'of the '\n",
      "                                                                       'tmb',\n",
      "                                                        'title': 'Calculation '\n",
      "                                                                 'Coefficient  '\n",
      "                                                                 'Resistance',\n",
      "                                                        'type': 'object'},\n",
      "                'calculation_coefficient__temperature': {'default': None,\n",
      "                                                         'description': 'Coefficients '\n",
      "                                                                        'for '\n",
      "                                                                        'calculating '\n",
      "                                                                        'the '\n",
      "                                                                        'temperature '\n",
      "                                                                        'of '\n",
      "                                                                        'the '\n",
      "                                                                        'dhw',\n",
      "                                                         'title': 'Calculation '\n",
      "                                                                  'Coefficient  '\n",
      "                                                                  'Temperature',\n",
      "                                                         'type': 'object'},\n",
      "                'dhw__temperature': {'default': None,\n",
      "                                     'description': 'temperature of the dhw',\n",
      "                                     'title': 'Dhw  Temperature',\n",
      "                                     'type': 'number'},\n",
      "                'electrical_input__current': {'default': None,\n",
      "                                              'description': 'Current of the '\n",
      "                                                             'THB',\n",
      "                                              'title': 'Electrical Input  '\n",
      "                                                       'Current',\n",
      "                                              'type': 'number'},\n",
      "                'electrical_input__energy': {'default': None,\n",
      "                                             'description': 'Energy '\n",
      "                                                            'consumption of '\n",
      "                                                            'the THB',\n",
      "                                             'title': 'Electrical Input  '\n",
      "                                                      'Energy',\n",
      "                                             'type': 'number'},\n",
      "                'electrical_input__power': {'default': None,\n",
      "                                            'description': 'Power of the THB',\n",
      "                                            'title': 'Electrical Input  Power',\n",
      "                                            'type': 'number'},\n",
      "                'electrical_input__resistance': {'default': None,\n",
      "                                                 'description': 'Electrical '\n",
      "                                                                'resistance of '\n",
      "                                                                'the THB',\n",
      "                                                 'title': 'Electrical Input  '\n",
      "                                                          'Resistance',\n",
      "                                                 'type': 'number'},\n",
      "                'electrical_input__voltage': {'default': None,\n",
      "                                              'description': 'Voltage of the '\n",
      "                                                             'THB',\n",
      "                                              'title': 'Electrical Input  '\n",
      "                                                       'Voltage',\n",
      "                                              'type': 'number'},\n",
      "                'operation__duty_cycle__active': {'default': None,\n",
      "                                                  'description': 'Active '\n",
      "                                                                 'operating '\n",
      "                                                                 'part / duty '\n",
      "                                                                 'cycle '\n",
      "                                                                 '(monitoring '\n",
      "                                                                 'or external '\n",
      "                                                                 'control)',\n",
      "                                                  'title': 'Operation  Duty '\n",
      "                                                           'Cycle  Active',\n",
      "                                                  'type': 'number'},\n",
      "                'operation__duty_cycle__length': {'default': None,\n",
      "                                                  'description': 'Length of '\n",
      "                                                                 'the '\n",
      "                                                                 'operating '\n",
      "                                                                 'interval',\n",
      "                                                  'title': 'Operation  Duty '\n",
      "                                                           'Cycle  Length',\n",
      "                                                  'type': 'number'},\n",
      "                'operation__error': {'default': None,\n",
      "                                     'description': 'Error code',\n",
      "                                     'title': 'Operation  Error',\n",
      "                                     'type': 'number'},\n",
      "                'operation__status': {'default': None,\n",
      "                                      'description': 'Operational status of '\n",
      "                                                     'the THB (monitoring or '\n",
      "                                                     'external control)',\n",
      "                                      'title': 'Operation  Status',\n",
      "                                      'type': 'number'},\n",
      "                'operation__warning': {'default': None,\n",
      "                                       'description': 'Code for warnings',\n",
      "                                       'title': 'Operation  Warning',\n",
      "                                       'type': 'number'}},\n",
      " 'title': 'TemperatureMaintenanceBand',\n",
      " 'type': 'object'}\n",
      "Data Model dhw installation\n",
      "{'description': 'Model for a DHW (domestic hot water) installation entity',\n",
      " 'properties': {'dhw__temperature__in': {'default': None,\n",
      "                                         'description': 'Inlet temperature of '\n",
      "                                                        'the DHW',\n",
      "                                         'title': 'Dhw  Temperature  In',\n",
      "                                         'type': 'number'},\n",
      "                'dhw__temperature__out': {'default': None,\n",
      "                                          'description': 'Outlet temperature '\n",
      "                                                         'of the DHW',\n",
      "                                          'title': 'Dhw  Temperature  Out',\n",
      "                                          'type': 'number'},\n",
      "                'dhw__temperature__x': {'default': None,\n",
      "                                        'description': 'DHW temperature at a '\n",
      "                                                       'specific position',\n",
      "                                        'title': 'Dhw  Temperature  X',\n",
      "                                        'type': 'number'},\n",
      "                'dhw__volumeflow': {'default': None,\n",
      "                                    'description': 'Volume flow of the DHW in '\n",
      "                                                   'the pipe (position '\n",
      "                                                   'determination possible)',\n",
      "                                    'title': 'Dhw  Volumeflow',\n",
      "                                    'type': 'number'}},\n",
      " 'title': 'DHWInstallation',\n",
      " 'type': 'object'}\n",
      "Data Model dhw measuring section\n",
      "{'description': 'Model for a DHW measuring section entity (lab use only)',\n",
      " 'properties': {'ambient__temperature__x': {'default': None,\n",
      "                                            'description': 'Ambient '\n",
      "                                                           'temperature '\n",
      "                                                           '(position '\n",
      "                                                           'determination '\n",
      "                                                           'possible)',\n",
      "                                            'title': 'Ambient  Temperature  X',\n",
      "                                            'type': 'number'},\n",
      "                'dhw__status__volumeflow': {'default': None,\n",
      "                                            'description': 'Status indicating '\n",
      "                                                           'which volumetric '\n",
      "                                                           'flow meter is used',\n",
      "                                            'title': 'Dhw  Status  Volumeflow',\n",
      "                                            'type': 'number'},\n",
      "                'tmb__temperature__x': {'default': None,\n",
      "                                        'description': 'Temperature of the '\n",
      "                                                       'temperature '\n",
      "                                                       'maintenance band '\n",
      "                                                       '(position '\n",
      "                                                       'determination '\n",
      "                                                       'possible)',\n",
      "                                        'title': 'Tmb  Temperature  X',\n",
      "                                        'type': 'number'}},\n",
      " 'title': 'DHWMeasuringSection',\n",
      " 'type': 'object'}\n",
      "Data Model dhw distribution\n",
      "{'description': 'Model for a DHW distribution entity (lab use only)',\n",
      " 'properties': {'dhw__status__bypass': {'default': None,\n",
      "                                        'description': 'Status indicating '\n",
      "                                                       'whether the bypass is '\n",
      "                                                       'being flowed through',\n",
      "                                        'title': 'Dhw  Status  Bypass',\n",
      "                                        'type': 'number'},\n",
      "                'dhw__status__measuring_section': {'default': None,\n",
      "                                                   'description': 'Status '\n",
      "                                                                  'indicating '\n",
      "                                                                  'whether the '\n",
      "                                                                  'measuring '\n",
      "                                                                  'section is '\n",
      "                                                                  'being '\n",
      "                                                                  'flowed '\n",
      "                                                                  'through',\n",
      "                                                   'title': 'Dhw  Status  '\n",
      "                                                            'Measuring Section',\n",
      "                                                   'type': 'number'},\n",
      "                'dhw__temperature__setpoint': {'default': None,\n",
      "                                               'description': 'Value of the '\n",
      "                                                              'setpoint '\n",
      "                                                              'temperature '\n",
      "                                                              '(monitoring or '\n",
      "                                                              'external '\n",
      "                                                              'control)',\n",
      "                                               'title': 'Dhw  Temperature  '\n",
      "                                                        'Setpoint',\n",
      "                                               'type': 'number'},\n",
      "                'dhw__volumeflow__setpoint': {'default': None,\n",
      "                                              'description': 'Value of the '\n",
      "                                                             'volumetric flow '\n",
      "                                                             'setpoint '\n",
      "                                                             '(monitoring or '\n",
      "                                                             'external '\n",
      "                                                             'control)',\n",
      "                                              'title': 'Dhw  Volumeflow  '\n",
      "                                                       'Setpoint',\n",
      "                                              'type': 'number'}},\n",
      " 'title': 'DHWDistribution',\n",
      " 'type': 'object'}\n",
      "Data Model dhw calculation\n",
      "{'description': 'Model for a DHW calculation entity',\n",
      " 'properties': {'calculation__time__tapping': {'default': None,\n",
      "                                               'description': 'Calculation '\n",
      "                                                              'time for '\n",
      "                                                              'detecting '\n",
      "                                                              'tapping events '\n",
      "                                                              '(lab use only)',\n",
      "                                               'title': 'Calculation  Time  '\n",
      "                                                        'Tapping',\n",
      "                                               'type': 'number'},\n",
      "                'calculation__time__temperature': {'default': None,\n",
      "                                                   'description': 'Calculation '\n",
      "                                                                  'time for '\n",
      "                                                                  'determining '\n",
      "                                                                  'the DHW '\n",
      "                                                                  'temperature '\n",
      "                                                                  '(lab use '\n",
      "                                                                  'only)',\n",
      "                                                   'title': 'Calculation  '\n",
      "                                                            'Time  Temperature',\n",
      "                                                   'type': 'number'},\n",
      "                'dhw__tapping': {'default': None,\n",
      "                                 'description': 'Detection of tapping events',\n",
      "                                 'title': 'Dhw  Tapping',\n",
      "                                 'type': 'number'},\n",
      "                'dhw__temperature__mean': {'default': None,\n",
      "                                           'description': 'Calculated '\n",
      "                                                          'temperature of the '\n",
      "                                                          'DHW',\n",
      "                                           'title': 'Dhw  Temperature  Mean',\n",
      "                                           'type': 'number'}},\n",
      " 'title': 'DHWCalculation',\n",
      " 'type': 'object'}\n",
      "Data Model thermal storage\n",
      "{'description': 'Model for a thermal storage entity',\n",
      " 'properties': {'hw_temperature__20': {'default': None,\n",
      "                                       'description': 'Temperature of the '\n",
      "                                                      'heating water in '\n",
      "                                                      'position at 20 per cent '\n",
      "                                                      'of the high of the '\n",
      "                                                      'thermal storage tank',\n",
      "                                       'title': 'Hw Temperature  20',\n",
      "                                       'type': 'number'},\n",
      "                'hw_temperature__50': {'default': None,\n",
      "                                       'description': 'Temperature of the '\n",
      "                                                      'heating water in '\n",
      "                                                      'position at 50 per cent '\n",
      "                                                      'of the high of the '\n",
      "                                                      'thermal storage tank',\n",
      "                                       'title': 'Hw Temperature  50',\n",
      "                                       'type': 'number'},\n",
      "                'hw_temperature__80': {'default': None,\n",
      "                                       'description': 'Temperature of the '\n",
      "                                                      'heating water in '\n",
      "                                                      'position at 80 per cent '\n",
      "                                                      'of the high of the '\n",
      "                                                      'thermal storage tank',\n",
      "                                       'title': 'Hw Temperature  80',\n",
      "                                       'type': 'number'},\n",
      "                'hw_volume': {'default': None,\n",
      "                              'description': 'volume of the heating water '\n",
      "                                             'water in the thermal storage',\n",
      "                              'title': 'Hw Volume',\n",
      "                              'type': 'number'}},\n",
      " 'title': 'ThermalStorage',\n",
      " 'type': 'object'}\n",
      "Data Model heat meter\n",
      "{'description': 'Model for a heat meter',\n",
      " 'properties': {'heat__energy': {'default': None,\n",
      "                                 'description': 'Heat energy measured by the '\n",
      "                                                'heat meter',\n",
      "                                 'title': 'Heat  Energy',\n",
      "                                 'type': 'number'},\n",
      "                'heat__power': {'anyOf': [{'type': 'number'}, {'type': 'null'}],\n",
      "                                'default': None,\n",
      "                                'description': 'Heating power measured by the '\n",
      "                                               'heat meter',\n",
      "                                'title': 'Heat  Power'},\n",
      "                'heat__temperature__in': {'default': None,\n",
      "                                          'description': 'Inlet temperature '\n",
      "                                                         'sensor of the heat '\n",
      "                                                         'meter',\n",
      "                                          'title': 'Heat  Temperature  In',\n",
      "                                          'type': 'number'},\n",
      "                'heat__temperature__out': {'default': None,\n",
      "                                           'description': 'Outlet temperature '\n",
      "                                                          'sensor of the heat '\n",
      "                                                          'meter',\n",
      "                                           'title': 'Heat  Temperature  Out',\n",
      "                                           'type': 'number'},\n",
      "                'heat__volumeflow': {'default': None,\n",
      "                                     'description': 'Volumeflow sensor of the '\n",
      "                                                    'heat meter',\n",
      "                                     'title': 'Heat  Volumeflow',\n",
      "                                     'type': 'number'}},\n",
      " 'title': 'HeatMeter',\n",
      " 'type': 'object'}\n"
     ]
    }
   ],
   "source": [
    "print(\"Data Model temperature maintenance band\")\n",
    "temperature_maintenance_band = TemperatureMaintenanceBand.model_json_schema()\n",
    "pprint(temperature_maintenance_band)\n",
    "\n",
    "with open(f\"{file_path}/temperature_maintenance_band_schema.json\", \"w\") as f:\n",
    "    json.dump(temperature_maintenance_band, f)\n",
    "\n",
    "print(\"Data Model dhw installation\")\n",
    "dhw_installation = DHWInstallation.model_json_schema()\n",
    "pprint(dhw_installation)\n",
    "with open(f\"{file_path}/dhw_storage_schema.json\", \"w\") as f:\n",
    "    json.dump(dhw_installation, f)\n",
    "    \n",
    "print(\"Data Model dhw measuring section\")\n",
    "dhw_measuring_section = DHWMeasuringSection.model_json_schema()\n",
    "pprint(dhw_measuring_section)\n",
    "with open(f\"{file_path}/dhw_measuring_section_schema.json\", \"w\") as f:\n",
    "    json.dump(dhw_measuring_section, f)\n",
    "    \n",
    "print(\"Data Model dhw distribution\")\n",
    "dhw_distribution = DHWDistribution.model_json_schema()\n",
    "pprint(dhw_distribution)\n",
    "with open(f\"{file_path}/dhw_distribution_schema.json\", \"w\") as f:\n",
    "    json.dump(dhw_distribution, f)\n",
    "    \n",
    "print(\"Data Model dhw calculation\")\n",
    "dhw_calculation = DHWCalculation.model_json_schema()\n",
    "pprint(dhw_calculation)\n",
    "with open(f\"{file_path}/dhw_calculation_schema.json\", \"w\") as f:\n",
    "    json.dump(dhw_calculation, f)\n",
    "    \n",
    "print(\"Data Model thermal storage\")\n",
    "thermal_storage = ThermalStorage.model_json_schema()\n",
    "pprint(thermal_storage)\n",
    "with open(f\"{file_path}/thermal_storage_schema.json\", \"w\") as f:\n",
    "    json.dump(thermal_storage, f)\n",
    "        \n",
    "print(\"Data Model heat meter\")\n",
    "heat_meter = HeatMeter.model_json_schema()\n",
    "pprint(heat_meter)\n",
    "with open(f\"{file_path}/heat_meter_schema.json\", \"w\") as f:\n",
    "    json.dump(heat_meter, f)"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "e3-fiware-data-modell-PeUllraW-py3.11",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.0"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}