add diagrams from freyja

.github/workflows/generate-plantuml.yml

@@ -0,0 +1,27 @@
+name: generate plantuml
+
+on:
+  push:
+    paths:
+      - '**.puml'
+
+jobs:
+  generate_plantuml:
+    runs-on: ubuntu-latest
+    name: plantuml
+    steps:
+    - name: checkout
+      uses: actions/checkout@v3
+    - name: generate plantuml
+      run: |
+        sudo apt-get install -y plantuml graphviz
+        # This uses a slightly off-white background color because #ffffff renders as transparent for some reason
+        plantuml -tsvg -SbackgroundColor=fefefe -checkmetadata -v **/*.puml
+      shell: bash
+    - name: commit changes
+      uses: EndBug/add-and-commit@v9
+      with:
+        author_name: Automated Notice Generation Pipeline
+        author_email: [email protected]
+        message: Generate PlantUML Diagrams
+        pathspec_error_handling: exitAtEnd

cloud_connectors/azure/digital_twins_connector/README.md

@@ -8,6 +8,8 @@ Freyja is not tightly coupled with Azure and can synchronize data with any cloud
 
 The Azure Digital Twins Cloud Connector forwards data emitted by Freyja to Azure Digital Twins. This cloud connector will connect directly to an Azure Digital Twins instance and serves as a minimal example of how to send data to Azure Digital Twins from the device.
 
+![Component Diagram](../../../docs/diagrams/azure_digital_twins_cloud_connector.svg)
+
 ## Prerequisites
 
 ### .NET 6.0 Setup

cloud_connectors/azure/mqtt_connector/README.md

@@ -10,6 +10,8 @@ For this Cloud Connector sample, you will use Azure to deploy an Azure Key Vault
 
 The Azure MQTT Cloud Connector forwards data emitted by Freyja to an Azure Event Grid using the MQTT Protocol. This cloud connector also includes an associated Azure Function which will forward the data to Azure Digital Twins, but the data from Azure Event Grid can be ingested by any desired cloud architecture using the appropriate connector.
 
+![Component Diagram](../../../docs/diagrams/azure_mqtt_cloud_connector.svg)
+
 ## Prerequisites
 
 ### Azure Digital Twins Deployed

docs/diagrams/azure_digital_twins_cloud_connector.puml

@@ -0,0 +1,25 @@
+@startuml
+
+cloud {
+    [Azure Digital Twins]
+}
+
+frame "Azure Digital Twins Connector" as azure_cloud_connector {
+    [Azure Digital Twins Client]
+}
+
+frame "Freyja" as freyja {
+    [Emitter] -left-> [Cloud Adapter]
+}
+
+[Azure Digital Twins Client] -up---> [Azure Digital Twins]
+
+azure_cloud_connector -down- cloud_connector.proto
+
+[Cloud Adapter] -left--> cloud_connector.proto
+
+' The two hidden arrows below help with spacing between the "Freyja" frame and the "cloud_connector.proto" interface
+[Emitter] -[hidden]right--> cloud_connector.proto
+[Emitter] -[hidden]up--------> cloud_connector.proto
+
+@enduml

docs/diagrams/azure_mqtt_cloud_connector.puml

@@ -0,0 +1,26 @@
+@startuml
+
+cloud {
+    [Azure Function] -up-> [Azure Digital Twin]
+    [Event Grid with MQTT v5] -up-> [Azure Function]
+}
+
+frame "Azure MQTT Connector" as azure_mqtt_cloud_connector {
+    [MQTT v5 Client]
+}
+
+frame "Freyja" as freyja {
+    [Emitter] -left-> [Cloud Adapter]
+}
+
+[MQTT v5 Client] -left-> [Event Grid with MQTT v5]
+
+azure_mqtt_cloud_connector -down- cloud_connector.proto
+
+[Cloud Adapter] -left--> cloud_connector.proto
+
+' The two hidden arrows below help with spacing between the "Freyja" frame and the "cloud_connector.proto" interface
+[Emitter] -[hidden]right--> cloud_connector.proto
+[Emitter] -[hidden]up--------> cloud_connector.proto
+
+@enduml