https://github.com/mic159/octoprint-grbl-plugin
Simple GRBL support for Octoprint
https://github.com/mic159/octoprint-grbl-plugin
cnc gcode grbl octoprint
Last synced: 3 months ago
JSON representation
Simple GRBL support for Octoprint
- Host: GitHub
- URL: https://github.com/mic159/octoprint-grbl-plugin
- Owner: mic159
- License: mit
- Created: 2017-05-10T15:38:57.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-19T13:59:16.000Z (almost 8 years ago)
- Last Synced: 2025-04-19T14:58:37.110Z (9 months ago)
- Topics: cnc, gcode, grbl, octoprint
- Language: Python
- Size: 7.81 KB
- Stars: 39
- Watchers: 8
- Forks: 9
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Grbl support for OctoPrint
This plugin lets you use Grbl based CNC machines with OctoPrint.
**NOTE:** You still need to set a few more settings after installing
this plugin to make it work. See below.
## Installation
```bash
pip install octoprint-grbl-plugin
```
## Required Configuration
- _Serial Connection_ > _Advanced options_ > _"Hello" command_ = **M5**
- _Features_ > _Send a checksum with the command_ > **Never**
## Additional controls
If you would like to show some additional info on the "Control" tab,
add the following to your `config.yaml` file:
```yaml
controls:
- name: State
type: section
layout: vertical
children:
- name: Realtime State
# GRBL 0.8
# Grbl 1.1
regex: '<([^,]+)[,|][WM]Pos:([+\-\d.]+,[+\-\d.]+,[+\-\d.]+)'
template: 'State: {0} Machine Position: {1}'
type: feedback
- name: GCode state
# [G0 G54 G17 G21 G90 G94 M0 M5 M9 T0 F300. S700.]
regex: 'F([\d.]+) S([\d.]+)'
template: 'Speed: {0} Power: {1}'
type: feedback
- command: '?$G'
name: Refresh
- command: '$H'
name: Home
- command: '$X'
name: Unlock
- command: '!'
name: Pause
- command: '~'
name: Resume
```