Files
RP2040-Decoder/Software/core1.h
T

164 lines
5.1 KiB
C

/*!
*
* \file core1.h
* Used exclusively by core1
*
*/
#pragma once
#include "shared.h"
#define BASE_PWM_ARR_LEN 16
typedef enum {
STARTUP_MODE,
PID_MODE,
} controller_mode_t;
typedef struct startup_parameters_t {
uint16_t level;
uint16_t base_pwm_arr[BASE_PWM_ARR_LEN];
uint16_t base_pwm_arr_i;
}startup_parameters_t;
typedef struct pid_parameters_t{
// PID Controller variables
float k_i; // Integral gain
float k_d; // Derivative gain
float t; // Sampling time
float tau; // Low-pass-filter time constant
float ci_0; // (k_i*t)/2
float cd_0; // (k_d*2)/(2*tau+t)
float cd_1; // (2*tau-t)/(2*tau+t)
float int_lim_max; // max limit for integrator
float int_lim_min; // min limit for integrator
float max_output; // max possible pwm output value
float k_p; // Proportional gain
float e; // Error
float e_prev; // Previous Error
float i_prev; // Previous Integral Value
float d_prev; // Previous Derivative Value
// Variable gain variables
float k_p_x_1_shift;
float k_p_x_1;
float k_p_x_2;
float k_p_y_0;
float k_p_y_1;
float k_p_y_2;
float k_p_m_1;
float k_p_m_2;
} pid_parameter_t;
typedef struct controller_parameter_t{
/*!
* General Variables
*/
controller_mode_t mode; // Controller mode
float feed_fwd; // Feed forward value
uint32_t setpoint; // Current setpoint
uint16_t speed_table[127]; // Array with setpoint values corresponding to every speed step
/*!
* Startup controller mode specific variables
*/
startup_parameters_t startup;
/*!
* PID Controller variables
*/
pid_parameter_t pid;
/*!
* Measurement Variables
*/
float measurement; // Newest Measurement value
float measurement_prev; // Previous Measurement
float measurement_corrected; // measurement - adc_offset = measurement_corrected
float adc_offset; // ADC offset value
uint8_t msr_delay_in_us; // Delay before VEMF Measurement
uint8_t msr_total_iterations; // Amount of samples
uint8_t l_side_arr_cutoff; // Discarded samples (left side)
uint8_t r_side_arr_cutoff; // Discarded samples (right side)
} controller_parameter_t;
/**
* @brief Get the speed step table index based on the speed step value.
*
* @param speed_step The speed step value.
* @return The index in the speed step table.
*/
uint8_t get_speed_step_table_index_of_speed_step(uint8_t speed_step);
/**
* @brief Repeating timer callback function called every x milliseconds to implement a time delay in acceleration or deceleration.
*
* x is CV_175
*
* @param t Pointer to the repeating timer structure.
* @return true to schedule the repeating timer again.
*/
bool speed_helper(struct repeating_timer *t);
/**
* @brief Function to adjust the PWM level/duty cycle.
*
* @param level The new PWM level.
*/
void adjust_pwm_level(uint16_t level);
/**
* @brief Function to calculate and return the proportional gain based on the speed step.
*
* This is done in order to make kp dependent on the speed step (gain scheduling).
*
* @param ctrl_par Pointer to the controller parameter structure.
* @return The proportional gain.
*/
float get_kp(const controller_parameter_t *ctrl_par);
/**
* @brief Calculate and return the initial PWM level.
*
* Calculation is done by taking the last 16 initial levels (when available) and calculating the average.
* The average is the multiplied by a factor of 2/3.
*
* @param ctrl_par Pointer to the controller parameter structure.
* @return The initial PWM level.
*/
uint16_t get_initial_level(controller_parameter_t * ctrl_par);
/**
* @brief Controller function for startup mode.
*
* This is called inside the controller_general function when the controller mode is set to STARTUP_MODE.
*
* @param ctrl_par Pointer to the controller parameter structure.
*/
void controller_startup_mode(controller_parameter_t * ctrl_par);
/**
* @brief Controller function for PID mode.
*
* This is called inside the controller_general function when the controller mode is set to PID_MODE.
*
* @param ctrl_par Pointer to the controller parameter structure.
*/
void controller_pid_mode(controller_parameter_t *const ctrl_par);
/**
* @brief General controller function called every x milliseconds.
*
* @param t Pointer to the repeating timer structure.
* @return true to schedule the repeating timer again.
*/
bool controller_general(struct repeating_timer * t);
/**
* @brief Initialize the all controller variables, measurement parameters, and speed table.
*
* ctrl_par contains all controller variables and is passed to the other controller functions.
*
* @param ctrl_par Pointer to the controller parameter structure.
*/
void init_controller(controller_parameter_t * ctrl_par);