Commit graph

225 commits

Author SHA1 Message Date
Sebastian Kuzminsky
f4c9802365 docs: fix cut-n-paste bug in mb2hal manpage
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-12-11 14:24:05 -07:00
Dewey Garrett
3c9b549eae halcmd manpage & help: update for 'save' command
updates some undocumented details

manpage:
1) add info for 'save' command for the "alias" type
2) note that 'save all' includes the "alias" type
3) list all types available for the 'save' command
   (some are redundant)
3) note equivalence of 'save' types:
     sig   signal
     param parameter
     netla netal

help save text:
1) include "alias"
2) list all available save types
2) refer to man page for details

Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2016-11-09 13:57:50 -07:00
Moses McKnight
98d06f0c3e elbpcom manpage fix: default address is 192.168.1.121
Signed-off-by: Moses McKnight <moses@texband.net>
2016-09-28 13:07:56 -05:00
Sebastian Kuzminsky
01e4bb6889 Merge remote-tracking branch 'origin/2.6' into 2.7 2016-06-08 11:19:03 -06:00
Sebastian Kuzminsky
7c21c70238 shuttlexpress: clean up the manpage & asciidocs
This fixes some wording problems, simplifies the flow of the text,
and updates the asciidoc documentation to be up-to-date with the manpage.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-06-08 11:17:20 -06:00
Jeff Epler
e709309ecf docs: give up in disgust about documenting udev rules syntax
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2016-03-13 20:51:19 -05:00
Dewey Garrett
3c0e24aa78 linuxcncrsh man page, remove wrong note
Forum user k-1 reported that the man page note conflicts with
observed behavior.
ref: https://forum.linuxcnc.org/forum/24-hal-components/30500-linuxcncrsh-need-suggest-for-chang-open-prog#70984

I can find no usages of the message EMC_TASK_PLAN_CLOSE_TYPE that
was cited as reason for the note (msg is defined but not used).

Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2016-03-03 15:18:05 -07:00
Jeff Epler
4d02519fb4 Merge remote-tracking branch 'origin/2.6' into 2.7
Conflicts:
	VERSION
	debian/changelog
2016-01-16 09:47:24 -06:00
Sebastian Kuzminsky
757675682f include udev rule file for ShuttleXpress USB jog pendant
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-01-12 18:32:32 -07:00
John Thornton
01bb3624f2 Docs: add mb2hal, work in progress
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-01-02 06:40:53 -06:00
Sebastian Kuzminsky
ad8ddd2b1d Merge remote-tracking branch 'origin/2.6' into 2.7 2015-11-14 10:46:32 -07: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
760a7f2bb0 hy-vfd: set P144 correctly
Set P144 to "motor speed at 50 Hz", as expected by the VFD.  The driver
used to incorrectly set it to "max motor speed", or "max motor speed
divided by 10", due to my misreading of the Huanyang manual.

This makes RoTT and the VFD speed display correct.

Update hy-vfd manpage to match.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-09-13 15:54:57 -06:00
Sebastian Kuzminsky
20beefc092 hy-vfd manpage: fix a copy/paste error
Thanks to Russell Brown for the bug report.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-08-20 17:21:19 -06:00
Sebastian Kuzminsky
6b21783f7c hy-vfd: reflow manpage to not look like roff markup
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-08-12 18:16:15 -06:00
Sebastian Kuzminsky
d4d282e7c2 hy-vfd: allow setting VFD params from command-line
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-08-05 01:34:46 -06:00
Sebastian Kuzminsky
056edd9a18 hy-vfd: rename variables & pins from "modbus" to "hycomm" for clarity
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-08-05 01:34:46 -06:00
Sebastian Kuzminsky
d9b2bb1536 hy-vfd: rename pins to match motion's convention
Rename .spindle-fwd to .spindle-forward, and .spindle-rev to
.spindle-reverse.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-08-05 01:34:46 -06:00
Sebastian Kuzminsky
f29f7d77e5 hy-vfd: add some useful spindle speed pins
.spindle-speed-fb, .spindle-at-speed, .spindle-at-speed-tolerance

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-08-05 01:34:46 -06:00
Sebastian Kuzminsky
67d92d2d11 hy-vfd: add a manpage
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-08-05 01:34:45 -06:00
Dewey Garrett
e082ca2f98 moveoff_gui: include all cmdline opts in manpage
to make consistent with --help option
Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2015-07-08 13:27:48 -07:00
Jeff Epler
45cf42e69e elpbcom: communicate directly with mesa ethernet cards
.. very distantly based on the program from the mesa 7i80 manual

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-04-18 19:30:26 -05:00
Dewey Garrett
9c0f90b004 xhc-hb04: support lower accels for mpg jogging
Specify with ini setting:
  [XHC_HB04_CONFIG]mpg_accels = a1 a2 a3 a4

