Skip to content

Commit c0f5b1e

Browse files
luc-githubluc-github
authored
Update README.md
1 parent 8c7b237 commit c0f5b1e

File tree

1 file changed

+46
-67
lines changed

1 file changed

+46
-67
lines changed

‎README.md‎

Lines changed: 46 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<img src="https://github.com/luc-github/ESP3D/blob/2.1/images/ESP3D.png" width="200px"/>
2+
13
# ESP3D 2.1 [![Code Climate](https://codeclimate.com/github/luc-github/ESP3D/badges/gpa.svg)](https://codeclimate.com/github/luc-github/ESP3D)
24

35
Firmware for ESP8266/ESP8285 and ESP32 used with 3D printer using [ESP8266 core version](https://github.com/esp8266/Arduino) and [ESP32 core version](https://github.com/espressif/arduino-esp32)
@@ -11,13 +13,13 @@ I currently use it with my personnal flavor of [repetier for Due based boards](h
1113
The web interface files are present in data directory but UI has it's own repository [ESP3D-WEBUI](https://github.com/luc-github/ESP3D-WEBUI).
1214
* be aware ESP3D-WEBUI is for firmware 0.9.99 minimum - previous released version use tpl files which are no more used.
1315

14-
<u>Stable version (ESP8266 only):</u>
15-
Arduino ide 1.6.5 with stable [2.0.0](http://arduino.esp8266.com/versions/2.0.0/package_esp8266com_index.json) from ESP8266, please use https://github.com/luc-github/ESP3D/releases/tag/v0.5.1
16-
Arduino ide 1.6.8 with stable [2.2.0](http://arduino.esp8266.com/versions/2.2.0/package_esp8266com_index.json) from ESP8266, please use https://github.com/luc-github/ESP3D/releases/tag/v0.6.2
17-
Arduino ide 1.8.5 with stable [2.4.0](http://arduino.esp8266.com/versions/2.4.0/package_esp8266com_index.json) from ESP8266, please use https://github.com/luc-github/ESP3D/releases/tag/1.0 [![Build Status](https://travis-ci.org/luc-github/ESP3D.svg?branch=master)](https://travis-ci.org/luc-github/ESP3D)
18-
Arduino ide 1.8.5 with with 2.5.2 version of ESP8266 and git version of ESP32, please use https://github.com/luc-github/ESP3D/releases/tag/2.0 [![Build Status](https://travis-ci.org/luc-github/ESP3D.svg?branch=2.0)](https://travis-ci.org/luc-github/ESP3D)
19-
<u>[Development version for 2.1](https://github.com/luc-github/ESP3D/tree/2.1) & [ESP-WEBUI (2.1 branch)](https://github.com/luc-github/ESP3D-WEBUI/tree/2.1):</u>
20-
Arduino ide 1.8.9 with 2.5.2 version of ESP8266 or git version ESP32 for 100% support of ESP32 : [![Build Status](https://travis-ci.org/luc-github/ESP3D.svg?branch=2.1)](https://travis-ci.org/luc-github/ESP3D)
16+
<u>Stable versions:</u>
17+
[V1.0](https://github.com/luc-github/ESP3D/releases/tag/1.0) : please use Arduino ide 1.8.5 with stable [2.4.0](http://arduino.esp8266.com/versions/2.4.0/package_esp8266com_index.json) from ESP8266
18+
[![Build Status](https://travis-ci.org/luc-github/ESP3D.svg?branch=master)](https://travis-ci.org/luc-github/ESP3D)
19+
[V2.0](https://github.com/luc-github/ESP3D/releases/tag/2.0) : please use Arduino ide 1.8.5 with with 2.5.2 version of ESP8266 and git version ESP32 [![Build Status](https://travis-ci.org/luc-github/ESP3D.svg?branch=2.0)](https://travis-ci.org/luc-github/ESP3D)
20+
[V2.1](https://github.com/luc-github/ESP3D/releases/tag/2.1RC1) : please use Arduino ide 1.8.9 with 2.5.2 version of ESP8266 or git version ESP32 : [![Build Status](https://travis-ci.org/luc-github/ESP3D.svg?branch=2.1)](https://travis-ci.org/luc-github/ESP3D)
21+
<u>Development version:</u>
22+
[V3.0](https://github.com/luc-github/ESP3D/tree/3.0) : please use Arduino ide 1.8.9 with 2.5.2 version of ESP8266 (to be updated) or git version ESP32 : [![Build Status](https://travis-ci.org/luc-github/ESP3D.svg?branch=3.0)](https://travis-ci.org/luc-github/ESP3D)
2123

2224
[All releases](https://github.com/luc-github/ESP3D/wiki)
2325

@@ -29,55 +31,37 @@ Arduino ide 1.8.9 with 2.5.2 version of ESP8266 or git version ESP32 for 100% su
2931

3032
## Donate
3133
Every support is welcome: [<img src="https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG_global.gif" border="0" alt="PayPal – The safer, easier way to pay online.">](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=Y8FFE7NA4LJWQ)
32-
Especially because need to buy new ESP modules and devices for developing and testing.
34+
Especially because need to buy new ESP modules and devices for developing and testing new features.
3335

3436
## Features
35-
* Serial/Wifi bridge using configurable port 8888, here to enable/disable [TCP_IP_DATA_FEATURE](https://github.com/luc-github/ESP3D/blob/master/esp3d/config.h)
36-
* Use GPIO2 to ground to reset all settings in hard way - 2-6 sec after boot / not before!! Set GPIO2 to ground before boot change boot mode and go to special boot that do not reach FW. Currently boot take 10 sec - giving 8 seconds to connect GPIO2 to GND and do an hard recovery for settings, here to enable/disable [RECOVERY_FEATURE](https://github.com/luc-github/ESP8266/blob/master/esp8266/config.h)
37-
* Complete configuration by web browser (Station or Access point) or by Serial commands
38-
* Authentication for sensitive pages, here to enable/disable [AUTHENTICATION_FEATURE](https://github.com/luc-github/ESP3D/blob/master/esp3d/config.h)
39-
* Update firmware by web browser, here to enable/disable [WEB_UPDATE_FEATURE](https://github.com/luc-github/ESP3D/blob/master/esp3d/config.h)
40-
* Control ESP module using commands on serial or data port, here to enable/disable [SERIAL_COMMAND_FEATURE](https://github.com/luc-github/ESP3D/blob/master/esp3d/config.h)
41-
* Captive portal in Access point mode which redirect all unknow call to main page, here to enable/disable [CAPTIVE_PORTAL_FEATURE](https://github.com/luc-github/ESP3D/blob/master/esp3d/config.h)
42-
* mDNS which allows to key the name defined in web browser and connect only with bonjour installed on computer, here to enable/disable [MDNS_FEATURE](https://github.com/luc-github/ESP3D/blob/master/esp3d/config.h)
43-
* SSDP, this feature is a discovery protocol, supported on Windows out of the box, here to enable/disable [SSDP_FEATURE](https://github.com/luc-github/ESP3D/blob/master/esp3d/config.h)
37+
* Serial/Wifi bridge using configurable port 8888
38+
* Use GPIO2 to ground to reset all settings in hard way - 2-6 sec after boot / not before!! Set GPIO2 to ground before boot change boot mode and go to special boot that do not reach FW. Currently boot take 10 sec - giving 8 seconds to connect GPIO2 to GND and do a hard recovery for settings
39+
* Complete configuration by web browser (Station or Access point) or by Serial/telnet commands
40+
* Authentication (optional) for better security
41+
* Update firmware by web browser
42+
* Captive portal in Access point mode which redirect all unknow call to main page
43+
* mDNS which allows to key the name defined in web browser and connect only with bonjour installed on computer
44+
* SSDP, this feature is a discovery protocol, supported on Windows out of the box
4445
* Fail safe mode (Access point)is enabled if cannot connect to defined station at boot.
45-
* Choice of web server Async or Sync
46-
* Websocket support
47-
* OLED screen support
48-
* The web ui add even more feature : https://github.com/luc-github/ESP3D-WEBUI/blob/master/README.md#features
49-
50-
51-
## Web configuration
52-
* Wifi Mode : Access point / Client station
53-
* IP Generation: DHCP/Static IP
54-
* IP/MASK/GATEWAY for static data
55-
* Baud Rate for serial (supported : 9600, 19200, 38400, 57600, 115200, 230400, 250000)
56-
* web port and data port
46+
* Embedded FS uploader and updater.
47+
* OLED screen support
48+
* Notifications using Line / Pushover / email
49+
* The web ui add even more feature : https://github.com/luc-github/ESP3D-WEBUI/blob/2.1/README.md#features
5750

58-
5951
## Default Configuration
6052
Default Settings:
61-
AP:ESP8266
62-
PW:12345678
63-
Authentification: WPA
64-
Mode: g (n is not supported by AP, just by STA)
65-
channel: 11
66-
AP: visible
67-
Sleep Mode: Modem
68-
IP Mode: Static IP
69-
IP: 192.168.0.1
70-
Mask: 255.255.255.0
71-
GW:192.168.0.1
72-
Baud rate: 115200
73-
Web port:80
74-
On async webserver the websocket is web port => 80+1 : 81
75-
Data port: 8888
76-
Web Page refresh: 3 secondes
77-
User: admin
78-
Password: admin
79-
User:user
80-
Password: user
53+
* Access Point: ESP3D
54+
* PW:12345678
55+
* Authentification: WPA
56+
* IP: 192.168.0.1
57+
* Baud rate: 115200
58+
* Web port:80
59+
* Data port: 8888
60+
if Authentication is enabled :
61+
* User: admin
62+
* Password: admin
63+
* User:user
64+
* Password: user
8165

8266

8367

@@ -90,14 +74,7 @@ Feedback on 2.0 was : ESP3D being a library is not really useful and make setup
9074
1. Please follow installation of the ESP core you want to use : [ESP8266 core version](https://github.com/esp8266/Arduino) or [ESP32 core version](https://github.com/espressif/arduino-esp32)
9175
2. Add manually libraries present in libraries directory -these versions are verified to work with ESP3D, any others (newer version) may cause untested behavior.
9276

93-
For async webserver support(currently not recommended as not stable)
94-
* ESPAsyncWebServer from @me-no-dev
95-
if you target ESP8266
96-
* ESPAsyncTCP from @me-no-dev
97-
if you target ESP32:
98-
* AsyncTCP from @me-no-dev
99-
100-
If you want sync webserver support (recommended as stable):
77+
Use webserver support (recommended as stable):
10178
* arduinoWebSockets from @Links2004
10279

10380
Generic ones:
@@ -108,14 +85,14 @@ If you want OLED support:
10885

10986
If you want DHT11/22 support:
11087
* DHT_sensor_library_for_ESPx from @beegee-tokyo
111-
3. Compile project esp3d.ino according target: ESP8266 board or ESP32 board, please review config.h to enable disable a feature, by default athenticatio is disabled and all others are enabled.
88+
3. Compile project esp3d.ino according target: ESP8266 board or ESP32 board, please review config.h to enable disable a feature, by default athentication is disabled and most others are enabled.
11289
* for ESP8266 set CPU freq to 160MHz for better (https://github.com/luc-github/ESP3D/wiki/Install-Instructions)
11390
4. Upload the data content on ESP3D file system
11491
* Using SPIFFS uploader, this plugin and install instructions is available on each ESP core - please refere to it
11592
or
11693
* Using embedded uploader (you may need to format SPIFFS using : [ESP710]FORMAT on ESP8266 first)
11794
if embedded uploader does not show up you can force it ti display using : http://your_IP_address?forcefallback=yes
118-
<img src=https://raw.githubusercontent.com/luc-github/ESP3D/master/images/docs/embedded.png><br>
95+
<img src=https://github.com/luc-github/ESP3D/blob/2.1/images/docs/embedded.png><br>
11996

12097
## Update
12198
* Generate a binary using the export binary menu from Arduino IDE and upload it using ESP-WEBUI or embedded interface
@@ -124,9 +101,9 @@ if embedded uploader does not show up you can force it ti display using : http:/
124101

125102
## Contribution/customization
126103
* To style the code before pushing PR please use [astyle --style=otbs *.h *.cpp *.ino](http://astyle.sourceforge.net/)
127-
* 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.
128-
* The current UI is located [here](https://github.com/luc-github/ESP3D-WEBUI)
129-
* An optional UI is under development using old repetier UI - check [UI\repetier\testui.htm] (https://github.com/luc-github/ESP3D/blob/master/UI/repetier/testui.htm) file
104+
* The embedded page is created using nodejs then gulp to generate a compressed html page (tool.html.gz), all necessary modules will be installed using the build.bat, you also need bin2c tool (https://sourceforge.net/projects/bin2c/) to generate the h file from the binary, installation and build is done using the build.bat.
105+
* The corresponding UI is located [here](https://github.com/luc-github/ESP3D-WEBUI/tree/2.1)
106+
* An optional UI was development using old repetier UI - check [UI\repetier\testui.htm] (https://github.com/luc-github/ESP3D/blob/master/UI/repetier/testui.htm) file
130107

131108

132109
## Need more information about supported boards or wiring ?
@@ -139,12 +116,14 @@ Check [Wiki](https://github.com/luc-github/ESP3D/wiki/Install-Instructions) or [
139116
Check [Wiki](https://github.com/luc-github/ESP3D/wiki/Install-Instructions) and [FAQ](https://github.com/luc-github/ESP3D/issues?utf8=%E2%9C%93&q=label%3AFAQ+) or [submit ticket](https://github.com/luc-github/ESP3D/issues)
140117

141118
## ESP3D is used by :
142-
* Custom version is used on azteeg mini wifi : http://www.panucatt.com/azteeg_X5_mini_reprap_3d_printer_controller_p/ax5mini.htm
143-
and Wifi boards for 3D printers : https://www.panucatt.com/ProductDetails.asp?ProductCode=WB8266,
119+
* Opensource version is used by various boards like : https://www.aliexpress.com/wholesale?SearchText=esp3d&opensearch=true&switch_new_app=y
120+
and https://youtu.be/XoWW0aU6DGE?t=76
144121

122+
123+
* Custom version (not this repository) is used on azteeg mini wifi : http://www.panucatt.com/azteeg_X5_mini_reprap_3d_printer_controller_p/ax5mini.htm
124+
and Wifi boards for 3D printers : https://www.panucatt.com/ProductDetails.asp?ProductCode=WB8266,
145125
<h2>:warning: Do not use this repository for these boards, you will lose several features.</h2>
146-
147-
* Several boards, mostly chinese ones, but without noticed me, so I can't promote them here...
126+
148127
* More to come...
149128

150129
If you use ESP3D on your product, drop me a message so I can link your product page here.

0 commit comments

Comments
 (0)