Gmoccapy

LinuxCNCKnowledgeBase | RecentChanges | PageIndex | Preferences | LinuxCNC.org

Difference (from prior major revision) (author diff)

Removed: 9,1092d8

gmoccapy - A GUI for linuxcnc written in Python

gmoccapy is a GUI for linuxcnc, designed to be used with a touch screen,

but can also be used on normal screens with a mouse or hardware buttons and MPG wheels,

as it presents HAL Pins for the most common needs. Please find more information in the following.

It offers the possibility to display up to 4 axis, support a lathe mode for normal and back tool lathe

and can be adapted to nearly every need, because gmoccapy supports embedded tabs and side panels. As a good example for that see [gmoccapy_plasma]

It has an integrated onboard keyboard, so there is no need for a hardware keyboard or mouse, but it can also be used with that hardware.

gmoccapy offers a separate settings page to configure most settings of the GUI without editing files.

gmoccapy can be localized very easy, because the corresponding files are separated from the linuxcnc.po files, so there is no need to translate unneeded stuff.

The files are placed in /src/po/gmoccapy. Just copy the gmoccapy.pot file to something like fr.po and translate that file with gtranslator or poedit. After a make you got the GUI in your referenced language

At the Moment it is available in English, German, Spanish and Serbian. Feel free to help me to introduce more languages.

If you need help, don't hesitate to ask.

<toc>

1. Requirements

Gmoccapy has been tested on UBUNTU 10.04 and 12.04 and DEBIAN Wheesy, if you use other versions, please inform about problems or solutions on the forum:

in German [Peters CNC Ecke]

in English [gmoccapy on linuxcnc]

The minimum screen resolution for gmoccapy, using it without side panels is 979 x 750 Pixel, so it should fit to every standard screen.

2. How to get gmoccapy ==

# For users ===
Beginning with Linuxcnc 2.6 gmoccapy is included in the standard installation. So the easiest way to get gmoccapy on you controlling PC, is just to get the [actual ISO] and install from the CD / DVD.

If you do have already installed a earlier Linuxcnc version, check how to update [here]

2.1. For developers

If you want to get actual sources for development reasons, you should get a copy of the master git repository.

If you are not familiar with git and linux, please read:
[git]

or trust me and do the following in a terminal:

For UBUNTU 10.04 do:

sudo apt-get install git-core gitk git-gui
git config --global user.name "Your full name"
git config --global user.email "you@example.com"
git clone git://git.linuxcnc.org/git/linuxcnc.git linuxcnc-dev
sudo apt-get install libboost-python-dev libmodbus-dev libusb-1.0-0-dev
cd linuxcnc-dev
cd src
./autogen.sh
./configure
make
sudo make setuid
cd ..
. ./scripts/rip-environment
linuxcnc

and select sim gmoccapy and a sub configuration, the best place to begin is just gmoccapy

If you are using the actual DEBIAN Wheesy Linuxcnc iso, you will have to install some more packages

sudo apt-get install git-core gitk git-gui
git config --global user.name "Your full name"
git config --global user.email "you@example.com"
git clone git://git.linuxcnc.org/git/linuxcnc.git linuxcnc-dev
sudo apt-get install libboost-python1.49-dev libmodbus-dev libusb-1.0-0-dev libxmu-dev libglu1-mesa-dev libgl1-mesa-dev libreadline-dev tcl8.5-dev tk8.5-dev
cd linuxcnc-dev
cd src
./autogen.sh
./configure
make
sudo make setuid
cd ..
. ./scripts/rip-environment
linuxcnc

and select sim gmoccapy and a sub configuration, the best place to begin is just gmoccapy

You will get the following screen if your locale settings is de (German):

3. How to update gmoccapy ==

# For users ===
Just do an update using your deb package tool like synaptic.

3.1. For developers

You will have to do at least:

cd linuxcnc-dev
cd src
git pull
make
cd ..
. ./scripts/rip-environment
linuxcnc

if there are mayor changes it can also be necessary to do the complete compiling like so:

cd linuxcnc-dev
cd src
make clean
./autogen.sh
./configure
make
sudo make setuid
cd ..
. ./scripts/rip-environment
linuxcnc

4. Basic configuration

There is really not to much to configure just to run gmoccapy, but there are some points
you should take care off if you want to use all the features of the GUI.

You will find the following INI files included, just to show the basics:

gmoccapy.ini
gmoccapy_4_axis.ini
gmoccapy_jog_wheels.ini
gmoccapy_lathe.ini
gmoccapy_lathe_imperial.ini
gmoccapy_left_panel.ini
gmoccapy_right_panel.ini
gmoccapy_sim_hardware_button.ini
gmoccapy_tool_sensor.ini
gmoccapy_with_user_tabs.ini
gmoccapy_messages.ini
gmoccapy_pendant.ini

The names should explain the main intention of the different INI Files.

If you use an existing configuration of your machine, just edit your INI according to this WIKI.

I you want to use [MACROS], don't forget to set the path to your macros or subroutines folder as described below.

