Doxygen Workflow

.github/workflows/generate_docs.yml

@@ -0,0 +1,71 @@
+# Taken from https://github.com/MissouriMRDT/Autonomy_Software/blob/development/.github/workflows/doxygen_generate.yml
+name: Generate API Docs
+
+on:
+  # Runs workflow 'automatically' when a pushed
+  # to the development branch.
+  push:
+    branches: ["development"]
+  pull_request:
+    branches:
+      - "development" 
+    # Don't apply gitignore rules, this allows us to push the generated docs.
+    paths-ignore:
+      - ".gitignore"
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  run-doxygen:
+    # Only run this step if the action was triggered automatically and the pull request merged on the development branch.
+    # Or, it was triggered manually on the development branch.
+    if: ${{ github.event_name == 'push' || ( github.event_name == 'workflow_dispatch' && (github.ref == 'refs/heads/development' || github.ref == 'refs/heads/documentation') ) }}
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Fix Dubious Ownership
+        run: git config --global --add safe.directory /opt/Basestation_Software_Blazor
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Run Doxygen
+        uses: mattnotmitt/[email protected]
+        with:
+          # Path to Doxyfile
+          doxyfile-path: ./Doxyfile
+          # Generate latex documentation
+          enable-latex: false
+          # Extra alpine packages for the build environment
+          additional-packages: graphviz
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "docs/Doxygen"
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -7,6 +7,13 @@
 *.userosscache
 *.sln.docstates
 
+# Documentation
+docs/*
+!docs/*.md
+!docs/Doxygen
+docs/Doxygen/*
+!docs/Doxygen/resources
+
 # User-specific files (MonoDevelop/Xamarin Studio)
 *.userprefs
 

Basestation_Software.Models/RoveComm/RoveCommManifest.cs

@@ -42,6 +42,15 @@ public RoveCommBoardDesc(string ip,
     }
 }
 
+public class RoveCommDeviceDesc
+{
+    public string Ip { get; init; }
+
+    public RoveCommDeviceDesc(string ip)
+    {
+        Ip = ip;
+    }
+}
 
 public class RoveCommPacketDesc
 {
@@ -69,6 +78,18 @@ public static class SystemPackets
         public static readonly int NO_DATA = 6;
     }
 
+    public static readonly IReadOnlyDictionary<string, RoveCommDeviceDesc> Devices = new Dictionary<string, RoveCommDeviceDesc>
+    {
+        ["BasestationSwitch"] = new RoveCommDeviceDesc("192.168.254.2"),
+        ["RoverSwitch"] = new RoveCommDeviceDesc("192.168.254.1"),
+        ["Rover900MHzRocket"] = new RoveCommDeviceDesc("10.0.0.3"),
+        ["Basestation900MHzRocket"] = new RoveCommDeviceDesc("10.0.0.4"),
+        ["Rover5GHzRocket"] = new RoveCommDeviceDesc("10.0.0.19"),
+        ["Basestation5GHzRocket"] = new RoveCommDeviceDesc("10.0.0.20"),
+        ["Rover2_4GHzRocket"] = new RoveCommDeviceDesc("10.0.0.11"),
+        ["Basestation2_4GHzRocket"] = new RoveCommDeviceDesc("10.0.0.12"),
+    };
+
     public static readonly IReadOnlyDictionary<string, RoveCommBoardDesc> Boards = new Dictionary<string, RoveCommBoardDesc>
     {
         ["Core"] = new RoveCommBoardDesc

Basestation_Software.Web/Basestation_Software.Web.csproj

@@ -20,6 +20,12 @@
     <PackageReference Include="Radzen.Blazor" Version="4.33.3" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Content Update="Core\Components\PingTool.razor">
+      <ExcludeFromSingleFile>true</ExcludeFromSingleFile>
+    </Content>
+  </ItemGroup>
+
   <PropertyGroup>
     <TargetFramework>net8.0</TargetFramework>
     <Nullable>enable</Nullable>

Basestation_Software.Web/Program.cs

@@ -7,6 +7,11 @@
 #pragma warning disable IDE0211 // Convert to 'Program.Main' style program
 var builder = WebApplication.CreateBuilder(args);
 
+// Configure logging
+builder.Logging.ClearProviders();
+builder.Logging.AddConsole();
+builder.Logging.AddDebug();
+
 // Add services to the container.
 builder.Services.AddRazorComponents()
     .AddInteractiveServerComponents()