Skip to content

Commit 259a180

Browse files
authored
Merge pull request #2088 from smoe/docs_misc_12
docs: misc smallish changes (smoe:docs_misc_12)
2 parents f8363ac + 6ab55fe commit 259a180

11 files changed

Lines changed: 98 additions & 112 deletions

File tree

docs/src/gui/qtdragon.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ You can embed QtVCP Virtual Control Panels into the QtDragon or QtDragon_hd scre
169169
These panels can be either user built or builtin <<cha:qtvcp:panels,QtVCP Panels>>. +
170170
The `TAB_NAME` entry will used as the title for the new tab. +
171171
Tab `TAB_LOCATION` options include: `tabWidget_utilities` and `tabWidget_setup`.
172-
See qtvcp/VCP panels for other available builtin panels.
172+
See QtVCP/VCP panels for other available builtin panels.
173173

174174
This sample adds a builtin panel; a graphical animated machine using the vismach library.
175175

@@ -186,7 +186,7 @@ EMBED_TAB_LOCATION = tabWidget_utilities
186186
Magic comments can be used to control the G-code preview. +
187187
On very large programs the preview can take a long time to load. You can control
188188
what is shown and what is hidden the the graphics screen by adding the appropriate
189-
comments from this list into your gcode:
189+
comments from this list into your G-code:
190190

191191
----
192192
(PREVIEW,stop)
@@ -705,7 +705,7 @@ This is only available in the QtDragon_hd version.
705705
* This allows the user to automatically fill in the X, Y and Z parameters with the current position as displayed on the DROs.
706706

707707
.Autofill Workpiece Height on Main Screen
708-
* When checked, the calculated height is automatically transferred to the Workpice Height field in the main screen.
708+
* When checked, the calculated height is automatically transferred to the Workpiece Height field in the main screen.
709709
* Otherwise, the main screen is not affected.
710710

711711
.Workpiece Probe At

docs/src/gui/qtvcp-widgets.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -807,8 +807,7 @@ This can also display:
807807

808808
* *MDI history* when LinuxCNC is in `MDI` mode.
809809
* *Log entries* when LinuxCNC is in `MANUAL` mode.
810-
* *Preference file entries* if you enter `PREFERENCE` in capitals into
811-
the `MDILine` widget.
810+
* *Preference file entries* if you enter `PREFERENCE` in capitals into the `MDILine` widget.
812811

813812
It has a _signal_ *`percentDone(int)`* that can be connected to a slot
814813
(such as a `progressBar` to display percent run).

docs/src/hal/components.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@ link:../man/[directory listing].
101101
| link:../man/man1/vfs11_vfd.1.html[vfs11_vfd] |HAL userspace component for Toshiba-Schneider VF-S11 Variable Frequency Drives ||
102102
| link:../man/man1/wj200_vfd.1.html[wj200_vfd] |Hitachi wj200 modbus driver ||
103103
| link:../man/man1/xhc-hb04.1.html[xhc-hb04] |User-space HAL component for the xhc-hb04 pendant ||
104-
| link:../man/man1/xhc-hb04-accels.1.html[xhc-hb04-accels] |Obsolete script for jogging wheel||
105-
| link:../man/man1/xhc-whb04b-6.1.html[xhc-whb04b-6] |Userspace jog dial HAL component for the wireless XHC WHB04B-6 USB device||
104+
| link:../man/man1/xhc-hb04-accels.1.html[xhc-hb04-accels] |Obsolete script for jogging wheel ||
105+
| link:../man/man1/xhc-whb04b-6.1.html[xhc-whb04b-6] |Userspace jog dial HAL component for the wireless XHC WHB04B-6 USB device ||
106106
|===
107107