If an item is not specified, uses [AXIS_N]MAX_ACCELERATION.
Method uses ini hal pins: ini.N.max_acceleration connected by
an [APPLICATIONS]APP = xhc-hb04-accels

Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2015-03-29 08:18:50 -07:00
Dewey Garrett
01cc0bc40e xhc-hb04: add pin for in or mm icon
tested/working with an 18 button pendant
Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2015-03-29 08:18:38 -07:00
Dewey Garrett
9288501db6 xhc-hb04 manpage: fix missing output pin .sleeping
+ fix some typos, + add some text

Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2015-03-10 08:14:25 -07:00
Dewey Garrett
1d0222002d xhc-hb04: add man page, update inline docs
Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2015-03-07 10:43:05 -07:00
Sebastian Kuzminsky
ffb3a15043 halcmd: manage prompt better
Only display a prompt if run in interactive mode, ie if the input is
a terminal.  As always, the prompt is "halcmd: " in normal mode and "%"
in script mode.

If the input is not a terminal, do not display a prompt.  This is new
behavior, prompted (heh) by ugly output (lots of "%" lines") from stepconf
running halcmd.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-01-28 18:10:25 -07:00
Dewey Garrett
91247e5e0b moveoff_gui: new manpage
and remove redundant text from the script
also: brief manpage for sim_pin

Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2014-12-18 17:22:59 -07:00
Sebastian Kuzminsky
4acb2d53df docs: document io's lube pin a bit more
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2014-11-07 17:20:31 -07:00
Sebastian Kuzminsky
bf5bffb465 remove EMC_WAIT_NONE from shcom, it's broken
Before this commit it was possible for programs using shcom to set
emcWaitType to EMC_WAIT_NONE, which meant that no wait at all would
happen after a command was put on the Command NML channel.

The programs using shcom are:
    * linuxcncrsh
    * the Tcl linuxcnc library
    * linuxcnclcd
    * the schedrmt tool

This wait mode is bug-prone and means messages from these programs to
Task might get overwritten and lost.

This "none" wait type was never explicitly requested by any in-tree code
that I could find, but it's possible that out-of-tree code could use it.

This commit removes EMC_WAIT_NONE entirely, to ensure that it does not
get used.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2014-10-21 12:12:32 -05:00
Dewey Garrett
4ef6ce7902 inihal: add hal pins for trajectory planner items
Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2014-10-09 07:07:03 -07:00
Jeff Epler
e667607774 Merge remote-tracking branch 'origin/2.6'
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2014-09-30 09:23:38 -05:00
Jeff Epler
8dbe3a5854 docs: document milltask's "ini.*" hal pins
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2014-09-30 09:21:03 -05:00
Sebastian Kuzminsky
b3d38ac4d3 Merge remote-tracking branch 'origin/2.6'
Conflicts:
	VERSION
2014-08-07 17:20:28 -06:00
Sebastian Kuzminsky
e03f459ec8 use easier-to-type bugtracker URL in some manpages 2014-07-29 10:18:27 -06:00
Chris Radek
a0613f0834 Rename comp to halcompile, to avoid several kinds of confusion
comp is part of MH ("compose"), and is also a hal component ("Two input
comparator with hysteresis"), so calling our compiler "comp" causes
trouble, in particular when the shell helpfully suggests you install mh.
2014-06-24 13:51:30 -05:00
Sebastian Kuzminsky
27f0bdd233 halui: add Rapid Override pins to manpage 2014-06-10 16:51:11 -05:00
Michael Haberler
7f4d56b01c halcmd: update man page on link/unlink semantic change 2014-03-27 17:51:18 +01:00
Sebastian Kuzminsky
55a8af724e Merge remote-tracking branch 'origin/v2.5_branch' 2014-03-03 17:14:29 -07:00
Sebastian Kuzminsky
97780e3fa6 docs: update --help & manpage for axis-remote 2014-02-10 09:42:56 -07:00
Sebastian Kuzminsky
cb024e4882 Merge remote-tracking branch 'origin/v2.5_branch' 2014-01-06 10:34:50 -07: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
490e035e97 vfd-b: update manpage, .frequency-limit is a pin not a param 2013-11-16 22:14:34 -07:00
Sebastian Kuzminsky
c263a21b1a vfd-b: add some missing pins to manpage
These pins are exported by the driver but were not described in the
manpage.
2013-11-16 22:14:31 -07:00
Sebastian Kuzminsky
d02652f7b4 vfd-b: note pin directions correctly in manpage 2013-11-16 22:13:52 -07:00
Sebastian Kuzminsky
9b84ad02c6 vfd-b: add .motor-RPS to manpage 2013-11-16 22:09:49 -07:00
Sebastian Kuzminsky
794b91a89a vfd-b: drop non-existent pins from manpage
This drops:

    .output-current-percentage
    .current-load-percentage
    .err-reset
    .output-voltage-percentage

None of these pins were/are created by the vfd-b driver.
2013-11-16 22:06:57 -07:00
Sebastian Kuzminsky
7fcf80c5d9 vfd-b: clarify some pins in manpage 2013-11-16 22:06:57 -07:00
Sebastian Kuzminsky
d34833fba8 vfd-b: document ini vars in manpage 2013-11-16 22:06:57 -07:00
Sebastian Kuzminsky
a441119bfe vfd-b: remove dead code 15/15
The vfd-v only supports RTU, not TCP.
2013-11-16 22:06:57 -07:00