Merge remote-tracking branch 'origin/2.9'

* origin/2.9:
  g-code.txt: Minor typos spotted when reading docs
  qtvcp -istat: fix OINT_RELATIONS_LIST so synced joints are calculated right
  qtvcp -docs: add details, examples for python rc files
  qtdagon -docs: add details; tool changer HAL pins, python customization
  dehian -add lintain overrides for qtvcp's basic probe help files
  qtvcp -probe basic help: update images, add another page
  qtvcp -probe_routines: fix a check in calibrate round pocket
  qtvcp -mdiline: add a function to return the current command text
  docs: remove obsolete "sign-off" admonition from Contributing doc

Author: SebKuzminsky

debian/source/lintian-overrides

@@ -18,3 +18,13 @@ linuxcnc source: source-is-missing [share/qtvcp/widgets_ui/versa_usage5.html]
 linuxcnc source: source-is-missing [share/qtvcp/widgets_ui/versa_usage6.html]
 linuxcnc source: source-is-missing [share/qtvcp/widgets_ui/versa_usage7.html]
 linuxcnc source: source-is-missing [share/qtvcp/widgets_ui/versa_usage8.html]
+
+linuxcnc source: source-is-missing [share/qtvcp/widgets_ui/basic_help.html]
+linuxcnc source: source-is-missing [share/qtvcp/widgets_ui/basic_help1.html]
+linuxcnc source: source-is-missing [share/qtvcp/widgets_ui/basic_help2.html]
+linuxcnc source: source-is-missing [share/qtvcp/widgets_ui/basic_help3.html]
+linuxcnc source: source-is-missing [share/qtvcp/widgets_ui/basic_help4.html]
+linuxcnc source: source-is-missing [share/qtvcp/widgets_ui/basic_help5.html]
+linuxcnc source: source-is-missing [share/qtvcp/widgets_ui/basic_help6.html]
+linuxcnc source: source-is-missing [share/qtvcp/widgets_ui/basic_help7.html]
+linuxcnc source: source-is-missing [share/qtvcp/widgets_ui/basic_help8.html]

docs/src/code/contributing-to-linuxcnc.adoc

@@ -109,30 +109,18 @@ https://wiki.spheredev.org/index.php/Git_for_the_lazy
 The high-level overview of how to contribute changes to the source goes
 like this:
 
-* Communicate with the project developers and let us know what you're
-  hacking on
-* Clone the git repo
-* Make your changes in a local branch, making sure you "sign off" your commits
-  according to our signed-off-by policy (see below).
-* Adding documentation and <<cha:writing-tests,writing tests>> is
-  an important part of adding a new feature.  Otherwise, others won't
-  know how to use your feature, and if other changes break your
-  feature it can go unnoticed without a test.
+* Communicate with the project developers and let us know what you're hacking on.  Explain what you are doing, and why.
+* Clone the git repo.
+* Make your changes in a local branch.
+* Adding documentation and <<cha:writing-tests,writing tests>> is an important part of adding a new feature.  Otherwise, others won't know how to use your feature, and if other changes break your feature it can go unnoticed without a test.
 * Share your changes with the other project developers in one of these ways:
-** Push your branch to github and create a github pull request to
-   https://github.com/linuxcnc/linuxcnc (this requires a github account)
-** Push your branch to a publicly visible git repo (such as github,
-   bitbucket, your own publicly-accessible server, etc) and share that
-   location on the emc-developers mailing list, or
-** Email your commits to the LinuxCNC-developers mailing list
-   (emc-developers@lists.sourceforge.net) (use `git
-   format-patch` to create the patches)
-* Advocate for your patch
-** Explain what problem it addresses and why it should be included
-   in LinuxCNC
+** Push your branch to github and create a github pull request to <https://github.com/linuxcnc/linuxcnc> (this requires a github account), or
+** Push your branch to a publicly visible git repo (such as github, or your own publicly-accessible server, etc) and share that location on the emc-developers mailing list, or
+** Email your commits to the LinuxCNC-developers mailing list (<emc-developers@lists.sourceforge.net>) (use `git format-patch` to create the patches).
+* Advocate for your patch:
+** Explain what problem it addresses and why it should be included in LinuxCNC.
 ** Be receptive to questions and feedback from the developer community.
-** It is not uncommon for a patch to go through several revisions before
-   it is accepted.
+** It is not uncommon for a patch to go through several revisions before it is accepted.
 
 == git configuration
 

docs/src/gcode/g-code.adoc

@@ -1855,8 +1855,8 @@ Optional settings
 
 * '$-' - The spindle number to which the motion will be synchronised
   (default 0).
-  For example is $1 is programmed then the motion will begin on the
-  reset od spindle.1.index-enable and proceed in synchrony with the
+  For example if $1 is programmed then the motion will begin on the
+  reset of spindle.1.index-enable and proceed in synchrony with the
   value of spindle.1.revs
 * 'R-' - The 'depth degression'. 'R1.0' selects constant depth on
   successive threading passes. 'R2.0' selects constant area.

