mycnc:mycnc_screen_configuration
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| mycnc:mycnc_screen_configuration [2018/10/01 10:46] – skirillov | mycnc:mycnc_screen_configuration [2023/07/25 11:26] (current) – ivan | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ===== MyCNC Screen Configuration ====== | + | ===== Screen |
| + | |||
| + | //The default preset GUI for myCNC profiles is described in the following manual: [[mycnc: | ||
| + | |||
| + | 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: | ||
| + | |||
| + | Video tutorial for screen editing: | ||
| + | |||
| + | {{youtube> | ||
| + | |||
| + | ==== 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 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 '' | ||
| + | |||
| + | {{: | ||
| + | |||
| + | Upon opening the necessary profile folder (we will be using X1366M in this example, for the simple 3-axis mill profile), you are presented with a list of all the .xml files which will populate your screen: | ||
| + | |||
| + | {{: | ||
| + | |||
| + | 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' | ||
| + | |||
| + | {{: | ||
| + | |||
| + | 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: | ||
| + | |||
| + | {{: | ||
| + | |||
| + | These files are named according to the different elements they put up on the screen ('' | ||
| + | |||
| + | In general, the order the files are loaded into myCNC (including .xml configuration files and your settings) is explained here: | ||
| + | |||
| + | {{youtube> | ||
| ==== MyCNC GUI elements ==== | ==== MyCNC GUI elements ==== | ||
| - | === Label === | + | Below is a list of the main elements that can be utilized to create or edit a myCNC profile screen. Some of the functions of these elements overlap (such as BDisplay |
| - | === Display === | + | |
| - | === BDisplay | + | |
| - | === RadioDisplay === | + | |
| - | === KDisplay | + | |
| - | === KSpinBox === | + | |
| - | === KSpinBox2 === | + | |
| - | === LED Display === | + | |
| - | === SVG Display === | + | |
| - | === Myitems Widget === | + | |
| - | === Button === | + | |
| - | A PushButton | + | ^ Element ^ Use ^ |
| + | | **Label** | Unchanging text element | | ||
| + | | **Display** | Changing value | | ||
| + | | **BDisplay** | Changing value - can be clicked by the user to enter a new value | | ||
| + | | **KDisplay** | Changing value - can be clicked by the user to enter a new value | | ||
| + | | **RadioDisplay** | Changing value - preset from a list of choices | | ||
| + | | **Radio2Display** | Changing value - preset from a list of choices (update of RadioDisplay) | | ||
| + | | **KSpinBox** | Changing value - changed by pressing the arrows to increase/ | ||
| + | | **KSpinBox2** | Changing value - changed by pressing the arrows to increase/ | ||
| + | | **LED** | LED display to show some status (can be on/off) | | ||
| + | | **SVG Display** | Set of images to change depending on input | | ||
| + | | **MyItems** | Container element which can contain other elements | | ||
| + | | **Border** | Frame element which can contain other elements | | ||
| + | | **Button** | Button | | ||
| + | | **XButton** | Button with an LED indicator | | ||
| + | | **GLView** | 3D Visualization | | ||
| + | | **NCView** | 2D Visualization | | ||
| + | | **Logview** | Program log window | | ||
| + | | **Statusbar** | Progress and status bar | | ||
| + | | **NCList** | Program G-code commands list | | ||
| + | | **Myscope** | Time graphs | | ||
| + | | **CentringView** | Centering widget (built-in) | | ||
| + | | **Rotation2View** | Full program rotation widget (built-in) | | ||
| + | | **timeview** | Time (clock) display | | ||
| + | | **time-display** | View a global variable (such as #6120) in a 00:00:00 format | | ||
| + | | **splitview** | An element with two horizontal sections where each section will automatically fill all available space when the other is closed | | ||
| + | |||
| + | The following table outlines the parameters that define the on-screen elements within myCNC: | ||
| + | |||
| + | ^ Parameter ^ Example ^ Use ^ | ||
| + | | **type** | type=" | ||
| + | | **skin** | skin=" | ||
| + | | **where** | where=" | ||
| + | | **position** | position=" | ||
| + | | **width** | width=" | ||
| + | | **height** | height=" | ||
| + | | **labelWidth** | labelWidth=" | ||
| + | | **displayWidth** | displayWidth=" | ||
| + | | **labelFgColor** | labelFgColor="## | ||
| + | | **labelBgColor** | labelBgColor="## | ||
| + | | **labelFontSize** | labelFontSize=" | ||
| + | | **labelFontStyle** | labelFontStyle=" | ||
| + | | **message** | < | ||
| + | | **name** | name=" | ||
| + | | **bgColor** | bgColor="## | ||
| + | | **fgColor** | fgColor="## | ||
| + | | **fontStyle** | fontStyle=" | ||
| + | | **format** | format=" | ||
| + | | **displayAlignment** | displayAlignment=" | ||
| + | | **fontFamily** | fontFamily=" | ||
| + | | **deviation** | deviation=" | ||
| + | | **action** | action=" | ||
| + | | **orientation** | orientation=" | ||
| + | | **train-list** | train-list=" | ||
| + | | **cnc-password-widget** | action=" | ||
| + | |||
| + | |||
| + | ++++Label| | ||
| + | |||
| + | Labels are static text elements which are displayed as a text box (typically simple text headings/ | ||
| + | |||
| + | {{:mycnc:screen-config-003-label-mileage-scaled640.png}} | ||
| + | |||
| + | Here, the **Mileage/ | ||
| + | |||
| + | <code c>< | ||
| + | | ||
| + | | ||
| + | | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | * **where** describes the tab that this label element will be inserted into (in this example, it's the oil-change tab) | ||
| + | * **position** specifies the xy pixel position for the label. This position is specified not within the overall screen, but within the **where** tab (in this example, the position is specified in reference to the oil-change section). | ||
| + | * **width** and **height** are specified in pixels. Since the entire text box will be taken up by the label, the labelWidth is equal to the overall width. | ||
| + | * **type** assigns a category to the element that this code will display on the page. In this case, it is set to " | ||
| + | * **labelFgColor** specifies the foreground colour of the label. The colour can be typed in directly, in the HTML RGB format, or, as in this case, with the two pound signs in front (## | ||
| + | {{: | ||
| + | * **labelFontSize** specifies the font size, **labelFontType** is set to bold in this case. **labelFontFamily** can also be specified if a particular font is required (an example of using a labelFontFamily is available in the BDisplay section on this page). If it is not specified, the default font will be used. | ||
| + | * **message** can be written in the required languages (which must be specified). The program will automatically display the correct message for each selected program language. | ||
| + | |||
| + | ++++ | ||
| + | ++++ Display| | ||
| + | |||
| + | **Display** allows to show dynamic info (such as a changing value), and often works in conjunction with a Label (a label will create some title, and the dynamic changing value will be placed on the screen next to the Label as a Display). An example of a Display is the Trip Counter from the User Settings window in the 1336M4 profile: | ||
| + | |||
| + | {{: | ||
| + | |||
| + | The code for this element will look like this: | ||
| + | |||
| + | <code c>< | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | |||
| + | * **where** descibes the section into which the Display element will be inserted. | ||
| + | * **position** describes the xy position within that tab | ||
| + | * **width** and **height** specify the overall dimensions of the Display element, while **displayWidth** and **labelWidth** describe the size of the Display and Label parts (Display being the dynamic changing part and Label being the static text part). | ||
| + | * **name** specifies the variable name for the displayed element (global variable #6090 is brought up on the screen in this case) | ||
| + | * **bgColor** and **fgColor** specify the background and foreground colours of the Display element (or any other element, depending on where they are specified) respectively. As with a Label, these colours can either be set directly, through an HTML RGB code, or by writing out the colour name from Screen > Colors prefaced by two pound signs (##). If no specified colour with that name is found in that list, then the new name will be added to the list and the user will be able to edit it (changes will take effect on the next program reload). | ||
| + | * Similarly, **labelFGColor** specifies the foreground color of the Label (static text) element (this is set separately from the Display element colour). | ||
| + | * **format** specifies how the values are presented. The first number specifies the overall digits that the value will display, while the second number specifies the amount of digits after the dot. F stands for float, while d stands for integer. For example, in this case, %6.3f specifies a float number with six total digits maximum and which allows the number to display up to the third decimal place (degree of accuracy). | ||
| + | * **deviation** can be specified to indicate the minimum absolute value change that would require the program to display a new value. For example, deviation of 0.01 means that the value needs to change by at lease 0.01 (absolute value) for the new numeric value to be displayed. This allows to eliminate visual changes/ | ||
| + | ++++ | ||
| + | |||
| + | ++++ BDisplay| | ||
| + | |||
| + | The BDisplay element allows to display a dynamic value, like a typical Display, which can also be clicked. When clicked, a popup element will be brought up on the screen that will allow the user to enter a new value. For example, the program coordinates displayed on the main screen of the software are BDisplay elements which bring up a popup when clicked, allowing to change their values: | ||
| + | |||
| + | {{: | ||
| + | |||
| + | An example of BDisplay code would be the following: | ||
| + | |||
| + | <code XML> | ||
| + | <gitem where=" | ||
| + | width=" | ||
| + | fgColor="## | ||
| + | type=" | ||
| + | name=" | ||
| + | displayWidth=" | ||
| + | </ | ||
| + | |||
| + | |||
| + | * **fgColor** and **bgColor** specify the colours used for the foreground and the background of the BDisplay element respectively. | ||
| + | * **displayAlignment** allows to position the displayed element in the right bottom corner of the specified area | ||
| + | * **format** works in the same way as the Display format | ||
| + | * **type** is specified to be " | ||
| + | * **deviation** specifies the minimum change in the value to display a new value for the user. This is done in order to prevent excessive value jumping due to small changes. | ||
| + | * **action** allows to perform some sort of action or command after the confirmation checkmark in the popup window is pressed (after the new value is entered). This value is stored as %v and will be used to change the program coordinates to the necessary value in the selected axis. This is extremely useful for changing the values which would require an action to do so (e.g. some kind of machine movement). If no actions are required (i.e., if all that is required is a value/ | ||
| + | * **name** specifies the global variable or the item that the element will be receiving its value from to display. In this case, it is receiving a value from the work-pos-axis-0 item. A comprehensive [[mycnc: | ||
| + | ++++ | ||
| + | |||
| + | ++++RadioDisplay| | ||
| + | |||
| + | RadioDisplay allows to display some value from a list. For example, the display of the coordinate system in the Diagnostics window of the 1366M4 profile is done by using a RadioDisplay element. This allows the user to select some coordinate system (which is not labeled G54/G55/etc within the software, but rather 1, 2, 3, etc), and then display the selected choice as some sort of a user-facing text string (thus, for example, displaying a software " | ||
| + | |||
| + | {{: | ||
| + | |||
| + | An example of code for such a RadioDisplay element is presented here: | ||
| + | |||
| + | <code c>< | ||
| + | labelWidth=" | ||
| + | height=" | ||
| + | bgColor="## | ||
| + | |||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | |||
| + | * **Colours** are selected the same was as described in the Display and Label sections (foreground/ | ||
| + | * **format** lists the list of all possible user-facing text strings. These are numbered 1, 2, 3, etc, separated by a semicolon. | ||
| + | * **type** is set to " | ||
| + | * **name** is the system variable which will be used to choose the user-facing text string. The system will read, for example, Global Variable #5220, and see what value (for example, 4) is written in it. Then, if 4 is written in 5220, G57 will be displayed to the user. | ||
| + | * **orientation** can be set to be horizontal or vertical | ||
| + | |||
| + | NOTE: RadioDisplay and Radio2Display allow for some rudimentary actions to be assigned to the action of clicking the RadioDisplay element. These are limited compared to the Button/ | ||
| + | |||
| + | ^ Action ^ Description ^ | ||
| + | | cnc-gvariable-switch | Switches between different values for a global variable (these variables are preassigned and set as a list separated by commas) | | ||
| + | | cnc-gvariable-toggle | Toggles a global variable between 0 and 1 upon RadioDisplay/ | ||
| + | | item-switch | Switches between preassigned values/ | ||
| + | | toggle-item | Toggles an item from the Item list (toggle writes 0 or 1 to the item depending | ||
| + | |||
| + | An example of actions being assigned to the RadioDisplay can be seen in the 1366V profile when creating a per-program z-height map to account for uneven material positioning. The RadioDisplay element switches between " | ||
| + | |||
| + | {{: | ||
| + | |||
| + | If we look at the code, the RadioDisplay element is actually using the cnc-gvariable-toggle to change between the two modes (0 for Rectangle, 1 for Area): | ||
| + | |||
| + | <code XML> | ||
| + | <gitem where=" | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | * **action** is set to " | ||
| + | * **format** is set to " | ||
| + | ++++ | ||
| + | |||
| + | ++++ Radio2Display | | ||
| + | |||
| + | Radio2Display allows for a more granular display configuration than the simpler RadioDisplay. Similar to RadioDisplay, | ||
| + | |||
| + | {{: | ||
| + | |||
| + | Example code for this screen element: | ||
| + | |||
| + | <code c>< | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | |||
| + | * **bgColor** (background colour) can be set to be transparent | ||
| + | * **type** is set to be radio2-display | ||
| + | * **format** lists all the available options. For example, when the input is equal to 0.1, the system will display 0.1. And when the input is equal to the jog step of 88.88, the system will recognize this command and set the jog to infinity (infinite step). If another number is added to each component, like in the ∞=88.88=2.3 line, that third number specifies the font size for that particular text element. Here, the infinity sign will be 2.3 times larger than the default of the same font, allowing for the infinity sign to be more clearly visible to the end user. | ||
| + | * **deviation** specifies the minimum value by which the parameter should change by for the change to be visually represented on the screen | ||
| + | * **name** indicates the global variable that the system is monitoring (global variable #5522 in this case) | ||
| + | |||
| + | Similar to RadioDisplay, | ||
| + | |||
| + | ^ Action ^ Description ^ | ||
| + | | cnc-gvariable-switch | Switches between different values for a global variable (these variables are preassigned and set as a list separated by commas) | | ||
| + | | cnc-gvariable-toggle | Toggles a global variable between 0 and 1 upon RadioDisplay/ | ||
| + | | item-switch | Switches between preassigned values/ | ||
| + | | toggle-item | Toggles an item from the Item list (toggle writes 0 or 1 to the item depending on the previous item state) | | ||
| + | |||
| + | The example in RadioDisplay code can also be used to assign actions to Radio2Display if type=" | ||
| + | |||
| + | ++++ | ||
| + | |||
| + | ++++ KDisplay | | ||
| + | |||
| + | KDisplay is similar to BDisplay, as it allows to display some dynamic changing variable/ | ||
| + | |||
| + | For example, the gantry alignment correction value can be changed from the Diagnostics window of myCNC software using a KDisplay element: | ||
| + | |||
| + | {{:mycnc:screen-config-008-gantry.png}} | ||
| + | |||
| + | <code c> | ||
| + | < | ||
| + | | ||
| + | | ||
| + | | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | * **Colours** are set similarly to the other elements (Display, BDisplay, etc), allowing to change the foreground/ | ||
| + | * **type** | ||
| + | * **name** displays the global variable that will be used in this field (in this example, it's global variable #7525 for the gantry alignment procedure) | ||
| + | * **deviation** specifies the minimum value by which the parameter (global variable used in this case) should change for the change to be visually represented on the screen. This cutoff allows to disregard some small changes. | ||
| + | ++++ | ||
| + | |||
| + | ++++ KSpinBox | | ||
| + | |||
| + | KSpinBox shows a certain value with an arrow on either side, allowing the user to change the value upon pressing (or pressing and holding) the arrow buttons. The PWM outputs section of the Diagnostics window is done using KSpinBoxes: | ||
| + | |||
| + | {{: | ||
| + | |||
| + | Example of KSpinBox code: | ||
| + | |||
| + | <code c> <gitem fgColor="## | ||
| + | where=" | ||
| + | action=" | ||
| + | type=" | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | * **colours** are done in a similar manner to Labels, Display, BDisplay elements and others (foreground/ | ||
| + | * **where** specifies the location of the displayed element (the PWM section of the screen) | ||
| + | * **alignment** specifies the positioning of the displayed element | ||
| + | * **action** specifies the two action that are taken when the user presses on the left and on the right arrow respectively. Here, " | ||
| + | * **address** specifies the address of the value/item the user is changing (pwm-outputs in this case) | ||
| + | * **number** specifies the particular hardware port that the on-screen element will be monitoring. Here, it is the number of the PWM output, as specified in the address. It is counted from 0, not from 1, so PWM output 1's number is 0, PWM Output 2 is number 1, etc. | ||
| + | * **type** is set to " | ||
| + | ++++ | ||
| + | |||
| + | ++++ KSpinBox2 | | ||
| + | |||
| + | KSpinBox2 allows the user to add an element similar to a regular KSpinBox, displaying a value between two arrows, which also allows the user to click on the current value and change it using a popup screen in addition to changing the value by pressing the respective arrows. This element is used, for example, on the main screen of myCNC software' | ||
| + | |||
| + | {{: | ||
| + | |||
| + | Example KSpinBox2 code: | ||
| + | |||
| + | <code c> | ||
| + | <gitem fgColor="## | ||
| + | where=" | ||
| + | action=" | ||
| + | name=" | ||
| + | labelFontSize=" | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | * **fgColor** specifies the foreground colour, **bgColor** specifies the background colour of the on-screen element | ||
| + | * **position** specifies where in the window the element will be inserted, **height** and **width** specify the size of the element | ||
| + | * **where** designates the window tab into which the element is inserted (in this case, main). The position which was previously specified is noted in relation to this window tab, not the entire myCNC window. | ||
| + | * **format** describes how the value will be presented to the user. %d stands for integer while %f stands for float. **K** specifies the coefficient by which the value will be multiplied by before displaying it to the user. Here, the coefficient is set to 1 to display the actual value. | ||
| + | * **action** lists the two actions which take place when the left arrow and the right arrow buttons are pressed respectively. Here, jog-overspeed-dec is assigned to the left arrow button, and jog-overspeed-inc is assigned to the right button. | ||
| + | * **type** is set to kspinbox2 | ||
| + | * **name** points to the value that will be displayed. This can be a global variable, as seen in the KDisplay and Radio2Display examples above, or it can be an item, as described in the [[mycnc: | ||
| + | * **fontStyle** is set to bold, **labelFontSize** is set separately, as is **displayWidth** and **labelWidth** | ||
| + | * **orientation** can be set to be horizontal or vertical | ||
| + | * the message can be listed in different languages, the system will automatically display the correct message depending on the user language settings for myCNC | ||
| + | ++++ | ||
| + | |||
| + | ++++ LED Display | | ||
| + | |||
| + | LED Display allows the user to display an LED element on the screen. This light can be on or off, and each LED element can have a different colour set for its ON configuration. This is useful to show the state of system items which have a binary state (on or off), such as input ports which can be viewed from the Diagnostics page: | ||
| + | |||
| + | {{: | ||
| + | |||
| + | Below is an example of LED display code for an LED element which will display the state of Input #0 (on or off): | ||
| + | |||
| + | <code c>< | ||
| + | labelFgColor="## | ||
| + | where=" | ||
| + | shape=" | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | |||
| + | * **inversion** indicates whether the LED behaviour will be " | ||
| + | * **where** specifies the section of the window where the LED element will be located (inputs-0 in this case) | ||
| + | * **address** specifies the physical controller hardware that the element will receive its information from (" | ||
| + | * **shape** can be set to be round, or left at square by default (if no shape has been specified). An example of a square LED can be seen at the bottom right of the Diagnostics page, to display whether recent changes have been saved to flash memory: | ||
| + | {{: | ||
| + | * **number** specifies the particular hardware port in the specified hardware section (inputs in this example) that will be monitored. Here, the state of port 0 will be monitored. | ||
| + | * **type** is set to " | ||
| + | ++++ | ||
| + | |||
| + | ++++ SVG Display | | ||
| + | |||
| + | SVG Display allows to display a set of images that will be changing depending on the user input (cycling through the available images). This allows for more granular control than an LED Display element which can only show two states of a system. | ||
| + | |||
| + | Example code: | ||
| + | |||
| + | <code c>< | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | </ | ||
| + | |||
| + | * **where** describes the section in which the element will be inserted | ||
| + | * **position** describes the location of the element within that section | ||
| + | * **imagesfolder** specifies the folder from which the displayed images will be taken | ||
| + | * **loop** allows to loop the value count. For example, if the range is specified from 0 to 100, and the loop is set to =" | ||
| + | * **images** specifies the particular images which will be retrieved from the folder. In this case, any images that start with " | ||
| + | * **type** is set to " | ||
| + | * **K** is the coefficient by which the value will be multiplied by before it is used by the element | ||
| + | * **min** and **max** values specify the bounds for the values which are used. Anything lower than the min value is assumed to be equal to min (displays the first image on the list), everything higher than the max value is assumed to be equal to max (displays the last image on the list). | ||
| + | ++++ | ||
| + | |||
| + | ++++ Myitems Widget | | ||
| + | |||
| + | The Myitems widget allows the user to create a section or a window within the main myCNC screen which can later be filled with buttons/ | ||
| + | |||
| + | {{: | ||
| + | |||
| + | Example code: | ||
| + | |||
| + | <code c>< | ||
| + | | ||
| + | |||
| + | < | ||
| + | |||
| + | * note that the window (oil-change) is itself inside another widget (oil-change-frame), | ||
| + | * **name** will specify the name of the myitems widget which can later be used to insert buttons and other display elements into it through the **where** line for each of these particular elements (therefore things like KDisplay, BDisplay, etc can be inserted into this new window). | ||
| + | * **type** is set as " | ||
| + | * **position** is set in pixels within the window/ | ||
| + | * it is necessary to **include** the actual code for the widget that will be inserted (oil-change.xml). That file contains all the necessary information about what's inside the widget, however it is not necessary to edit it if the entire widget needs to be moved or removed from the screen. | ||
| + | |||
| + | |||
| + | ++++ | ||
| + | |||
| + | ++++ Border | | ||
| + | |||
| + | Note that while the myitems screen element from the example above is its own element, it is also embedded into a separate on-screen element called the border. This border is a frame around an element (typically with rounded corners) and it allows for an easy visual separation between different on-screen elements. | ||
| + | |||
| + | As mentioned, an example of a border can be seen around the oil change section in the user settings tab of the X1366M/M4 profiles: | ||
| + | |||
| + | {{: | ||
| + | |||
| + | Sample border code is available here: | ||
| + | |||
| + | <code c> < | ||
| + | bgColor="## | ||
| + | border-width=" | ||
| + | position=" | ||
| + | basewidth=" | ||
| + | |||
| + | * **where** specifies that the frame will be inserted into the user-widget (the User Settings window is itself a widget on the main screen). | ||
| + | * **bgColor** and **border-color** specify the background and border colours respectively | ||
| + | * ** border-width** and **border-radius** specify the border measurements | ||
| + | * **basewidth** and **baseheight** are specified to serve as reference width and height during the window resizing process. The system will look at the basewidth/ | ||
| + | |||
| + | ++++ | ||
| + | |||
| + | ++++ Skin | | ||
| + | |||
| + | A skin is a parameter which effectively serves as a background for the element within which it is embedded. | ||
| + | |||
| + | Example of a skin can be seen in the Gantry Alignment widget: | ||
| + | |||
| + | {{: | ||
| + | |||
| + | The background of the widget consists of a diagram of the machine. This diagram is embedded using the '' | ||
| + | |||
| + | Example code: | ||
| + | |||
| + | < | ||
| + | skin=" | ||
| + | position=" | ||
| + | |||
| + | * **where** specifies the element within which the new element is embedded | ||
| + | * **name** should be chosen to be unique | ||
| + | * **bgColor** specifies the background colour of the element | ||
| + | * **type** is set to '' | ||
| + | * **skin** is set to the image path within the art/ | ||
| + | * **position** specifies the position in the element within which the item is located | ||
| + | * **width** and **height** specify the size | ||
| + | |||
| + | ++++ | ||
| + | |||
| + | ++++Button| | ||
| + | |||
| + | A PushButton screen item can be used on myCNC screen to serve as as a button which will trigger some command when pressed. For example, the refresh button can be seen on the main screen of the myCNC software: | ||
| + | |||
| + | {{: | ||
| + | |||
| + | The code for such a button will look as follows: | ||
| <code XML > | <code XML > | ||
| Line 22: | Line 489: | ||
| | | ||
| </ | </ | ||
| + | |||
| + | A text element can serve as a button as well as an icon, with the following code being an example of such a layout: | ||
| + | |||
| + | <code XML>< | ||
| + | | ||
| + | | ||
| + | | ||
| + | |||
| + | The button in the case of the example above will look the following way: | ||
| + | |||
| + | {{: | ||
| + | |||
| + | In here, the overlay element is the '' | ||
| Attributes description | Attributes description | ||
| - | * **where** - parent widget name the button placed | + | * **where** - parent widget name that the button |
| - | * **position** - X and Y position of the button inside a parent widget | + | * **position** - X and Y position of the button inside a parent widget |
| * **width** - button width in pixels | * **width** - button width in pixels | ||
| * **height** - button height in pixels | * **height** - button height in pixels | ||
| - | * **type** - type definitionof | + | * **type** - type definition of the item (should be type=" |
| - | * **image** - a image (icon) file in SVG format | + | * **title** - text element overlay on the button |
| - | * **action** - action for the button (which procedure will be executed if event triggered) | + | * **image** - a image (icon) file for the button |
| - | * **event** - event type the button is sensitive to. Event can be | + | * **action** - action for the button (which procedure will be executed if the button is pressed) |
| - | * **pressed** - action is executed if the button pressed | + | * **event** - event type the button is sensitive to. Event can be: |
| - | * **released** - action is executed if the button released | + | * **pressed** - action is executed if the button |
| + | * **released** - action is executed if the button | ||
| * **both** - there are separate actions (";" | * **both** - there are separate actions (";" | ||
| - | * **skinbase** - besides the Image file for each button there is a common **skin** SVG file for all the buttons. For selected buttons skin file can be redefined with **skinbase** attribute. This SVG file will be used as a bottom layer for the button image. | + | * **skinbase** - besides the Image file for each button there is a common **skin** SVG file for all the buttons. For selected buttons skin file can be redefined with **skinbase** attribute |
| + | * A skinbase set equal to " | ||
| + | ++++ | ||
| + | |||
| + | ++++ XButton | | ||
| + | XButton is a Push button (similar to a typical button described above) with a built-in light indicator. The light is typically used to show the current state of some CNC controller input, output pin, or CNC global variable register value. Effectively, | ||
| - | === XButton === | + | {{: |
| - | XButton is a Push Button with built in Light indicator. Light is mostly used to show a current state of CNC controller input, output pin, CNC global variable register value etc. | + | An XButton |
| - | A XButton XML definition example is shown below | ||
| <code XML> | <code XML> | ||
| <gitem where=" | <gitem where=" | ||
| | | ||
| - | | + | |
| | | ||
| | | ||
| Line 55: | Line 540: | ||
| Attributes description | Attributes description | ||
| - | * **where** - parent widget name the button placed to | + | * **where** - parent widget name the button placed to (in this case, the x-mill widget) |
| * **position** - X and Y position of the button inside a parent widget | * **position** - X and Y position of the button inside a parent widget | ||
| * **width** - button width in pixels | * **width** - button width in pixels | ||
| * **height** - button height in pixels | * **height** - button height in pixels | ||
| - | * **type** - type definitionof | + | * **type** - type definition of the item (should be type="xbutton") |
| * **image** - a image (icon) file in SVG format for the button | * **image** - a image (icon) file in SVG format for the button | ||
| * **action** - action for the button (which procedure will be executed if event triggered) | * **action** - action for the button (which procedure will be executed if event triggered) | ||
| * **event** - event type the button is sensitive to. Event can be | * **event** - event type the button is sensitive to. Event can be | ||
| - | * **pressed** - action is executed if the button pressed | + | * **pressed** - action is executed if the button |
| * **released** - action is executed if the button released | * **released** - action is executed if the button released | ||
| * **both** - there are separate actions (";" | * **both** - there are separate actions (";" | ||
| * **skinbase** - besides the Image file for each button there is a common **skin** SVG file for all the buttons. For selected buttons skin file can be redefined with **skinbase** attribute. This SVG file will be used as a bottom layer for the button image. | * **skinbase** - besides the Image file for each button there is a common **skin** SVG file for all the buttons. For selected buttons skin file can be redefined with **skinbase** attribute. This SVG file will be used as a bottom layer for the button image. | ||
| - | * **xattr** - defines light positionm | + | * **xattr** - defines light position |
| * X,Y position of the led/light inside the button | * X,Y position of the led/light inside the button | ||
| * width and height of the led | * width and height of the led | ||
| * type of light (actually this field is always " | * type of light (actually this field is always " | ||
| - | * shape of the standard | + | * shape of the standard |
| * **address** - defines CNC controller hardware the light attached to | * **address** - defines CNC controller hardware the light attached to | ||
| - | * " | + | * " |
| - | * " | + | * " |
| - | * " | + | * " |
| + | Another example of an xbutton realized with a **ref** value for reference to switch (toggle) a variable between two states: | ||
| - | === GLView === | + | < |
| - | === NCView === | + | image="rect/normal" |
| - | 2D Visualization widget. | + | |
| - | * Basic setup. | + | |
| - | < | + | xattr="0; |
| - | <gitem where=" | + | type="xbutton"/></ |
| - | | + | |
| - | </ | + | |
| - | * Advanced setup. | + | |
| - | <code XML> | + | |
| - | <gitem where="olicut" | + | |
| - | | + | |
| - | singlepath=" | + | |
| - | bgColor="# | + | |
| - | ColorT0=" | + | |
| - | ColorT1="#D000D0:5" | + | |
| - | ColorT2="#D05000:5" | + | |
| - | ColorT3="red:2" | + | |
| - | | + | |
| - | ColorT5="# | + | |
| - | </ | + | |
| + | * **data** specifies which values the switch is occuring (the cnc-gvariable-switch-5701 action in this case) | ||
| + | * **ref** specifies the reference value to monitor for | ||
| - | === Logview === | + | Similarly, a '' |
| - | === NCList === | + | |
| - | === CentringView === | + | |
| - | === Rotation2View === | + | |
| - | ==== MyCNC Actions ==== | ||
| - | All button-like screen components (button, xbutton, bdisplay, kspinbox2) runs **Handler** procedure when " | + | ++++ |
| - | List of actions is shown below | + | ++++ GLView (3D Visualization)| |
| - | ^ Action Name ^ Description ^ | + | 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' |
| - | | advanced-config | | | + | |
| - | | basic-config | | | + | |
| - | | toggle-button-coordinates | | | + | |
| - | | toggle-button-jog-enable | | | + | |
| - | | toggle-button-soft-limits | | | + | |
| - | | toggle-button-mist | | | + | |
| - | | toggle-button-flood | | | + | |
| - | | toggle-button-spindle | | | + | |
| - | | toggle-button-ccw-spindle-spindle | | | + | |
| - | | toggle-item: | + | |
| - | | laser-marker- | | | + | |
| - | === Player actions === | + | {{: |
| - | ^ Action Name ^ Description ^ | + | Sample GLView code is shown below: |
| - | | player-play | | | + | |
| - | | player-play-confirm | | | + | |
| - | | player-play-edge | | | + | |
| - | | player-play-edge-confirm | | | + | |
| - | | player-jump1 | | | + | |
| - | | player-pause | | | + | |
| - | | player-stop | | | + | |
| - | | player-skip-forward | | | + | |
| - | | player-skip-forward-10 | | | + | |
| - | | player-skip-backward | | | + | |
| - | | player-skip-backward-10 | | | + | |
| - | | player-skip-part-f | | | + | |
| - | | player-skip-part-b | | | + | |
| - | | player-nc-reset | | | + | |
| - | | player-nc-reset-confirm | | | + | |
| - | | player-back-to-path | | | + | |
| - | | player-back-to-path-confirm | | | + | |
| - | | player-play-back | | | + | |
| - | | player-nc-tie | | | + | |
| - | | player-play-step | | | + | |
| - | | player-play-step-backward | | | + | |
| - | | mdi-play | | | + | |
| - | | mdi-open | | | + | |
| + | <code c> | ||
| + | < | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | </ | ||
| - | === Jog actions === | + | * **type** is set to glview |
| + | * **name** is also set to glview in order to allow other widgets to reference this window | ||
| + | * **position**, | ||
| + | * **singlepath** can be set to //yes// or //no//. This is only useful on the NCView window (2D visualization program described below) | ||
| + | * **ColorT0, T1, etc** describe the visualization colours for different tools in the G-code | ||
| + | * **HColorT0, T1, etc** describes the highlight colour for the selected tool | ||
| + | ++++ | ||
| - | ^ Action Name ^ Description ^ | + | ++++ NCView |
| - | | jog-0-plus, jog-1-plus, \\ jog-2-plus, jog-3-plus, \\ jog-4-plus, jog-5-plus, \\ jog-6-plus, jog-7-plus \\ jog-8-plus | Jog Positive direction in Axis X, Y, Z, A, B, C, U, V, W | | + | |
| - | | jog-0-minus, | + | |
| - | | jog-0-plus-1-plus | Simultaneous two-axes Jog X+ Y+ | | + | |
| - | | jog-0-plus-1-minus | Simultaneous two-axes Jog X+ Y- | | + | |
| - | | jog-0-minus-1-plus | Simultaneous two-axes Jog X- Y+ | | + | |
| - | | jog-0-minus-1-minus | Simultaneous two-axes Jog X- Y- | | + | |
| - | | jog-overspeed-inc \\ jog-overspeed-dec | Increment/ | + | |
| - | | jog-overspeed-set: | + | |
| + | {{: | ||
| + | NCView is the 2D visualization widget to display an image of the imported G-code file such as the main visualization window in the 1366P profile (as a 3D visualization is unnecessary for a plasma/gas profile which will be doing all the cutting in the XY plane only). | ||
| - | === Motion Settings Actions=== | + | Below is the code used to display an NCView window in the 1366P plasma profile. |
| - | ^ Action Name ^ Description ^ | + | <code XML> |
| - | | step-float-inc \\ step-float-dec | + | <gitem where=" |
| - | | step-size-inc \\ step-size-dec | + | singlepath=" |
| - | | motion-linear-acceleration-inc \\ motion-linear-acceleration-dec | + | ColorT0=" |
| - | | motion-linear-jog-speed-inc \\ motion-linear-jog-speed-dec \\ motion-linear-jogspeed-inc \\ motion-linear-jogspeed-dec | + | ColorT4="# |
| - | | motion-jog-speed-x-inc, | + | HColorT0=" |
| - | | motion-rapid-speed-x-inc, | + | HColorT4="# |
| - | | motion-feed-speed-x-inc, | + | </code> |
| - | | motion-overspeed-inc \\ motion-overspeed-dec \\ motion-overspeed | Increase/decrease/ | + | |
| - | | spindle-speed-inc \\ spindle-speed-dec \\ spindle-speed | Increase/ | + | |
| - | | spindle-speed-restore | **Restore Default** Spindle Speed (S) | | + | |
| - | | spindle-overspeed-inc \\ spindle-overspeed-dec \\ spindle-overspeed | Increase/ | + | |
| - | === Built-in Editor Actions === | + | * **type** is set to " |
| + | * **position**, | ||
| + | * **singlepath** can be set to //yes// or //no//. Typically, it is set to be off, so as to display kerf compensation (if there is any kerf compensation present). If set to on, kerf compensation will not be visible (similar to the window shown during file import when a 2D G-code file is being imported into myCNC). | ||
| + | {{: | ||
| + | * **ColorT0, T1, etc** signify the tool colours in the visualization (light blue in this case) | ||
| + | * **HColor** signifies the highlight colour for each tool (colour of the tool visualization when selected | ||
| + | ++++ | ||
| - | ^ Action Name ^ Description ^ | + | ++++ X-log and Logview |
| - | | editor-arrow-up | | | + | |
| - | | editor-arrow-down | | | + | |
| - | | editor-ncline-edit | | | + | |
| - | | editor-ncline-insert | | | + | |
| - | | editor-ncline-remove | | | + | |
| - | | editor-font-inc | | | + | |
| - | | editor-font-dec | | | + | |
| - | | editor-numbers-toggle | | | + | |
| - | | editor-selection-begin | | | + | |
| - | | editor-selection-end | | | + | |
| - | | editor-selection-remove | | | + | |
| - | | editor-selection-insert | | | + | |
| - | | editor-new | | | + | |
| - | | editor-save-as | | | + | |
| - | | editor-save | | | + | |
| + | Logview is the log window tab at the bottom of the main screen of myCNC software (within the x-log widget). It contains information on program start and end times, error messages, etc. | ||
| - | === File Manipulation Actions === | + | {{: |
| - | ^ Action Name ^ Description ^ | + | Example code code to insert the log window as it is displayed in the 1366M4 profile is the following: |
| - | | save | | | + | |
| - | | open | | | + | |
| - | | load-file: | | | + | |
| - | | load-macro: | | | + | |
| - | | file-close | | | + | |
| - | | file-close | | | + | |
| - | | dxf-import | | | + | |
| - | | file-close | | | + | |
| - | | image-import | | | + | |
| + | <code XML> | ||
| + | <gitem where=" | ||
| + | | ||
| + | </ | ||
| - | === Visualization Actions === | + | * **position** describes the location of the logview element withing the x-log widget |
| + | * **position**, | ||
| + | * **name** and **type** are set to " | ||
| - | ^ Action Name ^ Description ^ | + | This will insert the Logview element into the x-log MyItems widget. |
| - | | zoom-in | | | + | |
| - | | zoom-out | | | + | |
| - | | fit-to-view | | | + | |
| - | | zoom-in | | | + | |
| - | | zoom-in | | | + | |
| - | | 3dview-xy | 3D Visualization: | + | |
| - | | 3dview-xz | 3D Visualization: | + | |
| - | | 3dview-yz | 3D Visualization: | + | |
| - | | 3dview-iso | 3D Visualization: | + | |
| - | | 3dview-custom: | + | |
| + | Below the logview window, a status bar can be seen: | ||
| - | === Widget Manipulations Actions === | + | {{: |
| - | ^ Action Name ^ Description ^ | + | This is inserted into the x-log widget |
| - | | show-inputbox | | | + | |
| - | | show-widget-centring | | | + | |
| - | | show-widget-rotation | | | + | |
| - | | show-widget-sawcutting | | | + | |
| - | | show-widget-diagnose | | | + | |
| - | | show-widget-config | | | + | |
| - | | show-widget-edit | | | + | |
| - | | show-widget-lib | | | + | |
| - | | show-widget-tools | | | + | |
| - | | show-widget-lof | | | + | |
| - | | show-widget-report | | | + | |
| - | | show-widget-support | | | + | |
| - | | show-widget-user | | | + | |
| - | | show-widget-work | | | + | |
| - | | mywidget-show: | + | |
| - | | mywidget-hide: | + | |
| - | | mywidget-toggle: | + | |
| - | | pendant-widget-open | | | + | |
| - | | measure-surface | | | + | |
| - | | toggle-virtual-keyboard | | | + | |
| - | | mywidget: | | | + | |
| + | <code XML> | ||
| + | <gitem where=" | ||
| + | | ||
| + | </ | ||
| + | * **where** points out that the status bar is inserted into the x-log widget, same as the Logview element. | ||
| + | * **name** and **type** are set to " | ||
| + | ++++ | ||
| + | ++++ NCList (G-code list) | | ||
| - | === Application Actions === | + | 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: |
| - | ^ Action Name ^ Description ^ | + | {{: |
| - | | close-application | Close myCNC Control software | | + | |
| - | | cnc-config-save | Save myCNC configuration files to disk | | + | |
| + | Example code to insert the NCList window: | ||
| - | === Hardware Manipulation actions | + | <code XML> |
| + | <gitem where=" | ||
| + | width=" | ||
| + | | ||
| + | | ||
| + | </ | ||
| - | ^ Action Name ^ Description ^ | + | * **type=" |
| - | | servo-pid-on | | | + | |
| - | | servo-pid-off | | | + | ++++ |
| - | | hw-pwm-inc | | | + | |
| - | | hw-pwm-dec | | | + | |
| - | | hw-dac-inc | | | + | |
| - | | hw-dac-dec | | | + | |
| - | | hw-direct- | | | + | |
| - | | thc-arc-voltage-ref-inc | | | + | |
| - | | thc-arc-voltage-ref-dec | | | + | |
| - | | thc-jog-speed-dec | | | + | |
| - | | thc-jog-speed-inc | | | + | |
| - | | thc-jog-pos | | | + | |
| - | | thc-jog-neg | | | + | |
| - | | dev-thc-jog-pos | | | + | |
| - | | dev-thc-jog-neg | | | + | |
| - | | toggle-widget-centring | | | + | ++++ Myscope (graphs and plots) |
| - | | toggle-widget-rotation | | | + | |
| - | | toggle-widget-sawcutting | | | + | |
| - | | toggle-widget-user | | | + | |
| - | | toggle-button-flood | | | + | The '' |
| - | | toggle-button-coolant | | | + | |
| - | | toggle-button-spindle | | | + | |
| - | | toggle-button-ccw-spindle | | | + | |
| - | | toggle-button-mist | | | + | |
| - | | < | + | |
| - | === PLC Actions === | + | {{: |
| + | Sample code to add a '' | ||
| - | ^ Action Name ^ Description ^ | + | < |
| - | | soft-plc-run: | | | + | width=" |
| - | | soft-plc-stop: | + | type=" |
| - | | *soft-plc-stop: | | | + | bgColor="## |
| - | | plc-run: | | | + | |
| - | | direct-plc: | | | + | |
| - | | multidev-plc-run: | + | |
| - | | switch-cnc-gvariable | | | + | |
| - | === Job Actions === | ||
| - | ^ Action Name ^ Description ^ | + | <gitem where=" |
| - | | direct-run: | | | + | name=" |
| - | | direct-run-confirm: | + | source=" |
| - | | radio-confirm | | | + | |
| - | | mode-cutting-ignore | | | + | |
| - | | mode-cutting-accept | | | + | |
| - | | mdi-save-list | | | + | * **where** indicated into which screen element the myscope graph will be inserted (in this example, it will be inserted into a border called '' |
| + | * **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 '' | ||
| + | * **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) | ||
| - | | mode-show-ruler | | | + | ^ Source ^ Description ^ |
| + | | adc0 | ADC #0. '' | ||
| + | | pwm0 | PWM #0. '' | ||
| + | | 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: | ||
| - | | mode-show-dimension | | | ||
| - | | mode-show-workarea | | | + | ++++ |
| + | ++++CentringView| | ||
| - | === OS/System Actions === | + | CentringView consists of the probe tools which allow to center the machine tool with regards to some obstacles. The window is brought up by clicking the Probe Sensor Window button: |
| - | ^ Action Name ^ Description ^ | + | {{: |
| - | | system-cmd | Run system command | | + | |
| - | | application-close | Close MyCNC application | | + | |
| - | | application-close-confirm | Run confirmation dialog to Close MyCNC application | | + | |
| - | | application-minimize | Minimize MyCNC Application | | + | |
| + | The code to insert such a window into the 1366M4 profile, the following code is used: | ||
| - | === CNC Variables manupulation Actions | + | <code XML> |
| + | <gitem where=" | ||
| + | position=" | ||
| + | action=" | ||
| + | </ | ||
| - | ^ Action Name ^ Description ^ | + | Note that this will bring up the x-centring.xml file which describes what is actually inside the CentringView widget. This code merely indicates that the Probe Sensor Window button is to be placed on the main screen, pressing which will, in turn, bring up the CentringView widget screen. |
| - | | direct-set-cnc-var | | | + | |
| - | | cnc-variable: | + | |
| - | | cnc-gvariable-dec, cnc-gvariable-inc | + | |
| - | | cnc-variable-dec, cnc-variable-inc, \\ cnc-variable-change, | + | |
| - | | cnc-vm-variable-dec, | + | |
| - | | device-variable-dec, | + | |
| - | | item-switch: | | | + | * **where** is set to "x-reserv" |
| - | | run-numpad: | | | + | * **image** is used for the button to indicate what the button action will be to the user |
| - | | item: | | | + | * **action** specifies the command which will be perform when the button is pressed (in this case, the button toggles the visibility of the x-centring widget (found in the x-centring.xml file) |
| - | | load-item: | | | + | * type is set to " |
| - | | cnc-nvariable- | | | + | ++++ |
| - | | cnc-nvariable: | + | |
| - | | fake | Empty Handler Action. Nothing happpens if run this action | + | ++++Rotation2View| |
| - | | myitem-value-inc, myitem-value-dec | Increement/ | + | Rotation2View is the window which allows to rotate the program part by some degree. It is brought up by clicking the Rotate button in the G-code tab on the main screen of myCNC software: |
| - | === HMI Actions === | + | {{: |
| + | The following window is brought up when clicking the button (window functions described [[mycnc: | ||
| - | ^ Action Name ^ Description ^ | + | {{:mycnc:screen-config-025-rotation2view.png}} |
| - | | search-nc-position | Open dialog to define line number for **Run From Here** command | | + | |
| - | | file-refresh | | | + | |
| - | | row-n-column | Open **Row And Column Multiplication/ | + | |
| - | | dialog-rotate | Open Dialog for NC-program rotation | | + | |
| - | | mypopup-show: | Show custom defined Popup widget | | + | |
| - | | mypopup-toggle: | Toggle custom defined Popup widget | | + | |
| - | | mode-jog-unlimited | Switch to Unlimited Jog Mode | | + | |
| - | | show-simple-edit | Show simple text editor window | + | |
| - | | show-simple2-edit | Show simple text editor window | + | |
| - | | rotate-nc-last | Rotage NC program to previously defined angle | | + | |
| - | | cnc-cutchart-save | Save current cutting data to Cutchart | | + | |
| - | | cnc-cutchart-load | Load cutting data for selected Cutting Mode | | + | |
| - | | run-from-here | **Run From Here** command | + | |
| + | This will bring up the x-rotate.xml file which further describes internals of the window. In order to simply add a button so that the overall window can be brought up, the following code can be used: | ||
| + | <code XML> | ||
| + | <gitem where=" | ||
| + | image=" | ||
| + | </ | ||
| + | * **where** points to the x-nclist widget (describe above) which inserts this button into it | ||
| + | * **position**, | ||
| + | * **action** specifies that pressing this button will toggle the x-rotate window visibility | ||
| + | * **type** is set to " | ||
| - | ==== MyCNC screen configuration examples ==== | + | Sample code for the rotation2view element: |
| - | [[mycnc-screen: | + | <gitem where=" |
| + | | ||
| + | | ||
| + | | ||
| + | | ||
| + | * **position** describes the XY location within the **where** element | ||
| + | * **width** and **height** describe the element' | ||
| + | * **table-rotation** sets the orientation of the table. //-90// and //90// are the typical values to rotate the orientation | ||
| + | * **type** is set to // | ||
| + | ++++ | ||
| - | === Add "Servo On" | + | ++++Timeview| |
| + | Timeview allows the user to add a clock within their myCNC software, for easy time monitoring (useful when program is in full-screen mode, for example). | ||
| - | We need to add buttons for Servo On/Servo Off to **1280M5** profile | + | Sample XML code: |
| - | Original screen is shown below- | + | <code XML> |
| + | <gitem where=" | ||
| + | height=" | ||
| + | </ | ||
| - | {{ mycnc-1280m5-001.png? | + | The following image provides an example of the '' |
| - | Put our new buttons instead of **CV** button | + | {{: |
| - | 1. Find **cnc-screen.xml** configuration file in **1280M5** profile folder | + | //NOTE: The timeview functionality is a remnant of older builds of myCNC software, and does not support font and background colour selection.// |
| - | 2. Edit the file (in Midnight commander press F4 on the **cnc-screen.xml** file) | + | ++++ |
| - | 3. Find in the file section with **CV** button definition (F7, search " | + | ++++time-display| |
| - | Here it is- | + | {{: |
| - | <code xml> | + | |
| - | <gitem where=" | + | |
| - | image=" | + | |
| - | xattr=" | + | |
| - | type=" | + | |
| - | </ | + | |
| - | 4. Put under this button small popup window which will be a container for two buttons | + | <code XML>< |
| - | Add **quick-popup-layout** section with popup window definition | + | |
| - | <code xml> | + | |
| - | <quick-popup-layout> | + | |
| - | < | + | name=" |
| - | <layout stretch="0" | + | bgColor="## |
| - | < | + | </gitem> |
| - | </layout> | + | |
| - | </ | + | <gitem where="map-z-frame" |
| + | | ||
| + | | ||
| + | type="time-display" | ||
| + | name="display-cnc-gvariable-6130" | ||
| + | </gitem> | ||
| </ | </ | ||
| - | * Layout for Servo buttons named " | ||
| - | * Layout contains a Window named " | ||
| - | 5. Fix **CV** button to show/hide **popup-servo** - | + | The time-display UI element allows the system to display a global variable (in case of this example, #6120 and #6130 for the working time of ATC Pots #1 and #2) in a 00:00:00 format. |
| + | ++++ | ||
| - | < | ||
| - | image=" | ||
| - | <code xml> | + | ++++ Password widget| |
| - | <gitem where=" | + | |
| - | image=" | + | |
| - | xattr=" | + | |
| - | type=" | + | |
| - | </ | + | |
| - | 6. Save **cnc-screen.xml**, | + | A password widget allows the user to create a hidden locked GUI element that is displayed after entering the correct password. This is similar to the [[mycnc: |
| - | {{ mycnc-1280m5-002.png? | + | When the element is clicked/ |
| - | 7. Add two buttons definition in the popup window | + | {{:mycnc: |
| - | <code xml> | + | |
| - | <gitem where=" | + | |
| - | height=" | + | |
| - | <gitem where=" | + | |
| - | height=" | + | |
| - | </ | + | |
| - | to prevent accidental servo driver activation add 1 sec delay for start button | + | A code example of such an element is displayed below. Note how there are two elements - the bdisplay element (for password entry) with a //cnc-password-widget-// action, and a second frame element with an ID (in this case, id=" |
| - | < | + | |
| - | action | + | |
| - | On button will ON relay #3 (M62.plc procedure) | + | |
| - | Off button will Off relay #3 (M63.plc procedure) | + | |
| - | For more complicated configurations special PLC procedure can be written to handle Servo ON/OFF (for example turn On servo power, wait some time and then check servo Fault/Alarm inputs before turn On **Servo On**) | + | < |
| + | | ||
| + | | ||
| + | | ||
| - | Result should be like this - | + | <gitem where=" |
| - | + | width=" | |
| - | {{ mycnc-1280m5-003.png?700 }} | + | |
| + | hidden=" | ||
| - | == button & xbutton types == | + | In the example above, the password is set to be **123**, and both the UI elements are located in the same " |
| - | Difference between **button** and **xbutton** push-button types easy to see if compare " | + | ++++ |
| - | XButton is simple Push button with added LED display on the top. Led parameters are given in attribute **xattr**. | + | |
| - | < | + | ++++ splitview | |
| - | xattr=" | + | |
| - | type=" | + | |
| - | </ | + | |
| - | In xattr programmed start x, y positions of Led inside the button, | + | <code XML>< |
| + | position=" | ||
| + | |||
| + | < | ||
| + | | ||
| + | ColorT0=" | ||
| + | ColorT4="# | ||
| + | HColorT0=" | ||
| + | | ||
| + | HColorT4="# | ||
| + | |||
| + | <gitem where=" | ||
| + | | ||
| + | | ||
| - | Custome defines skin from SVG file is possible too and will be described in other examples. | + | The '' |
| - | Attribute **name=" | + | The main feature |
| - | Attributes **address=" | + | ++++ |
| + | ==== MyCNC Actions ==== | ||
| - | To complete this example change led to show output pin #3 to show current servo state and resize the led - | + | All button-like screen components (button, xbutton, bdisplay, kspinbox2) run a **Handler** procedure when pressed or released event is activated by a mouse click or a touch screen tap. The Handler is defined in the " |
| - | <code xml> | + | ++++ List of general actions: | |
| - | <gitem where=" | + | |
| - | image=" | + | |
| - | xattr=" | + | |
| - | </ | + | |
| - | {{ mycnc-1280m5-004.png?700 }} | + | ^ Action Name ^ Description ^ |
| + | | advanced-config | Brings up the full configuration dialogs window (this is the window typically accessed through Settings > Config) | | ||
| + | | basic-config | Obsolete, was used to bring up a basic config settings window on some systems | | ||
| + | | toggle-button-coordinates | Special purpose action, used to toggle between displaying program and machine coordinates (only one set of coordinates would be shown at a time) | | ||
| + | | toggle-button-jog-enable | This toggle allows to enable/ | ||
| + | | toggle-button-soft-limits | This action will toggle whether the soft limits for the machine will be ON or OFF. This can also be done by heading into Settings > Config > Inputs/ | ||
| + | | toggle-button-mist | Coolant mist is toggled ON/OFF | | ||
| + | | toggle-button-flood | Coolant flood (liquid) is toggled ON/OFF | | ||
| + | | toggle-button-spindle | The spindle configuration uses the toggle-button-spindle and the toggle-button-ccw-spindle commands. By default, there are two commands sent to the spindle - power and direction. The power will cause the spindle to turn in the clockwise direction, while the ccw-spindle command will reverse the spin direction of the spindle. | | ||
| + | | toggle-button-ccw-spindle-spindle | Reverses the spin direction of the spindle (counter-clockwise instead of clockwise) | | ||
| + | | toggle-item: | ||
| + | | laser-marker- | Special purpose action reserved for laser marker machines. This action perform a test run in anticipation of the actual cutting process. | | ||
| + | | generate-pierce-array | EXPERIMENTAL FEATURE. This action goes through the control program and removes the cutting sections, leaving only the pierce points and idle movements between those points. Commisioned for a client' | ||
| + | | system-process | This is a command to the OS (rather than an internal myCNC command). | ||
| + | ++++ | ||
| - | == Add "Servo On" - "Servo Off" buttons (Version 2) == | + | ++++Items| |
| - | Just another way to add 2 buttons widget containers with 2 buttons. | + | Items are a subset of actions, and are written in the following form - item: |
| - | The same **1280M5** profile | + | |
| - | Original | + | Items are often presented to the user on the myCNC software |
| - | {{ mycnc-1280m5-001.png?700 }} | + | Items are typically used in conjunction with some input, as outlined in the Connections configuration dialog which can be found [[mycnc: |
| - | Put our new buttons instead | + | A list of commonly used items can be found in the [[mycnc: |
| + | ++++ | ||
| - | 1. Find **cnc-screen.xml** configuration file in **1280M5** profile folder | + | ++++ Player actions| |
| - | 2. Edit the file (in Midnight commander press F4 on the **cnc-screen.xml** file) | + | ^ Action Name ^ Description ^ |
| + | | player-play | Begins running | ||
| + | | player-play-confirm | Begins running the program after a confirmation popup has been clicked, to confirm that the user indeed wants to start the program run | | ||
| + | | player-play-edge | Begins running the program from the edge (done for plasma profiles on thick materials/ | ||
| + | | player-play-edge-confirm | Begins running the program from the edge after a confirmation popup to ensure that the user wants to start from the edge | | ||
| + | | player-jump1 | Special purpose command, done to jump to the first cutting/ | ||
| + | | player-pause | Pauses | ||
| + | | player-stop | Stops the program run. In myCNC, player-pause and player-stop are equivalent, as the controller remembers the machine position as the program is stopped, thus allowing it to serve as a pause | | ||
| + | | player-skip-forward | Skips to the next G-code command | | ||
| + | | player-skip-forward-10 | Skips 10 commands (forward direction) | | ||
| + | | player-skip-backward | Goes to the previous G-code command | | ||
| + | | player-skip-backward-10 | Skips 10 commands (backwards direction) | | ||
| + | | player-skip-part-f | Skips to the next part in the code | | ||
| + | | player-skip-part-b | Skips to the previous part in the code | | ||
| + | | player-nc-reset | Resets the program back to the beginning | | ||
| + | | player-nc-reset-confirm | Resets the program back to the beginning after asking for a confirmation in the form of a popup window | | ||
| + | | player-back-to-path | Goes back to path after a stop | | ||
| + | | player-back-to-path-confirm | Goes back to path, requires confirmation before the machine goes back to path | | ||
| + | | player-play-back | Runs the program backwards | | ||
| + | | player-simulate-forward | Simulate the program running forward in a simulation/ | ||
| + | | player-simulate-backward | Simulate the program running backward in a simulation/ | ||
| + | | player-nc-tie | Allows to tie a certain position to the reference zero program coordinate position. This allows to move the entire program around the cutting sheet. Useful when, for example, a single part needs to be cut out from a program made up from many different parts at a different location on the working material from that used originally (for example, if the first run was faulty). This calculates the difference of the current selected point and the zero program coordinate, and then interpolates the same difference between the new selected point and the new zero program coordinate, moving the whole program over. | | ||
| + | | player-play-step | Run through a single line of code (next line) | | ||
| + | | player-play-step-backward | Run through a single line of code (previous line) | | ||
| + | | mdi-play | If the Manual Data Input field is not presented as a separate window, it is possible to enter some MDI commands, and then keep them entered until they are required (no need to immediately execute them). This //mdi-play command// will execute the stored MDI process. NOTE: This is a special user case feature, typically // | ||
| + | | mdi-open | Opens the Manual Data Input window | | ||
| - | 3. Find in the file section with **CV** button definition (F7, search " | + | ++++ |
| - | Here it is- | + | ++++ Jog actions | |
| - | <code xml> | + | |
| - | <gitem where=" | + | |
| - | image=" | + | |
| - | xattr=" | + | |
| - | type=" | + | |
| - | </ | + | |
| - | 4. Put under this button small popup window which will be a container for two buttons | + | ^ Action Name ^ Description ^ |
| - | Add **mywidget** item - custom small widget with given attributes | + | | jog-0-plus, jog-1-plus, \\ jog-2-plus, jog-3-plus, \\ jog-4-plus, jog-5-plus, \\ jog-6-plus, jog-7-plus \\ jog-8-plus | Positive direction jog in the in the X, Y, Z, A, B, C, U, V, W axes | |
| - | <code xml> | + | | jog-0-minus, jog-1-minus, |
| - | <gitem where=" | + | | jog-0-plus-1-plus | Two-axes Jog, X+ Y+ | |
| - | type=" | + | | jog-0-plus-1-minus | Two-axes Jog, X+ Y- | |
| - | bgColor="# | + | | jog-0-minus-1-plus | Two-axes Jog, X- Y+ | |
| - | </code> | + | | jog-0-minus-1-minus | Two-axes Jog, X- Y- | |
| - | widget name: **toolbar-servo** | + | | jog-overspeed-inc \\ jog-overspeed-dec | Increment/Decrement Jog Overspeed value (%) - the default jog speed is set to be 100%. Safe range between 1% and 125%. | |
| + | | jog-overspeed-set: | ||
| + | ++++ | ||
| - | widget size: 80x160 exactly to fit 2 80x80 buttons in | + | ++++ Motion Settings Actions | |
| - | built-in led to show **output#0** state | + | ^ Action Name ^ Description ^ |
| + | | step-float-inc \\ step-float-dec | ||
| + | | step-size-inc \\ step-size-dec | ||
| + | | motion-linear-acceleration-inc \\ motion-linear-acceleration-dec | ||
| + | | motion-linear-jog-speed-inc \\ motion-linear-jog-speed-dec \\ motion-linear-jogspeed-inc \\ motion-linear-jogspeed-dec | Increase/ | ||
| + | | motion-jog-speed-x-inc, | ||
| + | | motion-rapid-speed-x-inc, | ||
| + | | motion-feed-speed-x-inc, | ||
| + | | motion-overspeed-inc \\ motion-overspeed-dec \\ motion-overspeed | Increase/ | ||
| + | | spindle-speed-inc \\ spindle-speed-dec \\ spindle-speed | Increase/ | ||
| + | | spindle-speed-restore | **Restore Default** Spindle Speed (S) | | ||
| + | | spindle-overspeed-inc \\ spindle-overspeed-dec \\ spindle-overspeed | Increase/ | ||
| - | 5. Fix **CV** button to show/hide **popup-servo** - | + | ++++ |
| - | < | + | ++++ Built-in Editor Actions | |
| - | image=" | + | |
| - | <code xml> | + | ^ Action Name ^ Description ^ |
| - | <gitem where=" | + | | editor-arrow-up | Go one line up in the code | |
| - | image=" | + | | editor-arrow-down | Go one line down in the code | |
| - | xattr=" | + | | editor-ncline-edit | Edits the current selected line of G-code | |
| - | type=" | + | | editor-ncline-insert | Inserts a line of code | |
| - | </code> | + | | editor-ncline-remove | Deletes the current selected line | |
| + | | editor-font-inc | Increase the font size for the editor G-code text | | ||
| + | | editor-font-dec | Decrease the font size for the editor G-code text | | ||
| + | | editor-numbers-toggle | Toggle the line number display to insert the current line number indicators into G-code | | ||
| + | | editor-selection-begin | Begin selection | | ||
| + | | editor-selection-end | End selection (the lines between the editor-selection-begin and editor-selection-end will be selected) | | ||
| + | | editor-selection-remove | Remove the selected lines | | ||
| + | | editor-selection-insert | Insert selected lines | | ||
| + | | editor-new | Create a new program file in the editor | | ||
| + | | editor-save-as | Save File As | | ||
| + | | editor-save | Save the editor file | | ||
| + | ++++ | ||
| - | 6. Save **cnc-screen.xml**, | + | ++++ File Manipulation Actions | |
| - | {{ mycnc-1280m5-002.png?700 }} | + | ^ Action Name ^ Description ^ |
| + | | save | Saves the file | | ||
| + | | open | Open selected file | | ||
| + | | load-file: | Load a file. This will load a file from the predefined folders which can be set in Config > Preferences > Common | | ||
| + | | load-macro: | A test debug feature. Allows to load the macros which are referenced in the imported G-code directly into the NCList window. In this way, instead of using a single macro number to refer to a specific macro, the full macros will be written out in the NCList.| | ||
| + | | file-close | Close the program file | | ||
| + | | dxf-import | Import a DXF file into myCNC | | ||
| + | | image-import | Import an image into myCNC | | ||
| - | 7. Add two buttons definition in the popup window. Definition is very similar to previous example but need to add button position attribute inside widget and button width/ | + | ++++ |
| - | <code xml> | + | |
| - | <gitem where=" | + | |
| - | image=" | + | |
| - | <gitem where=" | + | |
| - | image=" | + | |
| - | </ | + | |
| - | to prevent accidental servo driver activation add 1 sec delay for start button - | + | ++++ Visualization Actions | |
| - | < | + | |
| - | action function will be started only if the button press and hold for 1 sec (1000 msec). | + | |
| - | On button will run Servo-Pid-ON procedure | + | |
| - | Off button will run Servo-Pid-Off procedure | + | |
| - | Result should be like this - | + | ^ Action Name ^ Description ^ |
| - | + | | zoom-in | Zoom in on the visualization | | |
| - | {{ mycnc-1280m5-003.png?700 }} | + | | zoom-out | Zoom out on the visualization | |
| + | | fit-to-view | Fit the visualization into the screen | | ||
| + | | 3dview-xy | 3D Visualization: | ||
| + | | 3dview-xz | 3D Visualization: | ||
| + | | 3dview-yz | 3D Visualization: | ||
| + | | 3dview-iso | 3D Visualization: | ||
| + | | 3dview-custom: | 3D Visualization: | ||
| + | ++++ | ||
| + | ++++ Widget Manipulations Actions | | ||
| + | These actions allow to display widgets on the screen which are then used to change certain machine values/ | ||
| + | ^ Action Name ^ Description ^ | ||
| + | | show-inputbox | Obsolete version of the Manual Data Input | | ||
| + | | show-widget-centring | Shows the Centring widget (consists of probe widget command buttons to centre the tool with regard to some obstacles/ | ||
| + | | show-widget-rotation | Brings up the rotation2view window (typically the Rotate button is located in the G-code tab on the main screen) | | ||
| + | | show-widget-sawcutting | Brings up the sawcutting widget (obsolete on newer software) | | ||
| + | | show-widget-diagnose | Brings up the Diagnostics window | | ||
| + | | show-widget-config | Brings up the Config (full settings) window | | ||
| + | | show-widget-edit | Brings up the Edit widget screen, which allows to alter a G-code file before importing it into myCNC | | ||
| + | | show-widget-lib | Brings up the library window | | ||
| + | | show-widget-tools | Brings up the tools window/tab | | ||
| + | | show-widget-log | Brings up the log window (typically found in Settings > Log) | | ||
| + | | show-widget-report | Shows the report window (typically Settings > Report) | | ||
| + | | show-widget-support | Shows the support widget, which contains update options for the firmware, application and the profile used | | ||
| + | | show-widget-user | Shows the user settings window for that particular profile | | ||
| + | | show-widget-work | Brings up the work area (useful to return from a window like the Diagnostics window back to the main screen) | | ||
| + | | mywidget-show: | ||
| + | | mywidget-hide: | ||
| + | | mywidget-toggle: | ||
| + | | pendant-widget-open | Shows the pendant widget. This is typically used in older versions of the software (not on the 1366-series profile) to display a virtual pendant. | | ||
| + | | measure-surface | Obsolete. Reserved for surface measure commands on older versions of the software, newer versions have since switched to macros. | | ||
| + | | toggle-virtual-keyboard | Toggles the visibility of the virtual keyboard | | ||
| + | | mywidget: | Older version of the syntax for mywidget commands (still functional, but no longer developed further). The name of the widget would be set after the colon, and then, after a doubleslash, | ||
| - | == Add Window with some LEDs display == | + | ++++ |
| - | We need to add to the main screen a window with 8 led displays and some text labels to show the current state of inputs & outputs. | + | ++++ Application Actions | |
| - | We take **1280M5** profile as a base | + | |
| - | Original screen is - | + | ^ Action Name ^ Description ^ |
| + | | close-application | Close myCNC control software | | ||
| + | | cnc-config-save | Save myCNC configuration files to disk | | ||
| + | | system-process | Launch a system process / program by clicking a button within myCNC | | ||
| - | {{ mycnc-1280m5-002-1.png? | + | ++++ |
| - | Make the visualisation widget a little narrow and put the new window to the left side from visualization. | + | ++++ Hardware Manipulation actions | |
| - | Find " | + | |
| - | <code xml> | + | ^ Action Name ^ Description ^ |
| - | < | + | | servo-pid-on | Turns ON the Servo PIDs | |
| - | bgColor=" | + | | servo-pid-off | Turns OFF the Servo PIDs | |
| - | </code> | + | | hw-pwm-inc | Increases the PWM value in preset increments (currently, these increments are set to 20) | |
| + | | hw-pwm-dec | Decreases the PWM value in preset increments | | ||
| + | | hw-dac-inc | Increases the DAC value in preset increments | | ||
| + | | hw-dac-dec | Decreases the DAC value in preset increments | | ||
| + | | hw-direct-binary-set- | Directly sets an output value (for example, // | ||
| + | | hw-direct-binary-clear- | Directly clears an output value (for example, | ||
| + | | thc-arc-voltage-ref-inc | Increases the reference arc voltage value | | ||
| + | | thc-arc-voltage-ref-dec | Decreases the reference arc voltage value | | ||
| + | | thc-jog-speed-dec | Decreases the THC jog speed | | ||
| + | | thc-jog-speed-inc | Increases the THC jog speed | | ||
| + | | <del>thc-jog-pos</ | ||
| + | | < | ||
| + | | dev-thc-jog-pos | Multidevice positive direction Torch Height Control jog | | ||
| + | | dev-thc-jog-neg | Multidevice negative direction Torch Height Control jog | | ||
| - | to: | + | | toggle-widget-centring | Toggles the centring widget visibility on/off (centring widget |
| - | <code xml> | + | | toggle-widget-rotation | Toggles the rotation widget visibility on/off | |
| - | <gitem where=" | + | | toggle-widget-sawcutting | Toggles the sawcutting widget visibility on/off (obsolete on newer software versions) | |
| - | bgColor="# | + | | toggle-widget-user | Toggles the user settings widget visibility on/off | |
| - | <gitem where=" | + | |
| - | bgColor="# | + | |
| - | </code> | + | |
| - | Result is - | + | | toggle-button-flood | Toggles the flood state on/off (liquid) | |
| + | | toggle-button-coolant | Toggles the coolant state on/off | | ||
| + | | toggle-button-spindle | Toggles the spindle on/off state. This will cause the spindle to either not spin, or spin in the clockwise direction. | | ||
| + | | toggle-button-ccw-spindle | Toggles the reversal of spindle direction from clockwise to counterclockwise | | ||
| + | | toggle-button-mist | Toggles the mist state on/off | | ||
| + | | < | ||
| + | ++++ | ||
| - | {{ mycnc-1280m5-002-2.png? | + | ++++ PLC Actions | |
| - | Add 1st line label and leds from laft and right sides: | ||
| - | <code xml> | + | ^ Action Name ^ Description ^ |
| - | <gitem inversion=" | + | | soft-plc-run: | Runs software PLC commands | |
| - | address=" | + | | soft-plc-stop: |
| - | <gitem inversion=" | + | | *soft-plc-stop: | Stops both a software PLC process and the program itself from running | |
| - | displayWidth=" | + | | plc-run: | Runs a Hardware PLC process | |
| - | address="outputs" | + | | direct-plc: | Same as plc-run (either of these commands can be used) - runs Hardware PLC | |
| - | < | + | | multidev-plc-run: |
| - | < | + | | switch-cnc-gvariable | Switches a gvariable value between some data on a loop (for example, on every button press a gvariable gets assigned the next value from the data list). This syntax is not used in the newer projects, cnc-gvariable-switch, |
| - | </ | + | | cnc-gvariable-switch | Newer syntax for a global variable switch between values from a data set. Data points will be written separated by a comma, and the next value in the list will be taken on every switch command | |
| - | </ | + | | cnc-gvariable-toggle | Toggles a global variable (writes 0 or 1 into the global variable, depending on the previous value) | |
| + | | cnc-gvariable-set | Set a variable (write a "1" | ||
| + | | cnc-gvariable-vset | Value set (write some value to a variable) | | ||
| + | | cnc-gvariable-clear | Clears the value of a global variable | | ||
| + | | cnc-gvariable-clr | Clears the value of a global variable | | ||
| + | ++++ | ||
| - | **where=" | + | ++++ Job Actions | |
| - | **address=" | + | ^ Action Name ^ Description ^ |
| + | | direct-run: | Allows for a direct run of a command from a BDisplay element. This will allow for a direct command which will be executed when a BDisplay element is clicked/ | ||
| + | | direct-run-confirm: | ||
| + | | radio-confirm | Used for RadioDisplay elements to bring up a popup to ask the user to confirm whether the value should be changed before taking action | | ||
| + | | mode-cutting-ignore | Ignores cutting commands to simply move over the material to check the machine movement path. Replaced by global variable #7530 in the more recent profiles (1366 series) | | ||
| + | | mode-cutting-accept | Accepts cutting commands from the control program | | ||
| - | **<gitem inversion=" | + | | mdi-save-list | Reserved for a procedure in which a series of commands are entered through the Manual Data Input process, and which are then saved as a command list in a file. Contact myCNC Support for more information on this action. | |
| - | address=" | + | |
| - | - fisrt (left) led is single, no text label assigned | + | |
| - | + | ||
| - | **< | + | |
| - | **position=" | + | | mode-show-ruler | Shows a ruler in the visualization window which indicates the 2D part's dimensions (width/ |
| - | + | ||
| - | Result is - | + | |
| - | {{ mycnc-1280m5-002-3.png? | + | |
| - | Add some more LEDs to the widget. Complete code for the widget is - | + | | mode-show-dimension | Shows the overall dimensions of the part on the program visualization screen (width/ |
| - | <code xml> | + | | mode-show-workarea | Shows a box around the program visualization which will denote the work area (useful to see the minimum material dimensions necessary to fit the entire program file in) | |
| - | <gitem where=" | + | |
| - | name=" | + | |
| - | <gitem inversion=" | + | ++++ |
| - | height=" | + | |
| - | <gitem inversion=" | + | ++++ OS/System Actions | |
| - | displayWidth=" | + | |
| - | labelFontSize=" | + | |
| - | < | + | |
| - | < | + | |
| - | </ | + | |
| - | <gitem inversion=" | + | ^ Action Name ^ Description ^ |
| - | | + | | system-cmd | Run a system command | |
| + | | application-close | Close MyCNC application | | ||
| + | | application-close-confirm | Run confirmation dialog to Close MyCNC application (will ask the user to confirm via a popup window before closing the application) | | ||
| + | | application-minimize | Minimize MyCNC Application | | ||
| - | <gitem inversion=" | + | ++++ |
| - | displayWidth=" | + | |
| - | labelFontSize=" | + | |
| - | < | + | |
| - | < | + | |
| - | </ | + | |
| - | <gitem inversion=" | + | ++++ CNC Variables manupulation Actions | |
| - | height=" | + | |
| - | <gitem inversion=" | + | ^ Action Name ^ Description ^ |
| - | | + | | <del> |
| - | | + | | < |
| - | <message>Pedal</message> | + | | cnc-gvariable-dec, |
| - | <message_ru>Педаль</message_ru> | + | | <del>cnc-variable-change, |
| - | </gitem> | + | | <del>cnc-vm-variable-dec, |
| + | | < | ||
| - | <gitem inversion=" | + | | item-switch: | Used to switch between different values/labels for a certain item (allows to switch between options on a preset list) | |
| - | height=" | + | | run-numpad: | Opens the numpad widget | |
| + | | item: | See [[mycnc: | ||
| - | <gitem inversion=" | + | | fake | Empty Handler Action. Nothing happens when you run this action. | |
| - | displayWidth=" | + | |
| - | labelFontSize=" | + | |
| - | < | + | |
| - | < | + | |
| - | </ | + | |
| - | </ | + | |
| - | Result is | + | | myitem-value-inc, myitem-value-dec | Increement/ |
| - | {{ mycnc-1280m5-002-4.png? | + | ++++ |
| - | == Add Button with led display, that toggles Global Variable value and shows the current state == | + | ++++ HMI Actions | |
| - | For described example machine runs the same g-code on left and right sides of the machine table. To increase | + | ^ Action Name ^ Description ^ |
| + | | search-nc-position | Opens a dialog window to locate | ||
| + | | file-refresh | Refresh | ||
| + | | row-n-column | Open **Row And Column Multiplication/ | ||
| + | | dialog-rotate | Open Dialog for the program rotation | | ||
| + | | mypopup-show: | ||
| + | | mypopup-toggle: | ||
| + | | mode-jog-unlimited | Switch to Unlimited Jog Mode | | ||
| + | | show-simple-edit | Show simple text editor window | ||
| + | | show-simple2-edit | Show simple text editor window | ||
| + | | rotate-nc-last | Rotage NC program to previously defined angle | | ||
| + | | cnc-cutchart-save | Save the current cutting data to the Cutchart | | ||
| + | | cnc-cutchart-load | Load cutting data for selected Cutting Mode | | ||
| + | | run-from-here | **Run From Here** command - start job from the selected line | | ||
| - | Global variable #500 contains Current active side machine works (or going to work) with. | + | ++++ |
| - | Variable value- | + | |
| - | 0 - means machine works (or will start to work) with the left side, | + | === Actions Examples === |
| - | 1 - means machine works on the right side. | + | ++++ system-process | |
| - | + | ||
| - | We add a button to toggle current side. We add on-button indication and add LED displays to show current working side. | + | |
| - | Button definition is shown below - | + | < |
| - | < | + | |
| - | | + | |
| - | action=" | + | < |
| - | </code | + | </ |
| - | Led displays | + | The '' |
| - | <code xml> | + | |
| - | <gitem inversion="no" | + | |
| - | shape=" | + | |
| - | <gitem inversion=" | + | |
| - | shape=" | + | |
| - | </ | + | |
| - | Result is - | + | The example above sends a '' |
| - | {{ mycnc-1280m5-001-9.png? | ||
| + | <code XML> action=" | ||
| - | To add " | + | For the program launch (system-process) command listed above, '' |
| - | change type < | + | |
| - | add xattr=" | + | |
| - | add name=" | + | |
| - | add image files array - images=" | + | |
| - | images to show Variable state have the same size as the button itself, so image **--left** or **--right** will be drawn on the top of the button image. | + | For the example above, make sure to enable the " |
| - | Images for button base, "the left state" and "the right state" are | + | ++++ |
| - | {{left-right.png? | + | ====Style==== |
| - | {{left.png? | + | |
| - | {{right.png? | + | |
| - | code for button definition is - | + | The stylesheet specifies the fundamentals of the myCNC Graphical User Interface, and can be changed in //Settings > Config > Screen//: |
| + | {{: | ||
| - | <code xml> | + | The "x" |
| - | <gitem where="led-panel" | + | |
| - | type=" | + | |
| - | images=" | + | |
| - | </ | + | |
| - | Result screen is - | + | // |
| - | {{ mycnc-1280m5-001-10.png?700 }} | + | An example of the x.style file is shown below: |
| + | ++++ Expand code | | ||
| + | < | ||
| + | { | ||
| + | border: 4px solid ## | ||
| + | border-radius: | ||
| + | // | ||
| + | padding: 0px 0px 0px 0px; | ||
| + | } | ||
| + | QHeaderView, | ||
| + | { | ||
| + | border: 1px solid ## | ||
| + | border-radius: | ||
| + | border-style: | ||
| + | padding: 0px 0px 0px 0px; | ||
| - | == Add Buttons with LED display that runs PLC procedures and shows Output pin state == | + | font: bold 14px; |
| + | font-family: | ||
| - | We need to add 2 buttons on GUI main screen to fill up and drain water from plasma cutting machine water table. | + | } |
| - | {{water-up.png}} | + | QComboBox |
| - | {{water-down.png}} | + | |
| - | Need to add the button to the right from **Palnik ON** button | + | font: bold 14px; |
| - | {{ eco-001.jpg }} | + | font-family: |
| + | height: | ||
| + | selection-background-color: | ||
| + | selection-color: | ||
| + | border: 1px solid ##b-border; | ||
| + | border-radius: 1px; } | ||
| - | Goto cnc-screen.xml in profile folder, find " | ||
| - | <code xml> | ||
| - | <gitem where=" | ||
| - | image=" | ||
| - | <gitem where=" | + | QLineEdit, QSpinBox |
| - | fgColor=" | + | { |
| - | fontSize=" | + | font-size: bold 16px; |
| - | < | + | font-family: |
| - | < | + | height:24px; |
| - | < | + | selection-background-color: |
| - | </ | + | selection-color: |
| - | </ | + | border: 1px solid ##b-border; |
| + | border-radius: | ||
| + | } | ||
| - | **where=" | ||
| - | **position=" | ||
| - | We need to add 2 buttons just after it - | + | StatusBar, SLabel |
| + | { | ||
| + | font-size: 14px; | ||
| + | font-family: | ||
| + | background: ##b-main; | ||
| + | color: ##f-widget; | ||
| + | } | ||
| - | <code xml> | + | S2Label |
| - | <gitem where=" | + | { |
| - | action=" | + | background: ##b-main; |
| - | <gitem where=" | + | color: ##f-widget; |
| - | labelFgColor=" | + | } |
| - | fontStyle=" | + | |
| - | < | + | |
| - | < | + | |
| - | </ | + | |
| - | <gitem where=" | ||
| - | action=" | ||
| - | <gitem where=" | ||
| - | labelFgColor=" | ||
| - | labelAlignment=" | ||
| - | < | ||
| - | < | ||
| - | </ | ||
| - | </ | ||
| - | Result is - | + | QHeaderView:: |
| + | QListView, QTreeView, KSvgToggleSwitch, | ||
| + | K45SideSelection, | ||
| + | QTableView, MyTabWidget, | ||
| + | NWidget, SWidget, QListWidget | ||
| + | { | ||
| + | background: ##b-main; | ||
| + | color: ##f-widget; | ||
| + | } | ||
| - | {{ mycnc-1280m5-001-7.png? | ||
| - | Out pin #13 controls Water Fill, | + | // |
| - | Out pin #12 controls Water Drain | + | //font-family: "Open Sans"; |
| - | | + | |
| - | Add LEDs display to the buttons | + | |
| - | 1. Change type from " | + | KWidget |
| - | 2. Add **xatrr** attribute to buttons definition with LEDs position, width, height, colour and shape | + | { |
| - | 3. Add to button definition attribute address=" | + | font: bold 14px; |
| + | font-family: | ||
| - | <code xml> | + | background: ##b-main; |
| - | <gitem where=" | + | color: ##f-widget; |
| - | action=" | + | } |
| - | type=" | + | |
| - | <gitem where=" | + | |
| - | action=" | + | |
| - | type=" | + | |
| - | </ | + | |
| - | Result is - | + | MessageLabel |
| + | { | ||
| + | font: bold 16px; | ||
| + | font-family: "Open Sans"; | ||
| - | {{ mycnc-1280m5-001-8.png? | + | background: ##b-main; |
| + | color: ##f-widget; | ||
| + | } | ||
| - | To control Water Fill/Drain PLC procedure M240 with parameter " | + | NCListView |
| - | PLC procedure M240 is described [[plc:plc_examples# | + | { |
| + | background: transparent; | ||
| + | color: blue; | ||
| + | selection-color: | ||
| + | selection0background-color: | ||
| + | } | ||
| + | NCListView:: | ||
| + | { | ||
| + | background: blue; | ||
| + | color: blue; | ||
| + | } | ||
| - | == Add display to show current PLC status for Gas Cutting == | ||
| - | We will fix **1024G** profile. The main screen of the profile is shown below. | ||
| - | {{ mycnc-1024g-001.png?700 }} | + | QTableView |
| - | Put PLC process display to the top of the empty area next to "THC Speed" display. | + | QRadioButton |
| + | { | ||
| + | height: | ||
| + | color: ##f-widget; | ||
| + | selection-background-color: | ||
| + | selection-color: | ||
| + | //border: 2px solid ##b-border; border-radius: | ||
| + | } | ||
| - | To add the display - | + | QRadioButton:: |
| - | * find and open to edit " | + | |
| - | * find reference "THC Speed" display - <code xml> | + | |
| - | <gitem fgColor=" | + | |
| - | type=" | + | |
| - | displayWidth=" | + | |
| - | < | + | |
| - | < | + | |
| - | </ | + | |
| - | * Add new display (easy way to copy-paste "THC Speed" display and edit it. | + | |
| - | * Remove " | + | |
| - | * Add " | + | |
| - | * Change type - < | + | |
| - | * Edit " | + | |
| - | * Translate text inside format attribute if need local language messages - < | + | |
| - | * Edit bgColor, fgColor, fontSize attributes to get nice looking display | + | |
| - | A complete code - | ||
| - | <code xml> | ||
| - | <gitem fgColor=" | ||
| - | type=" | ||
| - | height=" | ||
| - | fontStyle=" | ||
| - | < | ||
| - | < | ||
| - | </ | ||
| - | Screen result is - | ||
| - | {{ mycnc-1024g-001-1.png? | ||
| - | == Add "Move A to 0" button to run macro with confirmation == | ||
| - | {{ mycnc: | ||
| - | For machines with rotational axes it is convenient to have similar button to move rotational axis **A** to work 0. | ||
| - | We add this button | + | QSpinBox:: |
| - | Here is **Move To 0** definition | + | QSpinBox:: |
| - | <code xml>< | ||
| - | where=" | ||
| - | image=" | ||
| - | action=" | ||
| - | position=" | ||
| - | < | ||
| - | < | ||
| - | </ | ||
| - | </ | ||
| - | Add on the left **Move To A** definition - | ||
| - | <code xml>< | + | QComboBox QListView:: |
| - | where=" | + | QComboBox:: |
| - | image=" | + | |
| - | action=" | + | |
| - | position=" | + | |
| - | <message-confirm> | + | |
| - | < | + | |
| - | </ | + | |
| - | </ | + | |
| - | * **type=" | ||
| - | * **where=" | ||
| - | * **image=" | ||
| - | * **action=" | ||
| - | * **direct-run-confirm: | ||
| - | * run G-code sequence (**";" | ||
| - | * **position=" | ||
| - | * **< | ||
| - | * **< | ||
| - | {{ mycnc:mycnc-move-to-a-0-1.png? | + | QTreeView, QComboBox |
| - | Screen with **Move To A** button | + | alternate-background-color: ##grid-color; |
| + | } | ||
| - | {{ mycnc:mycnc-move-to-a-0-2.png?700 }}Message Box when **Move To A** button pressed | + | QListView:: |
| + | QTreeView:: | ||
| + | QTreeView:: | ||
| + | { | ||
| + | selection-color:white; | ||
| + | selection-background-color: rgb(150, | ||
| + | } | ||
| - | If button OK pressed on Message Box, g-code line **M335** (which is macro actually) will be executed to move A axs to zero. | ||
| - | [[mycnc::move-a-to-0|M335 macro to move A to zero is described here]] | + | QCheckBox {padding: 0px 0px 0px 0px; spacing: 5px; } |
| + | QCheckBox:: | ||
| + | QCheckBox:: | ||
| + | QCheckBox:: | ||
| + | QPushButton | ||
| + | {color: ## | ||
| + | border-color: | ||
| + | QPushButton: | ||
| + | QPushButton: | ||
| - | == Add Centring Widget on main GUI screen == | + | QTabWidget:: |
| - | myCNC software has Centring widget to work with probing sensor and find internal and external centers, edges, corners on parts. | + | QTabWidget:: |
| - | {{ mycnc:mycnc-probing-001.png?500 }} | + | |
| - | Fig. Centring Widget | + | |
| - | There is just 1 line to configure Centring Widget in cnc-screen.xml configuration file. | + | QTabBar:: |
| - | <code xml>< | + | color: ##button-fg; |
| - | bsize=" | + | background: ##b-main; |
| - | position=" | + | border: 2px solid ##b-border; border-bottom-color: |
| - | hidden=" | + | |
| - | bgColor=" | + | |
| - | * **type=" | + | //MyTabBar { font: bold 14px; } |
| - | * **where=" | + | |
| - | * **bsize=" | + | |
| - | * **position=" | + | |
| - | * **hidden=" | + | |
| - | * **bgColor="# | + | |
| - | Centring Widget takes a lot of space on the GUI screen, so it's convenient to have it hidden while normal work and show the widget only when work with Probe sensor. | + | QTabBar:: |
| - | To show/hide Centring Widget usually used on-screen button. | + | QTabBar:: |
| - | <code xml>< | + | border-color: ##selected-border; |
| - | image=" | + | border-bottom-color: ##selected-border; |
| - | where=" | + | QTabBar:: |
| - | position=" | + | |
| - | * **type=" | + | |
| - | * **image=" | + | |
| - | | + | |
| - | * **where=" | + | |
| - | * **position=" | + | |
| - | {{ mycnc:mycnc-centring-01.png?700 }} | + | Notice that in the example above, the NCListView (the window that displays the G-code for the loaded control program) has been customized to feature a transparent background. In a similar way, other low-level GUI elements can be edited with custom colours that cannot othewise be accessed via the user-facing settings panel in myCNC Settings > Config > Screen > Colors. |
| - | {{ mycnc:mycnc-centring-01-1.png?700 }} | + | |
| + | |||
| + | ====Fonts==== | ||
| + | |||
| + | For the default profiles to align the text properly, Google' | ||
| + | |||
| + | ==== MyCNC screen configuration examples ==== | ||
| + | The examples for the screen configuration can be found here: [[mycnc: | ||
mycnc/mycnc_screen_configuration.1538405179.txt.gz · Last modified: 2018/10/01 10:46 by skirillov