Merge pull request #2555 from smoe/docs29_mac_101

Whatever I found while reviewing translations (smoe:Docs29 mac 101)

Author: hansu

docs/src/drivers/gm.adoc

@@ -406,7 +406,7 @@ Currently GM produced power amplifiers has upper level driver which export pins
 They receive position reference and provide encoder feedback via CAN bus.
 
 The frames are standard (11 bit) ID frames, with 4 byte data length.
-The BAUD rate is 1 Mbit/s.
+The baud rate is 1 Mbit/s.
 The position command IDs for axis 0..5 are 0x10..0x15.
 The position feedback IDs for axis 0..5 are 0x20..0x25.
 

docs/src/gui/gladevcp.adoc

@@ -198,7 +198,7 @@ so if you like to 'get under the hood' and re-arrange things, be sure to check t
 * `parport.<p>.pin-`__<n>__`-in` (bit) Tracks a physical input pin.
 * `parport.<p>.pin-`__<n>__`-in-not` (bit) Tracks a physical input pin, but inverted.
 
-For each pin, _<p>_ is the port number, and '<n>' is the physical pin number in the 25 pin D-shell connector.
+For each pin, _<p>_ is the port number, and _<n>_ is the physical pin number in the 25 pin D-shell connector.
 
 For each physical output pin, the driver creates a single HAL pin, for example: `parport.0.pin-14-out`.
 
@@ -220,7 +220,7 @@ If `-invert` is TRUE, then setting the HAL `-out` pin TRUE will drive the physic
 [[sub:parport-functions]]
 == Functions
 
-* `parport.`__<p>__`.read' (funct) Reads physical input pins of port number _<p>_ and updates HAL `-in` and `-in-not` pins.
+* `parport.`__<p>__`.read` (funct) Reads physical input pins of port number _<p>_ and updates HAL `-in` and `-in-not` pins.
 * `parport.read-all` (funct) Reads physical input pins of all ports and updates HAL `-in` and `-in-not` pins.
 * `parport.`__<p>__`.write` (funct) Reads HAL `-out` pins of port number _<p>_ and updates that port's physical output pins.
 * `parport.write-all` (funct) Reads HAL `-out` pins of all ports and updates all physical output pins.

docs/src/hal/parallel-port.adoc

@@ -262,7 +262,7 @@ The component exports two functions. Each function acts on all of the PWM genera
   The high speed function `pwmgen.make-pulses` should be run in the base (fastest) thread, from 10 to 50 µs depending on the capabilities of the computer.
   That thread's period determines the maximum PWM carrier frequency, as well as the resolution of the PWM or PDM signals.
   If the base thread is 50,000 ns then every 50 µs the module decides if it is time to change the state of the output.
-  At 50% duty cycle and 25␗Hz PWM frequency this means that the output changes state every (1/25) s / 50 µs * 50% = 400 iterations.
+  At 50% duty cycle and 25 Hz PWM frequency this means that the output changes state every (1/25) s / 50 µs * 50% = 400 iterations.
   This also means that you have a 800 possible duty cycle values (without dithering).
 * (funct) `pwmgen.update` - Low speed function to scale and limit value and handle other parameters.
   This is the function of the module that does the more complicated mathematics to work out how many base-periods the output should be high for, and how many it should be low for.
@@ -346,7 +346,7 @@ halcmd: unloadrt encoder
   It is also unaffected by reset or the index pulse.
 * `encoder._<chan>_.reset` (bit, In) - When True, force 'counts' and 'position' to zero immediately.
 * `encoder._<chan>_.velocity` (float, Out) - Velocity in scaled units per second.
-  `encoder' uses an algorithm that greatly reduces quantization noise as compared to simply differentiating the 'position' output.
+  `encoder` uses an algorithm that greatly reduces quantization noise as compared to simply differentiating the 'position' output.
   When the magnitude of the true velocity is below min-speed-estimate, the velocity output is 0.
 * `encoder._<chan>_.x4-mode` (bit, I/O) (default: TRUE) - Enables times-4 mode.
   When true, the counter counts each edge of the quadrature waveform (four counts per full cycle).

docs/src/hal/rtcomps.adoc

@@ -13,50 +13,42 @@ hy_gt_vfd - HAL non-realtime component for Huanyang GT-series VFDs
 
 == DESCRIPTION
 
