Skip to content

Commit

Permalink
docs: More smallish changes while iterating through translations
Browse files Browse the repository at this point in the history
  • Loading branch information
smoe committed Mar 27, 2023
1 parent d77880a commit 67acb4f
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 16 deletions.
18 changes: 9 additions & 9 deletions docs/src/config/ini-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -882,7 +882,7 @@ LinuxCNC will not know your joint travel limits when using `NO_FORCE_HOMING = 1`
[[sub:ini:sec:axis-letter]]
=== [AXIS_<letter>] Section(((INI File,Sections,[AXIS_<letter>] Sections)))

The <letter> specifies one of: X Y Z A B C U V W
The _<letter>_ specifies one of: X Y Z A B C U V W

* `MAX_VELOCITY = 1.2` - Maximum velocity for this axis in <<sub:ini:sec:traj,machine units>> per second.
* `MAX_ACCELERATION = 20.0` - Maximum acceleration for this axis in machine units per second squared.
Expand All @@ -896,7 +896,7 @@ The <letter> specifies one of: X Y Z A B C U V W
For a rotary axis (A,B,C typ) with unlimited rotation having no `MAX_LIMIT` for that axis in the `[AXIS_`<letter>`]` section a value of 1e99 is used.
* `WRAPPED_ROTARY = 1` - When this is set to 1 for an ANGULAR axis the axis will move 0-359.999 degrees.
Positive Numbers will move the axis in a positive direction and negative numbers will move the axis in the negative direction.
* `LOCKING_INDEXER_JOINT = 4` - This value selects a joint to use for a locking indexer for the specified axis <letter>.
* `LOCKING_INDEXER_JOINT = 4` - This value selects a joint to use for a locking indexer for the specified axis _<letter>_.
In this example, the joint is 4 which would correspond to the B axis for a XYZAB system with trivkins (identity) kinematics.
When set, a G0 move for this axis will initiate an unlock with the `joint.4.unlock pin` then wait for the `joint.4.is-unlocked` pin then move the joint at the rapid rate for that joint.
After the move the `joint.4.unlock` will be false and motion will wait for `joint.4.is-unlocked` to go false.
Expand Down Expand Up @@ -950,12 +950,12 @@ For example, using trivkins with `coordinates=XZ`, the joint-axes relationships
* JOINT_0 = X
* JOINT_1 = Z

For more information on kinematics modules see the manpage: `$ man kins`
For more information on kinematics modules see the manpage 'kins' (on the UNIX terminal type `man kins`).

