Building emulator examples¶

How to run a simple example¶

On Building Control Emulator Github repository at https://github.com/SenHuang19/BuildingControlEmulator:

folder emulatorExamples contains:
- emulatorSetup.py - to implement the emulatorSetup class
- startREST.py - to load the building emulator/FMU and start the REST server
- folder models that includes the building emulators given as FMU files
This folder needs to be bound to a folder inside the container to have access to the FMU to simulate.
folder simulationExamples contains:
- runSimulation.py - script to be run from the host computer to simulate the emulator inside the docker, control it if need be, get results, or whatever else the developer wants to add. This script is to be called (as seen later in the methodology) using
```
python runSimulation.py -u "http://0.0.0.0:5000" -d 200 -o 0 -l 1200 -s 300
```
or
```
python runSimulation.py --url="http://0.0.0.0:5000" --dayOfYear=200 --dayOffset=0 --simDuration=1200 --fmuStep=300
```
where
- -u, –url represents the URL of the Docker that runs the REST server has. In this case it is http://0.0.0.0:5000 because the emulator docker runs locally;
- -d, –dayOfYear represents the day of year when the emulator simulation starts;
- -o, –dayOffset represents the offset in seconds from second zero of the day when the simulation starts in the day previously set;
- -l, –simDuration represents the entire simulation duration in seconds;
- -s, –fmuStep represents the period for which the FMU is being simulated before stopping and/or waiting for external control; this value would actually overwrite the fmuStep given when instantiating the emulatorSetup class.

Methodology¶

Disclaimer. This procedure has been tested and worked well on a Mac or Linux machine with Docker installed as presented in Docker Container.

On a computer with docker installed, open a terminal and pull the building cnotrol emulator image.

docker pull laurmarinovici/building_control_emulator:latest

Clone the repository in to your home directory: /home/networkID.

git clone https://github.com/SenHuang19/BuildingControlEmulator

To instantiate the Docker container, run

docker run -it --rm -p="127.0.0.1:5000:5000" \
        --mount type=bind,source=/home/*networkID*/BuildingControlEmulator/emulatorExamples/,destination=/mnt/examples \
        --name=jmodelica_docker laurmarinovici/building_control_emulator:latest bash

where /home/networkID/ is the local folder where the building control emulator Github repository has been cloned to, and /mnt/examples is just a folder on the already started jmodelica_container.

At the opened terminal inside the container:

cd /mnt/examples

Run

python startREST.py --fmuPath=./models/wrapped.fmu --fmuStep=60

The app should start showing

* Serving Flask app "startREST" (lazy loading)
* Environment: production
  WARNING: This is a development server. Do not use it in a production deployment.
  Use a production WSGI server instead.
* Debug mode: off
* Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)

At a different terminal

cd /Users/mari009/PNNL_Projects/GitHubRepositories/BuildingControlEmulator/simulationExamples

python runSimulation.py --url="http://0.0.0.0:5000" --dayOfYear=200 --dayOffset=0 --simDuration=1200 --fmuStep=300

After 4 300-second intervals, within which the building emulator is simulated, the simulation ends, and the user can observe the following output files:

in <..>/BuildingControlEmulator/simulationExamples:

results.csv containing some sample measurements taken at the end of each 300-second interval

measurementsList.csv containing a list of all the measurements exposed for the building model

controlInputsList.csv containing a list of control signals that can be by an external control at the beginning of each 300-second interval to overwrite or not the default control signals that come with the building model:

<control signal name>_activate - flag that would signal to the emulator whether that control value should be overwrtten (when flag is set to 1) or disregarded (flag is set to 0)

<control signal name>_u - the actual value of the control signal for that particular time

in <..>/BuildingControlEmulator/emulatorExamples:

<FMU name>_result.mat - THIS STILL NEED TO BE WORKED OUT

Building emulator measurements nomenclature¶

