pi.h

Go to the documentation of this file.

 * @details
 * This file defines the @ref control_system::pi::PI class, which
 * implements a discrete-time proportional-integral (PI) controller.
 *
 * The controller combines proportional and integral actions to generate
 * a control output based on the error between a reference value and the
 * measured or current value.
 *
 * The controller maintains the previous control error and previous
 * controller output as internal state variables and applies a configurable
 * maximum output limit.
 *
 * @tparam T Numeric data type used for the controller calculations.
 *
 * @author Abhinay Kumar
 * @version 1.0.0
 * @date 2026-08-11
 *
 * @copyright
 * Copyright (c) 2026 Abhinay Kumar
 */
 
#ifndef CONTROL_SYSTEM_PI_PI_H
#define CONTROL_SYSTEM_PI_PI_H
 
#include "../utility/utility.h"
 
namespace control_system
{
 
    namespace pi
    {

         *
         * The controller uses the sampling time for its discrete-time
         * integral action and maintains the previous control error and
         * controller output as internal state.
         *
         * @tparam T Numeric data type used for the controller.
         *
         * @par Example
         * @code{.cpp}
         * control_system::pi::PI<double> controller;
         *
         * controller.init(
         *     0.001,
         *     Kp,
         *     Ki,
         *     0.0,
         *     100.0
         * );
         *
         * double output = controller.update(reference, measurement);
         * @endcode
         */
        template <typename T>
        class PI
        {
        public:
            /**
             * @brief Constructs a PI controller.
             *
             * @details
             * Constructs the controller with its parameters and internal
             * state initialized to their default values.
             */
            PI();


             * @param[in] dt_ Controller sampling time in seconds.
             * @param[in] Kp_ Proportional gain.
             * @param[in] Ki_ Integral gain.
             * @param[in] u_k_1_ Previous controller output.
             * @param[in] u_max_ Maximum allowed controller output.
             *
             * @details
             * Initializes the controller sampling time, proportional and
             * integral gains, previous controller output, and output limit.
             */
            void init(T dt_, T Kp_, T Ki_, T u_k_1_, T u_max_);

            /**
             * @brief Sets the PI controller parameters.
             *
             * @param[in] dt_ Controller sampling time in seconds.
             * @param[in] Kp_ Proportional gain.
             * @param[in] Ki_ Integral gain.
             * @param[in] u_k_1_ Previous controller output.
             * @param[in] u_max_ Maximum allowed controller output.
             *
             * @details
             * Updates the controller sampling time, gains, previous
             * controller output, and maximum output limit.
             */
            void set_param(T dt_, T Kp_, T Ki_, T u_k_1_, T u_max_);


             * @param[in] x_0 Reference or desired value.
             * @param[in] x Current or measured value.
             *
             * @return PI controller output limited by the configured
             * maximum output.
             *
             * @details
             * Calculates the proportional and integral contributions
             * using the current control error and the stored controller
             * state.
             */
            T update(T x_0, T x);

            void reset();

            void merge(T u_k_1_);

            void set_dt(T dt_);

            void set_Kp(T Kp_);

            void set_Ki(T Ki_);

            void set_u_0(T u_k_1_);

            void set_u_max(T u_max_);

            T get_dt();

            T get_Kp();

            T get_Ki();

            T get_u_k_1();

            T get_u_max();
 
        private:
            T dt = 0.0;

            T u_k_1 = 0.0;

            T e_k_1 = 0.0;

            T Kp = 0.0;

            T Ki = 0.0;

            T u_max = 9999999999;

            bool start = true;
        };
 
#include "../../src/pi/pi.tpp"
    }
}
 
#endif