steering.h

#pragma once
 
/************************************************************************************************
 * @file   steering.h
 *
 * @brief  Header file for steering
 *
 * @date   2025-07-09
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stdbool.h>
#include <stdint.h>
 
/* Inter-component Headers */
#include "display_defs.h"
#include "global_enums.h"
#include "ws22_motor_can.h"
 
/* Intra-component Headers */
#include "status.h"
#include "tasks.h"
 
/* Forward declarations */
struct ButtonManager;
struct ButtonLEDManager;
struct Ws22MotorCanConfig;
 
#define STEERING_BUTTON_DEBOUNCE_PERIOD_MS 5U
 
#define STEERING_CRUISE_MAX_SPEED_KMH 1000U  // 80
 
#define STEERING_CRUISE_MIN_SPEED_KMH 0U  // 40
 
typedef enum {
  STEERING_BUTTON_HAZARDS,
  STEERING_BUTTON_DRIVE,
  STEERING_BUTTON_NEUTRAL,
  STEERING_BUTTON_REVERSE,
 
  STEERING_BUTTON_REGEN,
 
  STEERING_BUTTON_LEFT_LIGHT,
  STEERING_BUTTON_RIGHT_LIGHT,
 
  STEERING_BUTTON_HORN,
 
  STEERING_BUTTON_CRUISE_CONTROL_UP,
  STEERING_BUTTON_CRUISE_CONTROL_DOWN,
 
  NUM_STEERING_BUTTONS,
} SteeringButtons;
 
typedef struct {
  uint16_t cruise_min_speed_kmh; 
  uint16_t cruise_max_speed_kmh; 
} SteeringConfig;
 
typedef struct {
  float state_of_charge;      
  uint16_t cell_voltages[36]; 
  int16_t vehicle_velocity; 
  int16_t dcdc_voltage; 
  int16_t dcdc_current; 
  int16_t aux_voltage;  
  int16_t aux_current;  
  float pack_voltage;           
  float pack_current;           
  uint16_t min_cell_voltage_mv; 
  uint16_t max_cell_voltage_mv; 
  uint16_t max_cell_temp;       
  uint16_t thermistor_temp_c[NUMBER_OF_THERMISTORS]; 
  float energy_used_wh; 
  uint16_t bps_fault;          
  uint8_t bps_fault_cell;      
  bool bps_fault_live;         
  BpsFaultData bps_fault_data; 
  VehicleDriveState drive_state;
  uint8_t pedal_percentage; 
  uint8_t brake_percentage; 
  uint8_t brake_enabled;
  uint8_t regen_enabled;
  uint8_t precharge_complete;
 
  TickType_t display_rx_medium_last_start;
  int64_t power_usage;
} DisplayData;
 
typedef struct {
  bool horn_enabled;           
  bool cruise_control_enabled; 
  uint16_t cruise_control_target_speed_kmh; 
  uint8_t drive_state;                      
  uint8_t light_signal;                     
  struct ButtonManager *button_manager;               
  struct ButtonLEDManager *button_led_manager;        
  struct Ws22MotorCanStorage *ws22_motor_can_storage; 
  DisplayData display_data;                           
  float estimated_km_remaining; 
  SteeringConfig *config;                    
  Ws22MotorCanConfig *ws22_motor_can_config; 
} SteeringStorage;
 
StatusCode steering_init(SteeringStorage *storage, SteeringConfig *config, Ws22MotorCanConfig *motor_can_config);
 
// /**
//  * @brief   Force BPS protection off (SECURE MODE OFF) regardless of the current state
//  * @details Broadcasts the disabled BPS-enable state to the rear controller and syncs the menu's
//  *          mirrored SECURE MODE label. Used when the driver acknowledges a BPS fault by leaving the
//  *          fault takeover screen.
//  * @return  STATUS_CODE_OK on success, error otherwise
//  */
// StatusCode steering_force_disable_bps(void);