Commit graph

47 commits

Author SHA1 Message Date
david mueller
415eefa59f new sample config 5axis xyzab_tdr using kins comp 2023-01-06 09:27:14 -07:00
Steffen Moeller
0da277b279 docs: misc changes while translating. 2022-12-30 21:28:16 +01:00
Petter Reinholdtsen
ed7bade7b2 Changed to regular format for man page cross references.
Man page viewers like khelp are able to convert hostmot2(9) into a link
to the hostmot2 manual page, while they do not understand 'man hostmot2'
or similar notation.  Thus, converted references to the regular fomat used
in manual pages.
2022-09-23 08:54:00 +02:00
Steffen Moeller
2c0a78efbc docs: screeing man pages prior to translations 2022-09-08 00:07:41 +02:00
Petter Reinholdtsen
9521f2945c Added missing colon in kins(9) manual page. 2022-08-20 11:26:04 +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
Dewey Garrett
135b0ce522 switchable kinematics
1) Control kinematics type by hal pin: motion.switchkins-type
   The _integer_ value of this float hal pin is passed
   to the kinematicsSwitch() function to select a
   kinematics type.
2) Uses M68 (analog out) in a hal net like:
     net :kinstype-select <= motion.analog-out-0N
     net :kinstype-select => motion.switchins-type
3) Supports 3 switchable kinematic types (0,1,2)
   Switching kinstype is managed by user supplied mcodes
   that provide for interp-motion syncrhonization:
     M428/M429/M130 (remap Mcode examples)
     M128/M129/M130 (user  Mcode examples with limits updates)
4) API change for kinematics:
   All kinematics modules must export functions:
          kinematicsSwitchable() (return 1 if supported)
          kinematicsSwitch()     (return 0 if ok)
       or use macro (from kinematics.h):
          KINS_NOT_SWITCHABLE
5) Provide a template (userkfuncs.c) and support building a
   user kinematics module for RIP builds
6) Supported modules:
     xyz[ab]c-trt-kins
     pumakins
     scarakins
     genserkins
     genhexkins
     5axiskins (bridgemill)
7) file updates for src/emc/kinematics/:
     genserfuncs.c: separated out genserkins functions
     trtfuncs.c:    separated out xyz[ab]c-trt-kins functions
     userkfuncs.c:  template user kins functions
     ugenserkins.c: separated user program bin/genserkins
                    (declining support, not working)
8) Docs (asciidoc fmt): docs/src/motion/switchkins.txt

******************************************************
Initial branch 24nov19
Based on work of rushabh,plopes9000,jskangas
particularly:
https://forum.linuxcnc.org/10-advanced-configuration/31813-tcp-5-axis-kinematics?start=90#124848
******************************************************

misc updates:
  scara use 6 joints as supported by vismach scaragui

  switchkins sims: [RS274NGC]FEATURES=8 obsolete
        [RS274NGC]HAL_PIN_VARS (default is 1(enable))

  update genserkins jts 6,7,8 == u,v,w
        with appropriate [KINS]JOINTS value

  support for 5axiskins (bridgemill), refactor to:
        1) support module 'coordinates' parameter and allow duplicate
           letters for multiple joints for an axis letter
        2) support A,U,V one-to-one to assigned joint
        3) support switchkins

  puma560gui: message if missing .obj files
2021-06-19 18:22:49 -07:00
luz paz
fa855db600 fix typos in docs/ and tests/
Found via codespell
2021-02-24 12:25:33 -05:00
Dewey Garrett
f2ec290d34 Merge remote-tracking branch 'origin/2.8' 2020-10-13 19:10:01 -07:00
Dewey Garrett
e6cfcfa398 userkins.comp (new) userkins using halcompile
Provide template hal component for user-built kinematics

See userkins.comp: description section
2020-10-13 19:08:22 -07:00
andypugh
cac12e2952 Merge branch '2.8' 2020-04-22 02:17:29 +01:00
andypugh
6cb796cab2 Build cleanup: sort out some docs building warnings.
Signed-off-by: andypugh <andy@bodgesoc.org>
2020-04-21 20:36:03 +01:00
Dewey Garrett
b2e2a6ad39 xyz[ab]c-trt-kins use map_coordinates_to_jnumbers
Allows unconventional mapping of coordinate letters to
joint numbers with the module 'coordinate' parameter in
the same way trivkins uses the parameter.

Default mapping is unchanged:
 xyzac-trt-kins:  x:0,y:1,z:2,a:3,c:4
 xyzbc-trt-kins:  x:0,y:1,z:2,b:3,c:4
2020-01-28 18:05:17 -07:00
Andrew Kyrychenko
3a021b7d6b pentakins kinematics #673
Introduce kinematics for a pentapod parallel kinematics machine
2020-01-12 16:57:16 -07:00
Andrew Kyrychenko
4f7e6bdaf2 pentakins: add manpage 2020-01-12 23:38:47 +02:00
andypugh
00d1e70552
Update kins.9
Note that genserkins uses modified DH parameters
2018-12-14 12:48:41 +00:00
Sebastian Kuzminsky
dec6b8580a Merge remote-tracking branch 'origin/2.7'
Conflicts:
	debian/control.bottom.in
	docs/man/man1/halstreamer.1
	docs/man/man1/halui.1
	docs/man/man1/linuxcncrsh.1
	docs/man/man1/shuttlexpress.1
	docs/man/man1/sim_pin.1
	docs/man/man9/gantrykins.9
	docs/man/man9/kins.9
	docs/man/man9/motion.9
	docs/man/man9/sserial.9
	docs/man/man9/streamer.9
	tests/startup-state/sim.var.clean
	tests/startup-state/sim.var.orig
	tests/startup-state/sim.var.pre
	tests/startup-state/test.sh
