Merge pull request #1866 from smoe/docs_stupid_simple_stuff

Docs stupid simple stuff

Author: SebKuzminsky

docs/man/man3/hm2_bspi_setup_chan.3hm2

@@ -39,8 +39,8 @@ handling. (values 32 and below require no special handling)
 
 .IP mhz
 sets the chip communication rate. The maximum value for this is 
-half the FPGA base frequency, so for example with a 48MHz 5i23 the max SPI 
-frequency is 24Mhz. Values in excess of the max supported will be silently 
+half the FPGA base frequency, so for example with a 48 MHz 5i23 the max SPI 
+frequency is 24 MHz. Values in excess of the max supported will be silently 
 rounded down.
 
 .IP delay

docs/man/man3/hm2_uart_setup.3hm2

@@ -17,7 +17,7 @@ setup. The names of the available UARTs are printed to standard output during
 the driver loading process and take the form:
 hm2_<board name>.<board index>.uart.<index> For example hm2_5i23.0.uart.0
 The minimum bitrate is approximately 50bps, and the maximum around the FPGA 
-frequency, 48MHz for a 5i23. 
+frequency, 48 MHz for a 5i23. 
 The UART function allows different RX and TX bitrates, but that is not currently
 supported by this driver
 

docs/man/man9/encoder.9

@@ -9,7 +9,7 @@ encoder \- software counting of quadrature encoder signals
 \fBencoder\fR is used to measure position by counting the pulses
 generated by a quadrature encoder.  As a software-based implementation
 it is much less expensive than hardware, but has a limited maximum
-count rate.  The limit is in the range of 10KHz to 50KHz, depending
+count rate.  The limit is in the range of 10 kHz to 50 kHz, depending
 on the computer speed and other factors.  If better performance is
 needed, a hardware encoder counter is a better choice.  
 Some hardware-based systems can count at MHz rates.

docs/man/man9/hostmot2.9

@@ -276,7 +276,7 @@ maximum variation between read times.  \-100 will suffice for most systems, and
 
 For serial encoders, the value also needs to include the time it takes to
 transfer the absolute encoder position.  For instance, if 50 bits must be read
-at 500kHz then subtract an additional 50/500kHz = 100uS to get a starting value
+at 500 kHz then subtract an additional 50/500 kHz = 100 µs to get a starting value
 of \-200.
 
 The xy2mod uses 2 DPLL timers, one for read and one for write. The read timer value
@@ -780,7 +780,7 @@ It is not appropriate to use this parameter for index-homing of axis drives.
 This pin sets the excitation frequency for
 the resolver. This pin is module-level rather than instance-level as all
 resolvers share the same excitation frequency.
- Valid values are 10 (~10kHz), 5 (~5kHz) and 2.5 (~2.5kHz). The
+ Valid values are 10 (~10 kHz), 5 (~5 kHz) and 2.5 (~2.5 kHz). The
 actual frequency depends on the FPGA frequency, and they correspond to 
 CLOCK_LOW/5000, CLOCK_LOW/10000 and CLOCK_LOW/20000 respectively. 
 The parameter will be set to the closest available of the three frequencies.
@@ -882,7 +882,7 @@ to 50% results in a 1 MHz square wave, identical to a 1 MHz PWM signal
 with 50% duty cycle.  The effective range of this parameter is from
 about 1525 Hz up to just under 200 MHz.  Note that the max frequency
 is determined by the ClockHigh frequency of the Anything IO board; the
-5i25 and 7i92 both have a 100 MHz clock, resulting in a 100 Mhz max
+5i25 and 7i92 both have a 100 MHz clock, resulting in a 100 MHz max
 PDM frequency.  Other boards may have different clocks, resulting in
 different max PDM frequencies.  If the user attempts to set the frequency
 too high, it will be clipped to the max supported frequency of the board.
@@ -963,8 +963,8 @@ that affects all instances
 
 .TP
 (u32 rw) frequency
-Sets the master PWM frequency. Maximum is approx 48kHz, minimum
-is 1kHz. Defaults to 20kHz.
+Sets the master PWM frequency. Maximum is approx 48 kHz, minimum
+is 1 kHz. Defaults to 20 kHz.
 
 .SS rcpwmgen
 The rcpwmgen is a simple PWM generator optimized for use with standard RC servos
