Verification 1

.github/workflows/docs_workflow.yml

@@ -0,0 +1,72 @@
+name: Docs
+
+permissions:
+  contents: write
+
+on:
+  push:
+    branches:
+      - "main"
+    tags:
+      - "*"
+  pull_request:
+    paths:
+      - "Docs/**"
+      - ".github/workflows/**"
+
+#
+jobs:
+  make_docs:
+    runs-on: ubuntu-latest
+    name: Build Docs
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+          architecture: x64
+
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - run: sudo apt update && sudo apt install texlive-latex-recommended texlive-latex-extra texlive-pictures pandoc rename latexmk
+
+      - name: Install docs requirements
+        run: pip install -r Docs/requirements.txt
+
+      - name: Build pdf
+        run: cd Docs && make
+
+        #
+      - run: mv Docs/_build/latex/*.pdf Docs/_build/latex/MegaMouse.pdf
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ProjectDocs
+          path: Docs/_build/latex/MegaMouse.pdf
+          #
+
+  publish_docs:
+    # Only run on tags
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    name: Publish Docs
+    needs: [make_docs]
+
+    steps:
+      - uses: actions/download-artifact@v2
+        with:
+          name: ProjectDocs
+
+      - name: Upload Docs to release
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: "*.pdf"
+          tag: ${{ github.ref }}
+          overwrite: true
+          prerelease: true
+          #
+          body: "SNHU Robotics, Automated with github ci/cd."
+          file_glob: true

.github/workflows/firmware_workflow.yml

@@ -1,4 +1,4 @@
-name: Firmware Workflow
+name: Firmware
 
 on:
   push:
@@ -9,28 +9,30 @@ on:
   pull_request:
     paths:
       - "Firmware/**"
+      - ".github/workflows/**"
 
+#
 jobs:
   make_firmware:
     runs-on: ubuntu-latest
     name: Firmware Builder
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Cache pip
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Cache PlatformIO
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.platformio
           key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
       - name: Install PlatformIO
         run: |
           python -m pip install --upgrade pip
@@ -39,55 +41,36 @@ jobs:
       - name: Run PlatformIO
         run: cd Firmware && make
 
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v4
         with:
-          name: Binaries
+          name: Display_Binaries
           path: Firmware/.pio/build/ATmega328P/firmware.*
 
   delint:
     runs-on: ubuntu-latest
     name: Delinter
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Cache pip
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Cache PlatformIO
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.platformio
           key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
       - name: Install PlatformIO
         run: |
           python -m pip install --upgrade pip
           pip install --upgrade platformio
 
       - name: Run Delinter
         run: cd Firmware && pio check
-
-  # dev-publish:
-  #   # publish only to devs
-  #   runs-on: ubuntu-latest
-  #   name: Dev-Publish
-  #   needs: [make_firmware]
-
-  #   steps:
-  #     # Download artifacts
-  #     - uses: actions/download-artifact@v2
-  #       with:
-  #         name: Binaries
-
-  #     - name: send custom message with args
-  #       uses: appleboy/discord-action@master
-  #       with:
-  #         webhook_id: ${{ secrets.WEBHOOK_ID }}
-  #         webhook_token: ${{ secrets.WEBHOOK_TOKEN }}
-  #         file: "firmware.hex"
-  #         args: "New firmware for MegaMouse board!"
+#

.github/workflows/hardware_workflow.yml

@@ -1,4 +1,9 @@
-name: Hardware Workflow
+name: Hardware
+
+permissions:
+  contents: write
+  actions: read
+  checks: write
 
 on:
   push:
@@ -9,64 +14,57 @@ on:
   pull_request:
     paths:
       - "Hardware/**"
-      - "Docs/**"
-
-permissions: write-all
+      - ".github/workflows/**"
 
+#
 jobs:
   KiCad_Hardware:
     runs-on: ubuntu-latest
     name: KiCad Hardware
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           submodules: true
 
-      - uses: INTI-CMNB/KiBot@v2_k6
+      - uses: INTI-CMNB/KiBot@v2_k8
         with:
           # Config file
           config: Hardware/config.kibot.yaml
           # Prefix for output in config file.
           dir: _hardwareOutput
 
           # Hardware Files
+          #
           schema: "Hardware/MegaMouse/MegaMouse.kicad_sch"
           board: "Hardware/MegaMouse/MegaMouse.kicad_pcb"
+          #
 
       - name: upload results
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: Board-Hardware
           path: _hardwareOutput
 
-      - name: Discord notification if failed
-        if: ${{ failure() }}
-        uses: appleboy/discord-action@master
-        with:
-          webhook_id: ${{ secrets.WEBHOOK_ID }}
-          webhook_token: ${{ secrets.WEBHOOK_TOKEN }}
-          args: "Building new board failed, most likely a DRC check."
-
   dev-publish:
     # publish only to devs
+    if: github.event_name == 'pull_request'
     runs-on: ubuntu-latest
     name: Dev-Publish
     needs: [KiCad_Hardware]
 
     steps:
-      # Download artifacts
       - uses: actions/download-artifact@v2
         with:
           name: Board-Hardware
 
-      - name: send custom message with args
-        uses: appleboy/discord-action@master
+      - name: Upload KiCAD Artifacts
+        uses: edunad/[email protected]
         with:
-          webhook_id: ${{ secrets.WEBHOOK_ID }}
-          webhook_token: ${{ secrets.WEBHOOK_TOKEN }}
-          file: "MegaMouse-3D_top.png"
+          path: "*-3D_top.png"
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          title: "PCB"
 
   publish:
     # Only run on tags
@@ -77,32 +75,30 @@ jobs:
 
     steps:
       # Be in our repo
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
-      # Download artifacts
       - uses: actions/download-artifact@v2
         with:
           name: Board-Hardware
 
       - run: mkdir -p _staging/
 
-      - run: cp *.pdf _staging/
-
       - run: cp *.step _staging/
 
       # Copy gerbers
       - run: cp PCBWay/*.zip _staging/Board-$(git rev-parse --short HEAD)-PCBWay.zip
       - run: cp JLCPCB/*.zip _staging/Board-$(git rev-parse --short HEAD)-JLCPCB.zip
 
-      - name: Upload Docs to release
+      - name: Upload artifacts to release
         uses: svenstaro/upload-release-action@v2
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
           file: "_staging/*"
           tag: ${{ github.ref }}
           overwrite: true
           prerelease: true
-          body: "Kitsune Scientific, Automated with github ci/cd."
+          #
+          body: "SNHU Robotics, Automated with github ci/cd."
           file_glob: true

.gitignore

@@ -26,6 +26,7 @@ _*/
 *-backups
 *.kicad_prl
 *.sch-bak
