nwaelti / esp3dlib

ESP3D library for Marlin and ESP32 boards

ESP3DLib 3.0 for Marlin NWa Version

With added MQTT for GCODE-MQTT communication

Library for ESP32 boards using Marlin 2.x :

ESP32 Controller, FYSETC-E4, MRR_ESPA, MRR_ESPE, Panda Zhu, MKS Tinybee

The web interface files has it's own repository ESP3D-WEBUI.

Latest development version

To use ESP3Lib V3 you need an updated version of Marlin which is here: https://github.com/luc-github/Marlin, necessary will be pushed when library V3 is considered as stable enough.

⚠️ This is not for ESP8266 boards neither standalone ESP3D installation

for them go here

All releases

Sponsors

  

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
• ko-fi

Features

• Complete configuration by web browser (Station or Access point) or by Serial commands
• Authentication for sensitive pages
• Update firmware by web browser or OTA
• Captive portal in Access point mode which redirect all unknow call to main page
• mDNS which allows to key the name defined in web browser and connect only with bonjour installed on computer
• SSDP, this feature is a discovery protocol, supported on Windows out of the box
• Fail safe mode (Access point)is enabled if cannot connect to defined station at boot.
• The web ui add even more feature : https://github.com/luc-github/ESP3D-WEBUI/blob/master/README.md#features

Coming Features

As side project of ESP3D, it follows ESP3D features: https://github.com/luc-github/ESP3DLib/blob/3.0/Features.md

How to enable ?

Check the document : https://github.com/luc-github/ESP3DLib/blob/3.0/Configuration.md

Default Configuration

Default Settings if not modified in Configuration_adv.h:
AP:MARLIN_ESP
PW:12345678
Authentification: WPA
Mode: g (n is not supported by AP, but by STA)
channel: 1
IP: 192.168.0.1
Mask: 255.255.255.0
GW:192.168.0.1
Web port:80 the webUI websocket is web port + 1 => 80+1 : 81
User: admin
Password: admin
User:user
Password: user

Direct commands:

Check wiki

Contribution/customization

• To style the code before pushing PR please use astyle --style=otbs *.h *.cpp *.ino
• The embedded page is created using nodejs then gulp to generate a compressed html page (tool.html.gz), all necessary modules can be installed using the install.bat file content, then it is included using bin2c (https://sourceforge.net/projects/bin2c/) to generate the h file used to create the file nofile.h, update the array and size according new out.h.
• The current UI is located here

❓Any question ?

Check Wiki or Join the chat at
you can also check discussions panel

❗Any issue ?

submit ticket

TODO/On going :

• Test test test....
• Update Marlin to support it officially the V3 using latest ESP32 arduino / platformIO core version