* `TYPE = LINEAR` - The type of joint, either `LINEAR` or `ANGULAR`.
* `UNITS = INCH` - (((UNITS)))
If specified, this setting overrides the related `[TRAJ] UNITS` setting.
(e.g., `[TRAJ]LINEAR_UNITS` if the `TYPE` of this joint is `LINEAR`, `[TRAJ]ANGULAR_UNITS` if the `TYPE` of this joint is `ANGULAR`)
If specified, this setting overrides the related `[TRAJ] UNITS` setting,
e.g., `[TRAJ]LINEAR_UNITS` if the `TYPE` of this joint is `LINEAR`, `[TRAJ]ANGULAR_UNITS` if the `TYPE` of this joint is `ANGULAR`.
* `MAX_VELOCITY = 1.2` - Maximum velocity for this joint in <<sub:ini:sec:traj,machine units>> per second.
* `MAX_ACCELERATION = 20.0` - Maximum acceleration for this joint in machine units per second squared.
* `BACKLASH = 0.0000` - (((Backlash))) Backlash in machine units.
Expand Down Expand Up @@ -1067,15 +1067,15 @@ These parameters are Homing related, for a better explanation read the <<cha:hom
When it is yes, it will affect the kind of home pattern used.
Currently, you can't home to index with steppers unless you're using StepGen in velocity mode and PID.
* `HOME_INDEX_NO_ENCODER_RESET = NO` -
Use YES if the encoder used for this joint does not reset its counter when an index pulse is detected after assertion of the joint index_enable HAL pin.
Use YES if the encoder used for this joint does not reset its counter when an index pulse is detected after assertion of the joint `index_enable` HAL pin.
Applicable only for `HOME_USE_INDEX = YES`.
* `HOME_IGNORE_LIMITS = NO` -
When you use the limit switch as a home switch and the limit switch this should be set to YES.
When set to YES the limit switch for this joint is ignored when homing.
You must configure your homing so that at the end of your home move the home/limit switch is not in the toggled state you will get a limit switch error after the home move.
* `HOME_IS_SHARED =` _<n>_ -
If the home input is shared by more than one joint set <n> to 1 to prevent homing from starting if the one of the shared switches is already closed.
Set <n> to 0 to permit homing if a switch is closed.
If the home input is shared by more than one joint set _<n>_ to 1 to prevent homing from starting if the one of the shared switches is already closed.
Set _<n>_ to 0 to permit homing if a switch is closed.
* `HOME_ABSOLUTE_ENCODER = 0` | `1` | `2` - Used to indicate the joint uses an absolute encoder.
At a request for homing, the current joint value is set to the `HOME_OFFSET` value.
If the `HOME_ABSOLUTE_ENCODER` setting is 1, the machine makes the usual final move to the `HOME` value.
Expand Down Expand Up @@ -1332,7 +1332,7 @@ The value of _num_spindles_ is set by `[TRAJ]SPINDLES=` .
There is usually no need to change this number.
* `TOOL_TABLE = tool.tbl` - The file which contains tool information, described in the User Manual.
* `DB_PROGRAM = db_program` - Path to an executable program that manages tool data.
(When a DB_PROGRAM is specified, a TOOL_TABLE entry is ignored)
When a DB_PROGRAM is specified, a TOOL_TABLE entry is ignored.
* `TOOL_CHANGE_POSITION = 0 0 2` -
Specifies the XYZ location to move to when performing a tool change if three digits are used.
Specifies the XYZABC location when 6 digits are used.
Expand Down
9 changes: 4 additions & 5 deletions docs/src/hal/rtcomps.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -261,12 +261,11 @@ The component exports two functions. Each function acts on all of the PWM genera
* (funct) `pwmgen.make-pulses` - High speed function to generate PWM waveforms (no floating point).
The high speed function `pwmgen.make-pulses` should be run in the base (fastest) thread, from 10 to 50&#8239;µ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&#8239;ns then every 50uS 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)&#8239;s / 50&#8239;µs * 50% = 400 iterations.
This also means that you have a 800 possible duty cycle values (without dithering)
If the base thread is 50,000&#8239;ns then every 50&#8239;µs the module decides if it is time to change the state of the output.
At 50% duty cycle and 25&#9239;Hz PWM frequency this means that the output changes state every (1/25)&#8239;s / 50&#8239;µ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.
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.

[[sec:encoder]]
== Encoder(((encoder)))
Expand Down
4 changes: 2 additions & 2 deletions docs/src/hal/tools.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
== Halcmd

`halcmd` is a command line tool for manipulating the HAL.
There is a rather complete man page for link:../man/man1/halcmd.1.html[`halcmd``], which will be installed if you have installed LinuxCNC from either source or a package.
There is a rather complete man page for link:../man/man1/halcmd.1.html[`halcmd`], which will be installed if you have installed LinuxCNC from either source or a package.
The manpage provides usage info:

----
Expand Down Expand Up @@ -345,4 +345,4 @@ Component pins that cannot be associated with a known thread function report the
This helps with the understanding what the source of a pin value is.
Use this information with applications like `halshow`, `halmeter`, `halscope` or the `halcmd show` command in a terminal.

// vim: set syntax=asciidoc:
// vim: set syntax=asciidoc:

0 comments on commit 67acb4f

Please sign in to comment.