A web-based interface for CNC milling controller running Grbl or TinyG2. It runs on an Raspberry Pi or a laptop computer that you have Node.js installed, connecting to the Arduino over a serial connection using a USB serial port, a Bluetooth serial module, or a Serial-to-WiFi module like XBee or USR-WIFI232-T.

Key Features

Installation

Node.js Installation

Node.js v4 or higher is recommended. You can install Node Version Manager to manage multiple Node.js versions. If you have git installed, just clone the nvm repo, and check out the latest version:

$ git clone https://github.com/creationix/nvm.git ~/.nvm
$ cd ~/.nvm
$ git checkout `git describe --abbrev=0 --tags`
$ cd ..
$ . ~/.nvm/nvm.sh
$ nvm install 4

Add these lines to your ~/.bash_profile, ~/.bashrc, or ~/.profile file to have it automatically sourced upon login:

export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh" # This loads nvm

If you're using Node.js v4 or earlier versions, it's recommended that you use npm v3 to install packages. To upgrade, run:

npm install npm@latest -g

If you're not using Node Version Manager, make sure you have prefix=~/.npm in ~/.npmrc to install global packages without sudo. For example:

$ echo "prefix=~/.npm" >> ~/.npmrc
$ cat ~/.npmrc
prefix=~/.npm

Getting Started

Install cncjs without sudo, or the serialport module may not install correctly on some platforms like Raspberry Pi.

It's recommended that you run Raspbian Jessie on the RPi2 or RPi3. For Raspbian Wheezy, be sure to install gcc/g++ 4.8 before npm install.

Check out wiki for other installation methods.

Upgrade

Run npm update -g cncjs to upgrade to a newer version. To determine the version, use cnc -V.

Usage

Run cnc or ~/.npm/bin/cnc to start the server, and visit http://yourhostname:8000/ to view the web interface:

Run cnc with -h for detailed usage:

$ cnc -h

  Usage: cnc [options]
  
  Options:

    -h, --help                  output usage information
    -V, --version               output the version number
    -p, --port                  set listen port (default: 8000)
    -l, --host                  set listen address or hostname (default: 0.0.0.0)
    -b, --backlog               set listen backlog (default: 511)
    -c, --config <filename>     set config file (default: ~/.cncrc)
    -v, --verbose               increase the verbosity level
    -m, --mount [<url>:]<path>  set the mount point for serving static files (default: /static:static)

If you need view detailed logs for troubleshooting, you can run the server in debug mode.

Wiki

https://github.com/cheton/cnc/wiki

Examples

There are several *.gcode files in the examples directory. You can use the GCode widget to load a GCode file and make a trial run.

If you don't have a CAM software, try using jscut to create G-Code from *.svg. It's a simple CAM package that runs in the browser.

Check out a live demo at http://jscut.org/jscut.html.

Contributions

Use GitHub issues for requests.

Pull requests welcome! Learn how to contribute.

Localization

You can help translate src/app/i18n/en/resource.json and src/web/i18n/en/resource.json files from English to other languages. Check out Localization guide to learn how to get started. If you are not familiar with GitHub development, you can open an issue or send your translations to cheton@gmail.com.

Donate

If you would like to support this project, you can make a donation using PayPal. Thank you!

License

Copyright (c) 2015-2016 Cheton Wu

Licensed under the MIT License.