Commit graph

694 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
John Thornton
1489c87181 Docs: fix issue #143
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-08-16 11:09:36 -05:00
Jeff Epler
f581faef25 hm2_eth: doc updates
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2016-06-10 20:48:03 -05:00
Jeff Epler
52febb5f38 hm2_eth: improve docs
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2016-06-10 20:48:03 -05:00
Jeff Epler
ce80671f13 hm2_eth: detect lost reads and writes
.. with a pile of new tunables (yuck)

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2016-06-10 20:48:02 -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
01e82b2989 motion: remove overruns parameter
After the removal of heuristic overrun detection, this param's value
was never changed from 0.

As noted clearly in the documentation, this parameter was for debugging
and subject to removal at any time, so we don't need to wait to remove
it.

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2016-05-10 12:52:43 -05:00
Sam Sokolik
6ceba7a9bb irq-coalesce requires ethtools
Signed-off-by: Sam Sokolik <samcoinc@gmail.com>
2016-05-10 10:53:05 -06:00
Jeff Epler
8c082eaac5 hm2_eth: note the irq-coalesce trick
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2016-04-12 13:04:18 -05: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
John Thornton
59e5b75d78 Docs: add supported boards
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-02-04 07:07:22 -06:00
John Thornton
0baf37dce6 Docs: fix markup, for some strange reason the \fB did not carry over to the next line
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-01-28 06:37:24 -06: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
John Thornton
d819fef886 Docs: change aio from 16 to 64
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-01-14 09:08:55 -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
7cf7f9f9d6 Merge remote-tracking branch 'origin/2.6' into 2.7 2015-12-12 18:13:29 -07:00
Sebastian Kuzminsky
c3304f1103 docs: fix manpage markup bug in rtapi_app_{main,exit}.3rtapi
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-12-12 18:11:38 -07: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
21ae4806b3 Merge remote-tracking branch 'origin/2.6' into 2.7
Conflicts:
	docs/man/man9/hm2_7i90.9
2015-10-29 10:28:57 -06:00
Sebastian Kuzminsky
2485089f9c hm2_7i90 manpage: clarify firmware management
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-10-29 09:58:04 -06:00
Sebastian Kuzminsky
a6bda7b46a hm2_7i90 manpage: remove incorrect EPP info
The factoring out of the 7i43/7i90/etc EPP driver code never progressed
beyond a good intention.

Thanks to Andy Pugh for the bug report.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-10-29 09:57:47 -06:00
Jeff Epler
3b24d38347 manpages: markup fixes
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-10-10 11:45:29 -05:00
Jeff Epler
4c3c1609c1 manpages: document alias APIs
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-10-10 11:45:25 -05: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
Jeff Epler
5f8123045a hostmot2: don't let ntp cause following errors
.. by tuning the dpll so that it can handle the +-500ppm
changes in the linux CLOCK_MONOTONIC rate that can be caused
by software like ntpd and ntpdate.

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-09-03 09:54:07 -05: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
Jeff Epler
3576acb0c6 Merge remote-tracking branch 'origin/jepler/arm-atomic' into 2.7 2015-08-04 09:07:36 -05:00
Jeff Epler
f529fae1a7 rtapi: implement subset of <stdatomic.h>
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-08-03 19:06:43 -05:00
Sebastian Kuzminsky
6a5ad145d7 Merge remote-tracking branch 'origin/2.6' into 2.7
Conflicts:
	docs/man/man9/hostmot2.9
2015-07-29 10:19:37 -06:00
andypugh
fcc3b0c339 Smart-serial boards can have HAL pins identified by board serial numbers. Document this.
Signed-off-by: andypugh <andy@bodgesoc.org>
2015-07-23 19:16:48 +02:00
Jeff Epler
06ca091fad hostmot2: support split reads
.. by a new read-request function.  This is useful on systems
with more than one hm2_eth card, because the transmission of the
second read request can overlap with the first card processing
and responding to its read request.

This also splits the multiple personalities of "queue_read",
so that the length argument to "queue_read" is no longer
overloaded to select whether to queue / actually send / actually
receive the requested reads.

It also fixes the new functions so that they return success /
failure codes correctly; before, some send/recv failures were
logged via LL_PRINT but not by return value.

It also moves rtapi_delay so that the delay is only taken after a
failed recv().  With multiple cards, this typically removes
the delay for all ethernet cards after the first.

In my hal-test harness, these measures together lowered the typical
thread1.time by >40% with two cards.

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-07-18 11:37:57 -05:00
Jeff Epler
a00817f8b8 hm2_eth: allow multiple instances (up to 4)
.. including on a single gigabit ethernet interface with a
gigabit switch between the PC and multiple hostmot2 cards.

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-07-18 11:37:57 -05:00
Sebastian Kuzminsky
7679b83624 Merge remote-tracking branch 'origin/2.6' into 2.7 2015-07-15 18:57:43 -06:00
Sebastian Kuzminsky
4ef16263f0 docs: document motion.feed-inhibit better
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-07-15 17:36:35 -06:00
Sebastian Kuzminsky
5f9480d62c docs: ficks a typoe in rtapi_print(3) manpage
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-07-14 14:56:58 -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
6df518d96b hm2_eth: do iptables and sysctl configuration automatically
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-06-30 17:24:00 -05:00
Sebastian Kuzminsky
8163316158 Merge remote-tracking branch 'origin/2.6' into 2.7 2015-06-29 23:14:00 -06:00