drive_state_manager.h

#pragma once
 
/************************************************************************************************
 * @file   drive_state_manager.h
 *
 * @brief  Header file for drive state manager
 *
 * @date   2025-07-22
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stdbool.h>
 
/* Inter-component Headers */
 
/* Intra-component Headers */
 
typedef enum {
  DRIVE_STATE_INVALID = 0, 
  DRIVE_STATE_NEUTRAL,     
  DRIVE_STATE_DRIVE,       
  DRIVE_STATE_REVERSE      
} DriveState;
 
typedef enum {
  DRIVE_STATE_REQUEST_NONE = 0, 
  DRIVE_STATE_REQUEST_D,        
  DRIVE_STATE_REQUEST_N,        
  DRIVE_STATE_REQUEST_R,        
  NUM_DRIVE_STATE_REQUESTS,     
} DriveStateRequest;
 
typedef enum {
  REGEN_STATE_DISABLED, 
  REGEN_STATE_ENABLED,  
  INVALID_REGEN_STATE,  
} RegenState;
 
StatusCode drive_state_manager_init(void);
 
StatusCode drive_state_manager_request(DriveStateRequest req);
 
StatusCode drive_state_manager_update(void);
 
DriveState drive_state_manager_get_state(void);
 
StatusCode drive_state_manager_enter_regen_state(RegenState new_regen_state);
 
StatusCode drive_state_manager_toggle_regen();