Repository files navigation

CNCjs is a full-featured web-based interface for CNC controllers runningGrbl,Marlin,Smoothieware, orTinyG.

For a more complete introduction, see theIntroduction section of the wiki page.

• Supported controllers
  • Grbl (Download)
  • Grbl-Mega (Download)
  • Marlin (Download)
  • Smoothieware (Download)
  • TinyG (Recommend: firmware version 0.97 build 449.xx) (Download)
  • g2core
• Desktop App for Linux, Mac OS X, and Windows
• 6-axis digital readout (DRO)
• Tool path 3D visualization
• Simultaneously communicate with multiple clients
• Responsive view for small screen display with device width less than 720px
  • Safari on an iPhone 5S[1][2]
• Customizable workspace
• Custom widget (since 1.9.10)
• Custom MDI (Multiple Document Interface) command buttons (since 1.9.13)
• My Account
• Commands
• Events
• Keyboard Shortcuts
• Contour ShuttleXpress
• Multi-Language Support
• Watch Directory
• Tool Change (since 1.9.11)
• Z-Probe

• cncjs-widget-boilerplate - Creating custom widgets for CNCjs.

• cncjs-pendant-boilerplate - A bare minimum example to develop a cncjs pendant.

• cncjs-pendant-keyboard - A simple pendant (using wireless keyboard or usb) to CNCJS.
• cncjs-pendant-numpad - A simple pendant (using wireless numpad or usb) to CNCJS.
• cncjs-pendant-lcd - CNCjs Web Kiosk for Raspberry Pi Touch Displays.
• cncjs-pendant-ps3 - Dual Shock / PS3 Bluetooth Remote Pendant for CNCjs.
• cncjs-pendant-raspi-gpio - Simple Raspberry Pi GPIO Pendant control for CNCjs.

• cncjs-pendant-tinyweb - A tiny web console for small 320x240 LCD display.
  
• cncjs-shopfloor-tablet - A simplified UI for cncjs optimized for tablet computers in a production (shop floor) environment.
  

Chrome	Edge	Firefox	IE	Opera	Safari
Yes	Yes	Yes	Not supported	Yes	Yes

Node.js 14 or higher is recommended. You can installNode Version Manager to manage multiple Node.js versions. If you havegit installed, just clone thenvm repo, and check out the latest version:

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

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

Once installed, you can select Node.js versions with:

nvm install 14nvm use 14

It's also recommended that you upgrade npm to the latest version. To upgrade, run:

npm install npm@latest -g

Install cncjs as a non-root user, or theserialport module may not install correctly on some platforms like Raspberry Pi.

npm install -g cncjs

If you're going to use sudo or root to install cncjs, you need to specify the--unsafe-perm option to run npm as the root account.

sudo npm install --unsafe-perm -g cncjs

Check outhttps://github.com/cncjs/cncjs/wiki/Installation for other installation methods.

Runnpm install -g cncjs@latest to install the latest version. To determine the version, usecncjs -V.

Runcncjs to start the server, and visithttp://yourhostname:8000/ to view the web interface. Pass--help tocncjs for more options.

pi@rpi3$ cncjs -h  Usage: cncjs [options]  Options:    -V, --version                       output the version number    -p, --port <port>                   Set listen port (default: 8000)    -H, --host <host>                   Set listen address or hostname (default: 0.0.0.0)    -b, --backlog <backlog>             Set listen backlog (default: 511)    -c, --config <filename>             Set config file (default: ~/.cncrc)    -v, --verbose                       Increase the verbosity level (-v, -vv, -vvv)    -m, --mount <route-path>:<target>   Add a mount point for serving static files    -w, --watch-directory <path>        Watch a directory for changes    --access-token-lifetime <lifetime>  Access token lifetime in seconds or a time span string (default: 30d)    --allow-remote-access               Allow remote access to the server (default: false)    --controller <type>                 Specify CNC controller: Grbl|Marlin|Smoothie|TinyG|g2core (default: '')    -h, --help                          output usage information  Examples:    $ cncjs -vv    $ cncjs --mount /pendant:/home/pi/tinyweb    $ cncjs --mount /widget:~+/widget --mount /pendant:~/pendant    $ cncjs --mount /widget:https://cncjs.github.io/cncjs-widget-boilerplate/v1/    $ cncjs --watch-directory /home/pi/watch    $ cncjs --access-token-lifetime 60d  # e.g. 3600, 30m, 12h, 30d    $ cncjs --allow-remote-access    $ cncjs --controller Grbl

Instead of passing command line options for--watch-directory,--access-token-lifetime,--allow-remote-access, and--controller, you can create a~/.cncrc file that contains the following configuration in JSON format:

{"mountPoints": [        {"route":"/pendant","target":"/home/pi/tinyweb"        },        {"route":"/widget","target":"https://cncjs.github.io/cncjs-widget-boilerplate/v1/"        }    ],"watchDirectory":"/path/to/dir","accessTokenLifetime":"30d","allowRemoteAccess":false,"controller":""}

To troubleshoot issues, run:

cncjs -vvv

The configuration file.cncrc contains settings that are equivalent to the cncjs command-line options. The configuration file is stored in user's home directory. To find out the actual location of the home directory, do the following:

• Linux/Mac

  echo$HOME

• Windows

  echo %USERPROFILE%

Check out an example configuration filehere.

See#242 (comment) for a detailed explanation.

{"ports": [     {"path":"/dev/ttyAMA0","manufacturer":""     }  ],"baudrates": [115200,250000],"mountPoints": [    {"route":"/widget","target":"https://cncjs.github.io/cncjs-widget-boilerplate/v1/"    }  ],"watchDirectory":"/path/to/dir","accessTokenLifetime":"30d","allowRemoteAccess":false,"controller":"","state": {"checkForUpdates":true,"controller": {"exception": {"ignoreErrors":false      }    }  },"commands": [    {"title":"Update (root user)","commands":"sudo npm install -g cncjs@latest --unsafe-perm; pkill -f cncjs"    },    {"title":"Update (non-root user)","commands":"npm install -g cncjs@latest; pkill -f cncjs"    },    {"title":"Reboot","commands":"sudo /sbin/reboot"    },    {"title":"Shutdown","commands":"sudo /sbin/shutdown"    }  ],"events": [],"macros": [],"users": []}

https://cnc.js.org/docs/

There are several *.gcode files in theexamples 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 usingjscut to create G-Code from *.svg. It's a simple CAM package that runs in the browser.

Check out a live demo athttp://jscut.org/jscut.html.

UseGitHub issues for requests.

Pull requests welcome! Learn how tocontribute.

You can help translate resource files in both ofapp andserver directories from English to other languages. Check outLocalization guide to learn how to get started. If you are not familiar with GitHub development, you canopen an issue or send your translations tocheton@gmail.com.

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

This project exists thanks to all the people who contribute. [Contribute].

Thank you to all our backers! 🙏 [Become a backer]

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

Licensed under theMIT License.