README.md

ESP8266

FW for ESP8266 used with 3D printer

Arduino ide 1.6.5 with latest master from ESP8266 :

##Description
Thanks to @disneysw for bringing this module idea
Thanks to @lkarlslund for suggestion about independant reset using GPIO2

Have a bridge configurable by web (implemented) and optionally by printer (not yet implemented)
Have a front end to know what is the wifi status (implemented) or know what is the print status (not yet implemented) - this part can be optional and removed by compilation directive if no need

Should be compatible with reprap printer (Marlin FW/Repetier FW) as soon as you can make both serial to communicate.

Current release listed here: https://github.com/luc-github/ESP8266/wiki

Master may not work unless you use the latest code of https://github.com/esp8266/arduino (https://github.com/esp8266/Arduino#using-git-version-) due to delay between PR integration in staging/stable versions

If you use an ESP with 512K flash like ESP01 please go here : https://github.com/luc-github/ESP8266/tree/ESP-512K-64KSPIFFS, it is dedicated to low memory device.
If you use an ESP with more than 512K flash please use master.

##Hardware connection
--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
--Use GPIO0 to ground to be in update mode
--Use a switch to reset/disable module
For ESP01:

For ESP12E:


For Davinci Board:

##Development
Currently using Arduino IDE 1.6.5 with the esp8266 module from board manager added from github.com/esp8266/Arduino
using relased version (http://arduino.esp8266.com/package_esp8266com_index.json)
and staging version (http://arduino.esp8266.com/staging/package_esp8266com_index.json)

Additionnaly:
--Use minimal css from http://getbootstrap.com/examples/theme/

##Flash the Module
*Tools:
--Use IDE to upload directly (latest version of board manager module generate one binary)
-- to flash the htm files present in data directory you need to use another tool, installation and usage is explained here: http://arduino.esp8266.com/versions/1.6.5-1160-gef26c5f/doc/reference.html#file-system
Once flashed you also can use the web updater to flash new FW in System Configuration Page

*Connection --Connect GPIO0 to ground to be in update mode

Do not flash Printer fw with ESP connected - it bring troubles, at least on DaVinci

##Web configuration
*Wifi Mode : Access point / Client station
*IP Generation: DHCP/Static IP
*IP/MASK/GATEWAY for static data
*Baud Rate for serial (supported : 9600, 19200, 38400, 57600, 115200, 230400, 250000)
*web port and data port

##Default Configuration
Default Settings:
AP:ESP8266
PW:12345678
Authentification: WPA
Mode: g (n is not supported by AP, just by STA)
channel: 11
AP: visible
Sleep Mode: Modem
IP Mode: Static IP
IP: 192.168.0.1
Mask: 255.255.255.0
GW:192.168.0.1
Baud rate: 9600
Web port:80
Data port: 8888
Web Page refresh: 3 secondes
User: admin
Password: admin

These are the pages defined using template:
Home page :

System Configuration Page:


Access Point Configuration Page:


Client Configuration Page:


Printer Status Page for 64K SPIFFS, due to limited space available no fancy:


Printer Status Page for more than 64K SPIFFS, fancy one:


Extra Settings Page, for web UI and for printer:


Change password Page:


Login Page:


the template files are stored on SPIFFS:

and uploaded using IDE
The list of keywords can be find here : https://github.com/luc-github/ESP8266/blob/master/keywords.txt
Any files on SPIFFS can be called on web interface without having the path hard coded - this give more flexibility, favicon.ico is a good example of it.
So UI is kind of separated from FW which allow easier modifications. For this a light file manager is available in extra settings page, it allows to upload/download/delete files. as SPIFFS is flat filesystem no directory management is necessary so it is very simple.

Additionally 404.tpl (the page not found) and restart.tpl(restart page when applying changes) are not mandatory, a fail safe version is embeded if they are not present.

Currently, I tested on ESP01 using 64K SPIFFS ( please use data directory content accordingly due to space limitation) and NodeMCU 1.0 1M SPIFFS.

##Protocol for discovery
*mDNS : on Station mode only with bonjour installed on computer (done)
*SSDP : on Station and AP mode (done)
*Captive portal : on AP mode only (done)

##Basic Authentification
Can be disabled in FW default user: admin default password: admin

#OTA support Currently only web update is supported not telnet one

##Commands/msg from/to serial(not fully implemented):
*from module to printer by serial communication
-M117 [Message], Error/status message from module (done)
-Send Wifi settings [AP/STATION,SSID,DHC/STATIC,IP,MASK,GW,STATUS,MAC ADDRESSS, BAUD?], ]Module configuration without password

*from host to printer on port 8888 (implemented) - bridge from TCP/IP to Serial and vice-versa (done)

*from printer/host to module (not fully implemented)
-request configuration/status
-set AP/STATION,SSID,PASSSWORD,DHC/STATIC,IP,MASK,GW,BAUD from serial -restart module from host/printer: [ESP888]RESTART
-Get IP (only printer see answer): [ESP111]M117
-reset EEPROM and restart: [ESP444]RESET
-display EEPROM content: [ESP444]CONFIG
-go to safe mode without restart: [ESP444]SAFEMODE
-SSID: [ESP100]
-Password: [ESP101]
-Station mode: [ESP103]STA
-AP mode: [ESP103]AP
-IP Static: [ESP104]STATIC
-IP DHCP: [ESP104]DHCP

##Front End (implemented) --Display printer status (done)
--Display temperatures (done)
--Display positions/flow/speed (done)
--Display print progress if any (done)
--List SDCard Content (done)
--Launch a Print (done)
--Stop/Pause a Print (done)
--Emergency Stop (done)
--Jog control / custom commands (done)

##TODO
-- Close open topics
-- Do testing (a lot)
-- UI Improvement
--Printer EEPROM management (Canceled/Postponed for next stage)

##Result of ESP12E on Davinci
I use a proto board to connect ESP12E socket, one micro switch for recovery, one jumper for normal usage/ flash, I did not put hardware switch.


Connected to Davinci:


The back cover:


The screen when connected to AP:


The settings:

##Result of ESP12E on Due/RADDS Use Serial1 for communications
the rendering on screen when connection to AP is done:

The settings:

##Donation: Every support is welcome:
Especially if need to buy new modules for testing.