PidCore Class Reference

A base class for PID implementations. More...

#include <PidCore.h>

Public Member Functions
	PidCore (void)=default
void	setOutputLimits (int32_t min, int32_t max)
	Set the output limits.
void	setTunings (const PidTuningParameters &params)
	Set the PID parameters.
void	resetIntegral (void)
	(Optional) Reset the integral term
int32_t	compute (int32_t feedForwardTerm, int32_t error, int32_t derivative)
	Compute the next correction.

Detailed Description

A base class for PID implementations.

Provides a shared PID algorithm.

See also

compute.

Constructor & Destructor Documentation

PidCore()

PidCore::PidCore ( void  )

default

Member Function Documentation

compute()

int32_t PidCore::compute	(	int32_t	feedForwardTerm,
		int32_t	error,
		int32_t	derivative
	)

Compute the next correction.

Here is the call graph for this function:

Here is the caller graph for this function:

resetIntegral()

void PidCore::resetIntegral ( void  )

inline

(Optional) Reset the integral term

Here is the caller graph for this function:

setOutputLimits()

void PidCore::setOutputLimits ( int32_t  min, int32_t  max  )

inline

Set the output limits.

Here is the call graph for this function:

Here is the caller graph for this function:

setTunings()

void PidCore::setTunings ( const PidTuningParameters &  params )

inline

Set the PID parameters.

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• speeduino/src/PID/PidCore.h
• speeduino/src/PID/PidCore.cpp