Ground Control is the program which allows you to control the Maslow CNC machine.
From within Ground Control, you can move the machine to where you want to begin a cut, calibrate the machine, open and run a g-code file, or monitor the progress of an ongoing cut.
At present, the UI looks like this:
Ground Control is written in Python. It was chosen because it has good cross platform support and is relatively simple to work with.
Two of the goals of Ground Control are:
- It runs on as many platforms as possible.
- It is as easy as possible for members of the community to contribute to making the program better.
For Windows and OS X binaries, see the releases page.
For help installing binaries, see the installation guides.
Ground control documentation is available on the project wiki.
For help in using Ground Control, see the users guide.
Ground Control is built using the 2.7.x version of the Python language. 2.7 was chosen instead of 3.x because the support for compiling binaries for the 3.x version is not good enough yet.
Maslow uses the Kivy framework for the UI and the pyserial module for USB communication.
You might also consider taking a look at Virtual Environments to save you from python version headaches later on. This is not a prerequisite for installation on any platform.
To setup your computer to run Ground Control from the source code, first download and install Python version 2.7.x.
Once you have installed Python 2.7.x, open the command prompt and type
python --versionYou should then see something similar to this:
Python 2.7.11If python does not open, it is most likely an issue with the PATH environment variable.
For more information about configuring the PATH in Windows, see superuser: How to add python to the windows path.
Next, you need to install Kivy and Pyserial. Fortunately, python comes with a built in package manager, pip which will install both of them for you.
To install pyserial, type:
python -m pip install pyserialInstalling Kivy is a little more complicated. First, check to make sure your version of pip is up to date by running:
python -m pip install --upgrade pip wheel setuptoolsthen install dependencies:
python -m pip install docutils pygments pypiwin32 kivy.deps.sdl2 kivy.deps.glewand finally install Kivy:
python -m pip install kivyTo install Python on OS X, first install Homebrew
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"then install Python:
brew install pythonInstall required dependencies:
pip install -r requirements_osx.txtPython is bundled with all major linux distributions. You can confirm the version of python you have installed with:
python --versionSee documentation for your linux distro on how to install Python 2.7.x if it is not installed.
Once Python 2.7.x is installed, install required dependencies:
pip install -r requirements_linux.txtGround Control can be run from the command line. From within the project folder, run the following:
python main.pyIf you have any questions or issues with this process please get in touch through the Maslow forums.
If you had any issues which you were able to resolve, please consider raising a Pull Request on this README.md file with corrections or additions. For more information, see How To Contribute below.
Maslow is an open source project, get involved!
If you find a bug in the software, report it on the issues page.
If you have an idea for a new feature, let us know in the Maslow forums.
If you want to get involved, say hi in the Maslow forums.
If you've already jumped in and started making the software better, feel free to submit a pull request! You can learn more about how to do that here Github Help: Creating a pull request
