Commit graph

25 commits

Author SHA1 Message Date
Steffen Moeller
0da277b279 docs: misc changes while translating. 2022-12-30 21:28:16 +01:00
Steffen Möller
ec02e63f4f docs: More translation-triggered changes 2022-12-29 01:34:45 +01:00
Petter Reinholdtsen
a882b0bc9b Merge auto tune support into pid HAL component
Instead of having a separate PID component with auto tuning support,
it is easier for users to have only one PID component where auto
tuning is a runtime option for those that want to use it.

Drop the at_pid HAL component and move its implementation and
documentation into the pid HAL component.  The code is marked
using #ifdef AUTO_TUNING to make it easy to identify in the code,
and trivial to compile out for those that want to.

There is some questions on how useful and efficient the implemented
auto tuning method is, and while I am sure it can be improved, it
did work for my machie and provided useful Pgain, Igain and Dgain
values for my X and Y axis.  As it is a runtime option, those
that do not want automatic tuning can simply ignore this feature.

Keep the at_pid(9) manual page to let earlier users know to use
the pid component instead.
2022-07-28 09:42:28 +02:00
c-morley
7fa26e27d9
Merge pull request #1801 from petterreinholdtsen/man-pid-calc
Extend pid(9) with explanation from pic.d source
2022-07-10 10:27:50 -07:00
Petter Reinholdtsen
5b440208ce Add cross references between bit logic and pid related man pages
Link between and2, logic, lut5, not and xor2, as well as at_pid
and pid.
2022-07-10 11:20:09 +02:00
Petter Reinholdtsen
6198f94ca6 Extend pid(9) with explanation from pic.d source
Now explain the calculation done by the pid controller and how
each factor contribute to the total.
2022-07-06 00:33:23 +02:00
Petter Reinholdtsen
186284aad7 Make more man pages po4a compatible. Fixes most generated man pages.
Remove the use of roff macro definitions, as po4a do not understand
this.
2022-06-03 15:26:30 +02:00
Sebastian Kuzminsky
57106b06e8 docs: add missing word to pid.9 manpage 2021-09-19 12:27:07 -06:00
Eduard Kachur
6f79bc58de Add FF3 term to PID 2019-11-13 12:23:40 +02:00
Sebastian Kuzminsky
4a897203bc docs: fix hyphen/minus confusion in manpages
groff treats '-' (the character you get when you hit the "minus" key on
the keyboard) as "hyphen", not as "minus".  Thus it renders incorrectly
in some locales, and line-wraps strangely.

groff treats the two-character sequence "\-" as "minus", and the
four-character sequence "\(hy" as "hyphen".

Details here: https://lists.debian.org/debian-devel/2003/03/msg01481.html

This commit replaces every instance of "-" in our manpages where the
meaning is "minus" with "\-", so it works right.

This fixes many lintian warnings.
2018-01-18 08:12:31 -07:00
bdebruijn
80c46b9207 docs : update manpage pid.9 for use of IN pins 2014-07-14 15:01:01 -05:00
Chris Radek
879303e8c2 use-case for the new pid mode will help explain better. 2013-01-26 11:37:44 -06:00
Chris Radek
0e448bcff0 Merge branch 'pid-ferror-fix-try2' into v2.5_branch 2013-01-26 11:32:43 -06:00
Chris Radek
a54ea0379f It's not clear how negative gains should work. Warn about them. 2013-01-25 12:56:50 -06:00
Chris Radek
52057aac1e Document new pid pin 2013-01-12 12:39:01 -06:00
Jeff Epler
f34124af79 manpages: say "LinuxCNC" 2012-01-19 18:31:23 -06:00
Dewey Garrett
77a0082cad pid: bugfix: use howmany not num_chan in test
also: reduce parameters of export_pid()
try to clarify man page for naming of pins, parameters, functions
2011-09-28 21:06:43 -05:00
Dewey Garrett
35e3377a80 pid: support names= option
For consistency with components created with the comp utility
and for improved modularity when using [HAL]TWOPASS processing
2011-08-17 21:55:00 -05:00
Jeff Epler
3986754221 pid: index-enable is related to -deriv inputs too 2010-11-07 12:29:21 -06:00
Jeff Epler
159df2fdba Merge branch 'v2.4_branch' of ../emc2.4 2010-11-07 12:27:24 -06:00
Jeff Epler
5237b3b14b pid: document index-enable pin 2010-11-07 12:27:11 -06:00
Jeff Epler
44586b831e pid: accept external command-deriv, feedback-deriv
One problem frequently identified with pid is that the D term is
excessively noisy due to quantization (particularly of feedback position).

Introduce command-deriv and feedback-deriv pins.  These can be connected
to some (hopefully superior) source of the derivative.  For example, a
system with an analog tach signal in hal could use that value for
feedback-deriv.  It also becomes easier to test different derivative
computation functions, such as explicit smoothing of the D term or
the five-point method mentioned on wikipedia
    http://en.wikipedia.org/wiki/Numerical_differentiation#Higher_order_methods

Zero, one, or both of the -deriv pins may be connected.  When a -deriv
pin is not connected, the  related value input is computed by the
traditional two-point difference method.  This means that when neither
pin is connected the behavior is the same as before (except for rounding
differences).
2010-10-27 09:37:24 -05:00
Jeff Epler
03bf7a3325 add outputs related to saturation
pid saturation is another way to detect a fault in the servo amplifier or feedback.  the exact policy for fault detection via saturation is left to the integrator.
2008-08-19 15:10:23 +00:00
Chris Radek
af6f92ad60 spelling/grammar/typo fixes 2007-01-27 05:19:22 +00:00
John Kasunich
150dadcd13 man page for PID loop 2007-01-23 03:53:23 +00:00