bertos/algo/pid_control.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2008 Develer S.r.l. (http://www.develer.com/)
  30  * -->
  31  *
  32  *
  33  * \brief Proportional, integral, derivative controller (PID controller).
  34  *
  35  *
  36  * \author Daniele Basile <asterix@develer.com>
  37  *
  38  * $WIZ$ module_name = "pid_control"
  39  * $WIZ$ module_depends = "timer"
  40  */
  41
  42 #ifndef ALGO_PID_CONTROL_H
  43 #define ALGO_PID_CONTROL_H
  44
  45 #include <drv/timer.h>
  46
  47 /**
  48  * Data type for pid coefficient.
  49  */
  50 typedef float pidk_t;
  51 typedef float piddata_t;
  52
  53 /**
  54  * PID context structure.
  55  */
  56 typedef struct PidCfg
  57 {
  58         pidk_t kp;              ///< Proportional term of PID control method (Gain).
  59         pidk_t ki;              ///< Integral term of PID control method (Integral Gain).
  60         pidk_t kd;              ///< Derivative of PID control method (Derivative Gain).
  61
  62         piddata_t i_max;        ///< Max value of integral term.
  63         piddata_t i_min;        ///< Min value of integral term.
  64
  65         piddata_t out_max;      ///< Man value of output.
  66         piddata_t out_min;      ///< Min value of output.
  67
  68         mtime_t sample_period;  ///< Sample period in milliseconds.
  69
  70 } PidCfg;
  71
  72
  73 /**
  74  * PID context structure.
  75  */
  76 typedef struct PidContext
  77 {
  78         const PidCfg *cfg;
  79
  80         piddata_t prev_err;     ///< Previous error.
  81         piddata_t i_state;      ///< Integrator state (sum of all the preceding errors).
  82
  83 } PidContext;
  84
  85 /**
  86  * Set Kp, Ki, Kd constants of PID control.
  87  */
  88 INLINE void pid_control_setPid(PidCfg *pid_cfg, pidk_t kp, pidk_t ki, pidk_t kd)
  89 {
  90         pid_cfg->kp = kp;
  91         pid_cfg->ki = ki;
  92         pid_cfg->kd = kd;
  93 }
  94
  95 /**
  96  * Set sample period for PID control.
  97  */
  98 INLINE void pid_control_setPeriod(PidCfg *pid_cfg, mtime_t sample_period)
  99 {
 100         pid_cfg->sample_period = sample_period;
 101 }
 102
 103 /**
 104  * Clear a pid control structure
 105  */
 106 INLINE void pid_control_reset(PidContext *pid_ctx)
 107 {
 108         pid_ctx->i_state = 0;
 109         pid_ctx->prev_err = 0;
 110 }
 111
 112 piddata_t pid_control_update(PidContext *pid_ctx, piddata_t target, piddata_t curr_pos);
 113 void pid_control_init(PidContext *pid_ctx, const PidCfg *pid_cfg);
 114
 115 #endif /* ALGO_PID_CONTROL_H */