Merge pull request #2470 from smoe/docs29_mac_100

More documentation changes (with an increased level of tolerance) (smoe: Docs29 mac 100)

Author: hansu

docs/src/config/stepper.adoc

@@ -12,55 +12,40 @@
 
 == Introduction
 
-The preferred way to set up a standard stepper machine is with the
-Step Configuration Wizard. See the
-<<cha:stepconf-wizard,Stepper Configuration Wizard>> Chapter.
+The preferred way to set up a standard stepper machine is with the Step Configuration Wizard.
+See the <<cha:stepconf-wizard,Stepper Configuration Wizard>> Chapter.
 
-This chapter describes some of the more common settings for manually
-setting up a stepper based system. These systems are using stepper motors
-with drives that accept step & direction signals.
+This chapter describes some of the more common settings for manually setting up a stepper based system.
+These systems are using stepper motors with drives that accept step & direction signals.
 
-It is one of the simpler setups, because the motors run open-loop (no
-feedback comes back from the motors), yet the system needs to be
-configured properly so the motors don't stall or lose steps.
+It is one of the simpler setups, because the motors run open-loop (no feedback comes back from the motors),
+yet the system needs to be configured properly so the motors don't stall or lose steps.
 
-Most of this chapter is based on a sample config released along with
-LinuxCNC. The config is called stepper_inch, and can be found by running the
-<<cha:running-emc,Configuration Picker>>.
+Most of this chapter is based on a sample config released along with LinuxCNC.
+The config is called stepper_inch, and can be found by running the <<cha:running-emc,Configuration Picker>>.
 
 == Maximum step rate
 
-With software step generation, the maximum step rate is one step per
-two BASE_PERIODs for step-and-direction output. The maximum requested
-step rate is the product of an axis' MAX_VELOCITY and its INPUT_SCALE.
-If the requested step rate is not attainable, following errors will
-occur, particularly during fast jogs and G0 moves.
+With software step generation, the maximum step rate is one step per two BASE_PERIODs for step-and-direction output.
+The maximum requested step rate is the product of an axis' MAX_VELOCITY and its INPUT_SCALE.
+If the requested step rate is not attainable, following errors will occur, particularly during fast jogs and G0 moves.
 
 If your stepper driver can accept quadrature input, use this mode.
-With a quadrature signal, one step is possible for each BASE_PERIOD,
-doubling the maximum step rate.
+With a quadrature signal, one step is possible for each BASE_PERIOD, doubling the maximum step rate.
 
-The other remedies are to decrease one or more of: the BASE_PERIOD
-(setting this too low will cause the machine to become unresponsive or
-even lock up), the INPUT_SCALE (if you can select different step sizes
-on your stepper driver, change pulley ratios, or leadscrew pitch), or
-the MAX_VELOCITY and STEPGEN_MAXVEL.
+The other remedies are to decrease one or more of: the BASE_PERIOD (setting this too low will cause the machine to become unresponsive or even lock up),
+the INPUT_SCALE (if you can select different step sizes on your stepper driver, change pulley ratios, or leadscrew pitch), or the MAX_VELOCITY and STEPGEN_MAXVEL.
 
-If no valid combination of BASE_PERIOD, INPUT_SCALE, and MAX_VELOCITY
-is acceptable, then consider using hardware step generation (such as
-with the LinuxCNC-supported Universal Stepper Controller, Mesa cards, and
-others).
+If no valid combination of BASE_PERIOD, INPUT_SCALE, and MAX_VELOCITY is acceptable,
+then consider using hardware step generation (such as with the LinuxCNC-supported Universal Stepper Controller, Mesa cards, and others).
 
 == Pinout
 
-One of the major flaws in LinuxCNC was that you couldn't specify the pinout
-without recompiling the source code. LinuxCNC is far more flexible, and now
-(thanks to the Hardware Abstraction Layer) you can easily specify which
-signal goes where. See the <<cha:basic-hal-reference,HAL Basics>>
-for more information on HAL.
+One of the major flaws in LinuxCNC was that you couldn't specify the pinout without recompiling the source code.
+LinuxCNC is far more flexible, and now (thanks to the Hardware Abstraction Layer) you can easily specify which signal goes where.
+See the <<cha:basic-hal-reference,HAL Basics>> for more information on HAL.
 
-As it is described in the HAL Introduction and tutorial, we have
-signals, pins and parameters inside the HAL.
+As it is described in the HAL Introduction and tutorial, we have signals, pins and parameters inside the HAL.
 
 [NOTE]
 We are presenting one axis to keep it short, all others are similar.
@@ -72,10 +57,9 @@ signals: Xstep, Xdir & Xen
 pins: parport.0.pin-XX-out & parport.0.pin-XX-in
 ----
 