Measurement name	Description (floor # = {1, 2, 3}, zone # = {1, 2, 3, 4, 5})	Unit
time	time of measurement	second
TOutDryBul_y	actual outside/ambient temperature	Kelvin
PChi_y	chiller power consumption	Watt
PPum_y	pump power consumption	Watt
PBoiler_y	boiler gas consumption	Watt
floor#_Pfan_y	fan power consumption on floor #	Watt
floor#_conCoiEco_ oveTMix_Sig_y	actual AHU mixed air temperature on floor #	Kelvin
floor#_conCoiEco_ oveTRet_Sig_y	actual AHU return air temperature on floor #	Kelvin
floor#_conCoiEco_ oveTSup_Sig_y	actual AHU SUPPLY air temperature on floor #	Kelvin
floor#_conCoiEco_ mSup_y	actual AHU SUPPLY air flow rate on floor #	kg/s
floor#_conFan_FanSpeed _Sig_y	AHU speed on floor #	Fraction
floor#_conFan_OvePre _Sig_y	AHU static pressure on floor #	Pa
floor#_conFan_ OvePreSetPoi_Sig_y	AHU static pressure set point on floor #	Pa
floor#_zon#_TSupAir_y	actual discharge air temperature in zone # on floor #	Kelvin
floor#_zon#_mSupAir_y	actual air flow in zone # on floor #	Kg/s
floor#_zon#_ TSetRooCoo_u	cooling temperature set point in zone # on floor #	Kelvin
floor#_zon#_ TSetRooHea_u	heating temperature set point in zone # on floor #	Kelvin
floor#_zon#_OccSch	occupant schedule of zone # on floor #	Binary
floor#_zon#_PPD	ppd of zone # on floor #	%

Building emulator controllable signals nomenclature¶

Signal name	Description (floor # = {1, 2, 3}, zone # = {1, 2, 3, 4, 5})	Unit
floor#_onCoiEco_Eco_ ovePos_u	set point for damper position at the AHU level on floor #	fraction
floor#_onCoiEco_oveBlockEco_ ovePos_u	damper position at the AHU level on floor #	fraction
floor#_conCoiEco_oveTMix_ oveSig_y	mixed air temperature sensor measurement at the AHU level on floor #	Kelvin
floor#_oveTout_oveSig_u	outside/ambient temperature sensor measurement at AHU level on floor #	Kelvin
floor#_conCoiEco_oveTRet_ oveSig_y	return air temperature sensor measurement at the AHU level on floor #	Kelvin
floor#_conCoiEco_oveTSupSetPoi_ oveSig_u	set point for supply air temperature at AHU level on floor #	Kelvin
floor#_conCoiEco_oveTSup_ oveSig_y	supply air temperature sensor measurement at the AHU level on floor #	Kelvin
floor#_conCoiEco_oveBlockCooCoi _oveLeakage_u	cooling coil leakage at AHU level on floor #	Fraction
floor#_conCoiEco_oveBlockCooCoi _ovePos_u	cooling coil valve position at AHU level on floor #	Fraction
floor#_conCoiEco_CooCoi _oveSig_u	position set point for cooling coil valve at AHU level on floor #	Fraction
floor#_conFan_OvePre_oveSig_u	static pressure sensor measurement at AHU level on floor #	Pa
floor#_conFan_OvePreSetPoi _oveSig_u	static pressure set point at AHU level on floor #	Pa
floor#_hvac_oveBlockDamper _ovePos_u	air flow relative to max in zone # on floor #	fraction
floor#_hvac_oveBlockHeaCoi _ovePos_u	reheat valve position in zone # on floor #	fraction
floor#_zon#_oveTRooAir_u	room air temperature sensor measurement in zone # on floor #	Kelvin
floor#_zon#_oveTSetRooCoo_u	cooling temperature set point in zone # on floor #	Kelvin
floor#_zon#_oveTSetRooHea_u	heating temperature set point in zone # on floor #	Kelvin
floor#_zon#_oveOcc	occupant schedule in zone # on floor #	Binary
oveTChWSet	set point of the chilled water leaving the chilelr	Kelvin

List of examples¶

The following examples should be found in /emulatorExamples/models/:

wrapped.fmu - just for exemplifying sake
LargeOffice - NEED DESCRIPTION
LargeOfficeFDD - NEED DESCRIPTION