docs/src/gui/qtdragon.adoc

@@ -448,6 +448,13 @@ net tool-changed     hal_manualtoolchange.changed  <=  iocontrol.0.tool-changed
 net tool-prep-number hal_manualtoolchange.number   <=  iocontrol.0.tool-prep-number
 ----
 
+Also if you don't have an automatic tool changer make sure these pins are connected in one of the HAL files:
+
+[source,{hal}]
+----
+net tool-prepare-loopback iocontrol.0.tool-prepare => iocontrol.0.tool-prepared
+----
+
 This input pin should be connected to indicate probe state.
 
 [source,{hal}]
@@ -1330,7 +1337,16 @@ All aspects of the GUI are fully customization through Qt Designer and/or Python
 This capability is included with the QtVCP development environment.
 The extensive use of QtVCP widgets keeps the amount of required Python code to a minimum, allowing relatively easy modifications.
 The LinuxCNC website has extensive documentation on the installation and use of QtVCP libraries.
-See <<cha:qtvcp,QtVCP Overview>> for more information.
+See <<cha:qtvcp,QtVCP>> for more information in about QtVCP in general.
+Qtdragon can also utilize QtVCP's rc file to do minor python code modifications without using a custom handler file.
+
+[source,{ini}]
+----
+[DISPLAY]
+USER_COMMAND_FILE = CONFIGFOLDER/qtdragonrc.py
+----
+
+See <<cha:qtvcp:modifying-screens,Modifying Screens>> for more information about customization.
 
 .QtDragon - Customized QtDragon
 image::images/silverdragon_custom.png["QtDragon customized",scale=25]

docs/src/gui/qtvcp.adoc

@@ -218,7 +218,7 @@ In that folder, QtVCP will load any of the available following files:
 
 There are _three ways_ to customize a screen/panel.
 
-.Minor StyleSheet Changes
+==== Minor StyleSheet Changes
 Stylesheets can be used to *set Qt properties*.
 If a widget uses properties then they usually can be modified by stylesheets.
 
@@ -232,8 +232,9 @@ State_LED #name_of_led{
   }
 ----
 
-.Minor Python Code Changes
+==== Minor Python Code Changes
 Another Python file can be used to *add commands* to the screen, after the handler file is parsed.
+This can be useful for minor changes while still honouring standard handler updates from linuxcnc repositoies.
 
 In the _INI file_ under the `[DISPLAY]` heading add *`USER_COMMAND_FILE = _PATH_`* +
 
@@ -251,22 +252,80 @@ The default path is in the configuration directory as a hidden file using the sc
 
 This file will be read and executed as Python code in the *handler file context*.
 
-*Only local functions and local attributes* can be referenced.
-Global libraries can not be referenced.
-These are usually seen as all capital words with no preceding self.
+*Only local functions and local attributes* can be referenced. +
+Global libraries defined in the screen's handler file can be referenced but must be preceded with 'self.' +
+These are usually seen as all capital words with no preceding self. +
+'self' references the window class +
+'self.w' typically references the widgets
 
 What can be used can vary by screen and development cycle.
 
