2025.1 Release (Washago) (#28)

JasonBrave · web-flow · commit 40a2d08b5c72 · 2024-11-28T11:07:11.000-05:00
diff --git a/.github/workflows/clang-format-check.yml b/.github/workflows/clang-format-check.yml
@@ -0,0 +1,20 @@
+name: C Coding Style Check
+
+# Runs on pushes to pull request
+on: pull_request
+
+jobs:
+  # Build job
+  clang-format-style-check:
+    name: C Coding Style Check (clang-format check)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          submodules: 'true'
+      - name: Run formatting check
+        uses: waterloo-rocketry/actions/clang-format-check@main
+        with:
+          clang-format-config-path: '.clang-format'
+          c-source-files: 'include/*.h common/*.c pic18f26k83/*.c unit_tests/*.c'
diff --git a/.github/workflows/clang-format-test.yml b/.github/workflows/clang-format-test.yml
diff --git a/README.md b/README.md
@@ -1,4 +1,15 @@
-# RocketLib
+# rocketlib
 
-Standardize embedded firmware.
+rocketlib is Waterloo Rocketry's common firmware library, it's used on a wide range of MCUs including PIC18 and STM32H7.
 
+## Common Library
+- clang-format configuration file
+- Common Error code definition
+- Assert macro
+- Low pass filter function
+
+## PIC18F26K83 Drivers
+- Timer driver (provides millis function)
+- I2C Controller driver (master only)
+- SPI Controller driver
+- PWM(CCP) driver
diff --git a/doc/conf.py b/doc/conf.py
@@ -7,9 +7,9 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'Waterloo Rocketry Standard Embedded Firmware'
-copyright = '2024, Jason Xu - Waterloo Rocketry'
-author = 'Jason Xu - Waterloo Rocketry'
-release = '0.99'
+copyright = '2024, Waterloo Rocketry'
+author = 'Waterloo Rocketry'
+release = '2025.1'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
diff --git a/doc/i2c_driver.rst b/doc/i2c_driver.rst
@@ -1,5 +1,5 @@
-I2C Master Driver
-*****************
+I2C Master Driver (Not Working)
+*******************************
 
 The driver only handles when the device is used as an I2C master, because it's unlikely the MCU is going to used as an I2C slave on the rocket. Functions for reading 8 and 16 bit registers are provided.
 
diff --git a/doc/low_pass_filter.rst b/doc/low_pass_filter.rst
@@ -1,5 +1,5 @@
 Low Pass Filter
-===============
+****************************
 
 Inline Functions
 ================
@@ -106,4 +106,4 @@ Notes
 
 References
 ==========
-- `Low-Pass Filter <https://en.wikipedia.org/wiki/Low-pass_filter>`_
+- `Low-Pass Filter <https://en.wikipedia.org/wiki/Low-pass_filter>`_
diff --git a/doc/millis.rst b/doc/millis.rst
@@ -1,5 +1,5 @@
-Timer Module Documentation
-===========================
+Timer Module (millis)
+=====================
 
 Overview
 --------
diff --git a/include/common.h b/include/common.h
@@ -1,6 +1,9 @@
 #ifndef ROCKETLIB_COMMON_H
 #define ROCKETLIB_COMMON_H
 
+#define ROCKETLIB_VERSION_MAJOR 2025
+#define ROCKETLIB_VERSION_MINOR 1
+
 typedef enum {
     W_SUCCESS = 0,
     W_FAILURE,
diff --git a/pic18f26k83/timer.c b/pic18f26k83/timer.c
@@ -2,10 +2,6 @@
 
 #include "timer.h"
 
-#ifndef _PIC18F26K83_H_
-#warning "compiling pic18f26k83 hardware specific file on a different microcontroller, WTF?"
-#endif
-
 /*
  * Magic numbers: timer is driven on a 500kHz clock and is 8 bits.
  * Timer rolls over every 256 counts, or every 512 microseconds.
