diff --git a/docs/src/gui/gladevcp-panels.adoc b/docs/src/gui/gladevcp-panels.adoc index 029b6be2c5a..d7ea8c533c1 100644 --- a/docs/src/gui/gladevcp-panels.adoc +++ b/docs/src/gui/gladevcp-panels.adoc @@ -19,12 +19,124 @@ There are several *builtin panels* available. In a terminal type `gladevcp` to see a list. -=== gtk_verser_probe +--- + +=== GTK Verser Probe A GTK based version of the third party Verser probe. + image::images/gtk_verser_probe.png["GTK Verser Probe",align="center"] -=== gtk_little_probe -A GTK based version of the third party Verser probe in a tabbed layout for smaller displays. +This is a version from 2015 by Serguei Glavatski which has **less functionality** than the current, but it **takes up less space on the screen** (no DRO e.g.). +This can be useful on smaller displays. + +**For Reference - The Current Version** + +The documentation and source code of the current version can be found here: + + * https://vers.ge/en/blog/useful-articles/probe-screen-v28 + * https://github.com/verser-git/probe_screen_v2.9 + + +**Modification of the INI file to use as embedded panel in Gmoccapy** +```ini +[DISPLAY] +DISPLAY = gmoccapy +EMBED_TAB_NAME = Probe +EMBED_TAB_LOCATION = ntb_user_tabs +EMBED_TAB_COMMAND = gladevcp -x {XID} gtk_verser_probe + +[TOOLSENSOR] +RAPID_SPEED = 600 + +[RS274NGC] +# for package install: +SUBROUTINE_PATH = ./macros:/usr/share/linuxcnc/nc_files/gtk_probe/ + +# For RIP installation, use the path according to your directory: +# SUBROUTINE_PATH = ./macros:~/linuxcnc/nc_files/probe/gtk_probe/ +``` + +**Example using dbounce with a Mesa card (HAL file)** +```hal +# ---probe signal--- +loadrt dbounce names=dbounce.probe +addf dbounce.probe servo-thread + +setp dbounce.probe.delay 5 +net probe-db dbounce.probe.in <= hm2_7i96.0.gpio.000.in +net probe-in motion.probe-input <= dbounce.probe.out +``` + +--- +=== GTK Little Probe +A GTK based version of the third party Verser probe, modified for a tabbed layout for smaller displays. image::images/gtk_little_probe.png["GTK little Probe",align="center"] + +This is a modification of the 2015 version of GTK Verser Probe. It moves the elements from one window to containers with switchable vertical tabs. The goal was to reduce the window size. + + +**Modification of the INI file to use as embedded panel in Gmoccapy** +```ini +[DISPLAY] +DISPLAY = gmoccapy +EMBED_TAB_NAME = Probe +EMBED_TAB_LOCATION = ntb_preview +EMBED_TAB_COMMAND = gladevcp -x {XID} gtk_little_probe + +[TOOLSENSOR] +RAPID_SPEED = 600 + +[RS274NGC] +# for package install: +SUBROUTINE_PATH = ./macros:/usr/share/linuxcnc/nc_files/probe/gtk_probe/ + +# For RIP installation, use the path according to your directory: +# SUBROUTINE_PATH = ./macros:~/linuxcnc/nc_files/probe/gtk_probe/ +``` +Use only one Probe Screen by Serguei Glavatski in one LCNC configuration. + + +**Example using dbounce with Mesa card (HAL file)** +```hal +# ---probe signal--- +loadrt dbounce names=dbounce.probe +addf dbounce.probe servo-thread + +setp dbounce.probe.delay 5 +net probe-db dbounce.probe.in <= hm2_7i96.0.gpio.000.in +net probe-in motion.probe-input <= dbounce.probe.out +``` +--- + +=== GTK Mesa Tests +This screen allows the user to verify whether they have a suitable and well-tuned PC for their Mesa card. + +Based on the design of Mesa Configuration Tool II https://github.com/jethornton/mesact Copyright (c) 2022 jethornton + +Although this screen was originally part of the configurator, it is not the configurator. It is a control system. Mesa tests uses data from a running LinuxCNC, but does not send any data to LinuxCNC, nor does it set anything. Parameter adjustment is only allowed to simulate the desired state. + +image::images/gtk_mesa_tests-servo.png["GTK Mesa Tests, Servo Thread",align="center"] + +Servo Thread test: + + * press the "Get CPU speed" button + * press the "Get tmax" button + * press the "Get period" button + * press the "Calculate" button + * check the result [%] + +image::images/gtk_mesa_tests-nic.png["GTK Mesa Tests, NIC",align="center"] + +NIC test: + + * press the "Get CPU speed" button + * press the "Get read.tmax" button + * press the "Get write.tmax" button + * press the "Get period" button + * press the "Calculate" button + * check the result [%] + + +Mesa Tests is a tool designed for beginners to sleep better or to know if they need to buy better hardware or tune their hardware better. It is better to use tools like Halshow or Halscope to monitor the parameters (pins,thread, ...) used. The list of parameters is displayed on the right side of the screen. diff --git a/docs/src/gui/images/gtk_mesa_tests-nic.png b/docs/src/gui/images/gtk_mesa_tests-nic.png new file mode 100644 index 00000000000..912ff33eff6 Binary files /dev/null and b/docs/src/gui/images/gtk_mesa_tests-nic.png differ diff --git a/docs/src/gui/images/gtk_mesa_tests-servo.png b/docs/src/gui/images/gtk_mesa_tests-servo.png new file mode 100644 index 00000000000..f5f2c739555 Binary files /dev/null and b/docs/src/gui/images/gtk_mesa_tests-servo.png differ diff --git a/lib/python/gladevcp/builtin-panels/gtk_little_probe/README.md b/lib/python/gladevcp/builtin-panels/gtk_little_probe/README.md index 2ba8b391529..2e8a02fad5f 100644 --- a/lib/python/gladevcp/builtin-panels/gtk_little_probe/README.md +++ b/lib/python/gladevcp/builtin-panels/gtk_little_probe/README.md @@ -12,40 +12,4 @@ The modification was made by zz912. ### Load with gladevcp command: ```bash gladevcp gtk_little_probe -``` - ---- - -## Modification INI file for embedded panel in Gmoccapy: -```ini -[DISPLAY] -DISPLAY = gmoccapy -EMBED_TAB_NAME = Probe -EMBED_TAB_LOCATION = ntb_preview -EMBED_TAB_COMMAND = gladevcp -x {XID} gtk_little_probe - -[TOOLSENSOR] -RAPID_SPEED = 600 - -[RS274NGC] -# for package install: -SUBROUTINE_PATH = ./macros:/usr/share/linuxcnc/nc_files/probe/gtk_probe/ - -# For RIP installation, use the path according to your directory: -# SUBROUTINE_PATH = ./macros:~/linuxcnc/nc_files/probe/gtk_probe/ -``` -Use only one Probe Screen by Serguei Glavatski in one LCNC configuration. - - ---- - -## Example using dbounce with Mesa card in HAL file: -```hal -# ---probe signal--- -loadrt dbounce names=dbounce.probe -addf dbounce.probe servo-thread - -setp dbounce.probe.delay 5 -net probe-db dbounce.probe.in <= hm2_7i96.0.gpio.000.in -net probe-in motion.probe-input <= dbounce.probe.out -``` +``` \ No newline at end of file diff --git a/lib/python/gladevcp/builtin-panels/gtk_verser_probe/README.md b/lib/python/gladevcp/builtin-panels/gtk_verser_probe/README.md index c605480a28a..60bee2d5109 100644 --- a/lib/python/gladevcp/builtin-panels/gtk_verser_probe/README.md +++ b/lib/python/gladevcp/builtin-panels/gtk_verser_probe/README.md @@ -11,38 +11,4 @@ Old version from 2015. This older version has **less functionality**, but it **t ### Load with gladevcp command: ```bash gladevcp gtk_verser_probe -``` - ---- - -## Modification INI file for embedded panel in Gmoccapy: -```ini -[DISPLAY] -DISPLAY = gmoccapy -EMBED_TAB_NAME = Probe -EMBED_TAB_LOCATION = ntb_user_tabs -EMBED_TAB_COMMAND = gladevcp -x {XID} gtk_verser_probe - -[TOOLSENSOR] -RAPID_SPEED = 600 - -[RS274NGC] -# for package install: -SUBROUTINE_PATH = ./macros:/usr/share/linuxcnc/nc_files/gtk_probe/ - -# For RIP installation, use the path according to your directory: -# SUBROUTINE_PATH = ./macros:~/linuxcnc/nc_files/probe/gtk_probe/ -``` - ---- - -## Example using dbounce with Mesa card in HAL file: -```hal -# ---probe signal--- -loadrt dbounce names=dbounce.probe -addf dbounce.probe servo-thread - -setp dbounce.probe.delay 5 -net probe-db dbounce.probe.in <= hm2_7i96.0.gpio.000.in -net probe-in motion.probe-input <= dbounce.probe.out -``` +``` \ No newline at end of file