108108
=== Mesa and other I/O Cards (Realtime)
@@ -152,7 +152,7 @@ link:../man/[directory listing].
152152
| link:../man/man9/setsserial.9.html[setsserial] |Utility for setting Smart Serial NVRAM parameters.
153153
NOTE: This rather clunky utility is no longer needed except for flashing new smart-serial remote firmware.
154154
Smart-serial remote parameters can now be set in the HAL file in the normal way. ||
155-
| link:../man/man1/sim_pin.1.html[sim_pin] |GUI for displaying and setting one or more Hal inputs ||
155+
| link:../man/man1/sim_pin.1.html[sim_pin] |GUI for displaying and setting one or more HAL inputs ||
156156
| link:../man/man1/stepconf.1.html[stepconf] |Configuration wizard for parallel-port based machines ||
157157
|===
158158

@@ -182,7 +182,7 @@ Smart-serial remote parameters can now be set in the HAL file in the normal way.
182182
| link:../man/man9/toggle2nist.9.html[toggle2nist] |Toggle button to nist logic ||
183183
| link:../man/man9/ton.9.html[ton] |IEC TON timer - delay rising edge on a signal ||
184184
| link:../man/man9/timedelay.9.html[timedelay] |Equivalent of a time-delay relay. ||
185-
| link:../man/man9/tp.9.html[tp] |IEC TP timer - generate a high pulse of defined duration on rising edge||
185+
| link:../man/man9/tp.9.html[tp] |IEC TP timer - generate a high pulse of defined duration on rising edge ||
186186
| link:../man/man9/tristate_bit.9.html[tristate_bit] |Places signal on an I/O pin only when enabled, similar to a tristate buffer in electronics ||
187187
| link:../man/man9/tristate_float.9.html[tristate_float] |Places signal on an I/O pin only when enabled, similar to a tristatebuffer in electronics ||
188188
| link:../man/man9/xor2.9.html[xor2] |Two-input XOR (exclusive OR) gate ||
@@ -258,7 +258,7 @@ the input is a position, this means that the 'position', 'velocity', and 'accele
258258
|===
259259
| link:../man/man9/corexy_by_hal.9.html[corexy_by_hal] |CoreXY kinematics ||
260260
| link:../man/man9/differential.9.html[differential] |Kinematics for a differential transmission ||
261-
| link:../man/man9/gantry.9.html[gantry] |LinuxCNC HAL component for driving multiple joints from a single axis||
261+
| link:../man/man9/gantry.9.html[gantry] |LinuxCNC HAL component for driving multiple joints from a single axis ||
262262
| link:../man/man9/gantrykins.9.html[gantrykins] |Kinematics module that maps one axis to multiple joints. ||
263263
| link:../man/man9/genhexkins.9.html[genhexkins] |Gives six degrees of freedom in position and orientation (XYZABC). The location of the motors is defined at compile time. ||
264264
| link:../man/man9/genserkins.9.html[genserkins] |Kinematics that can model a general serial-link manipulator with up to 6 angular joints. ||
@@ -307,8 +307,8 @@ is 0.0001 seconds and the formula would be 1/(0.0001 x 2) = 5,000 Hz or 5 kHz. |
307307
| link:../man/man9/gearchange.9.html[gearchange] | Select from one of two speed ranges. ||
308308
| link:../man/man9/joyhandle.9.html[joyhandle] | Sets nonlinear joypad movements, deadbands and scales. ||
309309
| link:../man/man9/sampler.9.html[sampler] | Sample data from HAL in real time. ||
310-
| link:../man/man9/siggen.9.html[siggen] | Signal generator. <<sec:siggen,Description>>. ||
311-
| link:../man/man9/sim_encoder.9.html[sim_encoder] | Simulated quadrature encoder. <<sec:simulated-encoder,Description>>. ||
310+
| link:../man/man9/siggen.9.html[siggen] | Signal generator, see <<sec:siggen,Description>>. ||
311+
| link:../man/man9/sim_encoder.9.html[sim_encoder] | Simulated quadrature encoder, see <<sec:simulated-encoder,Description>>. ||
312312
| link:../man/man9/sphereprobe.9.html[sphereprobe] | Probe a pretend hemisphere. ||
313313
| link:../man/man9/steptest.9.html[steptest] | Used by Stepconf to allow testing of acceleration and velocity values for an axis. ||
314314
| link:../man/man9/streamer.9.html[streamer] | Stream file data into HAL in real time. ||

