Package io.openems.edge.common.filter

Class PidFilter

java.lang.Object

io.openems.edge.common.filter.PidFilter

Direct Known Subclasses:

DisabledPidFilter

public class PidFilter
extends Object

A proportional-integral-derivative controller.

See Also:

• https://en.wikipedia.org/wiki/PID_controller

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_D
static final double	DEFAULT_I
static final double	DEFAULT_P
static final int	ERROR_SUM_LIMIT_FACTOR

Constructor Summary

Constructors

Constructor	Description
PidFilter()	Creates a PidFilter using default values.
PidFilter(double p, double i, double d)	Creates a PidFilter.

Method Summary

Modifier and Type	Method	Description
protected int	applyLowHighLimits(int value)	Applies the configured PID low and high limits to a value.
int	applyPidFilter(int input, int target)	Apply the PID filter using the current Channel value as input and the target value.
void	reset()	Reset the PID filter.
void	setLimits(Integer lowLimit, Integer highLimit)	Limit the output value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_P

public static final double DEFAULT_P

See Also:

• Constant Field Values

DEFAULT_I

public static final double DEFAULT_I

See Also:

• Constant Field Values

DEFAULT_D

public static final double DEFAULT_D

See Also:

• Constant Field Values

ERROR_SUM_LIMIT_FACTOR

public static final int ERROR_SUM_LIMIT_FACTOR

See Also:

• Constant Field Values

Constructor Details

PidFilter

public PidFilter(double p,
 double i,
 double d)

Creates a PidFilter.

Parameters:

p - the proportional gain

i - the integral gain

d - the derivative gain

PidFilter

public PidFilter()

Creates a PidFilter using default values.

Method Details

setLimits

public void setLimits(Integer lowLimit,
 Integer highLimit)

Limit the output value.

Parameters:

lowLimit - lowest allowed output value

highLimit - highest allowed output value

applyPidFilter

public int applyPidFilter(int input,
 int target)

Apply the PID filter using the current Channel value as input and the target value.

Parameters:

input - the input value, e.g. the measured Channel value

target - the target value

Returns:

the filtered set-point value

reset

public void reset()

Reset the PID filter.

This method should be called when the filter was not used for a while.

applyLowHighLimits

protected int applyLowHighLimits(int value)

Applies the configured PID low and high limits to a value.

Parameters:

value - the input value

Returns:

the value within low and high limit