Skip to content

Commit 3174e77

Browse files
committed
Docs: add missing info for compensation file and expand on description.
Do not merge with 2.7 the information is in different locations. Signed-off-by: jethornton <jthornton@gnipsel.com>
1 parent d6b7997 commit 3174e77

1 file changed

Lines changed: 46 additions & 23 deletions

File tree

docs/src/config/ini-config.txt

Lines changed: 46 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1057,31 +1057,54 @@ For more information on kinematics modules see the manpage: '$ man kins'
10571057
can be used to make up for small deficiencies in the hardware used to
10581058
drive an joint. If backlash is added to an joint and you are using
10591059
steppers the STEPGEN_MAXACCEL must be increased to 1.5 to 2 times the
1060-
MAX_ACCELERATION for the joint.
1060+
MAX_ACCELERATION for the joint. Excessive backlash compensation can cause an
1061+
axis to jerk as it changes direction. If a COMP_FILE is specificed for an
1062+
axis BACKLASH is not used.
10611063

10621064
* 'COMP_FILE = file.extension' -
1063-
(((Compensation))) A file holding compensation structure for the joint.
1064-
The file could be named joint0screw.comp (or xscrew.comp for the X axis
1065-
for aa config with identity kinematics). File
1066-
names are case sensitive and can contain letters and/or numbers. The
1067-
values are triplets per line separated by a space. The first value is
1068-
nominal (where it should be). The second and third values depend on the
1069-
setting of COMP_FILE_TYPE. Currently the limit inside LinuxCNC is for 256
1070-
triplets per joint. If COMP_FILE is specified, BACKLASH is ignored.
1071-
Compensation file values are in machine units.
1072-
1073-
* 'COMP_FILE_TYPE = 0 or 1' -
1074-
** 'If 0:' The second and third values specify
1075-
the forward position (where the joint is while traveling forward) and
1076-
the reverse position (where the joint is while traveling reverse),
1077-
positions which correspond to the nominal position.'
1078-
** 'If 1:' The second and third values specify
1079-
the forward trim (how far from nominal while traveling forward) and
1080-
the reverse trim (how far from nominal while traveling in reverse),
1081-
positions which correspond to the nominal position.
1082-
1083-
Example triplet with COMP_FILE_TYPE = 0: 1.00 1.01 0.99 +
1084-
Example triplet with COMP_FILE_TYPE = 1: 1.00 0.01 -0.01
1065+
(((Compensation))) The compensation file consists of map of position
1066+
information for the joint. Compensation file values are in machine units.
1067+
Each set of values are are on one line separated by a space. The first value
1068+
is the nominal value (the commanded position). The second and third values
1069+
depend on the setting of COMP_FILE_TYPE. Points in between nominal values
1070+
are interpolated between the two nominals. Compensation files must start
1071+
with the smallest nominal and be in ascending order to the largest value of
1072+
nominals. File names are case sensitive and can contain letters and/or
1073+
numbers. Currently the limit inside LinuxCNC is for 256 triplets per axis.
1074+
+
1075+
+
1076+
If COMP_FILE is specified for an axis, BACKLASH is not used. A
1077+
'COMP_FILE_TYPE' must be specified for each 'COMP_FILE'.
1078+
1079+
* 'COMP_FILE_TYPE = 0 or 1' - Specifies the type of compensation file. The
1080+
first value is the nominal (commanded) position for both types.
1081+
1082+
** 'Type 0:' The second value specifies the actual position as the axis is moving
1083+
in the positive direction (increasing value) and the third value specifies
1084+
the actual position as the axis is moving in the negative direction
1085+
(decreasing value).
1086+
+
1087+
+
1088+
Type 0 Example
1089+
+
1090+
----
1091+
-1.000 -1.005 -0.995
1092+
0.000 0.002 -0.003
1093+
1.000 1.003 0.998
1094+
----
1095+
1096+
** 'Type 1:' The second value specifies positive offset from nominal while
1097+
traveling in the positive direction. The third value specifies the negitive
1098+
offset from nominal while traveling in a negitive direction.
1099+
+
1100+
+
1101+
Type 1 Example
1102+
+
1103+
----
1104+
-1.000 0.005 -0.005
1105+
0.000 0.002 -0.003
1106+
1.000 0.003 -0.004
1107+
----
10851108

10861109
* 'MIN_LIMIT = -1000' - (((MIN LIMIT))) The minimum limit for axis motion, in
10871110
machine units. When this limit is reached, the controller aborts axis

0 commit comments

Comments
 (0)