So let us take a closer look to the the INI file and what you need to include
to use gmoccapy on your machine:

4.1. The DISPLAY Section

[DISPLAY]
DISPLAY = gmoccapy
PREFERENCE_FILE_PATH = gmoccapy_preferences
DEFAULT_LINEAR_VELOCITY = 166.666
MAX_LINEAR_VELOCITY = 166.666
MAX_FEED_OVERRIDE = 1.5
MAX_SPINDLE_OVERRIDE = 1.2
MIN_SPINDLE_OVERRIDE = 0.5
LATHE = 1
BACK_TOOL_LATHE = 1
PROGRAM_PREFIX = ../../nc_files/

The most important part is to tell linuxcnc to use gmoccapy, editing the [DISPLAY] section.

[DISPLAY]
DISPLAY = gmoccapy

PREFERENCE_FILE_PATH = gmoccapy_preferences

The line PREFERENCE_FILE_PATH gives the location and name of the preferences file to be used.

This file is used by gmoccapy to store your settings of the GUI, like themes,
DRO units, colors, and keyboard settings, etc., see [SETTINGS] for more details.

If no path or file is given, gmoccapy will use as default <your_machinename>.pref, if no machine name is given in your INI File it will use gmoccapy.pref The file will be stored in your config dir, so the settings will not be mixed if you use several configs. If you only want to use one file for several machines, you need to include PREFERENCE_FILE_PATH in your INI.

DEFAULT_LINEAR_VELOCITY = 166.666

Sets the default linear velocity in machine units per second.

If no value is given, a value of 15 will be applied.

If you don't set max linear velocity, the default linear velocity will be reduced to the default value max linear velocity (60)

If you don't set max velocity in TRAJ, it may be reduced as well

see [TRAY section]

MAX_LINEAR_VELOCITY = 166.666

Sets the value of the max velocity for jogging in machine units per second.

If no value is given, a value of 60 will be applied.

MAX_FEED_OVERRIDE = 1.5

Sets the maximum feed override, in the example given, you will be allowed to override the feed by 150%

MAX_SPINDLE_OVERRIDE = 1.2
MIN_SPINDLE_OVERRIDE = 0.5

will allow you to change the spindle override within a limit from 50% to 120%

LATHE = 1
BACK_TOOL_LATHE = 1

the first line set the screen layout to control a lathe.

The second line is optional and will switch the X axis in a way you need for a back tool lathe.
Also the keyboard shortcuts will react in a different way.

See also [LATHE specific section]

PROGRAM_PREFIX = ../../nc_files/

Is the entry to tell linuxcnc/gmoccapy where to look for the ngc files, if not omitted we will look in the following range:
~/linuxcnc/nc_files
~/

4.1.1. The configuration of tabs and side panels

You can add embedded programs to gmoccapy like you can do in axis, touchy and gscreen.
All is done by gmoccapy automatically if you include a few lines in your INI file in the DISPLAY section.

If you never used a glade panel, I recommend to read the excellent documentation.
[Glade VCP]

Here is an example that add two user tabs:

EMBED_TAB_NAME = DRO
EMBED_TAB_LOCATION = ntb_user_tabs
EMBED_TAB_COMMAND = gladevcp -x {XID} dro.glade

EMBED_TAB_NAME = Second user tab
EMBED_TAB_LOCATION = ntb_preview
EMBED_TAB_COMMAND = gladevcp -x {XID} vcp_box.glade

all you have to take care off, is that you include for every tab or side panel the mentioned three lines,

EMBED_TAB_NAME

represents the name of the tab or side panel,

it is up to you what name you use, but it must be present!

EMBED_TAB_LOCATION

is the place where your program will be placed in the GUI.

valid values are:

* ntb_user_tabs (as main tab, covering the complete screen)
* ntb_preview (as tab on the preview side)
* box_left (on the left, complete high of the screen)
* box_right (on the right, in between the normal screen and the button list)
* box_coolant_and_spindle (will hide the coolant and spindle frames and introduce your glade file here)
* box_cooling (will hide the cooling frame and introduce your glade file)
* box_spindle (will hide the spindle frame and introduce your glade file)
* box_vel_info (will hide the velocity frames and introduce your glade file)
* box_custom_1 (will introduce your glade file left of vel_frame)
* box_custom_2 (will introduce your glade file left of cooling_frame)
* box_custom_3 (will introduce your glade file left of spindle_frame)
* box_custom_4 (will introduce your glade file right of spindle_frame)

see the different INI files included to see the differences

EMBED_TAB_COMMAND

is the command to execute, i.e.

gladevcp -x {XID} dro.glade
includes a custom glade file called dro.glade in the mentioned location

The file must be placed in the config folder of your machine

gladevcp h_buttonlist.glade
will just open a new user window called h_buttonlist.glade
note the difference, this one is stand alone, and can be moved around independent from gmoccapy window

camview-emc -w {XID}
will add a live image from a web cam to the location you specified.

take care that camview-emc is installed, as it is not by default. You find detailed information for camview and linuxcnc at : [cam view]

