Commit graph

55 commits

Author SHA1 Message Date
Steffen Moeller
9a3a463ef5 docs - halui.1 - capitalisatoin of overrides 2022-11-07 15:16:44 +01:00
Steffen Moeller
73ada7b343 docs: following @hansu's suggestions to improve consistency 2022-11-07 14:30:56 +01:00
Steffen Moeller
9ce4147bd5 docs: more smallish changes while translating. 2022-11-07 14:21:04 +01:00
Steffen Möller
3ebf4c5510 docs: Preparing tables more weblate. Small bits. 2022-10-03 17:07:13 +02:00
Steffen Moeller
d1aadf7c88 More inifile -> INI file 2022-09-08 01:46:01 +02:00
Steffen Moeller
2c0a78efbc docs: screeing man pages prior to translations 2022-09-08 00:07:41 +02:00
Petter Reinholdtsen
56a8554b0f Remove empty HISTORY, BUGS, EXAMPLES and SEE ALSO man page sections. 2022-08-20 16:43:09 +02:00
russellgower
bee7a6173a Add reset pins for halui Rapid Override, Feed Override and Spindle Overrides
halui currently has pins for increasing and decreasing the above overrides but
there isn't currently a universal way to reset them back to 1.0.

My use case is, I have 3 rotary encoders on my control panel each with a
momentary centre push switch.
I have the encoders setup to adjust the overrides with the centre push switch
connected to the new reset pins to quickly set the overrides back to 100%.

Prior to making this change I could increase and decrease the overrides from my
control panel, but I had to use the GUI to reset back to 100%.
2022-08-08 09:43:38 +01:00
Steffen Moeller
a69d183551 docs: Series of changes to bring _es man pages in sync 2022-06-03 15:26:32 +02:00
andypugh
05f82e72ab Revert "docs: Experimentally unescape the hyphens in man1/halui"
This reverts commit 02387e36e8.

The fix was to switch the documets building buildslave to Buster.
2021-03-20 19:14:44 +00:00
andypugh
02387e36e8 docs: Experimentally unescape the hyphens in man1/halui
There seems to be a problem only when the docs are uploaded and web-served
from wlo that - becomes &minus become –.
And the long dash doesn't work as a HAL pin name.

Signed-off-by: andypugh <andy@bodgesoc.org>
2021-03-05 21:06:41 +00:00
Dewey Garrett
d433aace2b halui man page fix L identifier for selected items
Ref: https://forum.linuxcnc.org/32-documents/39971-possible-error-in-docs-2-8-0-pre1-man-halui#181165

missed earlier at 9d45b153ad
2020-09-07 14:31:49 -07:00
Dewey Garrett
9d45b153ad halui man page remove confusing numerical refs
in the identification of axis (coordinate letter) jogging
2019-06-12 10:54:45 -07:00
andy pugh
ebb709fc27 Multispindle: Correct the spindle pin names in docs and .comps
Signed-off-by: andy pugh <andy@bodgesoc.org>
2018-09-29 13:52:16 +01: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
Jeff Epler
5983acda83 Merge pull request #331 from lkundrak/lr/fsf-address
all: update FSF address in GPL 2.0 notices
2017-09-15 06:41:50 -05:00
Lubomir Rintel
a63ec765cb all: update FSF address in GPL 2.0 notices
If you write to 59 Temple Place you're unlikely to get a response.
Let's realign the address with a more up-to-date one from [1].

  [1] https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt

This is purely a cosmetic change, doesn't affect the meaning of the
license. Done to make rpmlint happy.

Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
2017-09-15 13:06:22 +02:00
Dewey Garrett
9787a7d484 halui.cc: new pin: halui.machine.units-per-mm
Use-case:
   Some hal components can use the units-per-mm
   ([TRAJ]LINEAR_UNITS) to reduce user required
   configuration items.
   (viz. eoffset_pid internal gain scaling)

Note:
  1) simpler to implement as an inihal pin but
     delayed creation not acceptable for intended usage
2017-09-07 05:52:50 -07:00
Jeff Epler
a562a9f3a8 halui: Add outputs that track whether joint limit override is enabled
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2017-05-11 09:57:07 -05:00
Sebastian Kuzminsky
038ae46394 Merge remote-tracking branch 'origin/2.7' 2017-04-14 11:08:40 -06:00
Sebastian Kuzminsky
a1f1aa42bf docs: add units info to halui max-velocity pins in manpage
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-04-10 12:25:59 -06:00
Sebastian Kuzminsky
7183394aa0 docs: flesh out max-velocity pins in halui manpage
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-04-10 11:40:28 -06:00
Sebastian Kuzminsky
c76c69194a halui: add a hal pin with the current tool diameter
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-02-07 16:53:08 -07:00
Dewey Garrett
db0d3329d4 halui man page: clarify analog jog items
Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2016-06-26 19:08:28 -06:00
Dewey Garrett
171b5c05ed man page compiler warnings try fix
Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2016-06-26 19:08:28 -06:00
Dewey Garrett
f6e968df82 fix some compiler warnings (edit errors)
Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2016-06-26 19:08:28 -06:00
Dewey Garrett
2aba0b8f56 halui support for axis jogging (world,teleop)
Halui now supports teleop jogging resulting in some
changed pin names and numerous new names for jogging-related
pins.

Two pins were renamed to clarify usage (joint or axis):
      was: halui.jog-speed          is: halui.joint.jog-speed
      was: halui.jog-deadband       is: halui.joint.jog-deadband
The corresponding new pins for axis jogging are:
                                   new: halui.axis.jog-speed
                                   new: halui.axis.jog-deadband

