You're reading the documentation for a version of ROS 2 that has reached its EOL (end-of-life), and is no longer officially supported. If you want up-to-date information, please have a look at Kilted.
control_toolbox
This package contains several C++ classes and filter plugins useful in writing controllers.
Base classes
PID
PID Controller
The PID (Proportional-Integral-Derivative) controller is a widely used feedback controller. This class implements a generic structure that can be used to create a wide range of PID controllers. It can function independently or be subclassed to provide more specific controls based on a particular control loop. Integral retention on reset is supported, which prevents re-winding the integrator after temporary disabling in presence of constant disturbances.
PID Equation
The standard PID equation is given by:
command = pterm + iterm + dterm
where:
pterm = pgain * error
iterm = iterm + igain * error * dt
dterm = dgain * derror
and:
error = desired_state - measured_state
derror = (error - errorlast) / dt
Parameters
p(Proportional gain): This gain determines the reaction to the current error. A larger proportional gain results in a larger change in the controller output for a given change in the error.i(Integral gain): This gain determines the reaction based on the sum of recent errors. The integral term accounts for past values of the error and integrates them over time to produce thei_term. This helps in eliminating steady-state errors.d(Derivative gain): This gain determines the reaction based on the rate at which the error has been changing. The derivative term predicts future errors based on the rate of change of the current error. This helps in reducing overshoot, settling time, and other transient performance variables.u_clamp(Minimum and maximum bounds for the controller output): These bounds are applied to the final command output of the controller, ensuring the output stays within acceptable physical limits.tracking_time_constant(Tracking time constant): This parameter is specific to the ‘back_calculation’ anti-windup strategy. If set to 0.0 when this strategy is selected, a recommended default value will be applied.antiwindup_strat(Anti-windup strategy): This parameter selects how the integrator is prevented from winding up when the controller output saturates. Available options are:NONE: no anti-windup technique; the integral term accumulates without correction.BACK_CALCULATION: adjusts the integral term based on the difference between the unsaturated and saturated outputs using the tracking time constanttracking_time_constant. Faster correction for smallertracking_time_constant.CONDITIONAL_INTEGRATION: only updates the integral term when the controller is not in saturation or when the error drives the output away from saturation, freezing integration otherwise.
Anti-Windup Strategies
Anti-windup functionality is crucial for PID controllers, especially when the control output is subject to saturation (clamping). Without anti-windup, the integral term can accumulate excessively when the controller output is saturated, leading to large overshoots and sluggish response once the error changes direction. The control_toolbox::Pid class offers two anti-windup strategies:
BACK_CALCULATION: This strategy adjusts the integral term based on the difference between the saturated and unsaturated controller output. When the controller outputcommandexceeds the output limits (u_maxoru_min), the integral termi_termis adjusted by subtracting a value proportional to the difference between the saturated outputcommand_satand the unsaturated outputcommand. This prevents the integral term from accumulating beyond what is necessary to maintain the output at its saturation limit. Thetracking_time_constantparameter is used to tune the speed of this adjustment. A smaller value results in faster anti-windup action.The update rule for the integral term with back-calculation is:
iterm += dt * (igain * error + (1 / trktc) * (commandsat - command))
If
trk_tc, i.e.,tracking_time_constantparameter, is set to 0.0, a default value is calculated based on the proportional and derivative gains:If
d_gainis not zero: trktc = √(dgain / igain)If
d_gainis zero: trktc = pgain / igain
CONDITIONAL_INTEGRATION: In this strategy, the integral term is only updated when the controller is not in saturation or when the error has a sign that would lead the controller out of saturation. Specifically, the integral term is frozen (not updated) if the controller output is saturated and the error has the same sign as the saturated output. This prevents further accumulation of the integral term in the direction of saturation.The integral term is updated only if the following condition is met:
(command - commandsat = 0) ∨ (error * command ≤ 0)
This means the integral term
i_termis updated asi_term += dt * i_gain * erroronly when the controller is not saturated, or when it is saturated but the error is driving the output away from the saturation limit.
Usage Example
To use the Pid class, you should first call some version of initialize() and then call compute_command() at every update step. For example:
control_toolbox::Pid pid;
pid.initialize(6.0, 1.0, 2.0, 5, -5,2,control_toolbox::AntiwindupStrategy::BACK_CALCULATION);
double position_desired = 0.5;
...
rclcpp::Time last_time = get_clock()->now();
while (true) {
rclcpp::Time time = get_clock()->now();
double effort = pid.compute_command(position_desired - currentPosition(), time - last_time);
last_time = time;
}
References
Visioli, A. Practical PID Control. London: Springer-Verlag London Limited, 2006. 476 p.
Vrancic, D., Horowitz, R., & Hagiwara, T. “Antiwindup, Bumpless, and Conditioned Transfer Techniques for PID Controllers.” IEEE Control Systems Magazine, vol. 16, no. 4, 1996, pp. 48–57.
Bohn, C.; Atherton, D. “An analysis package comparing PID anti-windup strategies.” IEEE Control Systems Magazine, 1995, pp. 34–40.
Åström, K.; Hägglund, T. PID Controllers: Theory, Design and Tuning. Research Triangle Park, USA: ISA Press / Springer-Verlag London Limited, 1995. 343 p.
Control filters
Implement filter plugins for control purposes as ros/filters
Available filters
Gravity Compensation: implements a gravity compensation algorithm, removing the gravity component from the incoming data (Wrench).
Low Pass: implements a low-pass filter based on a time-invariant Infinite Impulse Response (IIR) filter, for different data types (doubles or wrench).
Exponential Filter: Exponential filter for double data type.
Gravity compensation filter
This filter implements an algorithm compensating for the gravity forces acting at the center of gravity (CoG) of a known mass, computed at a sensor_frame and applied to a data_in wrench.
The filter relies on tf2, and might fail if transforms are missing.
Note that, for convenience, the filter can perform additional frame changes if data_out frame id is given.
GC: Required parameters
world_frame(ℛw): frame in which theCoG.forceis represented.sensor_frame(ℛs): frame in which theCoG.posis definedCoG.pos(ps): position of the CoG of the mass the filter should compensate forCoG.force(gw): constant (but updatable) force of gravity at the Cog (typically m.G), defined along axes of theworld_frame
GC: Algorithm
Given
above-required parameters, ℛw, ℛs, ps, gw
data_in, a wrench ℱi = {fi, τi} represented in thedata_inframe ℛiaccess to tf2 homogeneous transforms:
Tsi from ℛi to ℛs
Tsw from ℛw to ℛs
Tos from ℛs to ℛo
Compute data_out compensated wrench ℱco = {fco, τco} represented in the data_out frame ℛo if given, or the data_in frame ℛi otherwise, with equations:
ℱco = Tos.ℱcs,
with ℱcs = {fcs, τcs} the compensated wrench in sensor_frame (common frame for computation)
and,
fcs = fs - Tswgw
its force and,
τcs = τs - ps x (Tswgw)
its torque, and
ℱs = Tsi.ℱi = {fs, τs}
the full transform of the input wrench ℱi to sensor frame ℛs
Remarks :
a full vector is used for gravity force, to not impose gravity to be only along z of
world_frame.data_inframe is usually equal tosensor_frame, but could be different since measurement of wrench might occur in another frame. E.g.: measurements are at the FT sensor flange =data_inframe, but CoG is given in FT sensor base =sensor_frame(=frame to which it is mounted on the robot), introducing an offset (thickness of the sensor) to be accounted for.data_outframe is usuallydata_inframe, but for convenience, can be set to any other useful frame. E.g.: wrench expressed in acontrol_framelike the center of a gripper.Tsw will only rotate the gw vector, because gravity is a field applied everywhere, and not a wrench (no torque should be induced by transforming from ℛw to ℛs).
Low Pass filter
This filter implements a low-pass filter in the form of an IIR filter, applied to a data_in (double or wrench).
The feedforward and feedback coefficients of the IIR filter are computed from the low-pass filter parameters.
LPF: Required parameters
sampling frequency as
sfdamping frequency as
dfdamping intensity as
di
LPF: Algorithm
Given
above-required parameters,
sf,df,didata_in, a double or wrenchx
Compute data_out, the filtered output y(n) with equation:
y(n) = b x(n-1) + a y(n-1)
with
a the feedbackward coefficient such that a = exp( -1/sf (2 pi df) / (10^(di/-10)) )
b the feedforward coefficient such that b = 1 - a
Exponential filter
EF: Required parameters
alpha: the exponential decay factor
EF: Algorithm
smoothed_value = alpha * current_value + (1 - alpha) * last_smoothed_value;