gladevcp -c gladevcp -u hitcounter.py -H manual-example.hal manual-example.ui
will add a the panel manual-example.ui, include a custom python handler, hitcounter.py and make all connections after realizing the panel according to manual-example.hal.

here are some examples:

ntb_user_tabs - with integrated camview program

ntb_preview - as maximized version

ntb_preview

box_left - showing gmoccapy in edit mode

upload:gmoccapy_with_left_box_in_edit_mode.png

box_right - and gmoccapy in MDI mode

upload:gmoccapy_with_right_panel_in_MDI_mode.png

4.1.2. Configuration of User Created Messages

Now there is the ability to create user messages in the [DISPALY] section of the INI file similar to gscreen

Here is how to set up 3 user popup message dialogs the messages support pango markup language.
Detailed information about the markup language can be found at https://developer.gnome.org/pango/stable/PangoMarkupFormat.html

MESSAGE_TEXT = The text to be displayed, may be pango markup formated
MESSAGE_TYPE = "status" , "okdialog" , "yesnodialog"

status : Will just display a message as popup window, using the messsaging system of gmoccapy

okdialog : Will hold focus on the message dialog and will activate a "-waiting" Hal_Pin OUT.
Closing the message will reset the waiting pin

yesnodialog : Will hold focus on the message dialog and will activate a "-waiting" Hal_Pin bit OUT
it will also give access to an "-responce" Hal_Pin Bit Out, this pin will hold 1 if the
user klicks OK, and in all other states it will be 0
Closing the message will reset the waiting pin
The responce Hal Pin will remain 1 until the dialog is called again

MESSAGE_PINNAME = is the name of the hal pin group to be created

Example

MESSAGE_TEXT = This is a info-message test
MESSAGE_TYPE = status
MESSAGE_PINNAME = statustest

MESSAGE_TEXT = This is a yes no dialog test
MESSAGE_TYPE = yesnodialog
MESSAGE_PINNAME = yesnodialog

MESSAGE_TEXT = Text can be small, <big>big</big>, bold, italic, and even be colored.
MESSAGE_TYPE = okdialog
MESSAGE_PINNAME = okdialog

The specific hal pin conventions for these can be found under the [hal pin section]

4.2. The RS274NGC Section

[RS274NGC]
SUBROUTINE_PATH = macros

sets the path to search for macros and other subroutines.

4.3. The MACRO Section

You can add macros to gmoccapy, similar to touchy's way.

A macro is nothing else than a ngc-file. You are able to execute complete
CNC programs in MDI mode, by just pushing one button.

To do so, you have to add a section like so:

[MACROS]
MACRO = i_am_lost
MACRO = halo_world
MACRO = jog_around
MACRO = increment xinc yinc
MACRO = go_to_position X-pos Y-pos Z-pos

This will add 5 macros to the MDI button list.

Please note, that maximal 9 macros will appear in the GUI, due to place reasons. But it is no error placing more in your INI file.

Image showing gmoccapy with 4 axis layout in MDI mode and hidden keyboard

The name of the file must be exactly the same as the name given in the MACRO line.

So the macro i_am_lost will call the file i_am_lost.ngc.