All pins for joint jogging were renamed for specificity:
      was: halui.jog.N.plus         is: halui.joint.N.plus
      was: halui.jog.N.minus        is: halui.joint.N.minus
           ...  etc                     ... etc
    where N is a joint number (0 ... num_noints-1) or 'selected'
    for the joint selected by the halui.joint.N.select pins.

The corresponding new pins for axis jogging are:
                                   new: halui.axis.L.plus
                                   new: halui.axis.L.minus
                                        ... etc
where L is a letter corresponding to one of the axes
specified by [TRAJ]COORDINATES using an axis_mask or 'selected'
for the axis selected by the halui.axis.L.select pins.

Aditional pin renames for consistency to related pins:
  was: halui.joint.selected.is_homed
   is: halui.joint.selected.is-homed

  was: halui.joint.selected.on-soft-limit
   is: halui.joint.selected.on-soft-min-limit

If no axes are specified, make pins for all (mask=0xffff)

While the pin halui.joint.selected value is the number of
the joint selected, the pin halui.axis.selected is the index
of the corresponding axis (0:x 1:y 2:z 3:a 4:b 5:c 6:u 7:v 8:w)
since hal pin values must be numbers not letters.

Fixed bug: at startup,joint0/axis0(X) is used for selected
axis/joint but halui.joint.0.is-selected/halui.axis.x.is-selected
was not set.

Changed int sendJog*()  to static void sendJog*() (return was never tested)

Remove comment section in halui.cc that is redundant to man page

Updated halui man page.

Notes:
 1) No pin has ever been created for accessing the selected
    analog input for joint jogging (e.g.,
    halui.joint.selected.analog), so no corresponding pin
    was created for axis jogging.
 2) axis pins are created for all axes (xyxabcuvw) but
    jogging commands are sent iff the axis_mask applies,
    e.g., [TRAJ]COORDINATES values are enforced.
 2) some prints remain for debugging "...unexpected_n..."

Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2016-06-26 19:08:28 -06:00
Sebastian Kuzminsky
bdb5abc41d docs: clarify some pins in the halui manpage
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-11-12 23:02:00 -07:00
Sebastian Kuzminsky
27f0bdd233 halui: add Rapid Override pins to manpage 2014-06-10 16:51:11 -05:00
Sebastian Kuzminsky
4e47db6db2 halui manpage: fix incremental jog pin types
They're bits, not floats.
2014-01-06 10:32:05 -07:00
Sebastian Kuzminsky
8cb7ccbe6d docs: rebranding 2013-04-18 13:43:03 -06:00
Sebastian Kuzminsky
055008a887 halui manpage: document the mdi-command-XX pins 2013-03-27 23:01:20 -06:00
Sebastian Kuzminsky
70522aec9f fix a typo in halui manpage 2013-03-27 22:53:00 -06:00
John Thornton
fa358f7dd5 Docs: add missing pins, clarify indeterminate descriptions
Signed-off-by: John Thornton <jthornton@gnipsel.com>
2012-04-05 08:20:45 -05:00
John Thornton
83d80b9f8d Docs: fix typo
Signed-off-by: John Thornton <jthornton@gnipsel.com>
2012-02-26 05:49:17 -06:00
John Thornton
fa2918115b Docs: re-branding
Signed-off-by: John Thornton <jthornton@gnipsel.com>
2012-01-26 07:42:29 -06:00
Jeff Epler
f34124af79 manpages: say "LinuxCNC" 2012-01-19 18:31:23 -06:00
Kim Kirwan
910bb67e8e Docs: edit jog analog deadband comment
Improve this man 1 comment.

This is part of the big edit push of 20110607


Signed-off-by: Kim Kirwan <Kim@KimKirwan.com>
2011-06-07 16:18:14 -05:00
John Thornton
e4efeb83ea Docs: add pin types
Signed-off-by: John Thornton <jthornton@gnipsel.com>
2011-04-22 06:51:48 -05:00
Sebastian Kuzminsky
fde7b3559d Merge branch 'v2.4_branch' into v2.5_branch
* v2.4_branch:
  Make a script to say the version of the software
  remove redundant initialization
  remove a redundant initialization
  fix a NULL pointer dereference
  fix a NULL pointer dereference
  halui manpage: pin names use "-", not "_"

Conflicts:
	debian/update-dch-from-git
2011-04-07 18:45:59 -06:00
Sebastian Kuzminsky
2ec0dca624 halui manpage: pin names use "-", not "_" 2011-04-02 15:08:01 -06:00
John Thornton
9ed35776a4 add fo and so direct-value
Signed-off-by: John Thornton <jthornton@gnipsel.com>
2011-01-23 06:57:38 -06:00
Sebastian Kuzminsky
9a14c1ccd8 fix pin name: it's really halui.jog-speed 2011-01-14 15:55:56 -07:00
Sebastian Kuzminsky
d88e16b197 minor improvements to halui.1 manpage
Fix a typpo, and describe the behavior of some of the spindle control
pins with a bit more detail.
2010-08-26 21:10:54 -06:00
John Thornton
893fc9073d Update man page to include new pins
Signed-off-by: John Thornton <bjt128@gmail.com>
2010-04-17 06:38:57 -05:00
John Thornton
92d99f07aa number of joints depends on the config
Signed-off-by: John Thornton <bjt128@gmail.com>
2010-02-01 07:03:39 -06:00
John Thornton
58aea10b28 spelling fix
Signed-off-by: John Thornton <bjt128@gmail.com>
2010-01-13 06:19:02 -06:00
Jeff Epler
6be2b46b26 pins added since last doc update 2008-12-19 15:35:57 +00:00
Jeff Epler
5ab29a463c velocity and dtg as pins of motion 2008-09-09 20:38:09 +00:00