docs/src/hal/rtcomps.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ On the step type and control type selected.
6868
position units (position mode only).
6969
* '(float) stepgen._<chan>_.velocity-cmd' - Desired motor velocity, in
7070
position units per second (velocity mode only).
71-
* '(s32) stepgen._<chan>.counts' - Feedback position in counts,
71+
* '(s32) stepgen._<chan>_.counts' - Feedback position in counts,
7272
updated by 'capture_position()'.
7373
* '(float) stepgen._<chan>_.position-fb' - Feedback position in
7474
position units, updated by 'capture_position()'.

docs/src/hal/tools.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ or
252252

253253
.Notes:
254254
1. LinuxCNC (or another HAL application) must be running.
255-
2. If no pinname is specified, default is: motion-command-handler.time .
255+
2. If no pinname is specified, default is: `motion-command-handler.time`.
256256
3. This app may be opened for 5 pins.
257257
4. Pintypes float, s32, u32, bit are supported.
258258
5. The pin must be associated with a thread supporting floating point

docs/src/hal/tutorial.adoc

Lines changed: 25 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -122,12 +122,12 @@ halcmd: loadrt siggen
122122
Now that the module is loaded, it is time to introduce 'halcmd' , the
123123
command line tool used to configure the HAL. This tutorial will
124124
introduce some halcmd features, for a more complete description try
125-
'man halcmd', or see the reference in <<sec:hal-commands,Hal Commands>>
125+
'man halcmd', or see the reference in <<sec:hal-commands,HAL Commands>>
126126
section of this document. The first
127127
halcmd feature is the 'show' command. This command displays information
128128
about the current state of the HAL. To show all installed components:
129129

130-
.Show Components with `halrun`/`halcmd``
130+
.Show Components with `halrun`/`halcmd`
131131
----
132132
halcmd: show comp
133133
@@ -212,8 +212,8 @@ Owner CodeAddr Arg FP Users Name
212212

213213
The siggen component exported a single function. It requires floating
214214
point. It is not currently linked to any threads, so 'users' is
215-
zero. footnote:[CodeAddr and Arg fields were used during development and
216-
should probably disappear.]
215+
zero footnote:[CodeAddr and Arg fields were used during development and
216+
should probably disappear.].
217217

218218
=== Making realtime code run
219219

@@ -834,7 +834,7 @@ halcmd: setp stepgen.0.enable 1
834834
halcmd: setp stepgen.1.enable 1
835835
----
836836

837-
This velocity scaling means that when the pin 'stepgen.0.velocity-cmd'
837+
This velocity scaling means that when the pin `stepgen.0.velocity-cmd``
838838
is 1.0, the step generator will generate 10000 pulses per second
839839
(10 kHz). With the motor and leadscrew described above, that will result
840840
in the axis moving at exactly 1.0 inches per second. This illustrates
@@ -1031,40 +1031,35 @@ image::images/halscope-09.png["Waveforms with Triggering",align="center"]
10311031

10321032
To look closely at part of a waveform, you can use the zoom slider at
10331033
the top of the screen to expand the waveforms horizontally, and the
1034-
position slider to determine which part of the zoomed waveform is
1035-
visible. However, sometimes simply expanding the waveforms isn't enough
1036-
and you need to increase the sampling rate. For example, we would like
1037-
to look at the actual step pulses that are being generated in our
1038-
example. Since the step pulses may be only 50 µs long, sampling at 1 kHz
1039-
isn't fast enough. To change the sample rate, click on the button that
1040-
displays the number of samples and sample rate to bring up the 'Select
1041-
Sample Rate' dialog, figure . For this example, we will click on the
1042-
50 µs thread, 'fast', which gives us a sample rate of about 20 kHz. Now
1043-
instead of displaying about 4 seconds worth of data, one record is 4000
1044-
samples at 20 kHz, or about 0.20 seconds.
1034+
position slider to determine which part of the zoomed waveform is visible.
1035+
However, sometimes simply expanding the waveforms isn't enough and you need to increase the sampling rate.
1036+
For example, we would like to look at the actual step pulses that are being generated in our example.
1037+
Since the step pulses may be only 50&thinsp;µs long, sampling at 1&thinsp;kHz isn't fast enough.
1038+
To change the sample rate, click on the button that displays the number
1039+
of samples and sample rate to bring up the 'Select Sample Rate' dialog figure.
1040+
For this example, we will click on the 50&thinsp;µs thread, 'fast', which gives us a sample rate of about 20&thinsp;kHz.
1041+
Now instead of displaying about 4 seconds worth of data, one record is 4000 samples at 20&thinsp;kHz, or about 0.20&thinsp;seconds.
10451042