2018-01-19 08:25:06 -07: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
Dewey Garrett
c73fa859cb kins manpage: expand on duplicated coord letters
Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2017-06-07 13:40:55 -07:00
Sebastian Kuzminsky
8b81a2e4bd docs: remove invalid ".R" macro from kins.9 manpage
"man --warn" (run by lintian) let us know that ".R" is not a valid macro.

It was not clear to me what groff macro the author intended there,
so I just removed it.  The manpage renders fine and legible to me,
and without warnings.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-03-16 15:14:22 -06:00
Dewey Garrett
721e4304a8 corexy kinematics (+man page update +sim config)
Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2017-01-20 18:27:56 -07:00
Dewey Garrett
2d4f18f7c9 kins.9 clarify kinstype=B example text
Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2017-01-16 19:55:22 -07:00
Andrew Kyrychenko
f4a49b581e kinematics/genhexkins.c: add strut length correction
Add strut length correction for non-captive screw actuators with
universal (cardanic) joints, provide parameters for joint axes unit
vectors and screw lead, add pins to show correction values.

Update kins.9 manpage.

Signed-off-by: Andrew Kyrychenko <amkyrychenko@gmail.com>
2016-08-04 00:43:30 +03:00
Andrew Kyrychenko
5f44ed8ffa kinematics/genhexkins.c: add spindle-offset pin
Add spindle-offset pin to facilitate adjusting spindle position.

Convert pins to parameters where possible.

Document new pins.

Signed-off-by: Andrew Kyrychenko <amkyrychenko@gmail.com>
2016-08-04 00:43:30 +03:00
Andrew Kyrychenko
47b8d05f97 kins.9 document new pin: genhexkins.tool-offset JA
Add new pin tool-offset to kins manpage

Signed-off-by: Andrew Kyrychenko <amkyrychenko@gmail.com>
2016-06-26 19:08:28 -06:00
Dewey Garrett
63fc6c7e96 rose engine kinematics, sim example JA
Ref: https://en.wikipedia.org/wiki/Rose_engine_lathe

Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2016-06-26 19:08:28 -06:00
Sebastian Kuzminsky
9c301493b5 docs: update kins.9 manpage trivkins with some gantry info
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-06-26 19:08:28 -06:00
Dewey Garrett
73fd00adbf kins.9 fix editing errors JA
Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2016-06-26 19:08:28 -06:00
Dewey Garrett
a2c268fee0 kins.9 include new xyzac-trt,xyzbc-trt kins JA
also:
  put trivkins first in list (otherwise order alphabetically)
  and at least mention all kins available in the distribution

Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2016-06-26 19:08:28 -06:00
Dewey Garrett
74db1f519d kins.9 fix example error JA
Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2016-06-26 19:08:28 -06:00
Dewey Garrett
036345709f kins.9 update,gentrivkins,gantrykins superseded JA
Retain man pages for gantrykins,gentrivkins -- add note that these
modules are superseded by trivkins and point to trivkins (kins) man page

Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2016-06-26 19:08:28 -06:00
Dewey Garrett
4e242a69ae trivkins update, del gentrivkins, gantrykins
trivkins    was gentrivkins
gentrivkins deleted
gantrykins  deleted (use trivkins kinstype=BOTH)

Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2016-06-26 19:08:28 -06:00
Dewey Garrett
9de635e0f4 kins manpage, add info for gentrivkins
Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2016-06-26 19:08:28 -06:00
Dewey Garrett
dc1c6ac2d1 gentrivkins: add man page
Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2016-06-26 19:08:28 -06:00
Andrew Kyrychenko
0cc3445e1d genhexkins: add hal pins for joints coordinates
Parameters added for base and platform joints coordinates. Pins added
to control forward iterations. Cleaned from unused code. Manpage updated.

Signed-off-by: Andrew Kyrychenko <amkyrychenko@gmail.com>
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-01-04 21:46:45 -07:00
Sebastian Kuzminsky
47686d8e6e docs: fix branding in kins(9) manpage 2012-03-16 23:32:07 -06:00
John Thornton
3c4aba6019 Docs: update see also section
Signed-off-by: John Thornton <jthornton@gnipsel.com>
2012-01-26 07:32:33 -06:00
Jeff Epler
f34124af79 manpages: say "LinuxCNC" 2012-01-19 18:31:23 -06:00
Jeff Epler
5854faac24 document scarakins 2010-01-12 13:51:39 -06:00
Jeff Epler
96a77ae071 document pumakins 2010-01-12 13:51:39 -06:00
Jeff Epler
e86c08726f document genserkins 2010-01-12 13:51:39 -06:00
Jeff Epler
894a41a13c document maxkins 2010-01-12 13:51:39 -06:00
Jeff Epler
8c5738b130 refine markup 2010-01-12 13:51:39 -06:00
Jeff Epler
ae00a7e072 refer to gantrykins manpage 2010-01-12 13:51:38 -06:00
Sebastian Kuzminsky
6d9c3dd131 fix the syntax of the name of this manpage, for mandb 2009-12-29 15:52:26 -07:00
Chris Radek
af6f92ad60 spelling/grammar/typo fixes 2007-01-27 05:19:22 +00:00
Jeff Epler
f9e5456a8c new manpages 2007-01-20 14:54:48 +00:00