From 464ab651d478d9216bf6682c202ce0c1064182ba Mon Sep 17 00:00:00 2001
From: unicod <yvtr@protonmail.com>
Date: Thu, 31 Jul 2025 21:47:59 +0200
Subject: [PATCH] uml state diagram generator

---
 ui.cpp  |  8 ++++----
 uml.awk | 10 ++++++++++
 uml.bat |  8 ++++++++
 3 files changed, 22 insertions(+), 4 deletions(-)
 create mode 100644 uml.awk
 create mode 100644 uml.bat

diff --git a/ui.cpp b/ui.cpp
index dc73aaf..9746880 100644
--- a/ui.cpp
+++ b/ui.cpp
@@ -60,7 +60,7 @@ static void UiSt_Home(UI_SM* me, uint16_t event);
 
 //u @startuml
 //u skinparam defaultTextAlignment left
-//u state UserInterface {
+//u state UserInterface as "User Interface" {
 
 /***************************************************************************//**
 * @brief Initialize state machine for user interface
@@ -132,7 +132,7 @@ void UiSt_MixerStartup(UI_SM* const me, uint16_t event) {
       case EV_UI_RX_MUTE_CH1_OFF:
       case EV_UI_RX_MUTE_CH2_ON:
       case EV_UI_RX_MUTE_CH2_OFF: {    // mixer alive
-         SM_SET_STATE(&UiSt_Home);
+         SM_SET_STATE(&UiSt_Home);     //u MixerStartup --> Home : mixer alive\n(MIDI rx)
       }break;
 
       case EV_UI_TICK_1S: {
@@ -141,7 +141,7 @@ void UiSt_MixerStartup(UI_SM* const me, uint16_t event) {
             MIDI.sendControlChange(fader.MidiCtrlNr, fader.FaderStd - ((me->Timer >> 1) % 2), 1);  // ping mixer with changing value (std, std-1, std,...)
          }
          if (++me->Timer == 15) {
-            SM_SET_STATE(&UiSt_Home);    //u MixerStartup -left-> Home : timeout
+            SM_SET_STATE(&UiSt_Home);     //u MixerStartup --> Home : timeout\n15s
          }
       }break;
    }
@@ -164,7 +164,7 @@ void UiSt_Home(UI_SM* const me, uint16_t event) {
    }
    switch (event) {
       case EV_STATE_ENTER: {
-         LedBoard.Blink(30, 270, 5);
+         LedBoard.Blink(30, 470, 15);
          // initialize mixer
          for (uint_fast8_t i=0; i<ELEMCNT(AirMutes); i++) {
             MixerMuteState& mute = AirMutes[i];
diff --git a/uml.awk b/uml.awk
new file mode 100644
index 0000000..b5da64a
--- /dev/null
+++ b/uml.awk
@@ -0,0 +1,10 @@
+#!/usr/bin/gawk -f
+
+# Execute for every lines
+{
+   umlkey = "//u ";
+   pos = index($0, umlkey);
+   if (pos) {
+      print substr($0, pos + length(umlkey))
+   }
+}
diff --git a/uml.bat b/uml.bat
new file mode 100644
index 0000000..f877803
--- /dev/null
+++ b/uml.bat
@@ -0,0 +1,8 @@
+set path=%path%;C:\MinGW\msys\1.0\bin
+set PLANTUML=C:\Tools\plantuml\plantuml.jar
+
+if not exist doc mkdir doc
+gawk -f uml.awk ui.cpp > doc\ui.uml
+cd doc
+java -jar %PLANTUML% -charset UTF-8 -tsvg ui.uml
+cd ..