Diagrams

.gitignore

@@ -31,6 +31,15 @@
 *.out
 *.app
 
+# Diagrams
+*.svg
+
 # Directories
 .vscode/
+.cache/
+.cmake/
 build/
+debug/
+release/
+docs/html/
+docs/latex/

CMakeLists.txt

@@ -1,59 +1,53 @@
-# You should always specify a range with the newest
-# and oldest tested versions of CMake. 
-cmake_minimum_required(VERSION 3.14)
-
-# set version
-set(PROJECT_VERSION 2.0.0)
-set(PROJECT_NAME EGOT_ESI)
+# You should always specify a range with the newest and oldest tested versions
+# of CMake.
+cmake_minimum_required(VERSION 3.18)
 
 # This is your project statement. You should always list languages;
 project(
-    ${PROJECT_NAME}
-    VERSION ${PROJECT_VERSION}
-)
+  EGoT
+  VERSION 0.1.0
+  LANGUAGES CXX)
 
-# specify the C++ standard
-set(CMAKE_CXX_STANDARD 11)
-set(CMAKE_CXX_STANDARD_REQUIRED True)
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 
 # fetch remote packages for development
-find_package(Boost REQUIRED filesystem python3)
-find_package(PythonLibs 3 REQUIRED)
+find_package(Boost REQUIRED python filesystem)
+
+find_package(Python3 COMPONENTS Interpreter Development)
+
+include(FindThreads)
+
+include(FindXercesC)
+
+include(FindGTest)
 
 include(FetchContent)
-FetchContent_Declare(
-  googletest
-  GIT_REPOSITORY https://github.com/google/googletest.git
-  GIT_TAG        release-1.11.0
-)
+
+set(FETCHCONTENT_UPDATES_DISCONNECTED
+    ON
+    CACHE BOOL "Do not update everytime I run cmake, please")
 
 FetchContent_Declare(
   flecs
-  GIT_REPOSITORY https://github.com/SanderMertens/flecs.git
-  GIT_TAG        v3.0.3
-)
+  GIT_REPOSITORY git@github.com:SanderMertens/flecs.git
+  GIT_TAG master)
 
-FetchContent_MakeAvailable(googletest flecs)
+FetchContent_Declare(
+  cea2045
+  GIT_REPOSITORY https://github.com/epri-dev/CTA-2045-UCM-CPP-Library.git
+  GIT_TAG v1.0)
 
-add_subdirectory(utilities)
-add_subdirectory(standards)
-add_subdirectory(ecs)
-add_subdirectory(interfaces)
-add_subdirectory(dtm)
-#add_subdirectory(gsp)
-#add_subdirectory(dcm)
+FetchContent_MakeAvailable(flecs cea2045)
 
+add_subdirectory(libs)
+add_subdirectory(apps)
 
 # install resources for programs
 execute_process(
-    COMMAND ${CMAKE_COMMAND} -E copy_directory 
-    ${CMAKE_CURRENT_SOURCE_DIR}/resources/
-    ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/
-)
+  COMMAND ${CMAKE_COMMAND} -E copy_directory
+          ${CMAKE_CURRENT_SOURCE_DIR}/resources/ ${CMAKE_BINARY_DIR}/bin/)
 
 execute_process(
-    COMMAND ${CMAKE_COMMAND} -E copy_directory 
-    ${CMAKE_CURRENT_SOURCE_DIR}/ssl/root-ca/
-    ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/root-ca
-)
+  COMMAND
+    ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/ssl/root-ca/
+    ${CMAKE_BINARY_DIR}/bin/root-ca/)

README.md

@@ -2,20 +2,56 @@
 Department of Energy - Energy Grid of Things System
 
 ## Development
+- https://tmuxcheatsheet.com/
 
 ### Linux OS
 
 ```
 cd doe-egot-system
-./setup.sh
+./tools/setup.sh
 ```
 
 ## Building
+For development the build type should be set to *Debug*, but all performance testing should use *Release*. There may be issues when trying to compile multiple build types so the build folder should have a different name.
+```shell
+cd doe-egot-system
+cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug -DCMAKE_EXPORT_COMPILE_COMMANDS=1
+cmake --build build
+```
 
+### Documentation
+If you would like to build the documentation install the following requirments and run doxygen.
+```shell
+sudo apt install doxygen graphviz
+cd docs
+doxygen
 ```
