integerPID_ideal Class Reference

#include <integerPID_ideal.h>

Public Member Functions
	integerPID_ideal (void)
	Default construction.
void	initialize (uint16_t input)
	Initialize the controller.
bool	compute (uint32_t now, uint16_t input, uint16_t *pOutput)
	Compute the new output.
Configuration methods
void	setOutputLimits (uint8_t min, uint8_t max)
	Set the output limits.
void	setSampleTime (uint32_t now, uint16_t minComputeInterval)
	Set the minimum time interval between computations.
void	setTunings (const PidTuningParameters &params)
	Set the PID parameters.
void	setSetPoint (uint16_t setpoint)
	Set the controller set point.
void	setSensitivity (uint16_t sensitivity)
	(Optional) Set the sensitivity
void	setFeedForwardTerm (uint16_t feedForwardTerm)
	(Optional) Set the forward bias

Constructor & Destructor Documentation

integerPID_ideal()

integerPID_ideal::integerPID_ideal

(

void

)

Default construction.

Here is the call graph for this function:

Member Function Documentation

compute()

bool integerPID_ideal::compute	(	uint32_t	now,
		uint16_t	input,
		uint16_t *	pOutput
	)

Compute the new output.

Note

The output is not a correction to be applied to the input. It is the actual output to be applied to the physical system.

Parameters

now	Current time (same units as used for setSampleTime)
input	The input value
pOutput	The new output: only valid when true is returned.

Returns

true if a calculation occurred, false otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

initialize()

void integerPID_ideal::initialize

(

uint16_t

input

)

Initialize the controller.

Parameters

input

The first input value (same as the compute() input parameter)

Here is the call graph for this function:

Here is the caller graph for this function:

setFeedForwardTerm()

void integerPID_ideal::setFeedForwardTerm ( uint16_t  feedForwardTerm )

inline

(Optional) Set the forward bias

Here is the call graph for this function:

Here is the caller graph for this function:

setOutputLimits()

void integerPID_ideal::setOutputLimits	(	uint8_t	min,
		uint8_t	max
	)

Set the output limits.

Here is the call graph for this function:

Here is the caller graph for this function:

setSampleTime()

void integerPID_ideal::setSampleTime ( uint32_t  now, uint16_t  minComputeInterval  )

inline

Set the minimum time interval between computations.

Parameters

now	Current time
minComputeInterval	Interval between valid calls to compute(). Must be in same units as now

Here is the call graph for this function:

Here is the caller graph for this function:

setSensitivity()

void integerPID_ideal::setSensitivity ( uint16_t  sensitivity )

inline

(Optional) Set the sensitivity

Here is the call graph for this function:

Here is the caller graph for this function:

setSetPoint()

void integerPID_ideal::setSetPoint ( uint16_t  setpoint )

inline

Set the controller set point.

Here is the call graph for this function:

Here is the caller graph for this function:

setTunings()

void integerPID_ideal::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/integerPID_ideal.h
• speeduino/src/PID/integerPID_ideal.cpp