-For a valid example:
+.A simple example
+Reference the main window to change the title (Won't show if using INI entries for title change)
 
 [source,python]
 ----
 self.w.setWindowTitle('My Title Test')
 ----
 
-.Full Creative Control
-If you wish to *modify a stock screen* with full control,
-_copy it's UI and handler file to your configuration folder_.
+.An advanced instance patching example
+This could work with the Qtdragon screen's handler file. +
+Here we show how to add new functions and override existing ones.
+
+[source,python]
+----
+# needed to instance patch
+# reference: https://ruivieira.dev/python-monkey-patching-for-readability.html
+import types
+
+# This is actually an unbounded function with 'obj' as a parameter.
+# You call this function without the usual preceding 'self.'
+# This is because will will not be patching it into the original handler class instance
+# It will only be called from code in this file
+def test_function(obj):
+    print(dir(obj))
+
+# This is a new function we will added to the existing handler class instance.
+# Notice it calls the unbounded function with 'self' as an parameter
+# 'self' is the only global reference available. It references the window instance
+def on_keycall_F10(self,event,state,shift,cntrl):
+    if state:
+        print ('F10')
+        test_function(self)
+
+# This will be used to override an existing function in the existing handler class instance
+# note we also call a copy of the original function too
+# this shows how to extend an existing function to do extra functions
+def on_keycall_F11(self,event,state,shift,cntrl):
+    if state:
+        self.on_keycall_F11_super(event,state,shift,cntrl)
+        print ('Hello')
+
+# We are referencing the KEYBIND library that was instantiated in the 
+# original handler class instance by adding 'self.' to it.
+# This function tells KEYBIND to call 'on_keycall_F10' when F10 is pressed
+self.KEYBIND.add_call('Key_F10','on_keycall_F10')
+
+# Here we are instance patching the original handler file to add a new
+# function that calls our new function (of the same name)
+# defined in this file
+self.on_keycall_F10 = types.MethodType(on_keycall_F10, self)
+
+# Here we are defining a copy of the original 'on_keycall_F11' function
+# so we can call it later. we can use any valid, unused function name.
+# We need to do this before overriding the original function.
+self.on_keycall_F11_super = self.on_keycall_F11
+
+# Here we are instance patching the original handler file to override
+# an existing function to point to our new function (of the same name) 
+# defined in this file
+self.on_keycall_F11 = types.MethodType(on_keycall_F11, self)
+
+----
+
+==== Full Creative Control with custom handler/ui files
+If you wish to *modify a stock screen* with full control, _copy it's UI
+and handler file to your configuration folder_.
 
 There is a QtVCP panel to help with this:
 
@@ -278,8 +337,9 @@ qtvcp copy_dialog
 
 * Select the screen and destination folder in the dialog
 * If you wish to *name your screen* differently than the builtin screen's default name, change the _basename_ in the edit box.
+* There should be a folder in the config folder; for screens: named '<CONFIG FOLDER>/qtvcp/screens/' for panels:  named '<CONFIG FOLDER>/qtvcp/panels/' add the folders if ther are missing and copy your folder/files in it.
 * Validate to copy all the files
-* Delete the files you don't wish to modifyso that the original files will be used.
+* Delete the files you don't wish to modify so that the original files will be used.
 
 [[sec:qtvcp:vcp-panels]]
 == VCP Panels

lib/python/qtvcp/qt_istat.py

@@ -233,7 +233,7 @@ def update(self):
         for j in range(jointcount):
             seq = self.INI.find("JOINT_" + str(j), "HOME_SEQUENCE")
             if seq is None:
-                seq = -1
+                seq = 0
                 self.HOME_ALL_FLAG = 0
             self.JOINT_SEQUENCE_LIST[j] = int(seq)
         # joint sequence/type
@@ -265,7 +265,7 @@ def update(self):
             if flag:
                 templist.append(temp)
         # remove duplicates
-        self.JOINT_SYNCH_LIST = list(set(tuple(sorted(sub)) for sub in templist))
+        self.JOINT_SYNC_LIST = list(set(tuple(sorted(sub)) for sub in templist))
 
         # This is a list of joints that are related to a joint.
         #ie. JOINT_RELATIONS_LIST(0) will give a list of joints that go with joint 0
@@ -276,8 +276,12 @@ def update(self):
         for j in range(jointcount):
             temp = []
             for hj, hs in list(self.JOINT_SEQUENCE_LIST.items()):
+                # the absolute numbers must be equal first
                 if abs(int(hs)) == abs(int(self.JOINT_SEQUENCE_LIST.get(j))):
-                    temp.append(hj)
+                    # theN one has to be negative to signal syncing
+                    if int(hs) <0 or int(self.JOINT_SEQUENCE_LIST.get(j)) < 0:
+                        temp.append(hj)
+            # If empty list: no synced joints, just add the jointcount number
             if temp == []:
                 temp.append(j)
             self.JOINT_RELATIONS_LIST[j] = temp

lib/python/qtvcp/widgets/basic_probe.py

@@ -62,7 +62,7 @@ def __init__(self, parent=None):
             LOG.critical(e)
         self.helpPages = ['basic_help.html','basic_help1.html','basic_help2.html',
                         'basic_help3.html','basic_help4.html','basic_help5.html',
-                        'basic_help6.html','basic_help7.html']
+                        'basic_help6.html','basic_help7.html','basic_help8.html']
         self.currentHelpPage = 0
 
         self.probe_list = ["OUTSIDE CORNERS", "INSIDE CORNERS", "EDGE ANGLE", "BOSS and POCKETS",

lib/python/qtvcp/widgets/mdi_line.py

@@ -67,6 +67,10 @@ def __init__(self, parent=None):
             self.mdiLast = None
             pass
 
+    def getMDIText(self):
+        text = str(self.text()).strip()
+        return text
+
     def submit(self):
         self.mdiError = False
         text = str(self.text()).strip()

lib/python/qtvcp/widgets/probe_routines.py

@@ -1481,8 +1481,11 @@ def probe_valley_y(self):
         return error
 
     def probe_cal_round_pocket(self):
-        if self.data_probe_diam >= self.data_diameter_hint:
-            return 'Probe diameter too large for hole diameter hint'
+        if self.data_cal_diameter_hint <= 0 :
+            return 'Calibration diameter hint must be larger then 0'
+        if self.data_probe_diameter >= self.data_cal_diameter_hint:
+            return 'Probe diameter too large for Calibration diameter hint'
+
         self.data_side_edge_length = self.data_cal_diameter / 2
         error = self.probe_xy_hole()
         if error != 1: return error