Skip to content

Commit 0423e44

Browse files
committed
docs: More bits spotted while translating.
1 parent c09a70c commit 0423e44

7 files changed

Lines changed: 34 additions & 53 deletions

File tree

docs/src/config/core-components.adoc

Lines changed: 18 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,7 @@ unlock_joints_mask=0x38 selects joints 3,4,5
9595
[[sec:motion-pins]]
9696
=== Pins(((motion:HAL pins)))
9797

98-
These pins, parameters, and functions are created by the realtime 'motmod'
99-
module.
98+
These pins, parameters, and functions are created by the realtime 'motmod' module.
10099

101100
* 'motion.adaptive-feed' - (float, in) When adaptive feed is enabled with 'M52 P1' , the
102101
commanded velocity is multiplied by this value. This effect is
@@ -109,13 +108,10 @@ module.
109108
controlled by M67 or M68.
110109
* 'motion.coord-error' - (bit, out) TRUE when motion has encountered an error, such as
111110
exceeding a soft limit
112-
* 'motion.coord-mode' - (bit, out) TRUE when motion is in 'coordinated mode', as opposed to
113-
'teleop mode'
111+
* 'motion.coord-mode' - (bit, out) TRUE when motion is in 'coordinated mode', as opposed to 'teleop mode'
114112
* 'motion.current-vel' - (float, out) The current tool velocity in user units per second.
115-
* 'motion.digital-in-00' - (bit, in) These pins (00, 01, 02, 03 or more if configured) are
116-
controlled by M62-65.
117-
* 'motion.digital-out-00' - (bit, out) These pins (00, 01, 02, 03 or more if configured) are
118-
controlled by the 'M62-65'.
113+
* 'motion.digital-in-00' - (bit, in) These pins (00, 01, 02, 03 or more if configured) are controlled by M62-65.
114+
* 'motion.digital-out-00' - (bit, out) These pins (00, 01, 02, 03 or more if configured) are controlled by the 'M62-65'.
119115
* 'motion.distance-to-go' - (float,out) The distance remaining in the current move.
120116
* 'motion.enable' - (bit, in) If this bit is driven FALSE, motion stops, the machine is
121117
placed in the 'machine off' state, and a message is displayed for the
@@ -147,32 +143,18 @@ module.
147143
* 'motion.teleop-mode' - (bit, out) TRUE when motion is in 'teleop mode', as opposed to 'coordinated mode'
148144
* 'motion.tooloffset.x ... motion.tooloffset.w' - (float, out, one per axis) shows the tool offset in effect;
149145
it could come from the tool table ('G43' active), or it could come from the G-code ('G43.1' active)
150-
151-
* 'motion.on-soft-limit' -
152-
(bit, out) TRUE when the machine is on a soft limit.
153-
* 'motion.probe-input' -
154-
(bit, in) 'G38.n' uses the value on this pin to determine when the
155-
probe has made contact.
146+
* 'motion.on-soft-limit' - (bit, out) TRUE when the machine is on a soft limit.
147+
* 'motion.probe-input' - (bit, in) 'G38.n' uses the value on this pin to determine when the probe has made contact.
156148
TRUE for probe contact closed (touching),
157149
FALSE for probe contact open.
158-
* 'motion.program-line' -
159-
(s32, out) The current program line while executing. Zero if not
160-
running or between lines while single stepping.
161-
* 'motion.requested-vel' -
162-
(float, out) The current requested velocity in user units per
163-
second. This value is the F-word setting from the G-code file,
164-
possibly reduced to accommodate machine velocity and acceleration
165-
limits. The value on this pin does not reflect the feed override or
166-
any other adjustments.
167-
168-
* 'motion.teleop-mode' -
169-
(bit, out) TRUE when motion is in 'teleop mode', as opposed to
170-
'coordinated mode'
171-
172-
* 'motion.tooloffset.x ... motion.tooloffset.w' -
173-
(float, out, one per axis) shows the tool offset in effect;
174-
it could come from the tool table ('G43' active), or it could
175-
come from the G-code ('G43.1' active)
150+
* 'motion.program-line' - (s32, out) The current program line while executing.
151+
Zero if not running or between lines while single stepping.
152+
* 'motion.requested-vel' - (float, out) The current requested velocity in user units per second.
153+
This value is the F-word setting from the G-code file, possibly reduced to accommodate machine velocity and acceleration limits.
154+
The value on this pin does not reflect the feed override or any other adjustments.
155+
* 'motion.teleop-mode' - (bit, out) TRUE when motion is in 'teleop mode', as opposed to 'coordinated mode'
156+
* 'motion.tooloffset.x ... motion.tooloffset.w' - (float, out, one per axis) shows the tool offset in effect;
157+
it could come from the tool table ('G43' active), or it could come from the G-code ('G43.1' active)
176158

177159
=== Parameters
178160

@@ -191,10 +173,9 @@ change or removal at any time.
191173
* 'motion.debug-float-3' - (float, RO) This is used for debugging purposes.
192174
* 'motion.debug-s32-0' - (s32, RO) This is used for debugging purposes.
193175
* 'motion.debug-s32-1' - (s32, RO) This is used for debugging purposes.
194-
* 'motion.servo.last-period' - (u32, RO) The number of CPU cycles between invocations of the servo
195-
thread. Typically, this number divided by the CPU speed gives the time
196-
in seconds, and can be used to determine whether the realtime motion
197-
controller is meeting its timing constraints
176+
* 'motion.servo.last-period' - (u32, RO) The number of CPU cycles between invocations of the servo thread.
177+
Typically, this number divided by the CPU speed gives the time in seconds,
178+
and can be used to determine whether the realtime motion controller is meeting its timing constraints
198179
* 'motion.servo.last-period-ns' - (float, RO)
199180

