Commit graph

1106 commits

Author SHA1 Message Date
Petter Reinholdtsen
23f5b65059 Renamed at_pidv2 component and manual page to at_pid. 2022-07-11 23:06:04 +02:00
Petter Reinholdtsen
646c668712 Removed original at_pid component. 2022-07-11 23:05:53 +02:00
Petter Reinholdtsen
d893f518bb New component at_pidv2 based on at_pid and pid components.
Started with a copy of pid.c, and copied relevant code from
at_pid.c and inserted it into relevant locations.  This way
at_pidv2 become compatible with the current pid component, and
those that want to test autotuning can insert it in-place
without modifying any pins and signals in their HAL files.

The original at_pid code was commited by Peter G. Vavaroutsos,
so insert his name as author and also copy the module name over.

Manual page at_pidv2(9) is based on pid(9) with the comment about
the auto-tuning code not being updated since 2011 added and the
relevant parts coped over from at_pid(9).

This module is tested and found to be giving not completely unusable
P, I and D values for horizontal movements.
2022-07-11 23:05:53 +02:00
Petter Reinholdtsen
ec91c44b8a Baseline for new at_pid implementation, copied pid.c and pid.9.
Copied from commit bab0790f26.
2022-07-11 23:04:48 +02:00
c-morley
7fa26e27d9
Merge pull request #1801 from petterreinholdtsen/man-pid-calc
Extend pid(9) with explanation from pic.d source
2022-07-10 10:27:50 -07:00
c-morley
380fc598b7
Merge pull request #1802 from petterreinholdtsen/man-comp-at-pid-warning
Added comment to at_pid(9) about the status and incompatibility
2022-07-10 10:22:21 -07:00
Petter Reinholdtsen
5b440208ce Add cross references between bit logic and pid related man pages
Link between and2, logic, lut5, not and xor2, as well as at_pid
and pid.
2022-07-10 11:20:09 +02:00
Greg Carl
cfd70bfd26 motion: modify jog-inhibit. Add jog-stop and jog-stop-immediate
jog-inhibit now solely inhibits a jog from starting if True.
jog-stop will abort an active jog following associated acceleration 
values if True.
jog-stop-immediate will abort an active jog immediately (this may result 
in joint following errors) if True.
2022-07-08 21:51:10 -04:00
Petter Reinholdtsen
b93ae060ee Added comment to at_pid(9) about the status and incompatibility
The at_pid component have seen no development since 2011, and
is no longer compatible with the pid component.
2022-07-06 20:13:44 +02:00
Petter Reinholdtsen
6198f94ca6 Extend pid(9) with explanation from pic.d source
Now explain the calculation done by the pid controller and how
each factor contribute to the total.
2022-07-06 00:33:23 +02:00
Petter Reinholdtsen
319f60b1da Improve io(1) and iov2(1) manual pages
Remove duplicate entries under "Additional IO v2 pins" in iov2
and add missing periods at the end of sentences in both io(1) and iov2(1)
to make sure the identical strings stay the same to save translators
duplicate work.
2022-07-02 15:22:56 +02:00
Sebastian Kuzminsky
097218d8ca docs: fix a small typo in hostmot2 manpage 2022-06-14 12:10:02 +02:00
Petter Reinholdtsen
e7f312f6be Enable translations for more manual pages
Some manual pages uses roff macros and other features not handled by
po4a.  Make more manual pages translatable by removing the use of such
macros where it is trivial to do.
2022-06-08 20:15:14 +02:00
Peter Wallace
b7673fc886 Add reset feature to inm,inmux MPG encoder counters 2022-06-06 20:22:49 -07:00
Hans Unzner
3072c20896 docs: add generated docs to gitignore 2022-06-03 15:26:38 +02:00
Petter Reinholdtsen
daa312fbc5 Remove generated translated document source files and obsolete files.
Also remove files only using during migration.
2022-06-03 15:26:38 +02:00
Steffen Moeller
a69d183551 docs: Series of changes to bring _es man pages in sync 2022-06-03 15:26:32 +02:00
Steffen Moeller
8e8c3e70af docs: removing English man pages
docs: removing all-English mb2hal man page
Removing all-English es man page mitsub_vfd.1
Removing all-English es man page mgx485.1
docs: Removed all-English _es man page xhc-whb04b-6.1
docs: Removing all-English _es man page streamer.9
2022-06-03 15:26:32 +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
Bob Bond
79f121caf7 MDRO initial version
MDRO is a simple GUI meant to provide access to the DRO scales on
a machine when using it in a manual (hand-cranked) mode.
2022-05-14 11:54:29 -07:00
Hans Unzner
34a5f4fdf5 docs: temporary fix groff subsections
This uses a local Groff macro for formatting the man pages, which takes effect in the HTML output.
The macro is taken from this commit
https://git.savannah.gnu.org/cgit/groff.git/commit/?id=4503f8b9a826cc8b9a9f4a4d3efe9adde459c3bc
When Groff 1.23 is released, this fix is included in Groff and the local version should be removed.
2022-05-06 21:35:00 +02:00
Hans Unzner
60c50b4e35 docs/man-pages: slightly reduced size of section headings 2022-04-25 16:15:40 +02:00
Peter Wallace
536b193a0a Add preliminary 7I96S support 2022-04-07 08:59:36 -07:00
Håvard F. Aasen
be9c0cab56 motion: New pin 'is-all-homed'. (Issue #1622)
True if all active joints is homed.
2022-03-26 08:03:21 +01:00
Greg Carl
7a98bcd5f0 docs: remove bad unicode characters
there are more in the .po files, as well as some of the language 
versions. I left those alone as to not mess with translation efforts, 
but can fix there too if needed.
2022-03-24 07:45:00 -04:00
Hans
1781e9ab8b
Merge pull request #1629 from hansu/docs
Improved docs, mostly Modbus to Hal
2022-03-13 12:53:14 +01:00
Hans Unzner
76b5c2708b docs: used subsections for hostmod2 man page 2022-03-13 12:10:04 +01:00
Hans Unzner
2d92c5c778 mb2hal: added pins to manpage 2022-03-13 12:04:59 +01:00
Phillip Carter
9860a51479 sim-torch:remove redundant print and gitignore 2022-02-27 11:38:33 +11:00
Phillip Carter
38e416630d qtplasmac: change sim-torch to a userspace component 2022-02-26 17:33:30 +11:00
Phillip Carter
294616f4bd qtplasmac: add a simple torch simulator 2022-02-23 15:29:29 +11:00
Peter Wallace
b9fd027576 Fix minor outm mistrakes 2022-02-22 18:21:48 -08:00
Peter Wallace
dd3f7c7cd0 Add OutM simple output module support 2022-02-21 17:23:42 -08:00
luz paz
d7ea470096 Fix various typos
Found via `codespell -q 3 -S *.po,*.ts,./share,./docs/man/es,./configs/attic,*_fr.*,*_es.*,README_es -L ans,ba,bulle,componentes,doubleclick,dout,dum,fo,halp,ihs,inout,parm,parms,ro,ser,te,ue,wille,wont`
2022-02-16 11:17:29 -05:00
Phillip Carter
2d305b8306 add to gitignore: man9/homecomp.9, man9/tpcomp.9 2022-02-16 19:37:00 +11:00
Phillip Carter
2dd43208c3 motion: additional feed pins
add inches-per-minute, inches-per-seond, mm-per-minute, and 
mm-per-second feed pins
2022-02-11 11:00:12 +11:00
Sebastian Kuzminsky
13eb99bec7
Merge pull request #1560 from phillc54/phillc54/latency-test
latency-test: fixes for using servo-thread only.
2022-02-02 11:55:28 -07:00
Phillip Carter
0786cc1d84 latency-test: fixes for using servo-thread only.
some doc changes
2022-02-01 16:34:35 +11:00
Hans Unzner
5daea1b40e docs: Updated/extended halshow doc 2022-01-31 14:05:22 +01:00
Phillip Carter
abd1c8fdfa add new halpins motion.jog-inhibit and motion.jog-is-active 2022-01-31 18:56:21 +11:00
c-morley
ca22fa0af1
Merge pull request #1552 from hansu/docs
Some work on docs
2022-01-30 18:12:41 -08:00
Sebastian Kuzminsky
65b2093905 Merge remote-tracking branch 'origin/2.8'
* origin/2.8:
  add a test that verifies that rtapi shmem is initialized to zeros
  hal_lib: fix a race in hal_init()
  rtapi fix shmem comment
  docs: fix an omission in the rtapi_shmem manpage
  hal_lib: whitespace fixes only, no code change
  hal_lib: minor cosmetic fix to a seldom-seen debug message
  mitsub_vfd docs: add point we are not using MODBUS
  mitsub_vfd -add open, close then open agaon - some systems require it.
2022-01-27 09:09:50 -07:00
Sebastian Kuzminsky
d04578b40c docs: fix an omission in the rtapi_shmem manpage
Make explicit an important promise made by rtapi_shmem_new(): When a
block of memory is first allocated, it is initialized to all zero bytes.

On Uspace rtapi_shmem_new() calls shmget(), which zeros the memory when
creating a new shared memory block:

    https://man7.org/linux/man-pages/man2/shmget.2.html#DESCRIPTION

On RTAI rtapi_shmem_new() calls rtai_kmalloc() and rtai_malloc(), which
both end up calling _rt_shmem_new().  The documentation does not say
anything about initialization of freshly allocated memory buffers, but
Paolo Mantegazza (one of the main RTAI developers) said that RTAI *does*
zeros shmem buffers, and pointed to this code:

    https://mail.rtai.org/pipermail/rtai/2022-January/028282.html
    http://cvs.savannah.nongnu.org/viewvc/rtai/magma/base/ipc/shm/shm.c?view=markup#l69
2022-01-26 13:27:11 -07:00
Steffen Moeller
36735d950a g-code -> G-code 2022-01-18 14:38:59 +01:00
Steffen Moeller
1e06bf4e93 gcode -> G-code 2022-01-18 14:26:27 +01:00
CMorley
cd22b5e92c mitsub_vfd docs: add point we are not using MODBUS 2022-01-16 01:59:16 -08:00
CMorley
d42398ede7 mitsub -add new VFDs required pr 549 setting
also make it more obvious we are usinh computer link protocol.
2022-01-15 16:29:05 -08:00
CMorley
8e5570e8a1 mitsub_vfd -fix error in docs for data/stop setting 2022-01-14 20:06:03 -08:00
CMorley
4d056d45a4 mitsub_vfd -fix documention of the serial data/stop setting 2022-01-14 19:46:14 -08:00
c-morley
a69c3f9962
Merge pull request #1468 from petterreinholdtsen/typy-man-hal-type-t
Fix typo in hal_type_t(3) manual page.
2021-12-27 20:31:09 -08:00