10461043
[[fig:halscope-sample-rate-choice]]
10471044
.Sample Rate Dialog
10481045
image::images/halscope-10.png["Sample Rate Dialog",align="center"]
10491046

10501047
=== More Channels
10511048

1052-
Now let's look at the step pulses. Halscope has 16 channels, but for
1053-
this example we are using only 4 at a time. Before we select any more
1054-
channels, we need to turn off a couple. Click on the channel 2 button,
1055-
then click the 'Chan Off' button at the bottom of the 'Vertical' box.
1049+
Now let's look at the step pulses.
1050+
Halscope has 16 channels, but for this example we are using only 4 at a time.
1051+
Before we select any more channels, we need to turn off a couple.
1052+
Click on the channel 2 button, then click the 'Chan Off' button at the bottom of the 'Vertical' box.
10561053
Then click on channel 3, turn if off, and do the same for channel 4.
10571054
Even though the channels are turned off, they still remember what they
1058-
are connected to, and in fact we will continue to use channel 3 as the
1059-
trigger source. To add new channels, select channel 5, and choose pin
1060-
'stepgen.0.dir', then channel 6, and select 'stepgen.0.step'. Then
1061-
click run mode 'Normal' to start the scope, and adjust the horizontal
1062-
zoom to 5 ms per division. You should see the step pulses slow down as
1063-
the velocity command (channel 1) approaches zero, then the direction
1064-
pin changes state and the step pulses speed up again. You might want to
1065-
increase the gain on channel 1 to about 20 milli per division to better see
1066-
the change in the velocity command. The result should look like the
1067-
following figure.
1055+
are connected to, and in fact we will continue to use channel 3 as the trigger source.
1056+
To add new channels, select channel 5, and choose pin `stepgen.0.dir`, then channel 6, and select `stepgen.0.step`.
1057+
Then click run mode 'Normal' to start the scope, and adjust the horizontal zoom to 5&thinsp;ms per division.
1058+
You should see the step pulses slow down as the velocity command (channel 1) approaches zero,
1059+
then the direction pin changes state and the step pulses speed up again.
1060+
You might want toincrease the gain on channel 1 to about 20 milli per division to better see
1061+
the change in the velocity command.
1062+
The result should look like the following figure.
10681063

10691064
[[fig:halscope-step-pulses]]
10701065
.Step Pulses

docs/src/integrator/steppers.adoc

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ the winding will lead to eventual overheating and failure of the motor.
5454

5555
In most stepper-based CNC systems the voltage of the supply feeding the stepper driver is several orders of
5656
magnitude greater than the voltage of the motor itself. A typical NEMA23 stepper motor may have a rating of only a
57-
handful of volts, yet the power supply and driver could be operating at 48VDC or more.
57+
handful of volts, yet the power supply and driver could be operating at 48&thinsp;VDC or more.
5858

5959
Nearly all modern stepper motor drivers on the market today are constant-current types. That is, the current being
6060
applied to each winding is fixed irrespective of how much voltage is being applied. Most drivers accomplish this
@@ -71,19 +71,19 @@ increasing supply voltage is no longer beneficial. The first limitation to the m
7171
likely to be what the stepper driver itself is capable of withstanding. This value should be provided in the
7272
datasheet for the stepper driver, and exceeding this voltage will result in the destruction of the driver. Ideally
7373
the power supply voltage should be chosen with a degree of headroom that falls under this maximum voltage limit of
74-
around 10%. If, for example a stepper driver has a Vmax rating of 80VDC, the maximum power supply voltage should
75-
be limited to 72VDC.
74+
around 10%. If, for example a stepper driver has a V~max~ rating of 80&thinsp;VDC, the maximum power supply voltage should
75+
be limited to 72&thinsp;VDC.
7676

