Differences

This shows you the differences between two versions of the page.

--- mycnc:mycnc_screen_configuration [2020/01/20 12:55] – ivan
+++ mycnc:mycnc_screen_configuration [2020/01/24 10:29] – ivan
@@ Line 1: / Line 1: @@
 ===== MyCNC Screen Configuration ======
+In this manual, we will be going through all the different elements that can be used to display (and interact with) the necessary information on the myCNC screen. Sample examples for the step-by-step screen configuration of myCNC software are available [[mycnc:mycnc_screen_configuration:screen_configuration_examples|here]].
 ==== Getting Started with editing the myCNC screen====
-By default, myCNC comes with a number of profiles, each with slight visual differences which are designed to best suit the workflow of a particular system, be it a plasma cutting machine, a mill, or a tangential knife setup. However, sometimes it is necessary to edit the software screen to better suit the particular workflow of the operator. Luckily, the myCNC software is almost endlessly customizable since it comes with an ability to edit the .xml files which are responsible for displaying all the necessary on-screen content.
+By default, myCNC comes with a number of profiles, each with slight visual differences which are designed to best suit the workflow of a particular system, be it a plasma cutting machine, a mill, or a tangential knife setup. However, sometimes it is necessary to edit the software screen to better suit the particular workflow of the operator. Luckily, the myCNC software is almost endlessly customizable since it comes with the ability to edit the .xml files which are responsible for displaying the on-screen content.
 These .xml files are stored in your profile folder. On Ubuntu systems, go to your home folder, and then navigate to ''.config/myCNC/profiles''. All your profiles (which can be chosen from within the myCNC software by going into ''Settings > Info'') are stored here:
@@ Line 13: / Line 15: @@
 {{:mycnc:screen-config-029-x1366m.png}}
-However, merely being in the profile folder does not mean that the .xml file's contents will be displayed on the myCNC screen. In order for the .xml file to be used when building the myCNC screen, it must be included in the cnc-screen.xml file that is located within the profile folder:
+However, merely being in the profile folder does not mean that the .xml file's contents will be displayed on the myCNC screen. In order for the .xml file to be used, it must be included in the cnc-screen.xml file that is located within that profile's folder:
 {{:mycnc:screen-config-030-cnc-screen.png}}
-Upon opening this file and scrolling down to the bottom, you are presented with a list of all the .xml files from within the same folder which will be included when building the myCNC screen:
+Upon opening the cnc-screen.xml file and scrolling down to the bottom, you are presented with a list of all the files from within the same folder which will be included when building the myCNC screen:
 {{:mycnc:screen-config-031-cnc-screen.png}}
-From here on, you can edit these files that are named according to the different elements they put up on the screen (x-coordinates.xml is responsible for displaying the coordinates, x-gantry.xml deals with the gantry alignment widget, etc). Don't forget to save the .xml files and reload the myCNC application for the changes to take effect.
+These files are named according to the different elements they put up on the screen (''x-coordinates.xml'' is responsible for displaying the coordinates, ''x-gantry.xml'' deals with the gantry alignment widget, etc). Don't forget to save the files and reload the myCNC application for the changes to take effect.
-In this manual, we will be going through all the different elements that can be used to display (and interact with) the necessary information on the myCNC screen. Sample examples for the step-by-step screen configuration of myCNC software are available [[mycnc:mycnc_screen_configuration:screen_configuration_examples|here]].
 ==== MyCNC GUI elements ====
@@ Line 442: / Line 442: @@
 ++++
-++++ GLView |
+++++ GLView (3D Visualization)|
 GLView allows to display a 3D visualization window which will show a visualization of the imported program (such as the window on the main screen of myCNC software's 1366M4 profile).
@@ Line 467: / Line 467: @@
 ++++
-++++ NCView |
+++++ NCView (2D Visualization)|
 {{:mycnc:screen-config-018-2d.png}}
@@ Line 524: / Line 524: @@
   * **name** and **type** are set to "statusbar"
 ++++
-++++ NCList |
+++++ NCList (G-code list) |
 The NCList widget is used to display the G-code commands window to the user, as can be seen in the G-code tab on the main screen of the 1366M4 profile, as well as the nesting, rotation and Run From Here buttons:
@@ Line 541: / Line 541: @@
   * **type="frame"** allows to draw a frame border around the NCList window.
   * **hide-list** serves as an option to hide the x-log and x-mill windows when the NCList window is active (as they are all situated in the same area). The **exclusive** flag signifies that only the NCList widget will be up on the screen if it is selected, thus allowing to not interfere with x-log and x-mill windows (the same setting is present in both other respective windows).
+++++
+++++ Myscope (graphs and plots) |
+The ''myscope'' screen element allows the user to display time graphs of information received by the myCNC application. The graphs will look similar to the following image:
+{{:mycnc:screen-config-032-myscope-plot.png}}
+Sample code to add a ''myscope'' element to the myCNC screen:
+<code> <gitem where="xp" name="x-graph" position="90;90"
+ width="680" height="360" basewidth="680" baseheight="360" hidden="yes"
+ type="frame" border-color="##b-border" border-width="2" border-radius="10"
+ bgColor="##b-main"  />
+<gitem where="x-graph" position="10;10" width="660" height="165"
+ name="myscope1" type="myscope" yrange="0;4095" K="1"
+ source="adc0;adc1" sampling="50" /></code>
+  * **where** indicated into which screen element the myscope graph will be inserted (in this example, it will be inserted into a border called ''x-graph'').
+  * **position** indicates the XY position within the element into which it is inserted
+  * **width** and **height** indicate the size of the graph
+  * **name** should be a unique name
+  * **type** should be set to ''myscope''
+  * **yrange** will specify the Y-axis range of the graph
+  * **K** will specify the coefficient by which the necessary information will be multiplied by before being displayed
+  * **source** is the name of the port or the variable which will be monitored. A list of possible sources is provided below.
+  * **sampling** specifies the rate at which the information will be retrieved (in this example, the graph will be updated every 50 milliseconds)
+^ Source ^ Description ^
+| adc0 | ADC #0. ''adc0'' through ''adc7'' are available |
+| pwm0 | PWM #0. ''pwm0'' through ''pwm7'' are available |
+| multidev-adc0 | ADC #0 of the slave controller (if multiple devices are used). multidev-adc0 through multidev-adc7 are available |
+| speed-xyz | Movement speed of the machine |
+| speed-abc | Rotation movement speed of the machine |
+| thc-control | THC system speed |
+| thc-reference | THC Reference voltage |
+| thc-sensor | THC Arc Voltage |
+| data-counter | Reserved for future implementation |
+| time-counter | Reserved for future implementation |
+| cnc-gvariable- | Monitor a myCNC [[mycnc:global_variables|global variable]]. The variable should be included after the dash, such as in ''cnc-gvariable-7010'' |
 ++++