The macro files must follow some rules:
* the name of the file need to be the same as the name mentioned in the macro line, just with the ngc extension
* The file must contain a subroutine like so: O<i_am_lost> sub, where the name of the sub must match exactly the name of the macro (case sensitive)
* the file must end with an endsub command O<i_am_lost> endsub followed by an M2 command
* the files need to be placed in a folder specified in your INI file in the RS274NGC section (see [RS274NGC]:

The code in between sub and endsub will be executed by pushing the corresponding macro button.

You will find the sample macros in macros folder placed in the gmoccapy sim folder.

Gmoccapy will also accept macros asking for parameters like:

go_to_position X-pos Y-pos Z-pos

the parameters must be separated by spaces.

this calls a file go_to_position.ngc with the following content:

; Testfile go to position
; will jog the machine to a given position

O<go_to_position> sub

G17
G21
G54
G61
G40
G49
G80
G90

;#1 = <X-Pos>
;#2 = <Y-Pos>
;#3 = <Z-Pos>

(DBG, Will now move machine to X = #1 , Y = #2 , Z = #3)
G0 X #1 Y #2 Z #3

O<go_to_position> endsub
M2

after pushing the 'execute macro button', you will be asked to enter the values for

X-pos Y-pos Z-pos and the macro will only run if all values have been given.

4.4. The TRAJ Section

MAX_VELOCITY = 230.000

Sets the maximal velocity of the machine, this value will also take influence to default velocity.

5. HAL Pins

gmoccapy exports several hal pins to be able to add hardware devices to the GUI.

The goal is to get a GUI that may be operated in a tool shop, mostly without mouse or keyboard.

Please note, that you will have to do all connections to gmoccapy pins in your postgui.hal file, because they are not available before loading the GUI completely.

5.1. Right and bottom button lists

The screen has two main button lists, one on the right side an one on the bottom.
The right handed buttons will not change during operation, but the bottom list will change very often.
The buttons are count from up to down and from left to right beginning with "0".

In hal_show you will see the right buttons are:
* gmoccapy.v-button-0
* gmoccapy.v-button-1
* gmoccapy.v-button-2
* gmoccapy.v-button-3
* gmoccapy.v-button-4
* gmoccapy.v-button-5
* gmoccapy.v-button-6

and the bottom buttons are:
* gmoccapy.h-button-0
* gmoccapy.h-button-1
* gmoccapy.h-button-2
* gmoccapy.h-button-3
* gmoccapy.h-button-4
* gmoccapy.h-button-5
* gmoccapy.h-button-6
* gmoccapy.h-button-7
* gmoccapy.h-button-8
* gmoccapy.h-button-9

as the buttons in the bottom list will change according the mode and other influences,

the hardware buttons will activate different functions, and you don't have to take care about switching functions around in hal, because that is done completely by gmoccapy!

The sens of this is to be able to use the screen without an touch panel, or protect it from excessive use by placing hardware buttons around the panel.

5.2. Velocities and overrides

All sliders from gmoccapy can be connected to hardware encoders or potmeters.

To connect hardware encoderas the following hal pins are exported:

* gmoccapy.max-velocity.counts (Maximal Velocity of the machine)
* gmoccapy.jog-speed.counts (Jog velocity)
* gmoccapy.spindle-override.counts (spindle override)
* gmoccapy.feed-override.counts (feed override)
* gmoccapy.reset-feed-override (reset the feed override to 100 %)
* gmoccapy.reset-spindle-override (reset the spindle override to 100 %)

If you prefer potmeters to control the sliders you will need to connect to the following pin

* gmoccapy.feed-override.analog-enable HAL.BIT (must be True to activate the analog inputs)
* gmoccapy.spindle-override.direct-value HAL.FLOAT
* gmoccapy.max-velocity.direct-value HAL.FLOAT
* gmoccapy.jog-speed.direct-value HAL.FLOAT
* gmoccapy.feed-override.direct-value HAL.FLOAT

all four taking a float input as percentage, meaning a value from 0.0 to 1.0, setting the corresponding sliders directly to the given value.

i.e. spindle override slider has min of 30 % and max 150 % and you set gmoccapy.spindle-override-value to 0.25 the slider will jump to 60 % , as the result of min + (max-min) * pin.value

if gmoccapy.analog.enable = True, the counts are handled as well, so please be careful if you connect to both pin types

It is strongly recommended not to mix both types for the same slider!

5.3. jog hal pins

All axis given in the INI File have a jog-plus and a jog-minus pin,

so hardware momentary switches can be used to jog the axis.
For the standard config following hal Pin will be available:

* gmoccapy.jog-x-plus
* gmoccapy.jog-x-minus
* gmoccapy.jog-y-plus
* gmoccapy.jog-y-minus
* gmoccapy.jog-z-plus
* gmoccapy.jog-z-minus

if you use a 4 axis INI file, there will be two additional pins

* gmoccapy.jog-<your fourth axis letter >-plus
* gmoccapy.jog-<your fourth axis letter >-minus

for a "C" axis you will see:

* gmoccapy.jog-c-plus
* gmoccapy.jog-c-minus

5.4. jog increment hal pins

The jog increments are selectable through hal pins, so a

select hardware switch can be used to select the increment to use.

There will be a maximum of 10 hal pin for the increments given in the INI File,

If you give more increments in your INI File, they will be not reachable and will also not been displayed in the GUI.

If you have 7 increments in your hal you will get following pins:

* gmoccapy.jog-inc-0
* gmoccapy.jog-inc-1
* gmoccapy.jog-inc-2
* gmoccapy.jog-inc-3
* gmoccapy.jog-inc-4
* gmoccapy.jog-inc-5
* gmoccapy.jog-inc-6

jog-inc-0 is unchangeable and represents continuous jogging

5.5. hardware unlock pin

to be able to use a key switch to unlock the settings page the following pin is exported.

* gmoccapy.unlock-settings

The settings page is unlocked if the pin is high.

To use this pin, you need to activate it on the settings page.

5.6. Error pins

* gmoccapy.error
* gmoccapy.delete-message

gmoccapy.error is an bit out pin, to indicate an error to the hardware, so a light can lit or even the machine can be stoped. It will be reseted with the pin gmoccapy.delete-message. gmoccapy.delete-message will delete the first error and reset the gmoccapy.error pin to False after the last error has been cleared.

Messages or user infos will not affect the gmoccapy.error pin, but the gmoccapy.delete-message pin will delete the last message if no error is shown!

5.7. User Created Message HAL Pins

Status

* gmoccapy.messages.statustest

Yesnodialog

* gmoccapy.messages.yesnodialog
* gmoccapy.messages.yesnodialog-waiting
* gmoccapy.messages.yesnodialog-responce

Okdialog

* gmoccapy.messages.okdialog
* gmoccapy.messages.okdialog-waiting

5.8. Spindle feedback pins

There are two pins for spindle feedback

* gmoccapy.spindle_feedback_bar
* gmoccapy.spindle_at_speed_led

gmoccapy.spindle_feedback_bar will accept an float input to show the spindle speed

gmoccapy.spindle_at_speed_led is an bit to lit the GUI led if spindle is at speed

5.9. Pins to indicate program progress information

There are three pins giving information over the programm progress

* gmoccapy.program.length
* gmoccapy.program.current-line
* gmoccapy.program.progress

gmoccapy.program.length is an out pin (S32) showing the total number of lines of the program

gmoccapy.program.current-line is an out pin (S32) indicating the current working line of the program

gmoccapy.program.progress is an out pin (Float) giving the program progress in percentage

The values may not be very accurate, if you are working with subroutines or large remap procedures, also loops will cause different values.

5.10. Tool related pin ===

# Tool Change Pin ====
This pin are provided to use gmoccapy's internal tool change dialog. Similar to the one known from axis, but with several modifications, so you will not only get the message to change to tool number 3, but also the description of that tool like "7.5 mm 3 flute cutter". The information is taken from the tool table, so it is up to you what to display.

* gmoccapy.toolchange-number
* gmoccapy.toolchange-change
* gmoccapy.toolchange-changed

usually they are connected like this for a manual tool change:

net tool-change gmoccapy.toolchange-change <= iocontrol.0.tool-change
net tool-changed gmoccapy.toolchange-changed <= iocontrol.0.tool-changed
net tool-prep-number gmoccapy.toolchange-number <= iocontrol.0.tool-prep-number
net tool-prep-loop iocontrol.0.tool-prepare <= iocontrol.0.tool-prepared

5.10.1. tool offset pins

This pins allows you to show the active tool offset values for X and Z in the tool information frame.

You should know that they are only active after G43 has been send.

* gmoccapy.tooloffset-x
* gmoccapy.tooloffset-z

just connect them like so in your postgui hal.

net tooloffset-x gmoccapy.tooloffset-x <= motion.tooloffset.x
net tooloffset-z gmoccapy.tooloffset-z <= motion.tooloffset.z

Please note, that gmoccapy takes care of its own to update the offsets,

sending an G43 after any tool change, but not in auto mode!

So writing a program makes you responsible to include an G43 after each tool change!

6. Auto Tool Measurement

Gmoccapy offers an integrated auto tool measurement.

To use this feature, you will need to do some additional settings and you may want to use the offered hal pin to get values in your own ngc remap procedure.

Before starting the first test, do not forget to enter the Probe height and probe velocities on the settings page!
(see [Settings Page Tool Measurement])

It might be also a good idea to take a look at the tool measurement video:(see [Tool Measurement video])

Tool Measurement in gmoccapy is done a little bit different to many other GUI. You should follow the following steps:

* touch of you workpiece in X and Y
* measure the hight of your block from the base where your tool switch is located, to the upper face of the block (including chuck etc.)
* Push the button block height and enter the measured value
* Go to auto mode and start your program

here is a small sketch:

With the first given tool change the tool will be measured and the offset will be set automatically to fit the block height. The advantage of the gmoccapy way is, that you do not need a reference tool.

Please note:

Your program must contain a tool change at the beginning!

The tool will be measured, even it has been used before, so there is no danger, if the block height has changed.

There will be a video showing the way to do that on you tube

6.1. Tool measurement pins

Gmoccapy offers 5 pins for tool measurement purpose

The pins are mostly used to be read from a gcode subroutine, so the code can react to different values.

* gmoccapy.toolmeasurement = bit, enable or not tool measurement
* gmoccapy.blockheight = float, the measured value of the top face of the workpiece
* gmoccapy.probeheight = float, the probe switch height
* gmoccapy.searchvel = float, the velocity to search for the tool probe switch
* gmoccapy.probevel = float, the velocity to probe tool length

6.2. Tool Measurement INI File modifications

Modify your INI File to include the following:

6.2.1. The RS274NGC section

[RS274NGC]
# Enables the reading of INI and HAL values from gcode
FEATURES=12

# is the sub, with is called when a error during tool change happens
ON_ABORT_COMMAND=O <on_abort> call

# The remap code
REMAP=M6 modalgroup=6 prolog=change_prolog ngc=change epilog=change_epilog

6.2.2. The tool sensor section

The position of the tool sensor and the start position of the probing movement, all values are absolute coordinates, except MAXPROBE, what must be given in relative movement.
[TOOLSENSOR]
X = 10
Y = 10
Z = -20
MAXPROBE = -20

6.2.3. The Change position section

this is not named TOOL_CHANGE_POSITION on purpose - canon uses that name and will interfere otherwise
The position to move the machine before giving the change tool command. All values are in absolute coordinates
[CHANGE_POSITION]
X = 10
Y = 10
Z = -2

6.2.4. The Python section

the Python plugins serves interpreter and task
[PYTHON]
# The path to start a search for user modules
PATH_PREPEND = python
# The start point for all.
TOPLEVEL = python/toplevel.py

6.3. Needed Files

You must copy the following files to your config dir

First make a directory "python" in your config folder

from <your_linuxcnc-dev_directory>/configs/sim/gmoccapy/python

Copy toplevel.py to your config_dir/python folder

Copy remap.py to your config_dir/python folder

Copy stdglue.py to your config_dir/python folder

from <your_linuxcnc-dev_directory>/configs/sim/gmoccapy/macros

copy on_abort.ngc to the directory specified as SUBROUTINE_PATH (see [RS274NGC Section])

from <your_linuxcnc-dev_directory>/configs/sim/gmoccapy/macros

copy change.ngc to the directory specified as SUBROUTINE_PATH (see [RS274NGC Section])

open change.ngc with a editor and uncomment the following lines (49 and 50):

F #<_hal[gmoccapy.probevel]>
G38.2 Z-4
You may want to modify this file to fit more your needs, feel free, but do not ask for support ;-)

6.4. Needed Hal connections

connect the tool probe in your hal file like so

net probe motion.probe-input <= <your_input_pin>
The line might look like this:

net probe motion.probe-input <= parport.0.pin-15-in

In your postgui.hal file add:

# The next two lines are only needed if the pins had been connected before
unlinkp iocontrol.0.tool-change
unlinkp iocontrol.0.tool-changed

# link to gmoccapy toolchange, so you get the advantage of tool description on change dialog
net tool-change gmoccapy.toolchange-change <= iocontrol.0.tool-change
net tool-changed gmoccapy.toolchange-changed <= iocontrol.0.tool-changed
net tool-prep-number gmoccapy.toolchange-number <= iocontrol.0.tool-prep-number
net tool-prep-loop iocontrol.0.tool-prepare <= iocontrol.0.tool-prepared

7. The settings page

To enter the page you will have to click on:

and give an unlock code, witch is "123" as default. If you want to change it at this time you will

have to edit the hidden preference file. (see [the preference file path])

The page looks at the moment like so:

The page is separated in three main tabs:

7.1. Appearance

on this tab you will find the following options:

7.1.1. Main Window

Here you can select how you wish the GUI to start. The main reason for this was the wish to get an easy way for the user to set the starting options without the need to touch code.

You have three options:
* start as fullscreen
* start maximized
* start as window

If you select start as window the spinboxes to set the position and size will get active. One time set, the GUI will start every time on the place and with the size selected. Nevertheless the user can change the size and position using the mouse, but that will not have any influence on the settings.

You will find in this frame also a checkbox allowing you to hide the cursor, what is very useful if you use a touch screen.

7.1.2. Keyboard

The check-boxes allows the user to select if he want the on board keyboard to be shown immediately, when

entering the MDI Mode, when entering the offset page, the tooledit widget or when open a program in the EDIT mode.

The keyboard button on the bottom button list will not been affected by this settings, so you be able to show or hide the keyboard by pressing the button. The default behavior will be set by the check-boxes.

Default are :
* show keyboard on offset = True
* show keyboard on tooledit = False
* show keyboard on MDI = True
* show keyboard on EDIT = True
* show keyboard on load file = False

If the keyboard layout is not correct, i.e. clicking X gives Z, than the layout has not been set properly, related to your locale settings.

It can be solved with a small batch file with the following content:

#!/bin/bash
setxkbmap -model pc105 -layout de -variant basic

the letters "de" are for German, you will have to set them according to your locale settings

Just execute this file before starting linuxcnc, it can be done also adding a starter to your local folder

./config/autostart
so that the layout is set automatically on starting.

7.1.3. On Touch Off

give the option to show the preview tab or the offset page tab if you enter the touch off mode by clicking the corresponding bottom button.

* show preview
* show offsets

As the notebook tabs are shown, you are able to switch between both views in any case.

7.1.4. DRO Options

You have the option to select the background colors of the different DRO states.

By default the background is as follows:

* Relative mode = black
* Absolute mode = blue
* Distance to go = yellow
and the foreground color of the DRO can be selected with:
* homed color = green
* unhomed color = red
so users suffering from protanopia (red/green weakness) are able to select proper colors

If you activate:

show dro in preview, the DRO will be shown also in the preview window

and the checkboxes to select if the offsets and / or the DTG should be displayed also in the preview window will get sensitive.

The checkbox show the DRO Button will allow you to display additional buttons on the left side of the DRO.

It will display:

one button to switch from relative to absolute coordinates,

one button to toggle between distance to go and the other states

and one button to toggle the units from metric to imperial and vice versa.

It is not recommended to use this option, because the user will loose the auto unit option, which will toggle the units according to the active gcode G20 / G21
You can change through the DRO modes (absolute, relative, distance to go) by clicking on the DRO!

The checkbox Use Auto Units allows to disable the auto units option of the display, so you can run a programm in inches and watch the DRO in mm.

The adjustment size allows you to set the size of the DRO font, default is 28, if you use a bigger screen you may want to increase the size up to 56.

If you do use 4 axis, the DRO font size will be 3/4 of the value you select here, because of space reason.

7.1.5. Preview

Grid Size
Sets the grid size of the preview window.
Unfortunately the size has to be set in inches, even if your machine units are metric. We do hope to fix that in a future release.
The grid will not be shown in perspective view.

Show DRO
Will show the a DRO also in the preview window, it will be shown automatically in fullsize preview

Show DTG
Will show also the DTG (direct distance to end point) in the preview, only if Show DRO is active and not fullsize preview.

Show Offsets
Will show the offsets in the preview window, if you only check this option and leave the others unchecked, you will get in fullsize preview a offset page

Mouse Button Mode
With this combobox you can select the button behavior of the mouse to rotate, move or zoom within the preview.
add property 'mouse_btn_mode'
* left rotate, middle move, right zoom
* left zoom, middle move, right rotate
* left move, middle rotate, right zoom
* left zoom, middle rotate, right move
* left move, middle zoom, right rotate
* left rotate, middle zoom, right move

Default is left move, middle zoom, right rotate

The mouse wheel will still zoom the preview in every mode.

If you select an element in the preview, the selected element
will be taken as rotation center point.

7.1.6. File to load on start up

Select the file you want to be loaded on start up.

In other GUI changing this was very cumbersome, because the user where forced to edit the INI File.

If a file is loaded, it can be set by pressing the current button

to avoid that any program is loaded at start up, just press the None button.

The file selection screen will use the filters you have set in the INI File,

if there aren't any filters given, you will only see ngc files.

The path will be set according to the INI settings in [DISPLAY] PROGRAM_PREFIX

7.1.7. Jump to dir

you can set here the directory to jump to if you press the corresponding button

in the file selection dialog.

upload:gmoccapy_file_selection_dialog_with_keyboard.png

7.1.8. Themes and Sounds

This lets the user select what desktop theme to apply and what error and messages sounds should be played.
By default "Follow System Theme" is set.

7.2. Hardware

7.2.1. Hardware MPG Scales

For the different Hal Pin to connect MPG Wheels to, you may select individual scales to be applied.

The main reason for this was my own test to solve this through hal connections, resulting in a very complex hal file.

Imagine a user having an MPG Wheel with 100 ipr and he wants to slow down the max vel from 14000 to 2000 mm/min, that needs 12000 impulses, resulting in 120 turns of the wheel! Or an other user having a MPG Wheel with 500 ipr and he wants to set the spindle override witch has limits from 50 to 120 % so he goes from min to max within 70 impulses, meaning not even 1/4 turn.

By default all scales are set using the calculation:

(MAX - MIN)/100

7.2.2. Keyboard shortcuts

Some users want to jog there machine using the keyboard buttons and there are others that will never allow this.

So everybody can select whether to use them or not.

Default is to use keyboard shortcuts.

Please take care if you use a lathe, than the shortcuts will be different. See [the Lathe section]

* Arrow Left = X minus
* Arrow Right = X plus
* Arrow up = Y plus
* Arrow Down = Y minus
* Page Up = Z plus
* Page Down = Z minus

* F1 = Estop (will work even if keyboard shortcuts are disabled)
* F2 = Machine on

* ESC = Abort

7.2.3. Unlock options

you have three options to unlock the settings page:

* use unlock code (the user must give a code to get in)
* Do not use unlock code (There will be no security check, not recommended)
* Use hal pin to unlock (hardware pin must be high to unlock the settings, see [hardware unlock pin]

Default is use unlock code (123)

7.2.4. Spindle

The start RPM sets the rpm to be used if the spindle is started and no S value has been set.

With the MIN and MAX settings you set the limits of the spindle bar shown in the INFO frame on the main screen. It is no error giving wrong values. If you give a maximum of 2000 and your spindle makes 4000 rpm, only the bar level will be wrong on higher speeds than 2000 rpm.

default MIN = 0

MAX = 6000

7.3. Advanced Settings

7.3.1. Tool Measurement

If this part is not sensitive, you do not have a valid INI file configuration to use tool measurement.

Please check [Auto Tool Measurement]

* Use auto tool measurement : If checked, after each tool change, a tool measurement will be done, the result will be stored in the tool table and an G43 will be executed after the change.

7.3.1.1. Probe informations

The following informations are taken from your INI file and must be given in absolute coordinates

* X Pos. = The X position of the tool switch
* Y Pos. = The Y position of the tool switch
* Z Pos. = The X position of the tool switch, we will go as rapid move to this coordinate

* Max. Probe = is the distance to search for contact, an error will be launched, if no contact is given. The distance has to be given in relative coordinates, beginning the move from Z Pos., so you have to give a negative value to go down!

* Probe Height = is the height of your probe switch, you can measure it. Just touch off the base, where the probe switch is located and set that to zero. Then make a tool change and watch the tool_offset_z value, that is the hight you must enter here.

7.3.1.2. Probe velocities

* Search Vel. = The velocity to search for the tool switch, after contact the tool will go up again and then goes toward the probe again with probe vel, so you will get better results.
* Probe Vel. = Is the velocity for the second movement to the switch, it should be slower to get better touch results.(In sim mode, this is commented out in macros/change.ngc, otherwise the use would have to click twice on the probe button)

7.3.1.3. Tool Changer

If your 4'th axis is used in a tool changer, you may want to hide the DRO and all the other buttons related to that axis.
You can do that by checking the checkbox, that will hide:

* 4'th axis DRO
* 4'th axis Jog button
* 4'th axis home button
* column of 4'th axis in the offsetpage
* column of 4'th axis in the tolleditor

7.3.2. Message behavior and appearance

This will display small popup windows displaying the message or error text, the behavior is very similar to the one axis uses. You can delete a specific message, by clicking on it's close button, if you want to delete the last one, just hit the WINDOWS key on your keyboard, or delete all messages at ones with <STRG><SPACE>.

You are be able to set some options:
* X Pos = The position of the top left corner of the message in X counted in pixel from the top left corner of the screen.
* Y Pos = The position of the top left corner of the message in Y counted in pixel from the top left corner of the screen.
* Width = The width of the message box
* max = The maximum messages you want to see at ones, if you set this to 10, the 11th message will delete the first one, so you will only see the last 10 ones.
* Font = The font and size you want to use to display the messages
* use frames = If you activate the checkbox, each message will be displayed in a frame, so it is much easiere to distinguish the messages. But you will need a little bit more space.
* The button launch test message will just do what it is supposed to, it will show a message, so you can see the changes of your settings without the need to generate an error.

7.3.3. Run from line option

You can allow or disallow the run from line. This will set the corresponding button insensitive (grayed out),

so the user will not be able to use this option.

I do not recommend to use run from line, as linuxcnc will note take care of any previous lines in the code before the starting line.

So errors or crashes are very probably.

Default is disable run from line

7.3.4. Log Actions

If this button is active, nearly every button press or relevant action of linuxcnc will be logged in the ALARM history.

This is very useful for debugging.

8. LATHE specific section

If in the INI File LATHE = 1 is given, the GUI will change its appearance to the special needs for a lathe.

Mainly the Y axis will be hidden and the jog buttons will be arranged in a different order.

Normal Lathe:

upload:gmoccapy_lathe_touch_off_mode.png

Back Tool Lathe:

As you see the R DRO has a black background and the D DRO is gray. This will change according to the active G-Code G7 or G8. The active mode is visible by the black background, meaning in the shown images G8 is active.

The next difference to the standard screen is the location of the Jog Button.

X and Z have changed places and Y is gone.

You will note that the X+ and X- buttons changes there places according to normal or back tool lathe.

Also the keyboard behavior will change:

Normal Lathe:
* Arrow Left = Z minus
* Arrow Right = Z plus
* Arrow up = X minus
* Arrow Down = X plus

Back Tool Lathe:
* Arrow Left = Z minus
* Arrow Right = Z plus
* Arrow up = X plus
* Arrow Down = X minus

The tool information frame will show not only the Z offset, but also the X offset and the tool table is showing all lathe relevant information.

9. Plasma specific section

There is a very good WIKI, which is actually growing, maintained by Marius

see [Plasma wiki page]

10. VIDEO on you tube

This are videos showing gmoccapy in action, unfortunately the videos don't show the latest version of gmoccapy, but the way to use it will not change much in the future. I will try to actualize the videos as soon as possible.

10.1. Basic Usage

German =

English = https://www.youtube.com/watch?v=O5B-s3uiI6g

10.2. Simulated Jog Wheels

English = http://youtu.be/ag34SGxt97o

10.3. Settings Page

German Settings =

English Settings = https://www.youtube.com/watch?v=AuwhSHRJoiI

10.4. Simulated Hardware Button

German Hardware_Button = http://www.youtube.com/watch?v=DTqhY-MfzDE

English Hardware Button = http://www.youtube.com/watch?v=ItVWJBK9WFA

10.5. User Tabs

English User Tabs = http://www.youtube.com/watch?v=rG1zmeqXyZI

10.6. Tool_Measurement_Video

English Auto Tool Measurement Simmulation = http://youtu.be/rrkMw6rUFdk

English Auto Tool Measurement Screen = http://youtu.be/Z2ULDj9dzvk

English Auto Tool Measurement Machine = http://youtu.be/1arucCaDdX4

11. Known problems ==

# Strange numbers in the info area ===
If you get strange numbers in the info area of gmoccapy like:

You have made your config file using an older version of StepConfWizard?.

It has made a wrong entry in the INI file under the [TRAJ] named MAX_LINEAR_VELOCITY = xxx.
Change that entry to MAX_VELOCITY = xxx

The WIKI documentation will not be mantained any more.

Please see the documentation at:

[LinuxCNC 2.6 documentation]
[LinuxCNC 2.7 documentation]
[LinuxCNC master documentation]

Published under a Creative Commons License