@@ -980,7 +980,7 @@ Pins:
 
 .TP
 (float rw) rate
-Sets the master  RC PWM frequency. Maximum is 1 KHz, minimum
+Sets the master  RC PWM frequency. Maximum is 1 kHz, minimum
 is .01 Hz. Defaults to 50 Hz.
 
 .TP
@@ -1195,7 +1195,7 @@ reduces following errors.
 .SS Smart Serial Interface
 
 The Smart Serial Interface allows up to 32 different devices such as the Mesa
-8i20 2.2kW 3-phase drive or 7i64 48-way IO cards to be connected to a single
+8i20 2.2 kW 3-phase drive or 7i64 48-way IO cards to be connected to a single
 FPGA card.
 The driver auto-detects the connected hardware port, channel and device type.
 Devices can be connected in any order to any active channel of an active port.
@@ -1374,20 +1374,20 @@ Parameters:
 
 .TP
 (u32 in) scan_rate
-This sets the input scan rate in Hz. Default scan rate is 20 KHz
-(50 uS scan period).
+This sets the input scan rate in Hz. Default scan rate is 20 kHz
+(50 µs scan period).
 
 .TP
 (u32 in) fast_scans
 This sets the fast time constant for all input pins. This is the time constant 
 used when the input-slow pin for the corresponding input is False. The range is 0 to 
-63 scan periods and the default value is 5 = 250 uS at the default 20 Khz scan_rate.
+63 scan periods and the default value is 5 = 250 µs at the default 20 kHz scan_rate.
 
 .TP
 (u32 in) slow_scans
 This sets the slow time constant for all input pins. This is the time constant 
 used when the input-slow pin for the corresponding input is True. The range is 0 to 1023
-scan periods and the default value is 500 = 25 mS at the default 20 Khz scan_rate.
+scan periods and the default value is 500 = 25 ms at the default 20 kHz scan_rate.
 
 .TP
 (bit in) enc0_4xmode, enc1_4xmode, enc2_4xmode, and enc3_4xmode

docs/man/man9/pwmgen.9

@@ -107,7 +107,7 @@ Modulation.
 \fBpwmgen.\fIN\fB.dither\-pwm\fR bit in/out
 Because software-generated PWM uses a fairly slow timebase (several to many
 microseconds), it has limited resolution.  For example, if \fBmake\-pulses\fR
-is called at a 20KHz rate, and \fBpwm\-freq\fR is 2KHz, there are only 10
+is called at a 20 kHz rate, and \fBpwm\-freq\fR is 2 kHz, there are only 10
 possible duty cycles.  If \fBdither\-pwm\fR is false, the commanded duty cycle
 will be rounded to the nearest of those values.  Assuming \fBvalue\fR remains
 constant, the same output will repeat every PWM cycle.  If \fBdither\-pwm\fR is

docs/man/man9/sserial.9

@@ -88,7 +88,7 @@ The following list of Smart Serial devices is by no means exhaustive.
 
 .TP
 .SH 8i20
-The 8i20 is a 2.2kW three-phase drive for brushless DC motors and AC servo
+The 8i20 is a 2.2 kW three-phase drive for brushless DC motors and AC servo
 motors.
 8i20 pins and parameters have names like
 "hm2_\fI<BoardType>\fR.\fI<BoardNum>\fR.8i20.\fI<PortNum>\fR.\fI<ChanNum>\fR.\fI<Pin>\fR", for example
@@ -480,7 +480,7 @@ Utilities exist to update and change this firmware.
 .SH 7i73
 The 7I73 is a remote real time pendant or control panel interface. 
 
-The 7I73 supports up to four 50KHz encoder inputs for MPGs, 8 digital inputs 
+The 7I73 supports up to four 50 kHz encoder inputs for MPGs, 8 digital inputs 
 and 6 digital outputs and up to a 64 Key keypad. If a smaller keypad is used, 
 more digital inputs and outputs become available. Up to eight 0.0V to 3.3V 
 analog inputs are also provided.

docs/man/man9/stepgen.9

