Skip to content

Commit 7a0f006

Browse files
authored
Add documentation to fields (#173) (#174)
1 parent 360cf80 commit 7a0f006

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

control_msgs/msg/PidState.msg

+15
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,28 @@
11
std_msgs/Header header
22
builtin_interfaces/Duration timestep
3+
4+
# error = target - state
35
float64 error
6+
# derivative of error
47
float64 error_dot
8+
9+
# equals error
510
float64 p_error
11+
# weighted integral of error
612
float64 i_error
13+
# equals derivative of error
714
float64 d_error
15+
16+
# proportional gain
817
float64 p_term
18+
# integral gain
919
float64 i_term
20+
# derivative gain
1021
float64 d_term
22+
# upper integral clamp.
1123
float64 i_max
24+
# lower integral clamp.
1225
float64 i_min
26+
27+
# output of the PID controller
1328
float64 output

0 commit comments

Comments
 (0)