+*.lck
 *~
 _autosave-*
 *.tmp

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "Hardware/MegaMouse/Libraries/Panelization.pretty"]
 	path = Hardware/MegaMouse/Libraries/Panelization.pretty
 	url = https://github.com/madworm/Panelization.pretty
+[submodule "Firmware/sim/lib/mms-cpp"]
+	path = Firmware/sim/lib/mms-cpp
+	url = https://github.com/mackorone/mms-cpp.git

Docs/.gitignore

@@ -0,0 +1,5 @@
+# Dev
+Pipfile*
+
+# Build
+_build

Docs/Makefile

@@ -0,0 +1,17 @@
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Refactored from minimal makefile
+
+all: latexpdf
+
+clean:
+	git clean -fdX 
+
+latexpdf: Makefile
+	@$(SPHINXBUILD) -M latexpdf "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+html: Makefile
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

Docs/README.md

@@ -0,0 +1,21 @@
+# Building the Docs
+
+To get started, you'll need a few things, you should have `pipenv` 
+(or your favorite python container tool). And some familiarly with RST.
+
+To begin, install the requirements into your python environment
+
+```
+pipenv install -r requirements.txt
+pipenv shell
+```
+
+To make things easier, this project uses a build tool called make
+
+To use it just run
+
+```
+make
+```
+
+Thats it! Make some edits, and then run `make html`