@@ -8,7 +8,7 @@ stepgen \- software step pulse generation
 .SH DESCRIPTION
 \fBstepgen\fR is used to control stepper motors.  The maximum
 step rate depends on the CPU and other factors, and is usually in the range
-of 5KHz to 25KHz.  If higher rates are needed, a hardware step generator
+of 5 kHz to 25 kHz.  If higher rates are needed, a hardware step generator
 is a better choice.
 .P
 \fBstepgen\fR has two control modes, which can be selected on a channel

docs/src/config/ini-config.adoc

@@ -881,7 +881,7 @@ Basically, if a segment will complete in less time than 1 /
 ARC_BLEND_RAMP_FREQ, we don't bother with a trapezoidal velocity profile
 on that segment, and use constant acceleration. (Setting
 ARC_BLEND_RAMP_FREQ = 1000 is equivalent to always using trapezoidal
-acceleration, if the servo loop is 1kHz).
+acceleration, if the servo loop is 1 kHz).
 +
 You can characterize the worst-case loss of performance by comparing the
 velocity that a trapezoidal profile reaches vs. the ramp:
@@ -894,14 +894,14 @@ velocity that a trapezoidal profile reaches vs. the ramp:
 # f = cutoff frequency from INI
 ----
 +
-For the aforementioned machine, the ripple for a 20Hz cutoff frequency
+For the aforementioned machine, the ripple for a 20 Hz cutoff frequency
 is 100 / (4 * 20) = 1.25 IPS. This seems high, but keep in mind that it
 is only a worst-case estimate. In reality , the trapezoidal motion
 profile is limited by other factors, such as normal acceleration or
 requested velocity, and so the actual performance loss should be much
 smaller. Increasing the cutoff frequency can squeeze out more
 performance, but make the motion rougher due to acceleration
-discontinuities. A value in the range 20Hz to 200Hz should be reasonable
+discontinuities. A value in the range 20 Hz to 200 Hz should be reasonable
 to start.
 
 Finally, no amount of tweaking will speed up a toolpath with lots of

docs/src/config/pncconf.adoc

@@ -373,11 +373,11 @@ If using Mesa daughter boards the docs for the board should give recommendations
 It's important to follow these to avoid damage and get the best performance.
 
 ....
-The 7i33 requires PDM and a PDM base frequency of 6 mHz
-The 7i29 requires PWM and a PWM base frequency of 20 Khz
-The 7i30 requires PWM and a PWM base frequency of 20 Khz
-The 7i40 requires PWM and a PWM base frequency of 50 Khz
-The 7i48 requires UDM and a PWM base frequency of 24 Khz
+The 7i33 requires PDM and a PDM base frequency of 6 MHz
+The 7i29 requires PWM and a PWM base frequency of 20 kHz
+The 7i30 requires PWM and a PWM base frequency of 20 kHz
+The 7i40 requires PWM and a PWM base frequency of 50 kHz
+The 7i48 requires UDM and a PWM base frequency of 24 kHz
 ....
 
 Watchdog time out:: is used to set how long the MESA board will wait before

docs/src/config/python-interface.adoc

@@ -751,12 +751,12 @@ c.tool_offset(toolno, z_offset,  x_offset, diameter, frontangle, backangle, orie
 `spindle(direction: int, speed: float=0, spindle: int=0, wait_for_speed: int=0)`::
     - Direction: [SPINDLE_FORWARD, SPINDLE_REVERSE, SPINDLE_OFF, SPINDLE_INCREASE,
                 SPINDLE_DECREASE, or SPINDLE_CONSTANT]
-    - Speed: Speed in RPM, defaults to 0
-    - Spindle: Spindle number to command defaults to 0
+    - Speed: Speed in RPM, defaults to 0.
+    - Spindle: Spindle number to command defaults to 0.
     - Wait_for_speed: if 1 motion will wait for speed before continuing, defaults to not.
 
 [WARNING]
-MDI commands will ignore this. "S1000" after this will turn the spindle off
+MDI commands will ignore this. "S1000" after this will turn the spindle off.
 
 `text_msg(string)`::
   sends a operator text message to the screen. (max 254 characters)