update documentation

hytech-racing · Sep 22, 2024 · 8363cf5 · 8363cf5
1 parent 53321c8
commit 8363cf5
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 3 deletions.
diff --git a/lib/interfaces/include/LoadCellInterface.h b/lib/interfaces/include/LoadCellInterface.h
@@ -22,7 +22,7 @@ struct LoadCellInterfaceTick_s
 };
 
 /**
- * Struct containing converted and filtered load cell data
+ * Updates loadCellForcesFiltered_ vectors after receiving new data
  */
 struct LoadCellInterfaceOutput_s
 {
@@ -35,7 +35,6 @@ struct LoadCellInterfaceOutput_s
 /**
  * The LoadCellInterface filters load cell signals to be used in the TorqueControllers system.
  * Applies FIR filter and determines if signal is saturated
- * [why specifically do we use a FIR filter?]
  */
 class LoadCellInterface
 {

diff --git a/lib/interfaces/include/SABInterface.h b/lib/interfaces/include/SABInterface.h
@@ -66,7 +66,7 @@ class SABInterface
 
     /**
      * Parses CAN message into individual values for rear load cell and potentiometer readings.
-     * Updates each sensor's lastSample and converts data to pounds
+     * Updates each sensor's lastSample value and converts data (rlLoadCell and rrLoadCell converted to pounds)
      */
     void retrieve_pots_and_load_cells_CAN(CAN_message_t &recvd_msg);
 };