Deploy docs

kcjengr · Sep 18, 2024 · fbe2581 · fbe2581
commit fbe2581
Show file tree

Hide file tree

Showing 157 changed files with 9,119 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 48b478eea9386c5b6931925b620a4628
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/atc_setup.doctree b/.doctrees/atc_setup.doctree
diff --git a/.doctrees/custom_ux_hacking.doctree b/.doctrees/custom_ux_hacking.doctree
diff --git a/.doctrees/dev_install.doctree b/.doctrees/dev_install.doctree
diff --git a/.doctrees/development_quick_start_apt.doctree b/.doctrees/development_quick_start_apt.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/lathe_interface.doctree b/.doctrees/lathe_interface.doctree
diff --git a/.doctrees/machine_config.doctree b/.doctrees/machine_config.doctree
diff --git a/.doctrees/mill_interface.doctree b/.doctrees/mill_interface.doctree
diff --git a/.doctrees/probe_basic_parameters.doctree b/.doctrees/probe_basic_parameters.doctree
diff --git a/.doctrees/probing.doctree b/.doctrees/probing.doctree
diff --git a/.doctrees/quick_start.doctree b/.doctrees/quick_start.doctree
diff --git a/.doctrees/stable_develop_branch_change.doctree b/.doctrees/stable_develop_branch_change.doctree
diff --git a/.doctrees/stable_quick_start_apt.doctree b/.doctrees/stable_quick_start_apt.doctree
diff --git a/.doctrees/tool_length_setter.doctree b/.doctrees/tool_length_setter.doctree
diff --git a/.doctrees/user_tabs.doctree b/.doctrees/user_tabs.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/01_Main.png b/_images/01_Main.png
diff --git a/_images/01_Main1.png b/_images/01_Main1.png
diff --git a/_images/01_Main_MDI.png b/_images/01_Main_MDI.png
diff --git a/_images/02_File.png b/_images/02_File.png
diff --git a/_images/02_File1.png b/_images/02_File1.png
diff --git a/_images/03_ATC.png b/_images/03_ATC.png
diff --git a/_images/03_Offsets.png b/_images/03_Offsets.png
diff --git a/_images/04_Tool.png b/_images/04_Tool.png
diff --git a/_images/04_Touch_Off.png b/_images/04_Touch_Off.png
diff --git a/_images/05_Offsets.png b/_images/05_Offsets.png
diff --git a/_images/05_Tool_Table.png b/_images/05_Tool_Table.png
diff --git a/_images/06_Probing.png b/_images/06_Probing.png
diff --git a/_images/06_Probing1.png b/_images/06_Probing1.png
diff --git a/_images/07_Conversational.png b/_images/07_Conversational.png
diff --git a/_images/07_Conversational_Facing.png b/_images/07_Conversational_Facing.png
diff --git a/_images/07_Conversational_Hole_Ops_Pattern.png b/_images/07_Conversational_Hole_Ops_Pattern.png
diff --git a/_images/07_Conversational_Hole_Ops_XY_Coord.png b/_images/07_Conversational_Hole_Ops_XY_Coord.png
diff --git a/_images/08_Settings.png b/_images/08_Settings.png
diff --git a/_images/08_Settings1.png b/_images/08_Settings1.png
diff --git a/_images/09_Settings.png b/_images/09_Settings.png
diff --git a/_images/09_Status.png b/_images/09_Status.png
diff --git a/_images/atc.png b/_images/atc.png
diff --git a/_images/custom_ux_labels.png b/_images/custom_ux_labels.png
diff --git a/_images/enter_nano_file_save_name.png b/_images/enter_nano_file_save_name.png
diff --git a/_images/icon.png b/_images/icon.png
diff --git a/_images/nano_sources_list.png b/_images/nano_sources_list.png
diff --git a/_images/nano_sources_list_edited.png b/_images/nano_sources_list_edited.png
diff --git a/_images/params_atc.png b/_images/params_atc.png
diff --git a/_images/params_programmable_coolant.png b/_images/params_programmable_coolant.png
diff --git a/_images/params_tool_setter.png b/_images/params_tool_setter.png
diff --git a/_images/params_touch_probe.png b/_images/params_touch_probe.png
diff --git a/_images/pb_instruction_1.png b/_images/pb_instruction_1.png
diff --git a/_images/pb_instruction_2.png b/_images/pb_instruction_2.png
diff --git a/_images/pb_instruction_3.png b/_images/pb_instruction_3.png
diff --git a/_images/pb_instruction_4.png b/_images/pb_instruction_4.png
diff --git a/_images/pb_instruction_5.png b/_images/pb_instruction_5.png
diff --git a/_images/pb_instruction_7.png b/_images/pb_instruction_7.png
diff --git a/_images/pb_instruction_8.png b/_images/pb_instruction_8.png
diff --git a/_images/pb_instruction_9.png b/_images/pb_instruction_9.png
diff --git a/_images/pb_sources_list.png b/_images/pb_sources_list.png
diff --git a/_images/probe_00_parameters.png b/_images/probe_00_parameters.png
diff --git a/_images/probe_00_results.png b/_images/probe_00_results.png
diff --git a/_images/probe_00_work_offsets.png b/_images/probe_00_work_offsets.png
diff --git a/_images/probe_01_outside_corners.png b/_images/probe_01_outside_corners.png
diff --git a/_images/probe_02_inside_corners.png b/_images/probe_02_inside_corners.png
diff --git a/_images/probe_03_boss_and_pocket.png b/_images/probe_03_boss_and_pocket.png
diff --git a/_images/probe_04_ridge_and_valley.png b/_images/probe_04_ridge_and_valley.png
diff --git a/_images/probe_05_edge_angle.png b/_images/probe_05_edge_angle.png
diff --git a/_images/probe_06_rotary_axis.png b/_images/probe_06_rotary_axis.png
diff --git a/_images/probe_07_calibrate.png b/_images/probe_07_calibrate.png
diff --git a/_images/probe_08_probe_help.png b/_images/probe_08_probe_help.png
diff --git a/_images/probe_help_01_step_off_width.png b/_images/probe_help_01_step_off_width.png
diff --git a/_images/probe_help_02_extra_probe_depth.png b/_images/probe_help_02_extra_probe_depth.png
diff --git a/_images/probe_help_03_max_z_distance.png b/_images/probe_help_03_max_z_distance.png
diff --git a/_images/probe_help_04_max_xy_distance.png b/_images/probe_help_04_max_xy_distance.png
diff --git a/_images/probe_help_05_z_clearance.png b/_images/probe_help_05_z_clearance.png
diff --git a/_images/probe_help_06_xz_clearance.png b/_images/probe_help_06_xz_clearance.png
diff --git a/_images/probe_help_07_hint.png b/_images/probe_help_07_hint.png
diff --git a/_images/tool_length_measure.png b/_images/tool_length_measure.png
diff --git a/_images/tool_setter_setup.png b/_images/tool_setter_setup.png
diff --git a/_images/xfce_check_doc.png b/_images/xfce_check_doc.png
diff --git a/_images/yes_nano_to_save.png b/_images/yes_nano_to_save.png
diff --git a/_sources/atc_setup.rst.txt b/_sources/atc_setup.rst.txt
@@ -0,0 +1,8 @@
+==================
+Carousel ATC Setup
+==================
+
+TODO
+
+.. image:: images/mill/atc.png
+   :align: center
diff --git a/_sources/custom_ux_hacking.rst.txt b/_sources/custom_ux_hacking.rst.txt
@@ -0,0 +1,68 @@
+=========================
+Customisation with Python
+=========================
+
+It is possible to make a simple customisations to the user interface, like renaming a button, by overriding the main window provider in you ``custom_config.yml`` and a simple python class that extends ``ProbeBasic``
+
+These changes can be achieved with the standard instal of Probe Basic, no need for a Development install. Though you may need to dig into the ``probe_basic.ui`` file in Qt Designer to find the needed widget names (``editvcp probe_basic``).
+
+Button Renaming Example
+-----------------------
+
+In the following python example the **FLOOD** button is rename to **FOO** and the **MIST** button is renamed to **BAR**
+
+.. image:: images/custom_ux_labels.png
+   :align: center
+
+To try out the following yourself, save the python below to a file called ``custom_probebasic.py`` under your machine config directory (``~/linuxcnc/configs/{my_machine}/custom_probebasic.py``).
+
+.. code:: python
+
+    from probe_basic.probe_basic import ProbeBasic
+
+    class CustomProbeBasic(ProbeBasic):
+        """Main window class for the ProbeBasic VCP.
+
+        save this file as `custom_probebasic.py` in you configs directory
+        then your custom_config.yml add the `provider:` line below to the `mainwidow: section`
+
+        ```
+        windows:
+          mainwindow:
+            provider: custom_probebasic:CustomProbeBasic
+            kwargs:
+              confirm_exit: false
+        ```
+
+        """
+        def __init__(self, *args, **kwargs):
+            super(CustomProbeBasic, self).__init__(*args, **kwargs)
+
+            # rename the Flood button
+            self.flood_button.setText("Foo")
+
+            # rename the Mist button
+            self.mist_button.setText("Bar")
+
+
+Then edit the ``~/linuxcnc/configs/{my_machine}/custom_config.yml`` file and add the line ``provider: custom_probebasic:CustomProbeBasic`` just under ``mainwindow:``
+
+**Before:**
+
+.. code:: yaml
+
+    windows:
+      mainwindow:
+        kwargs:
+          confirm_exit: false
+
+**After:**
+
+.. code:: yaml
+
+    windows:
+      mainwindow:
+        provider: custom_probebasic:CustomProbeBasic
+        kwargs:
+          confirm_exit: false
+
diff --git a/_sources/dev_install.rst.txt b/_sources/dev_install.rst.txt
@@ -0,0 +1,78 @@
+Probe Basic Development Installation
+====================================
+
+
+This Dev install method uses an installer script and will install QtPyVCP and Probe Basic into a virtual environment (venv) which is now a requirement for pip installations on systems running python version 3.11 which is what comes on Linux Debian 12 Bookworm. This has been tested to work on a clean install of debian 12 bookworm using the xfce4 option and nonfree firmware cdnetinst iso. Download and install the bookworm iso from the link below for your pc type, typically the amd64 on normal pc's:
+
+
+https://www.debian.org/releases/bookworm/debian-installer/
+
+.. important::
+   During Linux Bookworm installation, DO NOT set a root password when prompted, just press continue to move to the next section in the visual installer. Once installed, run all of your updating.
+
+
+Installation Steps
+------------------
+
+   1. Install linuxcnc from terminal using apt:
+
+      .. code-block:: bash
+
+         sudo apt install linuxcnc-uspace linuxcnc-uspace-dev mesaflash
+
+   2. Next restart your computer
+
+   3. Ensure git is installed:
+
+      .. code-block:: bash
+
+         sudo apt install git
+
+   4. Ensure zenity is installed:
+
+      .. code-block:: bash
+
+         sudo apt install zenity
+
+   5. Create a directory and clone the repo to it. Either clone or download a zip file:
+
+      .. code-block:: bash
+
+         cd ~
+         mkdir dev
+         cd dev
+         git clone https://github.com/Lcvette/qtpyvcp-bookworm-installer.git
+         cd qtpyvcp-bookworm-installer
+         ./install_for_qtpyvcp.sh
+
+
+Getting Started with Probe Basic DEVELOPMENT
+--------------------------------------------
+
+    You should now see a series of icons on your desktop, 3 probe basic mill instances consisting of an inch/metric/atc sim and 1 lathe sim instance.  There should also be 2 qtpyvcp icons, one for mill and one for lathe. These icons must be used to enter QTdesigner for your develpment work.  To test your edits in QTdesigner you must use the desktop launcher icons provided to start and run your instance of probe basic sim.  This is required due to python3 requiring to be run in a VENV (virtual environment).  Do not use the application drop down to run linuxcnc or you will not see your changes from your dev efforts.  The changes will be saved in the dev folder files.  When you have completed your edits and wish to create a .deb build file, you can follow the instructions under creating a .deb installation file in the probe basic instruction docs. (coming soon).
+
+
+Updating QtPyVCP and Probe Basic
+--------------------------------
+
+   To update QtPyVCP and Probe Basic, from terminal in the installer directory file, run the following script command:
+
+   .. code-block:: bash
+
+      ./updater.sh
+
+
+Uninstalling QtPyVCP and Probe Basic
+------------------------------------
+
+   To uninstall QtPyVCP and Probe Basic, delete the /dev folder. Since this is a venv run in place install, it is removed once the directory is deleted.
+
+
+Note
+----
+
+   Files that must be executable:
+
+   - install_for_qtpyvcp.sh
+   - sudo_helper.sh
+   - updater.sh
diff --git a/_sources/development_quick_start_apt.rst.txt b/_sources/development_quick_start_apt.rst.txt
@@ -0,0 +1,89 @@
+===============================
+Probe Basic APT Develop Install
+===============================
+
+**Probe Basic APT Installation Guide for use with Debian 12 Bookworm and LinuxCNC version 2.9 or Later**
+
+Important Requirements
+----------------------
+
+    - Probe Basic is currently designed for 1920x1080 screen sizes only!
+    - Probe Basic Install by apt is for amd64 only currently!
+    - Probe Basic requires graphics hardware that supports OpenGL 3.2 and OpenGL Shading Language (GLSL) 1.50 or later
+    - Probe Basic is tested on xfce4, during install of Debian 12 ISO:
+    - DO NOT enter a Root password during installation, leave blank and skip this page.
+
+    During installation, this screen below will appear, be sure to uncheck gnome and check xfce as pictured below. No other changes on this page are needed.
+
+    .. image:: images/xfce_check_doc.png
+        :align: center
+
+
+Installation Steps
+------------------
+
+1. Download the Linux Debian 12 Bookworm ISO Image File
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+    Download from: https://www.debian.org/download
+
+    Select the Linux Debian 12 Bookworm Netinst CD ISO from the above link. You will need to make a bootable DVD or USB thumb drive depending on how you plan to install. The below software is extremely easy and works flawlessly with Linux Debian OS images:
+
+    https://www.balena.io/etcher/?ref=etcher_update
+
+    Once you have created your flash stick for LinuxCNC, proceed to install and boot the system. (Note: It is advised to have an ethernet cable internet connection during install). Select the graphical installation option. Follow the steps on screen to complete installation. When you are greeted by the Linux Desktop Selection Page, uncheck the GNOME option and check the XFCE4 option.
+
+2. Update the System
+^^^^^^^^^^^^^^^^^^^^
+
+    After installation, run the following commands in the main terminal:
+
+    .. code-block:: bash
+
+        sudo apt update
+        sudo apt upgrade
+
+3. Install LinuxCNC
+^^^^^^^^^^^^^^^^^^^
+
+    If you have not already installed LinuxCNC from apt, use the following command:
+
+    .. code-block:: bash
+
+        sudo apt install linuxcnc-uspace linuxcnc-uspace-dev mesaflash
+
+    Once you have installed LinuxCNC, open it and start the axis sim briefly and then shut it down to ensure the installation was successful.
+
+4. Add the APT Repository
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+    Run the following commands in the main terminal one at a time:
+
+    .. code-block:: bash
+
+        sudo apt install curl
+        echo 'deb [arch=amd64] https://repository.qtpyvcp.com/apt develop main' | sudo tee /etc/apt/sources.list.d/kcjengr.list
+        curl -sS https://repository.qtpyvcp.com/repo/kcjengr.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/kcjengr.gpg
+        gpg --keyserver keys.openpgp.org --recv-key 2DEC041F290DF85A
+
+5. Update the Repositories
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+    .. code-block:: bash
+
+        sudo apt update
+
+6. Install QtPyVCP and Probe Basic
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+    .. code-block:: bash
+
+        sudo apt install python3-qtpyvcp
+        sudo apt install python3-probe-basic
+
+    You are now installed! You should be able to launch the Probe Basic sim from within the LinuxCNC applications dropdown menu.
+
+Updating and Configuration
+--------------------------
+
+    Updating of Probe Basic and QtPyVCP will occur when you run the normal "sudo apt update, sudo apt upgrade" commands. During updating, the Probe Basic sim configuration files will be overwritten. It is strongly recommended to create your machine configuration files with unique names to avoid having them overwritten during updates.
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -0,0 +1,53 @@
+.. ProbeBasic documentation master file, created by
+   sphinx-quickstart on Sun Sep 29 11:22:41 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. image:: _static/icon.png
+
+Probe Basic
+===========
+
+ProbeBasic is a `QtPyVCP <http://www.qtpyvcp.com/>`_ based user interface
+for the `LinuxCNC <http://linuxcnc.org/>`_ machine control.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Installation:
+
+   stable_quick_start_apt
+   development_quick_start_apt
+   stable_develop_branch_change
+   quick_start
+   dev_install
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Configuration:
+
+   probe_basic_parameters
+   machine_config
+   atc_setup
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Interface:
+
+   Mill <mill_interface>
+   Lathe <lathe_interface>
+   probing
+   tool_length_setter
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Extending:
+
+   user_tabs
+   custom_ux_hacking
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/_sources/lathe_interface.rst.txt b/_sources/lathe_interface.rst.txt
@@ -0,0 +1,50 @@
+==========================================
+Probe Basic Lathe Interface
+==========================================
+
+Main
+----
+.. image:: images/lathe/01_Main.png
+   :align: center
+
+File
+----
+.. image:: images/lathe/02_File.png
+   :align: center
+
+Offsets
+-------
+.. image:: images/lathe/03_Offsets.png
+   :align: center
+
+Touch Off
+---------
+.. image:: images/lathe/04_Touch_Off.png
+   :align: center
+
+Tool Table
+----------
+.. image:: images/lathe/05_Tool_Table.png
+   :align: center
+
+Probing
+-------
+.. image:: images/lathe/06_Probing.png
+   :align: center
+
+Conversational
+--------------
+.. image:: images/lathe/07_Conversational.png
+   :align: center
+
+Settings
+--------
+.. image:: images/lathe/08_Settings.png
+   :align: center
+
+Status
+------
+.. image:: images/lathe/09_Settings.png
+   :align: center
+
+