Deploy docs

kcjengr · Aug 11, 2024 · 0b6d180 · 0b6d180
commit 0b6d180
Show file tree

Hide file tree

Showing 149 changed files with 8,881 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_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,153 @@
+===================
+Development Install
+===================
+
+
+**Probe Basic Development Installation Guide**
+
+
+**Note: Probe Basic is currently designed for 1920x1080 screen sizes only!**
+
+**For Whatever reason mesa ehternet setups go much more smoothly when a wired ethernet internet connection is used during linux installation.  The debian installer does some magic that sets up the network perfectly with only one minor tweak once installed.  The wireless setup after install is much easier to get working.  I HIGHLY RECOMMEND using the wired internet connection and choosing to setup that connection during installation to avoid unforeseen issues in connecting to the mesa card(s) post install.**
+
+
+**1- Download the Linuxcnc ISO Image File**
+
+::
+
+    http://www.linuxcnc.org/downloads/
+
+Select the "LinuxCNC 2.8.0 Debian 10 Buster PREEMPT-RT ISO" option. 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. Below is the link for it. I recommend using 2-4gb USB drive for quicker flashing.
+
+::
+
+    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.
+
+After installation, copy the following in the main terminal one line at a time and hit enter, select Y for yes if asked at any point during installation.
+
+::
+
+    sudo apt update
+
+    sudo apt upgrade
+
+
+
+**2- Start Linuxcnc first time**
+
+Now linuxcnc needs to be started for the first time for it to create its directory folders. This can be done by the drop down menu and selecting CNC and then LinuxCNC. After the program has started, you can shut it down and continue below.
+
+
+**3- Install qtpyvcp dependencies**
+
+Copy the following in the main terminal it is all one line, hit enter, select Y for yes f asked at any point during installation.
+
+::
+
+    sudo apt install python-pyqt5 python-pyqt5.qtquick python-dbus.mainloop.pyqt5 python-pyqt5.qtopengl python-pyqt5.qsci python-pyqt5.qtmultimedia python-pyqt5.qtwebkit qml-module-qtquick-controls gstreamer1.0-plugins-bad libqt5multimedia5-plugins pyqt5-dev-tools python-dev python-setuptools python-pip git:
+
+::
+
+    sudo apt install qttools5.dev qttools5-dev-tools python-pip
+
+
+**4- Install qtpyvcp**
+
+Copy the following in the main terminal, hit enter, select Y for yes if asked at any point during installation.
+
+::
+
+    git clone https://github.com/kcjengr/qtpyvcp qtpyvcp
+
+    cd qtpyvcp
+
+    pip install --editable .
+
+    cd
+
+    cd ~/qtpyvcp/pyqt5designer/Qt5.7.1-64bit/
+
+    sudo ./install.sh
+
+    cp ~/qtpyvcp/scripts/.xsessionrc ~/
+
+**IMPORTANT: now Log Off of Linux, then Log In again for the previous installation to take effect, then continue with step 6 after in a main terminal!**
+
+
+**5- Install probe_basic**
+
+Copy the following in the main terminal, hit enter.
+
+::
+
+    git clone https://github.com/kcjengr/probe_basic.git
+
+
+**6- Setup the probe_basic directory and install using pip.**
+
+From the main terminal paste the following and press enter after each, if asked, type Y and enter to continue install.
+
+::
+
+    cd probe_basic
+
+    qcompile .
+
+    pip install -e .
+
+    cd
+
+    cp -r ~/probe_basic/probe_basic/fonts/ ~/.local/share/
+
+    cp -r ~/probe_basic/config/probe_basic/ ~/linuxcnc/configs/
+    
+
+And install the conversational widgets
+
+::
+
+    pip install git+https://github.com/kcjengr/qtpyvcp_conversational_gcode.git
+
+
+More details about conversational widgets:
+
+https://github.com/kcjengr/qtpyvcp_conversational_gcode
+
+**7- Edit probe_basic**
+
+To be able to edit the probe_basic gui, you will enter the following in the main terminal.
+
+::
+
+    editvcp probe_basic
+
+
+**8- You are Finished with Installation!**
+
+This should complete the installation of QtPyVCP and the probe_basic GUI, you can now run the sim to get to know it, as well open and play with the GUI design.  If you would like to make a Desktop Icon to launch the editor for probe_basic,  follow the below instructions:
+
+right click on the desktop and select "Create Launcher"
+
+In the field entries you can put the following information:
+
+**NOTE: for the command line be sure to change the "YOUR_COMPUTER_NAME_HERE" for you actual computer name, for example /home/jacob/.local/bin/editvcp probe_basic or the launcher will give an error!**
+
+::
+
+    Name: QTDesigner
+
+    Comment: probe_basic gui editor
+
+    Command: /home/YOUR_COMPUTER_NAME_HERE/.local/bin/editvcp probe_basic
+
+    Working Directory:
+
+Press the Save button once completed.
+
+The first launch select Mark Executable when prompted.
+
+
+**9- Congratualtions you have made it through and should be ready to start having fun!**
+
diff --git a/_sources/development_quick_start_apt.rst.txt b/_sources/development_quick_start_apt.rst.txt
@@ -0,0 +1,110 @@
+===============================
+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
+
+
+
+
+
+**Download the Linux Debian 12 Bookworkm ISO Image File**
+
+::
+
+    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. Below is the link for it. I recommend using 2-4gb USB drive for quicker flashing.
+
+::
+
+    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.
+
+After installation, copy the following in the main terminal one line at a time and hit enter, select Y for yes if asked at any point during installation.  If the return shows "All up to Date" then you can proceed to the next step.
+
+::
+
+    sudo apt update
+
+    sudo apt upgrade
+
+
+
+**If you have not already installed linuxcnc from apt, use the following line in main terminal:**
+
+::
+
+    sudo apt install linuxcnc-uspace linuxcnc-uspace-dev mesaflash
+
+
+
+**Once you have installed linuxcnc, open linuxcnc and start the axis sim briefly and then you can shut it down to ensure the installation was succesful.**
+
+
+**Adding the apt repository to Debian 12, Run the following Lines in Main terminal one at a time**
+
+::
+
+    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
+
+
+
+**Update the Repositories**
+
+::
+
+    sudo apt update
+
+
+
+**Install QtPyVCP and Probe Basic**
+
+::
+
+    sudo apt install python3-qtpyvcp
+
+    sudo apt install python3-probe-basic
+
+
+
+**You are all installed!  You should now be able to launch the Probe Basic sim from within the linuxcnc applications dropdown menu.**
+
+
+**Updating of probe basic and qtpyvcp will occur when your 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.**
+
+**To build your own machine configuration, please follow the instructions in this document:**
+
+
+https://forum.linuxcnc.org/qtpyvcp/48401-configuration-file-conversion-doc-for-probe-basic-py3
+
+