7777
As mentioned above, excessive motor supply voltage also leads to excessive heat rise in the motor windings which
7878
can lead to eventual failure of the motor through overheating. A commonly used equation for providing a guideline
7979
in determining the maximum voltage to prevent excessive heat rise is to take the square-root of the winding
8080
inductance quoted in the motor datasheet (expressed in mill-Henries) and multiply by 32. For example, choosing a
81-
stepper with a coil inductance of 4mH will result in a maximum power supply voltage of 32 x SQRT (4) = 64VDC.
81+
stepper with a coil inductance of 4mH will result in a maximum power supply voltage of 32 x SQRT (4) = 64&thinsp;VDC.
8282

8383
Many stepper motor datasheets will also provide speed/torque curves, often plotted using different supply
8484
voltages. By studying the graphs it may be determined that increasing the supply voltage by a factor of two will
8585
not result in a corresponding improvement in speed/torque by the same degree. If there is little to be gained in
86-
running a stepper motor at 64VDC, this may help in narrowing down the proposed power supply to 32VDC which will
86+
running a stepper motor at 64&thinsp;VDC, this may help in narrowing down the proposed power supply to 32&thinsp;VDC which will
8787
also help minimise excessive heat rise in the motor windings.
8888

8989
The other factor to consider is the current rating of the power supply. This is based from the motor's winding
@@ -107,19 +107,15 @@ multiple new resonances introduced.
107107
Several methods exist to help control the effects of resonance, all with varying degrees of complexity,
108108
effectiveness and side effects:
109109

110-
* Microstepping can help reduce resonance by using smaller step changes in current between each step. These
111-
smaller step changes cause less ringing in the motor and windings and thus cause less excitation at the point of
112-
resonance.
113-
110+
* Microstepping can help reduce resonance by using smaller step changes in current between each step.
111+
These smaller step changes cause less ringing in the motor and windings and thus cause less excitation at the point of resonance.
114112
* Ensuring the motor is never operated at a particular frequency for a sustained period is a very basic method of
115113
reducing resonance, always accelerating or decelerating through the resonant peak.
116-
117-
* Increasing inertial load will damp unwanted resonances at the expense of some torque and potentially some
118-
accuracy. Elastomeric motor mounts, shaft couplings or bearing mounts can be employed.
119-
114+
* Increasing inertial load will damp unwanted resonances at the expense of some torque and potentially some accuracy.
115+
Elastomeric motor mounts, shaft couplings or bearing mounts can be employed.
120116
* More advanced stepper motor drives may have the ability to switch between stepping modes such that the resonant
121-
peak is managed at certain rates of operation. Other systems exist to place electrical load on the windings, which
122-
has a similar effect to mechanical damping, above.
117+
peak is managed at certain rates of operation.
118+
Other systems exist to place electrical load on the windings, which has a similar effect to mechanical damping, above.
123119

124120
== Microstepping
125121

@@ -153,7 +149,7 @@ will result in unacceptably slow RPM of the motor.
153149
Excessively-high rates of microstepping have no real benefit if the resultant accuracy is too small to be
154150
mechanically useful. A 1.8 degree per step motor running at 16x microstepping is theoretically capable of 0.1125
155151
degrees per step. Coupled with a 20TPI leadscrew this should result in a positional resolution of 0.000016” or
156-
0.0004mm. In reality it is incredibly difficult to achieve such fine degrees of control. All components in the CNC
152+
0.0004&thinsp;mm. In reality it is incredibly difficult to achieve such fine degrees of control. All components in the CNC
157153
system will contain tolerances and countering forces (backlash in leadscrews, flex in gantries, runout in the
158154
spindle and cutting tool, static friction in the stepper motor itself, stepper detent error etc) that will render
159155
such small amounts of resolution completely meaningless. In practice, microstepping at rates in excess of 4x or 8x

0 commit comments

Comments
 (0)