-Depending on what you have chosen in your INI file you are using
-either standard_pinout.hal or xylotex_pinout.hal. These are two files
-that instruct the HAL how to link the various signals & pins. Further
-on we'll investigate the standard_pinout.hal.
+Depending on what you have chosen in your INI file you are using either standard_pinout.hal or xylotex_pinout.hal.
+These are two files that instruct the HAL how to link the various signals & pins.
+Further on we'll investigate the standard_pinout.hal.
 
 === Standard Pinout HAL
 
@@ -163,31 +147,25 @@ net spindle-on spindle.0.on => parport.0.pin-09-out
 
 ----
 
-The lines starting with '#' are comments, and their only purpose is to
-guide the reader through the file.
+The lines starting with '#' are comments, and their only purpose is to guide the reader through the file.
 
 === Overview
 
-There are a couple of operations that get executed when the
-standard_pinout.hal gets executed/interpreted:
+There are a couple of operations that get executed when the standard_pinout.hal gets executed/interpreted:
 
 * The Parport driver gets loaded (see the <<cha:parport,Parport Chapter>> for details).
 * The read & write functions of the parport driver get assigned to the
-  base thread footnote:[the fastest thread in the LinuxCNC setup, usually ther
-  code gets executed every few tens of microseconds.].
-* The step & direction signals for axes X, Y, Z get linked to pins on the
-  parport.
+  base thread footnote:[The fastest thread in the LinuxCNC setup, usually the code gets executed every few tens of microseconds.].
+* The step & direction signals for axes X, Y, Z get linked to pins on the parport.
 * Further I/O signals get connected (estop loopback, toolchanger loopback).
 * A spindle-on signal gets defined and linked to a parport pin.
 
 === Changing the standard_pinout.hal
 
-If you want to change the standard_pinout.hal file, all you need is a
-text editor. Open the file and locate the parts you want to change.
+If you want to change the standard_pinout.hal file, all you need is a text editor.
+Open the file and locate the parts you want to change.
 
-If you want for example to change the pin for the X-axis Step &
-Directions signals, all you need to do is to change the number in the
-'parport.0.pin-XX-out' name:
+If you want for example to change the pin for the X-axis Step & Directions signals, all you need to do is to change the number in the 'parport.0.pin-XX-out' name:
 
 [source,{hal}]
 ----
@@ -205,14 +183,12 @@ net Xdir  parport.0.pin-03-out
 
 or basically any other 'out' pin you like.
 
-Hint: make sure you don't have more than one signal connected to the
-same pin.
+Hint: make sure you don't have more than one signal connected to the same pin.
 
 === Changing polarity of a signal
 
-If external hardware expects an "active low" signal, set the
-corresponding '-invert' parameter. For instance, to invert the spindle
-control signal:
+If external hardware expects an "active low" signal, set the corresponding '-invert' parameter.
+For instance, to invert the spindle control signal:
 
 [source,{hal}]
 ----
@@ -221,8 +197,7 @@ setp parport.0.pin-09-invert TRUE
 
 === Adding PWM Spindle Speed Control
 
-If your spindle can be controlled by a PWM signal, use the 'pwmgen'
-component to create the signal:
+If your spindle can be controlled by a PWM signal, use the 'pwmgen' component to create the signal:
 
 [source,{hal}]
 ----
@@ -236,15 +211,13 @@ setp pwmgen.0.scale 1800 # Change to your spindle's top speed in RPM
 ----
 
 This assumes that the spindle controller's response to PWM is simple:
-0% PWM gives 0 RPM, 10% PWM gives 180 RPM, etc. If there is a minimum
-PWM required to get the spindle to turn, follow the example in the
-'nist-lathe' sample configuration to use a 'scale' component.
+0% PWM gives 0 RPM, 10% PWM gives 180 RPM, etc.
+If there is a minimum PWM required to get the spindle to turn, follow the example in the 'nist-lathe' sample configuration to use a 'scale' component.
 
 === Adding an enable signal
 
-Some amplifiers (drives) require an enable signal before they accept
-and command movement of the motors. For this reason there are already
-defined signals called 'Xen', 'Yen', 'Zen'.
+Some amplifiers (drives) require an enable signal before they accept and command movement of the motors.
+For this reason there are already defined signals called 'Xen', 'Yen', 'Zen'.
 
 To connect them use the following example:
 
@@ -253,15 +226,12 @@ To connect them use the following example:
 net Xen parport.0.pin-08-out
 ----
 
-You can either have one single pin that enables all drives; or
-several, depending on the setup you have. Note, however, that usually
-when one axis faults, all the other drives will be disabled as well, so
-having only one enable signal / pin for all drives is a common
-practice.
+You can either have one single pin that enables all drives; or several, depending on the setup you have.
+Note, however, that usually when one axis faults, all the other drives will be disabled as well, so having only one enable signal / pin for all drives is a common practice.
 
 === External ESTOP button
 
-The standard_pinout.hal file assumes no external ESTOP button. For more
-information on an external E-Stop see the estop_latch man page.
+The standard_pinout.hal file assumes no external ESTOP button.
+For more information on an external E-Stop see the estop_latch man page.
 
 // vim: set syntax=asciidoc: