Commit graph

16 commits

Author SHA1 Message Date
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