-The hy_gt_vfd component interfaces a Huanyang GT-series VFD to the
-LinuxCNC HAL.  The VFD is connected via RS-485 serial to the LinuxCNC
-computer.
+The hy_gt_vfd component interfaces a Huanyang GT-series VFD to the LinuxCNC HAL.
+The VFD is connected via RS-485 serial to the LinuxCNC computer.
 
 
 == Hardware setup
 
-At least some Huanyang GT VFDs must be physically modified to enable
-Modbus communication.
+At least some Huanyang GT VFDs must be physically modified to enable Modbus communication.
 
-The circuit board location marked "SW1" is identified in the manual as
-"Switch of terminal resistor for RS485 communication".  On the only
-VFD I have experience with, the circuit board contained no switch at
-that location, instead holding a pair of crossed jumper wires (top-left
-pad connected to bottom-right pad, top-right to bottom-left).  In this
-configuration, no Modbus communication is possible.  We had to desolder
-the two crossed jumper wires and re-solder them parallel to each other
-(top-left to bottom-left, top-right to bottom-right).
+The circuit board location marked "SW1" is identified in the manual as "Switch of terminal resistor for RS485 communication".
+On the only VFD I have experience with, the circuit board contained no switch at that location, instead holding a pair of crossed jumper wires (top-left pad connected to bottom-right pad, top-right to bottom-left).
+In this configuration, no Modbus communication is possible.
+We had to desolder the two crossed jumper wires and re-solder them parallel to each other (top-left to bottom-left, top-right to bottom-right).
 
 
 == Firmware setup
 
-The Huanyang GT VFD must be configure via the faceplate to talk Modbus
-with LinuxCNC.  Consult the Operation section of the Huanyang GT-series
-Inverter Manual for details.  Set the following parameters:
+The Huanyang GT VFD must be configure via the faceplate to talk Modbus with LinuxCNC.
+Consult the Operation section of the Huanyang GT-series Inverter Manual for details.
+Set the following parameters:
 
 P0.01 = 2::
 
     Set Run Command Source to Modbus serial port.
 
 P0.03::
 
-    Set Maximum Frequency to the maximum frequency you want the VFD to
-    output, in Hz.
+    Set Maximum Frequency to the maximum frequency you want the VFD to output, in Hz.
 
 P0.04::
 
-    Set Upper Frequency Limit to the maximum frequency you want the VFD
-    to output, in Hz.  This should be the same as the value in P0.03.
+    Set Upper Frequency Limit to the maximum frequency you want the VFD to output, in Hz.
+    This should be the same as the value in P0.03.
 
 P0.05::
 
-    Set Lower Frequency Limit to the minimum frequency you want the VFD
-    to output, in Hz.
+    Set Lower Frequency Limit to the minimum frequency you want the VFD to output, in Hz.
 
 P0.07 = 7::
 
@@ -72,8 +64,7 @@ P2.02 = ???::
 
 P2.03 = ???::
 
-    Set Motor Rated Speed to the motor's speed in RPM at its rated
-    maximum frequency.
+    Set Motor Rated Speed to the motor's speed in RPM at its rated maximum frequency.
 
 P2.04 = ???::
 
@@ -85,13 +76,13 @@ P2.05 = ???::
 
 PC.00 = 1::
 
-    Set Local Address to 1.  This matches the default in the hy_gt_vfd
-    driver, change this if your setup has special needs.
+    Set Local Address to 1.
+    This matches the default in the hy_gt_vfd driver, change this if your setup has special needs.
 
 PC.01 = 5::
 
-    Set Baud Rate Selection to 5 (38400 bps).  This matches the default
-    in the hy_gt_vfd driver, change this if your setup has special needs.
+    Set baud rate selection to 5 (38400 bps).
+    This matches the default in the hy_gt_vfd driver, change this if your setup has special needs.
 
         0 = 1200
         1 = 2400
@@ -102,181 +93,167 @@ PC.01 = 5::
 
 PC.02 = 0::
 
-    Set Data Format (8n1 RTU).  This matches the default in the hy_gt_vfd
-    driver, change this if your setup has special needs.
+    Set Data Format (8n1 RTU).
+    This matches the default in the hy_gt_vfd driver, change this if your setup has special needs.
 
 PC.03 = 1::
 
