Merge pull request #54 from jknoxdev:diagrams-update

Fix PlantUML render pipeline and redraw diagrams for presentation

Author: jknoxdev

.github/workflows/render-diagrams.yml

@@ -4,37 +4,55 @@ on:
   push:
     paths:
       - '**.puml'
+      - '.github/workflows/plantuml.yml'
   workflow_dispatch:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   render:
     runs-on: ubuntu-latest
     permissions:
       contents: write
 
+    env:
+      PLANTUML_VERSION: "1.2026.0"
+
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
+
+      - name: Set up Java
+        uses: actions/setup-java@v4
         with:
-          fetch-depth: 0
+          distribution: temurin
+          java-version: '17'
+
+      - name: Install Graphviz
+        run: sudo apt-get update -q && sudo apt-get install -y graphviz
+
+      - name: Fetch PlantUML jar
+        run: |
+          curl -fsSL -o plantuml.jar \
+            "https://github.com/plantuml/plantuml/releases/download/v${PLANTUML_VERSION}/plantuml-${PLANTUML_VERSION}.jar"
+          java -jar plantuml.jar -version
 
-      - name: Install PlantUML
+      - name: Render svg
         run: |
-          sudo apt-get update -q
-          sudo apt-get install -y plantuml
+          find . -name '*.puml' -not -path './.git/*' -print0 \
+            | xargs -0 -r java -jar plantuml.jar -tsvg -nometadata -failfast2
 
-      - name: Render SVG and PNG
+      - name: Render png
         run: |
-          find . -name "*.puml" | while read f; do
-            echo "Rendering $f"
-            plantuml -tsvg "$f"
-            plantuml -tpng "$f"
-          done
+          find . -name '*.puml' -not -path './.git/*' -print0 \
+            | xargs -0 -r java -jar plantuml.jar -tpng -nometadata -failfast2
 
       - name: Commit rendered diagrams
         uses: stefanzweifel/git-auto-commit-action@v5
         with:
-          commit_message: "ci: auto-render PlantUML diagrams [skip ci]"
+          commit_message: "ci: auto-render PlantUML diagrams"
           file_pattern: "**/*.svg **/*.png"
           commit_user_name: "github-actions[bot]"
           commit_user_email: "github-actions[bot]@users.noreply.github.com"

docs/architecture/component.png

@@ -0,0 +1,49 @@
+@startuml fsm-simple
+!pragma layout smetana
+
+skinparam {
+    BackgroundColor #1a1a2e
+    ArrowColor #7EC8E3
+    ArrowFontColor #CCCCCC
+    ArrowFontSize 13
+    DefaultFontName Arial
+    DefaultFontColor #E0E0E0
+    DefaultFontSize 14
+    StateBorderColor #4A90D9
+    StateBorderThickness 2
+    StateBackgroundColor #0f3460
+    StateFontColor #FFFFFF
+    StateFontSize 16
+    NoteBackgroundColor #0D2818
+    NoteBorderColor #27AE60
+    NoteFontColor #27AE60
+    NoteFontSize 13
+    nodesep 36
+    ranksep 38
+}
+
+state "BOOT" as boot #1a3060
+state "CALIBRATING" as cal #2a1a0a
+state "ARMED" as armed #0D3320
+state "SLEEP" as sleep #0a1a3a
+state "EVENT\nDETECTED" as evt #2a1a4a
+state "SIGN" as sign #3a1a2a
+state "ENCRYPT" as enc #3a1a2a
+state "TX" as tx #0f3460
+
+[*] -right-> boot
+boot -right-> cal : self-test\npass
+cal -right-> armed : baseline\nestablished
+armed -right-> sleep : idle
+sleep -right-> evt : sensor IRQ
+evt -right-> enc
+enc -right-> sign
+sign -left-> tx
+tx -up-> armed : re-arm
+
+note bottom of cal
+  Baseline is captured once.
+  Drift after this point is signal.
+end note
+
+@enduml

docs/architecture/component.svg

@@ -0,0 +1,50 @@
+@startuml node
+
+allowmixing
+
+skinparam {
+    BackgroundColor #1a1a2e
+    ArrowColor #7EC8E3
+    ArrowFontColor #CCCCCC
+    ArrowFontSize 13
+    DefaultFontName Arial
+    DefaultFontColor #E0E0E0
+    DefaultFontSize 14
+    StateBorderColor #4A90D9
+    StateBorderThickness 2
+    StateBackgroundColor #0f3460
+    StateFontColor #FFFFFF
+    StateFontSize 16
+    NoteBackgroundColor #0D2818
+    NoteBorderColor #27AE60
+    NoteFontColor #27AE60
+    NoteFontSize 13
+    PackageBorderColor #4A90D9
+    PackageBackgroundColor #0f1a2e
+    PackageFontColor #7EC8E3
+    PackageFontSize 15
+    nodesep 36
+    ranksep 40
+}
+
+package "LIMA Node"{
+
+    package "Sensors" {
+        state "Motion" as motion #0D3320
+        state "Barometric" as baro #2a1a0a
+        state "Realtime\nClock" as rtc #2a1a4a
+    }
+
+    package "MCU" {
+        state "nRF52840" as mcu #1a3060
+    }
+    
+}
+
+state "nRF52840" as mcu #1a3060
+
+motion -up-> mcu
+baro -up-> mcu
+rtc -up-> mcu
+
+@enduml