200181
=== Functions
@@ -316,7 +297,7 @@ See the motion man page 'motion(9)' for details on the pins and parameters.
316297

317298
== iocontrol
318299

319-
iocontrol - accepts non-realtime I/O commands via NML, interacts with HAL .
300+
iocontrol - accepts non-realtime I/O commands via NML, interacts with HAL.
320301

321302
iocontrol's HAL pins are turned on and off in non-realtime context. If you have strict timing requirements or simply need more I/O, consider using the realtime synchronized I/O provided by <<sec:motion,motion>> instead.
322303

docs/src/man/man1/halreport.1.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ halreport - creates a report on the status of the HAL
1212

1313
*halreport*
1414

15-
. Supports components made by halcompile and numerous legacy components
15+
. Supports components made by halcompile and numerous legacy components.
1616
. Known unhandled components:
1717
at_pid:: naming conflicts with pid, seldom used
1818
boss_plc:: no manpage or docs (any users?)

docs/src/man/man1/halrmt.1.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ halrmt - remote-control interface for LinuxCNC
1212

1313
--port _port_:: Waits for socket connections (telnet) on specified
1414
socket, without port specification it uses default port 5006.
15-
(note: linuxcncrsh uses 5007 as default)
15+
(Note: linuxcncrsh uses 5007 as default.)
1616
--name _server_name_:: Sets the server name to specified name for Hello.
1717
--connectpw _password_:: Sets the connection password to 'password'. Default: EMC.
1818
--enablepw _password_:: Sets the enable password to _password_. Default EMCTOO.

docs/src/man/man1/sim_pin.1.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ supported.
2121
If the named input is a numerical type, the GUI displays:
2222

2323
*Entry* Entry widget for value or a valid Tcl expression. +
24-
*Set* Pushbutton to set new value from Entry (or use <RETURN>) +
24+
*Set* Pushbutton to set new value from Entry (or use <RETURN>). +
2525
*Reset* Pushbutton to reset to the value present on initiation If the
2626
input is a *bit* type, the GUI shows a single pushbutton that is
2727
controlled by radio-button selectors:
2828

29-
mode=**pulse** Pulse input to 1 for each pushbutton press +
30-
mode=**toggle** Toggle input for each pushbutton press +
31-
mode=**hold** Set input to 1 while pushbutton pressed
29+
mode=**pulse** Pulse input to 1 for each pushbutton press. +
30+
mode=**toggle** Toggle input for each pushbutton press. +
31+
mode=**hold** Set input to 1 while pushbutton pressed.
3232

3333
If the bit item mode begins with an uppercase letter, the radio buttons
3434
for selecting other modes are not shown

docs/src/man/man9/sserial.9.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ and the 7I70 during real time process data exchanges. For high speed
311311
applications, choosing the correct mode can reduced the data transfer
312312
sizes, resulting in higher maximum update rates.
313313

314-
MODE 0:: Input mode (48 bits input data only
314+
MODE 0:: Input mode (48 bits input data only)
315315
MODE 1:: Input plus analog mode (48 bits input data plus 6 channels of analog data)
316316
MODE 2:: Input plus field voltage
317317

docs/src/motion/switchkins.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -311,15 +311,15 @@ requirements.
311311

312312
=== External offset considerations
313313

314-
External offsets (set to an axis (_L_) via axis.L.eoffset-request) are preserved during
315-
kinematics switches. When an offset is active on an axis before the switch
316-
(visible in axis.L.eoffset), the trajectory planner maintains that same
317-
offset after the switch, similar to how it maintains the commanded
318-
position from a G-code. This ensures consistent machine behavior regardless
319-
of the active kinematics.
314+
External offsets (set to an axis (_L_) via axis._L_.eoffset-request)
315+
are preserved during kinematics switches. When an offset is active on
316+
an axis before the switch (visible in axis._L_.eoffset), the trajectory
317+
planner maintains that same offset after the switch, similar to how it
318+
maintains the commanded position from a G-code. This ensures consistent
319+
machine behavior regardless of the active kinematics.
320320

321321
If maintaining the offset will be an issue due to axis limit changes or other concerns,
322-
be sure to clear and possibly disable the eoffset before making a kinematics switch
322+
be sure to clear and possibly disable the eoffset before making a kinematics switch.
323323

324324
== Simulation configs
325325

docs/src/plasma/qtplasmac.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4109,8 +4109,8 @@ Therefore, the length of the wiggle and the feed rate need to be considered in c
41094109

41104110
For example:
41114111

4112-
* A feed rate of 1080 mm/min (18 mm/s)
4113-
* A wiggle movement of 4 mm for 3 oscillations
4112+
* A feed rate of 1080 mm/min (18 mm/s).
4113+
* A wiggle movement of 4 mm for 3 oscillations.
41144114

41154115
This means that the length of the wiggle is 4 x 3 = 12 mm. At the 18 mm/s feed rate, the pierce delay needs to be approx 0.7 seconds to support the wiggle distance at pierce height.
41164116

0 commit comments

Comments
 (0)