Merge branch '2.9'

Author: c-morley

docs/src/gui/images/qtdragon_spindle_belts.png

@@ -176,6 +176,11 @@ The `EMBED_TAB_NAME` entry will used as the title for the new tab.(must be uniqu
 Tab `EMBED_TAB_LOCATION` options include: `tabWidget_utilities`, `tabWidget_setup` and `stackedWidget_mainTab`. +
 Tab `EMBED_TAB_COMMAND` specifies what embed-able program to run, including any of it's command line options.
 
+If using the `tabWidget_utilities` or `tabWidget_setup` locations, an extra tab will appear with the panel. +
+If using `stackedWidget_mainTab`, a button labelled 'User' will appear. +
+Pressing this button will cycle through displaying all available panels (specified for this location) on the main tab area.
+
+==== Embedding Vismach Mill
 .Sample adding a builtin panel to the utilities tab, i.e., a graphical animated machine using the vismach library.
 [source,{ini}]
 ----
@@ -185,9 +190,18 @@ EMBED_TAB_COMMAND = qtvcp vismach_mill_xyz
 EMBED_TAB_LOCATION = tabWidget_utilities
 ----
 
-If using the `tabWidget_utilities` or `tabWidget_setup` locations, an extra tab will appear with the panel.
-If using `stackedWidget_mainTab`, a button labelled 'User' will appear.
-Pressing this button will cycle through displaying all available panels (specified for this location) on the main tab area.
+==== Embedding Spindle Belts Panel
+
+This example panel is designed to display additional RS485 VFD data and also to configure a 4 sheave, 2 belt spindle drive via a series of buttons.
+
+image::images/qtdragon_spindle_belts.png["QtDragon spindle_belts Panel - Spindle Belts VCP",align="center"]
+[source,{ini}]
+----
+[DISPLAY]
+EMBED_TAB_NAME = Spindle Belts
+EMBED_TAB_COMMAND = qtvcp spindle_belts
+EMBED_TAB_LOCATION = tabWidget_utilities
+----
 
 === Subroutine Paths
 

docs/src/gui/images/qtvcp_spindle_belts.png

@@ -747,6 +747,133 @@ def on_keycall_override(self,event,state,shift,cntrl,value):
         print('value = {}'.format(value))
 ----
 
+=== Key Defines
+
+Here is a list of recognized key words. Use the quoted text. +
+Letter keys use 'Key_' with the upper or lower letter added. +
+ie. 'Key_a' and 'Key_A'
+
+[source,python]
+----
+    keys = {
+        Qt.Key_Escape: "Key_Escape",
+        Qt.Key_Tab: "Key_Tab",
+        Qt.Key_Backtab: "Key_Backtab",
+        Qt.Key_Backspace: "Key_Backspace",
+        Qt.Key_Return: "Key_Return",
+        Qt.Key_Enter: "Key_Enter",
+        Qt.Key_Insert: "Key_Insert",
+        Qt.Key_Delete: "Key_Delete",
+        Qt.Key_Pause: "Key_Pause",
+        Qt.Key_Print: "Key_Print",
+        Qt.Key_SysReq: "Key_SysReq",
+        Qt.Key_Clear: "Key_Clear",
+        Qt.Key_Home: "Key_Home",
+        Qt.Key_End: "Key_End",
+        Qt.Key_Left: "Key_Left",
+        Qt.Key_Up: "Key_Up",
+        Qt.Key_Right: "Key_Right",
+        Qt.Key_Down: "Key_Down",
+        Qt.Key_PageUp: "Key_PageUp",
+        Qt.Key_PageDown: "Key_PageDown",
+        Qt.Key_Shift: "Key_Shift",
+        Qt.Key_Control: "Key_Control",
+        Qt.Key_Meta: "Key_Meta",
+        # Qt.Key_Alt: "Key_Alt",
+        Qt.Key_AltGr: "Key_AltGr",
+        Qt.Key_CapsLock: "Key_CapsLock",
+        Qt.Key_NumLock: "Key_NumLock",
+        Qt.Key_ScrollLock: "Key_ScrollLock",
+        Qt.Key_F1: "Key_F1",
+        Qt.Key_F2: "Key_F2",
+        Qt.Key_F3: "Key_F3",
+        Qt.Key_F4: "Key_F4",
+        Qt.Key_F5: "Key_F5",
+        Qt.Key_F6: "Key_F6",
+        Qt.Key_F7: "Key_F7",
+        Qt.Key_F8: "Key_F8",
+        Qt.Key_F9: "Key_F9",
+        Qt.Key_F10: "Key_F10",
+        Qt.Key_F11: "Key_F11",
+        Qt.Key_F12: "Key_F12",
+        Qt.Key_F13: "Key_F13",
+        Qt.Key_F14: "Key_F14",
+        Qt.Key_F15: "Key_F15",
+        Qt.Key_F16: "Key_F16",
+        Qt.Key_F17: "Key_F17",
+        Qt.Key_F18: "Key_F18",
+        Qt.Key_F19: "Key_F19",
+        Qt.Key_F20: "Key_F20",
+        Qt.Key_F21: "Key_F21",
+        Qt.Key_F22: "Key_F22",
+        Qt.Key_F23: "Key_F23",
+        Qt.Key_F24: "Key_F24",
+        Qt.Key_F25: "Key_F25",
+        Qt.Key_F26: "Key_F26",
+        Qt.Key_F27: "Key_F27",
+        Qt.Key_F28: "Key_F28",
+        Qt.Key_F29: "Key_F29",
+        Qt.Key_F30: "Key_F30",
+        Qt.Key_F31: "Key_F31",
+        Qt.Key_F32: "Key_F32",
+        Qt.Key_F33: "Key_F33",
+        Qt.Key_F34: "Key_F34",
+        Qt.Key_F35: "Key_F35",
+        Qt.Key_Super_L: "Key_Super_L",
+        Qt.Key_Super_R: "Key_Super_R",
+        Qt.Key_Menu: "Key_Menu",
+        Qt.Key_Hyper_L: "Key_HYPER_L",
+        Qt.Key_Hyper_R: "Key_Hyper_R",
+        Qt.Key_Help: "Key_Help",
+        Qt.Key_Direction_L: "Key_Direction_L",
+        Qt.Key_Direction_R: "Key_Direction_R",
+        Qt.Key_Space: "Key_Space",
+        Qt.Key_Any: "Key_Any",
+        Qt.Key_Exclam: "Key_Exclam",
+        Qt.Key_QuoteDbl: "Key_QuoteDdl",
+        Qt.Key_NumberSign: "Key_NumberSign",
+        Qt.Key_Dollar: "Key_Dollar",
+        Qt.Key_Percent: "Key_Percent",
+        Qt.Key_Ampersand: "Key_Ampersand",
+        Qt.Key_Apostrophe: "Key_Apostrophe",
+        Qt.Key_ParenLeft: "Key_ParenLeft",
+        Qt.Key_ParenRight: "Key_ParenRight",
+        Qt.Key_Asterisk: "Key_Asterisk",
+        Qt.Key_Plus: "Key_Plus",
+        Qt.Key_Comma: "Key_Comma",
+        Qt.Key_Minus: "Key_Minus",
+        Qt.Key_Period: "Key_Period",
+        Qt.Key_Slash: "Key_Slash",
+        Qt.Key_0: "Key_0",
+        Qt.Key_1: "Key_1",
+        Qt.Key_2: "Key_2",
+        Qt.Key_3: "Key_3",
+        Qt.Key_4: "Key_4",
+        Qt.Key_5: "Key_5",
+        Qt.Key_6: "Key_6",
+        Qt.Key_7: "Key_7",
+        Qt.Key_8: "Key_8",
+        Qt.Key_9: "Key_9",
+        Qt.Key_Colon: "Key_Colon",
+        Qt.Key_Semicolon: "Key_Semicolon",
+        Qt.Key_Less: "Key_Less",
+        Qt.Key_Equal: "Key_Equal",
+        Qt.Key_Greater: "Key_Greater",
+        Qt.Key_Question: "Key_Question",
+        Qt.Key_At: "Key_At",
+        Qt.Key_BracketLeft: "Key_BracketLeft",
+        Qt.Key_Backslash: "Key_Backslash",
+        Qt.Key_BracketRight: "Key_BracketRight",
+        Qt.Key_AsciiCircum: "Key_AsciiCircum",
+        Qt.Key_Underscore: "Key_Underscore",
+        Qt.Key_QuoteLeft: "Key_QuoteLeft",
+        Qt.Key_BraceLeft: "Key_BraceLeft",
+        Qt.Key_Bar: "Key_Bar",
+        Qt.Key_BraceRight: "Key_BraceRight",
+        Qt.Key_AsciiTilde: "Key_AsciiTilde",
+
+    }
+----
 == `Messages`
 
 *`Messages`* module is used to *display pop up dialog messages on the screen*.
@@ -855,7 +982,7 @@ You can set the:
 
 The `ScreenOptions` widget can automatically set up the preference system.
 
-QtVCP searches for the `ScreenOptions` widget first and, if found, calls *`+_pref_init()+`*. +
+QtVCP searches for the `ScreenOptions` widget first and, if found, calls *`_pref_init()`*. +
 This will _create the preferences object_ and return it to QtVCP to pass to all the widgets and add it to the window object attributes. +
 In this case the preferences object would be accessible from the handler file's `initialized_` method as *`self.w.PREFS_`*.
 

docs/src/gui/qtdragon.adoc

@@ -36,6 +36,67 @@ qtvcp copy
 .QtVCP `copy` Dialog - Screen, VCP Panel or QtVismach Code Copy Panel
 image::images/qtvcp_copy_dialog.png["QtVCP copy Dialog - Screen, Panel or Vismach Code Copy Panel",align="center"]
 
+[[sub:qtvcp:panels:spindle-belts]]
+=== spindle_belts
+
+This panel is designed to display additional RS485 VFD data and also to configure a 4 sheave, 2 belt spindle drive via a series of buttons.
+
+image::images/qtvcp_spindle_belts.png["QtVCP spindle_belts Panel - Spindle Belts VCP",align="center"]
+
+In addition, it is also a useful template to use for your custom panel because it includes:
+
+* Display of additional hal data
+* Buttons and button groups
+* Dynamic changes to button enabled/disabled state based on the state of other buttons
+* Saving data to the qtdragon.prefs file
+* Custom button to reset the VFD
+
+Modify this panel to suit your own requirements. Most common features are used. 
+The advantage of using panels is that it separates your custom display code from the qtdragon core code so upgrading the system will not break your customization.
+
+==== Additional Requirements
+
+* A spindle drive (for instance VFDMOD)
+* A custom component that scales the VFD frequency to obtain the desired spindle speed.
+* A belt driven spindle that uses two belts and an intermediate idler pulley much like a drill press.
+* Connect the input pins qtdragon.belts.<pin-name> in your postgui hal file.
+
+==== Function
+The belts are broken into two button groups, the front belts and the rear belts. These are numbered as per the plate on the machine. Buttons in a group are mutually exclusive. Eg. Only one can be selected in the group.
+
+Additionally, it's not possible to have both belts on the same level with this kind of mechanism because you can’t fit two belts to the one idler pulley sheave.. So if a belt is selected, its opposite button is disabled. Eg. if belt 3 is selected, belt 7 is disabled.
+
+==== Embedding commands
+Add these lines to the [DISPLAY] section in your .ini file +
+The example tab_location is for the QtDragon screen.
+----
+EMBED_TAB_NAME=Spindle Extras
+EMBED_TAB_COMMAND=qtvcp spindle_belts
+EMBED_TAB_LOCATION=tabWidget_utilities
+----
+
+Here is how to load `spindle_belt` from a HAL script:
+
+[source,{hal}]
+----
+loadusr qtvcp spindle_belts
+----
+
+==== Customization Hints
+
+Customizing the panel: +
+
+* Copy the files located in /user/share/qtvcp/qtdragon/panels/belts to:
+~/linuxcnc/configs/<my_configuration_folder>/qtvcp/panels/belts (you can use the copy dialog panel to do this)
+
+* Edit belts.ui with designer. 
+* Edit belts_handler.py with a text editor
+* Connect the relevant pins in a postgui.hal file
+* Make sure your postgui file is loaded by your .ini file.
+
+For information on the finer points, consult the qtvcp and qtdragon documentation
+The python handler file also provides a useful template for any custom panel.
+
 [[sub:qtvcp:panels:test-dial]]
 === `test_dial`