Merge branch 'main' into feat/workinghighpass

.github/ISSUE_TEMPLATE/bug-form.yml

@@ -2,33 +2,20 @@ name: Bug
 description: For any issue related to a bug
 title: '[Area] - Short Description'
 labels: [bug]
+projects: ["Northeastern-Electric-Racing/20"]
 body:
   - type: textarea
     id: observed-behavior
     attributes:
       label: Observed Behavior
-      description: What happened?
-    validations:
-      required: true
-  - type: textarea
-    id: expected-behavior
-    attributes:
-      label: Expected Behavior
-      description: What should have happened?
+      description: What happened? What should of happened?
     validations:
       required: true
   - type: textarea
     id: steps-to-reproduce
     attributes:
       label: Steps to Reproduce
-      description: How could someone reproduce this bug?
+      description: How could someone reproduce this bug? Include versions of code or PCBs as applicable.
       value: "1. \n2. \n3. "
     validations:
       required: true
-  - type: textarea
-    id: screenshots
-    attributes:
-      label: Screenshots (as needed)
-      description: Add screenshots of the bug if applicable
-    validations:
-      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -1 +1 @@
-blank_issues_enabled: true
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/task.yml

@@ -1,19 +1,20 @@
-name: Task
-description: Create a task that a developer can complete.
+name: Feature
+description: Describe a feature that a developer can add.
 title: '[Area] - Short Description'
+projects: ["Northeastern-Electric-Racing/20"]
 body:
   - type: textarea
     id: description
     attributes:
       label: Description
-      description: Provide a brief summary of this issue
+      description: Provide a brief summary of the current shortcoming or new improvement
     validations:
       required: true
   - type: textarea
     id: acceptance-criteria
     attributes:
       label: Acceptance Criteria
-      description: What are the conditions that need to be satisified to complete this task?
+      description: What are the test conditions that need to be satisified to complete this task?
     validations:
       required: true
   - type: textarea

.github/pull_request_template.md

@@ -25,7 +25,6 @@ It can be helpful to check the `Checks` and `Files changed` tabs.
 Please reach out to your Project Lead if anything is unclear.
 Please request reviewers and ping on slack only after you've gone through this whole checklist.
 
-- [ ] All commits are tagged with the ticket number
 - [ ] No merge conflicts
 - [ ] All checks passing
 - [ ] Remove any non-applicable sections of this template

.github/workflows/build_calypso.yml

@@ -0,0 +1,22 @@
+name: Check CAN, build Calypso
+on:
+  push:
+    paths:
+        - 'cangen/**'
+
+jobs:
+  run-build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone Calypso
+        uses: actions/checkout@v4
+        with:
+          repository: Northeastern-Electric-Racing/Calypso
+
+      - name: Clone Embedded-base
+        uses: actions/checkout@v4
+        with:
+          path: "./Embedded-Base"
+
+      - name: Build Calypso
+        run: cargo build --locked

.github/workflows/build_cerberus.yml

@@ -3,23 +3,20 @@ on: [push]
 jobs:
   run-build:
     runs-on: ubuntu-latest
-    container:
-        image: ghcr.io/northeastern-electric-racing/embedded-base:docker-compose
     timeout-minutes: 10
     steps:
-      - name: Clone Cerberus
-        uses: actions/checkout@v3
+      - name: Checkout code
+        uses: actions/checkout@v4
         with:
-          repository: Northeastern-Electric-Racing/Cerberus
-
+            repository: Northeastern-Electric-Racing/Cerberus
+            fetch-depth: 0
       - name: Clone Embedded-base
         uses: actions/checkout@v3
         with:
           path: "./Drivers/Embedded-Base"
-
       - name: Execute Make
         run: |
-            if ! make; then
+            if ! docker compose run --rm ner-gcc-arm make -j `nproc`; then
             echo "The application has failed to build."
             exit 1  # This will cause the workflow to fail
             fi

.gitignore

@@ -2,4 +2,5 @@
 __pycache__/
 *.egg-info/
 
-*.nix
+*.nix
+.DS_Store

.pre-commit-config.yaml

@@ -1,10 +1,10 @@
-repos:
-    - repo: local
-      hooks:
-        - id: clang_restage
-          name: Restage formatted files
-          entry: clang_restage
-          language: system
-          pass_filenames: false
-          always_run: true
+repos:
+    - repo: local
+      hooks:
+        - id: clang_restage
+          name: Restage formatted files
+          entry: clang_restage
+          language: system
+          pass_filenames: false
+          always_run: true
           stages: [pre-commit]

README.md

@@ -1,33 +1,22 @@
 # Embedded-Base
-Embedded-Base is a collection of drivers & middleware designed for use across various systems.
+Embedded-Base is a collection of drivers, middlewares, and communication definitions designed for use across various systems.  
 
-This repository houses custom drivers and middleware that can be utilized in multiple projects.
+Most firmware projects define Embedded-Base as a submodule.
 
-To use this repository in any project, it should be set up as a submodule.
+## Getting Started With NER Firmware
 
-## Getting Started
+All you need is on confluence [here](https://nerdocs.atlassian.net/wiki/spaces/NER/pages/1343533/Firmware+Onboarding+Embedded+Software#Development-Environment-Setup).
 
-#### 1. Clone Embbeded-Base:
-   ~~~
-   git clone https://github.com/Northeastern-Electric-Racing/Embedded-Base.git
-   ~~~
+### Notable items in this repository
 
-#### 2. Initialize submodule
-   Within the application directory, run the following command to initialize the submodule:
-   ~~~
-   git submodule update --init
-   ~~~
-
-## Development Guidelines
-
-When developing in the parent directory, it's recommended to frequently run the following command to update all submodules in case changes have been made:
-~~~
-git submodule update --remote
-~~~
-
-
-**When making changes to a driver located within Embedded-Base, always make those changes directly within the Embedded-Base repository. Avoid making changes to a submodule from the parent directory.** Although it's technically possible, doing so can lead to disorganization, which we want to avoid.
-
-This approach ensures that changes to Embedded-Base are tracked properly and can be easily integrated into your projects using it as a submodule.
+- `cangen`: All JSON definitions of in-car CAN data as well as documentation and parsing utilities.
+- `dev`: The manual version of the NER build system, compatible up circuit boards in competition 22A
+- `ner_environment`: The NER developer environment compatible with all boards from 22A onwards and cross platform support.
+- `general`: Cross-platform C source files for all peripheral drivers used by NER.
+- `middleware`: Cross-platform C source files common utilities used across various platforms.
+- `platforms`: C source files specific to STM HAL versions.
+- `clang-format`:  The organization wide clang-format definition.
+- `ftdi_flash.cfg`: An openocd script to assist in FTDI flashing.
+- `openocd.cfg`: A openocd stub to load GDB onto a target.