pedal_calib.h

#pragma once
 
/************************************************************************************************
 * @file   pedal_calib.h
 *
 * @brief  Header file to define the pedal calibration data
 *
 * @date   2025-05-15
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stdbool.h>
 
/* Inter-component Headers */
#include "gpio.h"
 
/* Intra-component Headers */
 
#define NUM_SAMPLES 1000
 
typedef enum {
  PEDAL_PRESSED = 0,
  PEDAL_UNPRESSED,
  NUM_PEDAL_STATES,
} PedalState;
 
typedef struct PedalCalibrationData {
  // When the pedal is considered fully unpressed
  int16_t lower_value;
  // When the pedal is considered fully pressed
  int16_t upper_value;
} PedalCalibrationData;
 
typedef struct PedalCalibBlob {
  PedalCalibrationData throttle_calib;
  PedalCalibrationData brake_calib;
} PedalCalibBlob;
 
typedef struct PedalCalibrationStorage {
  int16_t min_reading;
  int16_t max_reading;
  volatile uint32_t sample_counter;
} PedalCalibrationStorage;
 
extern PedalCalibBlob global_calib_blob;
 
/* @brief Reads data from ADC and calculates appropriate pedal calibration values
 *
 * @param calib_storage - A struct for storing the max and min reading while looping through adc reading for a given number of samples
 * @param data - A struct that stores the final calculated values for the upper and lower values for the pedal
 * @param state - An enum that describes the current state that he pedal is in when calling the function
 * @param address - The GPIO address for the adc of the pedal
 * @return STATUS_CODE_OK on success
 */
StatusCode pedal_calib_sample(PedalCalibrationStorage *calib_storage, PedalCalibrationData *data, PedalState state, GpioAddress *address);