-    Set Communication Delay Time to 1 ms.  This is expected by the
-    hy_gt_vfd driver.
+    Set Communication Delay Time to 1 ms.
+    This is expected by the hy_gt_vfd driver.
 
 
 == OPTIONS
 
 *-b*, *--bits* _N_::
 
-      (default 8) For Modbus communication.  Set number of data bits
-      to _N_.  _N_ must be between 5 and 8 inclusive.
+    (default 8) For Modbus communication.
+    Set number of data bits to _N_.
+    _N_ must be between 5 and 8 inclusive.
 
 *-p*, *--parity* [Even,Odd,None]
 
-      (default None) For Modbus communication.  Set serial parity to Even,
-      Odd, or None.
+    (default None) For Modbus communication.
+    Set serial parity to Even, Odd, or None.
 
 *-r*, *--rate* _N_::
 
-      (default 38400) For Modbus communication.  Set baud rate to _N_.
-      It is an error if the rate is not one of the following: 1200,
-      2400, 4800, 9600, 19200, 38400
+    (default 38400) For Modbus communication.
+    Set baud rate to _N_.
+    It is an error if the rate is not one of the following: 1200, 2400, 4800, 9600, 19200, 38400
 
 *-s*, *--stopbits* [1,2]::
 
-      (default 1) For Modbus communication.  Set serial stop bits to 1
-      or 2.
+    (default 1) For Modbus communication.
+    Set serial stop bits to 1 or 2.
 
 *-t*, *--target* _N_::
 
-      (default 1) For Modbus communication.  Set Modbus target (slave)
-      number.  This must match the device number you set on the Huanyang
-      GT VFD.
+    (default 1) For Modbus communication.
+    Set Modbus target (slave) number.
+    This must match the device number you set on the Huanyang GT VFD.
 
 *-d*, *--device* _PATH_::
 
-      (default /dev/ttyS0) For Modbus communication.  Set the name of
-      the serial device node to use.
+    (default /dev/ttyS0) For Modbus communication.
+    Set the name of the serial device node to use.
 
 *-v*, *--verbose*::
 
-      Turn on verbose mode.
+    Turn on verbose mode.
 
 *-S*, *--motor-max-speed* _RPM_::
 
-    The motor's max speed in RPM.  This must match the motor speed value
-    configured in VFD register P2.03.
+    The motor's max speed in RPM.
+    This must match the motor speed value configured in VFD register P2.03.
 
 *-F*, *--max-frequency* _HZ_::
 
-    This is the maximum output frequency of the VFD in Hz.  It should
-    correspond to the motor's rated max frequency, and to the maximum
-    and upper limit output frequency configured in VFD register P0.03
-    and P0.04.
+    This is the maximum output frequency of the VFD in Hz.
+    It should correspond to the motor's rated max frequency, and to the maximum and upper limit output frequency configured in VFD register P0.03 and P0.04.
 
 *-f*, *--min-frequency* _HZ_::
 
-    This is the minimum output frequency of the VFD in Hz.  It should
-    correspond to the minimum output frequency configured in VFD
-    register P0.05.
+    This is the minimum output frequency of the VFD in Hz.
+    It should correspond to the minimum output frequency configured in VFD register P0.05.
 
 
 == PINS
 
 
 *hy_gt_vfd.period* (float, in)::
 
-      The period for the driver's update cycle, in seconds. This is
-      how frequently the driver will wake up, check its HAL pins, and
-      communicate with the VFD.  Must be between 0.001 and 2.000 seconds.
-      Default: 0.1 seconds.
+    The period for the driver's update cycle, in seconds. This is
+    how frequently the driver will wake up, check its HAL pins, and
+    communicate with the VFD.  Must be between 0.001 and 2.000 seconds.
+    Default: 0.1 seconds.
 
 *hy_gt_vfd.speed-cmd* (float, in)::
 
-      The requested motor speed, in RPM.
+    The requested motor speed, in RPM.
 
 *hy_gt_vfd.speed-fb* (float, out)::
 
-      The motor's current speed, in RPM, reported by the VFD.
+    The motor's current speed, in RPM, reported by the VFD.
 
 *hy_gt_vfd.at-speed* (bit, out)::
 
-      True when the drive is on and at the commanded speed (within 2%),
-      False otherwise.
+    True when the drive is on and at the commanded speed (within 2%),
+    False otherwise.
 
 *hy_gt_vfd.freq-cmd* (float, out)::
 
