Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/luc-github/ESP3D-WEBUI

A Web UI for ESP8266 or ESP32 based boards connected to 3D printers / CNC
https://github.com/luc-github/ESP3D-WEBUI

3d-printer esp3d grbl marlin repetier smoothieware

Last synced: about 2 months ago
JSON representation

A Web UI for ESP8266 or ESP32 based boards connected to 3D printers / CNC

Host: GitHub
URL: https://github.com/luc-github/ESP3D-WEBUI
Owner: luc-github
License: gpl-3.0
Created: 2017-05-19T07:02:14.000Z (over 7 years ago)
Default Branch: 2.1
Last Pushed: 2024-08-26T13:47:31.000Z (4 months ago)
Last Synced: 2024-08-26T16:15:00.764Z (4 months ago)
Topics: 3d-printer, esp3d, grbl, marlin, repetier, smoothieware
Language: JavaScript
Homepage:
Size: 104 MB
Stars: 749
Watchers: 56
Forks: 306
Open Issues: 11
Metadata Files:
- Readme: README.md
- Changelog: Changelog.txt
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # ESP3D-WEBUI [](https://liberapay.com/ESP3D)

[![All Contributors](https://img.shields.io/badge/all_contributors-31-orange.svg?style=flat-square)](#contributors-)

[Latest stable release ![Release Version](https://img.shields.io/github/v/release/luc-github/ESP3D-WEBUI?color=green&include_prereleases&style=plastic) ![Release Date](https://img.shields.io/github/release-date/luc-github/ESP3D-WEBUI.svg?style=plastic)](https://github.com/luc-github/ESP3D-WEBUI/releases/latest/) [![Travis (.org) branch](https://img.shields.io/travis/luc-github/ESP3D-WEBUI/2.1?style=plastic)](https://travis-ci.org/github/luc-github/ESP3D-WEBUI)   

[Latest development version ![Development Version](https://img.shields.io/badge/Devt-v3.0-yellow?style=plastic) ![GitHub last commit (branch)](https://img.shields.io/github/last-commit/luc-github/ESP3D-WEBUI/3.0?style=plastic)](https://github.com/luc-github/ESP3D-WEBUI/tree/3.0) [![github-ci](https://github.com/luc-github/ESP3D-WeBUI/workflows/build-ci/badge.svg)](https://github.com/luc-github/ESP3D-WEBUI/actions/workflows/build-ci.yml) [![Project Page ESP3D 3.0](https://img.shields.io/badge/Project%20page-ESP3D%203.0-blue?style=plastic)](https://github.com/users/luc-github/projects/1/views/1)    

 

[Project board](https://github.com/users/luc-github/projects/1/views/1)

> [!WARNING]

>### Disclaimer

> The software is provided 'as is,' without any warranty of any kind, expressed or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.

>It is essential that you carefully read and understand this disclaimer before using this software and its components. If you do not agree with any part of this disclaimer, please refrain from using the software.  

## What is that ?

A web configuration tool for ESP3D 2.1

Originaly based on great UI from Jarek Szczepanski (imrahil): [smoothieware-webui](http://imrahil.github.io/smoothieware-webui/) to get a multi firmware support for [Repetier](https://github.com/repetier/Repetier-Firmware), [Repetier for Davinci printer](https://github.com/luc-github/Repetier-Firmware-0.92), (Marlin)[https://github.com/MarlinFirmware], [Marlin Kimbra](https://github.com/MagoKimbra/MarlinKimbra) and of course [Smoothieware](https://github.com/Smoothieware/Smoothieware)

## Why doing it ?

Original I ported [smoothieware-webui](http://imrahil.github.io/smoothieware-webui/) to support [ESP3D firmware](https://github.com/luc-github/ESP3D) and it was working pretty well and gave :[smoothieware-webui-for-ESP3D](https://github.com/luc-github/smoothieware-webui-for-ESP3D) 

But this UI has a 2 big limitations:    

1 - you need internet access to get all libraries available to download, which may not happen when ESP is in AP mode for configuration if you do not have all js/css in your browser cache, or if you want to use in local environement, in that case not only ESP AP mode is not displaying UI properly but also STA mode - so it make the ESP useless

2 - it rely on server availability and certificat check, I got several certificat failure for unknown reason that made the UI not working

So the solution was to make all resources available - easy no ?

Yes but!  ESP webserver is a convenient but it is also a very light webserver, allowing no more than 5 active connections at once and with a pretty limited filesystem space, so even concatenated all resources like bootstrap icon, angular and others libraries do not work as expected and do not fit the available space.

So I came with a full rewrite using pure javascript and resized resources:    

1 - a compressed css based on [bootstrap](http://getbootstrap.com/css/)   

2 - a local limited version of svg based of [Glyphicons Halflings](http://glyphicons.com/) to get a small footprint.    

3 - a customized version of [smoothiecharts](http://smoothiecharts.org/) is used to display temperatures charts, it is simple and perfectly sized for the current purpose   

The result is a monolitic file with a minimal size allowing almost full control of ESP3D board and your 3D printer

## Sponsors 

[](https://github.com/makerbase-mks)  

## Supporters

## Become a sponsor or a supporter

 * A sponsor is a recurent donator    

If your tier is `10 US$/month` or more, to thank you for your support, your logo / avatar will be added to the readme page with eventually with a link to your site.    

 * A supporter is per time donator 

 If your donation is over `120 US$` per year, to thank you for your support, your logo / avatar will be added to the readme page with eventually with a link to your site.  

 Every support is welcome, indeed helping users / developing new features need time and devices, donations contribute a lot to make things happen, thank you.

* liberapay  

* Paypal [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FQL59C749A78L)

* ko-fi [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/G2G0C0QT7)

## Features

- It supports several firmwares based on Repetier, Marlin, Smoothieware and GRBL.

- It allows to fully configure ESP wifi

- It has a macro support to add custom commands in UI by adding buttons launching some GCODE files from SD or ESP 

- It supports several languages, check list [here](https://github.com/luc-github/ESP3D-WEBUI/wiki/Translation-support)

- It allows to display a web camera in UI or detached

- It allows to edit the Repetier EEPROM, Smoothieware config file, Marlin and GRBL settings

- It allows to update the ESP3D by uploading the FW

- it allows to control and monitor your 3D printer in every aspect (position, temperature, print, SD card content, custom command

Please look at screenshots:

Main tab and menu:   

   

Control panel:  

  

Macro dialog:   

   

Temperatures panel:   

   

Extruder panel:   

  

SD card panel:   

  

   

  

  

Camera Tab:   

  

Repetier EEPROM Editor tab:  

  

Smoothieware config Editor tab:  

  

Marlin config Editor tab:  

  

GRBL config Editor tab: 

 

ESP3D settings Editor:   

  

ESP3D Status:   

   

ESP3D SPIFFS:   

   

## Installation

Please use the latest [ESP3D firmware](https://github.com/luc-github/ESP3D/tree/2.1.x) and copy the index.html.gz file on root of SPIFFS, in theory ESP3D have a version of web-ui but it may not be the latest one

## Contribution / development

Check wiki section [Contribution/Development](https://github.com/luc-github/ESP3D-WEBUI/wiki/Compilation---Development)

## Issues / Questions

You can submit ticket [here](https://github.com/luc-github/ESP3D-WEBUI/issues) or open discussion if it is not an issue [here](https://github.com/luc-github/ESP3D-WEBUI/discussions) or Join the chat at [![Discord server](https://img.shields.io/discord/752822148795596940?color=blue&label=discord&logo=discord)](https://discord.gg/Z4ujTwE)   

 

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
_Alexandre
💻

      
_{René Pasold}
💻

      
_{aaron GitHub}
💻

      
_Pavulon87
🐛 💻

      
_{Mitch Bradley}
🤔 💻

      
_{Patrice Côté}
💻

      
_E2D
🌍

    

    

      
_{Cedrik Theesen}
🌍

      
_royfocker19
📖

      
_{Bart Toersche}
💻

      
_vivian-ng
💻

      
_drzejkopf
🌍

      
_{Luciano Charles Moda}
🌍

      
_AxelB
🌍

    

    

      
_Zefram88
🌍

      
_3d-gussner
🌍

      
_{Alex Ganov}
🤔 💻 🧑‍🏫

      
_bdring
💵 🐛 📦

      
_n4d01
🌍

      
_{Jean-Philippe CIVADE}
🌍

      
_kondorzs
🌍

    

    

      
_Carlo
🌍

      
_zrwd01
🌍

      
_Wesie
🌍

      
_DusDus
🌍

      
_nyarurato
🌍

      
_{Terje Io}
🤔 💻 🌍

      
_{Ryan V1}
💵

    

    

      
_{James Pearson}
💻 🤔

      
_{David Buezas}
💻 🐛

      
_rondlh
💻 👀

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!