Commit graph

21 commits

Author SHA1 Message Date
andy pugh
50fb9d6435 encoders / resolvers: Add RPM pin for convenience
Add an -rpm velocity pin for HAL encoder and Mesa encoder and resolver modules.

Signed-off-by: andy pugh <andy@bodgesoc.org>
2019-04-26 20:16:22 +01: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
Sebastian Kuzminsky
20b05daf60 docs: update encoder.9 manpage
The encoder comp has no parameters, and the min-velocity-estimate pin
is really called min-speed-estimate (because it's direction-insensitive).

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-06-29 23:10:09 -06:00
Sebastian Kuzminsky
38e2776a8b docs: document the surprising encoder num_chan=0 behavior
It means "use the default, 3".

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2014-12-21 13:04:15 -07:00
Jeff Epler
f34124af79 manpages: say "LinuxCNC" 2012-01-19 18:31:23 -06:00
Dewey Garrett
bc5b33c97c encoder: rename export_counter to export_encoder
and reduce its parameters
try to clarify man page for naming of pins and parameters
2011-09-28 21:06:43 -05:00
Dewey Garrett
25eb078da6 encoder: 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
4570332ff8 remove stray sentence 2011-01-17 11:32:26 -06:00
Jeff Epler
43c2039a7c fix markup problem 2010-05-29 09:57:27 -05:00
John Thornton
5d7cc06ca8 parameters were converted to pins on 2008-10-26
Signed-off-by: John Thornton <bjt128@gmail.com>
2010-01-15 07:24:13 -06:00
Jeff Epler
d6d41e6eda document new functionality 2009-10-22 14:00:44 -05:00
Jeff Epler
5a39e13fc0 fix redundant markup 2009-10-22 13:57:22 -05:00
Jeff Epler
7077457df0 improve discussion of estimated modes 2009-05-13 14:18:48 +00:00
John Thornton
cb9a0dde5e update pins and parameters 2009-04-15 12:41:53 +00:00
John Kasunich
b0dfeb4655 rename interpolated position output for clarity, update man page 2008-07-11 03:24:17 +00:00
John Kasunich
6c28506b0f fix man page - encoder 'counter mode' counts only on rising edge, not both edges. (Both edges would give inaccurate results if the signal isn't a 50/50 duty cycle.) 2007-09-03 14:45:59 +00:00
Jeff Epler
adceea6e80 document the new counter mode for the encoder component, and note that the old, separate counter component is deprecated 2007-05-15 01:11:19 +00:00
Chris Radek
af6f92ad60 spelling/grammar/typo fixes 2007-01-27 05:19:22 +00:00
John Kasunich
29558f842a implement improved velocity output (much lower jitter, especialy at low speeds), also ensured that data transfer from the fast update() function to the slow capture() one is atomic 2007-01-27 05:09:31 +00:00
John Kasunich
1d329066c3 fix pin naming conventions in manpage 2007-01-22 04:30:06 +00:00
John Kasunich
991fadf75f add man page 2007-01-22 00:51:24 +00:00