Skip to content

Commit

Permalink
Merge pull request LinuxCNC#3160 from smoe/docs_20241011
Browse files Browse the repository at this point in the history
(Last one) More translation-triggered changes (smoe:docs_20241011)
  • Loading branch information
hansu authored Oct 25, 2024
2 parents 8102217 + 5d6eb66 commit 68fbb70
Show file tree
Hide file tree
Showing 25 changed files with 374 additions and 470 deletions.
4 changes: 2 additions & 2 deletions docs/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ files must be updated to add a new document file.

The relevant pdf.adoc must be updated to include the new document in the
pdf documentation. E.g., a new document belonging to the Master
Documentation requires an entry in src/Master_Documentation.adoc.
Documentation requires an entry in `src/Master_Documentation.adoc`.

`docs.xml` is used to create the "previous" and "next" buttons at the top
of each individual HTML document. It should generally match the order of
Expand All @@ -23,7 +23,7 @@ generating translated files using the files in `docs/po/`.

The main LinuxCNC Makefile can optionally build the documentation and
other files in this directory tree. Use "--enable-build-documentation"
when invoking `src/configure`, and run "make" from src.
when invoking `src/configure`, and run "make" from `src`.

== Notes about drawings

Expand Down
4 changes: 2 additions & 2 deletions docs/src/config/python-interface.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ see <<python:reading-ini-values,ReadingINI file values>> for an example.
current value of the analog input pins.

*angular_units*:: '(returns float)' -
machine angular units per deg, reflects [TRAJ]ANGULAR_UNITS INI value.
machine angular units per deg, reflects [TRAJ]ANGULAR_UNITS INI value.

*aout*:: '(returns tuple of floats)' -
current value of the analog output pins.
Expand All @@ -112,7 +112,7 @@ machine angular units per deg, reflects [TRAJ]ANGULAR_UNITS INI value.
block delete current status.

*call_level*:: '(returns integer)'` -
current subroutine depth. - 0 If not in a subroutine, Depth if not otherwise specified.
current subroutine depth. - 0 if not in a subroutine, depth if not otherwise specified.

*command*:: '(returns string)' -
currently executing command.
Expand Down
16 changes: 10 additions & 6 deletions docs/src/gui/qtdragon.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -965,7 +965,9 @@ Setup steps include:
* Enabling "Use Tool Sensor" under Settings.

[IMPORTANT]
When fist setting up auto tool measurement, please use caution until you confirm tool change and probe locations - it is easy to break a tool/probe. Abort will be honoured while the probe is in motion.
When fist setting up auto tool measurement, please use caution
until you confirm tool change and probe locations - it is easy to break a tool/probe.
Abort will be honoured while the probe is in motion.

Tool Measurement in QtDragon is organized into the following steps which will be explained in more detail in the following section:

Expand Down Expand Up @@ -1008,13 +1010,15 @@ MAXPROBE distance needs to be high enough for the tool to touch the probe.

The following setups need only be done once as long as they remain in effect:

. Under Probe Tool Screens: Insure reasonable values for "Rapid" and "Search," these are the speeds at which the probing will be performed and are in machine units per minute. +
. Under Probe Tool Screens: insure that "Tool Measure" is enabled (this is a button that must be highlighted)
. Under Settings: insure that "Use Tool Sensor" is enabled (this is a tick-box that must be checked)
. In the Tool Table: setup a tool for the spindle probe and insure that its Z offset is set to zero.
. Under Probe Tool Screens: Ensure reasonable values for "Rapid" and "Search," these are the speeds at which the probing will be performed and are in machine units per minute. +
. Under Probe Tool Screens: Ensure that "Tool Measure" is enabled (this is a button that must be highlighted)
. Under Settings: Ensure that "Use Tool Sensor" is enabled (this is a tick-box that must be checked)
. In the Tool Table: Set up a tool for the spindle probe and ensure that its Z offset is set to zero.

[NOTE]
It is possible to use a non-zero tool length for the tool probe, but this requires extra steps and is easy to make mistakes. The following procedure assumes a zero tool probe length.
It is possible to use a non-zero tool length for the tool probe,
but this requires extra steps and is easy to make mistakes.
The following procedure assumes a zero tool probe length.

==== Procedure before starting a program

Expand Down
22 changes: 9 additions & 13 deletions docs/src/hal/halui-examples.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@
:hal: {basebackend@docbook:'':hal}
:ngc: {basebackend@docbook:'':ngc}

For any Halui examples to work you need to add the following line to the [HAL]
section of the ini file.
For any Halui examples to work you need to add the following line to the [HAL] section of the INI file.

[source,{ini}]
----
Expand All @@ -23,14 +22,12 @@ HALUI = halui

To connect a remote program start button to LinuxCNC you use the
`halui.program.run` pin and the `halui.mode.auto` pin.
You have to insure that it is OK to run first by using the
`halui.mode.is-auto` pin. You do this with an `and2`
component. The following figure shows how this is done.
When the Remote Run Button is pressed it is connected to
both `halui.mode.auto` and `and2.0.in0`. If it is OK for
auto mode the pin `halui.mode.is-auto` will be on.
If both the inputs to the `and2.0` component are on the
`and2.0.out` will be on and this will start the program.
You have to ensure that it is OK to run first by using the `halui.mode.is-auto` pin.
You do this with an `and2` component. The following figure shows how this is done.
When the Remote Run Button is pressed it is connected to both `halui.mode.auto` and `and2.0.in0`.
If it is OK for auto mode the pin `halui.mode.is-auto` will be on.
If both the inputs to the `and2.0` component are on the `and2.0.out` will be on
and this will start the program.

.Remote Start Example
image::images/remote-start.png["Remote Start Example"]
Expand Down Expand Up @@ -74,9 +71,8 @@ net ispaused halui.program.is paused => "your output pin"
net resume halui.program.resume <= "your input pin"
----

Your input and output pins are connected to the pins
wired to the other controller. They may be parallel port
pins or any other I/O pins that you have access to.
Your input and output pins are connected to the pins wired to the other controller.
They may be parallel port pins or any other I/O pins that you have access to.

This system works in the following way. When an M0 is
encountered in your G-code, the `halui.program.is-paused`
Expand Down
4 changes: 2 additions & 2 deletions docs/src/man/man1/gs2_vfd.1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@ and writes to the GS2 via a modbus connection.
from the VFD

<name>.speed-command (float, in)::
speed sent to VFD in RPM It is an error to send a speed faster than
the Motor Max RPM as set in the VFD
speed sent to VFD in RPM. It is an error to send a speed faster than
the Motor Max RPM as set in the VFD.

<name>.spindle-fwd (bit, in)::
1 for FWD and 0 for REV sent to VFD
Expand Down
Loading

0 comments on commit 68fbb70

Please sign in to comment.