-      The requested output frequency, in Hz.  This is set from the
-      .speed-cmd value, and is just shown for debugging purposes.
+    The requested output frequency, in Hz.
+    This is set from the .speed-cmd value, and is just shown for debugging purposes.
 
 *hy_gt_vfd.freq-fb* (float, out)::
 
-      The current output frequency of the VFD, in Hz.  This is reported
-      from the VFD to the driver.
+    The current output frequency of the VFD, in Hz.
+    This is reported from the VFD to the driver.
 
 *hy_gt_vfd.spindle-on* (bit, in)::
 
-      Set this pin True to command the spindle on, at the speed requested
-      on the .speed-cmd pin.  Set this pin False to command the spindle
-      off.
+    Set this pin True to command the spindle on, at the speed requested on the .speed-cmd pin.
+    Set this pin False to command the spindle off.
 
 *hy_gt_vfd.output-voltage* (float, out)::
 
-      The voltage that the VFD is current providing to the motor,
-      in Volts.
+    The voltage that the VFD is current providing to the motor, in Volts.
 
 *hy_gt_vfd.output-current* (float, out)::
 
-      The current that the motor is currently drawing from the VFD,
-      in Amperes.
+    The current that the motor is currently drawing from the VFD, in Ampères.
 
 *hy_gt_vfd.output-power* (float, out)::
 
-      The power that the motor is currently drawing from the VFD,
-      in Watts.
+    The power that the motor is currently drawing from the VFD, in Watts.
 
 *hy_gt_vfd.dc-bus-volts* (float, out)::
 
-      The current voltage of the VFD's internal DC power supply, in Volts.
+    The current voltage of the VFD's internal DC power supply, in Volts.
 
 *hy_gt_vfd.modbus-errors* (u32, out)::
 
-      A count of the number of modbus communication errors between the
-      driver and the VFD.  The driver is resilient against communication
-      errors, but a large or growing number here indicates a problem
-      that should be investigated.
+    A count of the number of modbus communication errors between the driver and the VFD.
+    The driver is resilient against communication errors, but a large or growing number here indicates a problem that should be investigated.
 
 *hy_gt_vfd.input-terminal* (float, out)::
 
-        The VFD's input terminal register.
+    The VFD's input terminal register.
 
 *hy_gt_vfd.output-terminal* (float, out)::
 
-        The VFD's output terminal register.
+    The VFD's output terminal register.
 
 *hy_gt_vfd.AI1* (float, out)::
 
-        The VFD's AI1 register.
+    The VFD's AI1 register.
 
 *hy_gt_vfd.AI2* (float, out)::
 
-        The VFD's AI2 register.
+    The VFD's AI2 register.
 
 *hy_gt_vfd.HDI-frequency* (float, out)::
 
-        The VFD's HDI-frequency register.
+    The VFD's HDI-frequency register.
 
 *hy_gt_vfd.external-counter* (float, out)::
 
-        The VFD's external counter register.
+    The VFD's external counter register.
 
 *hy_gt_vfd.fault-info* (float, out)::
 
-        The VFD's fault info register.
+    The VFD's fault info register.
 
 
 == ISSUES
 
-The VFD produces the output frequency that it sends to the motor by adding
-a manually specified offset to the frequency command it gets over modbus.
+The VFD produces the output frequency that it sends to the motor by adding a manually specified offset to the frequency command it gets over modbus.
 
-The manual offset is controlled by pressing the Up/Down arrows on the
-faceplate while the VFD is turning the motor.
+The manual offset is controlled by pressing the Up/Down arrows on the faceplate while the VFD is turning the motor.
 
-If you command a speed on the .speed-cmd pin and get a different speed
-reported on the .speed-fb pin, first verify that the VFD registers
-listed in the FIRMWARE SETUP section above and the driver's command-line
-arguments all agree with the info on the motor's name plate.  If you
-still aren't getting the speed you expect, zero the VFD's frequency
-offset by starting the motor running, then pressing the Up/Down buttons
-to zero the offset.
+If you command a speed on the .speed-cmd pin and get a different speed reported on the .speed-fb pin, first verify that the VFD registers listed in the FIRMWARE SETUP section above and
+the driver's command-line arguments all agree with the info on the motor's name plate.
+If you still aren't getting the speed you expect, zero the VFD's frequency offset by starting the motor running, then pressing the Up/Down buttons to zero the offset.
 
 == AUTHOR