INI Settings¶
Note
The following Flex GUI settings are all located in the [DISPLAY] section of your LinuxCNC .ini file.
[EMC]¶
The optional DEBUG key in the [EMC] section can be used to show various levels of debug information when running in a terminal. The DEBUG key is not required.
DEBUG = option number
Debug Options
EMC_DEBUG_CONFIG 2
EMC_DEBUG_VERSIONS 8
EMC_DEBUG_TASK_ISSUE 10
EMC_DEBUG_NML 40
EMC_DEBUG_MOTION_TIME 80
EMC_DEBUG_INTERP 100
EMC_DEBUG_RCS 200
EMC_DEBUG_INTERP_LIST 800
EMC_DEBUG_IOCONTROL 1000
EMC_DEBUG_OWORD 2000
EMC_DEBUG_REMAP 4000
EMC_DEBUG_PYTHON 8000
EMC_DEBUG_NAMEDPARAM 10000
EMC_DEBUG_GDBONSIGNAL 20000
EMC_DEBUG_STATE_TAGS 80000
EMC_DEBUG_UNCONDITIONAL 40000000
EMC_DEBUG_ALL 7FFFFFFF
[DISPLAY]¶
Flex GUI¶
To use the Flex GUI (as opposed to Axis or others), change the DISPLAY value to
DISPLAY = flexgui
If no GUI is specified then the default GUI will be used.
Note
Any Flex GUI .ui and .qss files must be in the same LinuxCNC configuration directory as the .ini file.
To use your .ui file (created with Qt Designer), add a GUI key to the .ini with its filename:
GUI = my-file-name.ui
Jog Increments¶
The following settings can be used in the [DISPLAY] section of the ini file to preset jog items
INCREMENTS = 0.100, 0.010, 0.001
or
INCREMENTS = 1 inch, 0.5 in, 1 cm, 1 mm
MIN_LINEAR_VELOCITY = 0.1
MAX_LINEAR_VELOCITY = 1.0
DEFAULT_LINEAR_VELOCITY = 0.2
Warning
[DISPLAY] INCREMENTS must be a comma seperated list or it will be ignored.
Note
Jog incremnts can have unit labels, the following are valid unit labels cm, mm, um, inch, in or mil. If no unit labels are found the the configuration units are used.
Startup File¶
To automatically open a NC file on startup, add the OPEN_FILE key with any valid path. Use ~/ as a shortcut to the users home directory. Use ./ to indicate that the file is in the configuration directory
Full Path to the file
OPEN_FILE = /home/john/linuxcnc/configs/myconfig/welcome.ngc
or use the ~ for the users home directory
OPEN_FILE = ~/linuxcnc/configs/flex_examples/probe_sim/square.ngc
or use the ./ to use the current configuration directory
OPEN_FILE = ./welcome.ngc
or use the ../ to use the parent directory of the configuration
OPEN_FILE = ../welcome.ngc
File Location¶
Likewise, to specify a default location for NC files, add the PROGRAM_PREFIX item.
PROGRAM_PREFIX = /home/john/linuxcnc/configs/myconfig
or
PROGRAM_PREFIX = ~/linuxcnc/configs/flex_examples/probe_sim
or
PROGRAM_PREFIX = ./
or
PROGRAM_PREFIX = ../
Tool Table Editor¶
To specify a different tool table editor add an entry to the [DISPLAY] section. If no entry is found then the default tool editor is used
TOOL_EDITOR = tooledit
To control the columns displayed by the default tool editor add any of the valid column specifiers separated by a space.
TOOL_EDITOR = tooledit x y z a b c u v w diam front back orien
If no entry is found then the axes in the configuration and diameter are shown. Tool, Pocket and Comment are always shown.
File Extensions¶
The keyboard file dialog defaults to *.ngc and this ignores case. To specify the file extensions you want the file dialog to show, add an EXTENSIONS key with the desired extensions separated by a comma. The extensions must be in the format *.ext with the asterisk and dot
EXTENSIONS = `*.nc`, `*.G-code`, `*.ngc`, `*.txt`
[FLEXGUI]¶
Themes¶
Themes are just style sheets that get applied to the widgets. The theme files are in the themes directory of the example files if you want to copy and customize one of the themes.
blue.qss
blue-touch.qss
dark.qss
dark-touch.qss
keyboard.qss
touch.qss
To use a built-in theme with no color changes add one of the following to the [FLEXGUI] section of the ini file.
THEME = touch
THEME = keyboard
To use a built in theme with coloring add one of the following to the [FLEXGUI] section of the ini file.
THEME = blue
THEME = blue-touch
THEME = dark
THEME = dark-touch
Note
Touch themes use tabs set to South for rounding and non touch use tabs set to North.
Note
THEME is checked first then QSS so the first entry found is used.
To use a custom .qss style sheet you created add the name of the stylesheet to the QSS option in [FLEXGUI] section of the ini file.
QSS = name_of_stylesheet.qss
For more information on style sheets see StyleSheet
Resource File¶
To use a .py resource file (to add images to buttons with your qss stylesheet) place the .py resource file in the configuration directory and add the following line to the .ini file
RESOURCES = resources.py
See the section on Resources for more info.
Screen Size¶
To control the initial size of the screen, add of the following values.
SIZE = minimized
SIZE = normal
SIZE = maximized
SIZE = full
Note
the values are case sensitive
Warning
Full size screen does not have any window controls. Make sure there is a way to close the GUI like an Exit button or you may not be able to close the application. As a last-resort, pressing ALT-F4 will close it.
Plotter¶
The plotter background color can be set in the [FLEXGUI] section of the ini. The value is the Red,Green,Blue color numbers from 0 to 1 with no space. So an entry of 0.0,0.0,0.0 is black and 1.0,1.0,1.0 is white. Use a RGB 0-1 Color Picker to select the RGB values.
[FLEXGUI]
PLOT_BACKGROUND_COLOR = 0.0,0.0,0.0
The plotter orientation can be set to one of the following x, x2, y, y2, z, or p.
[DISPLAY]
VIEW = x
The font size for the plotter can be set in the ini by adding the following to the FLEXGUI section. The font size must be an integer.
[FLEXGUI]
DRO_FONT_SIZE = 12
Colors¶
The E-Stop can have a static color for Open and Closed.
The Power Button can have a static color for Off and On.
Create a key in the ini file called FLEXGUI and use the following to control the static color of these items. The value can be any valid color specification in the RGB, RGBA or Hex color format.
[FLEXGUI]
ESTOP_OPEN_COLOR = 128, 255, 128
ESTOP_CLOSED_COLOR = 255, 77, 77
POWER_OFF_COLOR = 255, 128, 128
POWER_ON_COLOR = #00FF00
PROBE_ENABLE_ON_COLOR = 255, 0, 0, 255
PROBE_ENABLE_OFF_COLOR = 0, 125, 0, 125
Note
Color pairs need to have both colors specified or the color will only toggle once.
Another way to achieve this is is via adding and editing a .qss stylesheet file. See the StyleSheet section for more info.
LED Defaults¶
LED buttons can have defaults set in the ini file. This makes it easier to have consistent LED size, position and colors. These options go in the [FLEXGUI] section.
The color options can be specified using HEX, RGB or RGBA.
Valid RGB(A) Red, Green, Blue (Alpha) values are 0 to 255.
Valid HEX values are #000000 to #ffffff
In PyQt6 the Alpha channel is 0 to 255. 0 represents a fully transparent color, while 255 represents a fully opaque color. If Alpha is ommitted then it’s set to fully opaque or 255.
The Diameter and Offset values are whole numbers only.
[FLEXGUI]
LED_DIAMETER = 15
LED_RIGHT_OFFSET = 5
LED_TOP_OFFSET = 5
LED_ON_COLOR = 0, 255, 0
LED_OFF_COLOR= 125, 0, 0, 255
For more information on LED buttons see LED Buttons
Touch Screens¶
Options for touch screen users.
Set the touch screen file chooser to automatically adjust the width by adding the following to the FLEXGUI section.
[FLEXGUI]
TOUCH_FILE_WIDTH = True
Add popup keypad to all spin boxes.
[FLEXGUI]
TOUCH_SPINBOX = True
To add a manual tool change popup to add the following to the ini file in the [FLEXGUI] section.
[FLEXGUI]
MANUAL_TOOL_CHANGE = True