Skip to content

Commit c8c19de

Browse files
Improved hostmot2(9) language and made its formatting more consistent
Expand contractions to make text easier to read. Use double quotes consistently instead of a mix of single and double quotes. Picked double over single quotes as it had most existing use. Also adjusted the roff formatting to quiet down po4a.
1 parent e117572 commit c8c19de

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/man/man9/hostmot2.9

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ For example, if your control computer has one 5i20 and one 5i23 you
8686
might load the hm2_pci driver with a HAL command (in halcmd) something
8787
like this:
8888

89-
.B
9089
.nf
90+
.B
9191
loadrt hm2_pci config="firmware=hm2/5i20/SVST8_4.BIT num_encoders=3 num_pwmgens=3 num_stepgens=3,firmware=hm2/5i23/SVSS8_8.BIT sserial_port_0=0000 num_encoders=4"
9292
.fi
9393

@@ -217,7 +217,7 @@ board. These are arranged in 1-4 ports of 1 to 8 channels.
217217
for example all inputs, or all outputs, or offering additional analogue input on
218218
some digital pins.
219219
To set the modes for port 0 use, for example \fBsserial_port_0=0120xxxx\fR
220-
A '0'in the string sets the corresponding port to mode 0, 1 to mode 1, and so
220+
A "0" in the string sets the corresponding port to mode 0, 1 to mode 1, and so
221221
on up to mode 9. An "x" in any position disables that channel and makes the
222222
corresponding FPGA pins available as GPIO.
223223
The string can be up to 8 characters long, and if it defines more
@@ -433,7 +433,7 @@ Parameters:
433433

434434
.TP
435435
(float r/w) scale
436-
Converts from 'count' units to 'position' units.
436+
Converts from "count" units to "position" units.
437437

438438
.TP
439439
(bit r/w) index\-invert
@@ -718,7 +718,7 @@ counts per rev (16777216 counts).
718718
.TP
719719
(s32, out) rawcounts
720720
This is identical to the counts pin, except it is not
721-
reset by the 'index' or 'reset' pins. This is the pin which would be linked to
721+
reset by the "index" or "reset" pins. This is the pin which would be linked to
722722
the bldc HAL component if the resolver was being used to commutate a motor.
723723

724724
.TP
@@ -798,7 +798,7 @@ In conjunction with \fBjoint-pos-fb\fR (qv) emulate absolute encoders.
798798
pwmgens have names like
799799
"hm2_\fI<BoardType>\fR.\fI<BoardNum>\fR.pwmgen.\fI<Instance>\fR".
800800
"Instance" is a two-digit number that corresponds to the HostMot2 pwmgen
801-
instance number. There are 'num_pwmgens' instances, starting with 00.
801+
instance number. There are "num_pwmgens" instances, starting with 00.
802802

803803
So, for example, the HAL pin that enables output from the fourth pwmgen
804804
of the first 7i43 board is: hm2_7i43.0.pwmgen.03.enable (this assumes
@@ -819,7 +819,7 @@ Pins:
819819
.TP
820820
(bit input) enable
821821
If True, the pwmgen will set its Not\-Enable pin
822-
False and output its pulses. If 'enable' is False, pwmgen will set its
822+
False and output its pulses. If "enable" is False, pwmgen will set its
823823
Not\-Enable pin True and not output any signals.
824824

825825
.TP
@@ -830,7 +830,7 @@ Parameters:
830830

831831
.TP
832832
(float rw) scale
833-
Scaling factor to convert 'value' from arbitrary units
833+
Scaling factor to convert "value" from arbitrary units
834834
to duty cycle: dc = value / scale. Duty cycle has an effective range
835835
of \-1.0 to +1.0 inclusive, anything outside that range gets clipped.
836836
The default scale is 1.0.
@@ -1004,7 +1004,7 @@ scale in degrees for 1-2 mS servos with a full motion range of 90 degrees
10041004
stepgens have names like
10051005
"hm2_\fI<BoardType>\fR.\fI<BoardNum>\fR.stepgen.\fI<Instance>\fR".
10061006
"Instance" is a two-digit number that corresponds to the HostMot2 stepgen
1007-
instance number. There are 'num_stepgens' instances, starting with 00.
1007+
instance number. There are "num_stepgens" instances, starting with 00.
10081008

10091009
So, for example, the HAL pin that has the current position
10101010
feedback from the first stepgen of the second 5i22 board is:
@@ -1118,7 +1118,7 @@ Maximum acceleration, in position units per second
11181118
per second. Defaults to 1.0. If set to 0, the driver will not limit its
11191119
acceleration at all - this requires that the position\-cmd or velocity\-cmd
11201120
pin is driven in a way that does not exceed the machine's capabilities.
1121-
This is probably what you want if you're going to be using the LinuxCNC
1121+
This is probably what you want if you are going to be using the LinuxCNC
11221122
trajectory planner to jog or run G-code.
11231123

11241124
.TP
@@ -1244,7 +1244,7 @@ and have a restricted HAL interface.
12441244
GPIOs have names like "hm2_\fI<BoardType>\fR.\fI<BoardNum>\fR.gpio.\fI<IONum>\fR".
12451245
IONum is a three-digit number. The mapping from IONum to connector and
12461246
pin-on-that-connector is written to the syslog when the driver loads,
1247-
and it's documented in Mesa's manual for the Anything I/O boards.
1247+
and it is documented in Mesa's manual for the Anything I/O boards.
12481248

12491249
So, for example, the HAL pin that has the current inverted input value
12501250
read from GPIO 012 of the second 7i43 board is: hm2_7i43.1.gpio.012.in\-not
@@ -1338,7 +1338,7 @@ inms have names like
13381338
"hm2_\fI<BoardType>\fR.\fI<BoardNum>\fR.inm.\fI<Instance>\fR".
13391339
inmuxes have names like "hm2_\fI<BoardType>\fR.\fI<BoardNum>\fR.inmux.\fI<Instance>\fR".
13401340
"Instance" is a two-digit number that corresponds to the HostMot2 inm or inmux
1341-
instance number. There are 'num_inms' or numx_inmuxs" instances, starting
1341+
instance number. There are "num_inms" or numx_inmuxs" instances, starting
13421342
with 00.
13431343

13441344
Each instance reads between 8 and 32 input pins. inm and inmux are identical except
@@ -1416,7 +1416,7 @@ the LED.
14161416
SSRs have names like
14171417
"hm2_\fI<BoardType>\fR.\fI<BoardNum>\fR.ssr.\fI<Instance>\fR".
14181418
"Instance" is a two-digit number that corresponds to the HostMot2 SSR
1419-
instance number. There are 'num_ssrs' instances, starting
1419+
instance number. There are "num_ssrs" instances, starting
14201420
with 00.
14211421

14221422
Each instance has a rate control pin and between 1 and 32 output pins.
@@ -1448,7 +1448,7 @@ pin is 0 and open when the out-NN pin is 1
14481448
OutMs have names like
14491449
"hm2_\fI<BoardType>\fR.\fI<BoardNum>\fR.OutM.\fI<Instance>\fR".
14501450
"Instance" is a two-digit number that corresponds to the HostMot2 OutM
1451-
instance number. There are 'num_outms' instances, starting
1451+
instance number. There are "num_outms" instances, starting
14521452
with 00.
14531453

14541454
Each instance has between 1 and 32 output pins.

0 commit comments

Comments
 (0)