Application layer refactored.

BlueAndi · Dec 30, 2024 · de5481d · de5481d
1 parent 0f588f4
commit de5481d
Show file tree

Hide file tree

Showing 46 changed files with 102 additions and 52 deletions.
diff --git a/config/mcu.ini b/config/mcu.ini
@@ -7,13 +7,14 @@ platform_packages =
   framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32.git#release/v2.x
 framework = arduino
 build_flags =
-    -I./src/Common
+    -I./src/ButtonHandler
+    -I./src/DisplayMgr
+    -I./src/General
     -I./src/Generated
-    -I./src/Gfx
     -I./src/Hal
     -I./src/Performance
     -I./src/Plugin
-    -I./src/StateMachine
+    -I./src/SystemState
     -I./src/Update
     -I./src/Web
     -I./src/Web/WsCommand

diff --git a/doc/architecture/README.md b/doc/architecture/README.md
@@ -8,7 +8,7 @@
 * [Purpose](#purpose)
 * [Scope](#scope)
 * [Context](#context)
-* [Deployment](#deployment)
+* [Task Deployment](#task-deployment)
 * [Layers](#layers)
   * [Application](#application)
   * [Services](#services)
@@ -43,7 +43,8 @@ PIXELIX as a system is not complete alone. It interacts with other neighbor syst
 
 ![context-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/Pixelix/master/doc/architecture/uml/context.wsd)
 
-# Deployment
+# Task Deployment
+The diagram shows the task deployment on the esp32 dual core derivates.
 
 ![deployment-diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/Pixelix/master/doc/architecture/uml/deployment.wsd)
 

diff --git a/doc/architecture/uml/app_layer.wsd b/doc/architecture/uml/app_layer.wsd
@@ -1,31 +1,53 @@
 @startuml app_layer
 
-skinparam component {
-    BackgroundColor<<Arduino>> Lightgreen
-    BackgroundColor<<Future>> White
-}
-
 package "Application" as app {
 
-    component "StateMachine" as stateMachine
-    component "DisplayMgr" as displayMgr
-    component "UpdateMgr" as updateMgr
+    component "main" as main <<program-entry>>
+
+    package "StateMachine" as stateMachinePckg {
+        component "StateMachine" as stateMachine
+    }
+
+    package "General" as generalPckg {
+        component "MiniTerminal" as miniTerminal
+        component "MemoryMonitor" as memoryMonitor
+    }
+
+    package "ButtonHandler" as buttonHandlerPckg {
+        component "ButtonHandler" as buttonHandler
+    }
+
+    package "DisplayMgr" as displayMgrPckg {
+        component "DisplayMgr" as displayMgr
+    }
 
-    package Plugin
+    package "Plugin" as pluginPckg {
+        component "PluginMgr" as pluginMgr
+    }
+
+    package "SystemState" as systemStatePckg {
+        component "APState" as apState
+        component "ConnectedState" as connectedState
+        component "ConnectingState" as connectingState
+        component "ErrorState" as errorState
+        component "IdleState" as idleState
+        component "InitState" as initState
+        component "RestartState" as restartState
+    }
 
-    package "State" as state {
-        component "APState"
-        component "ConnectedState"
-        component "ConnectingState"
-        component "ErrorState"
-        component "IdleState"
-        component "InitState"
-        component "RestartState"
+    package "Update" as updatePckg {
+        component "UpdateMgr" as updateMgr
     }
 
-    stateMachine ...> state
+    main --> stateMachine
+    main --> miniTerminal
+    main ---> buttonHandler
+    main --> memoryMonitor
+    stateMachine o---> systemStatePckg
 
-    displayMgr ..> Plugin
+    initState ...> updateMgr: <<use>>
+    connectedState ...> updateMgr: <<use>>
+    restartState ...> updateMgr: <<use>>
 }
 
 @enduml
diff --git a/doc/doxygen/mainpage.dox b/doc/doxygen/mainpage.dox
@@ -4,29 +4,55 @@
 Full RGB LED matrix, based on an ESP32 and WS2812B LEDs.
 <hr>
 
-@defgroup gfx Graphics functions
-The graphics functions containing all kind of widgets and the main display manager,
-as well as the LED matrix controller.
+@defgroup APP_LAYER Application layer
+The application layer.
+@{
+@}
+
+@defgroup SERVICE_LAYER Service layer
+The service layer.
 @{
 @}
 
-@defgroup hal Hardware abstraction
-The hardware abstraction makes it easier to use internal and external peripherals.
+@defgroup HA_LAYER Hardware abstraction layer
+The hardware abstraction layer.
 @{
 @}
 
-@defgroup statemachine Statemachine
+
+@defgroup STATE_MACHINE Statemachine
+@ingroup APP_LAYER
 Generic state machine.
 @{
 @}
 
-@defgroup sys_states System states
+@defgroup SYS_STATES System states
+@ingroup APP_LAYER
 The system states.
 @{
 @}
 
-@defgroup update Update routines
-The over-the-air update rountes.
+@defgroup DISPLAY_MGR Display manager
+@ingroup APP_LAYER
+The display manager.
+@{
+@}
+
+@defgroup BUTTON_HANDLER Button handler
+@ingroup APP_LAYER
+The button handler.
+@{
+@}
+
+@defgroup UPDATE Update routines
+@ingroup APP_LAYER
+The over-the-air update routines.
+@{
+@}
+
+@defgroup gfx Graphics functions
+The graphics functions containing all kind of widgets and the main display manager,
+as well as the LED matrix controller.
 @{
 @}
 

diff --git a/lib/StateMachine/src/StateMachine.hpp b/lib/StateMachine/src/StateMachine.hpp
@@ -28,7 +28,7 @@
  * @brief  Abstract state machine
  * @author Andreas Merkle <[email protected]>
  * 
- * @addtogroup statemachine
+ * @addtogroup STATE_MACHINE
  *
  * @{
  */

diff --git a/src/Common/WiFiUtil.cpp → lib/Utilities/src/WiFiUtil.cpp b/src/Common/WiFiUtil.cpp → lib/Utilities/src/WiFiUtil.cpp
diff --git a/src/Common/WiFiUtil.h → lib/Utilities/src/WiFiUtil.h b/src/Common/WiFiUtil.h → lib/Utilities/src/WiFiUtil.h
diff --git a/src/Common/ButtonActions.cpp → src/ButtonHandler/ButtonActions.cpp b/src/Common/ButtonActions.cpp → src/ButtonHandler/ButtonActions.cpp
diff --git a/src/Common/ButtonActions.h → src/ButtonHandler/ButtonActions.h b/src/Common/ButtonActions.h → src/ButtonHandler/ButtonActions.h
@@ -28,7 +28,7 @@
  * @brief  Button actions
  * @author Andreas Merkle <[email protected]>
  * 
- * @addtogroup app
+ * @addtogroup BUTTON_HANDLER
  *
  * @{
  */

diff --git a/src/Common/ButtonHandler.hpp → src/ButtonHandler/ButtonHandler.hpp b/src/Common/ButtonHandler.hpp → src/ButtonHandler/ButtonHandler.hpp
@@ -28,7 +28,7 @@
  * @brief  Button handler
  * @author Andreas Merkle <[email protected]>
  * 
- * @addtogroup app
+ * @addtogroup BUTTON_HANDLER
  *
  * @{
  */

diff --git a/src/Common/OneButtonCtrl.hpp → src/ButtonHandler/OneButtonCtrl.hpp b/src/Common/OneButtonCtrl.hpp → src/ButtonHandler/OneButtonCtrl.hpp
@@ -28,7 +28,7 @@
  * @brief  One button controller
  * @author Andreas Merkle <[email protected]>
  * 
- * @addtogroup app
+ * @addtogroup BUTTON_HANDLER
  *
  * @{
  */

diff --git a/src/Common/ThreeButtonCtrl.hpp → src/ButtonHandler/ThreeButtonCtrl.hpp b/src/Common/ThreeButtonCtrl.hpp → src/ButtonHandler/ThreeButtonCtrl.hpp
@@ -28,7 +28,7 @@
  * @brief  Three button controller
  * @author Andreas Merkle <[email protected]>
  * 
- * @addtogroup app
+ * @addtogroup BUTTON_HANDLER
  *
  * @{
  */

diff --git a/src/Common/TwoButtonCtrl.hpp → src/ButtonHandler/TwoButtonCtrl.hpp b/src/Common/TwoButtonCtrl.hpp → src/ButtonHandler/TwoButtonCtrl.hpp
@@ -28,7 +28,7 @@
  * @brief  Two button controller
  * @author Andreas Merkle <[email protected]>
  * 
- * @addtogroup app
+ * @addtogroup BUTTON_HANDLER
  *
  * @{
  */

diff --git a/src/Gfx/AmbientLight.cpp → src/DisplayMgr/AmbientLight.cpp b/src/Gfx/AmbientLight.cpp → src/DisplayMgr/AmbientLight.cpp
diff --git a/src/Gfx/AmbientLight.h → src/DisplayMgr/AmbientLight.h b/src/Gfx/AmbientLight.h → src/DisplayMgr/AmbientLight.h
@@ -28,7 +28,7 @@
  * @brief  Ambient light functions
  * @author Andreas Merkle <[email protected]>
  *
- * @addtogroup gfx
+ * @addtogroup DISPLAY_MGR
  *
  * @{
  */

diff --git a/src/Gfx/BrightnessCtrl.cpp → src/DisplayMgr/BrightnessCtrl.cpp b/src/Gfx/BrightnessCtrl.cpp → src/DisplayMgr/BrightnessCtrl.cpp
diff --git a/src/Gfx/BrightnessCtrl.h → src/DisplayMgr/BrightnessCtrl.h b/src/Gfx/BrightnessCtrl.h → src/DisplayMgr/BrightnessCtrl.h
@@ -28,7 +28,7 @@
  * @brief  Brightness controller
  * @author Andreas Merkle <[email protected]>
  *
- * @addtogroup gfx
+ * @addtogroup DISPLAY_MGR
  *
  * @{
  */

diff --git a/src/Gfx/DisplayMgr.cpp → src/DisplayMgr/DisplayMgr.cpp b/src/Gfx/DisplayMgr.cpp → src/DisplayMgr/DisplayMgr.cpp
diff --git a/src/Gfx/DisplayMgr.h → src/DisplayMgr/DisplayMgr.h b/src/Gfx/DisplayMgr.h → src/DisplayMgr/DisplayMgr.h
@@ -28,7 +28,7 @@
  * @brief  Display manager
  * @author Andreas Merkle <[email protected]>
  *
- * @addtogroup gfx
+ * @addtogroup DISPLAY_MGR
  *
  * @{
  */

diff --git a/src/Gfx/Slot.cpp → src/DisplayMgr/Slot.cpp b/src/Gfx/Slot.cpp → src/DisplayMgr/Slot.cpp
diff --git a/src/Gfx/Slot.h → src/DisplayMgr/Slot.h b/src/Gfx/Slot.h → src/DisplayMgr/Slot.h
@@ -28,7 +28,7 @@
  * @brief  Slot
  * @author Andreas Merkle <[email protected]>
  *
- * @addtogroup gfx
+ * @addtogroup DISPLAY_MGR
  *
  * @{
  */

diff --git a/src/Gfx/SlotList.cpp → src/DisplayMgr/SlotList.cpp b/src/Gfx/SlotList.cpp → src/DisplayMgr/SlotList.cpp
diff --git a/src/Gfx/SlotList.h → src/DisplayMgr/SlotList.h b/src/Gfx/SlotList.h → src/DisplayMgr/SlotList.h
@@ -28,7 +28,7 @@
  * @brief  Slot list
  * @author Andreas Merkle <[email protected]>
  *
- * @addtogroup gfx
+ * @addtogroup DISPLAY_MGR
  *
  * @{
  */

diff --git a/src/Common/MemMon.cpp → src/General/MemMon.cpp b/src/Common/MemMon.cpp → src/General/MemMon.cpp
diff --git a/src/Common/MemMon.h → src/General/MemMon.h b/src/Common/MemMon.h → src/General/MemMon.h
diff --git a/src/Common/MiniTerminal.cpp → src/General/MiniTerminal.cpp b/src/Common/MiniTerminal.cpp → src/General/MiniTerminal.cpp
diff --git a/src/Common/MiniTerminal.h → src/General/MiniTerminal.h b/src/Common/MiniTerminal.h → src/General/MiniTerminal.h
diff --git a/src/Common/SysMsg.cpp → src/General/SysMsg.cpp b/src/Common/SysMsg.cpp → src/General/SysMsg.cpp
diff --git a/src/Common/SysMsg.h → src/General/SysMsg.h b/src/Common/SysMsg.h → src/General/SysMsg.h
diff --git a/src/Common/Version.cpp → src/General/Version.cpp b/src/Common/Version.cpp → src/General/Version.cpp
diff --git a/src/Common/Version.h → src/General/Version.h b/src/Common/Version.h → src/General/Version.h
diff --git a/src/StateMachine/APState.cpp → src/SystemState/APState.cpp b/src/StateMachine/APState.cpp → src/SystemState/APState.cpp
diff --git a/src/StateMachine/APState.h → src/SystemState/APState.h b/src/StateMachine/APState.h → src/SystemState/APState.h
@@ -28,7 +28,7 @@
  * @brief  System state: AP
  * @author Andreas Merkle <[email protected]>
  *
- * @addtogroup sys_states
+ * @addtogroup SYS_STATES
  *
  * @{
  */

diff --git a/src/StateMachine/ConnectedState.cpp → src/SystemState/ConnectedState.cpp b/src/StateMachine/ConnectedState.cpp → src/SystemState/ConnectedState.cpp
diff --git a/src/StateMachine/ConnectedState.h → src/SystemState/ConnectedState.h b/src/StateMachine/ConnectedState.h → src/SystemState/ConnectedState.h
@@ -28,7 +28,7 @@
  * @brief  System state: Connected
  * @author Andreas Merkle <[email protected]>
  * 
- * @addtogroup sys_states
+ * @addtogroup SYS_STATES
  * 
  * @{
  */

diff --git a/src/StateMachine/ConnectingState.cpp → src/SystemState/ConnectingState.cpp b/src/StateMachine/ConnectingState.cpp → src/SystemState/ConnectingState.cpp
diff --git a/src/StateMachine/ConnectingState.h → src/SystemState/ConnectingState.h b/src/StateMachine/ConnectingState.h → src/SystemState/ConnectingState.h
@@ -28,7 +28,7 @@
  * @brief  System state: Connecting
  * @author Andreas Merkle <[email protected]>
  * 
- * @addtogroup sys_states
+ * @addtogroup SYS_STATES
  * 
  * @{
  */

diff --git a/src/StateMachine/ErrorState.cpp → src/SystemState/ErrorState.cpp b/src/StateMachine/ErrorState.cpp → src/SystemState/ErrorState.cpp
diff --git a/src/StateMachine/ErrorState.h → src/SystemState/ErrorState.h b/src/StateMachine/ErrorState.h → src/SystemState/ErrorState.h
@@ -28,7 +28,7 @@
  * @brief  System state: Error
  * @author Andreas Merkle <[email protected]>
  * 
- * @addtogroup sys_states
+ * @addtogroup SYS_STATES
  * 
  * @{
  */

diff --git a/src/StateMachine/IdleState.cpp → src/SystemState/IdleState.cpp b/src/StateMachine/IdleState.cpp → src/SystemState/IdleState.cpp
diff --git a/src/StateMachine/IdleState.h → src/SystemState/IdleState.h b/src/StateMachine/IdleState.h → src/SystemState/IdleState.h
@@ -28,7 +28,7 @@
  * @brief  System state: Idle
  * @author Andreas Merkle <[email protected]>
  * 
- * @addtogroup sys_states
+ * @addtogroup SYS_STATES
  * 
  * @{
  */

diff --git a/src/StateMachine/InitState.cpp → src/SystemState/InitState.cpp b/src/StateMachine/InitState.cpp → src/SystemState/InitState.cpp
diff --git a/src/StateMachine/InitState.h → src/SystemState/InitState.h b/src/StateMachine/InitState.h → src/SystemState/InitState.h
@@ -28,7 +28,7 @@
  * @brief  System state: Init
  * @author Andreas Merkle <[email protected]>
  *
- * @addtogroup sys_states
+ * @addtogroup SYS_STATES
  *
  * @{
  */

diff --git a/src/StateMachine/RestartState.cpp → src/SystemState/RestartState.cpp b/src/StateMachine/RestartState.cpp → src/SystemState/RestartState.cpp
diff --git a/src/StateMachine/RestartState.h → src/SystemState/RestartState.h b/src/StateMachine/RestartState.h → src/SystemState/RestartState.h
@@ -28,7 +28,7 @@
  * @brief  System state: Restart
  * @author Andreas Merkle <[email protected]>
  *
- * @addtogroup sys_states
+ * @addtogroup SYS_STATES
  *
  * @{
  */

diff --git a/src/Update/UpdateMgr.h b/src/Update/UpdateMgr.h
@@ -28,7 +28,7 @@
  * @brief  Update manager
  * @author Andreas Merkle <[email protected]>
  * 
- * @addtogroup update
+ * @addtogroup UPDATE
  *
  * @{
  */