Minimal Web UI for gcode to serial devices.
GcodeControlleris a small app to manage your gcode jobs with the least amount of setup. Use for Grbl, Marlin, RepRap and other firmware that accepts gcode.
✅ Minimal UI
✅ Start/Stop/Pause a job with realtime progress
✅ Jog
✅ Console to execute gcode
✅ Upload/Manage Files
✅ API with OpenAPI documentation
✅ MQTT / WebSocket Support (Rest API responses matching)
✅ Detailed Logs
✅ Streaming Webcam support
Download the latest release for your OS. Run the executable.
On Linux/Mac
chmod u+x GcodeController;
./GcodeControllerThen go to http://<device ip>:8081. It's shown in the console logs.
Grant dialout access *nix based machine for non sudo users (Linux, Mac)
Check user for dialout access
id -Gn <username>If missing `dialout` from the list then
sudo usermod -a -G dialout <username>logout and login to ensure access is granted.
| Endpoint | Purpose |
|---|---|
GET /api/ping |
Pong |
GET /api/serial |
Current serial device connection |
POST /api/serial |
Create and open serial device connection |
DELETE /api/serial |
Close serial device connection |
PUT /api/serial |
Send command to serial device |
GET /api/job |
Job Status |
POST /api/job |
Start job |
PUT /api/job |
Pause job |
DELETE /api/job |
Stop job |
POST /api/files |
Upload single file to be used in job |
GET /api/files |
Get all files |
GET /api/files/{fileName} |
Get single file information |
DELETE /api/files/{fileName} |
Remove single file |
Contributions, issues and feature requests are welcome.
Feel free to check issues page if you want to contribute.
👤 Spencer Kittleson
- Twitter: @skittleson
- Github: @skittleson
- LinkedIn: @skittleson
- StackOverflow: spencer
- Blog: DoCodeThatMatters
⭐️ this repository if this project helped you! It motivates us a lot! 👋
Buy me a coffee ☕: skittles
Copyright © 2021 Spencer Kittleson - Do Code That Matters.
This project is MIT licensed.