+
+If you would like a PDF of the documentation run install the following requirments and run make within the latex folder.
+```shell
+sudo apt install texlive-base texlive-latex-recommended texlive-latex-extra
+cd docs
+doxygen
+cd latex
+make
+```
+
+## Running
+Running the system as a whole is done through the *run_egot.sh* script found in tools. It will spawn tree tmux sessions: GSP, DTMC, and DERS. The DERS session will have *n* number of DCMS running in individual windows within the session. See snapshot of terminal after running.
+
+
+```shell
 cd doe-egot-system
-cmake -S . -B build
-cmake --build build
+./tools/run_egot.sh <n>
+tmux ls
+tmux a -t <session>
+```
+
+## Stop
+Stopping the EGoT system only requires stopping all tmux sessions. 
+
+```shell
+tmux kill-server
 ```
 
 ## Project Organization

apps/CMakeLists.txt

@@ -0,0 +1,11 @@
+add_subdirectory(dtm)
+add_subdirectory(dcm)
+add_subdirectory(dcm-aosmith)
+add_subdirectory(gsp)
+add_subdirectory(simple)
+execute_process(
+  COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/dtm/
+          ${CMAKE_BINARY_DIR}/bin/)
+execute_process(
+  COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/me/
+          ${CMAKE_BINARY_DIR}/bin/)

apps/dcm-aosmith/CMakeLists.txt

@@ -0,0 +1,7 @@
+add_executable(dcm_aosmith src/main.cpp)
+target_link_libraries(dcm_aosmith trust::cta2045 ecs::cta2045 sep::models
+                      EGoT::utils Threads::Threads)
+
+add_executable(dcm_aosmith_test src/test.cpp)
+target_link_libraries(dcm_aosmith_test trust::cta2045 ecs::cta2045 EGoT::utils
+                      Threads::Threads)

apps/dcm-aosmith/src/main.cpp

@@ -0,0 +1,27 @@
+#include <ecs/client/cta2045/commodity.hpp>
+#include <https/client/client.hpp>
+#include <iostream>
+#include <sep/models/active_power.hpp>
+#include <sep/models/real_energy.hpp>
+#include <string>
+#include <trust/cta2045/trust_device.hpp>
+#include <utilities/utilities.hpp>
+
+std::string g_program_path;
+// create config xml with these values and store somewhere
+float frr_time_window;
+float comfort_threshold;
+
+int main(int argc, char **argv) {
+  std::cout << "Starting DCM for AOSmith water heater\n";
+  g_program_path = psu::utilities::getProgramPath(argv);
+
+  flecs::world ecs;
+  ecs.import <ecs::client::commodity::Module>();
+  ecs.entity().set<sep::ActivePower>({0, 0});
+  ecs.entity().set<sep::RealEnergy>({0, 0});
+  https::Context dtm_ctx = {"1", g_program_path, "0.0.0.0", "8090"};
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx);
+  ecs.app().target_fps(1).run();
+  return 0;
+}

apps/dcm-aosmith/src/test.cpp

@@ -0,0 +1,46 @@
+
+#include <chrono>
+#include <https/client/client.hpp>
+#include <iostream>
+#include <string>
+#include <thread>
+#include <trust/cta2045/trust_device.hpp>
+#include <utilities/utilities.hpp>
+
+std::string g_program_path;
+
+int main(int argc, char **argv) {
+  std::cout << "Starting DCM for AOSmith water heater\n";
+  g_program_path = psu::utilities::getProgramPath(argv);
+
+  https::Context dtm_ctx = {"1", g_program_path, "0.0.0.0", "8090"};
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx);
+  std::this_thread::sleep_for(std::chrono::seconds(1));
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).getOutsideCommunicationStatus(cea2045::OutsideCommuncatonStatusCode::Found);
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).getOperationalState();
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).getDeviceInfo();
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).getCommodity();
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).loadUp(0); 
+  std::this_thread::sleep_for(std::chrono::seconds(10));
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).getOperationalState();
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).getCommodity();
+  std::this_thread::sleep_for(std::chrono::seconds(10));
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).endShed(0);
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).criticalPeakEvent(60);
+  std::this_thread::sleep_for(std::chrono::seconds(10));
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).getOperationalState();
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).endShed(0);
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).gridEmergency(60);
+  std::this_thread::sleep_for(std::chrono::seconds(10));
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).getOperationalState();
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).endShed(0);
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).shed(60);
+  std::this_thread::sleep_for(std::chrono::seconds(10));
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).getOperationalState();
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).loadUp(0); 
+  std::this_thread::sleep_for(std::chrono::seconds(10));
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).getOperationalState();
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).getCommodity();
+  trust::cta2045Device::getInstance("/dev/ttyAMA0", dtm_ctx).shed(0);
+return 0;
+}

apps/dcm/CMakeLists.txt

@@ -0,0 +1,14 @@
+add_executable(dcm
+    src/main.cpp
+)
+
+# target_include_directories(dcm PUBLIC include)
+
+target_link_libraries(dcm
+    ecs::client::sep
+    ecs::simulator
+    https::client
+    trust::client
+    EGoT::utils
+    Threads::Threads
+)