mcanthony / grblserver

GrblServer

GrblServer is a Grbl interface for standalone gcode execute service which works with nodejs.

GrblServer provides:

• WebSocket APIs
• Multiple session for one Grbl (broadcast Grbl state to all clients) This is useful for show state in multiple view (eg. local LCD and remote browsers)

Overview

Standalone WebApp

By "Add to Home screen" feature on Chrome for Android.

Responsive View

Install & Basic Usage

You must install node.js and git.

Clone repository to local

git clone https://github.com/cho45/GrblServer.git

Install dependencies

cd GrblServer
npm install

Configure

Create config/local.json. You must edit "serialPort" path.

cp config/default.json config/local.json
vi config/local.json

Run GrblServer

You should connect Grbl installed Arduino before running.

node bin/grbl-server.js

Open client by browser

Google Chrome is recommended for performance.

open http://localhost:8080/

(GrblServer also serves static files under ./browser)

Configuration

serverPort

Specify WebSocket/HTTP server port to serve.

serialPort

Specify serial port path which is connected to Grbl.

serialBaud

Specify serial baudrate to Grbl.

You want to write configuration with other formats? You can: https://github.com/lorenwest/node-config/wiki/Configuration-Files

TLSKey, TLSCert

Specify TLS key/cert for HTTP2. Default is empty (disabled).

GrblServer includes localhost cert (self signed certificates). Use it by following:

"TLSKey" : "dev/server.key",
"TLSCert" : "dev/server.crt" 

Or create self signed certificates by dev/make-key.sh.

Usecases

Jogging by smartphone's browser

with Raspberry Pi

Setup

Ensure that NodeJS has been installed on the Rapsberry Pi (https://learn.adafruit.com/node-embedded-development/installing-node-dot-js)

Clone GrblServer on Raspberry Pi:

mkdir app
cd app
git clone https://github.com/cho45/GrblServer.git
cd GrblServer
npm install
vi config/local.json

Edit /etc/inittab to auto login by user pi:

sudo vi /etc/inittab

# comment out following line:
# 1:2345:respawn:/sbin/getty --noclear 38400 tty1 
# and add following line:
1:2345:respawn:/bin/login -f pi tty1 </dev/tty1 >/dev/tty1 2>&1

Edit /etc/rc.local to auto launch GrblServer:

sudo vi /etc/rc.local
# add following line before exit
sudo -u pi /home/pi/app/GrblServer/service/grbl-server.sh

Development

GrblServer is written in TypeScript.

sudo npm install -g typescript
npm install
make watch # tsc watch
make server # launch websocket/http server

browser client is written JavaScript with Polymer

Above make server also serves static files under browser/.

Grbl for development

You may need actual connection to Grbl. But you should not connect to Grbl which connected to powered CNC machine. So I suggest you to make another Grbl installed Arduino and use it for development.

Grbl is open-loop control except homing and probing. It means you don't need to connect actual CNC machine in most case.

Contribute

Send pull-request.

LICENSE

MIT: http://cho45.github.com/mit-license