Update README.md

This commit is contained in:
Luc 2015-06-03 21:05:28 +08:00
parent 026fba1b3e
commit 4d39a454c1

View File

@ -4,20 +4,19 @@
FW for ESP8266 used with 3D printer FW for ESP8266 used with 3D printer
##Description ##Description
Thanks to @disneysw for bringing this module idea and basic code Thanks to @disneysw for bringing this module idea
Thanks to @lkarlslund for suggestion about independant reset using GPIO2 Thanks to @lkarlslund for suggestion about independant reset using GPIO2
Have a bridge configurable by web and optionally by printer 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 or know what is the print status - this part can be optional and removed by compilation directive if no need 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
...
TBD
##Hardware connection ##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 - I did not found information on this. Currently boot take 10 sec - giving 8 seconds to connect GPIO2 to GND and do an hard recovery for settings --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 - I did not found information on this. 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 GPIO0 to ground to be in update mode
--Use a switch to reset/disable module --Use a switch to reset/disable module
--TODO: Full wiring with drawing --TODO: Full wiring with drawing
TBD
##Development ##Development
Currently using [Arduino IDE 1.6.4](http://arduino.cc/en/Main/Software) with the esp8266 module from board manager added from [github.com/esp8266/Arduino](https://github.com/esp8266/Arduino) Currently using [Arduino IDE 1.6.4](http://arduino.cc/en/Main/Software) with the esp8266 module from board manager added from [github.com/esp8266/Arduino](https://github.com/esp8266/Arduino)
@ -27,21 +26,20 @@ Additionnaly:
##Flash the Module ##Flash the Module
*Tools: *Tools:
--Use IDE to upload directly --Use IDE to upload directly (latest version of board manager module generate one binary)
--Use esp flasher: https://github.com/nodemcu/nodemcu-flasher for 0x00000 and 0X00004 binaries
*Connection *Connection
--Connect GPIO0 to ground to be in update mode --Connect GPIO0 to ground to be in update mode
##Wifi connection ##Web configuration
*Wifi Mode : Access point / Client station *Wifi Mode : Access point / Client station
*IP Generation: DHCP/Static IP *IP Generation: DHCP/Static IP
*IP/MASK/GATEWAY for static data *IP/MASK/GATEWAY for static data
*Baud Rate for serial (supported : 9600, 19200, 38400, 57600, 115200, 230400) *Baud Rate for serial (supported : 9600, 19200, 38400, 57600, 115200, 230400)
... *web port and data port
TBD
##Configuration ##Default Configuration
Default Settings: Default Settings:
AP:ESP8266 AP:ESP8266
PW:12345678 PW:12345678
@ -54,58 +52,46 @@ IP Mode: Static IP
IP: 192.168.0.1 IP: 192.168.0.1
Mask: 255.255.255.0 Mask: 255.255.255.0
GW:192.168.0.1 GW:192.168.0.1
Baud rate: 9600 Baud rate: 9600
Web port:80
Data port: 8888
From web: These are the UI when css is in cache or internet is available:
port 80
--Need picture and flow
<img src=https://raw.githubusercontent.com/luc-github/ESP8266/master/Page1.png><br> <img src=https://raw.githubusercontent.com/luc-github/ESP8266/master/Page1.png><br>
<img src=https://raw.githubusercontent.com/luc-github/ESP8266/master/Page2.png><br> <img src=https://raw.githubusercontent.com/luc-github/ESP8266/master/Page2.png><br>
<img src=https://raw.githubusercontent.com/luc-github/ESP8266/master/Page3.png><br> <img src=https://raw.githubusercontent.com/luc-github/ESP8266/master/Page3.png><br>
<img src=https://raw.githubusercontent.com/luc-github/ESP8266/master/Page4.png> <img src=https://raw.githubusercontent.com/luc-github/ESP8266/master/Page4.png>
...
TBD
##Commands from/to serial(not yet implemented): ##Commands from/to serial(not yet implemented):
*from module to printer [Need Printer FW support and can be disabled in ESP FW] *from module to printer [Need Printer FW support and can be disabled in ESP FW]
-M800 S1 , restart module done need a wifi/activity restart -M800 S1 , restart module done need a wifi/activity restart
-M801 [Message], Error message from module -M801 [Message], Error message from module
-M802 [Message], Status message from module -M802 [Message], Status message from module
-M804 [AP/STATION,SSID,DHC/STATIC,IP,MASK,GW,STATUS,MAC ADDRESSS, BAUD?], ]Module configuration without password -M804 [AP/STATION,SSID,DHC/STATIC,IP,MASK,GW,STATUS,MAC ADDRESSS, BAUD?], ]Module configuration without password
...
TBD
*from host to printer (not yet implemented) [Need Printer FW support] on port 8888 *from host to printer (not yet implemented) [Need Printer FW support] on port 8888
-M803 [IP, AP,SSID, Password....], ]Module configuration settings to be used by module -M803 [IP, AP,SSID, Password....], ]Module configuration settings to be used by module
-M805 query to get M804 informations -M805 query to get M804 informations
...
TBD
*from printer to module [Need Printer FW support and can be disabled in ESP FW] (not yet implemented) *from printer to module [Need Printer FW support and can be disabled in ESP FW] (not yet implemented)
-request configuration/status (generate the M804 as answer) -request configuration/status (generate the M804 as answer)
-set AP/STATION,SSID,PASSSWORD,DHC/STATIC,IP,MASK,GW,BAUD from serial -set AP/STATION,SSID,PASSSWORD,DHC/STATIC,IP,MASK,GW,BAUD from serial
...
TBD
##Front End [need Printer FW support it] or just display module status ##Front End (not yet implemented) [need Printer FW support it] or just display module status
--Display printer status --Display printer status
--Display temperatures --Display temperatures
--Display print progress if any --Display print progress if any
--List SDCard Content --List SDCard Content
--Launch/Stop/(Pause?) a Print --Launch/Stop/(Pause?) a Print
##TODO ##TODO
-- Define Front End Functions -- Define Front End Functions
-- do the bridge serial/TCPIP
-- do coding
-- do testing -- do testing
-- do a complete drawing for connections -- do a complete drawing for connections
-- add some Javascript to enhance web UI -- add some Javascript to enhance web UI
-- allow to change ports from Web UI, currently fixed to 80 and 8888
more to come more to come