Skip to content

Gcode scripting, 3D visualization and streaming for the grbl CNC controller

License

Notifications You must be signed in to change notification settings

5ocworkshop/gerbil_gui

 
 

Repository files navigation

gerbil_gui - Graphical User Interface for the "grbl" CNC controller

Python scripting and realtime OpenGL 3D visualization of gcode plus streaming to the grbl CNC controller, implemented in Python3 with Qt5 bindings.

The main window

The simulator window

The simulator window

The simulator window

The simulator window

The simulator window

Installation

Your graphics hardware and drivers need to support at least OpenGL version 2.1 with GLSL version 1.20.

Ideally, you also need an Arduino board with a recent version of grbl flashed onto it, however the Gcode simulator and scripting will even work without an Arduino board connected.

Get and install Python3 and git for your OS. Then:

git clone https://github.com/michaelfranzl/gerbil_gui
cd gerbil_gui
git clone https://github.com/michaelfranzl/gerbil.git
git clone https://github.com/michaelfranzl/pyglpainter.git
git clone https://github.com/michaelfranzl/gcode_machine.git

Start the GUI (the path to a serial port on Windows is "COMx" where x is a number):

python ./gerbil_gui.py gui --path=/dev/ttyACM0

Dependencies in Windows

pip install pyserial
pip install svgwrite
pip install PyQt5
pip install numpy
pip install PyOpenGL
pip insatll Pillow

The installation of scipy may be difficult on Windows, but it is optional unless you want to use the feature that adapts Gcode to an uneven surface via probe cycles:

pip install scipy

Dependencies in Debian Jessie

apt-get install python3 python3-pip python3-serial python3-pil python3-numpy python3-scipy python3-pyqt5 python3-pyqt5.qtopengl python3-opengl

pip install svgwrite

Update Python code from Qt .ui file

Useful for developers only:

pyuic5 -o lib/qt/gerbil_gui/ui_mainwindow.py lib/qt/gerbil_gui/mainwindow.ui

License

Copyright (c) 2015 Michael Karl Franzl

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Gcode scripting, 3D visualization and streaming for the grbl CNC controller

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.4%
  • Other 0.6%