Skip to content

Commit

Permalink
misc changes
Browse files Browse the repository at this point in the history
  • Loading branch information
IshDeshpa committed Jan 20, 2024
1 parent 1e96bb1 commit affe4af
Show file tree
Hide file tree
Showing 12 changed files with 8 additions and 29 deletions.
2 changes: 1 addition & 1 deletion Apps/Src/UpdateDisplay.c
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
* and notifies UpdateDisplay. Another internal function, ``UpdateDisplay_PopNext()``,
* gets called by UpdateDisplay. It blocks on a semaphore until the queue is not empty, and then
* grabs the next command structure. It then parses the command and sends it out over UART. Check these
* functions in ``UpdateDisplay.c`` for more information.
* functions in UpdateDisplay.c for more information.
*
*/

Expand Down
4 changes: 0 additions & 4 deletions BSP/Inc/BSP_ADC.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,21 @@
#include "config.h"

/**
* @def MAX_CHANNELS
* @brief This macro represents the maximum number of ADC channels that can be used.
*/
#define MAX_CHANNELS 10

/**
* @def ADC_PRECISION_BITS
* @brief This macro represents the number of bits of precision of the ADC.
*/
#define ADC_PRECISION_BITS 12

/**
* @def ADC_RANGE_MILLIVOLTS
* @brief This macro represents the range of the ADC in millivolts.
*/
#define ADC_RANGE_MILLIVOLTS 3300

/**
* @enum ADC_t
* @brief This enum represents the ADC channels that are available on the board.
*/
typedef enum {
Expand Down
1 change: 0 additions & 1 deletion BSP/Inc/BSP_CAN.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
#include <bsp.h>

/**
* @enum CAN_t
* @brief The CAN bus to use.
* @note CAN_3 is the CAN bus that communicates with the motor controller.
* CAN_1 is the CAN bus that communicates with the car.
Expand Down
2 changes: 0 additions & 2 deletions BSP/Inc/BSP_GPIO.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,11 @@
#include <stdbool.h>

/**
* @enum port_t
* @brief GPIO ports
*/
typedef enum {PORTA = 0, PORTB, PORTC, PORTD, NUM_PORTS} port_t;

/**
* @enum direction_t
* @brief GPIO direction
*/
typedef enum {INPUT = 0, OUTPUT} direction_t;
Expand Down
1 change: 0 additions & 1 deletion BSP/Inc/BSP_UART.h
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
#include <bsp.h>

/**
* @enum UART_t
* @brief Enumeration of the UART devices
*/
typedef enum {UART_2, UART_3, NUM_UART} UART_t;
Expand Down
8 changes: 4 additions & 4 deletions Docs/source/Apps/ReadCarCAN.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@ Read Car CAN
************

.. doxygenfile:: ReadCarCAN.h
:sections: briefdescription
:sections: briefdescription

=============
Usage Details
=============
.. doxygenfile:: ReadCarCAN.h
:sections: detaileddescription
:sections: detaileddescription

==================
Functional Details
==================
.. doxygenfile:: ReadCarCAN.c
:sections: detaileddescription
:sections: detaileddescription

===
API
===
.. doxygenfile:: ReadCarCAN.h
:sections: define enum func typedef
:sections: define enum func typedef
6 changes: 3 additions & 3 deletions Docs/source/Apps/SendTritium.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
***********
SendTritium
***********
************
Send Tritium
************
.. doxygenfile:: SendTritium.h
:sections: briefdescription

Expand Down
3 changes: 0 additions & 3 deletions Drivers/Inc/CANbus.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
#define MOTORCAN CAN_3

/**
* @enum CANId_t
* @brief This enum is used to signify the ID of the message you want to send.
* It is used internally to index our lookup table (CANLUT.C) and get message-specific fields.
* For user purposes, it selects the message to send.
Expand Down Expand Up @@ -75,13 +74,11 @@ typedef struct {

//Compatibility macros for deprecated enum
/**
* @def CAN_BLOCKING
* @brief Compatibility macro for deprecated enum
*/
#define CAN_BLOCKING true

/**
* @def CAN_NON_BLOCKING
* @brief Compatibility macro for deprecated enum
*/
#define CAN_NON_BLOCKING false
Expand Down
4 changes: 0 additions & 4 deletions Drivers/Inc/Contactors.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,16 @@
#include "stm32f4xx_gpio.h"

/**
* @def CONTACTORS_PORT
* @brief The GPIO port used for the contactors
*/
#define CONTACTORS_PORT PORTC

/**
* @def ARRAY_PRECHARGE_BYPASS_PIN
* @brief The GPIO pin used for the array precharge bypass contactor
*/
#define ARRAY_PRECHARGE_BYPASS_PIN GPIO_Pin_10

/**
* @def MOTOR_CONTROLLER_PRECHARGE_BYPASS_PIN
* @brief The GPIO pin used for the motor controller precharge bypass contactor
*/
#define MOTOR_CONTROLLER_PRECHARGE_BYPASS_PIN GPIO_Pin_12
Expand All @@ -38,7 +35,6 @@
contactor(MOTOR_CONTROLLER_PRECHARGE_BYPASS_CONTACTOR), \

/**
* @enum contactor_t
* @brief The contactors that can be set
*/
typedef enum {
Expand Down
4 changes: 0 additions & 4 deletions Drivers/Inc/Display.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,11 @@
#include "Tasks.h" // for os and fault error locs

/**
* @def MAX_ARGS
* @brief maximum number of arguments in a command packet
*/
#define MAX_ARGS 2

/**
* @enum DisplayError_t
* @brief Error codes for display driver
* @note Currently only ERR_NONE and ERR_PARSE are used, since there is a bug
* where the nextion does not return errors properly to us.
Expand Down Expand Up @@ -52,7 +50,6 @@ typedef enum{


/**
* @def Page_t
* @brief All three pages on the HMI
*/
typedef enum{
Expand All @@ -62,7 +59,6 @@ typedef enum{
} Page_t;

/**
* @def Arg_e
* @brief Argument types
*/
typedef enum{
Expand Down
1 change: 0 additions & 1 deletion Drivers/Inc/Minions.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
PIN(BRAKELIGHT), \

/**
* @enum pin_t
* @brief Enumerates all software-controllable switches/lights
* @details The enum is used to index into the lookup table PINS_LOOKARR in Minions.c
* If the enum is changed, the lookup table should be changed accordingly.
Expand Down
1 change: 0 additions & 1 deletion Drivers/Inc/Pedals.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
#include "BSP_ADC.h"

/**
* @enum pedal_t
* @brief Used to index the LowerBound and UpperBound arrays
*/
typedef enum {
Expand Down

0 comments on commit affe4af

Please sign in to comment.